xref: /dflybsd-src/contrib/mdocml/mandoc_parse.h (revision 1e4d43f9c96723e4e55543d240f182e1aac9a4c2)
1*99db7d0eSSascha Wildner /*	$Id: mandoc_parse.h,v 1.5 2019/11/09 14:39:49 schwarze Exp $ */
254ba9607SSascha Wildner /*
354ba9607SSascha Wildner  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
454ba9607SSascha Wildner  * Copyright (c) 2014,2015,2016,2017,2018 Ingo Schwarze <schwarze@openbsd.org>
554ba9607SSascha Wildner  *
654ba9607SSascha Wildner  * Permission to use, copy, modify, and distribute this software for any
754ba9607SSascha Wildner  * purpose with or without fee is hereby granted, provided that the above
854ba9607SSascha Wildner  * copyright notice and this permission notice appear in all copies.
954ba9607SSascha Wildner  *
1054ba9607SSascha Wildner  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1154ba9607SSascha Wildner  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1254ba9607SSascha Wildner  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1354ba9607SSascha Wildner  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
1454ba9607SSascha Wildner  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
1554ba9607SSascha Wildner  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
1654ba9607SSascha Wildner  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1754ba9607SSascha Wildner  *
1854ba9607SSascha Wildner  * Top level parser interface.  For use in the main program
1954ba9607SSascha Wildner  * and in the main parser, but not in formatters.
2054ba9607SSascha Wildner  */
2154ba9607SSascha Wildner 
2254ba9607SSascha Wildner /*
2354ba9607SSascha Wildner  * Parse options.
2454ba9607SSascha Wildner  */
2554ba9607SSascha Wildner #define	MPARSE_MDOC	(1 << 0)  /* assume -mdoc */
2654ba9607SSascha Wildner #define	MPARSE_MAN	(1 << 1)  /* assume -man */
2754ba9607SSascha Wildner #define	MPARSE_SO	(1 << 2)  /* honour .so requests */
2854ba9607SSascha Wildner #define	MPARSE_QUICK	(1 << 3)  /* abort the parse early */
2954ba9607SSascha Wildner #define	MPARSE_UTF8	(1 << 4)  /* accept UTF-8 input */
3054ba9607SSascha Wildner #define	MPARSE_LATIN1	(1 << 5)  /* accept ISO-LATIN-1 input */
3154ba9607SSascha Wildner #define	MPARSE_VALIDATE	(1 << 6)  /* call validation functions */
32*99db7d0eSSascha Wildner #define	MPARSE_COMMENT	(1 << 7)  /* save comments in the tree */
3354ba9607SSascha Wildner 
3454ba9607SSascha Wildner 
3554ba9607SSascha Wildner struct	roff_meta;
3654ba9607SSascha Wildner struct	mparse;
3754ba9607SSascha Wildner 
3854ba9607SSascha Wildner struct mparse	 *mparse_alloc(int, enum mandoc_os, const char *);
3954ba9607SSascha Wildner void		  mparse_copy(const struct mparse *);
4054ba9607SSascha Wildner void		  mparse_free(struct mparse *);
4154ba9607SSascha Wildner int		  mparse_open(struct mparse *, const char *);
4254ba9607SSascha Wildner void		  mparse_readfd(struct mparse *, int, const char *);
4354ba9607SSascha Wildner void		  mparse_reset(struct mparse *);
4454ba9607SSascha Wildner struct roff_meta *mparse_result(struct mparse *);
45