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