xref: /illumos-gate/usr/src/cmd/mandoc/libmandoc.h (revision 1702cce751c5cb7ead878d0205a6c90b027e3de8)
1 /*	$Id: libmandoc.h,v 1.70 2017/07/08 17:52:49 schwarze Exp $ */
2 /*
3  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
4  * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
5  *
6  * Permission to use, copy, modify, and distribute this software for any
7  * purpose with or without fee is hereby granted, provided that the above
8  * copyright notice and this permission notice appear in all copies.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17  */
18 
19 enum	rofferr {
20 	ROFF_CONT, /* continue processing line */
21 	ROFF_RERUN, /* re-run roff interpreter with offset */
22 	ROFF_APPEND, /* re-run main parser, appending next line */
23 	ROFF_REPARSE, /* re-run main parser on the result */
24 	ROFF_SO, /* include another file */
25 	ROFF_IGN, /* ignore current line */
26 };
27 
28 struct	buf {
29 	char	*buf;
30 	size_t	 sz;
31 };
32 
33 
34 struct	mparse;
35 struct	roff;
36 struct	roff_man;
37 
38 void		 mandoc_msg(enum mandocerr, struct mparse *,
39 			int, int, const char *);
40 void		 mandoc_vmsg(enum mandocerr, struct mparse *,
41 			int, int, const char *, ...)
42 			__attribute__((__format__ (__printf__, 5, 6)));
43 char		*mandoc_getarg(struct mparse *, char **, int, int *);
44 char		*mandoc_normdate(struct roff_man *, char *, int, int);
45 int		 mandoc_eos(const char *, size_t);
46 int		 mandoc_strntoi(const char *, size_t, int);
47 const char	*mandoc_a2msec(const char*);
48 
49 int		 mdoc_parseln(struct roff_man *, int, char *, int);
50 void		 mdoc_endparse(struct roff_man *);
51 
52 int		 man_parseln(struct roff_man *, int, char *, int);
53 void		 man_endparse(struct roff_man *);
54 
55 int		 preconv_cue(const struct buf *, size_t);
56 int		 preconv_encode(const struct buf *, size_t *,
57 			struct buf *, size_t *, int *);
58 
59 void		 roff_free(struct roff *);
60 struct roff	*roff_alloc(struct mparse *, int);
61 void		 roff_reset(struct roff *);
62 void		 roff_man_free(struct roff_man *);
63 struct roff_man	*roff_man_alloc(struct roff *, struct mparse *,
64 			const char *, int);
65 void		 roff_man_reset(struct roff_man *);
66 enum rofferr	 roff_parseln(struct roff *, int, struct buf *, int *);
67 void		 roff_endparse(struct roff *);
68 void		 roff_setreg(struct roff *, const char *, int, char sign);
69 int		 roff_getreg(const struct roff *, const char *);
70 char		*roff_strdup(const struct roff *, const char *);
71 int		 roff_getcontrol(const struct roff *,
72 			const char *, int *);
73 int		 roff_getformat(const struct roff *);
74