Annotation of mandoc/libmandoc.h, Revision 1.72
1.72 ! schwarze 1: /* $Id: libmandoc.h,v 1.71 2018/04/09 22:27:04 schwarze Exp $ */
1.1 kristaps 2: /*
1.32 schwarze 3: * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv>
1.72 ! schwarze 4: * Copyright (c) 2013,2014,2015,2017,2018 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 */
1.72 ! schwarze 24: ROFF_USERCALL, /* dto., calling a user-defined macro */
! 25: ROFF_USERRET, /* abort parsing of user-defined macro */
1.14 kristaps 26: ROFF_SO, /* include another file */
27: ROFF_IGN, /* ignore current line */
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;
1.14 kristaps 37: struct roff;
1.56 schwarze 38: struct roff_man;
1.14 kristaps 39:
1.41 schwarze 40: void mandoc_msg(enum mandocerr, struct mparse *,
1.14 kristaps 41: int, int, const char *);
1.41 schwarze 42: void mandoc_vmsg(enum mandocerr, struct mparse *,
1.64 schwarze 43: int, int, const char *, ...)
1.65 schwarze 44: __attribute__((__format__ (__printf__, 5, 6)));
1.20 kristaps 45: char *mandoc_getarg(struct mparse *, char **, int, int *);
1.68 schwarze 46: char *mandoc_normdate(struct roff_man *, char *, int, int);
1.36 schwarze 47: int mandoc_eos(const char *, size_t);
1.24 kristaps 48: int mandoc_strntoi(const char *, size_t, int);
1.29 schwarze 49: const char *mandoc_a2msec(const char*);
1.14 kristaps 50:
1.56 schwarze 51: int mdoc_parseln(struct roff_man *, int, char *, int);
52: void mdoc_endparse(struct roff_man *);
1.14 kristaps 53:
1.56 schwarze 54: int man_parseln(struct roff_man *, int, char *, int);
55: void man_endparse(struct roff_man *);
1.45 schwarze 56:
1.47 schwarze 57: int preconv_cue(const struct buf *, size_t);
1.66 schwarze 58: int preconv_encode(const struct buf *, size_t *,
1.47 schwarze 59: struct buf *, size_t *, int *);
1.14 kristaps 60:
1.41 schwarze 61: void roff_free(struct roff *);
1.61 schwarze 62: struct roff *roff_alloc(struct mparse *, int);
1.14 kristaps 63: void roff_reset(struct roff *);
1.58 schwarze 64: void roff_man_free(struct roff_man *);
65: struct roff_man *roff_man_alloc(struct roff *, struct mparse *,
66: const char *, int);
67: void roff_man_reset(struct roff_man *);
1.48 schwarze 68: enum rofferr roff_parseln(struct roff *, int, struct buf *, int *);
1.72 ! schwarze 69: void roff_userret(struct roff *);
1.16 kristaps 70: void roff_endparse(struct roff *);
1.35 schwarze 71: void roff_setreg(struct roff *, const char *, int, char sign);
1.71 schwarze 72: int roff_getreg(struct roff *, const char *);
1.28 kristaps 73: char *roff_strdup(const struct roff *, const char *);
1.41 schwarze 74: int roff_getcontrol(const struct roff *,
1.31 kristaps 75: const char *, int *);
1.43 schwarze 76: int roff_getformat(const struct roff *);
CVSweb