Import mdocml-1.10.9
[dragonfly.git] / contrib / mdocml / roff.h
CommitLineData
80387638
SW
1/* $Id: roff.h,v 1.22 2011/01/01 16:18:39 kristaps Exp $ */
2/*
3 * Copyright (c) 2010 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 ROFF_H
18#define ROFF_H
19
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_ERR /* badness: puke and stop */
29};
30
31__BEGIN_DECLS
32
33struct roff;
34
35void roff_free(struct roff *);
36struct roff *roff_alloc(struct regset *, void *, mandocmsg);
37void roff_reset(struct roff *);
38enum rofferr roff_parseln(struct roff *, int,
39 char **, size_t *, int, int *);
40void roff_endparse(struct roff *);
41const struct tbl_span *roff_span(const struct roff *);
42
43__END_DECLS
44
45#endif /*!ROFF_H*/