1241675Suqs/* $Id: libmandoc.h,v 1.29 2011/12/02 01:37:14 schwarze Exp $ */ 2241675Suqs/* 3241675Suqs * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4241675Suqs * 5241675Suqs * Permission to use, copy, modify, and distribute this software for any 6241675Suqs * purpose with or without fee is hereby granted, provided that the above 7241675Suqs * copyright notice and this permission notice appear in all copies. 8241675Suqs * 9241675Suqs * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10241675Suqs * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11241675Suqs * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12241675Suqs * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13241675Suqs * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14241675Suqs * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15241675Suqs * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16241675Suqs */ 17241675Suqs#ifndef LIBMANDOC_H 18241675Suqs#define LIBMANDOC_H 19241675Suqs 20241675Suqsenum rofferr { 21241675Suqs ROFF_CONT, /* continue processing line */ 22241675Suqs ROFF_RERUN, /* re-run roff interpreter with offset */ 23241675Suqs ROFF_APPEND, /* re-run main parser, appending next line */ 24241675Suqs ROFF_REPARSE, /* re-run main parser on the result */ 25241675Suqs ROFF_SO, /* include another file */ 26241675Suqs ROFF_IGN, /* ignore current line */ 27241675Suqs ROFF_TBL, /* a table row was successfully parsed */ 28241675Suqs ROFF_EQN, /* an equation was successfully parsed */ 29241675Suqs ROFF_ERR /* badness: puke and stop */ 30241675Suqs}; 31241675Suqs 32241675Suqsenum regs { 33241675Suqs REG_nS = 0, /* nS register */ 34241675Suqs REG__MAX 35241675Suqs}; 36241675Suqs 37241675Suqs__BEGIN_DECLS 38241675Suqs 39241675Suqsstruct roff; 40241675Suqsstruct mdoc; 41241675Suqsstruct man; 42241675Suqs 43241675Suqsvoid mandoc_msg(enum mandocerr, struct mparse *, 44241675Suqs int, int, const char *); 45241675Suqsvoid mandoc_vmsg(enum mandocerr, struct mparse *, 46241675Suqs int, int, const char *, ...); 47241675Suqschar *mandoc_getarg(struct mparse *, char **, int, int *); 48241675Suqschar *mandoc_normdate(struct mparse *, char *, int, int); 49241675Suqsint mandoc_eos(const char *, size_t, int); 50241675Suqsint mandoc_getcontrol(const char *, int *); 51241675Suqsint mandoc_strntoi(const char *, size_t, int); 52241675Suqsconst char *mandoc_a2msec(const char*); 53241675Suqs 54241675Suqsvoid mdoc_free(struct mdoc *); 55241675Suqsstruct mdoc *mdoc_alloc(struct roff *, struct mparse *); 56241675Suqsvoid mdoc_reset(struct mdoc *); 57241675Suqsint mdoc_parseln(struct mdoc *, int, char *, int); 58241675Suqsint mdoc_endparse(struct mdoc *); 59241675Suqsint mdoc_addspan(struct mdoc *, const struct tbl_span *); 60241675Suqsint mdoc_addeqn(struct mdoc *, const struct eqn *); 61241675Suqs 62241675Suqsvoid man_free(struct man *); 63241675Suqsstruct man *man_alloc(struct roff *, struct mparse *); 64241675Suqsvoid man_reset(struct man *); 65241675Suqsint man_parseln(struct man *, int, char *, int); 66241675Suqsint man_endparse(struct man *); 67241675Suqsint man_addspan(struct man *, const struct tbl_span *); 68241675Suqsint man_addeqn(struct man *, const struct eqn *); 69241675Suqs 70241675Suqsvoid roff_free(struct roff *); 71241675Suqsstruct roff *roff_alloc(struct mparse *); 72241675Suqsvoid roff_reset(struct roff *); 73241675Suqsenum rofferr roff_parseln(struct roff *, int, 74241675Suqs char **, size_t *, int, int *); 75241675Suqsvoid roff_endparse(struct roff *); 76241675Suqsint roff_regisset(const struct roff *, enum regs); 77241675Suqsunsigned int roff_regget(const struct roff *, enum regs); 78241675Suqsvoid roff_regunset(struct roff *, enum regs); 79241675Suqschar *roff_strdup(const struct roff *, const char *); 80241675Suqs#if 0 81241675Suqschar roff_eqndelim(const struct roff *); 82241675Suqsvoid roff_openeqn(struct roff *, const char *, 83241675Suqs int, int, const char *); 84241675Suqsint roff_closeeqn(struct roff *); 85241675Suqs#endif 86241675Suqs 87241675Suqsconst struct tbl_span *roff_span(const struct roff *); 88241675Suqsconst struct eqn *roff_eqn(const struct roff *); 89241675Suqs 90241675Suqs__END_DECLS 91241675Suqs 92241675Suqs#endif /*!LIBMANDOC_H*/ 93