Import mdocml-1.12.3
[dragonfly.git] / contrib / mdocml / libmandoc.h
1 /*      $Id: libmandoc.h,v 1.35 2013/12/15 21:23:52 schwarze Exp $ */
2 /*
3  * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
4  * Copyright (c) 2013 Ingo Schwarze <schwarze@openbsd.org>
5  *
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.
9  *
10  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR 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.
17  */
18 #ifndef LIBMANDOC_H
19 #define LIBMANDOC_H
20
21 enum    rofferr {
22         ROFF_CONT, /* continue processing line */
23         ROFF_RERUN, /* re-run roff interpreter with offset */
24         ROFF_APPEND, /* re-run main parser, appending next line */
25         ROFF_REPARSE, /* re-run main parser on the result */
26         ROFF_SO, /* include another file */
27         ROFF_IGN, /* ignore current line */
28         ROFF_TBL, /* a table row was successfully parsed */
29         ROFF_EQN, /* an equation was successfully parsed */
30         ROFF_ERR /* badness: puke and stop */
31 };
32
33 __BEGIN_DECLS
34
35 struct  roff;
36 struct  mdoc;
37 struct  man;
38
39 void             mandoc_msg(enum mandocerr, struct mparse *, 
40                         int, int, const char *);
41 void             mandoc_vmsg(enum mandocerr, struct mparse *, 
42                         int, int, const char *, ...);
43 char            *mandoc_getarg(struct mparse *, char **, int, int *);
44 char            *mandoc_normdate(struct mparse *, char *, int, int);
45 int              mandoc_eos(const char *, size_t, int);
46 int              mandoc_strntoi(const char *, size_t, int);
47 const char      *mandoc_a2msec(const char*);
48
49 void             mdoc_free(struct mdoc *);
50 struct  mdoc    *mdoc_alloc(struct roff *, struct mparse *, char *);
51 void             mdoc_reset(struct mdoc *);
52 int              mdoc_parseln(struct mdoc *, int, char *, int);
53 int              mdoc_endparse(struct mdoc *);
54 int              mdoc_addspan(struct mdoc *, const struct tbl_span *);
55 int              mdoc_addeqn(struct mdoc *, const struct eqn *);
56
57 void             man_free(struct man *);
58 struct  man     *man_alloc(struct roff *, struct mparse *);
59 void             man_reset(struct man *);
60 int              man_parseln(struct man *, int, char *, int);
61 int              man_endparse(struct man *);
62 int              man_addspan(struct man *, const struct tbl_span *);
63 int              man_addeqn(struct man *, const struct eqn *);
64
65 void             roff_free(struct roff *);
66 struct roff     *roff_alloc(enum mparset, struct mparse *);
67 void             roff_reset(struct roff *);
68 enum rofferr     roff_parseln(struct roff *, int, 
69                         char **, size_t *, int, int *);
70 void             roff_endparse(struct roff *);
71 void             roff_setreg(struct roff *, const char *, int, char sign);
72 int              roff_getreg(const struct roff *, const char *);
73 char            *roff_strdup(const struct roff *, const char *);
74 int              roff_getcontrol(const struct roff *, 
75                         const char *, int *);
76 #if 0
77 char             roff_eqndelim(const struct roff *);
78 void             roff_openeqn(struct roff *, const char *, 
79                         int, int, const char *);
80 int              roff_closeeqn(struct roff *);
81 #endif
82
83 const struct tbl_span   *roff_span(const struct roff *);
84 const struct eqn        *roff_eqn(const struct roff *);
85
86 __END_DECLS
87
88 #endif /*!LIBMANDOC_H*/