Annotation of src/usr.bin/mandoc/libman.h, Revision 1.14
1.14 ! schwarze 1: /* $Id: libman.h,v 1.13 2010/03/26 01:22:05 schwarze Exp $ */
1.1 kristaps 2: /*
1.2 schwarze 3: * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 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.2 schwarze 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: #include "man.h"
21:
22: enum man_next {
23: MAN_NEXT_SIBLING = 0,
24: MAN_NEXT_CHILD
25: };
26:
27: struct man {
28: void *data;
29: struct man_cb cb;
30: int pflags;
31: int flags;
32: #define MAN_HALT (1 << 0)
1.12 schwarze 33: #define MAN_ELINE (1 << 1) /* Next-line element scope. */
34: #define MAN_BLINE (1 << 2) /* Next-line block scope. */
35: #define MAN_ILINE (1 << 3) /* Ignored in next-line scope. */
36: #define MAN_LITERAL (1 << 4) /* Literal input. */
1.1 kristaps 37: enum man_next next;
38: struct man_node *last;
39: struct man_node *first;
40: struct man_meta meta;
41: };
42:
1.3 schwarze 43: enum merr {
1.5 schwarze 44: WNPRINT = 0,
1.3 schwarze 45: WMSEC,
46: WDATE,
47: WLNSCOPE,
1.12 schwarze 48: WLNSCOPE2,
1.3 schwarze 49: WTSPACE,
50: WTQUOTE,
51: WNODATA,
1.4 schwarze 52: WNOTITLE,
1.5 schwarze 53: WESCAPE,
1.6 schwarze 54: WNUMFMT,
1.7 schwarze 55: WHEADARGS,
56: WBODYARGS,
57: WNHEADARGS,
58: WMACROFORM,
59: WEXITSCOPE,
1.8 schwarze 60: WNOSCOPE,
61: WOLITERAL,
62: WNLITERAL,
1.13 schwarze 63: WROFFNEST,
1.14 ! schwarze 64: WROFFSCOPE,
! 65: WTITLECASE,
1.5 schwarze 66: WERRMAX
1.3 schwarze 67: };
68:
1.13 schwarze 69: #define MACRO_PROT_ARGS struct man *m, enum mant tok, int line, \
1.7 schwarze 70: int ppos, int *pos, char *buf
71:
72: struct man_macro {
73: int (*fp)(MACRO_PROT_ARGS);
74: int flags;
75: #define MAN_SCOPED (1 << 0)
1.8 schwarze 76: #define MAN_EXPLICIT (1 << 1) /* See blk_imp(). */
77: #define MAN_FSCOPED (1 << 2) /* See blk_imp(). */
1.12 schwarze 78: #define MAN_NSCOPED (1 << 3) /* See in_line_eoln(). */
1.13 schwarze 79: #define MAN_NOCLOSE (1 << 4) /* See blk_exp(). */
1.7 schwarze 80: };
81:
82: extern const struct man_macro *const man_macros;
83:
1.1 kristaps 84: __BEGIN_DECLS
85:
1.3 schwarze 86: #define man_perr(m, l, p, t) \
1.5 schwarze 87: man_err((m), (l), (p), 1, (t))
1.3 schwarze 88: #define man_pwarn(m, l, p, t) \
1.5 schwarze 89: man_err((m), (l), (p), 0, (t))
1.3 schwarze 90: #define man_nerr(m, n, t) \
91: man_err((m), (n)->line, (n)->pos, 1, (t))
92: #define man_nwarn(m, n, t) \
93: man_err((m), (n)->line, (n)->pos, 0, (t))
94:
1.1 kristaps 95: int man_word_alloc(struct man *, int, int, const char *);
1.13 schwarze 96: int man_block_alloc(struct man *, int, int, enum mant);
97: int man_head_alloc(struct man *, int, int, enum mant);
98: int man_body_alloc(struct man *, int, int, enum mant);
99: int man_elem_alloc(struct man *, int, int, enum mant);
100: void man_node_delete(struct man *, struct man_node *);
1.9 schwarze 101: void man_hash_init(void);
1.13 schwarze 102: enum mant man_hash_find(const char *);
1.1 kristaps 103: int man_macroend(struct man *);
1.7 schwarze 104: int man_args(struct man *, int, int *, char *, char **);
105: #define ARGS_ERROR (-1)
106: #define ARGS_EOLN (0)
107: #define ARGS_WORD (1)
108: #define ARGS_QWORD (1)
109: int man_err(struct man *, int, int, int, enum merr);
1.1 kristaps 110: int man_vwarn(struct man *, int, int, const char *, ...);
111: int man_verr(struct man *, int, int, const char *, ...);
112: int man_valid_post(struct man *);
1.7 schwarze 113: int man_valid_pre(struct man *, const struct man_node *);
1.1 kristaps 114: int man_action_post(struct man *);
1.8 schwarze 115: int man_action_pre(struct man *, struct man_node *);
1.14 ! schwarze 116: int man_unscope(struct man *,
! 117: const struct man_node *, enum merr);
1.1 kristaps 118:
119: __END_DECLS
120:
121: #endif /*!LIBMAN_H*/
![[BACK]](/icons/back.gif){kind=icon}
Return to libman.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc