Annotation of src/usr.bin/mandoc/libman.h, Revision 1.17
1.17 ! schwarze 1: /* $Id: libman.h,v 1.16 2010/04/25 16:32:19 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;
1.15 schwarze 30: int pflags; /* parse flags (see man.h) */
31: int svflags; /* flags saved during roff blocks */
32: int flags; /* parse flags */
33: #define MAN_HALT (1 << 0) /* badness happened: die */
1.12 schwarze 34: #define MAN_ELINE (1 << 1) /* Next-line element scope. */
35: #define MAN_BLINE (1 << 2) /* Next-line block scope. */
36: #define MAN_ILINE (1 << 3) /* Ignored in next-line scope. */
37: #define MAN_LITERAL (1 << 4) /* Literal input. */
1.15 schwarze 38: #define MAN_BPLINE (1 << 5)
1.16 schwarze 39: #define MAN_EL_USE (1 << 6) /* Following .el will be used. */
1.1 kristaps 40: enum man_next next;
1.15 schwarze 41: enum man_next svnext;
1.1 kristaps 42: struct man_node *last;
43: struct man_node *first;
44: struct man_meta meta;
45: };
46:
1.3 schwarze 47: enum merr {
1.5 schwarze 48: WNPRINT = 0,
1.3 schwarze 49: WMSEC,
50: WDATE,
51: WLNSCOPE,
1.12 schwarze 52: WLNSCOPE2,
1.3 schwarze 53: WTSPACE,
54: WTQUOTE,
55: WNODATA,
1.4 schwarze 56: WNOTITLE,
1.5 schwarze 57: WESCAPE,
1.6 schwarze 58: WNUMFMT,
1.7 schwarze 59: WHEADARGS,
60: WBODYARGS,
61: WNHEADARGS,
62: WMACROFORM,
63: WEXITSCOPE,
1.8 schwarze 64: WNOSCOPE,
65: WOLITERAL,
66: WNLITERAL,
1.13 schwarze 67: WROFFNEST,
1.14 schwarze 68: WROFFSCOPE,
69: WTITLECASE,
1.17 ! schwarze 70: WBADCOMMENT,
1.5 schwarze 71: WERRMAX
1.3 schwarze 72: };
73:
1.13 schwarze 74: #define MACRO_PROT_ARGS struct man *m, enum mant tok, int line, \
1.7 schwarze 75: int ppos, int *pos, char *buf
76:
77: struct man_macro {
78: int (*fp)(MACRO_PROT_ARGS);
79: int flags;
80: #define MAN_SCOPED (1 << 0)
1.8 schwarze 81: #define MAN_EXPLICIT (1 << 1) /* See blk_imp(). */
82: #define MAN_FSCOPED (1 << 2) /* See blk_imp(). */
1.12 schwarze 83: #define MAN_NSCOPED (1 << 3) /* See in_line_eoln(). */
1.13 schwarze 84: #define MAN_NOCLOSE (1 << 4) /* See blk_exp(). */
1.7 schwarze 85: };
86:
87: extern const struct man_macro *const man_macros;
88:
1.1 kristaps 89: __BEGIN_DECLS
90:
1.3 schwarze 91: #define man_perr(m, l, p, t) \
1.5 schwarze 92: man_err((m), (l), (p), 1, (t))
1.3 schwarze 93: #define man_pwarn(m, l, p, t) \
1.5 schwarze 94: man_err((m), (l), (p), 0, (t))
1.3 schwarze 95: #define man_nerr(m, n, t) \
96: man_err((m), (n)->line, (n)->pos, 1, (t))
97: #define man_nwarn(m, n, t) \
98: man_err((m), (n)->line, (n)->pos, 0, (t))
99:
1.1 kristaps 100: int man_word_alloc(struct man *, int, int, const char *);
1.13 schwarze 101: int man_block_alloc(struct man *, int, int, enum mant);
102: int man_head_alloc(struct man *, int, int, enum mant);
103: int man_body_alloc(struct man *, int, int, enum mant);
104: int man_elem_alloc(struct man *, int, int, enum mant);
105: void man_node_delete(struct man *, struct man_node *);
1.9 schwarze 106: void man_hash_init(void);
1.13 schwarze 107: enum mant man_hash_find(const char *);
1.1 kristaps 108: int man_macroend(struct man *);
1.7 schwarze 109: int man_args(struct man *, int, int *, char *, char **);
110: #define ARGS_ERROR (-1)
111: #define ARGS_EOLN (0)
112: #define ARGS_WORD (1)
113: #define ARGS_QWORD (1)
114: int man_err(struct man *, int, int, int, enum merr);
1.1 kristaps 115: int man_vwarn(struct man *, int, int, const char *, ...);
116: int man_verr(struct man *, int, int, const char *, ...);
117: int man_valid_post(struct man *);
1.7 schwarze 118: int man_valid_pre(struct man *, const struct man_node *);
1.1 kristaps 119: int man_action_post(struct man *);
1.8 schwarze 120: int man_action_pre(struct man *, struct man_node *);
1.14 schwarze 121: int man_unscope(struct man *,
122: const struct man_node *, enum merr);
1.16 schwarze 123: int man_brace_close(struct man *, int, int);
1.1 kristaps 124:
125: __END_DECLS
126:
127: #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