Annotation of mandoc/libman.h, Revision 1.66
1.66 ! schwarze 1: /* $Id: libman.h,v 1.65 2014/11/28 05:51:32 schwarze Exp $ */
1.1 kristaps 2: /*
1.54 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.64 schwarze 4: * Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.8 kristaps 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.8 kristaps 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.
1.1 kristaps 17: */
18:
19: enum man_next {
20: MAN_NEXT_SIBLING = 0,
21: MAN_NEXT_CHILD
22: };
23:
24: struct man {
1.47 kristaps 25: struct mparse *parse; /* parse pointer */
1.57 schwarze 26: int quick; /* abort parse early */
1.29 kristaps 27: int flags; /* parse flags */
1.24 kristaps 28: #define MAN_ELINE (1 << 1) /* Next-line element scope. */
29: #define MAN_BLINE (1 << 2) /* Next-line block scope. */
30: #define MAN_LITERAL (1 << 4) /* Literal input. */
1.45 kristaps 31: #define MAN_NEWLINE (1 << 6) /* first macro/text in a line */
1.39 kristaps 32: enum man_next next; /* where to put the next node */
33: struct man_node *last; /* the last parsed node */
34: struct man_node *first; /* the first parsed node */
35: struct man_meta meta; /* document meta-data */
1.52 kristaps 36: struct roff *roff;
1.1 kristaps 37: };
38:
1.56 schwarze 39: #define MACRO_PROT_ARGS struct man *man, \
1.38 kristaps 40: enum mant tok, \
41: int line, \
42: int ppos, \
43: int *pos, \
44: char *buf
1.16 kristaps 45:
46: struct man_macro {
1.65 schwarze 47: void (*fp)(MACRO_PROT_ARGS);
1.16 kristaps 48: int flags;
49: #define MAN_SCOPED (1 << 0)
1.20 kristaps 50: #define MAN_EXPLICIT (1 << 1) /* See blk_imp(). */
51: #define MAN_FSCOPED (1 << 2) /* See blk_imp(). */
1.24 kristaps 52: #define MAN_NSCOPED (1 << 3) /* See in_line_eoln(). */
1.27 kristaps 53: #define MAN_NOCLOSE (1 << 4) /* See blk_exp(). */
1.55 schwarze 54: #define MAN_BSCOPE (1 << 5) /* Break BLINE scope. */
1.64 schwarze 55: #define MAN_JOIN (1 << 6) /* Join arguments together. */
1.16 kristaps 56: };
57:
58: extern const struct man_macro *const man_macros;
59:
1.1 kristaps 60: __BEGIN_DECLS
61:
1.65 schwarze 62: void man_word_alloc(struct man *, int, int, const char *);
1.64 schwarze 63: void man_word_append(struct man *, const char *);
1.65 schwarze 64: void man_block_alloc(struct man *, int, int, enum mant);
65: void man_head_alloc(struct man *, int, int, enum mant);
66: void man_body_alloc(struct man *, int, int, enum mant);
67: void man_elem_alloc(struct man *, int, int, enum mant);
1.27 kristaps 68: void man_node_delete(struct man *, struct man_node *);
1.21 kristaps 69: void man_hash_init(void);
1.50 kristaps 70: enum mant man_hash_find(const char *);
1.65 schwarze 71: void man_macroend(struct man *);
72: void man_valid_post(struct man *);
73: void man_unscope(struct man *, const struct man_node *);
1.1 kristaps 74:
75: __END_DECLS
CVSweb