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