![[BACK]](/icons/back.gif){kind=icon}
Return to mdoc.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc|
Return to mdoc.h CVS log | Up to [local] / src / usr.bin / mandoc |
1.19 ! schwarze 1: /* $Id: mdoc.h,v 1.18 2010/03/02 00:38:59 schwarze Exp $ */
1.1 kristaps 2: /*
1.2 schwarze 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.2 schwarze 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.2 schwarze 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 MDOC_H
18: #define MDOC_H
19:
20: /*
21: * This library implements a validating scanner/parser for ``mdoc'' roff
22: * macro documents, a.k.a. BSD manual page documents. The mdoc.c file
23: * drives the parser, while macro.c describes the macro ontologies.
24: * validate.c pre- and post-validates parsed macros, and action.c
25: * performs actions on parsed and validated macros.
26: */
27:
28: /* What follows is a list of ALL possible macros. */
29:
1.19 ! schwarze 30: enum mdoct {
! 31: MDOC_Ap = 0,
! 32: MDOC_Dd,
! 33: MDOC_Dt,
! 34: MDOC_Os,
! 35: MDOC_Sh,
! 36: MDOC_Ss,
! 37: MDOC_Pp,
! 38: MDOC_D1,
! 39: MDOC_Dl,
! 40: MDOC_Bd,
! 41: MDOC_Ed,
! 42: MDOC_Bl,
! 43: MDOC_El,
! 44: MDOC_It,
! 45: MDOC_Ad,
! 46: MDOC_An,
! 47: MDOC_Ar,
! 48: MDOC_Cd,
! 49: MDOC_Cm,
! 50: MDOC_Dv,
! 51: MDOC_Er,
! 52: MDOC_Ev,
! 53: MDOC_Ex,
! 54: MDOC_Fa,
! 55: MDOC_Fd,
! 56: MDOC_Fl,
! 57: MDOC_Fn,
! 58: MDOC_Ft,
! 59: MDOC_Ic,
! 60: MDOC_In,
! 61: MDOC_Li,
! 62: MDOC_Nd,
! 63: MDOC_Nm,
! 64: MDOC_Op,
! 65: MDOC_Ot,
! 66: MDOC_Pa,
! 67: MDOC_Rv,
! 68: MDOC_St,
! 69: MDOC_Va,
! 70: MDOC_Vt,
! 71: MDOC_Xr,
! 72: MDOC__A,
! 73: MDOC__B,
! 74: MDOC__D,
! 75: MDOC__I,
! 76: MDOC__J,
! 77: MDOC__N,
! 78: MDOC__O,
! 79: MDOC__P,
! 80: MDOC__R,
! 81: MDOC__T,
! 82: MDOC__V,
! 83: MDOC_Ac,
! 84: MDOC_Ao,
! 85: MDOC_Aq,
! 86: MDOC_At,
! 87: MDOC_Bc,
! 88: MDOC_Bf,
! 89: MDOC_Bo,
! 90: MDOC_Bq,
! 91: MDOC_Bsx,
! 92: MDOC_Bx,
! 93: MDOC_Db,
! 94: MDOC_Dc,
! 95: MDOC_Do,
! 96: MDOC_Dq,
! 97: MDOC_Ec,
! 98: MDOC_Ef,
! 99: MDOC_Em,
! 100: MDOC_Eo,
! 101: MDOC_Fx,
! 102: MDOC_Ms,
! 103: MDOC_No,
! 104: MDOC_Ns,
! 105: MDOC_Nx,
! 106: MDOC_Ox,
! 107: MDOC_Pc,
! 108: MDOC_Pf,
! 109: MDOC_Po,
! 110: MDOC_Pq,
! 111: MDOC_Qc,
! 112: MDOC_Ql,
! 113: MDOC_Qo,
! 114: MDOC_Qq,
! 115: MDOC_Re,
! 116: MDOC_Rs,
! 117: MDOC_Sc,
! 118: MDOC_So,
! 119: MDOC_Sq,
! 120: MDOC_Sm,
! 121: MDOC_Sx,
! 122: MDOC_Sy,
! 123: MDOC_Tn,
! 124: MDOC_Ux,
! 125: MDOC_Xc,
! 126: MDOC_Xo,
! 127: MDOC_Fo,
! 128: MDOC_Fc,
! 129: MDOC_Oo,
! 130: MDOC_Oc,
! 131: MDOC_Bk,
! 132: MDOC_Ek,
! 133: MDOC_Bt,
! 134: MDOC_Hf,
! 135: MDOC_Fr,
! 136: MDOC_Ud,
! 137: MDOC_Lb,
! 138: MDOC_Lp,
! 139: MDOC_Lk,
! 140: MDOC_Mt,
! 141: MDOC_Brq,
! 142: MDOC_Bro,
! 143: MDOC_Brc,
! 144: MDOC__C,
! 145: MDOC_Es,
! 146: MDOC_En,
! 147: MDOC_Dx,
! 148: MDOC__Q,
! 149: MDOC_br,
! 150: MDOC_sp,
! 151: MDOC__U,
! 152: MDOC_eos,
! 153: MDOC_MAX
! 154: };
1.1 kristaps 155:
156: /* What follows is a list of ALL possible macro arguments. */
157:
158: #define MDOC_Split 0
159: #define MDOC_Nosplit 1
160: #define MDOC_Ragged 2
161: #define MDOC_Unfilled 3
162: #define MDOC_Literal 4
163: #define MDOC_File 5
164: #define MDOC_Offset 6
165: #define MDOC_Bullet 7
166: #define MDOC_Dash 8
167: #define MDOC_Hyphen 9
168: #define MDOC_Item 10
169: #define MDOC_Enum 11
170: #define MDOC_Tag 12
171: #define MDOC_Diag 13
172: #define MDOC_Hang 14
173: #define MDOC_Ohang 15
174: #define MDOC_Inset 16
175: #define MDOC_Column 17
176: #define MDOC_Width 18
177: #define MDOC_Compact 19
178: #define MDOC_Std 20
179: #define MDOC_Filled 21
180: #define MDOC_Words 22
181: #define MDOC_Emphasis 23
182: #define MDOC_Symbolic 24
183: #define MDOC_Nested 25
1.14 schwarze 184: #define MDOC_Centred 26
185: #define MDOC_ARG_MAX 27
1.1 kristaps 186:
187: /* Type of a syntax node. */
188: enum mdoc_type {
189: MDOC_TEXT,
190: MDOC_ELEM,
191: MDOC_HEAD,
192: MDOC_TAIL,
193: MDOC_BODY,
194: MDOC_BLOCK,
195: MDOC_ROOT
196: };
197:
198: /* Section (named/unnamed) of `Sh'. */
199: enum mdoc_sec {
1.5 schwarze 200: SEC_NONE, /* No section, yet. */
201: SEC_NAME,
202: SEC_LIBRARY,
203: SEC_SYNOPSIS,
204: SEC_DESCRIPTION,
205: SEC_IMPLEMENTATION,
1.13 schwarze 206: SEC_EXIT_STATUS,
1.5 schwarze 207: SEC_RETURN_VALUES,
1.13 schwarze 208: SEC_ENVIRONMENT,
1.5 schwarze 209: SEC_FILES,
210: SEC_EXAMPLES,
211: SEC_DIAGNOSTICS,
212: SEC_COMPATIBILITY,
213: SEC_ERRORS,
214: SEC_SEE_ALSO,
215: SEC_STANDARDS,
216: SEC_HISTORY,
217: SEC_AUTHORS,
218: SEC_CAVEATS,
219: SEC_BUGS,
1.13 schwarze 220: SEC_SECURITY,
1.5 schwarze 221: SEC_CUSTOM /* User-defined. */
1.1 kristaps 222: };
223:
224: /* Information from prologue. */
225: struct mdoc_meta {
226: int msec;
227: char *vol;
228: char *arch;
229: time_t date;
230: char *title;
231: char *os;
232: char *name;
233: };
234:
235: /* An argument to a macro (multiple values = `It -column'). */
236: struct mdoc_argv {
237: int arg;
238: int line;
239: int pos;
240: size_t sz;
241: char **value;
242: };
243:
244: struct mdoc_arg {
245: size_t argc;
246: struct mdoc_argv *argv;
247: unsigned int refcnt;
248: };
249:
250: /* Node in AST. */
251: struct mdoc_node {
252: struct mdoc_node *parent;
253: struct mdoc_node *child;
254: struct mdoc_node *next;
255: struct mdoc_node *prev;
1.7 schwarze 256: int nchild;
1.1 kristaps 257: int line;
258: int pos;
1.19 ! schwarze 259: enum mdoct tok;
1.1 kristaps 260: int flags;
261: #define MDOC_VALID (1 << 0)
262: #define MDOC_ACTED (1 << 1)
263: enum mdoc_type type;
264: enum mdoc_sec sec;
265:
266: struct mdoc_arg *args; /* BLOCK/ELEM */
1.19 ! schwarze 267: struct mdoc_node *pending; /* BLOCK */
1.1 kristaps 268: struct mdoc_node *head; /* BLOCK */
269: struct mdoc_node *body; /* BLOCK */
270: struct mdoc_node *tail; /* BLOCK */
271: char *string; /* TEXT */
272: };
273:
274: #define MDOC_IGN_SCOPE (1 << 0) /* Ignore scope violations. */
275: #define MDOC_IGN_ESCAPE (1 << 1) /* Ignore bad escape sequences. */
276: #define MDOC_IGN_MACRO (1 << 2) /* Ignore unknown macros. */
277: #define MDOC_IGN_CHARS (1 << 3) /* Ignore disallowed chars. */
278:
279: /* Call-backs for parse messages. */
1.12 schwarze 280:
1.1 kristaps 281: struct mdoc_cb {
282: int (*mdoc_err)(void *, int, int, const char *);
1.8 schwarze 283: int (*mdoc_warn)(void *, int, int, const char *);
1.1 kristaps 284: };
285:
1.6 schwarze 286: /* See mdoc.3 for documentation. */
287:
1.1 kristaps 288: extern const char *const *mdoc_macronames;
289: extern const char *const *mdoc_argnames;
290:
291: __BEGIN_DECLS
292:
293: struct mdoc;
294:
1.6 schwarze 295: /* See mdoc.3 for documentation. */
296:
1.1 kristaps 297: void mdoc_free(struct mdoc *);
298: struct mdoc *mdoc_alloc(void *, int, const struct mdoc_cb *);
1.16 schwarze 299: void mdoc_reset(struct mdoc *);
1.1 kristaps 300: int mdoc_parseln(struct mdoc *, int, char *buf);
301: const struct mdoc_node *mdoc_node(const struct mdoc *);
302: const struct mdoc_meta *mdoc_meta(const struct mdoc *);
303: int mdoc_endparse(struct mdoc *);
304:
305: __END_DECLS
306:
307: #endif /*!MDOC_H*/