xref: /illumos-gate/usr/src/cmd/mandoc/libmandoc.h (revision cec8643b)
1 /*	$Id: libmandoc.h,v 1.77 2018/12/21 17:15:18 schwarze Exp $ */
2 /*
3  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
4  * Copyright (c) 2013,2014,2015,2017,2018 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 /*
20  * Return codes passed from the roff parser to the main parser.
21  */
22 
23 /* Main instruction: what to do with the returned line. */
24 #define	ROFF_IGN	0x000	/* Don't do anything with it. */
25 #define	ROFF_CONT	0x001	/* Give it to the high-level parser. */
26 #define	ROFF_RERUN	0x002	/* Re-run the roff parser with an offset. */
27 #define	ROFF_REPARSE	0x004	/* Recursively run the main parser on it. */
28 #define	ROFF_SO		0x008	/* Include the named file. */
29 #define	ROFF_MASK	0x00f	/* Only one of these bits should be set. */
30 
31 /* Options for further parsing, to be OR'ed with the above. */
32 #define	ROFF_APPEND	0x010	/* Append the next line to this one. */
33 #define	ROFF_USERCALL	0x020	/* Start execution of a new macro. */
34 #define	ROFF_USERRET	0x040	/* Abort execution of the current macro. */
35 #define	ROFF_WHILE	0x100	/* Start a new .while loop. */
36 #define	ROFF_LOOPCONT	0x200	/* Iterate the current .while loop. */
37 #define	ROFF_LOOPEXIT	0x400	/* Exit the current .while loop. */
38 #define	ROFF_LOOPMASK	0xf00
39 
40 
41 struct	buf {
42 	char		*buf;
43 	size_t		 sz;
44 	struct buf	*next;
45 };
46 
47 
48 struct	roff;
49 struct	roff_man;
50 
51 char		*mandoc_normdate(struct roff_man *, char *, int, int);
52 int		 mandoc_eos(const char *, size_t);
53 int		 mandoc_strntoi(const char *, size_t, int);
54 const char	*mandoc_a2msec(const char*);
55 
56 int		 mdoc_parseln(struct roff_man *, int, char *, int);
57 void		 mdoc_endparse(struct roff_man *);
58 
59 int		 man_parseln(struct roff_man *, int, char *, int);
60 void		 man_endparse(struct roff_man *);
61 
62 int		 preconv_cue(const struct buf *, size_t);
63 int		 preconv_encode(const struct buf *, size_t *,
64 			struct buf *, size_t *, int *);
65 
66 void		 roff_free(struct roff *);
67 struct roff	*roff_alloc(int);
68 void		 roff_reset(struct roff *);
69 void		 roff_man_free(struct roff_man *);
70 struct roff_man	*roff_man_alloc(struct roff *, const char *, int);
71 void		 roff_man_reset(struct roff_man *);
72 int		 roff_parseln(struct roff *, int, struct buf *, int *);
73 void		 roff_userret(struct roff *);
74 void		 roff_endparse(struct roff *);
75 void		 roff_setreg(struct roff *, const char *, int, char sign);
76 int		 roff_getreg(struct roff *, const char *);
77 char		*roff_strdup(const struct roff *, const char *);
78 char		*roff_getarg(struct roff *, char **, int, int *);
79 int		 roff_getcontrol(const struct roff *,
80 			const char *, int *);
81 int		 roff_getformat(const struct roff *);
82