Annotation of src/usr.bin/mandoc/mdoc.h, Revision 1.35
1.35 ! schwarze 1: /* $Id: mdoc.h,v 1.105 2010/10/04 07:01:02 kristaps 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:
1.35 ! schwarze 20: /*
! 21: * What follows is a list of ALL possible macros.
1.1 kristaps 22: */
1.19 schwarze 23: enum mdoct {
24: MDOC_Ap = 0,
25: MDOC_Dd,
26: MDOC_Dt,
27: MDOC_Os,
28: MDOC_Sh,
29: MDOC_Ss,
30: MDOC_Pp,
31: MDOC_D1,
32: MDOC_Dl,
33: MDOC_Bd,
34: MDOC_Ed,
35: MDOC_Bl,
36: MDOC_El,
37: MDOC_It,
38: MDOC_Ad,
39: MDOC_An,
40: MDOC_Ar,
41: MDOC_Cd,
42: MDOC_Cm,
43: MDOC_Dv,
44: MDOC_Er,
45: MDOC_Ev,
46: MDOC_Ex,
47: MDOC_Fa,
48: MDOC_Fd,
49: MDOC_Fl,
50: MDOC_Fn,
51: MDOC_Ft,
52: MDOC_Ic,
53: MDOC_In,
54: MDOC_Li,
55: MDOC_Nd,
56: MDOC_Nm,
57: MDOC_Op,
58: MDOC_Ot,
59: MDOC_Pa,
60: MDOC_Rv,
61: MDOC_St,
62: MDOC_Va,
63: MDOC_Vt,
64: MDOC_Xr,
65: MDOC__A,
66: MDOC__B,
67: MDOC__D,
68: MDOC__I,
69: MDOC__J,
70: MDOC__N,
71: MDOC__O,
72: MDOC__P,
73: MDOC__R,
74: MDOC__T,
75: MDOC__V,
76: MDOC_Ac,
77: MDOC_Ao,
78: MDOC_Aq,
79: MDOC_At,
80: MDOC_Bc,
81: MDOC_Bf,
82: MDOC_Bo,
83: MDOC_Bq,
84: MDOC_Bsx,
85: MDOC_Bx,
86: MDOC_Db,
87: MDOC_Dc,
88: MDOC_Do,
89: MDOC_Dq,
90: MDOC_Ec,
91: MDOC_Ef,
92: MDOC_Em,
93: MDOC_Eo,
94: MDOC_Fx,
95: MDOC_Ms,
96: MDOC_No,
97: MDOC_Ns,
98: MDOC_Nx,
99: MDOC_Ox,
100: MDOC_Pc,
101: MDOC_Pf,
102: MDOC_Po,
103: MDOC_Pq,
104: MDOC_Qc,
105: MDOC_Ql,
106: MDOC_Qo,
107: MDOC_Qq,
108: MDOC_Re,
109: MDOC_Rs,
110: MDOC_Sc,
111: MDOC_So,
112: MDOC_Sq,
113: MDOC_Sm,
114: MDOC_Sx,
115: MDOC_Sy,
116: MDOC_Tn,
117: MDOC_Ux,
118: MDOC_Xc,
119: MDOC_Xo,
120: MDOC_Fo,
121: MDOC_Fc,
122: MDOC_Oo,
123: MDOC_Oc,
124: MDOC_Bk,
125: MDOC_Ek,
126: MDOC_Bt,
127: MDOC_Hf,
128: MDOC_Fr,
129: MDOC_Ud,
130: MDOC_Lb,
131: MDOC_Lp,
132: MDOC_Lk,
133: MDOC_Mt,
134: MDOC_Brq,
135: MDOC_Bro,
136: MDOC_Brc,
137: MDOC__C,
138: MDOC_Es,
139: MDOC_En,
140: MDOC_Dx,
141: MDOC__Q,
142: MDOC_br,
143: MDOC_sp,
144: MDOC__U,
1.27 schwarze 145: MDOC_Ta,
1.34 schwarze 146: MDOC_TS,
147: MDOC_TE,
1.19 schwarze 148: MDOC_MAX
149: };
1.1 kristaps 150:
1.35 ! schwarze 151: /*
! 152: * What follows is a list of ALL possible macro arguments.
! 153: */
1.32 schwarze 154: enum mdocargt {
155: MDOC_Split,
156: MDOC_Nosplit,
157: MDOC_Ragged,
158: MDOC_Unfilled,
159: MDOC_Literal,
160: MDOC_File,
161: MDOC_Offset,
162: MDOC_Bullet,
163: MDOC_Dash,
164: MDOC_Hyphen,
165: MDOC_Item,
166: MDOC_Enum,
167: MDOC_Tag,
168: MDOC_Diag,
169: MDOC_Hang,
170: MDOC_Ohang,
171: MDOC_Inset,
172: MDOC_Column,
173: MDOC_Width,
174: MDOC_Compact,
175: MDOC_Std,
176: MDOC_Filled,
177: MDOC_Words,
178: MDOC_Emphasis,
179: MDOC_Symbolic,
180: MDOC_Nested,
181: MDOC_Centred,
182: MDOC_ARG_MAX
183: };
1.1 kristaps 184:
1.35 ! schwarze 185: /*
! 186: * Type of a syntax node.
! 187: */
1.1 kristaps 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:
1.35 ! schwarze 198: /*
! 199: * Section (named/unnamed) of `Sh'. Note that these appear in the
! 200: * conventional order imposed by mdoc.7.
! 201: */
1.1 kristaps 202: enum mdoc_sec {
1.35 ! schwarze 203: SEC_NONE = 0, /* No section, yet. */
1.5 schwarze 204: SEC_NAME,
205: SEC_LIBRARY,
206: SEC_SYNOPSIS,
207: SEC_DESCRIPTION,
208: SEC_IMPLEMENTATION,
209: SEC_RETURN_VALUES,
1.13 schwarze 210: SEC_ENVIRONMENT,
1.5 schwarze 211: SEC_FILES,
1.21 schwarze 212: SEC_EXIT_STATUS,
1.5 schwarze 213: SEC_EXAMPLES,
214: SEC_DIAGNOSTICS,
215: SEC_COMPATIBILITY,
216: SEC_ERRORS,
217: SEC_SEE_ALSO,
218: SEC_STANDARDS,
219: SEC_HISTORY,
220: SEC_AUTHORS,
221: SEC_CAVEATS,
222: SEC_BUGS,
1.13 schwarze 223: SEC_SECURITY,
1.35 ! schwarze 224: SEC_CUSTOM, /* User-defined. */
1.21 schwarze 225: SEC__MAX
1.1 kristaps 226: };
227:
1.35 ! schwarze 228: /*
! 229: * Information from prologue.
! 230: */
1.1 kristaps 231: struct mdoc_meta {
1.35 ! schwarze 232: char *msec; /* `Dt' section (1, 3p, etc.) */
! 233: char *vol; /* `Dt' volume (implied) */
! 234: char *arch; /* `Dt' arch (i386, etc.) */
! 235: time_t date; /* `Dd' normalised date */
! 236: char *title; /* `Dt' title (FOO, etc.) */
! 237: char *os; /* `Os' system (OpenBSD, etc.) */
! 238: char *name; /* leading `Nm' name */
1.1 kristaps 239: };
240:
1.35 ! schwarze 241: /*
! 242: * An argument to a macro (multiple values = `-column xxx yyy').
! 243: */
1.1 kristaps 244: struct mdoc_argv {
1.35 ! schwarze 245: enum mdocargt arg; /* type of argument */
1.1 kristaps 246: int line;
247: int pos;
1.35 ! schwarze 248: size_t sz; /* elements in "value" */
! 249: char **value; /* argument strings */
1.1 kristaps 250: };
251:
1.35 ! schwarze 252: /*
! 253: * Reference-counted macro arguments. These are refcounted because
! 254: * blocks have multiple instances of the same arguments spread across
! 255: * the HEAD, BODY, TAIL, and BLOCK node types.
! 256: */
1.1 kristaps 257: struct mdoc_arg {
258: size_t argc;
259: struct mdoc_argv *argv;
260: unsigned int refcnt;
261: };
262:
1.35 ! schwarze 263: /*
! 264: * Indicates that a BODY's formatting has ended, but the scope is still
! 265: * open. Used for syntax-broken blocks.
! 266: */
1.30 schwarze 267: enum mdoc_endbody {
268: ENDBODY_NOT = 0,
1.35 ! schwarze 269: ENDBODY_SPACE, /* is broken: append a space */
! 270: ENDBODY_NOSPACE /* is broken: don't append a space */
1.30 schwarze 271: };
272:
1.35 ! schwarze 273: /*
! 274: * Normalised `Bl' list type.
! 275: */
1.26 schwarze 276: enum mdoc_list {
277: LIST__NONE = 0,
278: LIST_bullet,
279: LIST_column,
280: LIST_dash,
281: LIST_diag,
282: LIST_enum,
283: LIST_hang,
284: LIST_hyphen,
285: LIST_inset,
286: LIST_item,
287: LIST_ohang,
288: LIST_tag
289: };
290:
1.35 ! schwarze 291: /*
! 292: * Normalised `Bd' display type.
! 293: */
1.28 schwarze 294: enum mdoc_disp {
295: DISP__NONE = 0,
296: DISP_centred,
297: DISP_ragged,
298: DISP_unfilled,
299: DISP_filled,
300: DISP_literal
301: };
302:
1.35 ! schwarze 303: /*
! 304: * Normalised `An' splitting argument.
! 305: */
1.31 schwarze 306: enum mdoc_auth {
307: AUTH__NONE = 0,
308: AUTH_split,
309: AUTH_nosplit
310: };
311:
1.35 ! schwarze 312: /*
! 313: * Normalised `Bf' font type.
! 314: */
1.31 schwarze 315: enum mdoc_font {
316: FONT__NONE = 0,
317: FONT_Em,
318: FONT_Li,
319: FONT_Sy
320: };
321:
1.35 ! schwarze 322: /*
! 323: * Normalised arguments for `Bd'.
! 324: */
1.28 schwarze 325: struct mdoc_bd {
326: const char *offs; /* -offset */
327: enum mdoc_disp type; /* -ragged, etc. */
328: int comp; /* -compact */
329: };
330:
1.35 ! schwarze 331: /*
! 332: * Normalised arguments for `Bl'.
! 333: */
1.28 schwarze 334: struct mdoc_bl {
335: const char *width; /* -width */
336: const char *offs; /* -offset */
337: enum mdoc_list type; /* -tag, -enum, etc. */
338: int comp; /* -compact */
1.31 schwarze 339: size_t ncols; /* -column arg count */
340: const char **cols; /* -column val ptr */
341: };
342:
1.35 ! schwarze 343: /*
! 344: * Normalised arguments for `Bf'.
! 345: */
1.31 schwarze 346: struct mdoc_bf {
347: enum mdoc_font font; /* font */
348: };
349:
1.35 ! schwarze 350: /*
! 351: * Normalised arguments for `An'.
! 352: */
1.31 schwarze 353: struct mdoc_an {
354: enum mdoc_auth auth; /* -split, etc. */
1.28 schwarze 355: };
356:
1.35 ! schwarze 357: /*
! 358: * Consists of normalised node arguments. These should be used instead
! 359: * of iterating through the mdoc_arg pointers of a node: defaults are
! 360: * provided, etc.
! 361: */
! 362: union mdoc_data {
! 363: struct mdoc_an An;
! 364: struct mdoc_bd *Bd;
! 365: struct mdoc_bf *Bf;
! 366: struct mdoc_bl *Bl;
! 367: struct tbl *TS;
! 368: };
! 369:
! 370: /*
! 371: * Single node in tree-linked AST.
! 372: */
1.1 kristaps 373: struct mdoc_node {
1.21 schwarze 374: struct mdoc_node *parent; /* parent AST node */
375: struct mdoc_node *child; /* first child AST node */
376: struct mdoc_node *next; /* sibling AST node */
377: struct mdoc_node *prev; /* prior sibling AST node */
378: int nchild; /* number children */
379: int line; /* parse line */
380: int pos; /* parse column */
381: enum mdoct tok; /* tok or MDOC__MAX if none */
1.1 kristaps 382: int flags;
1.21 schwarze 383: #define MDOC_VALID (1 << 0) /* has been validated */
384: #define MDOC_ACTED (1 << 1) /* has been acted upon */
385: #define MDOC_EOS (1 << 2) /* at sentence boundary */
386: #define MDOC_LINE (1 << 3) /* first macro/text on line */
1.29 schwarze 387: #define MDOC_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting */
1.30 schwarze 388: #define MDOC_ENDED (1 << 5) /* rendering has been ended */
1.21 schwarze 389: enum mdoc_type type; /* AST node type */
390: enum mdoc_sec sec; /* current named section */
1.29 schwarze 391: /* FIXME: these can be union'd to shave a few bytes. */
1.35 ! schwarze 392: struct mdoc_arg *args; /* BLOCK/ELEM */
! 393: struct mdoc_node *pending; /* BLOCK */
! 394: struct mdoc_node *head; /* BLOCK */
! 395: struct mdoc_node *body; /* BLOCK */
! 396: struct mdoc_node *tail; /* BLOCK */
! 397: char *string; /* TEXT */
! 398: enum mdoc_endbody end; /* BODY */
! 399: union mdoc_data data;
1.1 kristaps 400: };
401:
1.35 ! schwarze 402: /*
! 403: * Names of macros. Index is enum mdoct. Indexing into this returns
! 404: * the normalised name, e.g., mdoc_macronames[MDOC_Sh] -> "Sh".
! 405: */
! 406: extern const char *const *mdoc_macronames;
1.6 schwarze 407:
1.35 ! schwarze 408: /*
! 409: * Names of macro args. Index is enum mdocargt. Indexing into this
! 410: * returns the normalised name, e.g., mdoc_argnames[MDOC_File] ->
! 411: * "file".
! 412: */
1.1 kristaps 413: extern const char *const *mdoc_argnames;
414:
415: __BEGIN_DECLS
416:
417: struct mdoc;
1.6 schwarze 418:
1.1 kristaps 419: void mdoc_free(struct mdoc *);
1.33 schwarze 420: struct mdoc *mdoc_alloc(struct regset *, void *, mandocmsg);
1.16 schwarze 421: void mdoc_reset(struct mdoc *);
1.24 schwarze 422: int mdoc_parseln(struct mdoc *, int, char *, int);
1.1 kristaps 423: const struct mdoc_node *mdoc_node(const struct mdoc *);
424: const struct mdoc_meta *mdoc_meta(const struct mdoc *);
425: int mdoc_endparse(struct mdoc *);
426:
427: __END_DECLS
428:
429: #endif /*!MDOC_H*/