1 /* $Id: libmandoc.h,v 1.55 2015/01/15 04:26:39 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2009, 2010, 2011, 2012 Kristaps Dzonsons <kristaps@bsd.lv> 4 * Copyright (c) 2013, 2014 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 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 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 __BEGIN_DECLS 36 37 struct mparse; 38 struct mchars; 39 struct tbl_span; 40 struct eqn; 41 struct roff; 42 struct mdoc; 43 struct man; 44 45 void mandoc_msg(enum mandocerr, struct mparse *, 46 int, int, const char *); 47 #if __GNUC__ - 0 >= 4 48 __attribute__((__format__ (__printf__, 5, 6))) 49 #endif 50 void mandoc_vmsg(enum mandocerr, struct mparse *, 51 int, int, const char *, ...); 52 char *mandoc_getarg(struct mparse *, char **, int, int *); 53 char *mandoc_normdate(struct mparse *, char *, int, int); 54 int mandoc_eos(const char *, size_t); 55 int mandoc_strntoi(const char *, size_t, int); 56 const char *mandoc_a2msec(const char*); 57 58 void mdoc_free(struct mdoc *); 59 struct mdoc *mdoc_alloc(struct roff *, struct mparse *, 60 const char *, int); 61 void mdoc_reset(struct mdoc *); 62 int mdoc_parseln(struct mdoc *, int, char *, int); 63 void mdoc_endparse(struct mdoc *); 64 void mdoc_addspan(struct mdoc *, const struct tbl_span *); 65 void mdoc_addeqn(struct mdoc *, const struct eqn *); 66 67 void man_free(struct man *); 68 struct man *man_alloc(struct roff *, struct mparse *, 69 const char *, int); 70 void man_reset(struct man *); 71 int man_parseln(struct man *, int, char *, int); 72 void man_endparse(struct man *); 73 void man_addspan(struct man *, const struct tbl_span *); 74 void man_addeqn(struct man *, const struct eqn *); 75 76 int preconv_cue(const struct buf *, size_t); 77 int preconv_encode(struct buf *, size_t *, 78 struct buf *, size_t *, int *); 79 80 void roff_free(struct roff *); 81 struct roff *roff_alloc(struct mparse *, const struct mchars *, int); 82 void roff_reset(struct roff *); 83 enum rofferr roff_parseln(struct roff *, int, struct buf *, int *); 84 void roff_endparse(struct roff *); 85 void roff_setreg(struct roff *, const char *, int, char sign); 86 int roff_getreg(const struct roff *, const char *); 87 char *roff_strdup(const struct roff *, const char *); 88 int roff_getcontrol(const struct roff *, 89 const char *, int *); 90 int roff_getformat(const struct roff *); 91 92 const struct tbl_span *roff_span(const struct roff *); 93 const struct eqn *roff_eqn(const struct roff *); 94 95 __END_DECLS 96