Annotation of mandoc/mdoc.c, Revision 1.147
1.147 ! kristaps 1: /* $Id: mdoc.c,v 1.146 2010/06/12 11:58:22 kristaps Exp $ */
1.1 kristaps 2: /*
1.144 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.75 kristaps 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.75 kristaps 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: */
1.114 kristaps 17: #ifdef HAVE_CONFIG_H
18: #include "config.h"
19: #endif
20:
1.106 kristaps 21: #include <sys/types.h>
22:
1.1 kristaps 23: #include <assert.h>
24: #include <ctype.h>
25: #include <stdarg.h>
1.73 kristaps 26: #include <stdio.h>
1.1 kristaps 27: #include <stdlib.h>
28: #include <string.h>
1.120 kristaps 29: #include <time.h>
1.1 kristaps 30:
1.136 kristaps 31: #include "mandoc.h"
1.147 ! kristaps 32: #include "regs.h"
1.70 kristaps 33: #include "libmdoc.h"
1.113 kristaps 34: #include "libmandoc.h"
1.1 kristaps 35:
36: const char *const __mdoc_macronames[MDOC_MAX] = {
1.82 kristaps 37: "Ap", "Dd", "Dt", "Os",
1.1 kristaps 38: "Sh", "Ss", "Pp", "D1",
39: "Dl", "Bd", "Ed", "Bl",
40: "El", "It", "Ad", "An",
41: "Ar", "Cd", "Cm", "Dv",
42: "Er", "Ev", "Ex", "Fa",
43: "Fd", "Fl", "Fn", "Ft",
44: "Ic", "In", "Li", "Nd",
45: "Nm", "Op", "Ot", "Pa",
46: "Rv", "St", "Va", "Vt",
47: /* LINTED */
1.114 kristaps 48: "Xr", "%A", "%B", "%D",
1.1 kristaps 49: /* LINTED */
1.114 kristaps 50: "%I", "%J", "%N", "%O",
1.1 kristaps 51: /* LINTED */
1.114 kristaps 52: "%P", "%R", "%T", "%V",
1.1 kristaps 53: "Ac", "Ao", "Aq", "At",
54: "Bc", "Bf", "Bo", "Bq",
55: "Bsx", "Bx", "Db", "Dc",
56: "Do", "Dq", "Ec", "Ef",
57: "Em", "Eo", "Fx", "Ms",
58: "No", "Ns", "Nx", "Ox",
59: "Pc", "Pf", "Po", "Pq",
60: "Qc", "Ql", "Qo", "Qq",
61: "Re", "Rs", "Sc", "So",
62: "Sq", "Sm", "Sx", "Sy",
63: "Tn", "Ux", "Xc", "Xo",
64: "Fo", "Fc", "Oo", "Oc",
65: "Bk", "Ek", "Bt", "Hf",
1.82 kristaps 66: "Fr", "Ud", "Lb", "Lp",
67: "Lk", "Mt", "Brq", "Bro",
1.64 kristaps 68: /* LINTED */
1.114 kristaps 69: "Brc", "%C", "Es", "En",
1.69 kristaps 70: /* LINTED */
1.114 kristaps 71: "Dx", "%Q", "br", "sp",
1.110 kristaps 72: /* LINTED */
1.141 kristaps 73: "%U", "Ta"
1.1 kristaps 74: };
75:
76: const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
77: "split", "nosplit", "ragged",
78: "unfilled", "literal", "file",
79: "offset", "bullet", "dash",
80: "hyphen", "item", "enum",
81: "tag", "diag", "hang",
82: "ohang", "inset", "column",
83: "width", "compact", "std",
1.52 kristaps 84: "filled", "words", "emphasis",
1.108 kristaps 85: "symbolic", "nested", "centered"
1.1 kristaps 86: };
87:
88: const char * const *mdoc_macronames = __mdoc_macronames;
89: const char * const *mdoc_argnames = __mdoc_argnames;
90:
1.121 kristaps 91: static void mdoc_node_free(struct mdoc_node *);
92: static void mdoc_node_unlink(struct mdoc *,
93: struct mdoc_node *);
1.73 kristaps 94: static void mdoc_free1(struct mdoc *);
1.113 kristaps 95: static void mdoc_alloc1(struct mdoc *);
1.73 kristaps 96: static struct mdoc_node *node_alloc(struct mdoc *, int, int,
1.117 kristaps 97: enum mdoct, enum mdoc_type);
1.73 kristaps 98: static int node_append(struct mdoc *,
1.71 kristaps 99: struct mdoc_node *);
1.135 kristaps 100: static int mdoc_ptext(struct mdoc *, int, char *, int);
101: static int mdoc_pmacro(struct mdoc *, int, char *, int);
102: static int macrowarn(struct mdoc *, int,
103: const char *, int);
1.124 kristaps 104:
1.88 kristaps 105:
1.1 kristaps 106: const struct mdoc_node *
1.71 kristaps 107: mdoc_node(const struct mdoc *m)
1.1 kristaps 108: {
109:
1.71 kristaps 110: return(MDOC_HALT & m->flags ? NULL : m->first);
1.1 kristaps 111: }
112:
113:
1.37 kristaps 114: const struct mdoc_meta *
1.71 kristaps 115: mdoc_meta(const struct mdoc *m)
1.37 kristaps 116: {
117:
1.71 kristaps 118: return(MDOC_HALT & m->flags ? NULL : &m->meta);
1.37 kristaps 119: }
120:
121:
1.85 kristaps 122: /*
123: * Frees volatile resources (parse tree, meta-data, fields).
124: */
1.73 kristaps 125: static void
126: mdoc_free1(struct mdoc *mdoc)
1.67 kristaps 127: {
128:
129: if (mdoc->first)
1.121 kristaps 130: mdoc_node_delete(mdoc, mdoc->first);
1.67 kristaps 131: if (mdoc->meta.title)
132: free(mdoc->meta.title);
133: if (mdoc->meta.os)
134: free(mdoc->meta.os);
135: if (mdoc->meta.name)
136: free(mdoc->meta.name);
137: if (mdoc->meta.arch)
138: free(mdoc->meta.arch);
139: if (mdoc->meta.vol)
140: free(mdoc->meta.vol);
1.133 kristaps 141: if (mdoc->meta.msec)
142: free(mdoc->meta.msec);
1.73 kristaps 143: }
144:
145:
1.85 kristaps 146: /*
147: * Allocate all volatile resources (parse tree, meta-data, fields).
148: */
1.113 kristaps 149: static void
1.73 kristaps 150: mdoc_alloc1(struct mdoc *mdoc)
151: {
1.67 kristaps 152:
1.112 kristaps 153: memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
1.67 kristaps 154: mdoc->flags = 0;
1.85 kristaps 155: mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.113 kristaps 156: mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
1.70 kristaps 157: mdoc->first = mdoc->last;
1.67 kristaps 158: mdoc->last->type = MDOC_ROOT;
159: mdoc->next = MDOC_NEXT_CHILD;
1.73 kristaps 160: }
161:
162:
163: /*
1.85 kristaps 164: * Free up volatile resources (see mdoc_free1()) then re-initialises the
165: * data with mdoc_alloc1(). After invocation, parse data has been reset
166: * and the parser is ready for re-invocation on a new tree; however,
167: * cross-parse non-volatile data is kept intact.
1.73 kristaps 168: */
1.113 kristaps 169: void
1.73 kristaps 170: mdoc_reset(struct mdoc *mdoc)
171: {
172:
173: mdoc_free1(mdoc);
1.113 kristaps 174: mdoc_alloc1(mdoc);
1.67 kristaps 175: }
176:
177:
1.68 kristaps 178: /*
1.85 kristaps 179: * Completely free up all volatile and non-volatile parse resources.
180: * After invocation, the pointer is no longer usable.
1.68 kristaps 181: */
1.67 kristaps 182: void
1.38 kristaps 183: mdoc_free(struct mdoc *mdoc)
1.34 kristaps 184: {
185:
1.73 kristaps 186: mdoc_free1(mdoc);
1.1 kristaps 187: free(mdoc);
188: }
189:
190:
1.85 kristaps 191: /*
192: * Allocate volatile and non-volatile parse resources.
193: */
1.1 kristaps 194: struct mdoc *
1.136 kristaps 195: mdoc_alloc(void *data, int pflags, mandocmsg msg)
1.1 kristaps 196: {
197: struct mdoc *p;
198:
1.113 kristaps 199: p = mandoc_calloc(1, sizeof(struct mdoc));
200:
1.136 kristaps 201: p->msg = msg;
1.1 kristaps 202: p->data = data;
1.73 kristaps 203: p->pflags = pflags;
204:
1.113 kristaps 205: mdoc_hash_init();
206: mdoc_alloc1(p);
207: return(p);
1.1 kristaps 208: }
209:
210:
1.68 kristaps 211: /*
212: * Climb back up the parse tree, validating open scopes. Mostly calls
1.85 kristaps 213: * through to macro_end() in macro.c.
1.68 kristaps 214: */
1.1 kristaps 215: int
1.72 kristaps 216: mdoc_endparse(struct mdoc *m)
1.20 kristaps 217: {
218:
1.72 kristaps 219: if (MDOC_HALT & m->flags)
1.20 kristaps 220: return(0);
1.72 kristaps 221: else if (mdoc_macroend(m))
1.20 kristaps 222: return(1);
1.72 kristaps 223: m->flags |= MDOC_HALT;
224: return(0);
1.20 kristaps 225: }
226:
227:
1.50 kristaps 228: /*
1.53 kristaps 229: * Main parse routine. Parses a single line -- really just hands off to
1.123 kristaps 230: * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
1.50 kristaps 231: */
1.20 kristaps 232: int
1.147 ! kristaps 233: mdoc_parseln(struct mdoc *m, const struct regset *regs,
! 234: int ln, char *buf, int offs)
1.1 kristaps 235: {
236:
1.53 kristaps 237: if (MDOC_HALT & m->flags)
1.20 kristaps 238: return(0);
1.50 kristaps 239:
1.130 kristaps 240: m->flags |= MDOC_NEWLINE;
1.135 kristaps 241: return(('.' == buf[offs] || '\'' == buf[offs]) ?
242: mdoc_pmacro(m, ln, buf, offs) :
243: mdoc_ptext(m, ln, buf, offs));
1.1 kristaps 244: }
245:
246:
247: int
1.136 kristaps 248: mdoc_vmsg(struct mdoc *mdoc, enum mandocerr t,
249: int ln, int pos, const char *fmt, ...)
1.1 kristaps 250: {
1.31 kristaps 251: char buf[256];
252: va_list ap;
1.1 kristaps 253:
1.31 kristaps 254: va_start(ap, fmt);
1.136 kristaps 255: vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
1.31 kristaps 256: va_end(ap);
1.88 kristaps 257:
1.136 kristaps 258: return((*mdoc->msg)(t, mdoc->data, ln, pos, buf));
1.88 kristaps 259: }
260:
261:
262: int
1.117 kristaps 263: mdoc_macro(struct mdoc *m, enum mdoct tok,
1.88 kristaps 264: int ln, int pp, int *pos, char *buf)
265: {
1.122 kristaps 266: assert(tok < MDOC_MAX);
267:
268: /* If we're in the body, deny prologue calls. */
1.117 kristaps 269:
1.88 kristaps 270: if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.122 kristaps 271: MDOC_PBODY & m->flags)
1.136 kristaps 272: return(mdoc_pmsg(m, ln, pp, MANDOCERR_BADBODY));
1.122 kristaps 273:
274: /* If we're in the prologue, deny "body" macros. */
275:
276: if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
277: ! (MDOC_PBODY & m->flags)) {
1.136 kristaps 278: if ( ! mdoc_pmsg(m, ln, pp, MANDOCERR_BADPROLOG))
1.120 kristaps 279: return(0);
280: if (NULL == m->meta.title)
1.140 kristaps 281: m->meta.title = mandoc_strdup("UNKNOWN");
1.120 kristaps 282: if (NULL == m->meta.vol)
1.140 kristaps 283: m->meta.vol = mandoc_strdup("LOCAL");
1.120 kristaps 284: if (NULL == m->meta.os)
1.140 kristaps 285: m->meta.os = mandoc_strdup("LOCAL");
1.120 kristaps 286: if (0 == m->meta.date)
287: m->meta.date = time(NULL);
288: m->flags |= MDOC_PBODY;
289: }
1.88 kristaps 290:
291: return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
1.73 kristaps 292: }
293:
294:
295: static int
296: node_append(struct mdoc *mdoc, struct mdoc_node *p)
1.1 kristaps 297: {
298:
1.25 kristaps 299: assert(mdoc->last);
300: assert(mdoc->first);
301: assert(MDOC_ROOT != p->type);
1.1 kristaps 302:
1.13 kristaps 303: switch (mdoc->next) {
304: case (MDOC_NEXT_SIBLING):
1.6 kristaps 305: mdoc->last->next = p;
306: p->prev = mdoc->last;
1.13 kristaps 307: p->parent = mdoc->last->parent;
1.1 kristaps 308: break;
1.13 kristaps 309: case (MDOC_NEXT_CHILD):
310: mdoc->last->child = p;
1.1 kristaps 311: p->parent = mdoc->last;
312: break;
313: default:
1.13 kristaps 314: abort();
315: /* NOTREACHED */
1.1 kristaps 316: }
317:
1.86 kristaps 318: p->parent->nchild++;
319:
1.23 kristaps 320: if ( ! mdoc_valid_pre(mdoc, p))
321: return(0);
1.68 kristaps 322: if ( ! mdoc_action_pre(mdoc, p))
323: return(0);
1.27 kristaps 324:
325: switch (p->type) {
326: case (MDOC_HEAD):
327: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 328: p->parent->head = p;
1.27 kristaps 329: break;
330: case (MDOC_TAIL):
331: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 332: p->parent->tail = p;
1.27 kristaps 333: break;
334: case (MDOC_BODY):
335: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 336: p->parent->body = p;
1.27 kristaps 337: break;
338: default:
339: break;
340: }
341:
1.1 kristaps 342: mdoc->last = p;
1.71 kristaps 343:
344: switch (p->type) {
345: case (MDOC_TEXT):
346: if ( ! mdoc_valid_post(mdoc))
347: return(0);
348: if ( ! mdoc_action_post(mdoc))
349: return(0);
350: break;
351: default:
352: break;
353: }
354:
1.23 kristaps 355: return(1);
1.1 kristaps 356: }
357:
358:
1.45 kristaps 359: static struct mdoc_node *
1.117 kristaps 360: node_alloc(struct mdoc *m, int line, int pos,
361: enum mdoct tok, enum mdoc_type type)
1.45 kristaps 362: {
1.46 kristaps 363: struct mdoc_node *p;
364:
1.113 kristaps 365: p = mandoc_calloc(1, sizeof(struct mdoc_node));
1.91 kristaps 366: p->sec = m->lastsec;
1.73 kristaps 367: p->line = line;
368: p->pos = pos;
369: p->tok = tok;
1.118 kristaps 370: p->type = type;
1.130 kristaps 371: if (MDOC_NEWLINE & m->flags)
372: p->flags |= MDOC_LINE;
373: m->flags &= ~MDOC_NEWLINE;
1.46 kristaps 374: return(p);
1.45 kristaps 375: }
376:
377:
1.23 kristaps 378: int
1.117 kristaps 379: mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.17 kristaps 380: {
381: struct mdoc_node *p;
382:
1.91 kristaps 383: p = node_alloc(m, line, pos, tok, MDOC_TAIL);
1.102 kristaps 384: if ( ! node_append(m, p))
385: return(0);
386: m->next = MDOC_NEXT_CHILD;
387: return(1);
1.17 kristaps 388: }
389:
390:
1.23 kristaps 391: int
1.117 kristaps 392: mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1 kristaps 393: {
394: struct mdoc_node *p;
395:
1.91 kristaps 396: assert(m->first);
397: assert(m->last);
1.1 kristaps 398:
1.91 kristaps 399: p = node_alloc(m, line, pos, tok, MDOC_HEAD);
1.102 kristaps 400: if ( ! node_append(m, p))
401: return(0);
402: m->next = MDOC_NEXT_CHILD;
403: return(1);
1.1 kristaps 404: }
405:
406:
1.23 kristaps 407: int
1.117 kristaps 408: mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1 kristaps 409: {
410: struct mdoc_node *p;
411:
1.91 kristaps 412: p = node_alloc(m, line, pos, tok, MDOC_BODY);
1.102 kristaps 413: if ( ! node_append(m, p))
414: return(0);
415: m->next = MDOC_NEXT_CHILD;
416: return(1);
1.1 kristaps 417: }
418:
419:
1.23 kristaps 420: int
1.91 kristaps 421: mdoc_block_alloc(struct mdoc *m, int line, int pos,
1.117 kristaps 422: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 423: {
424: struct mdoc_node *p;
425:
1.91 kristaps 426: p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
1.77 kristaps 427: p->args = args;
428: if (p->args)
1.53 kristaps 429: (args->refcnt)++;
1.102 kristaps 430: if ( ! node_append(m, p))
431: return(0);
432: m->next = MDOC_NEXT_CHILD;
433: return(1);
1.1 kristaps 434: }
435:
436:
1.23 kristaps 437: int
1.91 kristaps 438: mdoc_elem_alloc(struct mdoc *m, int line, int pos,
1.117 kristaps 439: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 440: {
441: struct mdoc_node *p;
442:
1.91 kristaps 443: p = node_alloc(m, line, pos, tok, MDOC_ELEM);
1.77 kristaps 444: p->args = args;
445: if (p->args)
1.53 kristaps 446: (args->refcnt)++;
1.102 kristaps 447: if ( ! node_append(m, p))
448: return(0);
449: m->next = MDOC_NEXT_CHILD;
450: return(1);
1.1 kristaps 451: }
452:
453:
1.124 kristaps 454: int
455: mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
1.1 kristaps 456: {
1.91 kristaps 457: struct mdoc_node *n;
1.124 kristaps 458: size_t sv, len;
459:
460: len = strlen(p);
1.1 kristaps 461:
1.125 kristaps 462: n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
1.113 kristaps 463: n->string = mandoc_malloc(len + 1);
1.91 kristaps 464: sv = strlcpy(n->string, p, len + 1);
465:
466: /* Prohibit truncation. */
467: assert(sv < len + 1);
468:
1.101 kristaps 469: if ( ! node_append(m, n))
470: return(0);
1.124 kristaps 471:
1.101 kristaps 472: m->next = MDOC_NEXT_SIBLING;
473: return(1);
1.91 kristaps 474: }
475:
476:
1.53 kristaps 477: void
478: mdoc_node_free(struct mdoc_node *p)
1.1 kristaps 479: {
480:
1.53 kristaps 481: if (p->string)
482: free(p->string);
483: if (p->args)
484: mdoc_argv_free(p->args);
1.1 kristaps 485: free(p);
486: }
487:
488:
1.121 kristaps 489: static void
490: mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
491: {
492:
493: /* Adjust siblings. */
494:
495: if (n->prev)
496: n->prev->next = n->next;
497: if (n->next)
498: n->next->prev = n->prev;
499:
500: /* Adjust parent. */
501:
502: if (n->parent) {
503: n->parent->nchild--;
504: if (n->parent->child == n)
505: n->parent->child = n->prev ? n->prev : n->next;
506: }
507:
508: /* Adjust parse point, if applicable. */
509:
510: if (m && m->last == n) {
511: if (n->prev) {
512: m->last = n->prev;
513: m->next = MDOC_NEXT_SIBLING;
514: } else {
515: m->last = n->parent;
516: m->next = MDOC_NEXT_CHILD;
517: }
518: }
519:
520: if (m && m->first == n)
521: m->first = NULL;
522: }
523:
524:
1.53 kristaps 525: void
1.121 kristaps 526: mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
1.1 kristaps 527: {
528:
1.121 kristaps 529: while (p->child) {
530: assert(p->nchild);
531: mdoc_node_delete(m, p->child);
532: }
533: assert(0 == p->nchild);
1.1 kristaps 534:
1.121 kristaps 535: mdoc_node_unlink(m, p);
1.53 kristaps 536: mdoc_node_free(p);
1.1 kristaps 537: }
538:
539:
1.53 kristaps 540: /*
541: * Parse free-form text, that is, a line that does not begin with the
542: * control character.
543: */
544: static int
1.135 kristaps 545: mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
1.1 kristaps 546: {
1.142 kristaps 547: char *c, *ws, *end;
548: struct mdoc_node *n;
1.1 kristaps 549:
1.123 kristaps 550: /* Ignore bogus comments. */
551:
1.135 kristaps 552: if ('\\' == buf[offs] &&
553: '.' == buf[offs + 1] &&
554: '"' == buf[offs + 2])
1.136 kristaps 555: return(mdoc_pmsg(m, line, offs, MANDOCERR_BADCOMMENT));
1.123 kristaps 556:
1.124 kristaps 557: /* No text before an initial macro. */
558:
1.85 kristaps 559: if (SEC_NONE == m->lastnamed)
1.136 kristaps 560: return(mdoc_pmsg(m, line, offs, MANDOCERR_NOTEXT));
1.142 kristaps 561:
562: assert(m->last);
563: n = m->last;
564:
565: /*
1.144 kristaps 566: * Divert directly to list processing if we're encountering a
1.142 kristaps 567: * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
1.144 kristaps 568: * (a MDOC_BODY means it's already open, in which case we should
569: * process within its context in the normal way).
1.142 kristaps 570: */
571:
1.143 kristaps 572: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.146 kristaps 573: LIST_column == n->data.Bl.type) {
1.144 kristaps 574: /* `Bl' is open without any children. */
1.142 kristaps 575: m->flags |= MDOC_FREECOL;
576: return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
577: }
578:
579: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
580: NULL != n->parent &&
581: MDOC_Bl == n->parent->tok &&
1.146 kristaps 582: LIST_column == n->parent->data.Bl.type) {
1.144 kristaps 583: /* `Bl' has block-level `It' children. */
1.142 kristaps 584: m->flags |= MDOC_FREECOL;
585: return(mdoc_macro(m, MDOC_It, line, offs, &offs, buf));
586: }
1.124 kristaps 587:
1.137 schwarze 588: /*
589: * Search for the beginning of unescaped trailing whitespace (ws)
590: * and for the first character not to be output (end).
591: */
1.139 kristaps 592:
593: /* FIXME: replace with strcspn(). */
1.137 schwarze 594: ws = NULL;
595: for (c = end = buf + offs; *c; c++) {
596: switch (*c) {
1.138 kristaps 597: case '-':
598: if (mandoc_hyph(buf + offs, c))
599: *c = ASCII_HYPH;
1.145 kristaps 600: ws = NULL;
1.138 kristaps 601: break;
1.137 schwarze 602: case ' ':
603: if (NULL == ws)
604: ws = c;
605: continue;
606: case '\t':
607: /*
608: * Always warn about trailing tabs,
609: * even outside literal context,
610: * where they should be put on the next line.
611: */
612: if (NULL == ws)
613: ws = c;
614: /*
615: * Strip trailing tabs in literal context only;
616: * outside, they affect the next line.
617: */
618: if (MDOC_LITERAL & m->flags)
619: continue;
620: break;
621: case '\\':
622: /* Skip the escaped character, too, if any. */
623: if (c[1])
624: c++;
625: /* FALLTHROUGH */
626: default:
627: ws = NULL;
628: break;
629: }
630: end = c + 1;
631: }
632: *end = '\0';
1.91 kristaps 633:
1.137 schwarze 634: if (ws)
635: if ( ! mdoc_pmsg(m, line, (int)(ws-buf), MANDOCERR_EOLNSPACE))
636: return(0);
1.115 kristaps 637:
1.137 schwarze 638: if ('\0' == buf[offs] && ! (MDOC_LITERAL & m->flags)) {
639: if ( ! mdoc_pmsg(m, line, (int)(c-buf), MANDOCERR_NOBLANKLN))
1.119 kristaps 640: return(0);
1.124 kristaps 641:
1.119 kristaps 642: /*
1.124 kristaps 643: * Insert a `Pp' in the case of a blank line. Technically,
644: * blank lines aren't allowed, but enough manuals assume this
645: * behaviour that we want to work around it.
1.119 kristaps 646: */
1.135 kristaps 647: if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL))
1.119 kristaps 648: return(0);
1.124 kristaps 649:
650: m->next = MDOC_NEXT_SIBLING;
651: return(1);
1.119 kristaps 652: }
1.68 kristaps 653:
1.137 schwarze 654: if ( ! mdoc_word_alloc(m, line, offs, buf+offs))
655: return(0);
1.91 kristaps 656:
1.137 schwarze 657: if (MDOC_LITERAL & m->flags)
658: return(1);
1.128 kristaps 659:
660: /*
661: * End-of-sentence check. If the last character is an unescaped
662: * EOS character, then flag the node as being the end of a
663: * sentence. The front-end will know how to interpret this.
664: */
1.132 kristaps 665:
1.137 schwarze 666: assert(buf < end);
667:
668: if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
1.128 kristaps 669: m->last->flags |= MDOC_EOS;
670:
671: return(1);
1.1 kristaps 672: }
673:
674:
1.58 kristaps 675: static int
1.135 kristaps 676: macrowarn(struct mdoc *m, int ln, const char *buf, int offs)
1.58 kristaps 677: {
1.136 kristaps 678: int rc;
679:
680: rc = mdoc_vmsg(m, MANDOCERR_MACRO, ln, offs,
681: "unknown macro: %s%s",
682: buf, strlen(buf) > 3 ? "..." : "");
683:
684: /* FIXME: logic should be in driver. */
1.144 kristaps 685: /* FIXME: broken, will error out and not omit a message. */
1.136 kristaps 686: return(MDOC_IGN_MACRO & m->pflags ? rc : 0);
1.58 kristaps 687: }
688:
689:
1.53 kristaps 690: /*
691: * Parse a macro line, that is, a line beginning with the control
692: * character.
693: */
694: int
1.135 kristaps 695: mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
1.1 kristaps 696: {
1.144 kristaps 697: enum mdoct tok;
698: int i, j, sv;
699: char mac[5];
700: struct mdoc_node *n;
1.1 kristaps 701:
1.81 kristaps 702: /* Empty lines are ignored. */
1.63 kristaps 703:
1.135 kristaps 704: offs++;
705:
706: if ('\0' == buf[offs])
1.63 kristaps 707: return(1);
708:
1.135 kristaps 709: i = offs;
1.100 kristaps 710:
711: /* Accept whitespace after the initial control char. */
712:
713: if (' ' == buf[i]) {
714: i++;
1.65 kristaps 715: while (buf[i] && ' ' == buf[i])
1.63 kristaps 716: i++;
1.115 kristaps 717: if ('\0' == buf[i])
1.63 kristaps 718: return(1);
719: }
1.1 kristaps 720:
1.130 kristaps 721: sv = i;
722:
1.53 kristaps 723: /* Copy the first word into a nil-terminated buffer. */
1.1 kristaps 724:
1.100 kristaps 725: for (j = 0; j < 4; j++, i++) {
1.115 kristaps 726: if ('\0' == (mac[j] = buf[i]))
1.53 kristaps 727: break;
1.65 kristaps 728: else if (' ' == buf[i])
1.53 kristaps 729: break;
1.104 kristaps 730:
731: /* Check for invalid characters. */
732:
733: if (isgraph((u_char)buf[i]))
734: continue;
1.136 kristaps 735: if ( ! mdoc_pmsg(m, ln, i, MANDOCERR_BADCHAR))
736: return(0);
737: i--;
1.53 kristaps 738: }
1.1 kristaps 739:
1.135 kristaps 740: mac[j] = '\0';
1.1 kristaps 741:
1.100 kristaps 742: if (j == 4 || j < 2) {
1.135 kristaps 743: if ( ! macrowarn(m, ln, mac, sv))
1.58 kristaps 744: goto err;
745: return(1);
1.53 kristaps 746: }
747:
1.125 kristaps 748: if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
1.135 kristaps 749: if ( ! macrowarn(m, ln, mac, sv))
1.58 kristaps 750: goto err;
751: return(1);
1.53 kristaps 752: }
1.1 kristaps 753:
1.53 kristaps 754: /* The macro is sane. Jump to the next word. */
1.1 kristaps 755:
1.65 kristaps 756: while (buf[i] && ' ' == buf[i])
1.53 kristaps 757: i++;
1.1 kristaps 758:
1.125 kristaps 759: /*
760: * Trailing whitespace. Note that tabs are allowed to be passed
761: * into the parser as "text", so we only warn about spaces here.
762: */
1.115 kristaps 763:
764: if ('\0' == buf[i] && ' ' == buf[i - 1])
1.136 kristaps 765: if ( ! mdoc_pmsg(m, ln, i - 1, MANDOCERR_EOLNSPACE))
1.115 kristaps 766: goto err;
767:
1.144 kristaps 768: /*
769: * If an initial macro or a list invocation, divert directly
770: * into macro processing.
771: */
772:
773: if (NULL == m->last || MDOC_It == tok || MDOC_El == tok) {
774: if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
775: goto err;
776: return(1);
777: }
778:
779: n = m->last;
780: assert(m->last);
781:
782: /*
783: * If the first macro of a `Bl -column', open an `It' block
784: * context around the parsed macro.
785: */
786:
787: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.146 kristaps 788: LIST_column == n->data.Bl.type) {
1.144 kristaps 789: m->flags |= MDOC_FREECOL;
790: if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
791: goto err;
792: return(1);
793: }
794:
795: /*
796: * If we're following a block-level `It' within a `Bl -column'
797: * context (perhaps opened in the above block or in ptext()),
798: * then open an `It' block context around the parsed macro.
1.98 kristaps 799: */
1.144 kristaps 800:
801: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
802: NULL != n->parent &&
803: MDOC_Bl == n->parent->tok &&
1.146 kristaps 804: LIST_column == n->parent->data.Bl.type) {
1.144 kristaps 805: m->flags |= MDOC_FREECOL;
806: if ( ! mdoc_macro(m, MDOC_It, ln, sv, &sv, buf))
807: goto err;
808: return(1);
809: }
810:
811: /* Normal processing of a macro. */
812:
1.130 kristaps 813: if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
1.53 kristaps 814: goto err;
1.1 kristaps 815:
1.53 kristaps 816: return(1);
1.1 kristaps 817:
1.53 kristaps 818: err: /* Error out. */
1.1 kristaps 819:
1.53 kristaps 820: m->flags |= MDOC_HALT;
821: return(0);
1.1 kristaps 822: }
1.100 kristaps 823:
824:
CVSweb