Annotation of mandoc/mdoc.c, Revision 1.122
1.122 ! kristaps 1: /* $Id: mdoc.c,v 1.121 2010/04/06 11:33:00 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 */
71: "invalid manual section", /* EBADMSEC */
72: "invalid section", /* EBADSEC */
73: "invalid font mode", /* EFONT */
74: "invalid date syntax", /* EBADDATE */
75: "invalid number format", /* ENUMFMT */
76: "superfluous width argument", /* ENOWIDTH */
77: "system: utsname error", /* EUTSNAME */
78: "obsolete macro", /* EOBS */
79: "end-of-line scope violation", /* EIMPBRK */
80: "empty macro ignored", /* EIGNE */
81: "unclosed explicit scope", /* EOPEN */
82: "unterminated quoted phrase", /* EQUOTPHR */
83: "closure macro without prior context", /* ENOCTX */
1.107 kristaps 84: "no description found for library", /* ELIB */
85: "bad child for parent context", /* EBADCHILD */
1.109 kristaps 86: "list arguments preceding type", /* ENOTYPE */
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 *);
153: static int parsetext(struct mdoc *, int, char *);
154: static int parsemacro(struct mdoc *, int, char *);
155: static int macrowarn(struct mdoc *, int, const char *);
1.91 kristaps 156: static int pstring(struct mdoc *, int, int,
157: const char *, size_t);
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.73 kristaps 194: }
195:
196:
1.85 kristaps 197: /*
198: * Allocate all volatile resources (parse tree, meta-data, fields).
199: */
1.113 kristaps 200: static void
1.73 kristaps 201: mdoc_alloc1(struct mdoc *mdoc)
202: {
1.67 kristaps 203:
1.112 kristaps 204: memset(&mdoc->meta, 0, sizeof(struct mdoc_meta));
1.67 kristaps 205: mdoc->flags = 0;
1.85 kristaps 206: mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.113 kristaps 207: mdoc->last = mandoc_calloc(1, sizeof(struct mdoc_node));
1.70 kristaps 208: mdoc->first = mdoc->last;
1.67 kristaps 209: mdoc->last->type = MDOC_ROOT;
210: mdoc->next = MDOC_NEXT_CHILD;
1.73 kristaps 211: }
212:
213:
214: /*
1.85 kristaps 215: * Free up volatile resources (see mdoc_free1()) then re-initialises the
216: * data with mdoc_alloc1(). After invocation, parse data has been reset
217: * and the parser is ready for re-invocation on a new tree; however,
218: * cross-parse non-volatile data is kept intact.
1.73 kristaps 219: */
1.113 kristaps 220: void
1.73 kristaps 221: mdoc_reset(struct mdoc *mdoc)
222: {
223:
224: mdoc_free1(mdoc);
1.113 kristaps 225: mdoc_alloc1(mdoc);
1.67 kristaps 226: }
227:
228:
1.68 kristaps 229: /*
1.85 kristaps 230: * Completely free up all volatile and non-volatile parse resources.
231: * After invocation, the pointer is no longer usable.
1.68 kristaps 232: */
1.67 kristaps 233: void
1.38 kristaps 234: mdoc_free(struct mdoc *mdoc)
1.34 kristaps 235: {
236:
1.73 kristaps 237: mdoc_free1(mdoc);
1.1 kristaps 238: free(mdoc);
239: }
240:
241:
1.85 kristaps 242: /*
243: * Allocate volatile and non-volatile parse resources.
244: */
1.1 kristaps 245: struct mdoc *
1.55 kristaps 246: mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
1.1 kristaps 247: {
248: struct mdoc *p;
249:
1.113 kristaps 250: p = mandoc_calloc(1, sizeof(struct mdoc));
251:
1.74 kristaps 252: if (cb)
1.113 kristaps 253: memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
1.105 kristaps 254:
1.1 kristaps 255: p->data = data;
1.73 kristaps 256: p->pflags = pflags;
257:
1.113 kristaps 258: mdoc_hash_init();
259: mdoc_alloc1(p);
260: return(p);
1.1 kristaps 261: }
262:
263:
1.68 kristaps 264: /*
265: * Climb back up the parse tree, validating open scopes. Mostly calls
1.85 kristaps 266: * through to macro_end() in macro.c.
1.68 kristaps 267: */
1.1 kristaps 268: int
1.72 kristaps 269: mdoc_endparse(struct mdoc *m)
1.20 kristaps 270: {
271:
1.72 kristaps 272: if (MDOC_HALT & m->flags)
1.20 kristaps 273: return(0);
1.72 kristaps 274: else if (mdoc_macroend(m))
1.20 kristaps 275: return(1);
1.72 kristaps 276: m->flags |= MDOC_HALT;
277: return(0);
1.20 kristaps 278: }
279:
280:
1.50 kristaps 281: /*
1.53 kristaps 282: * Main parse routine. Parses a single line -- really just hands off to
1.85 kristaps 283: * the macro (parsemacro()) or text parser (parsetext()).
1.50 kristaps 284: */
1.20 kristaps 285: int
1.53 kristaps 286: mdoc_parseln(struct mdoc *m, int ln, char *buf)
1.1 kristaps 287: {
288:
1.53 kristaps 289: if (MDOC_HALT & m->flags)
1.20 kristaps 290: return(0);
1.50 kristaps 291:
1.53 kristaps 292: return('.' == *buf ? parsemacro(m, ln, buf) :
293: parsetext(m, ln, buf));
1.1 kristaps 294: }
295:
296:
297: int
1.31 kristaps 298: mdoc_verr(struct mdoc *mdoc, int ln, int pos,
299: const char *fmt, ...)
1.1 kristaps 300: {
1.31 kristaps 301: char buf[256];
302: va_list ap;
1.1 kristaps 303:
304: if (NULL == mdoc->cb.mdoc_err)
305: return(0);
1.31 kristaps 306:
307: va_start(ap, fmt);
308: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
309: va_end(ap);
1.88 kristaps 310:
1.31 kristaps 311: return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
1.1 kristaps 312: }
313:
314:
315: int
1.87 kristaps 316: mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
1.1 kristaps 317: {
1.31 kristaps 318: char buf[256];
319: va_list ap;
1.1 kristaps 320:
321: if (NULL == mdoc->cb.mdoc_warn)
322: return(0);
1.31 kristaps 323:
324: va_start(ap, fmt);
325: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
326: va_end(ap);
1.88 kristaps 327:
1.87 kristaps 328: return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));
1.1 kristaps 329: }
330:
331:
332: int
1.88 kristaps 333: mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)
1.78 kristaps 334: {
1.89 kristaps 335: const char *p;
1.88 kristaps 336:
1.89 kristaps 337: p = __mdoc_merrnames[(int)type];
1.73 kristaps 338: assert(p);
1.88 kristaps 339:
340: if (iserr)
341: return(mdoc_verr(m, line, pos, p));
342:
343: return(mdoc_vwarn(m, line, pos, p));
344: }
345:
346:
347: int
1.117 kristaps 348: mdoc_macro(struct mdoc *m, enum mdoct tok,
1.88 kristaps 349: int ln, int pp, int *pos, char *buf)
350: {
1.122 ! kristaps 351: assert(tok < MDOC_MAX);
! 352:
! 353: /* If we're in the body, deny prologue calls. */
1.117 kristaps 354:
1.88 kristaps 355: if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.122 ! kristaps 356: MDOC_PBODY & m->flags)
! 357: return(mdoc_perr(m, ln, pp, EPROLBODY));
! 358:
! 359: /* If we're in the prologue, deny "body" macros. */
! 360:
! 361: if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
! 362: ! (MDOC_PBODY & m->flags)) {
1.120 kristaps 363: if ( ! mdoc_pwarn(m, ln, pp, EBODYPROL))
364: return(0);
365: if (NULL == m->meta.title)
366: m->meta.title = mandoc_strdup("unknown");
367: if (NULL == m->meta.vol)
368: m->meta.vol = mandoc_strdup("local");
369: if (NULL == m->meta.os)
370: m->meta.os = mandoc_strdup("local");
371: if (0 == m->meta.date)
372: m->meta.date = time(NULL);
373: m->flags |= MDOC_PBODY;
374: }
1.88 kristaps 375:
376: return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
1.73 kristaps 377: }
378:
379:
380: static int
381: node_append(struct mdoc *mdoc, struct mdoc_node *p)
1.1 kristaps 382: {
383:
1.25 kristaps 384: assert(mdoc->last);
385: assert(mdoc->first);
386: assert(MDOC_ROOT != p->type);
1.1 kristaps 387:
1.13 kristaps 388: switch (mdoc->next) {
389: case (MDOC_NEXT_SIBLING):
1.6 kristaps 390: mdoc->last->next = p;
391: p->prev = mdoc->last;
1.13 kristaps 392: p->parent = mdoc->last->parent;
1.1 kristaps 393: break;
1.13 kristaps 394: case (MDOC_NEXT_CHILD):
395: mdoc->last->child = p;
1.1 kristaps 396: p->parent = mdoc->last;
397: break;
398: default:
1.13 kristaps 399: abort();
400: /* NOTREACHED */
1.1 kristaps 401: }
402:
1.86 kristaps 403: p->parent->nchild++;
404:
1.23 kristaps 405: if ( ! mdoc_valid_pre(mdoc, p))
406: return(0);
1.68 kristaps 407: if ( ! mdoc_action_pre(mdoc, p))
408: return(0);
1.27 kristaps 409:
410: switch (p->type) {
411: case (MDOC_HEAD):
412: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 413: p->parent->head = p;
1.27 kristaps 414: break;
415: case (MDOC_TAIL):
416: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 417: p->parent->tail = p;
1.27 kristaps 418: break;
419: case (MDOC_BODY):
420: assert(MDOC_BLOCK == p->parent->type);
1.53 kristaps 421: p->parent->body = p;
1.27 kristaps 422: break;
423: default:
424: break;
425: }
426:
1.1 kristaps 427: mdoc->last = p;
1.71 kristaps 428:
429: switch (p->type) {
430: case (MDOC_TEXT):
431: if ( ! mdoc_valid_post(mdoc))
432: return(0);
433: if ( ! mdoc_action_post(mdoc))
434: return(0);
435: break;
436: default:
437: break;
438: }
439:
1.23 kristaps 440: return(1);
1.1 kristaps 441: }
442:
443:
1.45 kristaps 444: static struct mdoc_node *
1.117 kristaps 445: node_alloc(struct mdoc *m, int line, int pos,
446: enum mdoct tok, enum mdoc_type type)
1.45 kristaps 447: {
1.46 kristaps 448: struct mdoc_node *p;
449:
1.113 kristaps 450: p = mandoc_calloc(1, sizeof(struct mdoc_node));
1.91 kristaps 451: p->sec = m->lastsec;
1.73 kristaps 452: p->line = line;
453: p->pos = pos;
454: p->tok = tok;
1.118 kristaps 455: p->type = type;
1.45 kristaps 456:
1.46 kristaps 457: return(p);
1.45 kristaps 458: }
459:
460:
1.23 kristaps 461: int
1.117 kristaps 462: mdoc_tail_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.17 kristaps 463: {
464: struct mdoc_node *p;
465:
1.91 kristaps 466: p = node_alloc(m, line, pos, tok, MDOC_TAIL);
1.102 kristaps 467: if ( ! node_append(m, p))
468: return(0);
469: m->next = MDOC_NEXT_CHILD;
470: return(1);
1.17 kristaps 471: }
472:
473:
1.23 kristaps 474: int
1.117 kristaps 475: mdoc_head_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1 kristaps 476: {
477: struct mdoc_node *p;
478:
1.91 kristaps 479: assert(m->first);
480: assert(m->last);
1.1 kristaps 481:
1.91 kristaps 482: p = node_alloc(m, line, pos, tok, MDOC_HEAD);
1.102 kristaps 483: if ( ! node_append(m, p))
484: return(0);
485: m->next = MDOC_NEXT_CHILD;
486: return(1);
1.1 kristaps 487: }
488:
489:
1.23 kristaps 490: int
1.117 kristaps 491: mdoc_body_alloc(struct mdoc *m, int line, int pos, enum mdoct tok)
1.1 kristaps 492: {
493: struct mdoc_node *p;
494:
1.91 kristaps 495: p = node_alloc(m, line, pos, tok, MDOC_BODY);
1.102 kristaps 496: if ( ! node_append(m, p))
497: return(0);
498: m->next = MDOC_NEXT_CHILD;
499: return(1);
1.1 kristaps 500: }
501:
502:
1.23 kristaps 503: int
1.91 kristaps 504: mdoc_block_alloc(struct mdoc *m, int line, int pos,
1.117 kristaps 505: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 506: {
507: struct mdoc_node *p;
508:
1.91 kristaps 509: p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
1.77 kristaps 510: p->args = args;
511: if (p->args)
1.53 kristaps 512: (args->refcnt)++;
1.102 kristaps 513: if ( ! node_append(m, p))
514: return(0);
515: m->next = MDOC_NEXT_CHILD;
516: return(1);
1.1 kristaps 517: }
518:
519:
1.23 kristaps 520: int
1.91 kristaps 521: mdoc_elem_alloc(struct mdoc *m, int line, int pos,
1.117 kristaps 522: enum mdoct tok, struct mdoc_arg *args)
1.1 kristaps 523: {
524: struct mdoc_node *p;
525:
1.91 kristaps 526: p = node_alloc(m, line, pos, tok, MDOC_ELEM);
1.77 kristaps 527: p->args = args;
528: if (p->args)
1.53 kristaps 529: (args->refcnt)++;
1.102 kristaps 530: if ( ! node_append(m, p))
531: return(0);
532: m->next = MDOC_NEXT_CHILD;
533: return(1);
1.1 kristaps 534: }
535:
536:
1.91 kristaps 537: static int
538: pstring(struct mdoc *m, int line, int pos, const char *p, size_t len)
1.1 kristaps 539: {
1.91 kristaps 540: struct mdoc_node *n;
541: size_t sv;
1.1 kristaps 542:
1.91 kristaps 543: n = node_alloc(m, line, pos, -1, MDOC_TEXT);
1.113 kristaps 544: n->string = mandoc_malloc(len + 1);
1.91 kristaps 545: sv = strlcpy(n->string, p, len + 1);
546:
547: /* Prohibit truncation. */
548: assert(sv < len + 1);
549:
1.101 kristaps 550: if ( ! node_append(m, n))
551: return(0);
552: m->next = MDOC_NEXT_SIBLING;
553: return(1);
1.91 kristaps 554: }
555:
556:
557: int
558: mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
559: {
560:
561: return(pstring(m, line, pos, p, strlen(p)));
1.1 kristaps 562: }
563:
564:
1.53 kristaps 565: void
566: mdoc_node_free(struct mdoc_node *p)
1.1 kristaps 567: {
568:
1.53 kristaps 569: if (p->string)
570: free(p->string);
571: if (p->args)
572: mdoc_argv_free(p->args);
1.1 kristaps 573: free(p);
574: }
575:
576:
1.121 kristaps 577: static void
578: mdoc_node_unlink(struct mdoc *m, struct mdoc_node *n)
579: {
580:
581: /* Adjust siblings. */
582:
583: if (n->prev)
584: n->prev->next = n->next;
585: if (n->next)
586: n->next->prev = n->prev;
587:
588: /* Adjust parent. */
589:
590: if (n->parent) {
591: n->parent->nchild--;
592: if (n->parent->child == n)
593: n->parent->child = n->prev ? n->prev : n->next;
594: }
595:
596: /* Adjust parse point, if applicable. */
597:
598: if (m && m->last == n) {
599: if (n->prev) {
600: m->last = n->prev;
601: m->next = MDOC_NEXT_SIBLING;
602: } else {
603: m->last = n->parent;
604: m->next = MDOC_NEXT_CHILD;
605: }
606: }
607:
608: if (m && m->first == n)
609: m->first = NULL;
610: }
611:
612:
1.53 kristaps 613: void
1.121 kristaps 614: mdoc_node_delete(struct mdoc *m, struct mdoc_node *p)
1.1 kristaps 615: {
616:
1.121 kristaps 617: while (p->child) {
618: assert(p->nchild);
619: mdoc_node_delete(m, p->child);
620: }
621: assert(0 == p->nchild);
1.1 kristaps 622:
1.121 kristaps 623: mdoc_node_unlink(m, p);
1.53 kristaps 624: mdoc_node_free(p);
1.1 kristaps 625: }
626:
627:
1.53 kristaps 628: /*
629: * Parse free-form text, that is, a line that does not begin with the
630: * control character.
631: */
632: static int
1.68 kristaps 633: parsetext(struct mdoc *m, int line, char *buf)
1.1 kristaps 634: {
1.91 kristaps 635: int i, j;
1.116 kristaps 636: char sv;
1.1 kristaps 637:
1.85 kristaps 638: if (SEC_NONE == m->lastnamed)
1.88 kristaps 639: return(mdoc_perr(m, line, 0, ETEXTPROL));
1.91 kristaps 640:
641: /*
642: * If in literal mode, then pass the buffer directly to the
643: * back-end, as it should be preserved as a single term.
644: */
645:
1.101 kristaps 646: if (MDOC_LITERAL & m->flags)
647: return(mdoc_word_alloc(m, line, 0, buf));
1.91 kristaps 648:
649: /* Disallow blank/white-space lines in non-literal mode. */
1.1 kristaps 650:
1.91 kristaps 651: for (i = 0; ' ' == buf[i]; i++)
652: /* Skip leading whitespace. */ ;
1.115 kristaps 653:
1.119 kristaps 654: if ('\0' == buf[i]) {
655: if ( ! mdoc_pwarn(m, line, 0, ENOBLANK))
656: return(0);
657: /*
658: * Assume that a `Pp' should be inserted in the case of
659: * a blank line. Technically, blank lines aren't
660: * allowed, but enough manuals assume this behaviour
661: * that we want to work around it.
662: */
663: if ( ! mdoc_elem_alloc(m, line, 0, MDOC_Pp, NULL))
664: return(0);
665: }
1.68 kristaps 666:
1.91 kristaps 667: /*
668: * Break apart a free-form line into tokens. Spaces are
669: * stripped out of the input.
670: */
671:
672: for (j = i; buf[i]; i++) {
673: if (' ' != buf[i])
674: continue;
675:
676: /* Escaped whitespace. */
677: if (i && ' ' == buf[i] && '\\' == buf[i - 1])
678: continue;
679:
1.116 kristaps 680: sv = buf[i];
1.115 kristaps 681: buf[i++] = '\0';
682:
1.91 kristaps 683: if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
684: return(0);
685:
1.116 kristaps 686: /* Trailing whitespace? Check at overwritten byte. */
687:
688: if (' ' == sv && '\0' == buf[i])
689: if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
690: return(0);
691:
1.91 kristaps 692: for ( ; ' ' == buf[i]; i++)
693: /* Skip trailing whitespace. */ ;
694:
695: j = i;
1.116 kristaps 696:
697: /* Trailing whitespace? */
698:
699: if (' ' == buf[i - 1] && '\0' == buf[i])
700: if ( ! mdoc_pwarn(m, line, i - 1, ETAILWS))
701: return(0);
702:
1.115 kristaps 703: if ('\0' == buf[i])
1.91 kristaps 704: break;
705: }
706:
707: if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
1.53 kristaps 708: return(0);
1.1 kristaps 709:
1.68 kristaps 710: m->next = MDOC_NEXT_SIBLING;
1.53 kristaps 711: return(1);
1.1 kristaps 712: }
713:
714:
1.91 kristaps 715:
1.58 kristaps 716: static int
717: macrowarn(struct mdoc *m, int ln, const char *buf)
718: {
719: if ( ! (MDOC_IGN_MACRO & m->pflags))
1.96 kristaps 720: return(mdoc_verr(m, ln, 0,
1.73 kristaps 721: "unknown macro: %s%s",
1.59 kristaps 722: buf, strlen(buf) > 3 ? "..." : ""));
1.96 kristaps 723: return(mdoc_vwarn(m, ln, 0, "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
733: parsemacro(struct mdoc *m, int ln, char *buf)
1.1 kristaps 734: {
1.103 kristaps 735: int i, j, c;
1.53 kristaps 736: char mac[5];
1.1 kristaps 737:
1.81 kristaps 738: /* Empty lines are ignored. */
1.63 kristaps 739:
1.115 kristaps 740: if ('\0' == buf[1])
1.63 kristaps 741: return(1);
742:
1.100 kristaps 743: i = 1;
744:
745: /* Accept whitespace after the initial control char. */
746:
747: if (' ' == buf[i]) {
748: i++;
1.65 kristaps 749: while (buf[i] && ' ' == buf[i])
1.63 kristaps 750: i++;
1.115 kristaps 751: if ('\0' == buf[i])
1.63 kristaps 752: return(1);
753: }
1.1 kristaps 754:
1.53 kristaps 755: /* Copy the first word into a nil-terminated buffer. */
1.1 kristaps 756:
1.100 kristaps 757: for (j = 0; j < 4; j++, i++) {
1.115 kristaps 758: if ('\0' == (mac[j] = buf[i]))
1.53 kristaps 759: break;
1.65 kristaps 760: else if (' ' == buf[i])
1.53 kristaps 761: break;
1.104 kristaps 762:
763: /* Check for invalid characters. */
764:
765: if (isgraph((u_char)buf[i]))
766: continue;
767: return(mdoc_perr(m, ln, i, EPRINT));
1.53 kristaps 768: }
1.1 kristaps 769:
1.100 kristaps 770: mac[j] = 0;
1.1 kristaps 771:
1.100 kristaps 772: if (j == 4 || j < 2) {
1.58 kristaps 773: if ( ! macrowarn(m, ln, mac))
774: goto err;
775: return(1);
1.53 kristaps 776: }
777:
1.105 kristaps 778: if (MDOC_MAX == (c = mdoc_hash_find(mac))) {
1.58 kristaps 779: if ( ! macrowarn(m, ln, mac))
780: goto err;
781: return(1);
1.53 kristaps 782: }
1.1 kristaps 783:
1.53 kristaps 784: /* The macro is sane. Jump to the next word. */
1.1 kristaps 785:
1.65 kristaps 786: while (buf[i] && ' ' == buf[i])
1.53 kristaps 787: i++;
1.1 kristaps 788:
1.115 kristaps 789: /* Trailing whitespace? */
790:
791: if ('\0' == buf[i] && ' ' == buf[i - 1])
792: if ( ! mdoc_pwarn(m, ln, i - 1, ETAILWS))
793: goto err;
794:
1.98 kristaps 795: /*
796: * Begin recursive parse sequence. Since we're at the start of
797: * the line, we don't need to do callable/parseable checks.
798: */
1.103 kristaps 799: if ( ! mdoc_macro(m, c, ln, 1, &i, buf))
1.53 kristaps 800: goto err;
1.1 kristaps 801:
1.53 kristaps 802: return(1);
1.1 kristaps 803:
1.53 kristaps 804: err: /* Error out. */
1.1 kristaps 805:
1.53 kristaps 806: m->flags |= MDOC_HALT;
807: return(0);
1.1 kristaps 808: }
1.100 kristaps 809:
810:
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