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