Annotation of mandoc/mdoc.c, Revision 1.135
1.135 ! kristaps 1: /* $Id: mdoc.c,v 1.134 2010/05/16 00:04:46 kristaps Exp $ */
1.1 kristaps 2: /*
1.76 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.75 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.75 kristaps 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 16: */
1.114 kristaps 17: #ifdef HAVE_CONFIG_H
18: #include "config.h"
19: #endif
20:
1.106 kristaps 21: #include <sys/types.h>
22:
1.1 kristaps 23: #include <assert.h>
24: #include <ctype.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.70 kristaps 31: #include "libmdoc.h"
1.113 kristaps 32: #include "libmandoc.h"
1.1 kristaps 33:
1.89 kristaps 34: const char *const __mdoc_merrnames[MERRMAX] = {
35: "trailing whitespace", /* ETAILWS */
36: "unexpected quoted parameter", /* EQUOTPARM */
37: "unterminated quoted parameter", /* EQUOTTERM */
38: "argument parameter suggested", /* EARGVAL */
39: "macro disallowed in prologue", /* EBODYPROL */
40: "macro disallowed in body", /* EPROLBODY */
41: "text disallowed in prologue", /* ETEXTPROL */
42: "blank line disallowed", /* ENOBLANK */
43: "text parameter too long", /* ETOOLONG */
44: "invalid escape sequence", /* EESCAPE */
45: "invalid character", /* EPRINT */
46: "document has no body", /* ENODAT */
47: "document has no prologue", /* ENOPROLOGUE */
48: "expected line arguments", /* ELINE */
49: "invalid AT&T argument", /* EATT */
50: "default name not yet set", /* ENAME */
51: "missing list type", /* ELISTTYPE */
52: "missing display type", /* EDISPTYPE */
53: "too many display types", /* EMULTIDISP */
54: "too many list types", /* EMULTILIST */
55: "NAME section must be first", /* ESECNAME */
56: "badly-formed NAME section", /* ENAMESECINC */
57: "argument repeated", /* EARGREP */
58: "expected boolean parameter", /* EBOOL */
59: "inconsistent column syntax", /* ECOLMIS */
60: "nested display invalid", /* ENESTDISP */
61: "width argument missing", /* EMISSWIDTH */
62: "invalid section for this manual section", /* EWRONGMSEC */
63: "section out of conventional order", /* ESECOOO */
64: "section repeated", /* ESECREP */
65: "invalid standard argument", /* EBADSTAND */
66: "multi-line arguments discouraged", /* ENOMULTILINE */
67: "multi-line arguments suggested", /* EMULTILINE */
68: "line arguments discouraged", /* ENOLINE */
69: "prologue macro out of conventional order", /* EPROLOOO */
70: "prologue macro repeated", /* EPROLREP */
1.133 kristaps 71: "invalid manual section", /* EBADMSEC */
1.89 kristaps 72: "invalid font mode", /* EFONT */
73: "invalid date syntax", /* EBADDATE */
74: "invalid number format", /* ENUMFMT */
75: "superfluous width argument", /* ENOWIDTH */
76: "system: utsname error", /* EUTSNAME */
77: "obsolete macro", /* EOBS */
78: "end-of-line scope violation", /* EIMPBRK */
79: "empty macro ignored", /* EIGNE */
80: "unclosed explicit scope", /* EOPEN */
81: "unterminated quoted phrase", /* EQUOTPHR */
82: "closure macro without prior context", /* ENOCTX */
1.107 kristaps 83: "no description found for library", /* ELIB */
84: "bad child for parent context", /* EBADCHILD */
1.109 kristaps 85: "list arguments preceding type", /* ENOTYPE */
1.123 kristaps 86: "deprecated comment style", /* EBADCOMMENT */
1.89 kristaps 87: };
88:
1.1 kristaps 89: const char *const __mdoc_macronames[MDOC_MAX] = {
1.82 kristaps 90: "Ap", "Dd", "Dt", "Os",
1.1 kristaps 91: "Sh", "Ss", "Pp", "D1",
92: "Dl", "Bd", "Ed", "Bl",
93: "El", "It", "Ad", "An",
94: "Ar", "Cd", "Cm", "Dv",
95: "Er", "Ev", "Ex", "Fa",
96: "Fd", "Fl", "Fn", "Ft",
97: "Ic", "In", "Li", "Nd",
98: "Nm", "Op", "Ot", "Pa",
99: "Rv", "St", "Va", "Vt",
100: /* LINTED */
1.114 kristaps 101: "Xr", "%A", "%B", "%D",
1.1 kristaps 102: /* LINTED */
1.114 kristaps 103: "%I", "%J", "%N", "%O",
1.1 kristaps 104: /* LINTED */
1.114 kristaps 105: "%P", "%R", "%T", "%V",
1.1 kristaps 106: "Ac", "Ao", "Aq", "At",
107: "Bc", "Bf", "Bo", "Bq",
108: "Bsx", "Bx", "Db", "Dc",
109: "Do", "Dq", "Ec", "Ef",
110: "Em", "Eo", "Fx", "Ms",
111: "No", "Ns", "Nx", "Ox",
112: "Pc", "Pf", "Po", "Pq",
113: "Qc", "Ql", "Qo", "Qq",
114: "Re", "Rs", "Sc", "So",
115: "Sq", "Sm", "Sx", "Sy",
116: "Tn", "Ux", "Xc", "Xo",
117: "Fo", "Fc", "Oo", "Oc",
118: "Bk", "Ek", "Bt", "Hf",
1.82 kristaps 119: "Fr", "Ud", "Lb", "Lp",
120: "Lk", "Mt", "Brq", "Bro",
1.64 kristaps 121: /* LINTED */
1.114 kristaps 122: "Brc", "%C", "Es", "En",
1.69 kristaps 123: /* LINTED */
1.114 kristaps 124: "Dx", "%Q", "br", "sp",
1.110 kristaps 125: /* LINTED */
1.114 kristaps 126: "%U"
1.1 kristaps 127: };
128:
129: const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
130: "split", "nosplit", "ragged",
131: "unfilled", "literal", "file",
132: "offset", "bullet", "dash",
133: "hyphen", "item", "enum",
134: "tag", "diag", "hang",
135: "ohang", "inset", "column",
136: "width", "compact", "std",
1.52 kristaps 137: "filled", "words", "emphasis",
1.108 kristaps 138: "symbolic", "nested", "centered"
1.1 kristaps 139: };
140:
141: const char * const *mdoc_macronames = __mdoc_macronames;
142: const char * const *mdoc_argnames = __mdoc_argnames;
143:
1.121 kristaps 144: static void mdoc_node_free(struct mdoc_node *);
145: static void mdoc_node_unlink(struct mdoc *,
146: struct mdoc_node *);
1.73 kristaps 147: static void mdoc_free1(struct mdoc *);
1.113 kristaps 148: static void mdoc_alloc1(struct mdoc *);
1.73 kristaps 149: static struct mdoc_node *node_alloc(struct mdoc *, int, int,
1.117 kristaps 150: enum mdoct, enum mdoc_type);
1.73 kristaps 151: static int node_append(struct mdoc *,
1.71 kristaps 152: struct mdoc_node *);
1.135 ! kristaps 153: static int mdoc_ptext(struct mdoc *, int, char *, int);
! 154: static int mdoc_pmacro(struct mdoc *, int, char *, int);
! 155: static int macrowarn(struct mdoc *, int,
! 156: const char *, int);
1.124 kristaps 157:
1.88 kristaps 158:
1.1 kristaps 159: const struct mdoc_node *
1.71 kristaps 160: mdoc_node(const struct mdoc *m)
1.1 kristaps 161: {
162:
1.71 kristaps 163: return(MDOC_HALT & m->flags ? NULL : m->first);
1.1 kristaps 164: }
165:
166:
1.37 kristaps 167: const struct mdoc_meta *
1.71 kristaps 168: mdoc_meta(const struct mdoc *m)
1.37 kristaps 169: {
170:
1.71 kristaps 171: return(MDOC_HALT & m->flags ? NULL : &m->meta);
1.37 kristaps 172: }
173:
174:
1.85 kristaps 175: /*
176: * Frees volatile resources (parse tree, meta-data, fields).
177: */
1.73 kristaps 178: static void
179: mdoc_free1(struct mdoc *mdoc)
1.67 kristaps 180: {
181:
182: if (mdoc->first)
1.121 kristaps 183: mdoc_node_delete(mdoc, mdoc->first);
1.67 kristaps 184: if (mdoc->meta.title)
185: free(mdoc->meta.title);
186: if (mdoc->meta.os)
187: free(mdoc->meta.os);
188: if (mdoc->meta.name)
189: free(mdoc->meta.name);
190: if (mdoc->meta.arch)
191: free(mdoc->meta.arch);
192: if (mdoc->meta.vol)
193: free(mdoc->meta.vol);
1.133 kristaps 194: if (mdoc->meta.msec)
195: free(mdoc->meta.msec);
1.73 kristaps 196: }
197:
198:
1.85 kristaps 199: /*
200: * Allocate all volatile resources (parse tree, meta-data, fields).
201: */
1.113 kristaps 202: static void
1.73 kristaps 203: mdoc_alloc1(struct mdoc *mdoc)
204: {
1.67 kristaps 205:
1.112 kristaps 206: memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
1.67 kristaps 207: mdoc->flags = 0;
1.85 kristaps 208: mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.113 kristaps 209: mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
1.70 kristaps 210: mdoc->first = mdoc->last;
1.67 kristaps 211: mdoc->last->type = MDOC_ROOT;
212: mdoc->next = MDOC_NEXT_CHILD;
1.73 kristaps 213: }
214:
215:
216: /*
1.85 kristaps 217: * Free up volatile resources (see mdoc_free1()) then re-initialises the
218: * data with mdoc_alloc1(). After invocation, parse data has been reset
219: * and the parser is ready for re-invocation on a new tree; however,
220: * cross-parse non-volatile data is kept intact.
1.73 kristaps 221: */
1.113 kristaps 222: void
1.73 kristaps 223: mdoc_reset(struct mdoc *mdoc)
224: {
225:
226: mdoc_free1(mdoc);
1.113 kristaps 227: mdoc_alloc1(mdoc);
1.67 kristaps 228: }
229:
230:
1.68 kristaps 231: /*
1.85 kristaps 232: * Completely free up all volatile and non-volatile parse resources.
233: * After invocation, the pointer is no longer usable.
1.68 kristaps 234: */
1.67 kristaps 235: void
1.38 kristaps 236: mdoc_free(struct mdoc *mdoc)
1.34 kristaps 237: {
238:
1.73 kristaps 239: mdoc_free1(mdoc);
1.1 kristaps 240: free(mdoc);
241: }
242:
243:
1.85 kristaps 244: /*
245: * Allocate volatile and non-volatile parse resources.
246: */
1.1 kristaps 247: struct mdoc *
1.55 kristaps 248: mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
1.1 kristaps 249: {
250: struct mdoc *p;
251:
1.113 kristaps 252: p = mandoc_calloc(1, sizeof(struct mdoc));
253:
1.74 kristaps 254: if (cb)
1.113 kristaps 255: memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
1.105 kristaps 256:
1.1 kristaps 257: p->data = data;
1.73 kristaps 258: p->pflags = pflags;
259:
1.113 kristaps 260: mdoc_hash_init();
261: mdoc_alloc1(p);
262: return(p);
1.1 kristaps 263: }
264:
265:
1.68 kristaps 266: /*
267: * Climb back up the parse tree, validating open scopes. Mostly calls
1.85 kristaps 268: * through to macro_end() in macro.c.
1.68 kristaps 269: */
1.1 kristaps 270: int
1.72 kristaps 271: mdoc_endparse(struct mdoc *m)
1.20 kristaps 272: {
273:
1.72 kristaps 274: if (MDOC_HALT & m->flags)
1.20 kristaps 275: return(0);
1.72 kristaps 276: else if (mdoc_macroend(m))
1.20 kristaps 277: return(1);
1.72 kristaps 278: m->flags |= MDOC_HALT;
279: return(0);
1.20 kristaps 280: }
281:
282:
1.50 kristaps 283: /*
1.53 kristaps 284: * Main parse routine. Parses a single line -- really just hands off to
1.123 kristaps 285: * the macro (mdoc_pmacro()) or text parser (mdoc_ptext()).
1.50 kristaps 286: */
1.20 kristaps 287: int
1.135 ! kristaps 288: mdoc_parseln(struct mdoc *m, int ln, char *buf, int offs)
1.1 kristaps 289: {
290:
1.53 kristaps 291: if (MDOC_HALT & m->flags)
1.20 kristaps 292: return(0);
1.50 kristaps 293:
1.130 kristaps 294: m->flags |= MDOC_NEWLINE;
1.135 ! kristaps 295: return(('.' == buf[offs] || '\'' == buf[offs]) ?
! 296: mdoc_pmacro(m, ln, buf, offs) :
! 297: mdoc_ptext(m, ln, buf, offs));
1.1 kristaps 298: }
299:
300:
301: int
1.31 kristaps 302: mdoc_verr(struct mdoc *mdoc, int ln, int pos,
303: const char *fmt, ...)
1.1 kristaps 304: {
1.31 kristaps 305: char buf[256];
306: va_list ap;
1.1 kristaps 307:
308: if (NULL == mdoc->cb.mdoc_err)
309: return(0);
1.31 kristaps 310:
311: va_start(ap, fmt);
312: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
313: va_end(ap);
1.88 kristaps 314:
1.31 kristaps 315: return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
1.1 kristaps 316: }
317:
318:
319: int
1.87 kristaps 320: mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
1.1 kristaps 321: {
1.31 kristaps 322: char buf[256];
323: va_list ap;
1.1 kristaps 324:
325: if (NULL == mdoc->cb.mdoc_warn)
326: return(0);
1.31 kristaps 327:
328: va_start(ap, fmt);
329: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
330: va_end(ap);
1.88 kristaps 331:
1.87 kristaps 332: return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));
1.1 kristaps 333: }
334:
335:
336: int
1.88 kristaps 337: mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)
1.78 kristaps 338: {
1.89 kristaps 339: const char *p;
1.88 kristaps 340:
1.89 kristaps 341: p = __mdoc_merrnames[(int)type];
1.73 kristaps 342: assert(p);
1.88 kristaps 343:
344: if (iserr)
345: return(mdoc_verr(m, line, pos, p));
346:
347: return(mdoc_vwarn(m, line, pos, p));
348: }
349:
350:
351: int
1.117 kristaps 352: mdoc_macro(struct mdoc *m, enum mdoct tok,
1.88 kristaps 353: int ln, int pp, int *pos, char *buf)
354: {
1.122 kristaps 355: assert(tok < MDOC_MAX);
356:
357: /* If we're in the body, deny prologue calls. */
1.117 kristaps 358:
1.88 kristaps 359: if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.122 kristaps 360: MDOC_PBODY & m->flags)
361: return(mdoc_perr(m, ln, pp, EPROLBODY));
362:
363: /* If we're in the prologue, deny "body" macros. */
364:
365: if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
366: ! (MDOC_PBODY & m->flags)) {
1.120 kristaps 367: if ( ! mdoc_pwarn(m, ln, pp, EBODYPROL))
368: return(0);
369: if (NULL == m->meta.title)
370: m->meta.title = mandoc_strdup("unknown");
371: if (NULL == m->meta.vol)
372: m->meta.vol = mandoc_strdup("local");
373: if (NULL == m->meta.os)
374: m->meta.os = mandoc_strdup("local");
375: if (0 == m->meta.date)
376: m->meta.date = time(NULL);
377: m->flags |= MDOC_PBODY;
378: }
1.88 kristaps 379:
380: return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
1.73 kristaps 381: }
382:
383:
384: static int
385: node_append(struct mdoc *mdoc, struct mdoc_node *p)
1.1 kristaps 386: {
387:
1.25 kristaps 388: assert(mdoc->last);
389: assert(mdoc->first);
390: assert(MDOC_ROOT != p->type);
1.1 kristaps 391:
1.13 kristaps 392: switch (mdoc->next) {
393: case (MDOC_NEXT_SIBLING):
1.6 kristaps 394: mdoc->last->next = p;
395: p->prev = mdoc->last;
1.13 kristaps 396: p->parent = mdoc->last->parent;
1.1 kristaps 397: break;
1.13 kristaps 398: case (MDOC_NEXT_CHILD):
399: mdoc->last->child = p;
1.1 kristaps 400: p->parent = mdoc->last;
401: break;
402: default:
1.13 kristaps 403: abort();
404: /* NOTREACHED */
1.1 kristaps 405: }
406:
1.86 kristaps 407: p->parent->nchild++;
408:
1.23 kristaps 409: if ( ! mdoc_valid_pre(mdoc, p))
410: return(0);
1.68 kristaps 411: if ( ! mdoc_action_pre(mdoc, p))
412: return(0);
1.27 kristaps 413:
414: switch (p->type) {
415: case (MDOC_HEAD):
416: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 417: p->parent->head = p;
1.27 kristaps 418: break;
419: case (MDOC_TAIL):
420: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 421: p->parent->tail = p;
1.27 kristaps 422: break;
423: case (MDOC_BODY):
424: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 425: p->parent->body = p;
1.27 kristaps 426: break;
427: default:
428: break;
429: }
430:
1.1 kristaps 431: mdoc->last = p;
1.71 kristaps 432:
433: switch (p->type) {
434: case (MDOC_TEXT):
435: if ( ! mdoc_valid_post(mdoc))
436: return(0);
437: if ( ! mdoc_action_post(mdoc))
438: return(0);
439: break;
440: default:
441: break;
442: }
443:
1.23 kristaps 444: return(1);
1.1 kristaps 445: }
446:
447:
1.45 kristaps 448: static struct mdoc_node *
1.117 kristaps 449: node_alloc(struct mdoc *m, int line, int pos,
450: enum mdoct tok, enum mdoc_type type)
1.45 kristaps 451: {
1.46 kristaps 452: struct mdoc_node *p;
453:
1.113 kristaps 454: p = mandoc_calloc(1, sizeof(struct mdoc_node));
1.91 kristaps 455: p->sec = m->lastsec;
1.73 kristaps 456: p->line = line;
457: p->pos = pos;
458: p->tok = tok;
1.118 kristaps 459: p->type = type;
1.130 kristaps 460: if (MDOC_NEWLINE & m->flags)
461: p->flags |= MDOC_LINE;
462: m->flags &= ~MDOC_NEWLINE;
1.46 kristaps 463: return(p);
1.45 kristaps 464: }
465:
466:
1.23 kristaps 467: int
1.117 kristaps 468: mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.17 kristaps 469: {
470: struct mdoc_node *p;
471:
1.91 kristaps 472: p = node_alloc(m, line, pos, tok, MDOC_TAIL);
1.102 kristaps 473: if ( ! node_append(m, p))
474: return(0);
475: m->next = MDOC_NEXT_CHILD;
476: return(1);
1.17 kristaps 477: }
478:
479:
1.23 kristaps 480: int
1.117 kristaps 481: mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1 kristaps 482: {
483: struct mdoc_node *p;
484:
1.91 kristaps 485: assert(m->first);
486: assert(m->last);
1.1 kristaps 487:
1.91 kristaps 488: p = node_alloc(m, line, pos, tok, MDOC_HEAD);
1.102 kristaps 489: if ( ! node_append(m, p))
490: return(0);
491: m->next = MDOC_NEXT_CHILD;
492: return(1);
1.1 kristaps 493: }
494:
495:
1.23 kristaps 496: int
1.117 kristaps 497: mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1 kristaps 498: {
499: struct mdoc_node *p;
500:
1.91 kristaps 501: p = node_alloc(m, line, pos, tok, MDOC_BODY);
1.102 kristaps 502: if ( ! node_append(m, p))
503: return(0);
504: m->next = MDOC_NEXT_CHILD;
505: return(1);
1.1 kristaps 506: }
507:
508:
1.23 kristaps 509: int
1.91 kristaps 510: mdoc_block_alloc(struct mdoc *m, int line, int pos,
1.117 kristaps 511: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 512: {
513: struct mdoc_node *p;
514:
1.91 kristaps 515: p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
1.77 kristaps 516: p->args = args;
517: if (p->args)
1.53 kristaps 518: (args->refcnt)++;
1.102 kristaps 519: if ( ! node_append(m, p))
520: return(0);
521: m->next = MDOC_NEXT_CHILD;
522: return(1);
1.1 kristaps 523: }
524:
525:
1.23 kristaps 526: int
1.91 kristaps 527: mdoc_elem_alloc(struct mdoc *m, int line, int pos,
1.117 kristaps 528: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 529: {
530: struct mdoc_node *p;
531:
1.91 kristaps 532: p = node_alloc(m, line, pos, tok, MDOC_ELEM);
1.77 kristaps 533: p->args = args;
534: if (p->args)
1.53 kristaps 535: (args->refcnt)++;
1.102 kristaps 536: if ( ! node_append(m, p))
537: return(0);
538: m->next = MDOC_NEXT_CHILD;
539: return(1);
1.1 kristaps 540: }
541:
542:
1.124 kristaps 543: int
544: mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
1.1 kristaps 545: {
1.91 kristaps 546: struct mdoc_node *n;
1.124 kristaps 547: size_t sv, len;
548:
549: len = strlen(p);
1.1 kristaps 550:
1.125 kristaps 551: n = node_alloc(m, line, pos, MDOC_MAX, MDOC_TEXT);
1.113 kristaps 552: n->string = mandoc_malloc(len + 1);
1.91 kristaps 553: sv = strlcpy(n->string, p, len + 1);
554:
555: /* Prohibit truncation. */
556: assert(sv < len + 1);
557:
1.101 kristaps 558: if ( ! node_append(m, n))
559: return(0);
1.124 kristaps 560:
1.101 kristaps 561: m->next = MDOC_NEXT_SIBLING;
562: return(1);
1.91 kristaps 563: }
564:
565:
1.53 kristaps 566: void
567: mdoc_node_free(struct mdoc_node *p)
1.1 kristaps 568: {
569:
1.53 kristaps 570: if (p->string)
571: free(p->string);
572: if (p->args)
573: mdoc_argv_free(p->args);
1.1 kristaps 574: free(p);
575: }
576:
577:
1.121 kristaps 578: static void
579: mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
580: {
581:
582: /* Adjust siblings. */
583:
584: if (n->prev)
585: n->prev->next = n->next;
586: if (n->next)
587: n->next->prev = n->prev;
588:
589: /* Adjust parent. */
590:
591: if (n->parent) {
592: n->parent->nchild--;
593: if (n->parent->child == n)
594: n->parent->child = n->prev ? n->prev : n->next;
595: }
596:
597: /* Adjust parse point, if applicable. */
598:
599: if (m && m->last == n) {
600: if (n->prev) {
601: m->last = n->prev;
602: m->next = MDOC_NEXT_SIBLING;
603: } else {
604: m->last = n->parent;
605: m->next = MDOC_NEXT_CHILD;
606: }
607: }
608:
609: if (m && m->first == n)
610: m->first = NULL;
611: }
612:
613:
1.53 kristaps 614: void
1.121 kristaps 615: mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
1.1 kristaps 616: {
617:
1.121 kristaps 618: while (p->child) {
619: assert(p->nchild);
620: mdoc_node_delete(m, p->child);
621: }
622: assert(0 == p->nchild);
1.1 kristaps 623:
1.121 kristaps 624: mdoc_node_unlink(m, p);
1.53 kristaps 625: mdoc_node_free(p);
1.1 kristaps 626: }
627:
628:
1.53 kristaps 629: /*
630: * Parse free-form text, that is, a line that does not begin with the
631: * control character.
632: */
633: static int
1.135 ! kristaps 634: mdoc_ptext(struct mdoc *m, int line, char *buf, int offs)
1.1 kristaps 635: {
1.124 kristaps 636: int i;
1.1 kristaps 637:
1.123 kristaps 638: /* Ignore bogus comments. */
639:
1.135 ! kristaps 640: if ('\\' == buf[offs] &&
! 641: '.' == buf[offs + 1] &&
! 642: '"' == buf[offs + 2])
! 643: return(mdoc_pwarn(m, line, offs, EBADCOMMENT));
1.123 kristaps 644:
1.124 kristaps 645: /* No text before an initial macro. */
646:
1.85 kristaps 647: if (SEC_NONE == m->lastnamed)
1.135 ! kristaps 648: return(mdoc_perr(m, line, offs, ETEXTPROL));
1.124 kristaps 649:
650: /* Literal just gets pulled in as-is. */
1.91 kristaps 651:
1.101 kristaps 652: if (MDOC_LITERAL & m->flags)
1.135 ! kristaps 653: return(mdoc_word_alloc(m, line, offs, buf + offs));
1.91 kristaps 654:
1.124 kristaps 655: /* Check for a blank line, which may also consist of spaces. */
1.1 kristaps 656:
1.135 ! kristaps 657: for (i = offs; ' ' == buf[i]; i++)
1.124 kristaps 658: /* Skip to first non-space. */ ;
1.115 kristaps 659:
1.119 kristaps 660: if ('\0' == buf[i]) {
1.135 ! kristaps 661: if ( ! mdoc_pwarn(m, line, offs, ENOBLANK))
1.119 kristaps 662: return(0);
1.124 kristaps 663:
1.119 kristaps 664: /*
1.124 kristaps 665: * Insert a `Pp' in the case of a blank line. Technically,
666: * blank lines aren't allowed, but enough manuals assume this
667: * behaviour that we want to work around it.
1.119 kristaps 668: */
1.135 ! kristaps 669: if ( ! mdoc_elem_alloc(m, line, offs, MDOC_Pp, NULL))
1.119 kristaps 670: return(0);
1.124 kristaps 671:
672: m->next = MDOC_NEXT_SIBLING;
673: return(1);
1.119 kristaps 674: }
1.68 kristaps 675:
1.126 kristaps 676: /*
677: * Warn if the last un-escaped character is whitespace. Then
678: * strip away the remaining spaces (tabs stay!).
679: */
1.91 kristaps 680:
1.124 kristaps 681: i = (int)strlen(buf);
682: assert(i);
1.116 kristaps 683:
1.126 kristaps 684: if (' ' == buf[i - 1] || '\t' == buf[i - 1]) {
1.127 kristaps 685: if (i > 1 && '\\' != buf[i - 2])
1.116 kristaps 686: if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
687: return(0);
1.126 kristaps 688:
689: for (--i; i && ' ' == buf[i]; i--)
690: /* Spin back to non-space. */ ;
691:
692: /* Jump ahead of escaped whitespace. */
693: i += '\\' == buf[i] ? 2 : 1;
694:
695: buf[i] = '\0';
696: }
1.116 kristaps 697:
1.124 kristaps 698: /* Allocate the whole word. */
1.1 kristaps 699:
1.135 ! kristaps 700: if ( ! mdoc_word_alloc(m, line, offs, buf + offs))
1.128 kristaps 701: return(0);
702:
703: /*
704: * End-of-sentence check. If the last character is an unescaped
705: * EOS character, then flag the node as being the end of a
706: * sentence. The front-end will know how to interpret this.
707: */
1.132 kristaps 708:
1.128 kristaps 709: assert(i);
1.129 kristaps 710: if (mandoc_eos(buf, (size_t)i))
1.128 kristaps 711: m->last->flags |= MDOC_EOS;
712:
713: return(1);
1.1 kristaps 714: }
715:
716:
1.58 kristaps 717: static int
1.135 ! kristaps 718: macrowarn(struct mdoc *m, int ln, const char *buf, int offs)
1.58 kristaps 719: {
720: if ( ! (MDOC_IGN_MACRO & m->pflags))
1.135 ! kristaps 721: return(mdoc_verr(m, ln, offs, "unknown macro: %s%s",
1.59 kristaps 722: buf, strlen(buf) > 3 ? "..." : ""));
1.135 ! kristaps 723: return(mdoc_vwarn(m, ln, offs, "unknown macro: %s%s",
1.59 kristaps 724: buf, strlen(buf) > 3 ? "..." : ""));
1.58 kristaps 725: }
726:
727:
1.53 kristaps 728: /*
729: * Parse a macro line, that is, a line beginning with the control
730: * character.
731: */
732: int
1.135 ! kristaps 733: mdoc_pmacro(struct mdoc *m, int ln, char *buf, int offs)
1.1 kristaps 734: {
1.125 kristaps 735: enum mdoct tok;
1.130 kristaps 736: int i, j, sv;
1.125 kristaps 737: char mac[5];
1.1 kristaps 738:
1.81 kristaps 739: /* Empty lines are ignored. */
1.63 kristaps 740:
1.135 ! kristaps 741: offs++;
! 742:
! 743: if ('\0' == buf[offs])
1.63 kristaps 744: return(1);
745:
1.135 ! kristaps 746: i = offs;
1.100 kristaps 747:
748: /* Accept whitespace after the initial control char. */
749:
750: if (' ' == buf[i]) {
751: i++;
1.65 kristaps 752: while (buf[i] && ' ' == buf[i])
1.63 kristaps 753: i++;
1.115 kristaps 754: if ('\0' == buf[i])
1.63 kristaps 755: return(1);
756: }
1.1 kristaps 757:
1.130 kristaps 758: sv = i;
759:
1.53 kristaps 760: /* Copy the first word into a nil-terminated buffer. */
1.1 kristaps 761:
1.100 kristaps 762: for (j = 0; j < 4; j++, i++) {
1.115 kristaps 763: if ('\0' == (mac[j] = buf[i]))
1.53 kristaps 764: break;
1.65 kristaps 765: else if (' ' == buf[i])
1.53 kristaps 766: break;
1.104 kristaps 767:
768: /* Check for invalid characters. */
769:
770: if (isgraph((u_char)buf[i]))
771: continue;
772: return(mdoc_perr(m, ln, i, EPRINT));
1.53 kristaps 773: }
1.1 kristaps 774:
1.135 ! kristaps 775: mac[j] = '\0';
1.1 kristaps 776:
1.100 kristaps 777: if (j == 4 || j < 2) {
1.135 ! kristaps 778: if ( ! macrowarn(m, ln, mac, sv))
1.58 kristaps 779: goto err;
780: return(1);
1.53 kristaps 781: }
782:
1.125 kristaps 783: if (MDOC_MAX == (tok = mdoc_hash_find(mac))) {
1.135 ! kristaps 784: if ( ! macrowarn(m, ln, mac, sv))
1.58 kristaps 785: goto err;
786: return(1);
1.53 kristaps 787: }
1.1 kristaps 788:
1.53 kristaps 789: /* The macro is sane. Jump to the next word. */
1.1 kristaps 790:
1.65 kristaps 791: while (buf[i] && ' ' == buf[i])
1.53 kristaps 792: i++;
1.1 kristaps 793:
1.125 kristaps 794: /*
795: * Trailing whitespace. Note that tabs are allowed to be passed
796: * into the parser as "text", so we only warn about spaces here.
797: */
1.115 kristaps 798:
799: if ('\0' == buf[i] && ' ' == buf[i - 1])
800: if ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS))
801: goto err;
802:
1.98 kristaps 803: /*
804: * Begin recursive parse sequence. Since we're at the start of
805: * the line, we don't need to do callable/parseable checks.
806: */
1.130 kristaps 807: if ( ! mdoc_macro(m, tok, ln, sv, &i, buf))
1.53 kristaps 808: goto err;
1.1 kristaps 809:
1.53 kristaps 810: return(1);
1.1 kristaps 811:
1.53 kristaps 812: err: /* Error out. */
1.1 kristaps 813:
1.53 kristaps 814: m->flags |= MDOC_HALT;
815: return(0);
1.1 kristaps 816: }
1.100 kristaps 817:
818:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc