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