9b3ffee17918c42a6bd85a4abb3f5ab25661f229
[dragonfly.git] / contrib / mdocml / libmandoc.h
1 /*      $Id: libmandoc.h,v 1.32 2012/11/19 17:57:23 schwarze Exp $ */
2 /*
3  * Copyright (c) 2009, 2010, 2011, 2012 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 __BEGIN_DECLS
38
39 struct  roff;
40 struct  mdoc;
41 struct  man;
42
43 void             mandoc_msg(enum mandocerr, struct mparse *, 
44                         int, int, const char *);
45 void             mandoc_vmsg(enum mandocerr, struct mparse *, 
46                         int, int, const char *, ...);
47 char            *mandoc_getarg(struct mparse *, char **, int, int *);
48 char            *mandoc_normdate(struct mparse *, char *, int, int);
49 int              mandoc_eos(const char *, size_t, int);
50 int              mandoc_strntoi(const char *, size_t, int);
51 const char      *mandoc_a2msec(const char*);
52
53 void             mdoc_free(struct mdoc *);
54 struct  mdoc    *mdoc_alloc(struct roff *, struct mparse *, char *);
55 void             mdoc_reset(struct mdoc *);
56 int              mdoc_parseln(struct mdoc *, int, char *, int);
57 int              mdoc_endparse(struct mdoc *);
58 int              mdoc_addspan(struct mdoc *, const struct tbl_span *);
59 int              mdoc_addeqn(struct mdoc *, const struct eqn *);
60
61 void             man_free(struct man *);
62 struct  man     *man_alloc(struct roff *, struct mparse *);
63 void             man_reset(struct man *);
64 int              man_parseln(struct man *, int, char *, int);
65 int              man_endparse(struct man *);
66 int              man_addspan(struct man *, const struct tbl_span *);
67 int              man_addeqn(struct man *, const struct eqn *);
68
69 void             roff_free(struct roff *);
70 struct roff     *roff_alloc(enum mparset, struct mparse *);
71 void             roff_reset(struct roff *);
72 enum rofferr     roff_parseln(struct roff *, int, 
73                         char **, size_t *, int, int *);
74 void             roff_endparse(struct roff *);
75 int              roff_regisset(const struct roff *, enum regs);
76 unsigned int     roff_regget(const struct roff *, enum regs);
77 void             roff_regunset(struct roff *, enum regs);
78 char            *roff_strdup(const struct roff *, const char *);
79 int              roff_getcontrol(const struct roff *, 
80                         const char *, int *);
81 #if 0
82 char             roff_eqndelim(const struct roff *);
83 void             roff_openeqn(struct roff *, const char *, 
84                         int, int, const char *);
85 int              roff_closeeqn(struct roff *);
86 #endif
87
88 const struct tbl_span   *roff_span(const struct roff *);
89 const struct eqn        *roff_eqn(const struct roff *);
90
91 __END_DECLS
92
93 #endif /*!LIBMANDOC_H*/