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