Import mdocml-1.12.3
[dragonfly.git] / contrib / mdocml / libmandoc.h
CommitLineData
7888c61d 1/* $Id: libmandoc.h,v 1.35 2013/12/15 21:23:52 schwarze Exp $ */
80387638 2/*
f88b6c16 3 * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
7888c61d 4 * Copyright (c) 2013 Ingo Schwarze <schwarze@openbsd.org>
80387638
SW
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
60e1e752
SW
21enum 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
80387638
SW
33__BEGIN_DECLS
34
60e1e752
SW
35struct roff;
36struct mdoc;
37struct man;
38
39void mandoc_msg(enum mandocerr, struct mparse *,
40 int, int, const char *);
41void mandoc_vmsg(enum mandocerr, struct mparse *,
42 int, int, const char *, ...);
60e1e752
SW
43char *mandoc_getarg(struct mparse *, char **, int, int *);
44char *mandoc_normdate(struct mparse *, char *, int, int);
80387638 45int mandoc_eos(const char *, size_t, int);
36342e81
SW
46int mandoc_strntoi(const char *, size_t, int);
47const char *mandoc_a2msec(const char*);
60e1e752
SW
48
49void mdoc_free(struct mdoc *);
f88b6c16 50struct mdoc *mdoc_alloc(struct roff *, struct mparse *, char *);
60e1e752
SW
51void mdoc_reset(struct mdoc *);
52int mdoc_parseln(struct mdoc *, int, char *, int);
53int mdoc_endparse(struct mdoc *);
54int mdoc_addspan(struct mdoc *, const struct tbl_span *);
55int mdoc_addeqn(struct mdoc *, const struct eqn *);
56
57void man_free(struct man *);
36342e81 58struct man *man_alloc(struct roff *, struct mparse *);
60e1e752
SW
59void man_reset(struct man *);
60int man_parseln(struct man *, int, char *, int);
61int man_endparse(struct man *);
62int man_addspan(struct man *, const struct tbl_span *);
63int man_addeqn(struct man *, const struct eqn *);
64
65void roff_free(struct roff *);
f88b6c16 66struct roff *roff_alloc(enum mparset, struct mparse *);
60e1e752
SW
67void roff_reset(struct roff *);
68enum rofferr roff_parseln(struct roff *, int,
69 char **, size_t *, int, int *);
70void roff_endparse(struct roff *);
7888c61d
FF
71void roff_setreg(struct roff *, const char *, int, char sign);
72int roff_getreg(const struct roff *, const char *);
36342e81 73char *roff_strdup(const struct roff *, const char *);
f88b6c16
FF
74int roff_getcontrol(const struct roff *,
75 const char *, int *);
36342e81
SW
76#if 0
77char roff_eqndelim(const struct roff *);
78void roff_openeqn(struct roff *, const char *,
79 int, int, const char *);
80int roff_closeeqn(struct roff *);
81#endif
60e1e752
SW
82
83const struct tbl_span *roff_span(const struct roff *);
84const struct eqn *roff_eqn(const struct roff *);
80387638
SW
85
86__END_DECLS
87
88#endif /*!LIBMANDOC_H*/