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