Annotation of mandoc/libmandoc.h, Revision 1.45
1.45 ! schwarze 1: /* $Id: libmandoc.h,v 1.44 2014/10/16 01:11:20 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: #ifndef LIBMANDOC_H
19: #define LIBMANDOC_H
20:
1.14 kristaps 21: enum rofferr {
22: ROFF_CONT, /* continue processing line */
23: ROFF_RERUN, /* re-run roff interpreter with offset */
24: ROFF_APPEND, /* re-run main parser, appending next line */
25: ROFF_REPARSE, /* re-run main parser on the result */
26: ROFF_SO, /* include another file */
27: ROFF_IGN, /* ignore current line */
28: ROFF_TBL, /* a table row was successfully parsed */
29: ROFF_EQN, /* an equation was successfully parsed */
30: ROFF_ERR /* badness: puke and stop */
31: };
32:
1.45 ! schwarze 33: struct buf {
! 34: char *buf;
! 35: size_t sz;
! 36: size_t offs;
! 37: };
! 38:
1.1 kristaps 39: __BEGIN_DECLS
40:
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 *);
64: int mdoc_addspan(struct mdoc *, const struct tbl_span *);
65: int mdoc_addeqn(struct mdoc *, const struct eqn *);
66:
1.41 schwarze 67: void man_free(struct man *);
1.38 schwarze 68: struct man *man_alloc(struct roff *, struct mparse *, int);
1.14 kristaps 69: void man_reset(struct man *);
1.41 schwarze 70: int man_parseln(struct man *, int, char *, int);
1.14 kristaps 71: int man_endparse(struct man *);
72: int man_addspan(struct man *, const struct tbl_span *);
73: int man_addeqn(struct man *, const struct eqn *);
1.45 ! schwarze 74:
! 75: int preconv_cue(const struct buf *);
! 76: int preconv_encode(struct buf *, struct buf *, int *);
1.14 kristaps 77:
1.41 schwarze 78: void roff_free(struct roff *);
1.40 schwarze 79: struct roff *roff_alloc(struct mparse *, int);
1.14 kristaps 80: void roff_reset(struct roff *);
1.41 schwarze 81: enum rofferr roff_parseln(struct roff *, int,
1.14 kristaps 82: char **, size_t *, int, int *);
1.16 kristaps 83: void roff_endparse(struct roff *);
1.35 schwarze 84: void roff_setreg(struct roff *, const char *, int, char sign);
1.34 schwarze 85: int roff_getreg(const struct roff *, const char *);
1.28 kristaps 86: char *roff_strdup(const struct roff *, const char *);
1.41 schwarze 87: int roff_getcontrol(const struct roff *,
1.31 kristaps 88: const char *, int *);
1.43 schwarze 89: int roff_getformat(const struct roff *);
1.14 kristaps 90:
1.16 kristaps 91: const struct tbl_span *roff_span(const struct roff *);
92: const struct eqn *roff_eqn(const struct roff *);
1.1 kristaps 93:
94: __END_DECLS
95:
96: #endif /*!LIBMANDOC_H*/
CVSweb