Annotation of mandoc/libmdoc.h, Revision 1.44
1.44 ! kristaps 1: /* $Id: libmdoc.h,v 1.43 2010/05/14 12:55:22 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: int flags;
1.42 kristaps 31: #define MDOC_HALT (1 << 0) /* error in parse: halt */
32: #define MDOC_LITERAL (1 << 1) /* in a literal scope */
33: #define MDOC_PBODY (1 << 2) /* in the document body */
34: #define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */
1.43 kristaps 35: #define MDOC_PHRASELIT (1 << 4) /* in a literal within a phrase */
1.1 kristaps 36: int pflags;
37: enum mdoc_next next;
38: struct mdoc_node *last;
39: struct mdoc_node *first;
40: struct mdoc_meta meta;
41: enum mdoc_sec lastnamed;
42: enum mdoc_sec lastsec;
43: };
44:
1.13 kristaps 45: enum merr {
1.14 kristaps 46: ETAILWS = 0,
1.13 kristaps 47: EQUOTPARM,
48: EQUOTTERM,
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,
1.14 kristaps 82: EBADSEC,
1.13 kristaps 83: EFONT,
84: EBADDATE,
1.14 kristaps 85: ENUMFMT,
1.13 kristaps 86: ENOWIDTH,
87: EUTSNAME,
88: EOBS,
89: EIMPBRK,
90: EIGNE,
91: EOPEN,
1.14 kristaps 92: EQUOTPHR,
1.13 kristaps 93: ENOCTX,
1.18 kristaps 94: ELIB,
1.28 kristaps 95: EBADCHILD,
1.29 kristaps 96: ENOTYPE,
1.34 kristaps 97: EBADCOMMENT,
1.14 kristaps 98: MERRMAX
1.13 kristaps 99: };
1.1 kristaps 100:
1.31 kristaps 101: #define MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
102: int line, int ppos, int *pos, char *buf
1.1 kristaps 103:
104: struct mdoc_macro {
105: int (*fp)(MACRO_PROT_ARGS);
106: int flags;
107: #define MDOC_CALLABLE (1 << 0)
108: #define MDOC_PARSED (1 << 1)
109: #define MDOC_EXPLICIT (1 << 2)
110: #define MDOC_PROLOGUE (1 << 3)
111: #define MDOC_IGNDELIM (1 << 4)
112: /* Reserved words in arguments treated as text. */
113: };
114:
1.36 kristaps 115: enum margserr {
1.35 kristaps 116: ARGS_ERROR,
117: ARGS_EOLN,
118: ARGS_WORD,
119: ARGS_PUNCT,
120: ARGS_QWORD,
1.38 kristaps 121: ARGS_PHRASE,
1.40 kristaps 122: ARGS_PPHRASE,
123: ARGS_PEND
1.35 kristaps 124: };
125:
1.37 kristaps 126: enum margverr {
127: ARGV_ERROR,
128: ARGV_EOLN,
129: ARGV_ARG,
130: ARGV_WORD
131: };
132:
1.1 kristaps 133: extern const struct mdoc_macro *const mdoc_macros;
134:
135: __BEGIN_DECLS
136:
1.13 kristaps 137: #define mdoc_perr(m, l, p, t) \
138: mdoc_err((m), (l), (p), 1, (t))
139: #define mdoc_pwarn(m, l, p, t) \
140: mdoc_err((m), (l), (p), 0, (t))
141: #define mdoc_nerr(m, n, t) \
1.15 kristaps 142: mdoc_err((m), (n)->line, (n)->pos, 1, (t))
143: #define mdoc_nwarn(m, n, t) \
1.13 kristaps 144: mdoc_err((m), (n)->line, (n)->pos, 0, (t))
145:
146: int mdoc_err(struct mdoc *, int, int, int, enum merr);
147: int mdoc_verr(struct mdoc *, int, int, const char *, ...);
1.12 kristaps 148: int mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
1.13 kristaps 149:
1.1 kristaps 150: int mdoc_macro(MACRO_PROT_ARGS);
151: int mdoc_word_alloc(struct mdoc *,
152: int, int, const char *);
153: int mdoc_elem_alloc(struct mdoc *, int, int,
1.31 kristaps 154: enum mdoct, struct mdoc_arg *);
1.1 kristaps 155: int mdoc_block_alloc(struct mdoc *, int, int,
1.31 kristaps 156: enum mdoct, struct mdoc_arg *);
157: int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
158: int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
159: int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
1.33 kristaps 160: void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.27 kristaps 161: void mdoc_hash_init(void);
1.31 kristaps 162: enum mdoct mdoc_hash_find(const char *);
1.1 kristaps 163: int mdoc_iscdelim(char);
164: int mdoc_isdelim(const char *);
165: size_t mdoc_isescape(const char *);
1.41 kristaps 166: enum mdoc_sec mdoc_str2sec(const char *);
1.1 kristaps 167: time_t mdoc_atotime(const char *);
1.39 kristaps 168: size_t mdoc_macro2len(enum mdoct);
1.16 kristaps 169: const char *mdoc_a2att(const char *);
1.18 kristaps 170: const char *mdoc_a2lib(const char *);
1.17 kristaps 171: const char *mdoc_a2st(const char *);
1.1 kristaps 172: const char *mdoc_a2arch(const char *);
173: const char *mdoc_a2vol(const char *);
174: const char *mdoc_a2msec(const char *);
175: int mdoc_valid_pre(struct mdoc *,
176: const struct mdoc_node *);
177: int mdoc_valid_post(struct mdoc *);
178: int mdoc_action_pre(struct mdoc *,
179: const struct mdoc_node *);
180: int mdoc_action_post(struct mdoc *);
1.37 kristaps 181: enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
1.1 kristaps 182: struct mdoc_arg **, int *, char *);
183: void mdoc_argv_free(struct mdoc_arg *);
1.32 kristaps 184: void mdoc_argn_free(struct mdoc_arg *, int);
1.36 kristaps 185: enum margserr mdoc_args(struct mdoc *, int,
1.31 kristaps 186: int *, char *, enum mdoct, char **);
1.36 kristaps 187: enum margserr mdoc_zargs(struct mdoc *, int,
1.25 kristaps 188: int *, char *, int, char **);
1.43 kristaps 189: #define ARGS_DELIM (1 << 1)
190: #define ARGS_TABSEP (1 << 2)
191: #define ARGS_NOWARN (1 << 3)
192: #define ARGS_PPHRASED (1 << 4)
1.35 kristaps 193:
1.2 kristaps 194: int mdoc_macroend(struct mdoc *);
1.1 kristaps 195:
196: __END_DECLS
197:
198: #endif /*!LIBMDOC_H*/
CVSweb