Import mdocml-1.12.1
[dragonfly.git] / contrib / mdocml / libmandoc.h
CommitLineData
36342e81 1/* $Id: libmandoc.h,v 1.29 2011/12/02 01:37:14 schwarze Exp $ */
80387638 2/*
60e1e752 3 * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
80387638
SW
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
60e1e752
SW
20enum 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
32enum regs {
33 REG_nS = 0, /* nS register */
34 REG__MAX
35};
36
80387638
SW
37__BEGIN_DECLS
38
60e1e752
SW
39struct roff;
40struct mdoc;
41struct man;
42
43void mandoc_msg(enum mandocerr, struct mparse *,
44 int, int, const char *);
45void mandoc_vmsg(enum mandocerr, struct mparse *,
46 int, int, const char *, ...);
60e1e752
SW
47char *mandoc_getarg(struct mparse *, char **, int, int *);
48char *mandoc_normdate(struct mparse *, char *, int, int);
80387638 49int mandoc_eos(const char *, size_t, int);
60e1e752 50int mandoc_getcontrol(const char *, int *);
36342e81
SW
51int mandoc_strntoi(const char *, size_t, int);
52const char *mandoc_a2msec(const char*);
60e1e752
SW
53
54void mdoc_free(struct mdoc *);
36342e81 55struct mdoc *mdoc_alloc(struct roff *, struct mparse *);
60e1e752
SW
56void mdoc_reset(struct mdoc *);
57int mdoc_parseln(struct mdoc *, int, char *, int);
58int mdoc_endparse(struct mdoc *);
59int mdoc_addspan(struct mdoc *, const struct tbl_span *);
60int mdoc_addeqn(struct mdoc *, const struct eqn *);
61
62void man_free(struct man *);
36342e81 63struct man *man_alloc(struct roff *, struct mparse *);
60e1e752
SW
64void man_reset(struct man *);
65int man_parseln(struct man *, int, char *, int);
66int man_endparse(struct man *);
67int man_addspan(struct man *, const struct tbl_span *);
68int man_addeqn(struct man *, const struct eqn *);
69
70void roff_free(struct roff *);
36342e81 71struct roff *roff_alloc(struct mparse *);
60e1e752
SW
72void roff_reset(struct roff *);
73enum rofferr roff_parseln(struct roff *, int,
74 char **, size_t *, int, int *);
75void roff_endparse(struct roff *);
36342e81
SW
76int roff_regisset(const struct roff *, enum regs);
77unsigned int roff_regget(const struct roff *, enum regs);
78void roff_regunset(struct roff *, enum regs);
79char *roff_strdup(const struct roff *, const char *);
80#if 0
81char roff_eqndelim(const struct roff *);
82void roff_openeqn(struct roff *, const char *,
83 int, int, const char *);
84int roff_closeeqn(struct roff *);
85#endif
60e1e752
SW
86
87const struct tbl_span *roff_span(const struct roff *);
88const struct eqn *roff_eqn(const struct roff *);
80387638
SW
89
90__END_DECLS
91
92#endif /*!LIBMANDOC_H*/