Annotation of mandoc/libmandoc.h, Revision 1.62
1.62 ! schwarze 1: /* $Id: libmandoc.h,v 1.61 2015/10/13 22:59:54 schwarze Exp $ */
1.1 kristaps 2: /*
1.32 schwarze 3: * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.56 schwarze 4: * Copyright (c) 2013, 2014, 2015 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: *
1.56 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1 kristaps 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.56 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1 kristaps 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:
1.51 schwarze 36: struct mparse;
37: struct tbl_span;
38: struct eqn;
1.14 kristaps 39: struct roff;
1.56 schwarze 40: struct roff_man;
1.58 schwarze 41: struct roff_node;
1.14 kristaps 42:
1.41 schwarze 43: void mandoc_msg(enum mandocerr, struct mparse *,
1.14 kristaps 44: int, int, const char *);
1.37 joerg 45: #if __GNUC__ - 0 >= 4
46: __attribute__((__format__ (__printf__, 5, 6)))
47: #endif
1.41 schwarze 48: void mandoc_vmsg(enum mandocerr, struct mparse *,
1.14 kristaps 49: int, int, const char *, ...);
1.20 kristaps 50: char *mandoc_getarg(struct mparse *, char **, int, int *);
1.16 kristaps 51: char *mandoc_normdate(struct mparse *, char *, int, int);
1.36 schwarze 52: int mandoc_eos(const char *, size_t);
1.24 kristaps 53: int mandoc_strntoi(const char *, size_t, int);
1.29 schwarze 54: const char *mandoc_a2msec(const char*);
1.14 kristaps 55:
1.57 schwarze 56: void mdoc_hash_init(void);
1.56 schwarze 57: int mdoc_parseln(struct roff_man *, int, char *, int);
58: void mdoc_endparse(struct roff_man *);
1.14 kristaps 59:
1.57 schwarze 60: void man_hash_init(void);
1.56 schwarze 61: int man_parseln(struct roff_man *, int, char *, int);
62: void man_endparse(struct roff_man *);
1.45 schwarze 63:
1.47 schwarze 64: int preconv_cue(const struct buf *, size_t);
65: int preconv_encode(struct buf *, size_t *,
66: struct buf *, size_t *, int *);
1.14 kristaps 67:
1.41 schwarze 68: void roff_free(struct roff *);
1.61 schwarze 69: struct roff *roff_alloc(struct mparse *, int);
1.14 kristaps 70: void roff_reset(struct roff *);
1.58 schwarze 71: void roff_man_free(struct roff_man *);
72: struct roff_man *roff_man_alloc(struct roff *, struct mparse *,
73: const char *, int);
74: void roff_man_reset(struct roff_man *);
1.48 schwarze 75: enum rofferr roff_parseln(struct roff *, int, struct buf *, int *);
1.16 kristaps 76: void roff_endparse(struct roff *);
1.35 schwarze 77: void roff_setreg(struct roff *, const char *, int, char sign);
1.34 schwarze 78: int roff_getreg(const struct roff *, const char *);
1.28 kristaps 79: char *roff_strdup(const struct roff *, const char *);
1.41 schwarze 80: int roff_getcontrol(const struct roff *,
1.31 kristaps 81: const char *, int *);
1.43 schwarze 82: int roff_getformat(const struct roff *);
1.14 kristaps 83:
1.16 kristaps 84: const struct tbl_span *roff_span(const struct roff *);
85: const struct eqn *roff_eqn(const struct roff *);
CVSweb