Annotation of mandoc/libman.h, Revision 1.24
1.24 ! kristaps 1: /* $Id: libman.h,v 1.23 2009/10/30 05:58:36 kristaps Exp $ */
1.1 kristaps 2: /*
1.9 kristaps 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.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: #include "man.h"
21:
22: enum man_next {
23: MAN_NEXT_SIBLING = 0,
24: MAN_NEXT_CHILD
25: };
26:
27: struct man {
1.4 kristaps 28: void *data;
29: struct man_cb cb;
1.6 kristaps 30: int pflags;
1.1 kristaps 31: int flags;
1.2 kristaps 32: #define MAN_HALT (1 << 0)
1.24 ! kristaps 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.10 kristaps 43: enum merr {
1.14 kristaps 44: WNPRINT = 0,
1.10 kristaps 45: WMSEC,
46: WDATE,
47: WLNSCOPE,
48: WTSPACE,
1.11 kristaps 49: WTQUOTE,
50: WNODATA,
1.12 kristaps 51: WNOTITLE,
1.14 kristaps 52: WESCAPE,
1.15 kristaps 53: WNUMFMT,
1.16 kristaps 54: WHEADARGS,
55: WBODYARGS,
56: WNHEADARGS,
57: WMACROFORM,
58: WEXITSCOPE,
1.17 kristaps 59: WNOSCOPE,
1.19 kristaps 60: WOLITERAL,
61: WNLITERAL,
1.14 kristaps 62: WERRMAX
1.10 kristaps 63: };
64:
1.16 kristaps 65: #define MACRO_PROT_ARGS struct man *m, int tok, int line, \
66: int ppos, int *pos, char *buf
67:
68: struct man_macro {
69: int (*fp)(MACRO_PROT_ARGS);
70: int flags;
71: #define MAN_SCOPED (1 << 0)
1.20 kristaps 72: #define MAN_EXPLICIT (1 << 1) /* See blk_imp(). */
73: #define MAN_FSCOPED (1 << 2) /* See blk_imp(). */
1.24 ! kristaps 74: #define MAN_NSCOPED (1 << 3) /* See in_line_eoln(). */
1.16 kristaps 75: };
76:
77: extern const struct man_macro *const man_macros;
78:
1.1 kristaps 79: __BEGIN_DECLS
80:
1.10 kristaps 81: #define man_perr(m, l, p, t) \
1.13 kristaps 82: man_err((m), (l), (p), 1, (t))
1.10 kristaps 83: #define man_pwarn(m, l, p, t) \
1.13 kristaps 84: man_err((m), (l), (p), 0, (t))
1.10 kristaps 85: #define man_nerr(m, n, t) \
86: man_err((m), (n)->line, (n)->pos, 1, (t))
87: #define man_nwarn(m, n, t) \
88: man_err((m), (n)->line, (n)->pos, 0, (t))
89:
1.1 kristaps 90: int man_word_alloc(struct man *, int, int, const char *);
1.16 kristaps 91: int man_block_alloc(struct man *, int, int, int);
92: int man_head_alloc(struct man *, int, int, int);
93: int man_body_alloc(struct man *, int, int, int);
1.1 kristaps 94: int man_elem_alloc(struct man *, int, int, int);
95: void man_node_free(struct man_node *);
96: void man_node_freelist(struct man_node *);
1.21 kristaps 97: void man_hash_init(void);
98: int man_hash_find(const char *);
1.3 kristaps 99: int man_macroend(struct man *);
1.16 kristaps 100: int man_args(struct man *, int, int *, char *, char **);
101: #define ARGS_ERROR (-1)
102: #define ARGS_EOLN (0)
103: #define ARGS_WORD (1)
104: #define ARGS_QWORD (1)
105: int man_err(struct man *, int, int, int, enum merr);
1.4 kristaps 106: int man_vwarn(struct man *, int, int, const char *, ...);
107: int man_verr(struct man *, int, int, const char *, ...);
1.5 kristaps 108: int man_valid_post(struct man *);
1.16 kristaps 109: int man_valid_pre(struct man *, const struct man_node *);
1.5 kristaps 110: int man_action_post(struct man *);
1.19 kristaps 111: int man_action_pre(struct man *, struct man_node *);
1.16 kristaps 112: int man_unscope(struct man *, const struct man_node *);
1.1 kristaps 113:
114: __END_DECLS
115:
116: #endif /*!LIBMAN_H*/
CVSweb