Unleashed v1.4
[unleashed.git] / bin / mandoc / mandoc_parse.h
blob61341f0d7f39491f1eb98c9d1e239ea27081a3db
1 /* $Id: mandoc_parse.h,v 1.4 2018/12/30 00:49:55 schwarze Exp $ */
2 /*
3 * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2014,2015,2016,2017,2018 Ingo Schwarze <schwarze@openbsd.org>
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.
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.
18 * Top level parser interface. For use in the main program
19 * and in the main parser, but not in formatters.
23 * Parse options.
25 #define MPARSE_MDOC (1 << 0) /* assume -mdoc */
26 #define MPARSE_MAN (1 << 1) /* assume -man */
27 #define MPARSE_SO (1 << 2) /* honour .so requests */
28 #define MPARSE_QUICK (1 << 3) /* abort the parse early */
29 #define MPARSE_UTF8 (1 << 4) /* accept UTF-8 input */
30 #define MPARSE_LATIN1 (1 << 5) /* accept ISO-LATIN-1 input */
31 #define MPARSE_VALIDATE (1 << 6) /* call validation functions */
34 struct roff_meta;
35 struct mparse;
37 struct mparse *mparse_alloc(int, enum mandoc_os, const char *);
38 void mparse_copy(const struct mparse *);
39 void mparse_free(struct mparse *);
40 int mparse_open(struct mparse *, const char *);
41 void mparse_readfd(struct mparse *, int, const char *);
42 void mparse_reset(struct mparse *);
43 struct roff_meta *mparse_result(struct mparse *);