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