Annotation of src/usr.bin/mandoc/main.c, Revision 1.19
1.19 ! schwarze 1: /* $Id: main.c,v 1.18 2009/10/27 21:40:07 schwarze Exp $ */
1.1 kristaps 2: /*
1.2 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.2 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.2 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 <sys/stat.h>
18:
19: #include <assert.h>
20: #include <fcntl.h>
21: #include <stdio.h>
1.17 schwarze 22: #include <stdint.h>
1.1 kristaps 23: #include <stdlib.h>
24: #include <string.h>
25: #include <unistd.h>
26:
27: #include "mdoc.h"
28: #include "man.h"
1.17 schwarze 29: #include "main.h"
30:
31: #define UNCONST(a) ((void *)(uintptr_t)(const void *)(a))
1.1 kristaps 32:
1.16 schwarze 33: typedef void (*out_mdoc)(void *, const struct mdoc *);
34: typedef void (*out_man)(void *, const struct man *);
1.1 kristaps 35: typedef void (*out_free)(void *);
36:
37: struct buf {
38: char *buf;
39: size_t sz;
40: };
41:
42: enum intt {
43: INTT_AUTO,
44: INTT_MDOC,
45: INTT_MAN
46: };
47:
48: enum outt {
49: OUTT_ASCII = 0,
50: OUTT_TREE,
1.17 schwarze 51: OUTT_HTML,
1.1 kristaps 52: OUTT_LINT
53: };
54:
55: struct curparse {
56: const char *file; /* Current parse. */
57: int fd; /* Current parse. */
58: int wflags;
1.13 schwarze 59: #define WARN_WALL (1 << 0) /* All-warnings mask. */
1.1 kristaps 60: #define WARN_WERR (1 << 2) /* Warnings->errors. */
61: int fflags;
62: #define IGN_SCOPE (1 << 0) /* Ignore scope errors. */
63: #define NO_IGN_ESCAPE (1 << 1) /* Don't ignore bad escapes. */
64: #define NO_IGN_MACRO (1 << 2) /* Don't ignore bad macros. */
65: #define NO_IGN_CHARS (1 << 3) /* Don't ignore bad chars. */
1.14 schwarze 66: #define IGN_ERRORS (1 << 4) /* Ignore failed parse. */
1.6 schwarze 67: enum intt inttype; /* Input parsers... */
1.1 kristaps 68: struct man *man;
69: struct man *lastman;
70: struct mdoc *mdoc;
71: struct mdoc *lastmdoc;
1.6 schwarze 72: enum outt outtype; /* Output devices... */
1.1 kristaps 73: out_mdoc outmdoc;
74: out_man outman;
75: out_free outfree;
76: void *outdata;
1.18 schwarze 77: char outopts[BUFSIZ];
1.1 kristaps 78: };
79:
80: static int foptions(int *, char *);
81: static int toptions(enum outt *, char *);
82: static int moptions(enum intt *, char *);
83: static int woptions(int *, char *);
84: static int merr(void *, int, int, const char *);
1.12 schwarze 85: static int mwarn(void *, int, int, const char *);
1.1 kristaps 86: static int ffile(struct buf *, struct buf *,
87: const char *, struct curparse *);
88: static int fdesc(struct buf *, struct buf *,
89: struct curparse *);
90: static int pset(const char *, int, struct curparse *,
91: struct man **, struct mdoc **);
92: static struct man *man_init(struct curparse *);
93: static struct mdoc *mdoc_init(struct curparse *);
1.3 schwarze 94: __dead static void version(void);
1.1 kristaps 95: __dead static void usage(void);
96:
1.19 ! schwarze 97: static const char *progname;
1.1 kristaps 98:
99:
100: int
101: main(int argc, char *argv[])
102: {
103: int c, rc;
104: struct buf ln, blk;
105: struct curparse curp;
106:
1.19 ! schwarze 107: progname = strrchr(argv[0], '/');
! 108: if (progname == NULL)
! 109: progname = argv[0];
! 110: else
! 111: ++progname;
! 112:
! 113: memset(&curp, 0, sizeof(struct curparse));
1.1 kristaps 114:
115: curp.inttype = INTT_AUTO;
116: curp.outtype = OUTT_ASCII;
117:
118: /* LINTED */
1.18 schwarze 119: while (-1 != (c = getopt(argc, argv, "f:m:O:T:VW:")))
1.1 kristaps 120: switch (c) {
121: case ('f'):
122: if ( ! foptions(&curp.fflags, optarg))
1.9 schwarze 123: return(EXIT_FAILURE);
1.1 kristaps 124: break;
125: case ('m'):
126: if ( ! moptions(&curp.inttype, optarg))
1.9 schwarze 127: return(EXIT_FAILURE);
1.1 kristaps 128: break;
1.18 schwarze 129: case ('O'):
130: (void)strlcat(curp.outopts, optarg, BUFSIZ);
131: (void)strlcat(curp.outopts, ",", BUFSIZ);
1.17 schwarze 132: break;
1.1 kristaps 133: case ('T'):
134: if ( ! toptions(&curp.outtype, optarg))
1.9 schwarze 135: return(EXIT_FAILURE);
1.1 kristaps 136: break;
137: case ('W'):
138: if ( ! woptions(&curp.wflags, optarg))
1.9 schwarze 139: return(EXIT_FAILURE);
1.1 kristaps 140: break;
1.3 schwarze 141: case ('V'):
142: version();
143: /* NOTREACHED */
1.1 kristaps 144: default:
145: usage();
146: /* NOTREACHED */
147: }
148:
149: argc -= optind;
150: argv += optind;
151:
1.19 ! schwarze 152: memset(&ln, 0, sizeof(struct buf));
! 153: memset(&blk, 0, sizeof(struct buf));
1.1 kristaps 154:
155: rc = 1;
156:
1.7 schwarze 157: if (NULL == *argv) {
158: curp.file = "<stdin>";
159: curp.fd = STDIN_FILENO;
1.14 schwarze 160:
161: c = fdesc(&blk, &ln, &curp);
162: if ( ! (IGN_ERRORS & curp.fflags))
163: rc = 1 == c ? 1 : 0;
164: else
165: rc = -1 == c ? 0 : 1;
1.7 schwarze 166: }
1.1 kristaps 167:
168: while (rc && *argv) {
1.14 schwarze 169: c = ffile(&blk, &ln, *argv, &curp);
170: if ( ! (IGN_ERRORS & curp.fflags))
171: rc = 1 == c ? 1 : 0;
172: else
173: rc = -1 == c ? 0 : 1;
174:
1.1 kristaps 175: argv++;
176: if (*argv && rc) {
177: if (curp.lastman)
1.19 ! schwarze 178: man_reset(curp.lastman);
1.1 kristaps 179: if (curp.lastmdoc)
1.19 ! schwarze 180: mdoc_reset(curp.lastmdoc);
1.1 kristaps 181: curp.lastman = NULL;
182: curp.lastmdoc = NULL;
183: }
184: }
185:
186: if (blk.buf)
187: free(blk.buf);
188: if (ln.buf)
189: free(ln.buf);
190: if (curp.outfree)
191: (*curp.outfree)(curp.outdata);
192: if (curp.mdoc)
193: mdoc_free(curp.mdoc);
194: if (curp.man)
195: man_free(curp.man);
196:
197: return(rc ? EXIT_SUCCESS : EXIT_FAILURE);
198: }
199:
200:
201: __dead static void
1.3 schwarze 202: version(void)
203: {
204:
1.19 ! schwarze 205: (void)printf("%s %s\n", progname, VERSION);
1.3 schwarze 206: exit(EXIT_SUCCESS);
207: }
208:
209:
210: __dead static void
1.1 kristaps 211: usage(void)
212: {
213:
1.3 schwarze 214: (void)fprintf(stderr, "usage: %s [-V] [-foption...] "
1.18 schwarze 215: "[-mformat] [-Ooption] [-Toutput] "
1.19 ! schwarze 216: "[-Werr...]\n", progname);
1.1 kristaps 217: exit(EXIT_FAILURE);
218: }
219:
220:
221: static struct man *
222: man_init(struct curparse *curp)
223: {
224: int pflags;
225: struct man_cb mancb;
226:
227: mancb.man_err = merr;
1.12 schwarze 228: mancb.man_warn = mwarn;
1.1 kristaps 229:
1.6 schwarze 230: /* Defaults from mandoc.1. */
1.2 schwarze 231:
1.11 schwarze 232: pflags = MAN_IGN_MACRO | MAN_IGN_ESCAPE | MAN_IGN_CHARS;
1.2 schwarze 233:
1.1 kristaps 234: if (curp->fflags & NO_IGN_MACRO)
235: pflags &= ~MAN_IGN_MACRO;
1.8 schwarze 236: if (curp->fflags & NO_IGN_CHARS)
237: pflags &= ~MAN_IGN_CHARS;
1.11 schwarze 238: if (curp->fflags & NO_IGN_ESCAPE)
239: pflags &= ~MAN_IGN_ESCAPE;
1.1 kristaps 240:
1.19 ! schwarze 241: return(man_alloc(curp, pflags, &mancb));
1.1 kristaps 242: }
243:
244:
245: static struct mdoc *
246: mdoc_init(struct curparse *curp)
247: {
248: int pflags;
249: struct mdoc_cb mdoccb;
250:
251: mdoccb.mdoc_err = merr;
1.12 schwarze 252: mdoccb.mdoc_warn = mwarn;
1.1 kristaps 253:
1.6 schwarze 254: /* Defaults from mandoc.1. */
1.2 schwarze 255:
1.1 kristaps 256: pflags = MDOC_IGN_MACRO | MDOC_IGN_ESCAPE | MDOC_IGN_CHARS;
257:
258: if (curp->fflags & IGN_SCOPE)
259: pflags |= MDOC_IGN_SCOPE;
260: if (curp->fflags & NO_IGN_ESCAPE)
261: pflags &= ~MDOC_IGN_ESCAPE;
262: if (curp->fflags & NO_IGN_MACRO)
263: pflags &= ~MDOC_IGN_MACRO;
264: if (curp->fflags & NO_IGN_CHARS)
265: pflags &= ~MDOC_IGN_CHARS;
266:
1.19 ! schwarze 267: return(mdoc_alloc(curp, pflags, &mdoccb));
1.1 kristaps 268: }
269:
270:
271: static int
272: ffile(struct buf *blk, struct buf *ln,
273: const char *file, struct curparse *curp)
274: {
275: int c;
276:
277: curp->file = file;
278: if (-1 == (curp->fd = open(curp->file, O_RDONLY, 0))) {
1.19 ! schwarze 279: perror(curp->file);
1.14 schwarze 280: return(-1);
1.1 kristaps 281: }
282:
283: c = fdesc(blk, ln, curp);
284:
285: if (-1 == close(curp->fd))
1.19 ! schwarze 286: perror(curp->file);
1.1 kristaps 287:
288: return(c);
289: }
290:
291:
292: static int
293: fdesc(struct buf *blk, struct buf *ln, struct curparse *curp)
294: {
295: size_t sz;
296: ssize_t ssz;
297: struct stat st;
1.5 schwarze 298: int j, i, pos, lnn, comment;
1.1 kristaps 299: struct man *man;
300: struct mdoc *mdoc;
301:
302: sz = BUFSIZ;
303: man = NULL;
304: mdoc = NULL;
305:
306: /*
307: * Two buffers: ln and buf. buf is the input buffer optimised
308: * here for each file's block size. ln is a line buffer. Both
309: * growable, hence passed in by ptr-ptr.
310: */
311:
312: if (-1 == fstat(curp->fd, &st))
1.19 ! schwarze 313: perror(curp->file);
1.1 kristaps 314: else if ((size_t)st.st_blksize > sz)
315: sz = st.st_blksize;
316:
317: if (sz > blk->sz) {
318: blk->buf = realloc(blk->buf, sz);
319: if (NULL == blk->buf) {
1.19 ! schwarze 320: perror(NULL);
! 321: exit(EXIT_FAILURE);
1.1 kristaps 322: }
323: blk->sz = sz;
324: }
325:
326: /* Fill buf with file blocksize. */
327:
1.5 schwarze 328: for (lnn = pos = comment = 0; ; ) {
1.1 kristaps 329: if (-1 == (ssz = read(curp->fd, blk->buf, sz))) {
1.19 ! schwarze 330: perror(curp->file);
1.14 schwarze 331: return(-1);
1.1 kristaps 332: } else if (0 == ssz)
333: break;
334:
335: /* Parse the read block into partial or full lines. */
336:
337: for (i = 0; i < (int)ssz; i++) {
338: if (pos >= (int)ln->sz) {
339: ln->sz += 256; /* Step-size. */
340: ln->buf = realloc(ln->buf, ln->sz);
341: if (NULL == ln->buf) {
1.19 ! schwarze 342: perror(NULL);
! 343: return(EXIT_FAILURE);
1.1 kristaps 344: }
345: }
346:
347: if ('\n' != blk->buf[i]) {
1.5 schwarze 348: if (comment)
349: continue;
1.1 kristaps 350: ln->buf[pos++] = blk->buf[i];
1.5 schwarze 351:
352: /* Handle in-line `\"' comments. */
353:
354: if (1 == pos || '\"' != ln->buf[pos - 1])
355: continue;
356:
357: for (j = pos - 2; j >= 0; j--)
358: if ('\\' != ln->buf[j])
359: break;
360:
361: if ( ! ((pos - 2 - j) % 2))
362: continue;
363:
364: comment = 1;
365: pos -= 2;
1.1 kristaps 366: continue;
1.5 schwarze 367: }
1.1 kristaps 368:
1.5 schwarze 369: /* Handle escaped `\\n' newlines. */
1.1 kristaps 370:
1.5 schwarze 371: if (pos > 0 && 0 == comment &&
372: '\\' == ln->buf[pos - 1]) {
1.1 kristaps 373: for (j = pos - 1; j >= 0; j--)
374: if ('\\' != ln->buf[j])
375: break;
376: if ( ! ((pos - j) % 2)) {
377: pos--;
378: lnn++;
379: continue;
380: }
381: }
382:
383: ln->buf[pos] = 0;
384: lnn++;
1.5 schwarze 385:
386: /* If unset, assign parser in pset(). */
1.1 kristaps 387:
388: if ( ! (man || mdoc) && ! pset(ln->buf,
389: pos, curp, &man, &mdoc))
1.14 schwarze 390: return(-1);
1.1 kristaps 391:
1.5 schwarze 392: pos = comment = 0;
393:
394: /* Pass down into parsers. */
1.1 kristaps 395:
396: if (man && ! man_parseln(man, lnn, ln->buf))
397: return(0);
398: if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf))
399: return(0);
400: }
401: }
402:
1.5 schwarze 403: /* NOTE a parser may not have been assigned, yet. */
1.1 kristaps 404:
405: if ( ! (man || mdoc)) {
1.19 ! schwarze 406: fprintf(stderr, "%s: Not a manual\n", curp->file);
1.1 kristaps 407: return(0);
408: }
409:
410: if (mdoc && ! mdoc_endparse(mdoc))
411: return(0);
412: if (man && ! man_endparse(man))
413: return(0);
414:
1.5 schwarze 415: /* If unset, allocate output dev now (if applicable). */
1.1 kristaps 416:
417: if ( ! (curp->outman && curp->outmdoc)) {
418: switch (curp->outtype) {
1.17 schwarze 419: case (OUTT_HTML):
420: curp->outdata = html_alloc(curp->outopts);
421: curp->outman = html_man;
422: curp->outmdoc = html_mdoc;
423: curp->outfree = html_free;
424: break;
1.1 kristaps 425: case (OUTT_TREE):
426: curp->outman = tree_man;
427: curp->outmdoc = tree_mdoc;
428: break;
429: case (OUTT_LINT):
430: break;
431: default:
432: curp->outdata = ascii_alloc();
433: curp->outman = terminal_man;
434: curp->outmdoc = terminal_mdoc;
435: curp->outfree = terminal_free;
436: break;
437: }
438: }
439:
440: /* Execute the out device, if it exists. */
441:
442: if (man && curp->outman)
1.16 schwarze 443: (*curp->outman)(curp->outdata, man);
1.1 kristaps 444: if (mdoc && curp->outmdoc)
1.16 schwarze 445: (*curp->outmdoc)(curp->outdata, mdoc);
1.1 kristaps 446:
447: return(1);
448: }
449:
450:
451: static int
452: pset(const char *buf, int pos, struct curparse *curp,
453: struct man **man, struct mdoc **mdoc)
454: {
1.5 schwarze 455: int i;
1.1 kristaps 456:
457: /*
458: * Try to intuit which kind of manual parser should be used. If
459: * passed in by command-line (-man, -mdoc), then use that
460: * explicitly. If passed as -mandoc, then try to guess from the
1.5 schwarze 461: * line: either skip dot-lines, use -mdoc when finding `.Dt', or
1.1 kristaps 462: * default to -man, which is more lenient.
463: */
464:
1.5 schwarze 465: if (buf[0] == '.') {
466: for (i = 1; buf[i]; i++)
467: if (' ' != buf[i] && '\t' != buf[i])
468: break;
469: if (0 == buf[i])
470: return(1);
471: }
1.1 kristaps 472:
473: switch (curp->inttype) {
474: case (INTT_MDOC):
475: if (NULL == curp->mdoc)
476: curp->mdoc = mdoc_init(curp);
477: if (NULL == (*mdoc = curp->mdoc))
478: return(0);
479: curp->lastmdoc = *mdoc;
480: return(1);
481: case (INTT_MAN):
482: if (NULL == curp->man)
483: curp->man = man_init(curp);
484: if (NULL == (*man = curp->man))
485: return(0);
486: curp->lastman = *man;
487: return(1);
488: default:
489: break;
490: }
491:
492: if (pos >= 3 && 0 == memcmp(buf, ".Dd", 3)) {
493: if (NULL == curp->mdoc)
494: curp->mdoc = mdoc_init(curp);
495: if (NULL == (*mdoc = curp->mdoc))
496: return(0);
497: curp->lastmdoc = *mdoc;
498: return(1);
499: }
500:
501: if (NULL == curp->man)
502: curp->man = man_init(curp);
503: if (NULL == (*man = curp->man))
504: return(0);
505: curp->lastman = *man;
506: return(1);
507: }
508:
509:
510: static int
511: moptions(enum intt *tflags, char *arg)
512: {
513:
514: if (0 == strcmp(arg, "doc"))
515: *tflags = INTT_MDOC;
516: else if (0 == strcmp(arg, "andoc"))
517: *tflags = INTT_AUTO;
518: else if (0 == strcmp(arg, "an"))
519: *tflags = INTT_MAN;
520: else {
1.19 ! schwarze 521: fprintf(stderr, "%s: Bad argument", arg);
1.1 kristaps 522: return(0);
523: }
524:
525: return(1);
526: }
527:
528:
529: static int
530: toptions(enum outt *tflags, char *arg)
531: {
532:
533: if (0 == strcmp(arg, "ascii"))
534: *tflags = OUTT_ASCII;
535: else if (0 == strcmp(arg, "lint"))
536: *tflags = OUTT_LINT;
537: else if (0 == strcmp(arg, "tree"))
538: *tflags = OUTT_TREE;
1.17 schwarze 539: else if (0 == strcmp(arg, "html"))
540: *tflags = OUTT_HTML;
1.1 kristaps 541: else {
1.19 ! schwarze 542: fprintf(stderr, "%s: Bad argument", arg);
1.1 kristaps 543: return(0);
544: }
545:
546: return(1);
547: }
548:
549:
550: static int
551: foptions(int *fflags, char *arg)
552: {
1.10 schwarze 553: char *v, *o;
1.19 ! schwarze 554: const char *toks[8];
1.1 kristaps 555:
556: toks[0] = "ign-scope";
557: toks[1] = "no-ign-escape";
558: toks[2] = "no-ign-macro";
559: toks[3] = "no-ign-chars";
1.14 schwarze 560: toks[4] = "ign-errors";
561: toks[5] = "strict";
1.19 ! schwarze 562: toks[6] = "ign-escape";
! 563: toks[7] = NULL;
1.1 kristaps 564:
1.10 schwarze 565: while (*arg) {
566: o = arg;
1.17 schwarze 567: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.1 kristaps 568: case (0):
569: *fflags |= IGN_SCOPE;
570: break;
571: case (1):
572: *fflags |= NO_IGN_ESCAPE;
573: break;
574: case (2):
575: *fflags |= NO_IGN_MACRO;
576: break;
577: case (3):
578: *fflags |= NO_IGN_CHARS;
579: break;
580: case (4):
1.14 schwarze 581: *fflags |= IGN_ERRORS;
582: break;
583: case (5):
1.1 kristaps 584: *fflags |= NO_IGN_ESCAPE |
585: NO_IGN_MACRO | NO_IGN_CHARS;
586: break;
1.19 ! schwarze 587: case (6):
! 588: *fflags &= ~NO_IGN_ESCAPE;
! 589: break;
1.1 kristaps 590: default:
1.19 ! schwarze 591: fprintf(stderr, "%s: Bad argument", o);
1.1 kristaps 592: return(0);
593: }
1.10 schwarze 594: }
1.1 kristaps 595:
596: return(1);
597: }
598:
599:
600: static int
601: woptions(int *wflags, char *arg)
602: {
1.10 schwarze 603: char *v, *o;
1.17 schwarze 604: const char *toks[3];
1.1 kristaps 605:
606: toks[0] = "all";
1.13 schwarze 607: toks[1] = "error";
608: toks[2] = NULL;
1.1 kristaps 609:
1.10 schwarze 610: while (*arg) {
611: o = arg;
1.17 schwarze 612: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.1 kristaps 613: case (0):
614: *wflags |= WARN_WALL;
615: break;
616: case (1):
617: *wflags |= WARN_WERR;
618: break;
619: default:
1.19 ! schwarze 620: fprintf(stderr, "%s: Bad argument", o);
1.1 kristaps 621: return(0);
622: }
1.10 schwarze 623: }
1.1 kristaps 624:
625: return(1);
626: }
627:
628:
629: /* ARGSUSED */
630: static int
631: merr(void *arg, int line, int col, const char *msg)
632: {
633: struct curparse *curp;
634:
635: curp = (struct curparse *)arg;
1.13 schwarze 636:
1.15 schwarze 637: (void)fprintf(stderr, "%s:%d:%d: error: %s\n",
638: curp->file, line, col + 1, msg);
1.2 schwarze 639:
1.1 kristaps 640: return(0);
641: }
642:
643:
644: static int
1.12 schwarze 645: mwarn(void *arg, int line, int col, const char *msg)
1.1 kristaps 646: {
647: struct curparse *curp;
648:
649: curp = (struct curparse *)arg;
650:
1.12 schwarze 651: if ( ! (curp->wflags & WARN_WALL))
1.1 kristaps 652: return(1);
653:
1.15 schwarze 654: (void)fprintf(stderr, "%s:%d:%d: warning: %s\n",
655: curp->file, line, col + 1, msg);
1.1 kristaps 656:
657: if ( ! (curp->wflags & WARN_WERR))
658: return(1);
1.2 schwarze 659:
1.1 kristaps 660: return(0);
661: }
662:
![[BACK]](/icons/back.gif){kind=icon}
Return to main.c CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc