Annotation of src/usr.bin/mandoc/mdoc.c, Revision 1.28
1.28 ! schwarze 1: /* $Id: mdoc.c,v 1.27 2009/09/21 21:11:37 schwarze Exp $ */
1.1 kristaps 2: /*
1.3 schwarze 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.3 schwarze 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.3 schwarze 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.28 ! schwarze 17: #include <sys/types.h>
! 18:
1.1 kristaps 19: #include <assert.h>
20: #include <ctype.h>
21: #include <stdarg.h>
22: #include <stdio.h>
23: #include <stdlib.h>
24: #include <string.h>
25:
26: #include "libmdoc.h"
27:
1.14 schwarze 28: const char *const __mdoc_merrnames[MERRMAX] = {
29: "trailing whitespace", /* ETAILWS */
30: "unexpected quoted parameter", /* EQUOTPARM */
31: "unterminated quoted parameter", /* EQUOTTERM */
32: "system: malloc error", /* EMALLOC */
33: "argument parameter suggested", /* EARGVAL */
34: "macro disallowed in prologue", /* EBODYPROL */
35: "macro disallowed in body", /* EPROLBODY */
36: "text disallowed in prologue", /* ETEXTPROL */
37: "blank line disallowed", /* ENOBLANK */
38: "text parameter too long", /* ETOOLONG */
39: "invalid escape sequence", /* EESCAPE */
40: "invalid character", /* EPRINT */
41: "document has no body", /* ENODAT */
42: "document has no prologue", /* ENOPROLOGUE */
43: "expected line arguments", /* ELINE */
44: "invalid AT&T argument", /* EATT */
45: "default name not yet set", /* ENAME */
46: "missing list type", /* ELISTTYPE */
47: "missing display type", /* EDISPTYPE */
48: "too many display types", /* EMULTIDISP */
49: "too many list types", /* EMULTILIST */
50: "NAME section must be first", /* ESECNAME */
51: "badly-formed NAME section", /* ENAMESECINC */
52: "argument repeated", /* EARGREP */
53: "expected boolean parameter", /* EBOOL */
54: "inconsistent column syntax", /* ECOLMIS */
55: "nested display invalid", /* ENESTDISP */
56: "width argument missing", /* EMISSWIDTH */
57: "invalid section for this manual section", /* EWRONGMSEC */
58: "section out of conventional order", /* ESECOOO */
59: "section repeated", /* ESECREP */
60: "invalid standard argument", /* EBADSTAND */
61: "multi-line arguments discouraged", /* ENOMULTILINE */
62: "multi-line arguments suggested", /* EMULTILINE */
63: "line arguments discouraged", /* ENOLINE */
64: "prologue macro out of conventional order", /* EPROLOOO */
65: "prologue macro repeated", /* EPROLREP */
66: "invalid manual section", /* EBADMSEC */
67: "invalid section", /* EBADSEC */
68: "invalid font mode", /* EFONT */
69: "invalid date syntax", /* EBADDATE */
70: "invalid number format", /* ENUMFMT */
71: "superfluous width argument", /* ENOWIDTH */
72: "system: utsname error", /* EUTSNAME */
73: "obsolete macro", /* EOBS */
74: "end-of-line scope violation", /* EIMPBRK */
75: "empty macro ignored", /* EIGNE */
76: "unclosed explicit scope", /* EOPEN */
77: "unterminated quoted phrase", /* EQUOTPHR */
78: "closure macro without prior context", /* ENOCTX */
1.18 schwarze 79: "no description found for library" /* ELIB */
1.1 kristaps 80: };
81:
82: const char *const __mdoc_macronames[MDOC_MAX] = {
1.7 schwarze 83: "Ap", "Dd", "Dt", "Os",
1.1 kristaps 84: "Sh", "Ss", "Pp", "D1",
85: "Dl", "Bd", "Ed", "Bl",
86: "El", "It", "Ad", "An",
87: "Ar", "Cd", "Cm", "Dv",
88: "Er", "Ev", "Ex", "Fa",
89: "Fd", "Fl", "Fn", "Ft",
90: "Ic", "In", "Li", "Nd",
91: "Nm", "Op", "Ot", "Pa",
92: "Rv", "St", "Va", "Vt",
93: /* LINTED */
94: "Xr", "\%A", "\%B", "\%D",
95: /* LINTED */
96: "\%I", "\%J", "\%N", "\%O",
97: /* LINTED */
98: "\%P", "\%R", "\%T", "\%V",
99: "Ac", "Ao", "Aq", "At",
100: "Bc", "Bf", "Bo", "Bq",
101: "Bsx", "Bx", "Db", "Dc",
102: "Do", "Dq", "Ec", "Ef",
103: "Em", "Eo", "Fx", "Ms",
104: "No", "Ns", "Nx", "Ox",
105: "Pc", "Pf", "Po", "Pq",
106: "Qc", "Ql", "Qo", "Qq",
107: "Re", "Rs", "Sc", "So",
108: "Sq", "Sm", "Sx", "Sy",
109: "Tn", "Ux", "Xc", "Xo",
110: "Fo", "Fc", "Oo", "Oc",
111: "Bk", "Ek", "Bt", "Hf",
1.7 schwarze 112: "Fr", "Ud", "Lb", "Lp",
113: "Lk", "Mt", "Brq", "Bro",
1.1 kristaps 114: /* LINTED */
1.7 schwarze 115: "Brc", "\%C", "Es", "En",
1.1 kristaps 116: /* LINTED */
1.20 schwarze 117: "Dx", "\%Q", "br", "sp"
1.1 kristaps 118: };
119:
120: const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
121: "split", "nosplit", "ragged",
122: "unfilled", "literal", "file",
123: "offset", "bullet", "dash",
124: "hyphen", "item", "enum",
125: "tag", "diag", "hang",
126: "ohang", "inset", "column",
127: "width", "compact", "std",
128: "filled", "words", "emphasis",
129: "symbolic", "nested"
130: };
131:
132: const char * const *mdoc_macronames = __mdoc_macronames;
133: const char * const *mdoc_argnames = __mdoc_argnames;
134:
135: static void mdoc_free1(struct mdoc *);
136: static int mdoc_alloc1(struct mdoc *);
137: static struct mdoc_node *node_alloc(struct mdoc *, int, int,
138: int, enum mdoc_type);
139: static int node_append(struct mdoc *,
140: struct mdoc_node *);
141: static int parsetext(struct mdoc *, int, char *);
142: static int parsemacro(struct mdoc *, int, char *);
143: static int macrowarn(struct mdoc *, int, const char *);
1.19 schwarze 144: static int pstring(struct mdoc *, int, int,
145: const char *, size_t);
1.16 schwarze 146:
1.1 kristaps 147:
148: const struct mdoc_node *
149: mdoc_node(const struct mdoc *m)
150: {
151:
152: return(MDOC_HALT & m->flags ? NULL : m->first);
153: }
154:
155:
156: const struct mdoc_meta *
157: mdoc_meta(const struct mdoc *m)
158: {
159:
160: return(MDOC_HALT & m->flags ? NULL : &m->meta);
161: }
162:
163:
1.8 schwarze 164: /*
165: * Frees volatile resources (parse tree, meta-data, fields).
166: */
1.1 kristaps 167: static void
168: mdoc_free1(struct mdoc *mdoc)
169: {
170:
171: if (mdoc->first)
172: mdoc_node_freelist(mdoc->first);
173: if (mdoc->meta.title)
174: free(mdoc->meta.title);
175: if (mdoc->meta.os)
176: free(mdoc->meta.os);
177: if (mdoc->meta.name)
178: free(mdoc->meta.name);
179: if (mdoc->meta.arch)
180: free(mdoc->meta.arch);
181: if (mdoc->meta.vol)
182: free(mdoc->meta.vol);
183: }
184:
185:
1.8 schwarze 186: /*
187: * Allocate all volatile resources (parse tree, meta-data, fields).
188: */
1.1 kristaps 189: static int
190: mdoc_alloc1(struct mdoc *mdoc)
191: {
192:
193: bzero(&mdoc->meta, sizeof(struct mdoc_meta));
194: mdoc->flags = 0;
1.9 schwarze 195: mdoc->lastnamed = mdoc->lastsec = SEC_NONE;
1.1 kristaps 196: mdoc->last = calloc(1, sizeof(struct mdoc_node));
197: if (NULL == mdoc->last)
198: return(0);
199:
200: mdoc->first = mdoc->last;
201: mdoc->last->type = MDOC_ROOT;
202: mdoc->next = MDOC_NEXT_CHILD;
203: return(1);
204: }
205:
206:
207: /*
1.8 schwarze 208: * Free up volatile resources (see mdoc_free1()) then re-initialises the
209: * data with mdoc_alloc1(). After invocation, parse data has been reset
210: * and the parser is ready for re-invocation on a new tree; however,
211: * cross-parse non-volatile data is kept intact.
1.1 kristaps 212: */
213: int
214: mdoc_reset(struct mdoc *mdoc)
215: {
216:
217: mdoc_free1(mdoc);
218: return(mdoc_alloc1(mdoc));
219: }
220:
221:
222: /*
1.8 schwarze 223: * Completely free up all volatile and non-volatile parse resources.
224: * After invocation, the pointer is no longer usable.
1.1 kristaps 225: */
226: void
227: mdoc_free(struct mdoc *mdoc)
228: {
229:
230: mdoc_free1(mdoc);
231: free(mdoc);
232: }
233:
234:
1.8 schwarze 235: /*
236: * Allocate volatile and non-volatile parse resources.
237: */
1.1 kristaps 238: struct mdoc *
239: mdoc_alloc(void *data, int pflags, const struct mdoc_cb *cb)
240: {
241: struct mdoc *p;
242:
243: if (NULL == (p = calloc(1, sizeof(struct mdoc))))
244: return(NULL);
245: if (cb)
246: (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
247:
1.27 schwarze 248: mdoc_hash_init();
249:
1.1 kristaps 250: p->data = data;
251: p->pflags = pflags;
252:
1.27 schwarze 253: if (mdoc_alloc1(p))
1.1 kristaps 254: return(p);
255:
256: free(p);
257: return(NULL);
258: }
259:
260:
261: /*
262: * Climb back up the parse tree, validating open scopes. Mostly calls
1.8 schwarze 263: * through to macro_end() in macro.c.
1.1 kristaps 264: */
265: int
266: mdoc_endparse(struct mdoc *m)
267: {
268:
269: if (MDOC_HALT & m->flags)
270: return(0);
271: else if (mdoc_macroend(m))
272: return(1);
273: m->flags |= MDOC_HALT;
274: return(0);
275: }
276:
277:
278: /*
279: * Main parse routine. Parses a single line -- really just hands off to
1.8 schwarze 280: * the macro (parsemacro()) or text parser (parsetext()).
1.1 kristaps 281: */
282: int
283: mdoc_parseln(struct mdoc *m, int ln, char *buf)
284: {
285:
286: if (MDOC_HALT & m->flags)
287: return(0);
288:
289: return('.' == *buf ? parsemacro(m, ln, buf) :
290: parsetext(m, ln, buf));
291: }
292:
293:
294: int
1.4 schwarze 295: mdoc_verr(struct mdoc *mdoc, int ln, int pos,
296: const char *fmt, ...)
1.1 kristaps 297: {
298: char buf[256];
299: va_list ap;
300:
301: if (NULL == mdoc->cb.mdoc_err)
302: return(0);
303:
304: va_start(ap, fmt);
305: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
306: va_end(ap);
1.12 schwarze 307:
1.1 kristaps 308: return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
309: }
310:
311:
312: int
1.12 schwarze 313: mdoc_vwarn(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
1.1 kristaps 314: {
315: char buf[256];
316: va_list ap;
317:
318: if (NULL == mdoc->cb.mdoc_warn)
319: return(0);
320:
321: va_start(ap, fmt);
322: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
323: va_end(ap);
1.17 schwarze 324:
1.11 schwarze 325: return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, buf));
1.5 schwarze 326: }
327:
328:
329: int
1.14 schwarze 330: mdoc_err(struct mdoc *m, int line, int pos, int iserr, enum merr type)
1.5 schwarze 331: {
1.14 schwarze 332: const char *p;
1.5 schwarze 333:
1.14 schwarze 334: p = __mdoc_merrnames[(int)type];
335: assert(p);
1.5 schwarze 336:
1.14 schwarze 337: if (iserr)
338: return(mdoc_verr(m, line, pos, p));
1.16 schwarze 339:
1.14 schwarze 340: return(mdoc_vwarn(m, line, pos, p));
1.5 schwarze 341: }
342:
343:
344: int
1.1 kristaps 345: mdoc_macro(struct mdoc *m, int tok,
346: int ln, int pp, int *pos, char *buf)
347: {
1.24 schwarze 348: /*
349: * If we're in the prologue, deny "body" macros. Similarly, if
350: * we're in the body, deny prologue calls.
351: */
1.1 kristaps 352: if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
1.9 schwarze 353: MDOC_PBODY & m->flags)
1.16 schwarze 354: return(mdoc_perr(m, ln, pp, EPROLBODY));
1.1 kristaps 355: if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
1.9 schwarze 356: ! (MDOC_PBODY & m->flags))
1.16 schwarze 357: return(mdoc_perr(m, ln, pp, EBODYPROL));
1.1 kristaps 358:
359: return((*mdoc_macros[tok].fp)(m, tok, ln, pp, pos, buf));
360: }
361:
362:
363: static int
364: node_append(struct mdoc *mdoc, struct mdoc_node *p)
365: {
366:
367: assert(mdoc->last);
368: assert(mdoc->first);
369: assert(MDOC_ROOT != p->type);
370:
371: switch (mdoc->next) {
372: case (MDOC_NEXT_SIBLING):
373: mdoc->last->next = p;
374: p->prev = mdoc->last;
375: p->parent = mdoc->last->parent;
376: break;
377: case (MDOC_NEXT_CHILD):
378: mdoc->last->child = p;
379: p->parent = mdoc->last;
380: break;
381: default:
382: abort();
383: /* NOTREACHED */
384: }
385:
1.10 schwarze 386: p->parent->nchild++;
387:
1.1 kristaps 388: if ( ! mdoc_valid_pre(mdoc, p))
389: return(0);
390: if ( ! mdoc_action_pre(mdoc, p))
391: return(0);
392:
393: switch (p->type) {
394: case (MDOC_HEAD):
395: assert(MDOC_BLOCK == p->parent->type);
396: p->parent->head = p;
397: break;
398: case (MDOC_TAIL):
399: assert(MDOC_BLOCK == p->parent->type);
400: p->parent->tail = p;
401: break;
402: case (MDOC_BODY):
403: assert(MDOC_BLOCK == p->parent->type);
404: p->parent->body = p;
405: break;
406: default:
407: break;
408: }
409:
410: mdoc->last = p;
411:
412: switch (p->type) {
413: case (MDOC_TEXT):
414: if ( ! mdoc_valid_post(mdoc))
415: return(0);
416: if ( ! mdoc_action_post(mdoc))
417: return(0);
418: break;
419: default:
420: break;
421: }
422:
423: return(1);
424: }
425:
426:
427: static struct mdoc_node *
1.19 schwarze 428: node_alloc(struct mdoc *m, int line,
1.1 kristaps 429: int pos, int tok, enum mdoc_type type)
430: {
431: struct mdoc_node *p;
432:
433: if (NULL == (p = calloc(1, sizeof(struct mdoc_node)))) {
1.19 schwarze 434: (void)mdoc_nerr(m, m->last, EMALLOC);
1.1 kristaps 435: return(NULL);
436: }
437:
1.19 schwarze 438: p->sec = m->lastsec;
1.1 kristaps 439: p->line = line;
440: p->pos = pos;
441: p->tok = tok;
442: if (MDOC_TEXT != (p->type = type))
443: assert(p->tok >= 0);
444:
445: return(p);
446: }
447:
448:
449: int
1.19 schwarze 450: mdoc_tail_alloc(struct mdoc *m, int line, int pos, int tok)
1.1 kristaps 451: {
452: struct mdoc_node *p;
453:
1.19 schwarze 454: p = node_alloc(m, line, pos, tok, MDOC_TAIL);
1.1 kristaps 455: if (NULL == p)
456: return(0);
1.25 schwarze 457: if ( ! node_append(m, p))
458: return(0);
459: m->next = MDOC_NEXT_CHILD;
460: return(1);
1.1 kristaps 461: }
462:
463:
464: int
1.19 schwarze 465: mdoc_head_alloc(struct mdoc *m, int line, int pos, int tok)
1.1 kristaps 466: {
467: struct mdoc_node *p;
468:
1.19 schwarze 469: assert(m->first);
470: assert(m->last);
1.1 kristaps 471:
1.19 schwarze 472: p = node_alloc(m, line, pos, tok, MDOC_HEAD);
1.1 kristaps 473: if (NULL == p)
474: return(0);
1.25 schwarze 475: if ( ! node_append(m, p))
476: return(0);
477: m->next = MDOC_NEXT_CHILD;
478: return(1);
1.1 kristaps 479: }
480:
481:
482: int
1.19 schwarze 483: mdoc_body_alloc(struct mdoc *m, int line, int pos, int tok)
1.1 kristaps 484: {
485: struct mdoc_node *p;
486:
1.19 schwarze 487: p = node_alloc(m, line, pos, tok, MDOC_BODY);
1.1 kristaps 488: if (NULL == p)
489: return(0);
1.25 schwarze 490: if ( ! node_append(m, p))
491: return(0);
492: m->next = MDOC_NEXT_CHILD;
493: return(1);
1.1 kristaps 494: }
495:
496:
497: int
1.19 schwarze 498: mdoc_block_alloc(struct mdoc *m, int line, int pos,
1.1 kristaps 499: int tok, struct mdoc_arg *args)
500: {
501: struct mdoc_node *p;
502:
1.19 schwarze 503: p = node_alloc(m, line, pos, tok, MDOC_BLOCK);
1.1 kristaps 504: if (NULL == p)
505: return(0);
1.4 schwarze 506: p->args = args;
507: if (p->args)
1.1 kristaps 508: (args->refcnt)++;
1.25 schwarze 509: if ( ! node_append(m, p))
510: return(0);
511: m->next = MDOC_NEXT_CHILD;
512: return(1);
1.1 kristaps 513: }
514:
515:
516: int
1.19 schwarze 517: mdoc_elem_alloc(struct mdoc *m, int line, int pos,
1.1 kristaps 518: int tok, struct mdoc_arg *args)
519: {
520: struct mdoc_node *p;
521:
1.19 schwarze 522: p = node_alloc(m, line, pos, tok, MDOC_ELEM);
1.1 kristaps 523: if (NULL == p)
524: return(0);
1.4 schwarze 525: p->args = args;
526: if (p->args)
1.1 kristaps 527: (args->refcnt)++;
1.25 schwarze 528: if ( ! node_append(m, p))
529: return(0);
530: m->next = MDOC_NEXT_CHILD;
531: return(1);
1.1 kristaps 532: }
533:
534:
1.19 schwarze 535: static int
536: pstring(struct mdoc *m, int line, int pos, const char *p, size_t len)
1.1 kristaps 537: {
1.19 schwarze 538: struct mdoc_node *n;
539: size_t sv;
1.1 kristaps 540:
1.19 schwarze 541: n = node_alloc(m, line, pos, -1, MDOC_TEXT);
542: if (NULL == n)
543: return(mdoc_nerr(m, m->last, EMALLOC));
544:
545: n->string = malloc(len + 1);
546: if (NULL == n->string) {
547: free(n);
548: return(mdoc_nerr(m, m->last, EMALLOC));
1.1 kristaps 549: }
1.15 schwarze 550:
1.19 schwarze 551: sv = strlcpy(n->string, p, len + 1);
552:
553: /* Prohibit truncation. */
554: assert(sv < len + 1);
555:
1.25 schwarze 556: if ( ! node_append(m, n))
557: return(0);
558: m->next = MDOC_NEXT_SIBLING;
559: return(1);
1.19 schwarze 560: }
561:
562:
563: int
564: mdoc_word_alloc(struct mdoc *m, int line, int pos, const char *p)
565: {
566:
567: return(pstring(m, line, pos, p, strlen(p)));
1.1 kristaps 568: }
569:
570:
571: void
572: mdoc_node_free(struct mdoc_node *p)
573: {
574:
1.10 schwarze 575: if (p->parent)
576: p->parent->nchild--;
1.1 kristaps 577: if (p->string)
578: free(p->string);
579: if (p->args)
580: mdoc_argv_free(p->args);
581: free(p);
582: }
583:
584:
585: void
586: mdoc_node_freelist(struct mdoc_node *p)
587: {
588:
589: if (p->child)
590: mdoc_node_freelist(p->child);
591: if (p->next)
592: mdoc_node_freelist(p->next);
593:
1.10 schwarze 594: assert(0 == p->nchild);
1.1 kristaps 595: mdoc_node_free(p);
596: }
597:
598:
599: /*
600: * Parse free-form text, that is, a line that does not begin with the
601: * control character.
602: */
603: static int
604: parsetext(struct mdoc *m, int line, char *buf)
605: {
1.19 schwarze 606: int i, j;
1.1 kristaps 607:
1.9 schwarze 608: if (SEC_NONE == m->lastnamed)
1.16 schwarze 609: return(mdoc_perr(m, line, 0, ETEXTPROL));
1.19 schwarze 610:
611: /*
612: * If in literal mode, then pass the buffer directly to the
613: * back-end, as it should be preserved as a single term.
614: */
1.1 kristaps 615:
1.25 schwarze 616: if (MDOC_LITERAL & m->flags)
617: return(mdoc_word_alloc(m, line, 0, buf));
1.19 schwarze 618:
619: /* Disallow blank/white-space lines in non-literal mode. */
620:
621: for (i = 0; ' ' == buf[i]; i++)
622: /* Skip leading whitespace. */ ;
623: if (0 == buf[i])
1.16 schwarze 624: return(mdoc_perr(m, line, 0, ENOBLANK));
1.1 kristaps 625:
1.19 schwarze 626: /*
627: * Break apart a free-form line into tokens. Spaces are
628: * stripped out of the input.
629: */
630:
631: for (j = i; buf[i]; i++) {
632: if (' ' != buf[i])
633: continue;
634:
635: /* Escaped whitespace. */
636: if (i && ' ' == buf[i] && '\\' == buf[i - 1])
637: continue;
638:
639: buf[i++] = 0;
640: if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
641: return(0);
642:
643: for ( ; ' ' == buf[i]; i++)
644: /* Skip trailing whitespace. */ ;
645:
646: j = i;
647: if (0 == buf[i])
648: break;
649: }
650:
651: if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
1.1 kristaps 652: return(0);
653:
654: m->next = MDOC_NEXT_SIBLING;
655: return(1);
656: }
1.19 schwarze 657:
658:
1.1 kristaps 659:
660:
661: static int
662: macrowarn(struct mdoc *m, int ln, const char *buf)
663: {
664: if ( ! (MDOC_IGN_MACRO & m->pflags))
1.23 schwarze 665: return(mdoc_verr(m, ln, 0,
1.1 kristaps 666: "unknown macro: %s%s",
667: buf, strlen(buf) > 3 ? "..." : ""));
1.23 schwarze 668: return(mdoc_vwarn(m, ln, 0, "unknown macro: %s%s",
1.1 kristaps 669: buf, strlen(buf) > 3 ? "..." : ""));
670: }
671:
672:
673: /*
674: * Parse a macro line, that is, a line beginning with the control
675: * character.
676: */
677: int
678: parsemacro(struct mdoc *m, int ln, char *buf)
679: {
1.25 schwarze 680: int i, j, c;
1.1 kristaps 681: char mac[5];
682:
1.7 schwarze 683: /* Empty lines are ignored. */
1.1 kristaps 684:
685: if (0 == buf[1])
686: return(1);
687:
1.24 schwarze 688: i = 1;
689:
690: /* Accept whitespace after the initial control char. */
691:
692: if (' ' == buf[i]) {
693: i++;
1.1 kristaps 694: while (buf[i] && ' ' == buf[i])
695: i++;
696: if (0 == buf[i])
697: return(1);
698: }
699:
700: /* Copy the first word into a nil-terminated buffer. */
701:
1.24 schwarze 702: for (j = 0; j < 4; j++, i++) {
703: if (0 == (mac[j] = buf[i]))
1.1 kristaps 704: break;
705: else if (' ' == buf[i])
706: break;
1.26 schwarze 707:
708: /* Check for invalid characters. */
709:
710: if (isgraph((u_char)buf[i]))
711: continue;
712: return(mdoc_perr(m, ln, i, EPRINT));
1.1 kristaps 713: }
714:
1.24 schwarze 715: mac[j] = 0;
1.1 kristaps 716:
1.24 schwarze 717: if (j == 4 || j < 2) {
1.1 kristaps 718: if ( ! macrowarn(m, ln, mac))
719: goto err;
720: return(1);
721: }
722:
1.27 schwarze 723: if (MDOC_MAX == (c = mdoc_hash_find(mac))) {
1.1 kristaps 724: if ( ! macrowarn(m, ln, mac))
725: goto err;
726: return(1);
727: }
728:
729: /* The macro is sane. Jump to the next word. */
730:
731: while (buf[i] && ' ' == buf[i])
732: i++;
733:
1.24 schwarze 734: /*
735: * Begin recursive parse sequence. Since we're at the start of
736: * the line, we don't need to do callable/parseable checks.
737: */
1.25 schwarze 738: if ( ! mdoc_macro(m, c, ln, 1, &i, buf))
1.1 kristaps 739: goto err;
740:
741: return(1);
742:
743: err: /* Error out. */
744:
745: m->flags |= MDOC_HALT;
746: return(0);
747: }
1.24 schwarze 748:
749:
![[BACK]](/icons/back.gif){kind=icon}
Return to mdoc.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc