Annotation of src/usr.bin/mandoc/mdoc.c, Revision 1.144
1.144 ! schwarze 1: /* $OpenBSD: mdoc.c,v 1.143 2015/10/12 00:07:27 schwarze Exp $ */
1.1 kristaps 2: /*
1.77 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.126 schwarze 4: * Copyright (c) 2010, 2012-2015 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.3 schwarze 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.130 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.3 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.130 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.3 schwarze 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.
1.1 kristaps 17: */
1.28 schwarze 18: #include <sys/types.h>
19:
1.1 kristaps 20: #include <assert.h>
1.101 schwarze 21: #include <ctype.h>
1.1 kristaps 22: #include <stdarg.h>
23: #include <stdio.h>
24: #include <stdlib.h>
25: #include <string.h>
1.39 schwarze 26: #include <time.h>
1.1 kristaps 27:
1.128 schwarze 28: #include "mandoc_aux.h"
29: #include "mandoc.h"
30: #include "roff.h"
1.83 schwarze 31: #include "mdoc.h"
1.128 schwarze 32: #include "libmandoc.h"
1.136 schwarze 33: #include "roff_int.h"
1.1 kristaps 34: #include "libmdoc.h"
35:
1.106 schwarze 36: const char *const __mdoc_macronames[MDOC_MAX + 1] = {
1.137 schwarze 37: "text",
1.7 schwarze 38: "Ap", "Dd", "Dt", "Os",
1.1 kristaps 39: "Sh", "Ss", "Pp", "D1",
40: "Dl", "Bd", "Ed", "Bl",
41: "El", "It", "Ad", "An",
42: "Ar", "Cd", "Cm", "Dv",
43: "Er", "Ev", "Ex", "Fa",
44: "Fd", "Fl", "Fn", "Ft",
45: "Ic", "In", "Li", "Nd",
46: "Nm", "Op", "Ot", "Pa",
47: "Rv", "St", "Va", "Vt",
1.33 schwarze 48: "Xr", "%A", "%B", "%D",
49: "%I", "%J", "%N", "%O",
50: "%P", "%R", "%T", "%V",
1.1 kristaps 51: "Ac", "Ao", "Aq", "At",
52: "Bc", "Bf", "Bo", "Bq",
53: "Bsx", "Bx", "Db", "Dc",
54: "Do", "Dq", "Ec", "Ef",
55: "Em", "Eo", "Fx", "Ms",
56: "No", "Ns", "Nx", "Ox",
57: "Pc", "Pf", "Po", "Pq",
58: "Qc", "Ql", "Qo", "Qq",
59: "Re", "Rs", "Sc", "So",
60: "Sq", "Sm", "Sx", "Sy",
61: "Tn", "Ux", "Xc", "Xo",
62: "Fo", "Fc", "Oo", "Oc",
63: "Bk", "Ek", "Bt", "Hf",
1.7 schwarze 64: "Fr", "Ud", "Lb", "Lp",
65: "Lk", "Mt", "Brq", "Bro",
1.33 schwarze 66: "Brc", "%C", "Es", "En",
67: "Dx", "%Q", "br", "sp",
1.137 schwarze 68: "%U", "Ta", "ll",
69: };
1.1 kristaps 70:
1.103 schwarze 71: const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
1.1 kristaps 72: "split", "nosplit", "ragged",
1.103 schwarze 73: "unfilled", "literal", "file",
74: "offset", "bullet", "dash",
75: "hyphen", "item", "enum",
76: "tag", "diag", "hang",
77: "ohang", "inset", "column",
78: "width", "compact", "std",
1.1 kristaps 79: "filled", "words", "emphasis",
1.30 schwarze 80: "symbolic", "nested", "centered"
1.1 kristaps 81: };
82:
1.137 schwarze 83: const char * const *mdoc_macronames = __mdoc_macronames + 1;
1.1 kristaps 84: const char * const *mdoc_argnames = __mdoc_argnames;
85:
1.131 schwarze 86: static int mdoc_ptext(struct roff_man *, int, char *, int);
87: static int mdoc_pmacro(struct roff_man *, int, char *, int);
1.1 kristaps 88:
1.81 schwarze 89:
1.1 kristaps 90: /*
91: * Main parse routine. Parses a single line -- really just hands off to
1.45 schwarze 92: * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
1.1 kristaps 93: */
94: int
1.131 schwarze 95: mdoc_parseln(struct roff_man *mdoc, int ln, char *buf, int offs)
1.1 kristaps 96: {
97:
1.128 schwarze 98: if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
1.117 schwarze 99: mdoc->flags |= MDOC_NEWLINE;
1.60 schwarze 100:
101: /*
102: * Let the roff nS register switch SYNOPSIS mode early,
103: * such that the parser knows at all times
104: * whether this mode is on or off.
105: * Note that this mode is also switched by the Sh macro.
106: */
1.94 schwarze 107: if (roff_getreg(mdoc->roff, "nS"))
108: mdoc->flags |= MDOC_SYNOPSIS;
109: else
110: mdoc->flags &= ~MDOC_SYNOPSIS;
1.60 schwarze 111:
1.142 schwarze 112: return roff_getcontrol(mdoc->roff, buf, &offs) ?
1.103 schwarze 113: mdoc_pmacro(mdoc, ln, buf, offs) :
1.142 schwarze 114: mdoc_ptext(mdoc, ln, buf, offs);
1.1 kristaps 115: }
116:
1.121 schwarze 117: void
1.58 schwarze 118: mdoc_macro(MACRO_PROT_ARGS)
1.1 kristaps 119: {
1.137 schwarze 120: assert(tok > TOKEN_NONE && tok < MDOC_MAX);
1.46 schwarze 121:
1.121 schwarze 122: (*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf);
1.1 kristaps 123: }
124:
1.120 schwarze 125: void
1.131 schwarze 126: mdoc_tail_alloc(struct roff_man *mdoc, int line, int pos, int tok)
1.1 kristaps 127: {
1.129 schwarze 128: struct roff_node *p;
1.1 kristaps 129:
1.136 schwarze 130: p = roff_node_alloc(mdoc, line, pos, ROFFT_TAIL, tok);
131: roff_node_append(mdoc, p);
1.131 schwarze 132: mdoc->next = ROFF_NEXT_CHILD;
1.59 schwarze 133: }
134:
1.129 schwarze 135: struct roff_node *
1.131 schwarze 136: mdoc_endbody_alloc(struct roff_man *mdoc, int line, int pos, int tok,
1.129 schwarze 137: struct roff_node *body, enum mdoc_endbody end)
1.59 schwarze 138: {
1.129 schwarze 139: struct roff_node *p;
1.59 schwarze 140:
1.126 schwarze 141: body->flags |= MDOC_ENDED;
142: body->parent->flags |= MDOC_ENDED;
1.136 schwarze 143: p = roff_node_alloc(mdoc, line, pos, ROFFT_BODY, tok);
1.126 schwarze 144: p->body = body;
1.92 schwarze 145: p->norm = body->norm;
1.59 schwarze 146: p->end = end;
1.136 schwarze 147: roff_node_append(mdoc, p);
1.131 schwarze 148: mdoc->next = ROFF_NEXT_SIBLING;
1.142 schwarze 149: return p;
1.1 kristaps 150: }
151:
1.129 schwarze 152: struct roff_node *
1.131 schwarze 153: mdoc_block_alloc(struct roff_man *mdoc, int line, int pos,
1.129 schwarze 154: int tok, struct mdoc_arg *args)
1.1 kristaps 155: {
1.129 schwarze 156: struct roff_node *p;
1.1 kristaps 157:
1.136 schwarze 158: p = roff_node_alloc(mdoc, line, pos, ROFFT_BLOCK, tok);
1.4 schwarze 159: p->args = args;
160: if (p->args)
1.1 kristaps 161: (args->refcnt)++;
1.75 schwarze 162:
163: switch (tok) {
1.103 schwarze 164: case MDOC_Bd:
165: case MDOC_Bf:
166: case MDOC_Bl:
1.107 schwarze 167: case MDOC_En:
1.103 schwarze 168: case MDOC_Rs:
1.75 schwarze 169: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
170: break;
171: default:
172: break;
173: }
1.136 schwarze 174: roff_node_append(mdoc, p);
1.131 schwarze 175: mdoc->next = ROFF_NEXT_CHILD;
1.142 schwarze 176: return p;
1.1 kristaps 177: }
178:
1.120 schwarze 179: void
1.131 schwarze 180: mdoc_elem_alloc(struct roff_man *mdoc, int line, int pos,
1.129 schwarze 181: int tok, struct mdoc_arg *args)
1.1 kristaps 182: {
1.129 schwarze 183: struct roff_node *p;
1.1 kristaps 184:
1.136 schwarze 185: p = roff_node_alloc(mdoc, line, pos, ROFFT_ELEM, tok);
1.4 schwarze 186: p->args = args;
187: if (p->args)
1.1 kristaps 188: (args->refcnt)++;
1.75 schwarze 189:
190: switch (tok) {
1.103 schwarze 191: case MDOC_An:
1.75 schwarze 192: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
193: break;
194: default:
195: break;
196: }
1.136 schwarze 197: roff_node_append(mdoc, p);
1.131 schwarze 198: mdoc->next = ROFF_NEXT_CHILD;
1.1 kristaps 199: }
200:
1.120 schwarze 201: void
1.131 schwarze 202: mdoc_node_relink(struct roff_man *mdoc, struct roff_node *p)
1.91 schwarze 203: {
204:
1.136 schwarze 205: roff_node_unlink(mdoc, p);
206: roff_node_append(mdoc, p);
1.1 kristaps 207: }
208:
209: /*
210: * Parse free-form text, that is, a line that does not begin with the
211: * control character.
212: */
213: static int
1.131 schwarze 214: mdoc_ptext(struct roff_man *mdoc, int line, char *buf, int offs)
1.1 kristaps 215: {
1.129 schwarze 216: struct roff_node *n;
1.56 schwarze 217: char *c, *ws, *end;
1.46 schwarze 218:
1.93 schwarze 219: assert(mdoc->last);
220: n = mdoc->last;
1.56 schwarze 221:
222: /*
223: * Divert directly to list processing if we're encountering a
1.128 schwarze 224: * columnar ROFFT_BLOCK with or without a prior ROFFT_BLOCK entry
225: * (a ROFFT_BODY means it's already open, in which case we should
1.56 schwarze 226: * process within its context in the normal way).
227: */
228:
1.128 schwarze 229: if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
1.127 schwarze 230: n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
1.56 schwarze 231: /* `Bl' is open without any children. */
1.93 schwarze 232: mdoc->flags |= MDOC_FREECOL;
1.121 schwarze 233: mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
1.142 schwarze 234: return 1;
1.56 schwarze 235: }
236:
1.128 schwarze 237: if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
1.103 schwarze 238: NULL != n->parent &&
239: MDOC_Bl == n->parent->tok &&
240: LIST_column == n->parent->norm->Bl.type) {
1.56 schwarze 241: /* `Bl' has block-level `It' children. */
1.93 schwarze 242: mdoc->flags |= MDOC_FREECOL;
1.121 schwarze 243: mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
1.142 schwarze 244: return 1;
1.56 schwarze 245: }
246:
1.52 schwarze 247: /*
248: * Search for the beginning of unescaped trailing whitespace (ws)
249: * and for the first character not to be output (end).
250: */
1.56 schwarze 251:
252: /* FIXME: replace with strcspn(). */
1.52 schwarze 253: ws = NULL;
1.53 schwarze 254: for (c = end = buf + offs; *c; c++) {
1.52 schwarze 255: switch (*c) {
256: case ' ':
257: if (NULL == ws)
258: ws = c;
259: continue;
260: case '\t':
261: /*
262: * Always warn about trailing tabs,
263: * even outside literal context,
264: * where they should be put on the next line.
265: */
266: if (NULL == ws)
267: ws = c;
268: /*
269: * Strip trailing tabs in literal context only;
270: * outside, they affect the next line.
271: */
1.93 schwarze 272: if (MDOC_LITERAL & mdoc->flags)
1.52 schwarze 273: continue;
274: break;
275: case '\\':
276: /* Skip the escaped character, too, if any. */
277: if (c[1])
278: c++;
279: /* FALLTHROUGH */
280: default:
281: ws = NULL;
282: break;
283: }
284: end = c + 1;
285: }
286: *end = '\0';
1.19 schwarze 287:
1.52 schwarze 288: if (ws)
1.108 schwarze 289: mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
290: line, (int)(ws-buf), NULL);
1.34 schwarze 291:
1.120 schwarze 292: if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) {
1.108 schwarze 293: mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
294: line, (int)(c - buf), NULL);
1.46 schwarze 295:
1.40 schwarze 296: /*
1.66 schwarze 297: * Insert a `sp' in the case of a blank line. Technically,
1.46 schwarze 298: * blank lines aren't allowed, but enough manuals assume this
299: * behaviour that we want to work around it.
1.40 schwarze 300: */
1.139 schwarze 301: roff_elem_alloc(mdoc, line, offs, MDOC_sp);
1.144 ! schwarze 302: mdoc->last->flags |= MDOC_VALID | MDOC_ENDED;
1.131 schwarze 303: mdoc->next = ROFF_NEXT_SIBLING;
1.142 schwarze 304: return 1;
1.38 schwarze 305: }
1.1 kristaps 306:
1.138 schwarze 307: roff_word_alloc(mdoc, line, offs, buf+offs);
1.1 kristaps 308:
1.120 schwarze 309: if (mdoc->flags & MDOC_LITERAL)
1.142 schwarze 310: return 1;
1.52 schwarze 311:
1.35 schwarze 312: /*
1.48 schwarze 313: * End-of-sentence check. If the last character is an unescaped
314: * EOS character, then flag the node as being the end of a
315: * sentence. The front-end will know how to interpret this.
1.35 schwarze 316: */
317:
1.52 schwarze 318: assert(buf < end);
1.48 schwarze 319:
1.97 schwarze 320: if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
1.93 schwarze 321: mdoc->last->flags |= MDOC_EOS;
1.142 schwarze 322: return 1;
1.1 kristaps 323: }
1.19 schwarze 324:
1.1 kristaps 325: /*
326: * Parse a macro line, that is, a line beginning with the control
327: * character.
328: */
1.61 schwarze 329: static int
1.131 schwarze 330: mdoc_pmacro(struct roff_man *mdoc, int ln, char *buf, int offs)
1.1 kristaps 331: {
1.129 schwarze 332: struct roff_node *n;
1.118 schwarze 333: const char *cp;
1.129 schwarze 334: int tok;
1.83 schwarze 335: int i, sv;
1.56 schwarze 336: char mac[5];
1.1 kristaps 337:
1.83 schwarze 338: sv = offs;
1.47 schwarze 339:
1.103 schwarze 340: /*
1.64 schwarze 341: * Copy the first word into a nil-terminated buffer.
1.118 schwarze 342: * Stop when a space, tab, escape, or eoln is encountered.
1.63 schwarze 343: */
1.1 kristaps 344:
1.83 schwarze 345: i = 0;
1.118 schwarze 346: while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
1.83 schwarze 347: mac[i++] = buf[offs++];
348:
349: mac[i] = '\0';
350:
1.137 schwarze 351: tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : TOKEN_NONE;
1.1 kristaps 352:
1.137 schwarze 353: if (tok == TOKEN_NONE) {
1.112 schwarze 354: mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
355: ln, sv, buf + sv - 1);
1.142 schwarze 356: return 1;
1.1 kristaps 357: }
358:
1.118 schwarze 359: /* Skip a leading escape sequence or tab. */
1.63 schwarze 360:
1.118 schwarze 361: switch (buf[offs]) {
362: case '\\':
363: cp = buf + offs + 1;
364: mandoc_escape(&cp, NULL, NULL);
365: offs = cp - buf;
366: break;
367: case '\t':
1.83 schwarze 368: offs++;
1.118 schwarze 369: break;
370: default:
371: break;
372: }
1.63 schwarze 373:
374: /* Jump to the next non-whitespace word. */
1.1 kristaps 375:
1.83 schwarze 376: while (buf[offs] && ' ' == buf[offs])
377: offs++;
1.34 schwarze 378:
1.103 schwarze 379: /*
1.46 schwarze 380: * Trailing whitespace. Note that tabs are allowed to be passed
381: * into the parser as "text", so we only warn about spaces here.
382: */
1.34 schwarze 383:
1.83 schwarze 384: if ('\0' == buf[offs] && ' ' == buf[offs - 1])
1.108 schwarze 385: mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
386: ln, offs - 1, NULL);
1.1 kristaps 387:
1.56 schwarze 388: /*
389: * If an initial macro or a list invocation, divert directly
390: * into macro processing.
391: */
392:
1.121 schwarze 393: if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
394: mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
1.142 schwarze 395: return 1;
1.121 schwarze 396: }
1.56 schwarze 397:
1.93 schwarze 398: n = mdoc->last;
399: assert(mdoc->last);
1.56 schwarze 400:
401: /*
402: * If the first macro of a `Bl -column', open an `It' block
403: * context around the parsed macro.
404: */
405:
1.128 schwarze 406: if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
1.127 schwarze 407: n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
1.93 schwarze 408: mdoc->flags |= MDOC_FREECOL;
1.121 schwarze 409: mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
1.142 schwarze 410: return 1;
1.56 schwarze 411: }
412:
413: /*
414: * If we're following a block-level `It' within a `Bl -column'
415: * context (perhaps opened in the above block or in ptext()),
416: * then open an `It' block context around the parsed macro.
1.24 schwarze 417: */
1.56 schwarze 418:
1.128 schwarze 419: if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
1.103 schwarze 420: NULL != n->parent &&
421: MDOC_Bl == n->parent->tok &&
422: LIST_column == n->parent->norm->Bl.type) {
1.93 schwarze 423: mdoc->flags |= MDOC_FREECOL;
1.121 schwarze 424: mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
1.142 schwarze 425: return 1;
1.56 schwarze 426: }
427:
428: /* Normal processing of a macro. */
429:
1.121 schwarze 430: mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
1.98 schwarze 431:
432: /* In quick mode (for mandocdb), abort after the NAME section. */
433:
434: if (mdoc->quick && MDOC_Sh == tok &&
435: SEC_NAME != mdoc->last->sec)
1.142 schwarze 436: return 2;
1.1 kristaps 437:
1.142 schwarze 438: return 1;
1.1 kristaps 439: }
1.24 schwarze 440:
1.83 schwarze 441: enum mdelim
442: mdoc_isdelim(const char *p)
443: {
444:
445: if ('\0' == p[0])
1.142 schwarze 446: return DELIM_NONE;
1.83 schwarze 447:
448: if ('\0' == p[1])
449: switch (p[0]) {
1.103 schwarze 450: case '(':
451: case '[':
1.142 schwarze 452: return DELIM_OPEN;
1.103 schwarze 453: case '|':
1.142 schwarze 454: return DELIM_MIDDLE;
1.103 schwarze 455: case '.':
456: case ',':
457: case ';':
458: case ':':
459: case '?':
460: case '!':
461: case ')':
462: case ']':
1.142 schwarze 463: return DELIM_CLOSE;
1.83 schwarze 464: default:
1.142 schwarze 465: return DELIM_NONE;
1.83 schwarze 466: }
467:
468: if ('\\' != p[0])
1.142 schwarze 469: return DELIM_NONE;
1.24 schwarze 470:
1.83 schwarze 471: if (0 == strcmp(p + 1, "."))
1.142 schwarze 472: return DELIM_CLOSE;
1.90 schwarze 473: if (0 == strcmp(p + 1, "fR|\\fP"))
1.142 schwarze 474: return DELIM_MIDDLE;
1.83 schwarze 475:
1.142 schwarze 476: return DELIM_NONE;
1.144 ! schwarze 477: }
! 478:
! 479: void
! 480: mdoc_validate(struct roff_man *mdoc)
! 481: {
! 482:
! 483: mdoc->last = mdoc->first;
! 484: mdoc_node_validate(mdoc);
! 485: mdoc_state_reset(mdoc);
1.83 schwarze 486: }