1 /* $OpenBSD: libmandoc.h,v 1.37 2014/12/01 08:05:02 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 ROFF_ERR /* badness: puke and stop */ 29 }; 30 31 struct buf { 32 char *buf; 33 size_t sz; 34 }; 35 36 __BEGIN_DECLS 37 38 struct mparse; 39 struct mchars; 40 enum mandocerr; 41 struct tbl_span; 42 struct eqn; 43 struct roff; 44 struct mdoc; 45 struct man; 46 47 void mandoc_msg(enum mandocerr, struct mparse *, 48 int, int, const char *); 49 void mandoc_vmsg(enum mandocerr, struct mparse *, 50 int, int, const char *, ...); 51 char *mandoc_getarg(struct mparse *, char **, int, int *); 52 char *mandoc_normdate(struct mparse *, char *, int, int); 53 int mandoc_eos(const char *, size_t); 54 int mandoc_strntoi(const char *, size_t, int); 55 const char *mandoc_a2msec(const char*); 56 57 void mdoc_free(struct mdoc *); 58 struct mdoc *mdoc_alloc(struct roff *, struct mparse *, 59 const char *, int); 60 void mdoc_reset(struct mdoc *); 61 int mdoc_parseln(struct mdoc *, int, char *, int); 62 int mdoc_endparse(struct mdoc *); 63 void mdoc_addspan(struct mdoc *, const struct tbl_span *); 64 void mdoc_addeqn(struct mdoc *, const struct eqn *); 65 66 void man_free(struct man *); 67 struct man *man_alloc(struct roff *, struct mparse *, int); 68 void man_reset(struct man *); 69 int man_parseln(struct man *, int, char *, int); 70 int man_endparse(struct man *); 71 void man_addspan(struct man *, const struct tbl_span *); 72 void man_addeqn(struct man *, const struct eqn *); 73 74 int preconv_cue(const struct buf *, size_t); 75 int preconv_encode(struct buf *, size_t *, 76 struct buf *, size_t *, int *); 77 78 void roff_free(struct roff *); 79 struct roff *roff_alloc(struct mparse *, const struct mchars *, int); 80 void roff_reset(struct roff *); 81 enum rofferr roff_parseln(struct roff *, int, struct buf *, int *); 82 void roff_endparse(struct roff *); 83 void roff_setreg(struct roff *, const char *, int, char sign); 84 int roff_getreg(const 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 90 const struct tbl_span *roff_span(const struct roff *); 91 const struct eqn *roff_eqn(const struct roff *); 92 93 __END_DECLS 94