Annotation of src/usr.bin/mandoc/mdoc.c, Revision 1.129
1.129 ! schwarze 1: /* $OpenBSD: mdoc.c,v 1.128 2015/04/02 21:03:18 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.128 schwarze 28: #include "mandoc_aux.h"
29: #include "mandoc.h"
30: #include "roff.h"
1.83 schwarze 31: #include "mdoc.h"
1.128 schwarze 32: #include "libmandoc.h"
1.1 kristaps 33: #include "libmdoc.h"
34:
1.106 schwarze 35: const char *const __mdoc_macronames[MDOC_MAX + 1] = {
1.7 schwarze 36: "Ap", "Dd", "Dt", "Os",
1.1 kristaps 37: "Sh", "Ss", "Pp", "D1",
38: "Dl", "Bd", "Ed", "Bl",
39: "El", "It", "Ad", "An",
40: "Ar", "Cd", "Cm", "Dv",
41: "Er", "Ev", "Ex", "Fa",
42: "Fd", "Fl", "Fn", "Ft",
43: "Ic", "In", "Li", "Nd",
44: "Nm", "Op", "Ot", "Pa",
45: "Rv", "St", "Va", "Vt",
1.33 schwarze 46: "Xr", "%A", "%B", "%D",
47: "%I", "%J", "%N", "%O",
48: "%P", "%R", "%T", "%V",
1.1 kristaps 49: "Ac", "Ao", "Aq", "At",
50: "Bc", "Bf", "Bo", "Bq",
51: "Bsx", "Bx", "Db", "Dc",
52: "Do", "Dq", "Ec", "Ef",
53: "Em", "Eo", "Fx", "Ms",
54: "No", "Ns", "Nx", "Ox",
55: "Pc", "Pf", "Po", "Pq",
56: "Qc", "Ql", "Qo", "Qq",
57: "Re", "Rs", "Sc", "So",
58: "Sq", "Sm", "Sx", "Sy",
59: "Tn", "Ux", "Xc", "Xo",
60: "Fo", "Fc", "Oo", "Oc",
61: "Bk", "Ek", "Bt", "Hf",
1.7 schwarze 62: "Fr", "Ud", "Lb", "Lp",
63: "Lk", "Mt", "Brq", "Bro",
1.33 schwarze 64: "Brc", "%C", "Es", "En",
65: "Dx", "%Q", "br", "sp",
1.106 schwarze 66: "%U", "Ta", "ll", "text",
1.1 kristaps 67: };
68:
1.103 schwarze 69: const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
1.1 kristaps 70: "split", "nosplit", "ragged",
1.103 schwarze 71: "unfilled", "literal", "file",
72: "offset", "bullet", "dash",
73: "hyphen", "item", "enum",
74: "tag", "diag", "hang",
75: "ohang", "inset", "column",
76: "width", "compact", "std",
1.1 kristaps 77: "filled", "words", "emphasis",
1.30 schwarze 78: "symbolic", "nested", "centered"
1.1 kristaps 79: };
80:
81: const char * const *mdoc_macronames = __mdoc_macronames;
82: const char * const *mdoc_argnames = __mdoc_argnames;
83:
1.129 ! schwarze 84: static void mdoc_node_free(struct roff_node *);
1.103 schwarze 85: static void mdoc_node_unlink(struct mdoc *,
1.129 ! schwarze 86: struct roff_node *);
1.1 kristaps 87: static void mdoc_free1(struct mdoc *);
1.32 schwarze 88: static void mdoc_alloc1(struct mdoc *);
1.129 ! schwarze 89: static struct roff_node *node_alloc(struct mdoc *, int, int,
! 90: int, enum roff_type);
! 91: static void node_append(struct mdoc *, struct roff_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.129 ! schwarze 96: const struct roff_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.129 ! schwarze 138: mdoc->last = mandoc_calloc(1, sizeof(*mdoc->last));
1.1 kristaps 139: mdoc->first = mdoc->last;
1.128 schwarze 140: mdoc->last->type = ROFFT_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:
1.123 schwarze 192: void
1.93 schwarze 193: mdoc_endparse(struct mdoc *mdoc)
1.1 kristaps 194: {
195:
1.121 schwarze 196: mdoc_macroend(mdoc);
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: {
1.129 ! schwarze 202: struct roff_node *n;
1.81 schwarze 203:
1.128 schwarze 204: n = node_alloc(mdoc, ep->ln, ep->pos, MDOC_MAX, ROFFT_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.129 ! schwarze 215: struct roff_node *n;
1.77 schwarze 216:
1.128 schwarze 217: n = node_alloc(mdoc, sp->line, 0, MDOC_MAX, ROFFT_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.128 schwarze 231: if (mdoc->last->type != ROFFT_EQN || ln > mdoc->last->line)
1.117 schwarze 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.129 ! schwarze 278: node_append(struct mdoc *mdoc, struct roff_node *p)
1.1 kristaps 279: {
280:
281: assert(mdoc->last);
282: assert(mdoc->first);
1.128 schwarze 283: assert(p->type != ROFFT_ROOT);
1.1 kristaps 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.128 schwarze 308: case ROFFT_BODY:
1.92 schwarze 309: if (ENDBODY_NOT != p->end)
310: break;
1.75 schwarze 311: /* FALLTHROUGH */
1.128 schwarze 312: case ROFFT_TAIL:
1.75 schwarze 313: /* FALLTHROUGH */
1.128 schwarze 314: case ROFFT_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.128 schwarze 324: case ROFFT_HEAD:
325: assert(p->parent->type == ROFFT_BLOCK);
1.1 kristaps 326: p->parent->head = p;
327: break;
1.128 schwarze 328: case ROFFT_TAIL:
329: assert(p->parent->type == ROFFT_BLOCK);
1.1 kristaps 330: p->parent->tail = p;
331: break;
1.128 schwarze 332: case ROFFT_BODY:
1.59 schwarze 333: if (p->end)
334: break;
1.128 schwarze 335: assert(p->parent->type == ROFFT_BLOCK);
1.1 kristaps 336: p->parent->body = p;
337: break;
338: default:
339: break;
340: }
341:
342: mdoc->last = p;
343:
344: switch (p->type) {
1.128 schwarze 345: case ROFFT_TBL:
1.77 schwarze 346: /* FALLTHROUGH */
1.128 schwarze 347: case ROFFT_TEXT:
1.119 schwarze 348: mdoc_valid_post(mdoc);
1.1 kristaps 349: break;
350: default:
351: break;
352: }
353: }
354:
1.129 ! schwarze 355: static struct roff_node *
1.103 schwarze 356: node_alloc(struct mdoc *mdoc, int line, int pos,
1.129 ! schwarze 357: int tok, enum roff_type type)
1.1 kristaps 358: {
1.129 ! schwarze 359: struct roff_node *p;
1.1 kristaps 360:
1.129 ! schwarze 361: p = mandoc_calloc(1, sizeof(*p));
1.93 schwarze 362: p->sec = mdoc->lastsec;
1.1 kristaps 363: p->line = line;
364: p->pos = pos;
365: p->tok = tok;
1.37 schwarze 366: p->type = type;
1.58 schwarze 367:
368: /* Flag analysis. */
369:
1.93 schwarze 370: if (MDOC_SYNOPSIS & mdoc->flags)
1.60 schwarze 371: p->flags |= MDOC_SYNPRETTY;
372: else
373: p->flags &= ~MDOC_SYNPRETTY;
1.93 schwarze 374: if (MDOC_NEWLINE & mdoc->flags)
1.47 schwarze 375: p->flags |= MDOC_LINE;
1.93 schwarze 376: mdoc->flags &= ~MDOC_NEWLINE;
1.58 schwarze 377:
1.1 kristaps 378: return(p);
379: }
380:
1.120 schwarze 381: void
1.129 ! schwarze 382: mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.1 kristaps 383: {
1.129 ! schwarze 384: struct roff_node *p;
1.1 kristaps 385:
1.128 schwarze 386: p = node_alloc(mdoc, line, pos, tok, ROFFT_TAIL);
1.119 schwarze 387: node_append(mdoc, p);
1.93 schwarze 388: mdoc->next = MDOC_NEXT_CHILD;
1.1 kristaps 389: }
390:
1.129 ! schwarze 391: struct roff_node *
! 392: mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.1 kristaps 393: {
1.129 ! schwarze 394: struct roff_node *p;
1.1 kristaps 395:
1.93 schwarze 396: assert(mdoc->first);
397: assert(mdoc->last);
1.128 schwarze 398: p = node_alloc(mdoc, line, pos, tok, ROFFT_HEAD);
1.119 schwarze 399: node_append(mdoc, p);
1.93 schwarze 400: mdoc->next = MDOC_NEXT_CHILD;
1.120 schwarze 401: return(p);
1.1 kristaps 402: }
403:
1.129 ! schwarze 404: struct roff_node *
! 405: mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.1 kristaps 406: {
1.129 ! schwarze 407: struct roff_node *p;
1.1 kristaps 408:
1.128 schwarze 409: p = node_alloc(mdoc, line, pos, tok, ROFFT_BODY);
1.119 schwarze 410: node_append(mdoc, p);
1.93 schwarze 411: mdoc->next = MDOC_NEXT_CHILD;
1.120 schwarze 412: return(p);
1.59 schwarze 413: }
414:
1.129 ! schwarze 415: struct roff_node *
! 416: mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, int tok,
! 417: struct roff_node *body, enum mdoc_endbody end)
1.59 schwarze 418: {
1.129 ! schwarze 419: struct roff_node *p;
1.59 schwarze 420:
1.126 schwarze 421: body->flags |= MDOC_ENDED;
422: body->parent->flags |= MDOC_ENDED;
1.128 schwarze 423: p = node_alloc(mdoc, line, pos, tok, ROFFT_BODY);
1.126 schwarze 424: p->body = body;
1.92 schwarze 425: p->norm = body->norm;
1.59 schwarze 426: p->end = end;
1.119 schwarze 427: node_append(mdoc, p);
1.93 schwarze 428: mdoc->next = MDOC_NEXT_SIBLING;
1.124 schwarze 429: return(p);
1.1 kristaps 430: }
431:
1.129 ! schwarze 432: struct roff_node *
1.103 schwarze 433: mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
1.129 ! schwarze 434: int tok, struct mdoc_arg *args)
1.1 kristaps 435: {
1.129 ! schwarze 436: struct roff_node *p;
1.1 kristaps 437:
1.128 schwarze 438: p = node_alloc(mdoc, line, pos, tok, ROFFT_BLOCK);
1.4 schwarze 439: p->args = args;
440: if (p->args)
1.1 kristaps 441: (args->refcnt)++;
1.75 schwarze 442:
443: switch (tok) {
1.103 schwarze 444: case MDOC_Bd:
1.75 schwarze 445: /* FALLTHROUGH */
1.103 schwarze 446: case MDOC_Bf:
1.75 schwarze 447: /* FALLTHROUGH */
1.103 schwarze 448: case MDOC_Bl:
1.107 schwarze 449: /* FALLTHROUGH */
450: case MDOC_En:
1.75 schwarze 451: /* FALLTHROUGH */
1.103 schwarze 452: case MDOC_Rs:
1.75 schwarze 453: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
454: break;
455: default:
456: break;
457: }
1.119 schwarze 458: node_append(mdoc, p);
1.93 schwarze 459: mdoc->next = MDOC_NEXT_CHILD;
1.120 schwarze 460: return(p);
1.1 kristaps 461: }
462:
1.120 schwarze 463: void
1.103 schwarze 464: mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
1.129 ! schwarze 465: int tok, struct mdoc_arg *args)
1.1 kristaps 466: {
1.129 ! schwarze 467: struct roff_node *p;
1.1 kristaps 468:
1.128 schwarze 469: p = node_alloc(mdoc, line, pos, tok, ROFFT_ELEM);
1.4 schwarze 470: p->args = args;
471: if (p->args)
1.1 kristaps 472: (args->refcnt)++;
1.75 schwarze 473:
474: switch (tok) {
1.103 schwarze 475: case MDOC_An:
1.75 schwarze 476: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
477: break;
478: default:
479: break;
480: }
1.119 schwarze 481: node_append(mdoc, p);
1.93 schwarze 482: mdoc->next = MDOC_NEXT_CHILD;
1.1 kristaps 483: }
484:
1.120 schwarze 485: void
1.93 schwarze 486: mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
1.1 kristaps 487: {
1.129 ! schwarze 488: struct roff_node *n;
1.1 kristaps 489:
1.128 schwarze 490: n = node_alloc(mdoc, line, pos, MDOC_MAX, ROFFT_TEXT);
1.93 schwarze 491: n->string = roff_strdup(mdoc->roff, p);
1.119 schwarze 492: node_append(mdoc, n);
1.93 schwarze 493: mdoc->next = MDOC_NEXT_SIBLING;
1.19 schwarze 494: }
495:
1.95 schwarze 496: void
497: mdoc_word_append(struct mdoc *mdoc, const char *p)
498: {
1.129 ! schwarze 499: struct roff_node *n;
1.95 schwarze 500: char *addstr, *newstr;
501:
502: n = mdoc->last;
503: addstr = roff_strdup(mdoc->roff, p);
1.100 schwarze 504: mandoc_asprintf(&newstr, "%s %s", n->string, addstr);
1.95 schwarze 505: free(addstr);
506: free(n->string);
507: n->string = newstr;
508: mdoc->next = MDOC_NEXT_SIBLING;
509: }
1.19 schwarze 510:
1.61 schwarze 511: static void
1.129 ! schwarze 512: mdoc_node_free(struct roff_node *p)
1.1 kristaps 513: {
1.61 schwarze 514:
1.128 schwarze 515: if (p->type == ROFFT_BLOCK || p->type == ROFFT_ELEM)
1.75 schwarze 516: free(p->norm);
1.1 kristaps 517: if (p->string)
518: free(p->string);
519: if (p->args)
520: mdoc_argv_free(p->args);
521: free(p);
522: }
523:
1.40 schwarze 524: static void
1.129 ! schwarze 525: mdoc_node_unlink(struct mdoc *mdoc, struct roff_node *n)
1.40 schwarze 526: {
527:
528: /* Adjust siblings. */
529:
530: if (n->prev)
531: n->prev->next = n->next;
532: if (n->next)
533: n->next->prev = n->prev;
534:
535: /* Adjust parent. */
536:
537: if (n->parent) {
538: n->parent->nchild--;
539: if (n->parent->child == n)
540: n->parent->child = n->prev ? n->prev : n->next;
1.72 schwarze 541: if (n->parent->last == n)
542: n->parent->last = n->prev ? n->prev : NULL;
1.40 schwarze 543: }
544:
545: /* Adjust parse point, if applicable. */
546:
1.93 schwarze 547: if (mdoc && mdoc->last == n) {
1.40 schwarze 548: if (n->prev) {
1.93 schwarze 549: mdoc->last = n->prev;
550: mdoc->next = MDOC_NEXT_SIBLING;
1.40 schwarze 551: } else {
1.93 schwarze 552: mdoc->last = n->parent;
553: mdoc->next = MDOC_NEXT_CHILD;
1.40 schwarze 554: }
555: }
556:
1.93 schwarze 557: if (mdoc && mdoc->first == n)
558: mdoc->first = NULL;
1.40 schwarze 559: }
560:
1.1 kristaps 561: void
1.129 ! schwarze 562: mdoc_node_delete(struct mdoc *mdoc, struct roff_node *p)
1.1 kristaps 563: {
564:
1.40 schwarze 565: while (p->child) {
566: assert(p->nchild);
1.93 schwarze 567: mdoc_node_delete(mdoc, p->child);
1.40 schwarze 568: }
569: assert(0 == p->nchild);
1.1 kristaps 570:
1.93 schwarze 571: mdoc_node_unlink(mdoc, p);
1.1 kristaps 572: mdoc_node_free(p);
1.91 schwarze 573: }
574:
1.120 schwarze 575: void
1.129 ! schwarze 576: mdoc_node_relink(struct mdoc *mdoc, struct roff_node *p)
1.91 schwarze 577: {
578:
1.93 schwarze 579: mdoc_node_unlink(mdoc, p);
1.119 schwarze 580: node_append(mdoc, p);
1.1 kristaps 581: }
582:
583: /*
584: * Parse free-form text, that is, a line that does not begin with the
585: * control character.
586: */
587: static int
1.93 schwarze 588: mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
1.1 kristaps 589: {
1.129 ! schwarze 590: struct roff_node *n;
1.56 schwarze 591: char *c, *ws, *end;
1.46 schwarze 592:
1.93 schwarze 593: assert(mdoc->last);
594: n = mdoc->last;
1.56 schwarze 595:
596: /*
597: * Divert directly to list processing if we're encountering a
1.128 schwarze 598: * columnar ROFFT_BLOCK with or without a prior ROFFT_BLOCK entry
599: * (a ROFFT_BODY means it's already open, in which case we should
1.56 schwarze 600: * process within its context in the normal way).
601: */
602:
1.128 schwarze 603: if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
1.127 schwarze 604: n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
1.56 schwarze 605: /* `Bl' is open without any children. */
1.93 schwarze 606: mdoc->flags |= MDOC_FREECOL;
1.121 schwarze 607: mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
608: return(1);
1.56 schwarze 609: }
610:
1.128 schwarze 611: if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
1.103 schwarze 612: NULL != n->parent &&
613: MDOC_Bl == n->parent->tok &&
614: LIST_column == n->parent->norm->Bl.type) {
1.56 schwarze 615: /* `Bl' has block-level `It' children. */
1.93 schwarze 616: mdoc->flags |= MDOC_FREECOL;
1.121 schwarze 617: mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf);
618: return(1);
1.56 schwarze 619: }
620:
1.52 schwarze 621: /*
622: * Search for the beginning of unescaped trailing whitespace (ws)
623: * and for the first character not to be output (end).
624: */
1.56 schwarze 625:
626: /* FIXME: replace with strcspn(). */
1.52 schwarze 627: ws = NULL;
1.53 schwarze 628: for (c = end = buf + offs; *c; c++) {
1.52 schwarze 629: switch (*c) {
630: case ' ':
631: if (NULL == ws)
632: ws = c;
633: continue;
634: case '\t':
635: /*
636: * Always warn about trailing tabs,
637: * even outside literal context,
638: * where they should be put on the next line.
639: */
640: if (NULL == ws)
641: ws = c;
642: /*
643: * Strip trailing tabs in literal context only;
644: * outside, they affect the next line.
645: */
1.93 schwarze 646: if (MDOC_LITERAL & mdoc->flags)
1.52 schwarze 647: continue;
648: break;
649: case '\\':
650: /* Skip the escaped character, too, if any. */
651: if (c[1])
652: c++;
653: /* FALLTHROUGH */
654: default:
655: ws = NULL;
656: break;
657: }
658: end = c + 1;
659: }
660: *end = '\0';
1.19 schwarze 661:
1.52 schwarze 662: if (ws)
1.108 schwarze 663: mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
664: line, (int)(ws-buf), NULL);
1.34 schwarze 665:
1.120 schwarze 666: if (buf[offs] == '\0' && ! (mdoc->flags & MDOC_LITERAL)) {
1.108 schwarze 667: mandoc_msg(MANDOCERR_FI_BLANK, mdoc->parse,
668: line, (int)(c - buf), NULL);
1.46 schwarze 669:
1.40 schwarze 670: /*
1.66 schwarze 671: * Insert a `sp' in the case of a blank line. Technically,
1.46 schwarze 672: * blank lines aren't allowed, but enough manuals assume this
673: * behaviour that we want to work around it.
1.40 schwarze 674: */
1.120 schwarze 675: mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL);
1.93 schwarze 676: mdoc->next = MDOC_NEXT_SIBLING;
1.119 schwarze 677: mdoc_valid_post(mdoc);
678: return(1);
1.38 schwarze 679: }
1.1 kristaps 680:
1.120 schwarze 681: mdoc_word_alloc(mdoc, line, offs, buf+offs);
1.1 kristaps 682:
1.120 schwarze 683: if (mdoc->flags & MDOC_LITERAL)
1.52 schwarze 684: return(1);
685:
1.35 schwarze 686: /*
1.48 schwarze 687: * End-of-sentence check. If the last character is an unescaped
688: * EOS character, then flag the node as being the end of a
689: * sentence. The front-end will know how to interpret this.
1.35 schwarze 690: */
691:
1.52 schwarze 692: assert(buf < end);
1.48 schwarze 693:
1.97 schwarze 694: if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
1.93 schwarze 695: mdoc->last->flags |= MDOC_EOS;
1.1 kristaps 696: return(1);
697: }
1.19 schwarze 698:
1.1 kristaps 699: /*
700: * Parse a macro line, that is, a line beginning with the control
701: * character.
702: */
1.61 schwarze 703: static int
1.93 schwarze 704: mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
1.1 kristaps 705: {
1.129 ! schwarze 706: struct roff_node *n;
1.118 schwarze 707: const char *cp;
1.129 ! schwarze 708: int tok;
1.83 schwarze 709: int i, sv;
1.56 schwarze 710: char mac[5];
1.1 kristaps 711:
1.83 schwarze 712: sv = offs;
1.47 schwarze 713:
1.103 schwarze 714: /*
1.64 schwarze 715: * Copy the first word into a nil-terminated buffer.
1.118 schwarze 716: * Stop when a space, tab, escape, or eoln is encountered.
1.63 schwarze 717: */
1.1 kristaps 718:
1.83 schwarze 719: i = 0;
1.118 schwarze 720: while (i < 4 && strchr(" \t\\", buf[offs]) == NULL)
1.83 schwarze 721: mac[i++] = buf[offs++];
722:
723: mac[i] = '\0';
724:
1.104 schwarze 725: tok = (i > 1 && i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
1.1 kristaps 726:
1.118 schwarze 727: if (tok == MDOC_MAX) {
1.112 schwarze 728: mandoc_msg(MANDOCERR_MACRO, mdoc->parse,
729: ln, sv, buf + sv - 1);
1.1 kristaps 730: return(1);
731: }
732:
1.118 schwarze 733: /* Skip a leading escape sequence or tab. */
1.63 schwarze 734:
1.118 schwarze 735: switch (buf[offs]) {
736: case '\\':
737: cp = buf + offs + 1;
738: mandoc_escape(&cp, NULL, NULL);
739: offs = cp - buf;
740: break;
741: case '\t':
1.83 schwarze 742: offs++;
1.118 schwarze 743: break;
744: default:
745: break;
746: }
1.63 schwarze 747:
748: /* Jump to the next non-whitespace word. */
1.1 kristaps 749:
1.83 schwarze 750: while (buf[offs] && ' ' == buf[offs])
751: offs++;
1.34 schwarze 752:
1.103 schwarze 753: /*
1.46 schwarze 754: * Trailing whitespace. Note that tabs are allowed to be passed
755: * into the parser as "text", so we only warn about spaces here.
756: */
1.34 schwarze 757:
1.83 schwarze 758: if ('\0' == buf[offs] && ' ' == buf[offs - 1])
1.108 schwarze 759: mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
760: ln, offs - 1, NULL);
1.1 kristaps 761:
1.56 schwarze 762: /*
763: * If an initial macro or a list invocation, divert directly
764: * into macro processing.
765: */
766:
1.121 schwarze 767: if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
768: mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
769: return(1);
770: }
1.56 schwarze 771:
1.93 schwarze 772: n = mdoc->last;
773: assert(mdoc->last);
1.56 schwarze 774:
775: /*
776: * If the first macro of a `Bl -column', open an `It' block
777: * context around the parsed macro.
778: */
779:
1.128 schwarze 780: if (n->tok == MDOC_Bl && n->type == ROFFT_BODY &&
1.127 schwarze 781: n->end == ENDBODY_NOT && n->norm->Bl.type == LIST_column) {
1.93 schwarze 782: mdoc->flags |= MDOC_FREECOL;
1.121 schwarze 783: mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
784: return(1);
1.56 schwarze 785: }
786:
787: /*
788: * If we're following a block-level `It' within a `Bl -column'
789: * context (perhaps opened in the above block or in ptext()),
790: * then open an `It' block context around the parsed macro.
1.24 schwarze 791: */
1.56 schwarze 792:
1.128 schwarze 793: if (n->tok == MDOC_It && n->type == ROFFT_BLOCK &&
1.103 schwarze 794: NULL != n->parent &&
795: MDOC_Bl == n->parent->tok &&
796: LIST_column == n->parent->norm->Bl.type) {
1.93 schwarze 797: mdoc->flags |= MDOC_FREECOL;
1.121 schwarze 798: mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf);
799: return(1);
1.56 schwarze 800: }
801:
802: /* Normal processing of a macro. */
803:
1.121 schwarze 804: mdoc_macro(mdoc, tok, ln, sv, &offs, buf);
1.98 schwarze 805:
806: /* In quick mode (for mandocdb), abort after the NAME section. */
807:
808: if (mdoc->quick && MDOC_Sh == tok &&
809: SEC_NAME != mdoc->last->sec)
810: return(2);
1.1 kristaps 811:
812: return(1);
813: }
1.24 schwarze 814:
1.83 schwarze 815: enum mdelim
816: mdoc_isdelim(const char *p)
817: {
818:
819: if ('\0' == p[0])
820: return(DELIM_NONE);
821:
822: if ('\0' == p[1])
823: switch (p[0]) {
1.103 schwarze 824: case '(':
1.83 schwarze 825: /* FALLTHROUGH */
1.103 schwarze 826: case '[':
1.83 schwarze 827: return(DELIM_OPEN);
1.103 schwarze 828: case '|':
1.83 schwarze 829: return(DELIM_MIDDLE);
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: /* FALLTHROUGH */
1.103 schwarze 844: case ']':
1.83 schwarze 845: return(DELIM_CLOSE);
846: default:
847: return(DELIM_NONE);
848: }
849:
850: if ('\\' != p[0])
851: return(DELIM_NONE);
1.24 schwarze 852:
1.83 schwarze 853: if (0 == strcmp(p + 1, "."))
854: return(DELIM_CLOSE);
1.90 schwarze 855: if (0 == strcmp(p + 1, "fR|\\fP"))
1.83 schwarze 856: return(DELIM_MIDDLE);
857:
858: return(DELIM_NONE);
1.101 schwarze 859: }
860:
861: void
1.129 ! schwarze 862: mdoc_deroff(char **dest, const struct roff_node *n)
1.101 schwarze 863: {
864: char *cp;
865: size_t sz;
866:
1.128 schwarze 867: if (n->type != ROFFT_TEXT) {
1.101 schwarze 868: for (n = n->child; n; n = n->next)
869: mdoc_deroff(dest, n);
870: return;
871: }
872:
873: /* Skip leading whitespace. */
874:
875: for (cp = n->string; '\0' != *cp; cp++)
876: if (0 == isspace((unsigned char)*cp))
877: break;
878:
879: /* Skip trailing whitespace. */
880:
881: for (sz = strlen(cp); sz; sz--)
882: if (0 == isspace((unsigned char)cp[sz-1]))
883: break;
884:
885: /* Skip empty strings. */
886:
887: if (0 == sz)
888: return;
889:
890: if (NULL == *dest) {
891: *dest = mandoc_strndup(cp, sz);
892: return;
893: }
894:
895: mandoc_asprintf(&cp, "%s %*s", *dest, (int)sz, cp);
896: free(*dest);
897: *dest = cp;
1.83 schwarze 898: }
![[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