1 /* $Id: libmandoc.h,v 1.63 2016/07/07 19:19:01 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> 4 * Copyright (c) 2013, 2014, 2015 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 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 */ 27 ROFF_EQN /* an equation was successfully parsed */ 28 }; 29 30 struct buf { 31 char *buf; 32 size_t sz; 33 }; 34 35 36 struct mparse; 37 struct tbl_span; 38 struct eqn; 39 struct roff; 40 struct roff_man; 41 42 void mandoc_msg(enum mandocerr, struct mparse *, 43 int, int, const char *); 44 #if __GNUC__ - 0 >= 4 45 __attribute__((__format__ (__printf__, 5, 6))) 46 #endif 47 void mandoc_vmsg(enum mandocerr, struct mparse *, 48 int, int, const char *, ...); 49 char *mandoc_getarg(struct mparse *, char **, int, int *); 50 char *mandoc_normdate(struct mparse *, char *, int, int); 51 int mandoc_eos(const char *, size_t); 52 int mandoc_strntoi(const char *, size_t, int); 53 const char *mandoc_a2msec(const char*); 54 55 void mdoc_hash_init(void); 56 int mdoc_parseln(struct roff_man *, int, char *, int); 57 void mdoc_endparse(struct roff_man *); 58 59 void man_hash_init(void); 60 int man_parseln(struct roff_man *, int, char *, int); 61 void man_endparse(struct roff_man *); 62 63 int preconv_cue(const struct buf *, size_t); 64 int preconv_encode(struct buf *, size_t *, 65 struct buf *, size_t *, int *); 66 67 void roff_free(struct roff *); 68 struct roff *roff_alloc(struct mparse *, int); 69 void roff_reset(struct roff *); 70 void roff_man_free(struct roff_man *); 71 struct roff_man *roff_man_alloc(struct roff *, struct mparse *, 72 const char *, int); 73 void roff_man_reset(struct roff_man *); 74 enum rofferr roff_parseln(struct roff *, int, struct buf *, int *); 75 void roff_endparse(struct roff *); 76 void roff_setreg(struct roff *, const char *, int, char sign); 77 int roff_getreg(const struct roff *, const char *); 78 char *roff_strdup(const struct roff *, const char *); 79 int roff_getcontrol(const struct roff *, 80 const char *, int *); 81 int roff_getformat(const struct roff *); 82 83 const struct tbl_span *roff_span(const struct roff *); 84 const struct eqn *roff_eqn(const struct roff *); 85