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