Annotation of src/usr.bin/mandoc/mdoc.h, Revision 1.34
1.34 ! schwarze 1: /* $Id: mdoc.h,v 1.33 2010/08/20 00:53:35 schwarze Exp $ */
1.1 kristaps 2: /*
1.31 schwarze 3: * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
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,
1.27 schwarze 152: MDOC_Ta,
1.34 ! schwarze 153: MDOC_TS,
! 154: MDOC_TE,
1.19 schwarze 155: MDOC_MAX
156: };
1.1 kristaps 157:
158: /* What follows is a list of ALL possible macro arguments. */
159:
1.32 schwarze 160: enum mdocargt {
161: MDOC_Split,
162: MDOC_Nosplit,
163: MDOC_Ragged,
164: MDOC_Unfilled,
165: MDOC_Literal,
166: MDOC_File,
167: MDOC_Offset,
168: MDOC_Bullet,
169: MDOC_Dash,
170: MDOC_Hyphen,
171: MDOC_Item,
172: MDOC_Enum,
173: MDOC_Tag,
174: MDOC_Diag,
175: MDOC_Hang,
176: MDOC_Ohang,
177: MDOC_Inset,
178: MDOC_Column,
179: MDOC_Width,
180: MDOC_Compact,
181: MDOC_Std,
182: MDOC_Filled,
183: MDOC_Words,
184: MDOC_Emphasis,
185: MDOC_Symbolic,
186: MDOC_Nested,
187: MDOC_Centred,
188: MDOC_ARG_MAX
189: };
1.1 kristaps 190:
191: /* Type of a syntax node. */
192: enum mdoc_type {
193: MDOC_TEXT,
194: MDOC_ELEM,
195: MDOC_HEAD,
196: MDOC_TAIL,
197: MDOC_BODY,
198: MDOC_BLOCK,
199: MDOC_ROOT
200: };
201:
202: /* Section (named/unnamed) of `Sh'. */
203: enum mdoc_sec {
1.5 schwarze 204: SEC_NONE, /* No section, yet. */
205: SEC_NAME,
206: SEC_LIBRARY,
207: SEC_SYNOPSIS,
208: SEC_DESCRIPTION,
209: SEC_IMPLEMENTATION,
210: SEC_RETURN_VALUES,
1.13 schwarze 211: SEC_ENVIRONMENT,
1.5 schwarze 212: SEC_FILES,
1.21 schwarze 213: SEC_EXIT_STATUS,
1.5 schwarze 214: SEC_EXAMPLES,
215: SEC_DIAGNOSTICS,
216: SEC_COMPATIBILITY,
217: SEC_ERRORS,
218: SEC_SEE_ALSO,
219: SEC_STANDARDS,
220: SEC_HISTORY,
221: SEC_AUTHORS,
222: SEC_CAVEATS,
223: SEC_BUGS,
1.13 schwarze 224: SEC_SECURITY,
1.21 schwarze 225: SEC_CUSTOM, /* User-defined. */
226: SEC__MAX
1.1 kristaps 227: };
228:
229: /* Information from prologue. */
230: struct mdoc_meta {
1.23 schwarze 231: char *msec;
1.1 kristaps 232: char *vol;
233: char *arch;
234: time_t date;
235: char *title;
236: char *os;
237: char *name;
238: };
239:
240: /* An argument to a macro (multiple values = `It -column'). */
241: struct mdoc_argv {
1.32 schwarze 242: enum mdocargt arg;
1.1 kristaps 243: int line;
244: int pos;
245: size_t sz;
246: char **value;
247: };
248:
249: struct mdoc_arg {
250: size_t argc;
251: struct mdoc_argv *argv;
252: unsigned int refcnt;
253: };
254:
1.30 schwarze 255: enum mdoc_endbody {
256: ENDBODY_NOT = 0,
257: ENDBODY_SPACE,
1.31 schwarze 258: ENDBODY_NOSPACE
1.30 schwarze 259: };
260:
1.26 schwarze 261: enum mdoc_list {
262: LIST__NONE = 0,
263: LIST_bullet,
264: LIST_column,
265: LIST_dash,
266: LIST_diag,
267: LIST_enum,
268: LIST_hang,
269: LIST_hyphen,
270: LIST_inset,
271: LIST_item,
272: LIST_ohang,
273: LIST_tag
274: };
275:
1.28 schwarze 276: enum mdoc_disp {
277: DISP__NONE = 0,
278: DISP_centred,
279: DISP_ragged,
280: DISP_unfilled,
281: DISP_filled,
282: DISP_literal
283: };
284:
1.31 schwarze 285: enum mdoc_auth {
286: AUTH__NONE = 0,
287: AUTH_split,
288: AUTH_nosplit
289: };
290:
291: enum mdoc_font {
292: FONT__NONE = 0,
293: FONT_Em,
294: FONT_Li,
295: FONT_Sy
296: };
297:
1.28 schwarze 298: struct mdoc_bd {
299: const char *offs; /* -offset */
300: enum mdoc_disp type; /* -ragged, etc. */
301: int comp; /* -compact */
302: };
303:
304: struct mdoc_bl {
305: const char *width; /* -width */
306: const char *offs; /* -offset */
307: enum mdoc_list type; /* -tag, -enum, etc. */
308: int comp; /* -compact */
1.31 schwarze 309: size_t ncols; /* -column arg count */
310: const char **cols; /* -column val ptr */
311: };
312:
313: struct mdoc_bf {
314: enum mdoc_font font; /* font */
315: };
316:
317: struct mdoc_an {
318: enum mdoc_auth auth; /* -split, etc. */
1.28 schwarze 319: };
320:
1.1 kristaps 321: /* Node in AST. */
322: struct mdoc_node {
1.21 schwarze 323: struct mdoc_node *parent; /* parent AST node */
324: struct mdoc_node *child; /* first child AST node */
325: struct mdoc_node *next; /* sibling AST node */
326: struct mdoc_node *prev; /* prior sibling AST node */
327: int nchild; /* number children */
328: int line; /* parse line */
329: int pos; /* parse column */
330: enum mdoct tok; /* tok or MDOC__MAX if none */
1.1 kristaps 331: int flags;
1.21 schwarze 332: #define MDOC_VALID (1 << 0) /* has been validated */
333: #define MDOC_ACTED (1 << 1) /* has been acted upon */
334: #define MDOC_EOS (1 << 2) /* at sentence boundary */
335: #define MDOC_LINE (1 << 3) /* first macro/text on line */
1.29 schwarze 336: #define MDOC_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting */
1.30 schwarze 337: #define MDOC_ENDED (1 << 5) /* rendering has been ended */
1.21 schwarze 338: enum mdoc_type type; /* AST node type */
339: enum mdoc_sec sec; /* current named section */
1.29 schwarze 340: /* FIXME: these can be union'd to shave a few bytes. */
1.1 kristaps 341: struct mdoc_arg *args; /* BLOCK/ELEM */
1.19 schwarze 342: struct mdoc_node *pending; /* BLOCK */
1.1 kristaps 343: struct mdoc_node *head; /* BLOCK */
344: struct mdoc_node *body; /* BLOCK */
345: struct mdoc_node *tail; /* BLOCK */
346: char *string; /* TEXT */
1.30 schwarze 347: enum mdoc_endbody end; /* BODY */
1.26 schwarze 348:
349: union {
1.34 ! schwarze 350: struct mdoc_an An;
! 351: struct mdoc_bd *Bd;
! 352: struct mdoc_bf *Bf;
! 353: struct mdoc_bl *Bl;
! 354: struct tbl *TS;
1.26 schwarze 355: } data;
1.1 kristaps 356: };
357:
1.6 schwarze 358: /* See mdoc.3 for documentation. */
359:
1.1 kristaps 360: extern const char *const *mdoc_macronames;
361: extern const char *const *mdoc_argnames;
362:
363: __BEGIN_DECLS
364:
365: struct mdoc;
366:
1.6 schwarze 367: /* See mdoc.3 for documentation. */
368:
1.1 kristaps 369: void mdoc_free(struct mdoc *);
1.33 schwarze 370: struct mdoc *mdoc_alloc(struct regset *, void *, mandocmsg);
1.16 schwarze 371: void mdoc_reset(struct mdoc *);
1.24 schwarze 372: int mdoc_parseln(struct mdoc *, int, char *, int);
1.1 kristaps 373: const struct mdoc_node *mdoc_node(const struct mdoc *);
374: const struct mdoc_meta *mdoc_meta(const struct mdoc *);
375: int mdoc_endparse(struct mdoc *);
376:
377: __END_DECLS
378:
379: #endif /*!MDOC_H*/