Annotation of src/usr.bin/mandoc/libman.h, Revision 1.39
1.39 ! schwarze 1: /* $OpenBSD$ */
1.1 kristaps 2: /*
1.29 schwarze 3: * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.39 ! 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.2 schwarze 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.2 schwarze 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: #ifndef LIBMAN_H
19: #define LIBMAN_H
20:
21: enum man_next {
22: MAN_NEXT_SIBLING = 0,
23: MAN_NEXT_CHILD
24: };
25:
26: struct man {
1.29 schwarze 27: struct mparse *parse; /* parse pointer */
1.33 schwarze 28: int quick; /* abort parse early */
1.15 schwarze 29: int flags; /* parse flags */
1.12 schwarze 30: #define MAN_ELINE (1 << 1) /* Next-line element scope. */
31: #define MAN_BLINE (1 << 2) /* Next-line block scope. */
32: #define MAN_LITERAL (1 << 4) /* Literal input. */
1.27 schwarze 33: #define MAN_NEWLINE (1 << 6) /* first macro/text in a line */
1.23 schwarze 34: enum man_next next; /* where to put the next node */
35: struct man_node *last; /* the last parsed node */
36: struct man_node *first; /* the first parsed node */
37: struct man_meta meta; /* document meta-data */
1.30 schwarze 38: struct roff *roff;
1.1 kristaps 39: };
40:
1.32 schwarze 41: #define MACRO_PROT_ARGS struct man *man, \
1.23 schwarze 42: enum mant tok, \
43: int line, \
44: int ppos, \
45: int *pos, \
46: char *buf
1.7 schwarze 47:
48: struct man_macro {
49: int (*fp)(MACRO_PROT_ARGS);
50: int flags;
51: #define MAN_SCOPED (1 << 0)
1.8 schwarze 52: #define MAN_EXPLICIT (1 << 1) /* See blk_imp(). */
53: #define MAN_FSCOPED (1 << 2) /* See blk_imp(). */
1.12 schwarze 54: #define MAN_NSCOPED (1 << 3) /* See in_line_eoln(). */
1.13 schwarze 55: #define MAN_NOCLOSE (1 << 4) /* See blk_exp(). */
1.31 schwarze 56: #define MAN_BSCOPE (1 << 5) /* Break BLINE scope. */
1.39 ! schwarze 57: #define MAN_JOIN (1 << 6) /* Join arguments together. */
1.7 schwarze 58: };
59:
60: extern const struct man_macro *const man_macros;
61:
1.1 kristaps 62: __BEGIN_DECLS
63:
64: int man_word_alloc(struct man *, int, int, const char *);
1.39 ! schwarze 65: void man_word_append(struct man *, const char *);
1.13 schwarze 66: int man_block_alloc(struct man *, int, int, enum mant);
67: int man_head_alloc(struct man *, int, int, enum mant);
1.29 schwarze 68: int man_tail_alloc(struct man *, int, int, enum mant);
1.13 schwarze 69: int man_body_alloc(struct man *, int, int, enum mant);
70: int man_elem_alloc(struct man *, int, int, enum mant);
71: void man_node_delete(struct man *, struct man_node *);
1.9 schwarze 72: void man_hash_init(void);
1.29 schwarze 73: enum mant man_hash_find(const char *);
1.1 kristaps 74: int man_macroend(struct man *);
75: int man_valid_post(struct man *);
1.35 schwarze 76: int man_unscope(struct man *, const struct man_node *);
1.1 kristaps 77:
78: __END_DECLS
79:
80: #endif /*!LIBMAN_H*/