Annotation of mandoc/mdoc.c, Revision 1.52
1.52 ! kristaps 1: /* $Id: mdoc.c,v 1.51 2009/03/05 13:12:12 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
19: #include <assert.h>
20: #include <ctype.h>
21: #include <err.h>
22: #include <stdarg.h>
23: #include <stdlib.h>
24: #include <stdio.h>
25: #include <string.h>
26:
27: #include "private.h"
28:
1.41 kristaps 29: /*
30: * Main caller in the libmdoc library. This begins the parsing routine,
31: * handles allocation of data, and so forth. Most of the "work" is done
1.48 kristaps 32: * in macro.c and validate.c.
1.41 kristaps 33: */
34:
1.48 kristaps 35: static struct mdoc_arg *argdup(size_t, const struct mdoc_arg *);
36: static void argfree(size_t, struct mdoc_arg *);
37: static void argcpy(struct mdoc_arg *,
38: const struct mdoc_arg *);
39:
40: static struct mdoc_node *mdoc_node_alloc(const struct mdoc *);
41: static int mdoc_node_append(struct mdoc *,
42: struct mdoc_node *);
43: static void mdoc_elem_free(struct mdoc_elem *);
44: static void mdoc_text_free(struct mdoc_text *);
45:
46:
1.1 kristaps 47: const char *const __mdoc_macronames[MDOC_MAX] = {
48: "\\\"", "Dd", "Dt", "Os",
49: "Sh", "Ss", "Pp", "D1",
50: "Dl", "Bd", "Ed", "Bl",
51: "El", "It", "Ad", "An",
52: "Ar", "Cd", "Cm", "Dv",
53: "Er", "Ev", "Ex", "Fa",
54: "Fd", "Fl", "Fn", "Ft",
55: "Ic", "In", "Li", "Nd",
56: "Nm", "Op", "Ot", "Pa",
57: "Rv", "St", "Va", "Vt",
58: /* LINTED */
59: "Xr", "\%A", "\%B", "\%D",
60: /* LINTED */
61: "\%I", "\%J", "\%N", "\%O",
62: /* LINTED */
63: "\%P", "\%R", "\%T", "\%V",
64: "Ac", "Ao", "Aq", "At",
65: "Bc", "Bf", "Bo", "Bq",
66: "Bsx", "Bx", "Db", "Dc",
67: "Do", "Dq", "Ec", "Ef",
68: "Em", "Eo", "Fx", "Ms",
69: "No", "Ns", "Nx", "Ox",
70: "Pc", "Pf", "Po", "Pq",
71: "Qc", "Ql", "Qo", "Qq",
72: "Re", "Rs", "Sc", "So",
73: "Sq", "Sm", "Sx", "Sy",
74: "Tn", "Ux", "Xc", "Xo",
75: "Fo", "Fc", "Oo", "Oc",
76: "Bk", "Ek", "Bt", "Hf",
1.52 ! kristaps 77: "Fr", "Ud", "Lb",
1.1 kristaps 78: };
79:
80: const char *const __mdoc_argnames[MDOC_ARG_MAX] = {
81: "split", "nosplit", "ragged",
82: "unfilled", "literal", "file",
83: "offset", "bullet", "dash",
84: "hyphen", "item", "enum",
85: "tag", "diag", "hang",
86: "ohang", "inset", "column",
87: "width", "compact", "std",
1.52 ! kristaps 88: "filled", "words", "emphasis",
! 89: "symbolic"
1.1 kristaps 90: };
91:
92: const char * const *mdoc_macronames = __mdoc_macronames;
93: const char * const *mdoc_argnames = __mdoc_argnames;
94:
1.45 kristaps 95:
1.1 kristaps 96: const struct mdoc_node *
1.47 kristaps 97: mdoc_node(const struct mdoc *mdoc)
1.1 kristaps 98: {
99:
100: return(mdoc->first);
101: }
102:
103:
1.37 kristaps 104: const struct mdoc_meta *
1.47 kristaps 105: mdoc_meta(const struct mdoc *mdoc)
1.37 kristaps 106: {
107:
108: return(&mdoc->meta);
109: }
110:
111:
1.1 kristaps 112: void
1.38 kristaps 113: mdoc_free(struct mdoc *mdoc)
1.34 kristaps 114: {
115:
1.38 kristaps 116: if (mdoc->first)
117: mdoc_node_freelist(mdoc->first);
118: if (mdoc->htab)
119: mdoc_tokhash_free(mdoc->htab);
1.34 kristaps 120: if (mdoc->meta.title)
121: free(mdoc->meta.title);
122: if (mdoc->meta.os)
123: free(mdoc->meta.os);
124: if (mdoc->meta.name)
125: free(mdoc->meta.name);
1.52 ! kristaps 126: if (mdoc->meta.arch)
! 127: free(mdoc->meta.arch);
! 128: if (mdoc->meta.vol)
! 129: free(mdoc->meta.vol);
1.34 kristaps 130:
1.1 kristaps 131: free(mdoc);
132: }
133:
134:
135: struct mdoc *
136: mdoc_alloc(void *data, const struct mdoc_cb *cb)
137: {
138: struct mdoc *p;
139:
140: p = xcalloc(1, sizeof(struct mdoc));
141:
142: p->data = data;
1.33 kristaps 143: if (cb)
144: (void)memcpy(&p->cb, cb, sizeof(struct mdoc_cb));
1.1 kristaps 145:
1.25 kristaps 146: p->last = xcalloc(1, sizeof(struct mdoc_node));
147: p->last->type = MDOC_ROOT;
148: p->first = p->last;
149:
150: p->next = MDOC_NEXT_CHILD;
1.4 kristaps 151: p->htab = mdoc_tokhash_alloc();
1.25 kristaps 152:
1.1 kristaps 153: return(p);
154: }
155:
156:
157: int
1.20 kristaps 158: mdoc_endparse(struct mdoc *mdoc)
159: {
160:
161: if (MDOC_HALT & mdoc->flags)
162: return(0);
163: if (NULL == mdoc->first)
164: return(1);
165:
166: assert(mdoc->last);
167: if ( ! macro_end(mdoc)) {
168: mdoc->flags |= MDOC_HALT;
169: return(0);
170: }
171: return(1);
172: }
173:
174:
1.50 kristaps 175: /*
176: * Main line-parsing routine. If the line is a macro-line (started with
177: * a '.' control character), then pass along to the parser, which parses
178: * subsequent macros until the end of line. If normal text, simply
179: * append the entire line to the chain.
180: */
1.20 kristaps 181: int
182: mdoc_parseln(struct mdoc *mdoc, int line, char *buf)
1.1 kristaps 183: {
184: int c, i;
185: char tmp[5];
186:
1.20 kristaps 187: if (MDOC_HALT & mdoc->flags)
188: return(0);
189:
1.39 kristaps 190: mdoc->linetok = 0;
191:
1.5 kristaps 192: if ('.' != *buf) {
1.50 kristaps 193: /*
194: * Free-form text. Not allowed in the prologue.
195: */
1.44 kristaps 196: if (SEC_PROLOGUE == mdoc->lastnamed)
1.49 kristaps 197: return(mdoc_perr(mdoc, line, 0,
1.50 kristaps 198: "no text in prologue"));
199:
1.39 kristaps 200: if ( ! mdoc_word_alloc(mdoc, line, 0, buf))
201: return(0);
202: mdoc->next = MDOC_NEXT_SIBLING;
203: return(1);
1.1 kristaps 204: }
205:
1.50 kristaps 206: /*
207: * Control-character detected. Begin the parsing sequence.
208: */
209:
1.1 kristaps 210: if (buf[1] && '\\' == buf[1])
211: if (buf[2] && '\"' == buf[2])
212: return(1);
213:
214: i = 1;
1.51 kristaps 215: while (buf[i] && ! isspace((u_char)buf[i]) &&
216: i < (int)sizeof(tmp))
1.1 kristaps 217: i++;
218:
1.20 kristaps 219: if (i == (int)sizeof(tmp)) {
220: mdoc->flags |= MDOC_HALT;
1.31 kristaps 221: return(mdoc_perr(mdoc, line, 1, "unknown macro"));
1.20 kristaps 222: } else if (i <= 2) {
223: mdoc->flags |= MDOC_HALT;
1.31 kristaps 224: return(mdoc_perr(mdoc, line, 1, "unknown macro"));
1.20 kristaps 225: }
1.1 kristaps 226:
227: i--;
228:
1.2 kristaps 229: (void)memcpy(tmp, buf + 1, (size_t)i);
1.1 kristaps 230: tmp[i++] = 0;
231:
1.20 kristaps 232: if (MDOC_MAX == (c = mdoc_find(mdoc, tmp))) {
233: mdoc->flags |= MDOC_HALT;
1.31 kristaps 234: return(mdoc_perr(mdoc, line, 1, "unknown macro"));
1.20 kristaps 235: }
1.1 kristaps 236:
1.51 kristaps 237: while (buf[i] && isspace((u_char)buf[i]))
1.1 kristaps 238: i++;
239:
1.21 kristaps 240: if ( ! mdoc_macro(mdoc, c, line, 1, &i, buf)) {
1.20 kristaps 241: mdoc->flags |= MDOC_HALT;
242: return(0);
243: }
1.50 kristaps 244:
1.20 kristaps 245: return(1);
1.1 kristaps 246: }
247:
248:
249: void
1.31 kristaps 250: mdoc_vmsg(struct mdoc *mdoc, int ln, int pos, const char *fmt, ...)
1.1 kristaps 251: {
1.31 kristaps 252: char buf[256];
1.23 kristaps 253: va_list ap;
1.1 kristaps 254:
255: if (NULL == mdoc->cb.mdoc_msg)
256: return;
257:
258: va_start(ap, fmt);
1.31 kristaps 259: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
1.1 kristaps 260: va_end(ap);
1.31 kristaps 261: (*mdoc->cb.mdoc_msg)(mdoc->data, ln, pos, buf);
1.1 kristaps 262: }
263:
264:
265: int
1.31 kristaps 266: mdoc_verr(struct mdoc *mdoc, int ln, int pos,
267: const char *fmt, ...)
1.1 kristaps 268: {
1.31 kristaps 269: char buf[256];
270: va_list ap;
1.1 kristaps 271:
272: if (NULL == mdoc->cb.mdoc_err)
273: return(0);
1.31 kristaps 274:
275: va_start(ap, fmt);
276: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
277: va_end(ap);
278: return((*mdoc->cb.mdoc_err)(mdoc->data, ln, pos, buf));
1.1 kristaps 279: }
280:
281:
282: int
1.31 kristaps 283: mdoc_vwarn(struct mdoc *mdoc, int ln, int pos,
284: enum mdoc_warn type, const char *fmt, ...)
1.1 kristaps 285: {
1.31 kristaps 286: char buf[256];
287: va_list ap;
1.1 kristaps 288:
289: if (NULL == mdoc->cb.mdoc_warn)
290: return(0);
1.31 kristaps 291:
292: va_start(ap, fmt);
293: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
294: va_end(ap);
295: return((*mdoc->cb.mdoc_warn)(mdoc->data, ln, pos, type, buf));
1.1 kristaps 296: }
297:
298:
299: int
1.21 kristaps 300: mdoc_macro(struct mdoc *mdoc, int tok,
1.23 kristaps 301: int ln, int ppos, int *pos, char *buf)
1.1 kristaps 302: {
303:
1.31 kristaps 304: assert(mdoc_macros[tok].fp);
305:
1.44 kristaps 306: if (MDOC_PROLOGUE & mdoc_macros[tok].flags &&
307: SEC_PROLOGUE != mdoc->lastnamed)
308: return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document body"));
309: if ( ! (MDOC_PROLOGUE & mdoc_macros[tok].flags) &&
310: SEC_PROLOGUE == mdoc->lastnamed)
311: return(mdoc_perr(mdoc, ln, ppos, "macro disallowed in document prologue"));
1.23 kristaps 312: if (1 != ppos && ! (MDOC_CALLABLE & mdoc_macros[tok].flags))
1.31 kristaps 313: return(mdoc_perr(mdoc, ln, ppos, "macro not callable"));
1.23 kristaps 314: return((*mdoc_macros[tok].fp)(mdoc, tok, ln, ppos, pos, buf));
1.1 kristaps 315: }
316:
317:
1.23 kristaps 318: static int
319: mdoc_node_append(struct mdoc *mdoc, struct mdoc_node *p)
1.1 kristaps 320: {
321:
1.25 kristaps 322: assert(mdoc->last);
323: assert(mdoc->first);
324: assert(MDOC_ROOT != p->type);
1.1 kristaps 325:
1.39 kristaps 326: /* See if we exceed the suggest line-max. */
327:
328: switch (p->type) {
329: case (MDOC_TEXT):
330: /* FALLTHROUGH */
331: case (MDOC_ELEM):
332: /* FALLTHROUGH */
333: case (MDOC_BLOCK):
334: mdoc->linetok++;
335: break;
336: default:
337: break;
338: }
339:
1.40 kristaps 340: /* This sort-of works (re-opening of text macros...). */
1.39 kristaps 341: if (mdoc->linetok > MDOC_LINEARG_SOFTMAX)
342: if ( ! mdoc_nwarn(mdoc, p, WARN_COMPAT,
343: "suggested %d tokens per line exceeded (has %d)",
344: MDOC_LINEARG_SOFTMAX, mdoc->linetok))
345: return(0);
346:
1.13 kristaps 347: switch (mdoc->next) {
348: case (MDOC_NEXT_SIBLING):
1.6 kristaps 349: mdoc->last->next = p;
350: p->prev = mdoc->last;
1.13 kristaps 351: p->parent = mdoc->last->parent;
1.1 kristaps 352: break;
1.13 kristaps 353: case (MDOC_NEXT_CHILD):
354: mdoc->last->child = p;
1.1 kristaps 355: p->parent = mdoc->last;
356: break;
357: default:
1.13 kristaps 358: abort();
359: /* NOTREACHED */
1.1 kristaps 360: }
361:
1.23 kristaps 362: if ( ! mdoc_valid_pre(mdoc, p))
363: return(0);
1.27 kristaps 364:
365: switch (p->type) {
366: case (MDOC_HEAD):
367: assert(MDOC_BLOCK == p->parent->type);
368: p->parent->data.block.head = p;
369: break;
370: case (MDOC_TAIL):
371: assert(MDOC_BLOCK == p->parent->type);
372: p->parent->data.block.tail = p;
373: break;
374: case (MDOC_BODY):
375: assert(MDOC_BLOCK == p->parent->type);
376: p->parent->data.block.body = p;
377: break;
378: default:
379: break;
380: }
381:
1.1 kristaps 382: mdoc->last = p;
1.23 kristaps 383: return(1);
1.1 kristaps 384: }
385:
386:
1.45 kristaps 387: static struct mdoc_node *
1.46 kristaps 388: mdoc_node_alloc(const struct mdoc *mdoc)
1.45 kristaps 389: {
1.46 kristaps 390: struct mdoc_node *p;
391:
392: p = xcalloc(1, sizeof(struct mdoc_node));
393: p->sec = mdoc->lastsec;
1.45 kristaps 394:
1.46 kristaps 395: return(p);
1.45 kristaps 396: }
397:
398:
1.23 kristaps 399: int
1.22 kristaps 400: mdoc_tail_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.17 kristaps 401: {
402: struct mdoc_node *p;
403:
404: assert(mdoc->first);
405: assert(mdoc->last);
406:
1.46 kristaps 407: p = mdoc_node_alloc(mdoc);
1.17 kristaps 408:
1.22 kristaps 409: p->line = line;
410: p->pos = pos;
1.17 kristaps 411: p->type = MDOC_TAIL;
1.27 kristaps 412: p->tok = tok;
1.17 kristaps 413:
1.23 kristaps 414: return(mdoc_node_append(mdoc, p));
1.17 kristaps 415: }
416:
417:
1.23 kristaps 418: int
1.22 kristaps 419: mdoc_head_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.1 kristaps 420: {
421: struct mdoc_node *p;
422:
423: assert(mdoc->first);
424: assert(mdoc->last);
425:
1.46 kristaps 426: p = mdoc_node_alloc(mdoc);
1.13 kristaps 427:
1.22 kristaps 428: p->line = line;
429: p->pos = pos;
1.1 kristaps 430: p->type = MDOC_HEAD;
1.27 kristaps 431: p->tok = tok;
1.1 kristaps 432:
1.23 kristaps 433: return(mdoc_node_append(mdoc, p));
1.1 kristaps 434: }
435:
436:
1.23 kristaps 437: int
1.22 kristaps 438: mdoc_body_alloc(struct mdoc *mdoc, int line, int pos, int tok)
1.1 kristaps 439: {
440: struct mdoc_node *p;
441:
442: assert(mdoc->first);
443: assert(mdoc->last);
444:
1.46 kristaps 445: p = mdoc_node_alloc(mdoc);
1.1 kristaps 446:
1.22 kristaps 447: p->line = line;
448: p->pos = pos;
1.1 kristaps 449: p->type = MDOC_BODY;
1.27 kristaps 450: p->tok = tok;
1.1 kristaps 451:
1.23 kristaps 452: return(mdoc_node_append(mdoc, p));
1.1 kristaps 453: }
454:
455:
1.23 kristaps 456: int
1.25 kristaps 457: mdoc_root_alloc(struct mdoc *mdoc)
458: {
459: struct mdoc_node *p;
460:
1.46 kristaps 461: p = mdoc_node_alloc(mdoc);
1.25 kristaps 462:
463: p->type = MDOC_ROOT;
464:
465: return(mdoc_node_append(mdoc, p));
466: }
467:
468:
469: int
1.22 kristaps 470: mdoc_block_alloc(struct mdoc *mdoc, int line, int pos,
471: int tok, size_t argsz, const struct mdoc_arg *args)
1.1 kristaps 472: {
473: struct mdoc_node *p;
474:
1.46 kristaps 475: p = mdoc_node_alloc(mdoc);
1.1 kristaps 476:
1.22 kristaps 477: p->pos = pos;
478: p->line = line;
1.1 kristaps 479: p->type = MDOC_BLOCK;
1.27 kristaps 480: p->tok = tok;
1.1 kristaps 481: p->data.block.argc = argsz;
482: p->data.block.argv = argdup(argsz, args);
483:
1.23 kristaps 484: return(mdoc_node_append(mdoc, p));
1.1 kristaps 485: }
486:
487:
1.23 kristaps 488: int
1.22 kristaps 489: mdoc_elem_alloc(struct mdoc *mdoc, int line, int pos,
490: int tok, size_t argsz, const struct mdoc_arg *args)
1.1 kristaps 491: {
492: struct mdoc_node *p;
493:
1.46 kristaps 494: p = mdoc_node_alloc(mdoc);
1.22 kristaps 495:
496: p->line = line;
497: p->pos = pos;
1.1 kristaps 498: p->type = MDOC_ELEM;
1.27 kristaps 499: p->tok = tok;
1.1 kristaps 500: p->data.elem.argc = argsz;
501: p->data.elem.argv = argdup(argsz, args);
502:
1.23 kristaps 503: return(mdoc_node_append(mdoc, p));
1.1 kristaps 504: }
505:
506:
1.23 kristaps 507: int
1.22 kristaps 508: mdoc_word_alloc(struct mdoc *mdoc,
509: int line, int pos, const char *word)
1.1 kristaps 510: {
511: struct mdoc_node *p;
512:
1.46 kristaps 513: p = mdoc_node_alloc(mdoc);
1.45 kristaps 514:
1.22 kristaps 515: p->line = line;
516: p->pos = pos;
1.1 kristaps 517: p->type = MDOC_TEXT;
518: p->data.text.string = xstrdup(word);
519:
1.23 kristaps 520: return(mdoc_node_append(mdoc, p));
1.1 kristaps 521: }
522:
523:
524: static void
525: argfree(size_t sz, struct mdoc_arg *p)
526: {
1.2 kristaps 527: int i, j;
1.1 kristaps 528:
529: if (0 == sz)
530: return;
531:
532: assert(p);
1.2 kristaps 533: /* LINTED */
534: for (i = 0; i < (int)sz; i++)
1.1 kristaps 535: if (p[i].sz > 0) {
536: assert(p[i].value);
1.2 kristaps 537: /* LINTED */
538: for (j = 0; j < (int)p[i].sz; j++)
1.1 kristaps 539: free(p[i].value[j]);
1.19 kristaps 540: free(p[i].value);
1.1 kristaps 541: }
542: free(p);
543: }
544:
545:
546: static void
547: mdoc_elem_free(struct mdoc_elem *p)
548: {
549:
550: argfree(p->argc, p->argv);
551: }
552:
553:
554: static void
555: mdoc_block_free(struct mdoc_block *p)
556: {
557:
558: argfree(p->argc, p->argv);
559: }
560:
561:
562: static void
563: mdoc_text_free(struct mdoc_text *p)
564: {
565:
566: if (p->string)
567: free(p->string);
568: }
569:
570:
571: void
572: mdoc_node_free(struct mdoc_node *p)
573: {
574:
575: switch (p->type) {
576: case (MDOC_TEXT):
577: mdoc_text_free(&p->data.text);
578: break;
579: case (MDOC_ELEM):
580: mdoc_elem_free(&p->data.elem);
581: break;
582: case (MDOC_BLOCK):
583: mdoc_block_free(&p->data.block);
584: break;
585: default:
586: break;
587: }
588:
589: free(p);
590: }
591:
592:
1.37 kristaps 593: void
1.1 kristaps 594: mdoc_node_freelist(struct mdoc_node *p)
595: {
596:
597: if (p->child)
598: mdoc_node_freelist(p->child);
599: if (p->next)
600: mdoc_node_freelist(p->next);
601:
602: mdoc_node_free(p);
603: }
604:
605:
606: int
607: mdoc_find(const struct mdoc *mdoc, const char *key)
608: {
609:
1.4 kristaps 610: return(mdoc_tokhash_find(mdoc->htab, key));
1.1 kristaps 611: }
612:
613:
614: static void
615: argcpy(struct mdoc_arg *dst, const struct mdoc_arg *src)
616: {
1.2 kristaps 617: int i;
1.1 kristaps 618:
1.26 kristaps 619: dst->line = src->line;
620: dst->pos = src->pos;
1.1 kristaps 621: dst->arg = src->arg;
622: if (0 == (dst->sz = src->sz))
623: return;
624: dst->value = xcalloc(dst->sz, sizeof(char *));
1.2 kristaps 625: for (i = 0; i < (int)dst->sz; i++)
1.1 kristaps 626: dst->value[i] = xstrdup(src->value[i]);
627: }
628:
629:
630: static struct mdoc_arg *
631: argdup(size_t argsz, const struct mdoc_arg *args)
632: {
633: struct mdoc_arg *pp;
1.2 kristaps 634: int i;
1.1 kristaps 635:
636: if (0 == argsz)
637: return(NULL);
638:
639: pp = xcalloc((size_t)argsz, sizeof(struct mdoc_arg));
1.2 kristaps 640: for (i = 0; i < (int)argsz; i++)
1.1 kristaps 641: argcpy(&pp[i], &args[i]);
642:
643: return(pp);
644: }
645:
CVSweb