Annotation of mandoc/roff.h, Revision 1.25
1.25 ! kristaps 1: /* $Id: roff.h,v 1.24 2011/02/09 09:05:52 kristaps Exp $ */
1.1 kristaps 2: /*
1.13 kristaps 3: * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.12 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.12 kristaps 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.
1.1 kristaps 16: */
17: #ifndef ROFF_H
18: #define ROFF_H
19:
1.12 kristaps 20: enum rofferr {
1.14 kristaps 21: ROFF_CONT, /* continue processing line */
22: ROFF_RERUN, /* re-run roff interpreter with offset */
1.19 kristaps 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 */
1.14 kristaps 26: ROFF_IGN, /* ignore current line */
1.20 kristaps 27: ROFF_TBL, /* a table row was successfully parsed */
1.23 kristaps 28: ROFF_EQN, /* an equation was successfully parsed */
1.15 kristaps 29: ROFF_ERR /* badness: puke and stop */
1.1 kristaps 30: };
31:
32: __BEGIN_DECLS
33:
1.12 kristaps 34: struct roff;
1.1 kristaps 35:
1.12 kristaps 36: void roff_free(struct roff *);
1.25 ! kristaps 37: struct roff *roff_alloc(struct regset *, struct mparse *);
1.12 kristaps 38: void roff_reset(struct roff *);
1.17 kristaps 39: enum rofferr roff_parseln(struct roff *, int,
40: char **, size_t *, int, int *);
1.22 kristaps 41: void roff_endparse(struct roff *);
1.21 kristaps 42: const struct tbl_span *roff_span(const struct roff *);
1.24 kristaps 43: const struct eqn *roff_eqn(const struct roff *);
1.1 kristaps 44:
45: __END_DECLS
46:
47: #endif /*!ROFF_H*/
CVSweb