1 /* $OpenBSD: libmandoc.h,v 1.34 2014/11/01 06:02:43 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 #ifndef LIBMANDOC_H 19 #define LIBMANDOC_H 20 21 enum rofferr { 22 ROFF_CONT, /* continue processing line */ 23 ROFF_RERUN, /* re-run roff interpreter with offset */ 24 ROFF_APPEND, /* re-run main parser, appending next line */ 25 ROFF_REPARSE, /* re-run main parser on the result */ 26 ROFF_SO, /* include another file */ 27 ROFF_IGN, /* ignore current line */ 28 ROFF_TBL, /* a table row was successfully parsed */ 29 ROFF_EQN, /* an equation was successfully parsed */ 30 ROFF_ERR /* badness: puke and stop */ 31 }; 32 33 struct buf { 34 char *buf; 35 size_t sz; 36 }; 37 38 __BEGIN_DECLS 39 40 struct roff; 41 struct mdoc; 42 struct man; 43 44 void mandoc_msg(enum mandocerr, struct mparse *, 45 int, int, const char *); 46 void mandoc_vmsg(enum mandocerr, struct mparse *, 47 int, int, const char *, ...); 48 char *mandoc_getarg(struct mparse *, char **, int, int *); 49 char *mandoc_normdate(struct mparse *, char *, int, int); 50 int mandoc_eos(const char *, size_t); 51 int mandoc_strntoi(const char *, size_t, int); 52 const char *mandoc_a2msec(const char*); 53 54 void mdoc_free(struct mdoc *); 55 struct mdoc *mdoc_alloc(struct roff *, struct mparse *, 56 const char *, int); 57 void mdoc_reset(struct mdoc *); 58 int mdoc_parseln(struct mdoc *, int, char *, int); 59 int mdoc_endparse(struct mdoc *); 60 int mdoc_addspan(struct mdoc *, const struct tbl_span *); 61 int mdoc_addeqn(struct mdoc *, const struct eqn *); 62 63 void man_free(struct man *); 64 struct man *man_alloc(struct roff *, struct mparse *, int); 65 void man_reset(struct man *); 66 int man_parseln(struct man *, int, char *, int); 67 int man_endparse(struct man *); 68 int man_addspan(struct man *, const struct tbl_span *); 69 int man_addeqn(struct man *, const struct eqn *); 70 71 int preconv_cue(const struct buf *, size_t); 72 int preconv_encode(struct buf *, size_t *, 73 struct buf *, size_t *, int *); 74 75 void roff_free(struct roff *); 76 struct roff *roff_alloc(struct mparse *, const struct mchars *, int); 77 void roff_reset(struct roff *); 78 enum rofferr roff_parseln(struct roff *, int, struct buf *, int *); 79 void roff_endparse(struct roff *); 80 void roff_setreg(struct roff *, const char *, int, char sign); 81 int roff_getreg(const struct roff *, const char *); 82 char *roff_strdup(const struct roff *, const char *); 83 int roff_getcontrol(const struct roff *, 84 const char *, int *); 85 int roff_getformat(const struct roff *); 86 87 const struct tbl_span *roff_span(const struct roff *); 88 const struct eqn *roff_eqn(const struct roff *); 89 90 __END_DECLS 91 92 #endif /*!LIBMANDOC_H*/ 93