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