1 /* $OpenBSD: libmandoc.h,v 1.59 2018/08/24 22:56:37 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> 4 * Copyright (c) 2013,2014,2015,2017,2018 Ingo Schwarze <schwarze@openbsd.org> 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 AUTHORS DISCLAIM ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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 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 40 41 struct buf { 42 char *buf; 43 size_t sz; 44 struct buf *next; 45 }; 46 47 48 struct mparse; 49 struct roff; 50 struct roff_man; 51 52 void mandoc_msg(enum mandocerr, struct mparse *, 53 int, int, const char *); 54 void mandoc_vmsg(enum mandocerr, struct mparse *, 55 int, int, const char *, ...) 56 __attribute__((__format__ (__printf__, 5, 6))); 57 char *mandoc_getarg(struct mparse *, char **, int, int *); 58 char *mandoc_normdate(struct roff_man *, char *, int, int); 59 int mandoc_eos(const char *, size_t); 60 int mandoc_strntoi(const char *, size_t, int); 61 const char *mandoc_a2msec(const char*); 62 63 int mdoc_parseln(struct roff_man *, int, char *, int); 64 void mdoc_endparse(struct roff_man *); 65 66 int man_parseln(struct roff_man *, int, char *, int); 67 void man_endparse(struct roff_man *); 68 69 int preconv_cue(const struct buf *, size_t); 70 int preconv_encode(const struct buf *, size_t *, 71 struct buf *, size_t *, int *); 72 73 void roff_free(struct roff *); 74 struct roff *roff_alloc(struct mparse *, int); 75 void roff_reset(struct roff *); 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 *); 80 int roff_parseln(struct roff *, int, struct buf *, int *); 81 void roff_userret(struct roff *); 82 void roff_endparse(struct roff *); 83 void roff_setreg(struct roff *, const char *, int, char sign); 84 int roff_getreg(struct roff *, const char *); 85 char *roff_strdup(const struct roff *, const char *); 86 int roff_getcontrol(const struct roff *, 87 const char *, int *); 88 int roff_getformat(const struct roff *); 89