Annotation of src/usr.bin/mandoc/mdoc.c, Revision 1.97
1.97 ! schwarze 1: /* $Id: mdoc.c,v 1.96 2013/12/24 19:10:34 schwarze Exp $ */
1.1 kristaps 2: /*
1.77 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.95 schwarze 4: * Copyright (c) 2010, 2012, 2013 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;
1.96 schwarze 433: p->lastline = line;
1.1 kristaps 434: p->tok = tok;
1.37 schwarze 435: p->type = type;
1.58 schwarze 436:
437: /* Flag analysis. */
438:
1.93 schwarze 439: if (MDOC_SYNOPSIS & mdoc->flags)
1.60 schwarze 440: p->flags |= MDOC_SYNPRETTY;
441: else
442: p->flags &= ~MDOC_SYNPRETTY;
1.93 schwarze 443: if (MDOC_NEWLINE & mdoc->flags)
1.47 schwarze 444: p->flags |= MDOC_LINE;
1.93 schwarze 445: mdoc->flags &= ~MDOC_NEWLINE;
1.58 schwarze 446:
1.1 kristaps 447: return(p);
448: }
449:
450:
451: int
1.93 schwarze 452: mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.1 kristaps 453: {
454: struct mdoc_node *p;
455:
1.93 schwarze 456: p = node_alloc(mdoc, line, pos, tok, MDOC_TAIL);
457: if ( ! node_append(mdoc, p))
1.25 schwarze 458: return(0);
1.93 schwarze 459: mdoc->next = MDOC_NEXT_CHILD;
1.25 schwarze 460: return(1);
1.1 kristaps 461: }
462:
463:
464: int
1.93 schwarze 465: mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.1 kristaps 466: {
467: struct mdoc_node *p;
468:
1.93 schwarze 469: assert(mdoc->first);
470: assert(mdoc->last);
1.1 kristaps 471:
1.93 schwarze 472: p = node_alloc(mdoc, line, pos, tok, MDOC_HEAD);
473: if ( ! node_append(mdoc, p))
1.25 schwarze 474: return(0);
1.93 schwarze 475: mdoc->next = MDOC_NEXT_CHILD;
1.25 schwarze 476: return(1);
1.1 kristaps 477: }
478:
479:
480: int
1.93 schwarze 481: mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok)
1.1 kristaps 482: {
483: struct mdoc_node *p;
484:
1.93 schwarze 485: p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
486: if ( ! node_append(mdoc, p))
1.25 schwarze 487: return(0);
1.93 schwarze 488: mdoc->next = MDOC_NEXT_CHILD;
1.59 schwarze 489: return(1);
490: }
491:
492:
493: int
1.93 schwarze 494: mdoc_endbody_alloc(struct mdoc *mdoc, int line, int pos, enum mdoct tok,
1.59 schwarze 495: struct mdoc_node *body, enum mdoc_endbody end)
496: {
497: struct mdoc_node *p;
498:
1.93 schwarze 499: p = node_alloc(mdoc, line, pos, tok, MDOC_BODY);
1.59 schwarze 500: p->pending = body;
1.92 schwarze 501: p->norm = body->norm;
1.59 schwarze 502: p->end = end;
1.93 schwarze 503: if ( ! node_append(mdoc, p))
1.59 schwarze 504: return(0);
1.93 schwarze 505: mdoc->next = MDOC_NEXT_SIBLING;
1.25 schwarze 506: return(1);
1.1 kristaps 507: }
508:
509:
510: int
1.93 schwarze 511: mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
1.37 schwarze 512: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 513: {
514: struct mdoc_node *p;
515:
1.93 schwarze 516: p = node_alloc(mdoc, line, pos, tok, MDOC_BLOCK);
1.4 schwarze 517: p->args = args;
518: if (p->args)
1.1 kristaps 519: (args->refcnt)++;
1.75 schwarze 520:
521: switch (tok) {
522: case (MDOC_Bd):
523: /* FALLTHROUGH */
524: case (MDOC_Bf):
525: /* FALLTHROUGH */
526: case (MDOC_Bl):
527: /* FALLTHROUGH */
528: case (MDOC_Rs):
529: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
530: break;
531: default:
532: break;
533: }
534:
1.93 schwarze 535: if ( ! node_append(mdoc, p))
1.25 schwarze 536: return(0);
1.93 schwarze 537: mdoc->next = MDOC_NEXT_CHILD;
1.25 schwarze 538: return(1);
1.1 kristaps 539: }
540:
541:
542: int
1.93 schwarze 543: mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
1.37 schwarze 544: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 545: {
546: struct mdoc_node *p;
547:
1.93 schwarze 548: p = node_alloc(mdoc, line, pos, tok, MDOC_ELEM);
1.4 schwarze 549: p->args = args;
550: if (p->args)
1.1 kristaps 551: (args->refcnt)++;
1.75 schwarze 552:
553: switch (tok) {
554: case (MDOC_An):
555: p->norm = mandoc_calloc(1, sizeof(union mdoc_data));
556: break;
557: default:
558: break;
559: }
560:
1.93 schwarze 561: if ( ! node_append(mdoc, p))
1.25 schwarze 562: return(0);
1.93 schwarze 563: mdoc->next = MDOC_NEXT_CHILD;
1.25 schwarze 564: return(1);
1.1 kristaps 565: }
566:
1.46 schwarze 567: int
1.93 schwarze 568: mdoc_word_alloc(struct mdoc *mdoc, int line, int pos, const char *p)
1.1 kristaps 569: {
1.19 schwarze 570: struct mdoc_node *n;
1.1 kristaps 571:
1.93 schwarze 572: n = node_alloc(mdoc, line, pos, MDOC_MAX, MDOC_TEXT);
573: n->string = roff_strdup(mdoc->roff, p);
1.19 schwarze 574:
1.93 schwarze 575: if ( ! node_append(mdoc, n))
1.25 schwarze 576: return(0);
1.46 schwarze 577:
1.93 schwarze 578: mdoc->next = MDOC_NEXT_SIBLING;
1.25 schwarze 579: return(1);
1.19 schwarze 580: }
581:
1.95 schwarze 582: void
583: mdoc_word_append(struct mdoc *mdoc, const char *p)
584: {
585: struct mdoc_node *n;
586: char *addstr, *newstr;
587:
588: n = mdoc->last;
589: addstr = roff_strdup(mdoc->roff, p);
590: if (-1 == asprintf(&newstr, "%s %s", n->string, addstr)) {
591: perror(NULL);
592: exit((int)MANDOCLEVEL_SYSERR);
593: }
594: free(addstr);
595: free(n->string);
596: n->string = newstr;
597: mdoc->next = MDOC_NEXT_SIBLING;
598: }
1.19 schwarze 599:
1.61 schwarze 600: static void
1.1 kristaps 601: mdoc_node_free(struct mdoc_node *p)
602: {
1.61 schwarze 603:
1.75 schwarze 604: if (MDOC_BLOCK == p->type || MDOC_ELEM == p->type)
605: free(p->norm);
1.1 kristaps 606: if (p->string)
607: free(p->string);
608: if (p->args)
609: mdoc_argv_free(p->args);
610: free(p);
611: }
612:
613:
1.40 schwarze 614: static void
1.93 schwarze 615: mdoc_node_unlink(struct mdoc *mdoc, struct mdoc_node *n)
1.40 schwarze 616: {
617:
618: /* Adjust siblings. */
619:
620: if (n->prev)
621: n->prev->next = n->next;
622: if (n->next)
623: n->next->prev = n->prev;
624:
625: /* Adjust parent. */
626:
627: if (n->parent) {
628: n->parent->nchild--;
629: if (n->parent->child == n)
630: n->parent->child = n->prev ? n->prev : n->next;
1.72 schwarze 631: if (n->parent->last == n)
632: n->parent->last = n->prev ? n->prev : NULL;
1.40 schwarze 633: }
634:
635: /* Adjust parse point, if applicable. */
636:
1.93 schwarze 637: if (mdoc && mdoc->last == n) {
1.40 schwarze 638: if (n->prev) {
1.93 schwarze 639: mdoc->last = n->prev;
640: mdoc->next = MDOC_NEXT_SIBLING;
1.40 schwarze 641: } else {
1.93 schwarze 642: mdoc->last = n->parent;
643: mdoc->next = MDOC_NEXT_CHILD;
1.40 schwarze 644: }
645: }
646:
1.93 schwarze 647: if (mdoc && mdoc->first == n)
648: mdoc->first = NULL;
1.40 schwarze 649: }
650:
651:
1.1 kristaps 652: void
1.93 schwarze 653: mdoc_node_delete(struct mdoc *mdoc, struct mdoc_node *p)
1.1 kristaps 654: {
655:
1.40 schwarze 656: while (p->child) {
657: assert(p->nchild);
1.93 schwarze 658: mdoc_node_delete(mdoc, p->child);
1.40 schwarze 659: }
660: assert(0 == p->nchild);
1.1 kristaps 661:
1.93 schwarze 662: mdoc_node_unlink(mdoc, p);
1.1 kristaps 663: mdoc_node_free(p);
1.91 schwarze 664: }
665:
666: int
1.93 schwarze 667: mdoc_node_relink(struct mdoc *mdoc, struct mdoc_node *p)
1.91 schwarze 668: {
669:
1.93 schwarze 670: mdoc_node_unlink(mdoc, p);
671: return(node_append(mdoc, p));
1.1 kristaps 672: }
673:
1.84 schwarze 674: #if 0
675: /*
676: * Pre-treat a text line.
677: * Text lines can consist of equations, which must be handled apart from
678: * the regular text.
679: * Thus, use this function to step through a line checking if it has any
680: * equations embedded in it.
681: * This must handle multiple equations AND equations that do not end at
682: * the end-of-line, i.e., will re-enter in the next roff parse.
683: */
684: static int
1.93 schwarze 685: mdoc_preptext(struct mdoc *mdoc, int line, char *buf, int offs)
1.84 schwarze 686: {
687: char *start, *end;
688: char delim;
689:
690: while ('\0' != buf[offs]) {
691: /* Mark starting position if eqn is set. */
692: start = NULL;
1.93 schwarze 693: if ('\0' != (delim = roff_eqndelim(mdoc->roff)))
1.84 schwarze 694: if (NULL != (start = strchr(buf + offs, delim)))
695: *start++ = '\0';
696:
697: /* Parse text as normal. */
1.93 schwarze 698: if ( ! mdoc_ptext(mdoc, line, buf, offs))
1.84 schwarze 699: return(0);
700:
701: /* Continue only if an equation exists. */
702: if (NULL == start)
703: break;
704:
705: /* Read past the end of the equation. */
706: offs += start - (buf + offs);
707: assert(start == &buf[offs]);
708: if (NULL != (end = strchr(buf + offs, delim))) {
709: *end++ = '\0';
710: while (' ' == *end)
711: end++;
712: }
713:
714: /* Parse the equation itself. */
1.93 schwarze 715: roff_openeqn(mdoc->roff, NULL, line, offs, buf);
1.84 schwarze 716:
717: /* Process a finished equation? */
1.93 schwarze 718: if (roff_closeeqn(mdoc->roff))
719: if ( ! mdoc_addeqn(mdoc, roff_eqn(mdoc->roff)))
1.84 schwarze 720: return(0);
721: offs += (end - (buf + offs));
722: }
723:
724: return(1);
725: }
726: #endif
1.1 kristaps 727:
728: /*
729: * Parse free-form text, that is, a line that does not begin with the
730: * control character.
731: */
732: static int
1.93 schwarze 733: mdoc_ptext(struct mdoc *mdoc, int line, char *buf, int offs)
1.1 kristaps 734: {
1.56 schwarze 735: char *c, *ws, *end;
736: struct mdoc_node *n;
1.44 schwarze 737:
1.46 schwarze 738: /* No text before an initial macro. */
739:
1.93 schwarze 740: if (SEC_NONE == mdoc->lastnamed) {
741: mdoc_pmsg(mdoc, line, offs, MANDOCERR_NOTEXT);
1.76 schwarze 742: return(1);
743: }
1.46 schwarze 744:
1.93 schwarze 745: assert(mdoc->last);
746: n = mdoc->last;
1.56 schwarze 747:
748: /*
749: * Divert directly to list processing if we're encountering a
750: * columnar MDOC_BLOCK with or without a prior MDOC_BLOCK entry
751: * (a MDOC_BODY means it's already open, in which case we should
752: * process within its context in the normal way).
753: */
754:
755: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.75 schwarze 756: LIST_column == n->norm->Bl.type) {
1.56 schwarze 757: /* `Bl' is open without any children. */
1.93 schwarze 758: mdoc->flags |= MDOC_FREECOL;
759: return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
1.56 schwarze 760: }
761:
762: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
763: NULL != n->parent &&
764: MDOC_Bl == n->parent->tok &&
1.75 schwarze 765: LIST_column == n->parent->norm->Bl.type) {
1.56 schwarze 766: /* `Bl' has block-level `It' children. */
1.93 schwarze 767: mdoc->flags |= MDOC_FREECOL;
768: return(mdoc_macro(mdoc, MDOC_It, line, offs, &offs, buf));
1.56 schwarze 769: }
770:
1.52 schwarze 771: /*
772: * Search for the beginning of unescaped trailing whitespace (ws)
773: * and for the first character not to be output (end).
774: */
1.56 schwarze 775:
776: /* FIXME: replace with strcspn(). */
1.52 schwarze 777: ws = NULL;
1.53 schwarze 778: for (c = end = buf + offs; *c; c++) {
1.52 schwarze 779: switch (*c) {
780: case ' ':
781: if (NULL == ws)
782: ws = c;
783: continue;
784: case '\t':
785: /*
786: * Always warn about trailing tabs,
787: * even outside literal context,
788: * where they should be put on the next line.
789: */
790: if (NULL == ws)
791: ws = c;
792: /*
793: * Strip trailing tabs in literal context only;
794: * outside, they affect the next line.
795: */
1.93 schwarze 796: if (MDOC_LITERAL & mdoc->flags)
1.52 schwarze 797: continue;
798: break;
799: case '\\':
800: /* Skip the escaped character, too, if any. */
801: if (c[1])
802: c++;
803: /* FALLTHROUGH */
804: default:
805: ws = NULL;
806: break;
807: }
808: end = c + 1;
809: }
810: *end = '\0';
1.19 schwarze 811:
1.52 schwarze 812: if (ws)
1.93 schwarze 813: mdoc_pmsg(mdoc, line, (int)(ws-buf), MANDOCERR_EOLNSPACE);
1.34 schwarze 814:
1.93 schwarze 815: if ('\0' == buf[offs] && ! (MDOC_LITERAL & mdoc->flags)) {
816: mdoc_pmsg(mdoc, line, (int)(c-buf), MANDOCERR_NOBLANKLN);
1.46 schwarze 817:
1.40 schwarze 818: /*
1.66 schwarze 819: * Insert a `sp' in the case of a blank line. Technically,
1.46 schwarze 820: * blank lines aren't allowed, but enough manuals assume this
821: * behaviour that we want to work around it.
1.40 schwarze 822: */
1.93 schwarze 823: if ( ! mdoc_elem_alloc(mdoc, line, offs, MDOC_sp, NULL))
1.42 schwarze 824: return(0);
1.46 schwarze 825:
1.93 schwarze 826: mdoc->next = MDOC_NEXT_SIBLING;
1.89 schwarze 827:
1.93 schwarze 828: return(mdoc_valid_post(mdoc));
1.38 schwarze 829: }
1.1 kristaps 830:
1.93 schwarze 831: if ( ! mdoc_word_alloc(mdoc, line, offs, buf+offs))
1.1 kristaps 832: return(0);
833:
1.93 schwarze 834: if (MDOC_LITERAL & mdoc->flags)
1.52 schwarze 835: return(1);
836:
1.35 schwarze 837: /*
1.48 schwarze 838: * End-of-sentence check. If the last character is an unescaped
839: * EOS character, then flag the node as being the end of a
840: * sentence. The front-end will know how to interpret this.
1.35 schwarze 841: */
842:
1.52 schwarze 843: assert(buf < end);
1.48 schwarze 844:
1.97 ! schwarze 845: if (mandoc_eos(buf+offs, (size_t)(end-buf-offs)))
1.93 schwarze 846: mdoc->last->flags |= MDOC_EOS;
1.48 schwarze 847:
1.1 kristaps 848: return(1);
849: }
1.19 schwarze 850:
1.1 kristaps 851:
852: /*
853: * Parse a macro line, that is, a line beginning with the control
854: * character.
855: */
1.61 schwarze 856: static int
1.93 schwarze 857: mdoc_pmacro(struct mdoc *mdoc, int ln, char *buf, int offs)
1.1 kristaps 858: {
1.56 schwarze 859: enum mdoct tok;
1.83 schwarze 860: int i, sv;
1.56 schwarze 861: char mac[5];
862: struct mdoc_node *n;
1.1 kristaps 863:
1.83 schwarze 864: /* Empty post-control lines are ignored. */
1.1 kristaps 865:
1.83 schwarze 866: if ('"' == buf[offs]) {
1.93 schwarze 867: mdoc_pmsg(mdoc, ln, offs, MANDOCERR_BADCOMMENT);
1.83 schwarze 868: return(1);
869: } else if ('\0' == buf[offs])
1.1 kristaps 870: return(1);
871:
1.83 schwarze 872: sv = offs;
1.47 schwarze 873:
1.63 schwarze 874: /*
1.64 schwarze 875: * Copy the first word into a nil-terminated buffer.
876: * Stop copying when a tab, space, or eoln is encountered.
1.63 schwarze 877: */
1.1 kristaps 878:
1.83 schwarze 879: i = 0;
880: while (i < 4 && '\0' != buf[offs] &&
881: ' ' != buf[offs] && '\t' != buf[offs])
882: mac[i++] = buf[offs++];
883:
884: mac[i] = '\0';
885:
886: tok = (i > 1 || i < 4) ? mdoc_hash_find(mac) : MDOC_MAX;
1.1 kristaps 887:
1.65 schwarze 888: if (MDOC_MAX == tok) {
1.93 schwarze 889: mandoc_vmsg(MANDOCERR_MACRO, mdoc->parse,
1.83 schwarze 890: ln, sv, "%s", buf + sv - 1);
1.1 kristaps 891: return(1);
892: }
893:
1.63 schwarze 894: /* Disregard the first trailing tab, if applicable. */
895:
1.83 schwarze 896: if ('\t' == buf[offs])
897: offs++;
1.63 schwarze 898:
899: /* Jump to the next non-whitespace word. */
1.1 kristaps 900:
1.83 schwarze 901: while (buf[offs] && ' ' == buf[offs])
902: offs++;
1.34 schwarze 903:
1.46 schwarze 904: /*
905: * Trailing whitespace. Note that tabs are allowed to be passed
906: * into the parser as "text", so we only warn about spaces here.
907: */
1.34 schwarze 908:
1.83 schwarze 909: if ('\0' == buf[offs] && ' ' == buf[offs - 1])
1.93 schwarze 910: mdoc_pmsg(mdoc, ln, offs - 1, MANDOCERR_EOLNSPACE);
1.1 kristaps 911:
1.56 schwarze 912: /*
913: * If an initial macro or a list invocation, divert directly
914: * into macro processing.
915: */
916:
1.93 schwarze 917: if (NULL == mdoc->last || MDOC_It == tok || MDOC_El == tok) {
918: if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
1.56 schwarze 919: goto err;
920: return(1);
921: }
922:
1.93 schwarze 923: n = mdoc->last;
924: assert(mdoc->last);
1.56 schwarze 925:
926: /*
927: * If the first macro of a `Bl -column', open an `It' block
928: * context around the parsed macro.
929: */
930:
931: if (MDOC_Bl == n->tok && MDOC_BODY == n->type &&
1.75 schwarze 932: LIST_column == n->norm->Bl.type) {
1.93 schwarze 933: mdoc->flags |= MDOC_FREECOL;
934: if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf))
1.56 schwarze 935: goto err;
936: return(1);
937: }
938:
939: /*
940: * If we're following a block-level `It' within a `Bl -column'
941: * context (perhaps opened in the above block or in ptext()),
942: * then open an `It' block context around the parsed macro.
1.24 schwarze 943: */
1.56 schwarze 944:
945: if (MDOC_It == n->tok && MDOC_BLOCK == n->type &&
946: NULL != n->parent &&
947: MDOC_Bl == n->parent->tok &&
1.75 schwarze 948: LIST_column == n->parent->norm->Bl.type) {
1.93 schwarze 949: mdoc->flags |= MDOC_FREECOL;
950: if ( ! mdoc_macro(mdoc, MDOC_It, ln, sv, &sv, buf))
1.56 schwarze 951: goto err;
952: return(1);
953: }
954:
955: /* Normal processing of a macro. */
956:
1.93 schwarze 957: if ( ! mdoc_macro(mdoc, tok, ln, sv, &offs, buf))
1.1 kristaps 958: goto err;
959:
960: return(1);
961:
962: err: /* Error out. */
963:
1.93 schwarze 964: mdoc->flags |= MDOC_HALT;
1.1 kristaps 965: return(0);
966: }
1.24 schwarze 967:
1.83 schwarze 968: enum mdelim
969: mdoc_isdelim(const char *p)
970: {
971:
972: if ('\0' == p[0])
973: return(DELIM_NONE);
974:
975: if ('\0' == p[1])
976: switch (p[0]) {
977: case('('):
978: /* FALLTHROUGH */
979: case('['):
980: return(DELIM_OPEN);
981: case('|'):
982: return(DELIM_MIDDLE);
983: case('.'):
984: /* FALLTHROUGH */
985: case(','):
986: /* FALLTHROUGH */
987: case(';'):
988: /* FALLTHROUGH */
989: case(':'):
990: /* FALLTHROUGH */
991: case('?'):
992: /* FALLTHROUGH */
993: case('!'):
994: /* FALLTHROUGH */
995: case(')'):
996: /* FALLTHROUGH */
997: case(']'):
998: return(DELIM_CLOSE);
999: default:
1000: return(DELIM_NONE);
1001: }
1002:
1003: if ('\\' != p[0])
1004: return(DELIM_NONE);
1.24 schwarze 1005:
1.83 schwarze 1006: if (0 == strcmp(p + 1, "."))
1007: return(DELIM_CLOSE);
1.90 schwarze 1008: if (0 == strcmp(p + 1, "fR|\\fP"))
1.83 schwarze 1009: return(DELIM_MIDDLE);
1010:
1011: return(DELIM_NONE);
1012: }
![[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