Annotation of mandoc/libmdoc.h, Revision 1.19
1.19 ! kristaps 1: /* $Id: libmdoc.h,v 1.18 2009/07/12 20:50:08 kristaps Exp $ */
1.1 kristaps 2: /*
1.7 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.6 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.6 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 LIBMDOC_H
18: #define LIBMDOC_H
19:
20: #include "mdoc.h"
21:
22: enum mdoc_next {
23: MDOC_NEXT_SIBLING = 0,
24: MDOC_NEXT_CHILD
25: };
26:
27: struct mdoc {
28: void *data;
29: struct mdoc_cb cb;
30: void *htab;
31: int flags;
1.11 kristaps 32: #define MDOC_HALT (1 << 0) /* Error in parse. Halt. */
33: #define MDOC_LITERAL (1 << 1) /* In a literal scope. */
34: #define MDOC_PBODY (1 << 2) /* In the document body. */
1.1 kristaps 35: int pflags;
36: enum mdoc_next next;
37: struct mdoc_node *last;
38: struct mdoc_node *first;
39: struct mdoc_meta meta;
40: enum mdoc_sec lastnamed;
41: enum mdoc_sec lastsec;
42: };
43:
1.13 kristaps 44: enum merr {
1.14 kristaps 45: ETAILWS = 0,
1.13 kristaps 46: ECOLEMPTY,
47: EQUOTPARM,
48: EQUOTTERM,
49: EMALLOC,
50: EARGVAL,
51: ENOCALL,
52: EBODYPROL,
53: EPROLBODY,
54: ETEXTPROL,
55: ENOBLANK,
56: ETOOLONG,
57: EESCAPE,
58: EPRINT,
59: ENODAT,
60: ENOPROLOGUE,
61: ELINE,
62: EATT,
63: ENAME,
64: ELISTTYPE,
65: EDISPTYPE,
66: EMULTIDISP,
1.14 kristaps 67: EMULTILIST,
1.13 kristaps 68: ESECNAME,
1.14 kristaps 69: ENAMESECINC,
1.13 kristaps 70: EARGREP,
71: EBOOL,
72: ECOLMIS,
73: ENESTDISP,
74: EMISSWIDTH,
75: EWRONGMSEC,
76: ESECOOO,
77: ESECREP,
78: EBADSTAND,
79: ENOMULTILINE,
80: EMULTILINE,
81: ENOLINE,
82: EPROLOOO,
83: EPROLREP,
84: EBADMSEC,
1.14 kristaps 85: EBADSEC,
1.13 kristaps 86: EFONT,
87: EBADDATE,
1.14 kristaps 88: ENUMFMT,
1.13 kristaps 89: ENOWIDTH,
90: EUTSNAME,
91: EOBS,
92: EMACPARM,
93: EIMPBRK,
94: EIGNE,
95: EOPEN,
1.14 kristaps 96: EQUOTPHR,
1.13 kristaps 97: ENOCTX,
1.14 kristaps 98: ESPACE,
1.18 kristaps 99: ELIB,
1.14 kristaps 100: MERRMAX
1.13 kristaps 101: };
1.1 kristaps 102:
103: #define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
104: int ppos, int *pos, char *buf
105:
106: struct mdoc_macro {
107: int (*fp)(MACRO_PROT_ARGS);
108: int flags;
109: #define MDOC_CALLABLE (1 << 0)
110: #define MDOC_PARSED (1 << 1)
111: #define MDOC_EXPLICIT (1 << 2)
112: #define MDOC_PROLOGUE (1 << 3)
113: #define MDOC_IGNDELIM (1 << 4)
114: /* Reserved words in arguments treated as text. */
115: };
116:
117: extern const struct mdoc_macro *const mdoc_macros;
118:
119: __BEGIN_DECLS
120:
1.13 kristaps 121: #define mdoc_perr(m, l, p, t) \
122: mdoc_err((m), (l), (p), 1, (t))
123: #define mdoc_pwarn(m, l, p, t) \
124: mdoc_err((m), (l), (p), 0, (t))
125: #define mdoc_nerr(m, n, t) \
1.15 kristaps 126: mdoc_err((m), (n)->line, (n)->pos, 1, (t))
127: #define mdoc_nwarn(m, n, t) \
1.13 kristaps 128: mdoc_err((m), (n)->line, (n)->pos, 0, (t))
129:
130: int mdoc_err(struct mdoc *, int, int, int, enum merr);
131: int mdoc_verr(struct mdoc *, int, int, const char *, ...);
1.12 kristaps 132: int mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
1.13 kristaps 133:
1.1 kristaps 134: int mdoc_macro(MACRO_PROT_ARGS);
135: int mdoc_word_alloc(struct mdoc *,
136: int, int, const char *);
137: int mdoc_elem_alloc(struct mdoc *, int, int,
138: int, struct mdoc_arg *);
139: int mdoc_block_alloc(struct mdoc *, int, int,
140: int, struct mdoc_arg *);
141: int mdoc_head_alloc(struct mdoc *, int, int, int);
142: int mdoc_tail_alloc(struct mdoc *, int, int, int);
143: int mdoc_body_alloc(struct mdoc *, int, int, int);
144: void mdoc_node_free(struct mdoc_node *);
145: void mdoc_node_freelist(struct mdoc_node *);
1.4 kristaps 146: void *mdoc_hash_alloc(void);
147: int mdoc_hash_find(const void *, const char *);
148: void mdoc_hash_free(void *);
1.1 kristaps 149: int mdoc_iscdelim(char);
150: int mdoc_isdelim(const char *);
151: size_t mdoc_isescape(const char *);
152: enum mdoc_sec mdoc_atosec(const char *);
153: time_t mdoc_atotime(const char *);
154:
155: size_t mdoc_macro2len(int);
1.16 kristaps 156: const char *mdoc_a2att(const char *);
1.18 kristaps 157: const char *mdoc_a2lib(const char *);
1.17 kristaps 158: const char *mdoc_a2st(const char *);
1.1 kristaps 159: const char *mdoc_a2arch(const char *);
160: const char *mdoc_a2vol(const char *);
161: const char *mdoc_a2msec(const char *);
162: int mdoc_valid_pre(struct mdoc *,
163: const struct mdoc_node *);
164: int mdoc_valid_post(struct mdoc *);
165: int mdoc_action_pre(struct mdoc *,
166: const struct mdoc_node *);
167: int mdoc_action_post(struct mdoc *);
168: int mdoc_argv(struct mdoc *, int, int,
169: struct mdoc_arg **, int *, char *);
170: #define ARGV_ERROR (-1)
171: #define ARGV_EOLN (0)
172: #define ARGV_ARG (1)
173: #define ARGV_WORD (2)
174: void mdoc_argv_free(struct mdoc_arg *);
175: int mdoc_args(struct mdoc *, int,
176: int *, char *, int, char **);
177: #define ARGS_ERROR (-1)
178: #define ARGS_EOLN (0)
179: #define ARGS_WORD (1)
180: #define ARGS_PUNCT (2)
181: #define ARGS_QWORD (3)
182: #define ARGS_PHRASE (4)
183:
1.2 kristaps 184: int mdoc_macroend(struct mdoc *);
1.1 kristaps 185:
186: __END_DECLS
187:
188: #endif /*!LIBMDOC_H*/
CVSweb