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
19enum	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
28struct	buf {
29	char	*buf;
30	size_t	 sz;
31};
32
33
34struct	mparse;
35struct	roff;
36struct	roff_man;
37
38void		 mandoc_msg(enum mandocerr, struct mparse *,
39			int, int, const char *);
40void		 mandoc_vmsg(enum mandocerr, struct mparse *,
41			int, int, const char *, ...)
42			__attribute__((__format__ (__printf__, 5, 6)));
43char		*mandoc_getarg(struct mparse *, char **, int, int *);
44char		*mandoc_normdate(struct roff_man *, char *, int, int);
45int		 mandoc_eos(const char *, size_t);
46int		 mandoc_strntoi(const char *, size_t, int);
47const char	*mandoc_a2msec(const char*);
48
49int		 mdoc_parseln(struct roff_man *, int, char *, int);
50void		 mdoc_endparse(struct roff_man *);
51
52int		 man_parseln(struct roff_man *, int, char *, int);
53void		 man_endparse(struct roff_man *);
54
55int		 preconv_cue(const struct buf *, size_t);
56int		 preconv_encode(const struct buf *, size_t *,
57			struct buf *, size_t *, int *);
58
59void		 roff_free(struct roff *);
60struct roff	*roff_alloc(struct mparse *, int);
61void		 roff_reset(struct roff *);
62void		 roff_man_free(struct roff_man *);
63struct roff_man	*roff_man_alloc(struct roff *, struct mparse *,
64			const char *, int);
65void		 roff_man_reset(struct roff_man *);
66enum rofferr	 roff_parseln(struct roff *, int, struct buf *, int *);
67void		 roff_endparse(struct roff *);
68void		 roff_setreg(struct roff *, const char *, int, char sign);
69int		 roff_getreg(const struct roff *, const char *);
70char		*roff_strdup(const struct roff *, const char *);
71int		 roff_getcontrol(const struct roff *,
72			const char *, int *);
73int		 roff_getformat(const struct roff *);
74