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