Annotation of src/usr.bin/mandoc/libmandoc.h, Revision 1.53
1.53 ! schwarze 1: /* $OpenBSD: libmandoc.h,v 1.52 2017/04/29 12:43:55 schwarze Exp $ */
1.1 schwarze 2: /*
1.19 schwarze 3: * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.42 schwarze 4: * Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 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: *
1.42 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.42 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1 schwarze 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.11 schwarze 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.40 schwarze 27: ROFF_EQN /* an equation was successfully parsed */
1.11 schwarze 28: };
29:
1.32 schwarze 30: struct buf {
31: char *buf;
32: size_t sz;
33: };
34:
1.1 schwarze 35:
1.37 schwarze 36: struct mparse;
37: struct tbl_span;
38: struct eqn;
1.11 schwarze 39: struct roff;
1.42 schwarze 40: struct roff_man;
1.11 schwarze 41:
1.27 schwarze 42: void mandoc_msg(enum mandocerr, struct mparse *,
1.11 schwarze 43: int, int, const char *);
1.27 schwarze 44: void mandoc_vmsg(enum mandocerr, struct mparse *,
1.49 schwarze 45: int, int, const char *, ...)
1.50 schwarze 46: __attribute__((__format__ (__printf__, 5, 6)));
1.11 schwarze 47: char *mandoc_getarg(struct mparse *, char **, int, int *);
1.53 ! schwarze 48: char *mandoc_normdate(struct roff_man *, char *, int, int);
1.23 schwarze 49: int mandoc_eos(const char *, size_t);
1.14 schwarze 50: int mandoc_strntoi(const char *, size_t, int);
1.16 schwarze 51: const char *mandoc_a2msec(const char*);
1.11 schwarze 52:
1.42 schwarze 53: int mdoc_parseln(struct roff_man *, int, char *, int);
54: void mdoc_endparse(struct roff_man *);
1.11 schwarze 55:
1.42 schwarze 56: int man_parseln(struct roff_man *, int, char *, int);
57: void man_endparse(struct roff_man *);
1.32 schwarze 58:
1.33 schwarze 59: int preconv_cue(const struct buf *, size_t);
1.51 schwarze 60: int preconv_encode(const struct buf *, size_t *,
1.33 schwarze 61: struct buf *, size_t *, int *);
1.11 schwarze 62:
1.27 schwarze 63: void roff_free(struct roff *);
1.47 schwarze 64: struct roff *roff_alloc(struct mparse *, int);
1.11 schwarze 65: void roff_reset(struct roff *);
1.44 schwarze 66: void roff_man_free(struct roff_man *);
67: struct roff_man *roff_man_alloc(struct roff *, struct mparse *,
68: const char *, int);
69: void roff_man_reset(struct roff_man *);
1.34 schwarze 70: enum rofferr roff_parseln(struct roff *, int, struct buf *, int *);
1.11 schwarze 71: void roff_endparse(struct roff *);
1.22 schwarze 72: void roff_setreg(struct roff *, const char *, int, char sign);
1.21 schwarze 73: int roff_getreg(const struct roff *, const char *);
1.15 schwarze 74: char *roff_strdup(const struct roff *, const char *);
1.27 schwarze 75: int roff_getcontrol(const struct roff *,
1.19 schwarze 76: const char *, int *);
1.29 schwarze 77: int roff_getformat(const struct roff *);
1.11 schwarze 78:
79: const struct tbl_span *roff_span(const struct roff *);
80: const struct eqn *roff_eqn(const struct roff *);