Annotation of mandoc/libmandoc.h, Revision 1.14
1.14 ! kristaps 1: /* $Id: libmandoc.h,v 1.13 2011/03/20 16:02:05 kristaps Exp $ */
1.1 kristaps 2: /*
1.9 schwarze 3: * Copyright (c) 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
17: #ifndef LIBMANDOC_H
18: #define LIBMANDOC_H
19:
1.14 ! kristaps 20: enum rofferr {
! 21: ROFF_CONT, /* continue processing line */
! 22: ROFF_RERUN, /* re-run roff interpreter with offset */
! 23: ROFF_APPEND, /* re-run main parser, appending next line */
! 24: ROFF_REPARSE, /* re-run main parser on the result */
! 25: ROFF_SO, /* include another file */
! 26: ROFF_IGN, /* ignore current line */
! 27: ROFF_TBL, /* a table row was successfully parsed */
! 28: ROFF_EQN, /* an equation was successfully parsed */
! 29: ROFF_ERR /* badness: puke and stop */
! 30: };
! 31:
! 32: /*
! 33: * Available registers (set in libroff, accessed elsewhere).
! 34: */
! 35: enum regs {
! 36: REG_nS = 0,
! 37: REG__MAX
! 38: };
! 39:
! 40: /*
! 41: * A register (struct reg) can consist of many types: this consists of
! 42: * normalised types from the original string form.
! 43: */
! 44: union regval {
! 45: unsigned u; /* unsigned integer */
! 46: };
! 47:
! 48: /*
! 49: * A single register entity. If "set" is zero, the value of the
! 50: * register should be the default one, which is per-register. It's
! 51: * assumed that callers know which type in "v" corresponds to which
! 52: * register value.
! 53: */
! 54: struct reg {
! 55: int set; /* whether set or not */
! 56: union regval v; /* parsed data */
! 57: };
! 58:
! 59: /*
! 60: * The primary interface to setting register values is in libroff,
! 61: * although libmdoc and libman from time to time will manipulate
! 62: * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
! 63: */
! 64: struct regset {
! 65: struct reg regs[REG__MAX];
! 66: };
! 67:
1.1 kristaps 68: __BEGIN_DECLS
69:
1.14 ! kristaps 70: struct roff;
! 71: struct mdoc;
! 72: struct man;
! 73:
! 74: void mandoc_msg(enum mandocerr, struct mparse *,
! 75: int, int, const char *);
! 76: void mandoc_vmsg(enum mandocerr, struct mparse *,
! 77: int, int, const char *, ...);
! 78: int mandoc_special(char *);
! 79: char *mandoc_strdup(const char *);
! 80: char *mandoc_getarg(struct mparse *, char **, int, int *);
! 81: char *mandoc_normdate(struct mparse *, char *, int, int);
! 82: int mandoc_eos(const char *, size_t, int);
! 83: int mandoc_hyph(const char *, const char *);
! 84:
! 85: void mdoc_free(struct mdoc *);
! 86: struct mdoc *mdoc_alloc(struct regset *, struct mparse *);
! 87: void mdoc_reset(struct mdoc *);
! 88: int mdoc_parseln(struct mdoc *, int, char *, int);
! 89: int mdoc_endparse(struct mdoc *);
! 90: int mdoc_addspan(struct mdoc *, const struct tbl_span *);
! 91: int mdoc_addeqn(struct mdoc *, const struct eqn *);
! 92:
! 93: void man_free(struct man *);
! 94: struct man *man_alloc(struct regset *, struct mparse *);
! 95: void man_reset(struct man *);
! 96: int man_parseln(struct man *, int, char *, int);
! 97: int man_endparse(struct man *);
! 98: int man_addspan(struct man *, const struct tbl_span *);
! 99: int man_addeqn(struct man *, const struct eqn *);
! 100:
! 101: void roff_free(struct roff *);
! 102: struct roff *roff_alloc(struct regset *, struct mparse *);
! 103: void roff_reset(struct roff *);
! 104: enum rofferr roff_parseln(struct roff *, int,
! 105: char **, size_t *, int, int *);
! 106: void roff_endparse(struct roff *);
! 107:
! 108: const struct tbl_span *roff_span(const struct roff *);
! 109: const struct eqn *roff_eqn(const struct roff *);
! 110:
1.1 kristaps 111:
112: __END_DECLS
113:
114: #endif /*!LIBMANDOC_H*/
CVSweb