Annotation of src/usr.bin/mandoc/mdoc.c, Revision 1.117
1.117 ! schwarze 1: /* $OpenBSD: mdoc.c,v 1.116 2014/10/20 02:31:44 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.53 schwarze 92: static int mdoc_ptext(struct mdoc *, int, char *, int);
93: static int mdoc_pmacro(struct mdoc *, int, char *, int);
1.1 kristaps 94:
1.103 schwarze 95:
1.1 kristaps 96: const struct mdoc_node *
1.93 schwarze 97: mdoc_node(const struct mdoc *mdoc)
1.1 kristaps 98: {
99:
1.93 schwarze 100: return(mdoc->first);
1.1 kristaps 101: }
102:
103: const struct mdoc_meta *
1.93 schwarze 104: mdoc_meta(const struct mdoc *mdoc)
1.1 kristaps 105: {
106:
1.93 schwarze 107: return(&mdoc->meta);
1.1 kristaps 108: }
109:
1.8 schwarze 110: /*
111: * Frees volatile resources (parse tree, meta-data, fields).
112: */
1.1 kristaps 113: static void
114: mdoc_free1(struct mdoc *mdoc)
115: {
116:
117: if (mdoc->first)
1.40 schwarze 118: mdoc_node_delete(mdoc, mdoc->first);
1.113 schwarze 119: free(mdoc->meta.msec);
120: free(mdoc->meta.vol);
121: free(mdoc->meta.arch);
122: free(mdoc->meta.date);
123: free(mdoc->meta.title);
124: free(mdoc->meta.os);
125: free(mdoc->meta.name);
1.1 kristaps 126: }
127:
1.8 schwarze 128: /*
129: * Allocate all volatile resources (parse tree, meta-data, fields).
130: */
1.32 schwarze 131: static void
1.1 kristaps 132: mdoc_alloc1(struct mdoc *mdoc)
133: {
134:
1.32 schwarze 135: memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
1.1 kristaps 136: mdoc->flags = 0;
1.9 schwarze 137: mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.32 schwarze 138: mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
1.1 kristaps 139: mdoc->first = mdoc->last;
140: mdoc->last->type = MDOC_ROOT;
1.86 schwarze 141: mdoc->last->tok = MDOC_MAX;
1.1 kristaps 142: mdoc->next = MDOC_NEXT_CHILD;
143: }
144:
145: /*
1.8 schwarze 146: * Free up volatile resources (see mdoc_free1()) then re-initialises the
147: * data with mdoc_alloc1(). After invocation, parse data has been reset
148: * and the parser is ready for re-invocation on a new tree; however,
149: * cross-parse non-volatile data is kept intact.
1.1 kristaps 150: */
1.32 schwarze 151: void
1.1 kristaps 152: mdoc_reset(struct mdoc *mdoc)
153: {
154:
155: mdoc_free1(mdoc);
1.32 schwarze 156: mdoc_alloc1(mdoc);
1.1 kristaps 157: }
158:
159: /*
1.8 schwarze 160: * Completely free up all volatile and non-volatile parse resources.
161: * After invocation, the pointer is no longer usable.
1.1 kristaps 162: */
163: void
164: mdoc_free(struct mdoc *mdoc)
165: {
166:
167: mdoc_free1(mdoc);
168: free(mdoc);
169: }
170:
1.8 schwarze 171: /*
1.103 schwarze 172: * Allocate volatile and non-volatile parse resources.
1.8 schwarze 173: */
1.1 kristaps 174: struct mdoc *
1.98 schwarze 175: mdoc_alloc(struct roff *roff, struct mparse *parse,
1.110 schwarze 176: const char *defos, int quick)
1.1 kristaps 177: {
178: struct mdoc *p;
179:
1.32 schwarze 180: p = mandoc_calloc(1, sizeof(struct mdoc));
181:
1.83 schwarze 182: p->parse = parse;
1.87 schwarze 183: p->defos = defos;
1.98 schwarze 184: p->quick = quick;
1.84 schwarze 185: p->roff = roff;
1.1 kristaps 186:
1.32 schwarze 187: mdoc_hash_init();
188: mdoc_alloc1(p);
189: return(p);
1.1 kristaps 190: }
191:
192: int
1.93 schwarze 193: mdoc_endparse(struct mdoc *mdoc)
1.1 kristaps 194: {
195:
1.111 schwarze 196: return(mdoc_macroend(mdoc));
1.81 schwarze 197: }
198:
199: int
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.81 schwarze 208:
1.93 schwarze 209: if ( ! node_append(mdoc, n))
1.81 schwarze 210: return(0);
211:
1.93 schwarze 212: mdoc->next = MDOC_NEXT_SIBLING;
1.81 schwarze 213: return(1);
1.1 kristaps 214: }
215:
1.77 schwarze 216: int
1.93 schwarze 217: mdoc_addspan(struct mdoc *mdoc, const struct tbl_span *sp)
1.77 schwarze 218: {
1.79 schwarze 219: struct mdoc_node *n;
1.77 schwarze 220:
1.93 schwarze 221: n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, MDOC_TBL);
1.79 schwarze 222: n->span = sp;
223:
1.93 schwarze 224: if ( ! node_append(mdoc, n))
1.79 schwarze 225: return(0);
226:
1.93 schwarze 227: mdoc->next = MDOC_NEXT_SIBLING;
1.79 schwarze 228: return(1);
1.77 schwarze 229: }
230:
1.1 kristaps 231: /*
232: * Main parse routine. Parses a single line -- really just hands off to
1.45 schwarze 233: * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
1.1 kristaps 234: */
235: int
1.93 schwarze 236: mdoc_parseln(struct mdoc *mdoc, int ln, char *buf, int offs)
1.1 kristaps 237: {
238:
1.117 ! schwarze 239: if (mdoc->last->type != MDOC_EQN || ln > mdoc->last->line)
! 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:
610: /*
611: * Parse free-form text, that is, a line that does not begin with the
612: * control character.
613: */
614: static int
1.93 schwarze 615: mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
1.1 kristaps 616: {
1.56 schwarze 617: char *c, *ws, *end;
618: struct mdoc_node *n;
1.46 schwarze 619:
1.93 schwarze 620: assert(mdoc->last);
621: n = mdoc->last;
1.56 schwarze 622:
623: /*
624: * Divert directly to list processing if we're encountering a
625: * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
626: * (a MDOC_BODY means it's already open, in which case we should
627: * process within its context in the normal way).
628: */
629:
630: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.103 schwarze 631: LIST_column == n->norm->Bl.type) {
1.56 schwarze 632: /* `Bl' is open without any children. */
1.93 schwarze 633: mdoc->flags |= MDOC_FREECOL;
634: return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
1.56 schwarze 635: }
636:
637: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
1.103 schwarze 638: NULL != n->parent &&
639: MDOC_Bl == n->parent->tok &&
640: LIST_column == n->parent->norm->Bl.type) {
1.56 schwarze 641: /* `Bl' has block-level `It' children. */
1.93 schwarze 642: mdoc->flags |= MDOC_FREECOL;
643: return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
1.56 schwarze 644: }
645:
1.52 schwarze 646: /*
647: * Search for the beginning of unescaped trailing whitespace (ws)
648: * and for the first character not to be output (end).
649: */
1.56 schwarze 650:
651: /* FIXME: replace with strcspn(). */
1.52 schwarze 652: ws = NULL;
1.53 schwarze 653: for (c = end = buf + offs; *c; c++) {
1.52 schwarze 654: switch (*c) {
655: case ' ':
656: if (NULL == ws)
657: ws = c;
658: continue;
659: case '\t':
660: /*
661: * Always warn about trailing tabs,
662: * even outside literal context,
663: * where they should be put on the next line.
664: */
665: if (NULL == ws)
666: ws = c;
667: /*
668: * Strip trailing tabs in literal context only;
669: * outside, they affect the next line.
670: */
1.93 schwarze 671: if (MDOC_LITERAL & mdoc->flags)
1.52 schwarze 672: continue;
673: break;
674: case '\\':
675: /* Skip the escaped character, too, if any. */
676: if (c[1])
677: c++;
678: /* FALLTHROUGH */
679: default:
680: ws = NULL;
681: break;
682: }
683: end = c + 1;
684: }
685: *end = '\0';
1.19 schwarze 686:
1.52 schwarze 687: if (ws)
1.108 schwarze 688: mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
689: line, (int)(ws-buf), NULL);
1.34 schwarze 690:
1.93 schwarze 691: if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) {
1.108 schwarze 692: mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
693: line, (int)(c - buf), NULL);
1.46 schwarze 694:
1.40 schwarze 695: /*
1.66 schwarze 696: * Insert a `sp' in the case of a blank line. Technically,
1.46 schwarze 697: * blank lines aren't allowed, but enough manuals assume this
698: * behaviour that we want to work around it.
1.40 schwarze 699: */
1.93 schwarze 700: if ( ! mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL))
1.42 schwarze 701: return(0);
1.46 schwarze 702:
1.93 schwarze 703: mdoc->next = MDOC_NEXT_SIBLING;
1.89 schwarze 704:
1.93 schwarze 705: return(mdoc_valid_post(mdoc));
1.38 schwarze 706: }
1.1 kristaps 707:
1.93 schwarze 708: if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs))
1.1 kristaps 709: return(0);
710:
1.93 schwarze 711: if (MDOC_LITERAL & mdoc->flags)
1.52 schwarze 712: return(1);
713:
1.35 schwarze 714: /*
1.48 schwarze 715: * End-of-sentence check. If the last character is an unescaped
716: * EOS character, then flag the node as being the end of a
717: * sentence. The front-end will know how to interpret this.
1.35 schwarze 718: */
719:
1.52 schwarze 720: assert(buf < end);
1.48 schwarze 721:
1.97 schwarze 722: if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
1.93 schwarze 723: mdoc->last->flags |= MDOC_EOS;
1.48 schwarze 724:
1.1 kristaps 725: return(1);
726: }
1.19 schwarze 727:
1.1 kristaps 728: /*
729: * Parse a macro line, that is, a line beginning with the control
730: * character.
731: */
1.61 schwarze 732: static int
1.93 schwarze 733: mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
1.1 kristaps 734: {
1.56 schwarze 735: enum mdoct tok;
1.83 schwarze 736: int i, sv;
1.56 schwarze 737: char mac[5];
738: struct mdoc_node *n;
1.1 kristaps 739:
1.83 schwarze 740: sv = offs;
1.47 schwarze 741:
1.103 schwarze 742: /*
1.64 schwarze 743: * Copy the first word into a nil-terminated buffer.
744: * Stop copying when a tab, space, or eoln is encountered.
1.63 schwarze 745: */
1.1 kristaps 746:
1.83 schwarze 747: i = 0;
1.103 schwarze 748: while (i < 4 && '\0' != buf[offs] && ' ' != buf[offs] &&
749: '\t' != buf[offs])
1.83 schwarze 750: mac[i++] = buf[offs++];
751:
752: mac[i] = '\0';
753:
1.104 schwarze 754: tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
1.1 kristaps 755:
1.65 schwarze 756: if (MDOC_MAX == tok) {
1.112 schwarze 757: mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
758: ln, sv, buf + sv - 1);
1.1 kristaps 759: return(1);
760: }
761:
1.63 schwarze 762: /* Disregard the first trailing tab, if applicable. */
763:
1.83 schwarze 764: if ('\t' == buf[offs])
765: offs++;
1.63 schwarze 766:
767: /* Jump to the next non-whitespace word. */
1.1 kristaps 768:
1.83 schwarze 769: while (buf[offs] && ' ' == buf[offs])
770: offs++;
1.34 schwarze 771:
1.103 schwarze 772: /*
1.46 schwarze 773: * Trailing whitespace. Note that tabs are allowed to be passed
774: * into the parser as "text", so we only warn about spaces here.
775: */
1.34 schwarze 776:
1.83 schwarze 777: if ('\0' == buf[offs] && ' ' == buf[offs - 1])
1.108 schwarze 778: mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
779: ln, offs - 1, NULL);
1.1 kristaps 780:
1.56 schwarze 781: /*
782: * If an initial macro or a list invocation, divert directly
783: * into macro processing.
784: */
785:
1.111 schwarze 786: if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok)
787: return(mdoc_macro(mdoc, tok, ln, sv, &offs, buf));
1.56 schwarze 788:
1.93 schwarze 789: n = mdoc->last;
790: assert(mdoc->last);
1.56 schwarze 791:
792: /*
793: * If the first macro of a `Bl -column', open an `It' block
794: * context around the parsed macro.
795: */
796:
797: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.103 schwarze 798: LIST_column == n->norm->Bl.type) {
1.93 schwarze 799: mdoc->flags |= MDOC_FREECOL;
1.111 schwarze 800: return(mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf));
1.56 schwarze 801: }
802:
803: /*
804: * If we're following a block-level `It' within a `Bl -column'
805: * context (perhaps opened in the above block or in ptext()),
806: * then open an `It' block context around the parsed macro.
1.24 schwarze 807: */
1.56 schwarze 808:
809: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
1.103 schwarze 810: NULL != n->parent &&
811: MDOC_Bl == n->parent->tok &&
812: LIST_column == n->parent->norm->Bl.type) {
1.93 schwarze 813: mdoc->flags |= MDOC_FREECOL;
1.111 schwarze 814: return(mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf));
1.56 schwarze 815: }
816:
817: /* Normal processing of a macro. */
818:
1.103 schwarze 819: if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
1.111 schwarze 820: return(0);
1.98 schwarze 821:
822: /* In quick mode (for mandocdb), abort after the NAME section. */
823:
824: if (mdoc->quick && MDOC_Sh == tok &&
825: SEC_NAME != mdoc->last->sec)
826: return(2);
1.1 kristaps 827:
828: return(1);
829: }
1.24 schwarze 830:
1.83 schwarze 831: enum mdelim
832: mdoc_isdelim(const char *p)
833: {
834:
835: if ('\0' == p[0])
836: return(DELIM_NONE);
837:
838: if ('\0' == p[1])
839: switch (p[0]) {
1.103 schwarze 840: case '(':
1.83 schwarze 841: /* FALLTHROUGH */
1.103 schwarze 842: case '[':
1.83 schwarze 843: return(DELIM_OPEN);
1.103 schwarze 844: case '|':
1.83 schwarze 845: return(DELIM_MIDDLE);
1.103 schwarze 846: case '.':
1.83 schwarze 847: /* FALLTHROUGH */
1.103 schwarze 848: case ',':
1.83 schwarze 849: /* FALLTHROUGH */
1.103 schwarze 850: case ';':
1.83 schwarze 851: /* FALLTHROUGH */
1.103 schwarze 852: case ':':
1.83 schwarze 853: /* FALLTHROUGH */
1.103 schwarze 854: case '?':
1.83 schwarze 855: /* FALLTHROUGH */
1.103 schwarze 856: case '!':
1.83 schwarze 857: /* FALLTHROUGH */
1.103 schwarze 858: case ')':
1.83 schwarze 859: /* FALLTHROUGH */
1.103 schwarze 860: case ']':
1.83 schwarze 861: return(DELIM_CLOSE);
862: default:
863: return(DELIM_NONE);
864: }
865:
866: if ('\\' != p[0])
867: return(DELIM_NONE);
1.24 schwarze 868:
1.83 schwarze 869: if (0 == strcmp(p + 1, "."))
870: return(DELIM_CLOSE);
1.90 schwarze 871: if (0 == strcmp(p + 1, "fR|\\fP"))
1.83 schwarze 872: return(DELIM_MIDDLE);
873:
874: return(DELIM_NONE);
1.101 schwarze 875: }
876:
877: void
878: mdoc_deroff(char **dest, const struct mdoc_node *n)
879: {
880: char *cp;
881: size_t sz;
882:
883: if (MDOC_TEXT != n->type) {
884: for (n = n->child; n; n = n->next)
885: mdoc_deroff(dest, n);
886: return;
887: }
888:
889: /* Skip leading whitespace. */
890:
891: for (cp = n->string; '\0' != *cp; cp++)
892: if (0 == isspace((unsigned char)*cp))
893: break;
894:
895: /* Skip trailing whitespace. */
896:
897: for (sz = strlen(cp); sz; sz--)
898: if (0 == isspace((unsigned char)cp[sz-1]))
899: break;
900:
901: /* Skip empty strings. */
902:
903: if (0 == sz)
904: return;
905:
906: if (NULL == *dest) {
907: *dest = mandoc_strndup(cp, sz);
908: return;
909: }
910:
911: mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
912: free(*dest);
913: *dest = cp;
1.83 schwarze 914: }
![[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