1 /* $Id: mdoc.h,v 1.136 2015/02/12 12:24:33 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
147 MDOC_Split, /* -split */
148 MDOC_Nosplit, /* -nospli */
149 MDOC_Ragged, /* -ragged */
150 MDOC_Unfilled, /* -unfilled */
151 MDOC_Literal, /* -literal */
152 MDOC_File, /* -file */
153 MDOC_Offset, /* -offset */
154 MDOC_Bullet, /* -bullet */
155 MDOC_Dash, /* -dash */
156 MDOC_Hyphen, /* -hyphen */
157 MDOC_Item, /* -item */
158 MDOC_Enum, /* -enum */
160 MDOC_Diag, /* -diag */
161 MDOC_Hang, /* -hang */
162 MDOC_Ohang, /* -ohang */
163 MDOC_Inset, /* -inset */
164 MDOC_Column, /* -column */
165 MDOC_Width, /* -width */
166 MDOC_Compact, /* -compact */
168 MDOC_Filled, /* -filled */
169 MDOC_Words, /* -words */
170 MDOC_Emphasis, /* -emphasis */
171 MDOC_Symbolic, /* -symbolic */
172 MDOC_Nested, /* -nested */
173 MDOC_Centred, /* -centered */
190 * Section (named/unnamed) of `Sh'. Note that these appear in the
191 * conventional order imposed by mdoc.7. In the case of SEC_NONE, no
192 * section has been invoked (this shouldn't happen). SEC_CUSTOM refers
198 SEC_LIBRARY, /* LIBRARY */
199 SEC_SYNOPSIS, /* SYNOPSIS */
200 SEC_DESCRIPTION, /* DESCRIPTION */
201 SEC_CONTEXT, /* CONTEXT */
202 SEC_IMPLEMENTATION, /* IMPLEMENTATION NOTES */
203 SEC_RETURN_VALUES, /* RETURN VALUES */
204 SEC_ENVIRONMENT, /* ENVIRONMENT */
205 SEC_FILES, /* FILES */
206 SEC_EXIT_STATUS, /* EXIT STATUS */
207 SEC_EXAMPLES, /* EXAMPLES */
208 SEC_DIAGNOSTICS, /* DIAGNOSTICS */
209 SEC_COMPATIBILITY, /* COMPATIBILITY */
210 SEC_ERRORS, /* ERRORS */
211 SEC_SEE_ALSO, /* SEE ALSO */
212 SEC_STANDARDS, /* STANDARDS */
213 SEC_HISTORY, /* HISTORY */
214 SEC_AUTHORS, /* AUTHORS */
215 SEC_CAVEATS, /* CAVEATS */
217 SEC_SECURITY, /* SECURITY */
223 char *msec; /* `Dt' section (1, 3p, etc.) */
224 char *vol; /* `Dt' volume (implied) */
225 char *arch; /* `Dt' arch (i386, etc.) */
226 char *date; /* `Dd' normalised date */
227 char *title; /* `Dt' title (FOO, etc.) */
228 char *os; /* `Os' system (OpenBSD, etc.) */
229 char *name; /* leading `Nm' name */
233 * An argument to a macro (multiple values = `-column xxx yyy').
236 enum mdocargt arg; /* type of argument */
239 size_t sz; /* elements in "value" */
240 char **value; /* argument strings */
244 * Reference-counted macro arguments. These are refcounted because
245 * blocks have multiple instances of the same arguments spread across
246 * the HEAD, BODY, TAIL, and BLOCK node types.
250 struct mdoc_argv *argv;
255 * Indicates that a BODY's formatting has ended, but the scope is still
256 * open. Used for syntax-broken blocks.
260 ENDBODY_SPACE, /* is broken: append a space */
261 ENDBODY_NOSPACE /* is broken: don't append a space */
266 LIST_bullet, /* -bullet */
267 LIST_column, /* -column */
268 LIST_dash, /* -dash */
269 LIST_diag, /* -diag */
270 LIST_enum, /* -enum */
271 LIST_hang, /* -hang */
272 LIST_hyphen, /* -hyphen */
273 LIST_inset, /* -inset */
274 LIST_item, /* -item */
275 LIST_ohang, /* -ohang */
282 DISP_centered, /* -centered */
283 DISP_ragged, /* -ragged */
284 DISP_unfilled, /* -unfilled */
285 DISP_filled, /* -filled */
286 DISP_literal /* -literal */
291 AUTH_split, /* -split */
292 AUTH_nosplit /* -nosplit */
297 FONT_Em, /* Em, -emphasis */
298 FONT_Li, /* Li, -literal */
299 FONT_Sy /* Sy, -symbolic */
303 const char *offs; /* -offset */
304 enum mdoc_disp type; /* -ragged, etc. */
305 int comp; /* -compact */
309 const char *width; /* -width */
310 const char *offs; /* -offset */
311 enum mdoc_list type; /* -tag, -enum, etc. */
312 int comp; /* -compact */
313 size_t ncols; /* -column arg count */
314 const char **cols; /* -column val ptr */
315 int count; /* -enum counter */
319 enum mdoc_font font; /* font */
323 enum mdoc_auth auth; /* -split, etc. */
327 int quote_T; /* whether to quote %T */
331 * Consists of normalised node arguments. These should be used instead
332 * of iterating through the mdoc_arg pointers of a node: defaults are
340 struct mdoc_node *Es;
345 * Single node in tree-linked AST.
348 struct mdoc_node *parent; /* parent AST node */
349 struct mdoc_node *child; /* first child AST node */
350 struct mdoc_node *last; /* last child AST node */
351 struct mdoc_node *next; /* sibling AST node */
352 struct mdoc_node *prev; /* prior sibling AST node */
353 int nchild; /* number children */
354 int line; /* parse line */
355 int pos; /* parse column */
356 enum mdoct tok; /* tok or MDOC__MAX if none */
358 #define MDOC_VALID (1 << 0) /* has been validated */
359 #define MDOC_ENDED (1 << 1) /* gone past body end mark */
360 #define MDOC_EOS (1 << 2) /* at sentence boundary */
361 #define MDOC_LINE (1 << 3) /* first macro/text on line */
362 #define MDOC_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting */
363 #define MDOC_BROKEN (1 << 5) /* must validate parent when ending */
364 #define MDOC_DELIMO (1 << 6)
365 #define MDOC_DELIMC (1 << 7)
366 enum mdoc_type type; /* AST node type */
367 enum mdoc_sec sec; /* current named section */
368 union mdoc_data *norm; /* normalised args */
369 int prev_font; /* before entering this node */
370 /* FIXME: these can be union'd to shave a few bytes. */
371 struct mdoc_arg *args; /* BLOCK/ELEM */
372 struct mdoc_node *head; /* BLOCK */
373 struct mdoc_node *body; /* BLOCK/ENDBODY */
374 struct mdoc_node *tail; /* BLOCK */
375 char *string; /* TEXT */
376 const struct tbl_span *span; /* TBL */
377 const struct eqn *eqn; /* EQN */
378 enum mdoc_endbody end; /* BODY */
381 /* Names of macros. Index is enum mdoct. */
382 extern const char *const *mdoc_macronames;
384 /* Names of macro args. Index is enum mdocargt. */
385 extern const char *const *mdoc_argnames;
391 const struct mdoc_node *mdoc_node(const struct mdoc *);
392 const struct mdoc_meta *mdoc_meta(const struct mdoc *);
393 void mdoc_deroff(char **, const struct mdoc_node *);