Annotation of src/usr.bin/mandoc/mdoc.c, Revision 1.113
1.113 ! schwarze 1: /* $Id: mdoc.c,v 1.112 2014/08/08 15:54:10 schwarze Exp $ */
1.1 kristaps 2: /*
1.77 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.98 schwarze 4: * Copyright (c) 2010, 2012, 2013, 2014 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>
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.83 schwarze 28: #include "mdoc.h"
1.54 schwarze 29: #include "mandoc.h"
1.99 schwarze 30: #include "mandoc_aux.h"
1.1 kristaps 31: #include "libmdoc.h"
1.32 schwarze 32: #include "libmandoc.h"
1.1 kristaps 33:
1.106 schwarze 34: const char *const __mdoc_macronames[MDOC_MAX + 1] = {
1.7 schwarze 35: "Ap", "Dd", "Dt", "Os",
1.1 kristaps 36: "Sh", "Ss", "Pp", "D1",
37: "Dl", "Bd", "Ed", "Bl",
38: "El", "It", "Ad", "An",
39: "Ar", "Cd", "Cm", "Dv",
40: "Er", "Ev", "Ex", "Fa",
41: "Fd", "Fl", "Fn", "Ft",
42: "Ic", "In", "Li", "Nd",
43: "Nm", "Op", "Ot", "Pa",
44: "Rv", "St", "Va", "Vt",
1.33 schwarze 45: "Xr", "%A", "%B", "%D",
46: "%I", "%J", "%N", "%O",
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.33 schwarze 63: "Brc", "%C", "Es", "En",
64: "Dx", "%Q", "br", "sp",
1.106 schwarze 65: "%U", "Ta", "ll", "text",
1.1 kristaps 66: };
67:
1.103 schwarze 68: const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
1.1 kristaps 69: "split", "nosplit", "ragged",
1.103 schwarze 70: "unfilled", "literal", "file",
71: "offset", "bullet", "dash",
72: "hyphen", "item", "enum",
73: "tag", "diag", "hang",
74: "ohang", "inset", "column",
75: "width", "compact", "std",
1.1 kristaps 76: "filled", "words", "emphasis",
1.30 schwarze 77: "symbolic", "nested", "centered"
1.1 kristaps 78: };
79:
80: const char * const *mdoc_macronames = __mdoc_macronames;
81: const char * const *mdoc_argnames = __mdoc_argnames;
82:
1.40 schwarze 83: static void mdoc_node_free(struct mdoc_node *);
1.103 schwarze 84: static void mdoc_node_unlink(struct mdoc *,
1.40 schwarze 85: struct mdoc_node *);
1.1 kristaps 86: static void mdoc_free1(struct mdoc *);
1.32 schwarze 87: static void mdoc_alloc1(struct mdoc *);
1.103 schwarze 88: static struct mdoc_node *node_alloc(struct mdoc *, int, int,
1.37 schwarze 89: enum mdoct, enum mdoc_type);
1.103 schwarze 90: static int node_append(struct mdoc *,
1.1 kristaps 91: struct mdoc_node *);
1.84 schwarze 92: #if 0
93: static int mdoc_preptext(struct mdoc *, int, char *, int);
94: #endif
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:
1.103 schwarze 98:
1.1 kristaps 99: const struct mdoc_node *
1.93 schwarze 100: mdoc_node(const struct mdoc *mdoc)
1.1 kristaps 101: {
102:
1.93 schwarze 103: return(mdoc->first);
1.1 kristaps 104: }
105:
106: const struct mdoc_meta *
1.93 schwarze 107: mdoc_meta(const struct mdoc *mdoc)
1.1 kristaps 108: {
109:
1.93 schwarze 110: return(&mdoc->meta);
1.1 kristaps 111: }
112:
1.8 schwarze 113: /*
114: * Frees volatile resources (parse tree, meta-data, fields).
115: */
1.1 kristaps 116: static void
117: mdoc_free1(struct mdoc *mdoc)
118: {
119:
120: if (mdoc->first)
1.40 schwarze 121: mdoc_node_delete(mdoc, mdoc->first);
1.113 ! schwarze 122: free(mdoc->meta.msec);
! 123: free(mdoc->meta.vol);
! 124: free(mdoc->meta.arch);
! 125: free(mdoc->meta.date);
! 126: free(mdoc->meta.title);
! 127: free(mdoc->meta.os);
! 128: free(mdoc->meta.name);
1.1 kristaps 129: }
130:
1.8 schwarze 131: /*
132: * Allocate all volatile resources (parse tree, meta-data, fields).
133: */
1.32 schwarze 134: static void
1.1 kristaps 135: mdoc_alloc1(struct mdoc *mdoc)
136: {
137:
1.32 schwarze 138: memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
1.1 kristaps 139: mdoc->flags = 0;
1.9 schwarze 140: mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.32 schwarze 141: mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
1.1 kristaps 142: mdoc->first = mdoc->last;
143: mdoc->last->type = MDOC_ROOT;
1.86 schwarze 144: mdoc->last->tok = MDOC_MAX;
1.1 kristaps 145: mdoc->next = MDOC_NEXT_CHILD;
146: }
147:
148: /*
1.8 schwarze 149: * Free up volatile resources (see mdoc_free1()) then re-initialises the
150: * data with mdoc_alloc1(). After invocation, parse data has been reset
151: * and the parser is ready for re-invocation on a new tree; however,
152: * cross-parse non-volatile data is kept intact.
1.1 kristaps 153: */
1.32 schwarze 154: void
1.1 kristaps 155: mdoc_reset(struct mdoc *mdoc)
156: {
157:
158: mdoc_free1(mdoc);
1.32 schwarze 159: mdoc_alloc1(mdoc);
1.1 kristaps 160: }
161:
162: /*
1.8 schwarze 163: * Completely free up all volatile and non-volatile parse resources.
164: * After invocation, the pointer is no longer usable.
1.1 kristaps 165: */
166: void
167: mdoc_free(struct mdoc *mdoc)
168: {
169:
170: mdoc_free1(mdoc);
171: free(mdoc);
172: }
173:
1.8 schwarze 174: /*
1.103 schwarze 175: * Allocate volatile and non-volatile parse resources.
1.8 schwarze 176: */
1.1 kristaps 177: struct mdoc *
1.98 schwarze 178: mdoc_alloc(struct roff *roff, struct mparse *parse,
1.110 schwarze 179: const char *defos, int quick)
1.1 kristaps 180: {
181: struct mdoc *p;
182:
1.32 schwarze 183: p = mandoc_calloc(1, sizeof(struct mdoc));
184:
1.83 schwarze 185: p->parse = parse;
1.87 schwarze 186: p->defos = defos;
1.98 schwarze 187: p->quick = quick;
1.84 schwarze 188: p->roff = roff;
1.1 kristaps 189:
1.32 schwarze 190: mdoc_hash_init();
191: mdoc_alloc1(p);
192: return(p);
1.1 kristaps 193: }
194:
195: int
1.93 schwarze 196: mdoc_endparse(struct mdoc *mdoc)
1.1 kristaps 197: {
198:
1.111 schwarze 199: return(mdoc_macroend(mdoc));
1.81 schwarze 200: }
201:
202: int
1.93 schwarze 203: mdoc_addeqn(struct mdoc *mdoc, const struct eqn *ep)
1.81 schwarze 204: {
205: struct mdoc_node *n;
206:
1.93 schwarze 207: n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, MDOC_EQN);
1.81 schwarze 208: n->eqn = ep;
209:
1.93 schwarze 210: if ( ! node_append(mdoc, n))
1.81 schwarze 211: return(0);
212:
1.93 schwarze 213: mdoc->next = MDOC_NEXT_SIBLING;
1.81 schwarze 214: return(1);
1.1 kristaps 215: }
216:
1.77 schwarze 217: int
1.93 schwarze 218: mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)
1.77 schwarze 219: {
1.79 schwarze 220: struct mdoc_node *n;
1.77 schwarze 221:
1.93 schwarze 222: n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL);
1.79 schwarze 223: n->span = sp;
224:
1.93 schwarze 225: if ( ! node_append(mdoc, n))
1.79 schwarze 226: return(0);
227:
1.93 schwarze 228: mdoc->next = MDOC_NEXT_SIBLING;
1.79 schwarze 229: return(1);
1.77 schwarze 230: }
231:
1.1 kristaps 232: /*
233: * Main parse routine. Parses a single line -- really just hands off to
1.45 schwarze 234: * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
1.1 kristaps 235: */
236: int
1.93 schwarze 237: mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)
1.1 kristaps 238: {
239:
1.93 schwarze 240: mdoc->flags |= MDOC_NEWLINE;
1.60 schwarze 241:
242: /*
243: * Let the roff nS register switch SYNOPSIS mode early,
244: * such that the parser knows at all times
245: * whether this mode is on or off.
246: * Note that this mode is also switched by the Sh macro.
247: */
1.94 schwarze 248: if (roff_getreg(mdoc->roff, "nS"))
249: mdoc->flags |= MDOC_SYNOPSIS;
250: else
251: mdoc->flags &= ~MDOC_SYNOPSIS;
1.60 schwarze 252:
1.93 schwarze 253: return(roff_getcontrol(mdoc->roff, buf, &offs) ?
1.103 schwarze 254: mdoc_pmacro(mdoc, ln, buf, offs) :
255: mdoc_ptext(mdoc, ln, buf, offs));
1.1 kristaps 256: }
257:
1.5 schwarze 258: int
1.58 schwarze 259: mdoc_macro(MACRO_PROT_ARGS)
1.1 kristaps 260: {
1.46 schwarze 261: assert(tok < MDOC_MAX);
262:
1.113 ! schwarze 263: if (mdoc->flags & MDOC_PBODY) {
! 264: if (tok == MDOC_Dt) {
! 265: mandoc_vmsg(MANDOCERR_DT_LATE,
! 266: mdoc->parse, line, ppos,
! 267: "Dt %s", buf + *pos);
! 268: return(1);
! 269: }
! 270: } else if ( ! (mdoc_macros[tok].flags & MDOC_PROLOGUE)) {
! 271: if (mdoc->meta.title == NULL) {
! 272: mandoc_vmsg(MANDOCERR_DT_NOTITLE,
! 273: mdoc->parse, line, ppos, "%s %s",
! 274: mdoc_macronames[tok], buf + *pos);
! 275: mdoc->meta.title = mandoc_strdup("UNTITLED");
! 276: }
1.93 schwarze 277: if (NULL == mdoc->meta.vol)
278: mdoc->meta.vol = mandoc_strdup("LOCAL");
279: mdoc->flags |= MDOC_PBODY;
1.39 schwarze 280: }
1.1 kristaps 281:
1.93 schwarze 282: return((*mdoc_macros[tok].fp)(mdoc, tok, line, ppos, pos, buf));
1.1 kristaps 283: }
284:
285:
286: static int
287: node_append(struct mdoc *mdoc, struct mdoc_node *p)
288: {
289:
290: assert(mdoc->last);
291: assert(mdoc->first);
292: assert(MDOC_ROOT != p->type);
293:
294: switch (mdoc->next) {
1.103 schwarze 295: case MDOC_NEXT_SIBLING:
1.1 kristaps 296: mdoc->last->next = p;
297: p->prev = mdoc->last;
298: p->parent = mdoc->last->parent;
299: break;
1.103 schwarze 300: case MDOC_NEXT_CHILD:
1.1 kristaps 301: mdoc->last->child = p;
302: p->parent = mdoc->last;
303: break;
304: default:
305: abort();
306: /* NOTREACHED */
307: }
308:
1.10 schwarze 309: p->parent->nchild++;
310:
1.75 schwarze 311: /*
312: * Copy over the normalised-data pointer of our parent. Not
313: * everybody has one, but copying a null pointer is fine.
314: */
315:
316: switch (p->type) {
1.103 schwarze 317: case MDOC_BODY:
1.92 schwarze 318: if (ENDBODY_NOT != p->end)
319: break;
1.75 schwarze 320: /* FALLTHROUGH */
1.103 schwarze 321: case MDOC_TAIL:
1.75 schwarze 322: /* FALLTHROUGH */
1.103 schwarze 323: case MDOC_HEAD:
1.75 schwarze 324: p->norm = p->parent->norm;
325: break;
326: default:
327: break;
328: }
329:
1.1 kristaps 330: if ( ! mdoc_valid_pre(mdoc, p))
331: return(0);
332:
333: switch (p->type) {
1.103 schwarze 334: case MDOC_HEAD:
1.1 kristaps 335: assert(MDOC_BLOCK == p->parent->type);
336: p->parent->head = p;
337: break;
1.103 schwarze 338: case MDOC_TAIL:
1.1 kristaps 339: assert(MDOC_BLOCK == p->parent->type);
340: p->parent->tail = p;
341: break;
1.103 schwarze 342: case MDOC_BODY:
1.59 schwarze 343: if (p->end)
344: break;
1.1 kristaps 345: assert(MDOC_BLOCK == p->parent->type);
346: p->parent->body = p;
347: break;
348: default:
349: break;
350: }
351:
352: mdoc->last = p;
353:
354: switch (p->type) {
1.103 schwarze 355: case MDOC_TBL:
1.77 schwarze 356: /* FALLTHROUGH */
1.103 schwarze 357: case MDOC_TEXT:
1.1 kristaps 358: if ( ! mdoc_valid_post(mdoc))
359: return(0);
360: break;
361: default:
362: break;
363: }
364:
365: return(1);
366: }
367:
368: static struct mdoc_node *
1.103 schwarze 369: node_alloc(struct mdoc *mdoc, int line, int pos,
1.37 schwarze 370: enum mdoct tok, enum mdoc_type type)
1.1 kristaps 371: {
372: struct mdoc_node *p;
373:
1.32 schwarze 374: p = mandoc_calloc(1, sizeof(struct mdoc_node));
1.93 schwarze 375: p->sec = mdoc->lastsec;
1.1 kristaps 376: p->line = line;
377: p->pos = pos;
1.96 schwarze 378: p->lastline = line;
1.1 kristaps 379: p->tok = tok;
1.37 schwarze 380: p->type = type;
1.58 schwarze 381:
382: /* Flag analysis. */
383:
1.93 schwarze 384: if (MDOC_SYNOPSIS & mdoc->flags)
1.60 schwarze 385: p->flags |= MDOC_SYNPRETTY;
386: else
387: p->flags &= ~MDOC_SYNPRETTY;
1.93 schwarze 388: if (MDOC_NEWLINE & mdoc->flags)
1.47 schwarze 389: p->flags |= MDOC_LINE;
1.93 schwarze 390: mdoc->flags &= ~MDOC_NEWLINE;
1.58 schwarze 391:
1.1 kristaps 392: return(p);
393: }
394:
395: int
1.93 schwarze 396: mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.1 kristaps 397: {
398: struct mdoc_node *p;
399:
1.93 schwarze 400: p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
401: if ( ! node_append(mdoc, p))
1.25 schwarze 402: return(0);
1.93 schwarze 403: mdoc->next = MDOC_NEXT_CHILD;
1.25 schwarze 404: return(1);
1.1 kristaps 405: }
406:
407: int
1.93 schwarze 408: mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.1 kristaps 409: {
410: struct mdoc_node *p;
411:
1.93 schwarze 412: assert(mdoc->first);
413: assert(mdoc->last);
1.1 kristaps 414:
1.93 schwarze 415: p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
416: if ( ! node_append(mdoc, p))
1.25 schwarze 417: return(0);
1.93 schwarze 418: mdoc->next = MDOC_NEXT_CHILD;
1.25 schwarze 419: return(1);
1.1 kristaps 420: }
421:
422: int
1.93 schwarze 423: mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.1 kristaps 424: {
425: struct mdoc_node *p;
426:
1.93 schwarze 427: p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
428: if ( ! node_append(mdoc, p))
1.25 schwarze 429: return(0);
1.93 schwarze 430: mdoc->next = MDOC_NEXT_CHILD;
1.59 schwarze 431: return(1);
432: }
433:
434: int
1.93 schwarze 435: mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok,
1.59 schwarze 436: struct mdoc_node *body, enum mdoc_endbody end)
437: {
438: struct mdoc_node *p;
439:
1.93 schwarze 440: p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
1.59 schwarze 441: p->pending = body;
1.92 schwarze 442: p->norm = body->norm;
1.59 schwarze 443: p->end = end;
1.93 schwarze 444: if ( ! node_append(mdoc, p))
1.59 schwarze 445: return(0);
1.93 schwarze 446: mdoc->next = MDOC_NEXT_SIBLING;
1.25 schwarze 447: return(1);
1.1 kristaps 448: }
449:
450: int
1.103 schwarze 451: mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
1.37 schwarze 452: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 453: {
454: struct mdoc_node *p;
455:
1.93 schwarze 456: p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
1.4 schwarze 457: p->args = args;
458: if (p->args)
1.1 kristaps 459: (args->refcnt)++;
1.75 schwarze 460:
461: switch (tok) {
1.103 schwarze 462: case MDOC_Bd:
1.75 schwarze 463: /* FALLTHROUGH */
1.103 schwarze 464: case MDOC_Bf:
1.75 schwarze 465: /* FALLTHROUGH */
1.103 schwarze 466: case MDOC_Bl:
1.107 schwarze 467: /* FALLTHROUGH */
468: case MDOC_En:
1.75 schwarze 469: /* FALLTHROUGH */
1.103 schwarze 470: case MDOC_Rs:
1.75 schwarze 471: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
472: break;
473: default:
474: break;
475: }
476:
1.93 schwarze 477: if ( ! node_append(mdoc, p))
1.25 schwarze 478: return(0);
1.93 schwarze 479: mdoc->next = MDOC_NEXT_CHILD;
1.25 schwarze 480: return(1);
1.1 kristaps 481: }
482:
483: int
1.103 schwarze 484: mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
1.37 schwarze 485: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 486: {
487: struct mdoc_node *p;
488:
1.93 schwarze 489: p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
1.4 schwarze 490: p->args = args;
491: if (p->args)
1.1 kristaps 492: (args->refcnt)++;
1.75 schwarze 493:
494: switch (tok) {
1.103 schwarze 495: case MDOC_An:
1.75 schwarze 496: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
497: break;
498: default:
499: break;
500: }
501:
1.93 schwarze 502: if ( ! node_append(mdoc, p))
1.25 schwarze 503: return(0);
1.93 schwarze 504: mdoc->next = MDOC_NEXT_CHILD;
1.25 schwarze 505: return(1);
1.1 kristaps 506: }
507:
1.46 schwarze 508: int
1.93 schwarze 509: mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
1.1 kristaps 510: {
1.19 schwarze 511: struct mdoc_node *n;
1.1 kristaps 512:
1.93 schwarze 513: n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT);
514: n->string = roff_strdup(mdoc->roff, p);
1.19 schwarze 515:
1.93 schwarze 516: if ( ! node_append(mdoc, n))
1.25 schwarze 517: return(0);
1.46 schwarze 518:
1.93 schwarze 519: mdoc->next = MDOC_NEXT_SIBLING;
1.25 schwarze 520: return(1);
1.19 schwarze 521: }
522:
1.95 schwarze 523: void
524: mdoc_word_append(struct mdoc *mdoc, const char *p)
525: {
526: struct mdoc_node *n;
527: char *addstr, *newstr;
528:
529: n = mdoc->last;
530: addstr = roff_strdup(mdoc->roff, p);
1.100 schwarze 531: mandoc_asprintf(&newstr, "%s %s", n->string, addstr);
1.95 schwarze 532: free(addstr);
533: free(n->string);
534: n->string = newstr;
535: mdoc->next = MDOC_NEXT_SIBLING;
536: }
1.19 schwarze 537:
1.61 schwarze 538: static void
1.1 kristaps 539: mdoc_node_free(struct mdoc_node *p)
540: {
1.61 schwarze 541:
1.75 schwarze 542: if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
543: free(p->norm);
1.1 kristaps 544: if (p->string)
545: free(p->string);
546: if (p->args)
547: mdoc_argv_free(p->args);
548: free(p);
549: }
550:
1.40 schwarze 551: static void
1.93 schwarze 552: mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n)
1.40 schwarze 553: {
554:
555: /* Adjust siblings. */
556:
557: if (n->prev)
558: n->prev->next = n->next;
559: if (n->next)
560: n->next->prev = n->prev;
561:
562: /* Adjust parent. */
563:
564: if (n->parent) {
565: n->parent->nchild--;
566: if (n->parent->child == n)
567: n->parent->child = n->prev ? n->prev : n->next;
1.72 schwarze 568: if (n->parent->last == n)
569: n->parent->last = n->prev ? n->prev : NULL;
1.40 schwarze 570: }
571:
572: /* Adjust parse point, if applicable. */
573:
1.93 schwarze 574: if (mdoc && mdoc->last == n) {
1.40 schwarze 575: if (n->prev) {
1.93 schwarze 576: mdoc->last = n->prev;
577: mdoc->next = MDOC_NEXT_SIBLING;
1.40 schwarze 578: } else {
1.93 schwarze 579: mdoc->last = n->parent;
580: mdoc->next = MDOC_NEXT_CHILD;
1.40 schwarze 581: }
582: }
583:
1.93 schwarze 584: if (mdoc && mdoc->first == n)
585: mdoc->first = NULL;
1.40 schwarze 586: }
587:
1.1 kristaps 588: void
1.93 schwarze 589: mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p)
1.1 kristaps 590: {
591:
1.40 schwarze 592: while (p->child) {
593: assert(p->nchild);
1.93 schwarze 594: mdoc_node_delete(mdoc, p->child);
1.40 schwarze 595: }
596: assert(0 == p->nchild);
1.1 kristaps 597:
1.93 schwarze 598: mdoc_node_unlink(mdoc, p);
1.1 kristaps 599: mdoc_node_free(p);
1.91 schwarze 600: }
601:
602: int
1.93 schwarze 603: mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
1.91 schwarze 604: {
605:
1.93 schwarze 606: mdoc_node_unlink(mdoc, p);
607: return(node_append(mdoc, p));
1.1 kristaps 608: }
609:
1.84 schwarze 610: #if 0
611: /*
612: * Pre-treat a text line.
613: * Text lines can consist of equations, which must be handled apart from
614: * the regular text.
615: * Thus, use this function to step through a line checking if it has any
616: * equations embedded in it.
617: * This must handle multiple equations AND equations that do not end at
618: * the end-of-line, i.e., will re-enter in the next roff parse.
619: */
620: static int
1.93 schwarze 621: mdoc_preptext(struct mdoc *mdoc, int line, char *buf, int offs)
1.84 schwarze 622: {
623: char *start, *end;
624: char delim;
625:
626: while ('\0' != buf[offs]) {
627: /* Mark starting position if eqn is set. */
628: start = NULL;
1.93 schwarze 629: if ('\0' != (delim = roff_eqndelim(mdoc->roff)))
1.84 schwarze 630: if (NULL != (start = strchr(buf + offs, delim)))
631: *start++ = '\0';
632:
633: /* Parse text as normal. */
1.93 schwarze 634: if ( ! mdoc_ptext(mdoc, line, buf, offs))
1.84 schwarze 635: return(0);
636:
637: /* Continue only if an equation exists. */
638: if (NULL == start)
639: break;
640:
641: /* Read past the end of the equation. */
642: offs += start - (buf + offs);
643: assert(start == &buf[offs]);
644: if (NULL != (end = strchr(buf + offs, delim))) {
645: *end++ = '\0';
646: while (' ' == *end)
647: end++;
648: }
649:
650: /* Parse the equation itself. */
1.93 schwarze 651: roff_openeqn(mdoc->roff, NULL, line, offs, buf);
1.84 schwarze 652:
653: /* Process a finished equation? */
1.93 schwarze 654: if (roff_closeeqn(mdoc->roff))
655: if ( ! mdoc_addeqn(mdoc, roff_eqn(mdoc->roff)))
1.84 schwarze 656: return(0);
657: offs += (end - (buf + offs));
1.103 schwarze 658: }
1.84 schwarze 659:
660: return(1);
661: }
662: #endif
1.1 kristaps 663:
664: /*
665: * Parse free-form text, that is, a line that does not begin with the
666: * control character.
667: */
668: static int
1.93 schwarze 669: mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
1.1 kristaps 670: {
1.56 schwarze 671: char *c, *ws, *end;
672: struct mdoc_node *n;
1.46 schwarze 673:
1.93 schwarze 674: assert(mdoc->last);
675: n = mdoc->last;
1.56 schwarze 676:
677: /*
678: * Divert directly to list processing if we're encountering a
679: * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
680: * (a MDOC_BODY means it's already open, in which case we should
681: * process within its context in the normal way).
682: */
683:
684: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.103 schwarze 685: LIST_column == n->norm->Bl.type) {
1.56 schwarze 686: /* `Bl' is open without any children. */
1.93 schwarze 687: mdoc->flags |= MDOC_FREECOL;
688: return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
1.56 schwarze 689: }
690:
691: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
1.103 schwarze 692: NULL != n->parent &&
693: MDOC_Bl == n->parent->tok &&
694: LIST_column == n->parent->norm->Bl.type) {
1.56 schwarze 695: /* `Bl' has block-level `It' children. */
1.93 schwarze 696: mdoc->flags |= MDOC_FREECOL;
697: return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
1.56 schwarze 698: }
699:
1.52 schwarze 700: /*
701: * Search for the beginning of unescaped trailing whitespace (ws)
702: * and for the first character not to be output (end).
703: */
1.56 schwarze 704:
705: /* FIXME: replace with strcspn(). */
1.52 schwarze 706: ws = NULL;
1.53 schwarze 707: for (c = end = buf + offs; *c; c++) {
1.52 schwarze 708: switch (*c) {
709: case ' ':
710: if (NULL == ws)
711: ws = c;
712: continue;
713: case '\t':
714: /*
715: * Always warn about trailing tabs,
716: * even outside literal context,
717: * where they should be put on the next line.
718: */
719: if (NULL == ws)
720: ws = c;
721: /*
722: * Strip trailing tabs in literal context only;
723: * outside, they affect the next line.
724: */
1.93 schwarze 725: if (MDOC_LITERAL & mdoc->flags)
1.52 schwarze 726: continue;
727: break;
728: case '\\':
729: /* Skip the escaped character, too, if any. */
730: if (c[1])
731: c++;
732: /* FALLTHROUGH */
733: default:
734: ws = NULL;
735: break;
736: }
737: end = c + 1;
738: }
739: *end = '\0';
1.19 schwarze 740:
1.52 schwarze 741: if (ws)
1.108 schwarze 742: mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
743: line, (int)(ws-buf), NULL);
1.34 schwarze 744:
1.93 schwarze 745: if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) {
1.108 schwarze 746: mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
747: line, (int)(c - buf), NULL);
1.46 schwarze 748:
1.40 schwarze 749: /*
1.66 schwarze 750: * Insert a `sp' in the case of a blank line. Technically,
1.46 schwarze 751: * blank lines aren't allowed, but enough manuals assume this
752: * behaviour that we want to work around it.
1.40 schwarze 753: */
1.93 schwarze 754: if ( ! mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL))
1.42 schwarze 755: return(0);
1.46 schwarze 756:
1.93 schwarze 757: mdoc->next = MDOC_NEXT_SIBLING;
1.89 schwarze 758:
1.93 schwarze 759: return(mdoc_valid_post(mdoc));
1.38 schwarze 760: }
1.1 kristaps 761:
1.93 schwarze 762: if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs))
1.1 kristaps 763: return(0);
764:
1.93 schwarze 765: if (MDOC_LITERAL & mdoc->flags)
1.52 schwarze 766: return(1);
767:
1.35 schwarze 768: /*
1.48 schwarze 769: * End-of-sentence check. If the last character is an unescaped
770: * EOS character, then flag the node as being the end of a
771: * sentence. The front-end will know how to interpret this.
1.35 schwarze 772: */
773:
1.52 schwarze 774: assert(buf < end);
1.48 schwarze 775:
1.97 schwarze 776: if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
1.93 schwarze 777: mdoc->last->flags |= MDOC_EOS;
1.48 schwarze 778:
1.1 kristaps 779: return(1);
780: }
1.19 schwarze 781:
1.1 kristaps 782: /*
783: * Parse a macro line, that is, a line beginning with the control
784: * character.
785: */
1.61 schwarze 786: static int
1.93 schwarze 787: mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
1.1 kristaps 788: {
1.56 schwarze 789: enum mdoct tok;
1.83 schwarze 790: int i, sv;
1.56 schwarze 791: char mac[5];
792: struct mdoc_node *n;
1.1 kristaps 793:
1.83 schwarze 794: /* Empty post-control lines are ignored. */
1.1 kristaps 795:
1.83 schwarze 796: if ('"' == buf[offs]) {
1.108 schwarze 797: mandoc_msg(MANDOCERR_COMMENT_BAD, mdoc->parse,
798: ln, offs, NULL);
1.83 schwarze 799: return(1);
800: } else if ('\0' == buf[offs])
1.1 kristaps 801: return(1);
802:
1.83 schwarze 803: sv = offs;
1.47 schwarze 804:
1.103 schwarze 805: /*
1.64 schwarze 806: * Copy the first word into a nil-terminated buffer.
807: * Stop copying when a tab, space, or eoln is encountered.
1.63 schwarze 808: */
1.1 kristaps 809:
1.83 schwarze 810: i = 0;
1.103 schwarze 811: while (i < 4 && '\0' != buf[offs] && ' ' != buf[offs] &&
812: '\t' != buf[offs])
1.83 schwarze 813: mac[i++] = buf[offs++];
814:
815: mac[i] = '\0';
816:
1.104 schwarze 817: tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
1.1 kristaps 818:
1.65 schwarze 819: if (MDOC_MAX == tok) {
1.112 schwarze 820: mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
821: ln, sv, buf + sv - 1);
1.1 kristaps 822: return(1);
823: }
824:
1.63 schwarze 825: /* Disregard the first trailing tab, if applicable. */
826:
1.83 schwarze 827: if ('\t' == buf[offs])
828: offs++;
1.63 schwarze 829:
830: /* Jump to the next non-whitespace word. */
1.1 kristaps 831:
1.83 schwarze 832: while (buf[offs] && ' ' == buf[offs])
833: offs++;
1.34 schwarze 834:
1.103 schwarze 835: /*
1.46 schwarze 836: * Trailing whitespace. Note that tabs are allowed to be passed
837: * into the parser as "text", so we only warn about spaces here.
838: */
1.34 schwarze 839:
1.83 schwarze 840: if ('\0' == buf[offs] && ' ' == buf[offs - 1])
1.108 schwarze 841: mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
842: ln, offs - 1, NULL);
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:
1.111 schwarze 849: if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok)
850: return(mdoc_macro(mdoc, tok, ln, sv, &offs, buf));
1.56 schwarze 851:
1.93 schwarze 852: n = mdoc->last;
853: assert(mdoc->last);
1.56 schwarze 854:
855: /*
856: * If the first macro of a `Bl -column', open an `It' block
857: * context around the parsed macro.
858: */
859:
860: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.103 schwarze 861: LIST_column == n->norm->Bl.type) {
1.93 schwarze 862: mdoc->flags |= MDOC_FREECOL;
1.111 schwarze 863: return(mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf));
1.56 schwarze 864: }
865:
866: /*
867: * If we're following a block-level `It' within a `Bl -column'
868: * context (perhaps opened in the above block or in ptext()),
869: * then open an `It' block context around the parsed macro.
1.24 schwarze 870: */
1.56 schwarze 871:
872: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
1.103 schwarze 873: NULL != n->parent &&
874: MDOC_Bl == n->parent->tok &&
875: LIST_column == n->parent->norm->Bl.type) {
1.93 schwarze 876: mdoc->flags |= MDOC_FREECOL;
1.111 schwarze 877: return(mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf));
1.56 schwarze 878: }
879:
880: /* Normal processing of a macro. */
881:
1.103 schwarze 882: if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
1.111 schwarze 883: return(0);
1.98 schwarze 884:
885: /* In quick mode (for mandocdb), abort after the NAME section. */
886:
887: if (mdoc->quick && MDOC_Sh == tok &&
888: SEC_NAME != mdoc->last->sec)
889: return(2);
1.1 kristaps 890:
891: return(1);
892: }
1.24 schwarze 893:
1.83 schwarze 894: enum mdelim
895: mdoc_isdelim(const char *p)
896: {
897:
898: if ('\0' == p[0])
899: return(DELIM_NONE);
900:
901: if ('\0' == p[1])
902: switch (p[0]) {
1.103 schwarze 903: case '(':
1.83 schwarze 904: /* FALLTHROUGH */
1.103 schwarze 905: case '[':
1.83 schwarze 906: return(DELIM_OPEN);
1.103 schwarze 907: case '|':
1.83 schwarze 908: return(DELIM_MIDDLE);
1.103 schwarze 909: case '.':
1.83 schwarze 910: /* FALLTHROUGH */
1.103 schwarze 911: case ',':
1.83 schwarze 912: /* FALLTHROUGH */
1.103 schwarze 913: case ';':
1.83 schwarze 914: /* FALLTHROUGH */
1.103 schwarze 915: case ':':
1.83 schwarze 916: /* FALLTHROUGH */
1.103 schwarze 917: case '?':
1.83 schwarze 918: /* FALLTHROUGH */
1.103 schwarze 919: case '!':
1.83 schwarze 920: /* FALLTHROUGH */
1.103 schwarze 921: case ')':
1.83 schwarze 922: /* FALLTHROUGH */
1.103 schwarze 923: case ']':
1.83 schwarze 924: return(DELIM_CLOSE);
925: default:
926: return(DELIM_NONE);
927: }
928:
929: if ('\\' != p[0])
930: return(DELIM_NONE);
1.24 schwarze 931:
1.83 schwarze 932: if (0 == strcmp(p + 1, "."))
933: return(DELIM_CLOSE);
1.90 schwarze 934: if (0 == strcmp(p + 1, "fR|\\fP"))
1.83 schwarze 935: return(DELIM_MIDDLE);
936:
937: return(DELIM_NONE);
1.101 schwarze 938: }
939:
940: void
941: mdoc_deroff(char **dest, const struct mdoc_node *n)
942: {
943: char *cp;
944: size_t sz;
945:
946: if (MDOC_TEXT != n->type) {
947: for (n = n->child; n; n = n->next)
948: mdoc_deroff(dest, n);
949: return;
950: }
951:
952: /* Skip leading whitespace. */
953:
954: for (cp = n->string; '\0' != *cp; cp++)
955: if (0 == isspace((unsigned char)*cp))
956: break;
957:
958: /* Skip trailing whitespace. */
959:
960: for (sz = strlen(cp); sz; sz--)
961: if (0 == isspace((unsigned char)cp[sz-1]))
962: break;
963:
964: /* Skip empty strings. */
965:
966: if (0 == sz)
967: return;
968:
969: if (NULL == *dest) {
970: *dest = mandoc_strndup(cp, sz);
971: return;
972: }
973:
974: mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
975: free(*dest);
976: *dest = cp;
1.83 schwarze 977: }