1 /* $Id: mdoc.c,v 1.177 2011/01/03 11:27:33 kristaps Exp $ */
3 * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2010 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.
22 #include <sys/types.h>
33 #include "libmandoc.h"
35 const char *const __mdoc_macronames[MDOC_MAX] = {
36 "Ap", "Dd", "Dt", "Os",
37 "Sh", "Ss", "Pp", "D1",
38 "Dl", "Bd", "Ed", "Bl",
39 "El", "It", "Ad", "An",
40 "Ar", "Cd", "Cm", "Dv",
41 "Er", "Ev", "Ex", "Fa",
42 "Fd", "Fl", "Fn", "Ft",
43 "Ic", "In", "Li", "Nd",
44 "Nm", "Op", "Ot", "Pa",
45 "Rv", "St", "Va", "Vt",
47 "Xr", "%A", "%B", "%D",
49 "%I", "%J", "%N", "%O",
51 "%P", "%R", "%T", "%V",
52 "Ac", "Ao", "Aq", "At",
53 "Bc", "Bf", "Bo", "Bq",
54 "Bsx", "Bx", "Db", "Dc",
55 "Do", "Dq", "Ec", "Ef",
56 "Em", "Eo", "Fx", "Ms",
57 "No", "Ns", "Nx", "Ox",
58 "Pc", "Pf", "Po", "Pq",
59 "Qc", "Ql", "Qo", "Qq",
60 "Re", "Rs", "Sc", "So",
61 "Sq", "Sm", "Sx", "Sy",
62 "Tn", "Ux", "Xc", "Xo",
63 "Fo", "Fc", "Oo", "Oc",
64 "Bk", "Ek", "Bt", "Hf",
65 "Fr", "Ud", "Lb", "Lp",
66 "Lk", "Mt", "Brq", "Bro",
68 "Brc", "%C", "Es", "En",
70 "Dx", "%Q", "br", "sp",
75 const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
76 "split", "nosplit", "ragged",
77 "unfilled", "literal", "file",
78 "offset", "bullet", "dash",
79 "hyphen", "item", "enum",
80 "tag", "diag", "hang",
81 "ohang", "inset", "column",
82 "width", "compact", "std",
83 "filled", "words", "emphasis",
84 "symbolic", "nested", "centered"
87 const char * const *mdoc_macronames = __mdoc_macronames;
88 const char * const *mdoc_argnames = __mdoc_argnames;
90 static void mdoc_node_free(struct mdoc_node *);
91 static void mdoc_node_unlink(struct mdoc *,
93 static void mdoc_free1(struct mdoc *);
94 static void mdoc_alloc1(struct mdoc *);
95 static struct mdoc_node *node_alloc(struct mdoc *, int, int,
96 enum mdoct, enum mdoc_type);
97 static int node_append(struct mdoc *,
99 static int mdoc_ptext(struct mdoc *, int, char *, int);
100 static int mdoc_pmacro(struct mdoc *, int, char *, int);
101 static int mdoc_span_alloc(struct mdoc *,
102 const struct tbl_span *);
105 const struct mdoc_node *
106 mdoc_node(const struct mdoc *m)
109 assert( ! (MDOC_HALT & m->flags));
114 const struct mdoc_meta *
115 mdoc_meta(const struct mdoc *m)
118 assert( ! (MDOC_HALT & m->flags));
124 * Frees volatile resources (parse tree, meta-data, fields).
127 mdoc_free1(struct mdoc *mdoc)
131 mdoc_node_delete(mdoc, mdoc->first);
132 if (mdoc->meta.title)
133 free(mdoc->meta.title);
137 free(mdoc->meta.name);
139 free(mdoc->meta.arch);
141 free(mdoc->meta.vol);
143 free(mdoc->meta.msec);
148 * Allocate all volatile resources (parse tree, meta-data, fields).
151 mdoc_alloc1(struct mdoc *mdoc)
154 memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
156 mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
157 mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
158 mdoc->first = mdoc->last;
159 mdoc->last->type = MDOC_ROOT;
160 mdoc->next = MDOC_NEXT_CHILD;
165 * Free up volatile resources (see mdoc_free1()) then re-initialises the
166 * data with mdoc_alloc1(). After invocation, parse data has been reset
167 * and the parser is ready for re-invocation on a new tree; however,
168 * cross-parse non-volatile data is kept intact.
171 mdoc_reset(struct mdoc *mdoc)
180 * Completely free up all volatile and non-volatile parse resources.
181 * After invocation, the pointer is no longer usable.
184 mdoc_free(struct mdoc *mdoc)
193 * Allocate volatile and non-volatile parse resources.
196 mdoc_alloc(struct regset *regs, void *data, mandocmsg msg)
200 p = mandoc_calloc(1, sizeof(struct mdoc));
213 * Climb back up the parse tree, validating open scopes. Mostly calls
214 * through to macro_end() in macro.c.
217 mdoc_endparse(struct mdoc *m)
220 assert( ! (MDOC_HALT & m->flags));
221 if (mdoc_macroend(m))
223 m->flags |= MDOC_HALT;
228 mdoc_addspan(struct mdoc *m, const struct tbl_span *sp)
231 assert( ! (MDOC_HALT & m->flags));
233 /* No text before an initial macro. */
235 if (SEC_NONE == m->lastnamed) {
236 /* FIXME: grab from span. */
237 mdoc_pmsg(m, 0, 0, MANDOCERR_NOTEXT);
241 return(mdoc_span_alloc(m, sp));
246 * Main parse routine. Parses a single line -- really just hands off to
247 * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
250 mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
253 assert( ! (MDOC_HALT & m->flags));
255 m->flags |= MDOC_NEWLINE;
258 * Let the roff nS register switch SYNOPSIS mode early,
259 * such that the parser knows at all times
260 * whether this mode is on or off.
261 * Note that this mode is also switched by the Sh macro.
263 if (m->regs->regs[(int)REG_nS].set) {
264 if (m->regs->regs[(int)REG_nS].v.u)
265 m->flags |= MDOC_SYNOPSIS;
267 m->flags &= ~MDOC_SYNOPSIS;
270 return(('.' == buf[offs] || '\'' == buf[offs]) ?
271 mdoc_pmacro(m, ln, buf, offs) :
272 mdoc_ptext(m, ln, buf, offs));
277 mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
278 int ln, int pos, const char *fmt, ...)
284 vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
287 return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
292 mdoc_macro(MACRO_PROT_ARGS)
294 assert(tok < MDOC_MAX);
296 /* If we're in the body, deny prologue calls. */
298 if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
299 MDOC_PBODY & m->flags) {
300 mdoc_pmsg(m, line, ppos, MANDOCERR_BADBODY);
304 /* If we're in the prologue, deny "body" macros. */
306 if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
307 ! (MDOC_PBODY & m->flags)) {
308 mdoc_pmsg(m, line, ppos, MANDOCERR_BADPROLOG);
309 if (NULL == m->meta.msec)
310 m->meta.msec = mandoc_strdup("1");
311 if (NULL == m->meta.title)
312 m->meta.title = mandoc_strdup("UNKNOWN");
313 if (NULL == m->meta.vol)
314 m->meta.vol = mandoc_strdup("LOCAL");
315 if (NULL == m->meta.os)
316 m->meta.os = mandoc_strdup("LOCAL");
317 if (0 == m->meta.date)
318 m->meta.date = time(NULL);
319 m->flags |= MDOC_PBODY;
322 return((*mdoc_macros[tok].fp)(m, tok, line, ppos, pos, buf));
327 node_append(struct mdoc *mdoc, struct mdoc_node *p)
332 assert(MDOC_ROOT != p->type);
334 switch (mdoc->next) {
335 case (MDOC_NEXT_SIBLING):
336 mdoc->last->next = p;
337 p->prev = mdoc->last;
338 p->parent = mdoc->last->parent;
340 case (MDOC_NEXT_CHILD):
341 mdoc->last->child = p;
342 p->parent = mdoc->last;
352 * Copy over the normalised-data pointer of our parent. Not
353 * everybody has one, but copying a null pointer is fine.
362 p->norm = p->parent->norm;
368 if ( ! mdoc_valid_pre(mdoc, p))
373 assert(MDOC_BLOCK == p->parent->type);
377 assert(MDOC_BLOCK == p->parent->type);
383 assert(MDOC_BLOCK == p->parent->type);
396 if ( ! mdoc_valid_post(mdoc))
407 static struct mdoc_node *
408 node_alloc(struct mdoc *m, int line, int pos,
409 enum mdoct tok, enum mdoc_type type)
413 p = mandoc_calloc(1, sizeof(struct mdoc_node));
422 if (MDOC_SYNOPSIS & m->flags)
423 p->flags |= MDOC_SYNPRETTY;
425 p->flags &= ~MDOC_SYNPRETTY;
426 if (MDOC_NEWLINE & m->flags)
427 p->flags |= MDOC_LINE;
428 m->flags &= ~MDOC_NEWLINE;
435 mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
439 p = node_alloc(m, line, pos, tok, MDOC_TAIL);
440 if ( ! node_append(m, p))
442 m->next = MDOC_NEXT_CHILD;
448 mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
455 p = node_alloc(m, line, pos, tok, MDOC_HEAD);
456 if ( ! node_append(m, p))
458 m->next = MDOC_NEXT_CHILD;
464 mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
468 p = node_alloc(m, line, pos, tok, MDOC_BODY);
469 if ( ! node_append(m, p))
471 m->next = MDOC_NEXT_CHILD;
477 mdoc_endbody_alloc(struct mdoc *m, int line, int pos, enum mdoct tok,
478 struct mdoc_node *body, enum mdoc_endbody end)
482 p = node_alloc(m, line, pos, tok, MDOC_BODY);
485 if ( ! node_append(m, p))
487 m->next = MDOC_NEXT_SIBLING;
493 mdoc_block_alloc(struct mdoc *m, int line, int pos,
494 enum mdoct tok, struct mdoc_arg *args)
498 p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
511 p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
517 if ( ! node_append(m, p))
519 m->next = MDOC_NEXT_CHILD;
525 mdoc_elem_alloc(struct mdoc *m, int line, int pos,
526 enum mdoct tok, struct mdoc_arg *args)
530 p = node_alloc(m, line, pos, tok, MDOC_ELEM);
537 p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
543 if ( ! node_append(m, p))
545 m->next = MDOC_NEXT_CHILD;
550 mdoc_span_alloc(struct mdoc *m, const struct tbl_span *sp)
554 /* FIXME: grab from tbl_span. */
555 n = node_alloc(m, 0, 0, MDOC_MAX, MDOC_TBL);
558 if ( ! node_append(m, n))
561 m->next = MDOC_NEXT_SIBLING;
567 mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
574 n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
575 n->string = mandoc_malloc(len + 1);
576 sv = strlcpy(n->string, p, len + 1);
578 /* Prohibit truncation. */
579 assert(sv < len + 1);
581 if ( ! node_append(m, n))
584 m->next = MDOC_NEXT_SIBLING;
590 mdoc_node_free(struct mdoc_node *p)
593 if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
598 mdoc_argv_free(p->args);
604 mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
607 /* Adjust siblings. */
610 n->prev->next = n->next;
612 n->next->prev = n->prev;
618 if (n->parent->child == n)
619 n->parent->child = n->prev ? n->prev : n->next;
620 if (n->parent->last == n)
621 n->parent->last = n->prev ? n->prev : NULL;
624 /* Adjust parse point, if applicable. */
626 if (m && m->last == n) {
629 m->next = MDOC_NEXT_SIBLING;
632 m->next = MDOC_NEXT_CHILD;
636 if (m && m->first == n)
642 mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
647 mdoc_node_delete(m, p->child);
649 assert(0 == p->nchild);
651 mdoc_node_unlink(m, p);
657 * Parse free-form text, that is, a line that does not begin with the
661 mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
666 /* Ignore bogus comments. */
668 if ('\\' == buf[offs] &&
669 '.' == buf[offs + 1] &&
670 '"' == buf[offs + 2]) {
671 mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT);
675 /* No text before an initial macro. */
677 if (SEC_NONE == m->lastnamed) {
678 mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT);
686 * Divert directly to list processing if we're encountering a
687 * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
688 * (a MDOC_BODY means it's already open, in which case we should
689 * process within its context in the normal way).
692 if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
693 LIST_column == n->norm->Bl.type) {
694 /* `Bl' is open without any children. */
695 m->flags |= MDOC_FREECOL;
696 return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
699 if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
701 MDOC_Bl == n->parent->tok &&
702 LIST_column == n->parent->norm->Bl.type) {
703 /* `Bl' has block-level `It' children. */
704 m->flags |= MDOC_FREECOL;
705 return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
709 * Search for the beginning of unescaped trailing whitespace (ws)
710 * and for the first character not to be output (end).
713 /* FIXME: replace with strcspn(). */
715 for (c = end = buf + offs; *c; c++) {
718 if (mandoc_hyph(buf + offs, c))
728 * Always warn about trailing tabs,
729 * even outside literal context,
730 * where they should be put on the next line.
735 * Strip trailing tabs in literal context only;
736 * outside, they affect the next line.
738 if (MDOC_LITERAL & m->flags)
742 /* Skip the escaped character, too, if any. */
755 mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
757 if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
758 mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
761 * Insert a `sp' in the case of a blank line. Technically,
762 * blank lines aren't allowed, but enough manuals assume this
763 * behaviour that we want to work around it.
765 if ( ! mdoc_elem_alloc(m, line, offs, MDOC_sp, NULL))
768 m->next = MDOC_NEXT_SIBLING;
772 if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
775 if (MDOC_LITERAL & m->flags)
779 * End-of-sentence check. If the last character is an unescaped
780 * EOS character, then flag the node as being the end of a
781 * sentence. The front-end will know how to interpret this.
786 if (mandoc_eos(buf+offs, (size_t)(end-buf-offs), 0))
787 m->last->flags |= MDOC_EOS;
794 * Parse a macro line, that is, a line beginning with the control
798 mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
805 /* Empty lines are ignored. */
809 if ('\0' == buf[offs])
814 /* Accept tabs/whitespace after the initial control char. */
816 if (' ' == buf[i] || '\t' == buf[i]) {
818 while (buf[i] && (' ' == buf[i] || '\t' == buf[i]))
827 * Copy the first word into a nil-terminated buffer.
828 * Stop copying when a tab, space, or eoln is encountered.
832 while (j < 4 && '\0' != buf[i] && ' ' != buf[i] && '\t' != buf[i])
836 tok = (j > 1 || j < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
837 if (MDOC_MAX == tok) {
838 mdoc_vmsg(m, MANDOCERR_MACRO, ln, sv, "%s", buf + sv - 1);
842 /* Disregard the first trailing tab, if applicable. */
847 /* Jump to the next non-whitespace word. */
849 while (buf[i] && ' ' == buf[i])
853 * Trailing whitespace. Note that tabs are allowed to be passed
854 * into the parser as "text", so we only warn about spaces here.
857 if ('\0' == buf[i] && ' ' == buf[i - 1])
858 mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE);
861 * If an initial macro or a list invocation, divert directly
862 * into macro processing.
865 if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {
866 if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
875 * If the first macro of a `Bl -column', open an `It' block
876 * context around the parsed macro.
879 if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
880 LIST_column == n->norm->Bl.type) {
881 m->flags |= MDOC_FREECOL;
882 if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
888 * If we're following a block-level `It' within a `Bl -column'
889 * context (perhaps opened in the above block or in ptext()),
890 * then open an `It' block context around the parsed macro.
893 if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
895 MDOC_Bl == n->parent->tok &&
896 LIST_column == n->parent->norm->Bl.type) {
897 m->flags |= MDOC_FREECOL;
898 if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
903 /* Normal processing of a macro. */
905 if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
910 err: /* Error out. */
912 m->flags |= MDOC_HALT;