Annotation of mandoc/libmdoc.h, Revision 1.22
1.22 ! kristaps 1: /* $Id: libmdoc.h,v 1.21 2009/07/20 14:09:38 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: EQUOTPARM,
47: EQUOTTERM,
48: EMALLOC,
49: EARGVAL,
50: EBODYPROL,
51: EPROLBODY,
52: ETEXTPROL,
53: ENOBLANK,
54: ETOOLONG,
55: EESCAPE,
56: EPRINT,
57: ENODAT,
58: ENOPROLOGUE,
59: ELINE,
60: EATT,
61: ENAME,
62: ELISTTYPE,
63: EDISPTYPE,
64: EMULTIDISP,
1.14 kristaps 65: EMULTILIST,
1.13 kristaps 66: ESECNAME,
1.14 kristaps 67: ENAMESECINC,
1.13 kristaps 68: EARGREP,
69: EBOOL,
70: ECOLMIS,
71: ENESTDISP,
72: EMISSWIDTH,
73: EWRONGMSEC,
74: ESECOOO,
75: ESECREP,
76: EBADSTAND,
77: ENOMULTILINE,
78: EMULTILINE,
79: ENOLINE,
80: EPROLOOO,
81: EPROLREP,
82: EBADMSEC,
1.14 kristaps 83: EBADSEC,
1.13 kristaps 84: EFONT,
85: EBADDATE,
1.14 kristaps 86: ENUMFMT,
1.13 kristaps 87: ENOWIDTH,
88: EUTSNAME,
89: EOBS,
90: EIMPBRK,
91: EIGNE,
92: EOPEN,
1.14 kristaps 93: EQUOTPHR,
1.13 kristaps 94: ENOCTX,
1.14 kristaps 95: ESPACE,
1.18 kristaps 96: ELIB,
1.14 kristaps 97: MERRMAX
1.13 kristaps 98: };
1.1 kristaps 99:
100: #define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
101: int ppos, int *pos, char *buf
102:
103: struct mdoc_macro {
104: int (*fp)(MACRO_PROT_ARGS);
105: int flags;
106: #define MDOC_CALLABLE (1 << 0)
107: #define MDOC_PARSED (1 << 1)
108: #define MDOC_EXPLICIT (1 << 2)
109: #define MDOC_PROLOGUE (1 << 3)
110: #define MDOC_IGNDELIM (1 << 4)
111: /* Reserved words in arguments treated as text. */
112: };
113:
114: extern const struct mdoc_macro *const mdoc_macros;
115:
116: __BEGIN_DECLS
117:
1.13 kristaps 118: #define mdoc_perr(m, l, p, t) \
119: mdoc_err((m), (l), (p), 1, (t))
120: #define mdoc_pwarn(m, l, p, t) \
121: mdoc_err((m), (l), (p), 0, (t))
122: #define mdoc_nerr(m, n, t) \
1.15 kristaps 123: mdoc_err((m), (n)->line, (n)->pos, 1, (t))
124: #define mdoc_nwarn(m, n, t) \
1.13 kristaps 125: mdoc_err((m), (n)->line, (n)->pos, 0, (t))
126:
127: int mdoc_err(struct mdoc *, int, int, int, enum merr);
128: int mdoc_verr(struct mdoc *, int, int, const char *, ...);
1.12 kristaps 129: int mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
1.13 kristaps 130:
1.1 kristaps 131: int mdoc_macro(MACRO_PROT_ARGS);
132: int mdoc_word_alloc(struct mdoc *,
133: int, int, const char *);
134: int mdoc_elem_alloc(struct mdoc *, int, int,
135: int, struct mdoc_arg *);
136: int mdoc_block_alloc(struct mdoc *, int, int,
137: int, struct mdoc_arg *);
138: int mdoc_head_alloc(struct mdoc *, int, int, int);
139: int mdoc_tail_alloc(struct mdoc *, int, int, int);
140: int mdoc_body_alloc(struct mdoc *, int, int, int);
141: void mdoc_node_free(struct mdoc_node *);
142: void mdoc_node_freelist(struct mdoc_node *);
1.4 kristaps 143: void *mdoc_hash_alloc(void);
144: int mdoc_hash_find(const void *, const char *);
145: void mdoc_hash_free(void *);
1.1 kristaps 146: int mdoc_iscdelim(char);
147: int mdoc_isdelim(const char *);
148: size_t mdoc_isescape(const char *);
149: enum mdoc_sec mdoc_atosec(const char *);
150: time_t mdoc_atotime(const char *);
151:
152: size_t mdoc_macro2len(int);
1.16 kristaps 153: const char *mdoc_a2att(const char *);
1.18 kristaps 154: const char *mdoc_a2lib(const char *);
1.17 kristaps 155: const char *mdoc_a2st(const char *);
1.1 kristaps 156: const char *mdoc_a2arch(const char *);
157: const char *mdoc_a2vol(const char *);
158: const char *mdoc_a2msec(const char *);
159: int mdoc_valid_pre(struct mdoc *,
160: const struct mdoc_node *);
161: int mdoc_valid_post(struct mdoc *);
162: int mdoc_action_pre(struct mdoc *,
163: const struct mdoc_node *);
164: int mdoc_action_post(struct mdoc *);
165: int mdoc_argv(struct mdoc *, int, int,
166: struct mdoc_arg **, int *, char *);
167: #define ARGV_ERROR (-1)
168: #define ARGV_EOLN (0)
169: #define ARGV_ARG (1)
170: #define ARGV_WORD (2)
171: void mdoc_argv_free(struct mdoc_arg *);
172: int mdoc_args(struct mdoc *, int,
173: int *, char *, int, char **);
1.20 kristaps 174: int mdoc_zargs(struct mdoc *, int,
175: int *, char *, char **);
1.1 kristaps 176: #define ARGS_ERROR (-1)
177: #define ARGS_EOLN (0)
178: #define ARGS_WORD (1)
179: #define ARGS_PUNCT (2)
180: #define ARGS_QWORD (3)
181: #define ARGS_PHRASE (4)
182:
1.2 kristaps 183: int mdoc_macroend(struct mdoc *);
1.1 kristaps 184:
185: __END_DECLS
186:
187: #endif /*!LIBMDOC_H*/
CVSweb