Import mdocml-1.11.1
[dragonfly.git] / contrib / mdocml / libmandoc.h
1 /*      $Id: libmandoc.h,v 1.17 2011/03/28 23:52:13 kristaps Exp $ */
2 /*
3  * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4  *
5  * Permission to use, copy, modify, and distribute this software for any
6  * purpose with or without fee is hereby granted, provided that the above
7  * copyright notice and this permission notice appear in all copies.
8  *
9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16  */
17 #ifndef LIBMANDOC_H
18 #define LIBMANDOC_H
19
20 enum    rofferr {
21         ROFF_CONT, /* continue processing line */
22         ROFF_RERUN, /* re-run roff interpreter with offset */
23         ROFF_APPEND, /* re-run main parser, appending next line */
24         ROFF_REPARSE, /* re-run main parser on the result */
25         ROFF_SO, /* include another file */
26         ROFF_IGN, /* ignore current line */
27         ROFF_TBL, /* a table row was successfully parsed */
28         ROFF_EQN, /* an equation was successfully parsed */
29         ROFF_ERR /* badness: puke and stop */
30 };
31
32 enum    regs {
33         REG_nS = 0, /* nS register */
34         REG__MAX
35 };
36
37 /*
38  * A register (struct reg) can consist of many types: this consists of
39  * normalised types from the original string form.  For the time being,
40  * there's only an unsigned integer type.
41  */
42 union   regval {
43         unsigned  u; /* unsigned integer */
44 };
45
46 /*
47  * A single register entity.  If "set" is zero, the value of the
48  * register should be the default one, which is per-register.  It's
49  * assumed that callers know which type in "v" corresponds to which
50  * register value.
51  */
52 struct  reg {
53         int               set; /* whether set or not */
54         union regval      v; /* parsed data */
55 };
56
57 /*
58  * The primary interface to setting register values is in libroff,
59  * although libmdoc and libman from time to time will manipulate
60  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
61  */
62 struct  regset {
63         struct reg        regs[REG__MAX];
64 };
65
66 __BEGIN_DECLS
67
68 struct  roff;
69 struct  mdoc;
70 struct  man;
71
72 void             mandoc_msg(enum mandocerr, struct mparse *, 
73                         int, int, const char *);
74 void             mandoc_vmsg(enum mandocerr, struct mparse *, 
75                         int, int, const char *, ...);
76 int              mandoc_special(char *);
77 char            *mandoc_strdup(const char *);
78 char            *mandoc_getarg(struct mparse *, char **, int, int *);
79 char            *mandoc_normdate(struct mparse *, char *, int, int);
80 int              mandoc_eos(const char *, size_t, int);
81 int              mandoc_hyph(const char *, const char *);
82 int              mandoc_getcontrol(const char *, int *);
83
84 void             mdoc_free(struct mdoc *);
85 struct  mdoc    *mdoc_alloc(struct regset *, struct mparse *);
86 void             mdoc_reset(struct mdoc *);
87 int              mdoc_parseln(struct mdoc *, int, char *, int);
88 int              mdoc_endparse(struct mdoc *);
89 int              mdoc_addspan(struct mdoc *, const struct tbl_span *);
90 int              mdoc_addeqn(struct mdoc *, const struct eqn *);
91
92 void             man_free(struct man *);
93 struct  man     *man_alloc(struct regset *, struct mparse *);
94 void             man_reset(struct man *);
95 int              man_parseln(struct man *, int, char *, int);
96 int              man_endparse(struct man *);
97 int              man_addspan(struct man *, const struct tbl_span *);
98 int              man_addeqn(struct man *, const struct eqn *);
99
100 void             roff_free(struct roff *);
101 struct roff     *roff_alloc(struct regset *, struct mparse *);
102 void             roff_reset(struct roff *);
103 enum rofferr     roff_parseln(struct roff *, int, 
104                         char **, size_t *, int, int *);
105 void             roff_endparse(struct roff *);
106
107 const struct tbl_span   *roff_span(const struct roff *);
108 const struct eqn        *roff_eqn(const struct roff *);
109
110 __END_DECLS
111
112 #endif /*!LIBMANDOC_H*/