xref: /netbsd-src/external/bsd/mdocml/dist/mandoc_parse.h (revision 544c191c349c1704c9d5e679d12ec15cff579663)
1*544c191cSchristos /*	Id: mandoc_parse.h,v 1.4 2018/12/30 00:49:55 schwarze Exp  */
2*544c191cSchristos /*
3*544c191cSchristos  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4*544c191cSchristos  * Copyright (c) 2014,2015,2016,2017,2018 Ingo Schwarze <schwarze@openbsd.org>
5*544c191cSchristos  *
6*544c191cSchristos  * Permission to use, copy, modify, and distribute this software for any
7*544c191cSchristos  * purpose with or without fee is hereby granted, provided that the above
8*544c191cSchristos  * copyright notice and this permission notice appear in all copies.
9*544c191cSchristos  *
10*544c191cSchristos  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11*544c191cSchristos  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12*544c191cSchristos  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13*544c191cSchristos  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14*544c191cSchristos  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15*544c191cSchristos  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16*544c191cSchristos  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17*544c191cSchristos  *
18*544c191cSchristos  * Top level parser interface.  For use in the main program
19*544c191cSchristos  * and in the main parser, but not in formatters.
20*544c191cSchristos  */
21*544c191cSchristos 
22*544c191cSchristos /*
23*544c191cSchristos  * Parse options.
24*544c191cSchristos  */
25*544c191cSchristos #define	MPARSE_MDOC	(1 << 0)  /* assume -mdoc */
26*544c191cSchristos #define	MPARSE_MAN	(1 << 1)  /* assume -man */
27*544c191cSchristos #define	MPARSE_SO	(1 << 2)  /* honour .so requests */
28*544c191cSchristos #define	MPARSE_QUICK	(1 << 3)  /* abort the parse early */
29*544c191cSchristos #define	MPARSE_UTF8	(1 << 4)  /* accept UTF-8 input */
30*544c191cSchristos #define	MPARSE_LATIN1	(1 << 5)  /* accept ISO-LATIN-1 input */
31*544c191cSchristos #define	MPARSE_VALIDATE	(1 << 6)  /* call validation functions */
32*544c191cSchristos 
33*544c191cSchristos 
34*544c191cSchristos struct	roff_meta;
35*544c191cSchristos struct	mparse;
36*544c191cSchristos 
37*544c191cSchristos struct mparse	 *mparse_alloc(int, enum mandoc_os, const char *);
38*544c191cSchristos void		  mparse_copy(const struct mparse *);
39*544c191cSchristos void		  mparse_free(struct mparse *);
40*544c191cSchristos int		  mparse_open(struct mparse *, const char *);
41*544c191cSchristos void		  mparse_readfd(struct mparse *, int, const char *);
42*544c191cSchristos void		  mparse_reset(struct mparse *);
43*544c191cSchristos struct roff_meta *mparse_result(struct mparse *);
44