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