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