]> git.cameronkatri.com Git - mandoc.git/blob - libman.h
`IP' and `TP' correctly handle width arguments.
[mandoc.git] / libman.h
1 /* $Id: libman.h,v 1.16 2009/08/13 11:45:29 kristaps Exp $ */
2 /*
3 * Copyright (c) 2009 Kristaps Dzonsons <kristaps@kth.se>
4 *
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
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.
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 void *htab;
31 int pflags;
32 int flags;
33 #define MAN_HALT (1 << 0)
34 #define MAN_ELINE (1 << 1) /* Next-line element scope. */
35 #define MAN_BLINE (1 << 2) /* Next-line block scope. */
36 enum man_next next;
37 struct man_node *last;
38 struct man_node *first;
39 struct man_meta meta;
40 };
41
42 enum merr {
43 WNPRINT = 0,
44 WNMEM,
45 WMSEC,
46 WDATE,
47 WLNSCOPE,
48 WTSPACE,
49 WTQUOTE,
50 WNODATA,
51 WNOTITLE,
52 WESCAPE,
53 WNUMFMT,
54 WHEADARGS,
55 WBODYARGS,
56 WNHEADARGS,
57 WMACRO,
58 WMACROFORM,
59 WEXITSCOPE,
60 WERRMAX
61 };
62
63 #define MACRO_PROT_ARGS struct man *m, int tok, int line, \
64 int ppos, int *pos, char *buf
65
66 struct man_macro {
67 int (*fp)(MACRO_PROT_ARGS);
68 int flags;
69 #define MAN_SCOPED (1 << 0)
70 };
71
72 extern const struct man_macro *const man_macros;
73
74 __BEGIN_DECLS
75
76 #define man_perr(m, l, p, t) \
77 man_err((m), (l), (p), 1, (t))
78 #define man_pwarn(m, l, p, t) \
79 man_err((m), (l), (p), 0, (t))
80 #define man_nerr(m, n, t) \
81 man_err((m), (n)->line, (n)->pos, 1, (t))
82 #define man_nwarn(m, n, t) \
83 man_err((m), (n)->line, (n)->pos, 0, (t))
84
85 int man_word_alloc(struct man *, int, int, const char *);
86 int man_block_alloc(struct man *, int, int, int);
87 int man_head_alloc(struct man *, int, int, int);
88 int man_body_alloc(struct man *, int, int, int);
89 int man_elem_alloc(struct man *, int, int, int);
90 void man_node_free(struct man_node *);
91 void man_node_freelist(struct man_node *);
92 void *man_hash_alloc(void);
93 int man_hash_find(const void *, const char *);
94 void man_hash_free(void *);
95 int man_macroend(struct man *);
96 int man_args(struct man *, int, int *, char *, char **);
97 #define ARGS_ERROR (-1)
98 #define ARGS_EOLN (0)
99 #define ARGS_WORD (1)
100 #define ARGS_QWORD (1)
101 int man_err(struct man *, int, int, int, enum merr);
102 int man_vwarn(struct man *, int, int, const char *, ...);
103 int man_verr(struct man *, int, int, const char *, ...);
104 int man_valid_post(struct man *);
105 int man_valid_pre(struct man *, const struct man_node *);
106 int man_action_post(struct man *);
107 int man_unscope(struct man *, const struct man_node *);
108
109 __END_DECLS
110
111 #endif /*!LIBMAN_H*/