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