Annotation of mandoc/man.c, Revision 1.44
1.44 ! kristaps 1: /* $Id: man.c,v 1.43 2009/10/26 07:11:06 kristaps Exp $ */
1.1 kristaps 2: /*
1.19 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.18 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.18 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.41 kristaps 17: #include <sys/types.h>
18:
1.1 kristaps 19: #include <assert.h>
20: #include <ctype.h>
21: #include <stdarg.h>
22: #include <stdlib.h>
23: #include <stdio.h>
24: #include <string.h>
25:
26: #include "libman.h"
27:
1.27 kristaps 28: const char *const __man_merrnames[WERRMAX] = {
29: "invalid character", /* WNPRINT */
30: "system: malloc error", /* WNMEM */
31: "invalid manual section", /* WMSEC */
32: "invalid date format", /* WDATE */
33: "scope of prior line violated", /* WLNSCOPE */
34: "trailing whitespace", /* WTSPACE */
35: "unterminated quoted parameter", /* WTQUOTE */
36: "document has no body", /* WNODATA */
37: "document has no title/section", /* WNOTITLE */
38: "invalid escape sequence", /* WESCAPE */
1.28 kristaps 39: "invalid number format", /* WNUMFMT */
1.29 kristaps 40: "expected block head arguments", /* WHEADARGS */
41: "expected block body arguments", /* WBODYARGS */
42: "expected empty block head", /* WNHEADARGS */
43: "ill-formed macro", /* WMACROFORM */
1.30 kristaps 44: "scope open on exit", /* WEXITSCOPE */
1.35 kristaps 45: "no scope context", /* WNOSCOPE */
46: "literal context already open", /* WOLITERAL */
47: "no literal context open" /* WNLITERAL */
1.27 kristaps 48: };
49:
1.1 kristaps 50: const char *const __man_macronames[MAN_MAX] = {
1.21 kristaps 51: "br", "TH", "SH", "SS",
1.1 kristaps 52: "TP", "LP", "PP", "P",
53: "IP", "HP", "SM", "SB",
54: "BI", "IB", "BR", "RB",
1.11 kristaps 55: "R", "B", "I", "IR",
1.29 kristaps 56: "RI", "na", "i", "sp",
1.30 kristaps 57: "nf", "fi", "r", "RE",
1.42 kristaps 58: "RS", "DT", "UC", "PD"
1.1 kristaps 59: };
60:
61: const char * const *man_macronames = __man_macronames;
62:
1.16 kristaps 63: static struct man_node *man_node_alloc(int, int,
64: enum man_type, int);
1.1 kristaps 65: static int man_node_append(struct man *,
66: struct man_node *);
67: static int man_ptext(struct man *, int, char *);
68: static int man_pmacro(struct man *, int, char *);
1.2 kristaps 69: static void man_free1(struct man *);
1.16 kristaps 70: static int man_alloc1(struct man *);
1.31 kristaps 71: static int pstring(struct man *, int, int,
72: const char *, size_t);
1.43 kristaps 73: static int macrowarn(struct man *, int, const char *);
1.1 kristaps 74:
1.32 kristaps 75: #ifdef __linux__
76: extern size_t strlcpy(char *, const char *, size_t);
77: #endif
78:
1.1 kristaps 79:
80: const struct man_node *
1.2 kristaps 81: man_node(const struct man *m)
1.1 kristaps 82: {
83:
1.2 kristaps 84: return(MAN_HALT & m->flags ? NULL : m->first);
1.1 kristaps 85: }
86:
87:
88: const struct man_meta *
1.2 kristaps 89: man_meta(const struct man *m)
1.1 kristaps 90: {
91:
1.2 kristaps 92: return(MAN_HALT & m->flags ? NULL : &m->meta);
1.1 kristaps 93: }
94:
95:
1.15 kristaps 96: int
1.1 kristaps 97: man_reset(struct man *man)
98: {
99:
1.2 kristaps 100: man_free1(man);
1.16 kristaps 101: return(man_alloc1(man));
1.1 kristaps 102: }
103:
104:
105: void
106: man_free(struct man *man)
107: {
108:
1.2 kristaps 109: man_free1(man);
1.1 kristaps 110: free(man);
111: }
112:
113:
114: struct man *
1.7 kristaps 115: man_alloc(void *data, int pflags, const struct man_cb *cb)
1.1 kristaps 116: {
117: struct man *p;
118:
1.16 kristaps 119: if (NULL == (p = calloc(1, sizeof(struct man))))
120: return(NULL);
1.2 kristaps 121:
1.16 kristaps 122: if ( ! man_alloc1(p)) {
123: free(p);
124: return(NULL);
125: }
1.1 kristaps 126:
1.40 kristaps 127: man_hash_init();
128:
1.4 kristaps 129: p->data = data;
1.7 kristaps 130: p->pflags = pflags;
1.16 kristaps 131: (void)memcpy(&p->cb, cb, sizeof(struct man_cb));
1.1 kristaps 132: return(p);
133: }
134:
135:
136: int
137: man_endparse(struct man *m)
138: {
139:
1.3 kristaps 140: if (MAN_HALT & m->flags)
141: return(0);
142: else if (man_macroend(m))
143: return(1);
144: m->flags |= MAN_HALT;
145: return(0);
1.1 kristaps 146: }
147:
148:
149: int
150: man_parseln(struct man *m, int ln, char *buf)
151: {
152:
153: return('.' == *buf ?
154: man_pmacro(m, ln, buf) :
155: man_ptext(m, ln, buf));
156: }
157:
158:
1.2 kristaps 159: static void
160: man_free1(struct man *man)
161: {
162:
163: if (man->first)
164: man_node_freelist(man->first);
165: if (man->meta.title)
166: free(man->meta.title);
1.6 kristaps 167: if (man->meta.source)
168: free(man->meta.source);
1.2 kristaps 169: if (man->meta.vol)
170: free(man->meta.vol);
171: }
172:
173:
1.16 kristaps 174: static int
1.2 kristaps 175: man_alloc1(struct man *m)
176: {
177:
1.44 ! kristaps 178: memset(&m->meta, 0, sizeof(struct man_meta));
1.2 kristaps 179: m->flags = 0;
180: m->last = calloc(1, sizeof(struct man_node));
181: if (NULL == m->last)
1.16 kristaps 182: return(0);
1.2 kristaps 183: m->first = m->last;
184: m->last->type = MAN_ROOT;
185: m->next = MAN_NEXT_CHILD;
1.16 kristaps 186: return(1);
1.2 kristaps 187: }
188:
189:
1.1 kristaps 190: static int
191: man_node_append(struct man *man, struct man_node *p)
192: {
193:
194: assert(man->last);
195: assert(man->first);
196: assert(MAN_ROOT != p->type);
197:
198: switch (man->next) {
199: case (MAN_NEXT_SIBLING):
200: man->last->next = p;
201: p->prev = man->last;
202: p->parent = man->last->parent;
203: break;
204: case (MAN_NEXT_CHILD):
205: man->last->child = p;
206: p->parent = man->last;
207: break;
208: default:
209: abort();
210: /* NOTREACHED */
211: }
1.22 kristaps 212:
213: p->parent->nchild++;
1.1 kristaps 214:
1.29 kristaps 215: if ( ! man_valid_pre(man, p))
216: return(0);
217:
218: switch (p->type) {
219: case (MAN_HEAD):
220: assert(MAN_BLOCK == p->parent->type);
221: p->parent->head = p;
222: break;
223: case (MAN_BODY):
224: assert(MAN_BLOCK == p->parent->type);
225: p->parent->body = p;
226: break;
227: default:
228: break;
229: }
230:
1.2 kristaps 231: man->last = p;
232:
1.1 kristaps 233: switch (p->type) {
1.2 kristaps 234: case (MAN_TEXT):
235: if ( ! man_valid_post(man))
236: return(0);
237: if ( ! man_action_post(man))
238: return(0);
1.1 kristaps 239: break;
240: default:
241: break;
242: }
243:
244: return(1);
245: }
246:
247:
248: static struct man_node *
1.16 kristaps 249: man_node_alloc(int line, int pos, enum man_type type, int tok)
1.1 kristaps 250: {
251: struct man_node *p;
252:
1.16 kristaps 253: p = calloc(1, sizeof(struct man_node));
254: if (NULL == p)
255: return(NULL);
256:
1.1 kristaps 257: p->line = line;
258: p->pos = pos;
259: p->type = type;
1.16 kristaps 260: p->tok = tok;
1.1 kristaps 261: return(p);
262: }
263:
264:
265: int
1.30 kristaps 266: man_elem_alloc(struct man *m, int line, int pos, int tok)
1.1 kristaps 267: {
268: struct man_node *p;
269:
1.16 kristaps 270: p = man_node_alloc(line, pos, MAN_ELEM, tok);
271: if (NULL == p)
272: return(0);
1.30 kristaps 273: if ( ! man_node_append(m, p))
274: return(0);
275: m->next = MAN_NEXT_CHILD;
276: return(1);
1.1 kristaps 277: }
278:
279:
280: int
1.29 kristaps 281: man_head_alloc(struct man *m, int line, int pos, int tok)
282: {
283: struct man_node *p;
284:
285: p = man_node_alloc(line, pos, MAN_HEAD, tok);
286: if (NULL == p)
287: return(0);
288: if ( ! man_node_append(m, p))
289: return(0);
290: m->next = MAN_NEXT_CHILD;
291: return(1);
292: }
293:
294:
295: int
296: man_body_alloc(struct man *m, int line, int pos, int tok)
297: {
298: struct man_node *p;
299:
300: p = man_node_alloc(line, pos, MAN_BODY, tok);
301: if (NULL == p)
302: return(0);
303: if ( ! man_node_append(m, p))
304: return(0);
305: m->next = MAN_NEXT_CHILD;
306: return(1);
307: }
308:
309:
310: int
311: man_block_alloc(struct man *m, int line, int pos, int tok)
312: {
313: struct man_node *p;
314:
315: p = man_node_alloc(line, pos, MAN_BLOCK, tok);
316: if (NULL == p)
317: return(0);
318: if ( ! man_node_append(m, p))
319: return(0);
320: m->next = MAN_NEXT_CHILD;
321: return(1);
322: }
323:
324:
1.31 kristaps 325: static int
326: pstring(struct man *m, int line, int pos,
327: const char *p, size_t len)
1.1 kristaps 328: {
1.31 kristaps 329: struct man_node *n;
330: size_t sv;
1.1 kristaps 331:
1.31 kristaps 332: n = man_node_alloc(line, pos, MAN_TEXT, -1);
333: if (NULL == n)
1.16 kristaps 334: return(0);
1.31 kristaps 335:
336: n->string = malloc(len + 1);
337: if (NULL == n->string) {
338: free(n);
1.16 kristaps 339: return(0);
1.31 kristaps 340: }
341:
342: sv = strlcpy(n->string, p, len + 1);
343:
344: /* Prohibit truncation. */
345: assert(sv < len + 1);
346:
347: if ( ! man_node_append(m, n))
1.30 kristaps 348: return(0);
349: m->next = MAN_NEXT_SIBLING;
350: return(1);
1.1 kristaps 351: }
352:
353:
1.31 kristaps 354: int
355: man_word_alloc(struct man *m, int line, int pos, const char *word)
356: {
357:
358: return(pstring(m, line, pos, word, strlen(word)));
359: }
360:
361:
1.1 kristaps 362: void
363: man_node_free(struct man_node *p)
364: {
365:
366: if (p->string)
367: free(p->string);
1.24 kristaps 368: if (p->parent)
369: p->parent->nchild--;
1.1 kristaps 370: free(p);
371: }
372:
373:
374: void
375: man_node_freelist(struct man_node *p)
376: {
1.37 kristaps 377: struct man_node *n;
1.1 kristaps 378:
379: if (p->child)
380: man_node_freelist(p->child);
1.24 kristaps 381: assert(0 == p->nchild);
1.37 kristaps 382: n = p->next;
1.1 kristaps 383: man_node_free(p);
1.37 kristaps 384: if (n)
385: man_node_freelist(n);
1.1 kristaps 386: }
387:
388:
389: static int
390: man_ptext(struct man *m, int line, char *buf)
391: {
1.31 kristaps 392: int i, j;
393:
1.35 kristaps 394: /* Literal free-form text whitespace is preserved. */
395:
396: if (MAN_LITERAL & m->flags) {
397: if ( ! man_word_alloc(m, line, 0, buf))
398: return(0);
399: goto descope;
400: }
401:
1.31 kristaps 402: /* First de-chunk and allocate words. */
403:
404: for (i = 0; ' ' == buf[i]; i++)
405: /* Skip leading whitespace. */ ;
406: if (0 == buf[i]) {
407: if ( ! pstring(m, line, 0, &buf[i], 0))
408: return(0);
409: goto descope;
410: }
411:
412: for (j = i; buf[i]; i++) {
413: if (' ' != buf[i])
414: continue;
415:
416: /* Escaped whitespace. */
417: if (i && ' ' == buf[i] && '\\' == buf[i - 1])
418: continue;
1.1 kristaps 419:
1.31 kristaps 420: buf[i++] = 0;
421: if ( ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
422: return(0);
1.29 kristaps 423:
1.31 kristaps 424: for ( ; ' ' == buf[i]; i++)
425: /* Skip trailing whitespace. */ ;
1.30 kristaps 426:
1.31 kristaps 427: j = i;
428: if (0 == buf[i])
429: break;
430: }
431:
432: if (j != i && ! pstring(m, line, j, &buf[j], (size_t)(i - j)))
1.1 kristaps 433: return(0);
1.31 kristaps 434:
435: descope:
1.11 kristaps 436:
437: /*
1.29 kristaps 438: * Co-ordinate what happens with having a next-line scope open:
439: * first close out the element scope (if applicable), then close
440: * out the block scope (also if applicable).
1.11 kristaps 441: */
442:
1.29 kristaps 443: if (MAN_ELINE & m->flags) {
444: m->flags &= ~MAN_ELINE;
445: if ( ! man_unscope(m, m->last->parent))
446: return(0);
447: }
448:
449: if ( ! (MAN_BLINE & m->flags))
1.11 kristaps 450: return(1);
1.29 kristaps 451: m->flags &= ~MAN_BLINE;
1.11 kristaps 452:
1.29 kristaps 453: if ( ! man_unscope(m, m->last->parent))
1.11 kristaps 454: return(0);
1.29 kristaps 455: return(man_body_alloc(m, line, 0, m->last->tok));
1.1 kristaps 456: }
457:
458:
1.43 kristaps 459: static int
460: macrowarn(struct man *m, int ln, const char *buf)
461: {
462: if ( ! (MAN_IGN_MACRO & m->pflags))
463: return(man_verr(m, ln, 0,
464: "unknown macro: %s%s",
465: buf, strlen(buf) > 3 ? "..." : ""));
466: return(man_vwarn(m, ln, 0, "unknown macro: %s%s",
467: buf, strlen(buf) > 3 ? "..." : ""));
468: }
469:
470:
1.1 kristaps 471: int
472: man_pmacro(struct man *m, int ln, char *buf)
473: {
1.34 kristaps 474: int i, j, c, ppos, fl;
475: char mac[5];
476: struct man_node *n;
1.1 kristaps 477:
478: /* Comments and empties are quickly ignored. */
479:
1.29 kristaps 480: fl = m->flags;
1.11 kristaps 481:
1.1 kristaps 482: if (0 == buf[1])
1.11 kristaps 483: goto out;
1.1 kristaps 484:
1.9 kristaps 485: i = 1;
486:
487: if (' ' == buf[i]) {
488: i++;
1.1 kristaps 489: while (buf[i] && ' ' == buf[i])
490: i++;
491: if (0 == buf[i])
1.11 kristaps 492: goto out;
1.1 kristaps 493: }
494:
1.10 kristaps 495: ppos = i;
496:
1.1 kristaps 497: /* Copy the first word into a nil-terminated buffer. */
498:
1.10 kristaps 499: for (j = 0; j < 4; j++, i++) {
500: if (0 == (mac[j] = buf[i]))
1.1 kristaps 501: break;
1.10 kristaps 502: else if (' ' == buf[i])
1.1 kristaps 503: break;
1.38 kristaps 504:
505: /* Check for invalid characters. */
506:
507: if (isgraph((u_char)buf[i]))
508: continue;
509: return(man_perr(m, ln, i, WNPRINT));
1.1 kristaps 510: }
511:
1.9 kristaps 512: mac[j] = 0;
1.1 kristaps 513:
1.9 kristaps 514: if (j == 4 || j < 1) {
1.7 kristaps 515: if ( ! (MAN_IGN_MACRO & m->pflags)) {
1.29 kristaps 516: (void)man_perr(m, ln, ppos, WMACROFORM);
1.7 kristaps 517: goto err;
518: }
1.29 kristaps 519: if ( ! man_pwarn(m, ln, ppos, WMACROFORM))
1.7 kristaps 520: goto err;
1.12 kristaps 521: return(1);
1.7 kristaps 522: }
1.1 kristaps 523:
1.40 kristaps 524: if (MAN_MAX == (c = man_hash_find(mac))) {
1.43 kristaps 525: if ( ! macrowarn(m, ln, mac))
1.7 kristaps 526: goto err;
1.12 kristaps 527: return(1);
1.1 kristaps 528: }
529:
530: /* The macro is sane. Jump to the next word. */
531:
532: while (buf[i] && ' ' == buf[i])
533: i++;
534:
1.34 kristaps 535: /* Remove prior ELINE macro, if applicable. */
536:
537: if (m->flags & MAN_ELINE) {
538: n = m->last;
539: assert(NULL == n->child);
1.37 kristaps 540: assert(0 == n->nchild);
1.34 kristaps 541: if ( ! man_nwarn(m, n, WLNSCOPE))
542: return(0);
543:
544: if (n->prev) {
545: assert(n != n->parent->child);
546: assert(n == n->prev->next);
547: n->prev->next = NULL;
548: m->last = n->prev;
1.37 kristaps 549: m->next = MAN_NEXT_SIBLING;
1.34 kristaps 550: } else {
551: assert(n == n->parent->child);
552: n->parent->child = NULL;
553: m->last = n->parent;
1.37 kristaps 554: m->next = MAN_NEXT_CHILD;
1.34 kristaps 555: }
556:
557: man_node_free(n);
558: m->flags &= ~MAN_ELINE;
559: }
560:
1.1 kristaps 561: /* Begin recursive parse sequence. */
562:
1.29 kristaps 563: assert(man_macros[c].fp);
564:
565: if ( ! (*man_macros[c].fp)(m, c, ln, ppos, &i, buf))
1.1 kristaps 566: goto err;
567:
1.11 kristaps 568: out:
1.29 kristaps 569: if ( ! (MAN_BLINE & fl))
570: return(1);
571:
572: /*
573: * If we've opened a new next-line element scope, then return
574: * now, as the next line will close out the block scope.
575: */
576:
577: if (MAN_ELINE & m->flags)
578: return(1);
579:
580: /* Close out the block scope opened in the prior line. */
1.11 kristaps 581:
1.29 kristaps 582: assert(MAN_BLINE & m->flags);
583: m->flags &= ~MAN_BLINE;
1.11 kristaps 584:
1.29 kristaps 585: if ( ! man_unscope(m, m->last->parent))
586: return(0);
587: return(man_body_alloc(m, ln, 0, m->last->tok));
1.1 kristaps 588:
589: err: /* Error out. */
590:
1.2 kristaps 591: m->flags |= MAN_HALT;
1.1 kristaps 592: return(0);
593: }
1.3 kristaps 594:
1.4 kristaps 595:
596: int
597: man_verr(struct man *man, int ln, int pos, const char *fmt, ...)
598: {
599: char buf[256];
600: va_list ap;
601:
602: if (NULL == man->cb.man_err)
603: return(0);
604:
605: va_start(ap, fmt);
606: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
607: va_end(ap);
608: return((*man->cb.man_err)(man->data, ln, pos, buf));
609: }
610:
611:
612: int
613: man_vwarn(struct man *man, int ln, int pos, const char *fmt, ...)
614: {
615: char buf[256];
616: va_list ap;
617:
618: if (NULL == man->cb.man_warn)
619: return(0);
620:
621: va_start(ap, fmt);
622: (void)vsnprintf(buf, sizeof(buf) - 1, fmt, ap);
623: va_end(ap);
624: return((*man->cb.man_warn)(man->data, ln, pos, buf));
625: }
626:
627:
1.23 kristaps 628: int
1.27 kristaps 629: man_err(struct man *m, int line, int pos, int iserr, enum merr type)
1.23 kristaps 630: {
631: const char *p;
632:
1.27 kristaps 633: p = __man_merrnames[(int)type];
1.23 kristaps 634: assert(p);
635:
636: if (iserr)
637: return(man_verr(m, line, pos, p));
638:
639: return(man_vwarn(m, line, pos, p));
640: }
CVSweb