Annotation of mandoc/libmandoc.h, Revision 1.54
1.54 ! schwarze 1: /* $Id: libmandoc.h,v 1.53 2014/12/28 14:42:27 schwarze Exp $ */
1.1 kristaps 2: /*
1.32 schwarze 3: * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.40 schwarze 4: * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 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:
1.14 kristaps 19: enum rofferr {
20: ROFF_CONT, /* continue processing line */
21: ROFF_RERUN, /* re-run roff interpreter with offset */
22: ROFF_APPEND, /* re-run main parser, appending next line */
23: ROFF_REPARSE, /* re-run main parser on the result */
24: ROFF_SO, /* include another file */
25: ROFF_IGN, /* ignore current line */
26: ROFF_TBL, /* a table row was successfully parsed */
1.54 ! schwarze 27: ROFF_EQN /* an equation was successfully parsed */
1.14 kristaps 28: };
29:
1.45 schwarze 30: struct buf {
31: char *buf;
32: size_t sz;
33: };
34:
1.1 kristaps 35: __BEGIN_DECLS
36:
1.51 schwarze 37: struct mparse;
38: struct mchars;
39: struct tbl_span;
40: struct eqn;
1.14 kristaps 41: struct roff;
42: struct mdoc;
43: struct man;
44:
1.41 schwarze 45: void mandoc_msg(enum mandocerr, struct mparse *,
1.14 kristaps 46: int, int, const char *);
1.37 joerg 47: #if __GNUC__ - 0 >= 4
48: __attribute__((__format__ (__printf__, 5, 6)))
49: #endif
1.41 schwarze 50: void mandoc_vmsg(enum mandocerr, struct mparse *,
1.14 kristaps 51: int, int, const char *, ...);
1.20 kristaps 52: char *mandoc_getarg(struct mparse *, char **, int, int *);
1.16 kristaps 53: char *mandoc_normdate(struct mparse *, char *, int, int);
1.36 schwarze 54: int mandoc_eos(const char *, size_t);
1.24 kristaps 55: int mandoc_strntoi(const char *, size_t, int);
1.29 schwarze 56: const char *mandoc_a2msec(const char*);
1.14 kristaps 57:
1.41 schwarze 58: void mdoc_free(struct mdoc *);
1.42 schwarze 59: struct mdoc *mdoc_alloc(struct roff *, struct mparse *,
60: const char *, int);
1.14 kristaps 61: void mdoc_reset(struct mdoc *);
1.41 schwarze 62: int mdoc_parseln(struct mdoc *, int, char *, int);
1.14 kristaps 63: int mdoc_endparse(struct mdoc *);
1.49 schwarze 64: void mdoc_addspan(struct mdoc *, const struct tbl_span *);
65: void mdoc_addeqn(struct mdoc *, const struct eqn *);
1.14 kristaps 66:
1.41 schwarze 67: void man_free(struct man *);
1.53 schwarze 68: struct man *man_alloc(struct roff *, struct mparse *,
69: const char *, int);
1.14 kristaps 70: void man_reset(struct man *);
1.41 schwarze 71: int man_parseln(struct man *, int, char *, int);
1.14 kristaps 72: int man_endparse(struct man *);
1.49 schwarze 73: void man_addspan(struct man *, const struct tbl_span *);
74: void man_addeqn(struct man *, const struct eqn *);
1.45 schwarze 75:
1.47 schwarze 76: int preconv_cue(const struct buf *, size_t);
77: int preconv_encode(struct buf *, size_t *,
78: struct buf *, size_t *, int *);
1.14 kristaps 79:
1.41 schwarze 80: void roff_free(struct roff *);
1.46 schwarze 81: struct roff *roff_alloc(struct mparse *, const struct mchars *, int);
1.14 kristaps 82: void roff_reset(struct roff *);
1.48 schwarze 83: enum rofferr roff_parseln(struct roff *, int, struct buf *, int *);
1.16 kristaps 84: void roff_endparse(struct roff *);
1.35 schwarze 85: void roff_setreg(struct roff *, const char *, int, char sign);
1.34 schwarze 86: int roff_getreg(const struct roff *, const char *);
1.28 kristaps 87: char *roff_strdup(const struct roff *, const char *);
1.41 schwarze 88: int roff_getcontrol(const struct roff *,
1.31 kristaps 89: const char *, int *);
1.43 schwarze 90: int roff_getformat(const struct roff *);
1.14 kristaps 91:
1.16 kristaps 92: const struct tbl_span *roff_span(const struct roff *);
93: const struct eqn *roff_eqn(const struct roff *);
1.1 kristaps 94:
95: __END_DECLS
CVSweb