Annotation of mandoc/libmandoc.h, Revision 1.74
1.74 ! schwarze 1: /* $Id: libmandoc.h,v 1.73 2018/08/23 19:33:27 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.74 ! schwarze 19: /*
! 20: * Return codes passed from the roff parser to the main parser.
! 21: */
! 22:
! 23: /* Main instruction: what to do with the returned line. */
! 24: #define ROFF_IGN 0x000 /* Don't do anything with it. */
! 25: #define ROFF_CONT 0x001 /* Give it to the high-level parser. */
! 26: #define ROFF_RERUN 0x002 /* Re-run the roff parser with an offset. */
! 27: #define ROFF_REPARSE 0x004 /* Recursively run the main parser on it. */
! 28: #define ROFF_SO 0x008 /* Include the named file. */
! 29: #define ROFF_MASK 0x00f /* Only one of these bits should be set. */
! 30:
! 31: /* Options for further parsing, to be OR'ed with the above. */
! 32: #define ROFF_APPEND 0x010 /* Append the next line to this one. */
! 33: #define ROFF_USERCALL 0x020 /* Start execution of a new macro. */
! 34: #define ROFF_USERRET 0x040 /* Abort execution of the current macro. */
! 35: #define ROFF_WHILE 0x100 /* Start a new .while loop. */
! 36: #define ROFF_LOOPCONT 0x200 /* Iterate the current .while loop. */
! 37: #define ROFF_LOOPEXIT 0x400 /* Exit the current .while loop. */
! 38: #define ROFF_LOOPMASK 0xf00
! 39:
1.14 kristaps 40:
1.45 schwarze 41: struct buf {
1.73 schwarze 42: char *buf;
43: size_t sz;
44: struct buf *next;
1.45 schwarze 45: };
46:
1.1 kristaps 47:
1.51 schwarze 48: struct mparse;
1.14 kristaps 49: struct roff;
1.56 schwarze 50: struct roff_man;
1.14 kristaps 51:
1.41 schwarze 52: void mandoc_msg(enum mandocerr, struct mparse *,
1.14 kristaps 53: int, int, const char *);
1.41 schwarze 54: void mandoc_vmsg(enum mandocerr, struct mparse *,
1.64 schwarze 55: int, int, const char *, ...)
1.65 schwarze 56: __attribute__((__format__ (__printf__, 5, 6)));
1.20 kristaps 57: char *mandoc_getarg(struct mparse *, char **, int, int *);
1.68 schwarze 58: char *mandoc_normdate(struct roff_man *, char *, int, int);
1.36 schwarze 59: int mandoc_eos(const char *, size_t);
1.24 kristaps 60: int mandoc_strntoi(const char *, size_t, int);
1.29 schwarze 61: const char *mandoc_a2msec(const char*);
1.14 kristaps 62:
1.56 schwarze 63: int mdoc_parseln(struct roff_man *, int, char *, int);
64: void mdoc_endparse(struct roff_man *);
1.14 kristaps 65:
1.56 schwarze 66: int man_parseln(struct roff_man *, int, char *, int);
67: void man_endparse(struct roff_man *);
1.45 schwarze 68:
1.47 schwarze 69: int preconv_cue(const struct buf *, size_t);
1.66 schwarze 70: int preconv_encode(const struct buf *, size_t *,
1.47 schwarze 71: struct buf *, size_t *, int *);
1.14 kristaps 72:
1.41 schwarze 73: void roff_free(struct roff *);
1.61 schwarze 74: struct roff *roff_alloc(struct mparse *, int);
1.14 kristaps 75: void roff_reset(struct roff *);
1.58 schwarze 76: void roff_man_free(struct roff_man *);
77: struct roff_man *roff_man_alloc(struct roff *, struct mparse *,
78: const char *, int);
79: void roff_man_reset(struct roff_man *);
1.74 ! schwarze 80: int roff_parseln(struct roff *, int, struct buf *, int *);
1.72 schwarze 81: void roff_userret(struct roff *);
1.16 kristaps 82: void roff_endparse(struct roff *);
1.35 schwarze 83: void roff_setreg(struct roff *, const char *, int, char sign);
1.71 schwarze 84: int roff_getreg(struct roff *, const char *);
1.28 kristaps 85: char *roff_strdup(const struct roff *, const char *);
1.41 schwarze 86: int roff_getcontrol(const struct roff *,
1.31 kristaps 87: const char *, int *);
1.43 schwarze 88: int roff_getformat(const struct roff *);
CVSweb