Annotation of mandoc/libman.h, Revision 1.49
1.49 ! kristaps 1: /* $Id: libman.h,v 1.48 2011/03/22 14:33:05 kristaps Exp $ */
1.1 kristaps 2: /*
1.42 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
1.8 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.8 kristaps 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.
1.1 kristaps 16: */
17: #ifndef LIBMAN_H
18: #define LIBMAN_H
19:
20: enum man_next {
21: MAN_NEXT_SIBLING = 0,
22: MAN_NEXT_CHILD
23: };
24:
25: struct man {
1.47 kristaps 26: struct mparse *parse; /* parse pointer */
1.29 kristaps 27: int flags; /* parse flags */
28: #define MAN_HALT (1 << 0) /* badness happened: die */
1.24 kristaps 29: #define MAN_ELINE (1 << 1) /* Next-line element scope. */
30: #define MAN_BLINE (1 << 2) /* Next-line block scope. */
31: #define MAN_ILINE (1 << 3) /* Ignored in next-line scope. */
32: #define MAN_LITERAL (1 << 4) /* Literal input. */
1.29 kristaps 33: #define MAN_BPLINE (1 << 5)
1.45 kristaps 34: #define MAN_NEWLINE (1 << 6) /* first macro/text in a line */
1.39 kristaps 35: enum man_next next; /* where to put the next node */
36: struct man_node *last; /* the last parsed node */
37: struct man_node *first; /* the first parsed node */
38: struct man_meta meta; /* document meta-data */
1.40 kristaps 39: struct regset *regs; /* registers */
1.1 kristaps 40: };
41:
1.38 kristaps 42: #define MACRO_PROT_ARGS struct man *m, \
43: enum mant tok, \
44: int line, \
45: int ppos, \
46: int *pos, \
47: char *buf
1.16 kristaps 48:
49: struct man_macro {
50: int (*fp)(MACRO_PROT_ARGS);
51: int flags;
52: #define MAN_SCOPED (1 << 0)
1.20 kristaps 53: #define MAN_EXPLICIT (1 << 1) /* See blk_imp(). */
54: #define MAN_FSCOPED (1 << 2) /* See blk_imp(). */
1.24 kristaps 55: #define MAN_NSCOPED (1 << 3) /* See in_line_eoln(). */
1.27 kristaps 56: #define MAN_NOCLOSE (1 << 4) /* See blk_exp(). */
1.16 kristaps 57: };
58:
59: extern const struct man_macro *const man_macros;
60:
1.1 kristaps 61: __BEGIN_DECLS
62:
1.34 kristaps 63: #define man_pmsg(m, l, p, t) \
1.47 kristaps 64: mandoc_msg((t), (m)->parse, (l), (p), NULL)
1.34 kristaps 65: #define man_nmsg(m, n, t) \
1.47 kristaps 66: mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL)
1.1 kristaps 67: int man_word_alloc(struct man *, int, int, const char *);
1.26 kristaps 68: int man_block_alloc(struct man *, int, int, enum mant);
69: int man_head_alloc(struct man *, int, int, enum mant);
1.49 ! kristaps 70: int man_tail_alloc(struct man *, int, int, enum mant);
1.26 kristaps 71: int man_body_alloc(struct man *, int, int, enum mant);
72: int man_elem_alloc(struct man *, int, int, enum mant);
1.27 kristaps 73: void man_node_delete(struct man *, struct man_node *);
1.21 kristaps 74: void man_hash_init(void);
1.26 kristaps 75: enum mant man_hash_find(const char *);
1.3 kristaps 76: int man_macroend(struct man *);
1.16 kristaps 77: int man_args(struct man *, int, int *, char *, char **);
78: #define ARGS_ERROR (-1)
79: #define ARGS_EOLN (0)
80: #define ARGS_WORD (1)
81: #define ARGS_QWORD (1)
1.5 kristaps 82: int man_valid_post(struct man *);
1.35 kristaps 83: int man_valid_pre(struct man *, struct man_node *);
1.28 kristaps 84: int man_unscope(struct man *,
1.34 kristaps 85: const struct man_node *, enum mandocerr);
1.1 kristaps 86:
87: __END_DECLS
88:
89: #endif /*!LIBMAN_H*/
CVSweb