Annotation of src/usr.bin/mandoc/main.c, Revision 1.91
1.91 ! schwarze 1: /* $Id: main.c,v 1.90 2014/04/20 16:44:44 schwarze Exp $ */
1.1 kristaps 2: /*
1.64 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.87 schwarze 4: * Copyright (c) 2010, 2011, 2012, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.86 schwarze 5: * Copyright (c) 2010 Joerg Sonnenberger <joerg@netbsd.org>
1.1 kristaps 6: *
7: * Permission to use, copy, modify, and distribute this software for any
1.2 schwarze 8: * purpose with or without fee is hereby granted, provided that the above
9: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 10: *
1.2 schwarze 11: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 18: */
19:
20: #include <assert.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:
1.30 schwarze 27: #include "mandoc.h"
1.89 schwarze 28: #include "mandoc_aux.h"
1.38 schwarze 29: #include "main.h"
1.1 kristaps 30: #include "mdoc.h"
31: #include "man.h"
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: enum outt {
1.76 schwarze 38: OUTT_ASCII = 0, /* -Tascii */
1.77 schwarze 39: OUTT_LOCALE, /* -Tlocale */
40: OUTT_UTF8, /* -Tutf8 */
1.76 schwarze 41: OUTT_TREE, /* -Ttree */
1.78 schwarze 42: OUTT_MAN, /* -Tman */
1.76 schwarze 43: OUTT_HTML, /* -Thtml */
44: OUTT_XHTML, /* -Txhtml */
45: OUTT_LINT, /* -Tlint */
46: OUTT_PS, /* -Tps */
47: OUTT_PDF /* -Tpdf */
1.1 kristaps 48: };
49:
50: struct curparse {
1.76 schwarze 51: struct mparse *mp;
1.75 schwarze 52: enum mandoclevel wlevel; /* ignore messages below this */
53: int wstop; /* stop after a file with a warning */
1.90 schwarze 54: enum outt outtype; /* which output to use */
1.33 schwarze 55: out_mdoc outmdoc; /* mdoc output ptr */
1.90 schwarze 56: out_man outman; /* man output ptr */
1.33 schwarze 57: out_free outfree; /* free output ptr */
58: void *outdata; /* data for output */
59: char outopts[BUFSIZ]; /* buf of output opts */
60: };
61:
1.79 schwarze 62: int apropos(int, char**);
63: int mandocdb(int, char**);
64:
1.87 schwarze 65: static int moptions(int *, char *);
1.76 schwarze 66: static void mmsg(enum mandocerr, enum mandoclevel,
67: const char *, int, int, const char *);
1.90 schwarze 68: static void parse(struct curparse *, int,
1.76 schwarze 69: const char *, enum mandoclevel *);
1.27 schwarze 70: static int toptions(struct curparse *, char *);
71: static void usage(void) __attribute__((noreturn));
1.20 schwarze 72: static void version(void) __attribute__((noreturn));
1.45 schwarze 73: static int woptions(struct curparse *, char *);
1.1 kristaps 74:
1.19 schwarze 75: static const char *progname;
1.1 kristaps 76:
1.90 schwarze 77:
1.1 kristaps 78: int
79: main(int argc, char *argv[])
80: {
1.27 schwarze 81: int c;
1.1 kristaps 82: struct curparse curp;
1.87 schwarze 83: int options;
1.76 schwarze 84: enum mandoclevel rc;
1.83 schwarze 85: char *defos;
1.1 kristaps 86:
1.19 schwarze 87: progname = strrchr(argv[0], '/');
88: if (progname == NULL)
89: progname = argv[0];
90: else
91: ++progname;
1.79 schwarze 92:
1.81 schwarze 93: if (0 == strncmp(progname, "apropos", 7) ||
94: 0 == strncmp(progname, "whatis", 6))
1.79 schwarze 95: return(apropos(argc, argv));
1.82 schwarze 96: if (0 == strncmp(progname, "mandocdb", 8) ||
97: 0 == strncmp(progname, "makewhatis", 10))
1.79 schwarze 98: return(mandocdb(argc, argv));
1.19 schwarze 99:
100: memset(&curp, 0, sizeof(struct curparse));
1.1 kristaps 101:
1.87 schwarze 102: options = MPARSE_SO;
1.1 kristaps 103: curp.outtype = OUTT_ASCII;
1.45 schwarze 104: curp.wlevel = MANDOCLEVEL_FATAL;
1.83 schwarze 105: defos = NULL;
1.1 kristaps 106:
1.83 schwarze 107: while (-1 != (c = getopt(argc, argv, "I:m:O:T:VW:")))
1.1 kristaps 108: switch (c) {
1.90 schwarze 109: case 'I':
1.83 schwarze 110: if (strncmp(optarg, "os=", 3)) {
1.90 schwarze 111: fprintf(stderr,
112: "-I%s: Bad argument\n", optarg);
1.83 schwarze 113: return((int)MANDOCLEVEL_BADARG);
114: }
115: if (defos) {
1.90 schwarze 116: fprintf(stderr,
117: "-I%s: Duplicate argument\n",
118: optarg);
1.83 schwarze 119: return((int)MANDOCLEVEL_BADARG);
120: }
121: defos = mandoc_strdup(optarg + 3);
122: break;
1.90 schwarze 123: case 'm':
1.87 schwarze 124: if ( ! moptions(&options, optarg))
1.47 schwarze 125: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 126: break;
1.90 schwarze 127: case 'O':
1.18 schwarze 128: (void)strlcat(curp.outopts, optarg, BUFSIZ);
129: (void)strlcat(curp.outopts, ",", BUFSIZ);
1.17 schwarze 130: break;
1.90 schwarze 131: case 'T':
1.22 schwarze 132: if ( ! toptions(&curp, optarg))
1.47 schwarze 133: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 134: break;
1.90 schwarze 135: case 'W':
1.45 schwarze 136: if ( ! woptions(&curp, optarg))
1.47 schwarze 137: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 138: break;
1.90 schwarze 139: case 'V':
1.3 schwarze 140: version();
141: /* NOTREACHED */
1.1 kristaps 142: default:
143: usage();
144: /* NOTREACHED */
145: }
146:
1.87 schwarze 147: curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
1.76 schwarze 148:
1.80 schwarze 149: /*
150: * Conditionally start up the lookaside buffer before parsing.
151: */
152: if (OUTT_MAN == curp.outtype)
153: mparse_keep(curp.mp);
154:
1.1 kristaps 155: argc -= optind;
156: argv += optind;
157:
1.76 schwarze 158: rc = MANDOCLEVEL_OK;
1.14 schwarze 159:
1.76 schwarze 160: if (NULL == *argv)
161: parse(&curp, STDIN_FILENO, "<stdin>", &rc);
1.27 schwarze 162:
163: while (*argv) {
1.76 schwarze 164: parse(&curp, -1, *argv, &rc);
165: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27 schwarze 166: break;
167: ++argv;
1.1 kristaps 168: }
169:
170: if (curp.outfree)
171: (*curp.outfree)(curp.outdata);
1.76 schwarze 172: if (curp.mp)
173: mparse_free(curp.mp);
1.83 schwarze 174: free(defos);
1.1 kristaps 175:
1.76 schwarze 176: return((int)rc);
1.1 kristaps 177: }
178:
1.20 schwarze 179: static void
1.3 schwarze 180: version(void)
181: {
182:
1.76 schwarze 183: printf("%s %s\n", progname, VERSION);
1.47 schwarze 184: exit((int)MANDOCLEVEL_OK);
1.3 schwarze 185: }
186:
1.20 schwarze 187: static void
1.1 kristaps 188: usage(void)
189: {
190:
1.76 schwarze 191: fprintf(stderr, "usage: %s "
1.59 schwarze 192: "[-V] "
1.84 jmc 193: "[-Ios=name] "
1.59 schwarze 194: "[-mformat] "
195: "[-Ooption] "
196: "[-Toutput] "
1.84 jmc 197: "[-Wlevel]\n"
1.90 schwarze 198: "\t [file ...]\n",
1.59 schwarze 199: progname);
200:
1.47 schwarze 201: exit((int)MANDOCLEVEL_BADARG);
1.1 kristaps 202: }
203:
1.27 schwarze 204: static void
1.90 schwarze 205: parse(struct curparse *curp, int fd, const char *file,
206: enum mandoclevel *level)
1.52 schwarze 207: {
1.76 schwarze 208: enum mandoclevel rc;
209: struct mdoc *mdoc;
210: struct man *man;
1.52 schwarze 211:
1.76 schwarze 212: /* Begin by parsing the file itself. */
1.52 schwarze 213:
1.76 schwarze 214: assert(file);
215: assert(fd >= -1);
1.52 schwarze 216:
1.76 schwarze 217: rc = mparse_readfd(curp->mp, fd, file);
1.1 kristaps 218:
1.76 schwarze 219: /* Stop immediately if the parse has failed. */
1.1 kristaps 220:
1.76 schwarze 221: if (MANDOCLEVEL_FATAL <= rc)
1.51 schwarze 222: goto cleanup;
223:
224: /*
1.76 schwarze 225: * With -Wstop and warnings or errors of at least the requested
226: * level, do not produce output.
1.51 schwarze 227: */
228:
1.76 schwarze 229: if (MANDOCLEVEL_OK != rc && curp->wstop)
1.51 schwarze 230: goto cleanup;
231:
232: /* If unset, allocate output dev now (if applicable). */
233:
234: if ( ! (curp->outman && curp->outmdoc)) {
235: switch (curp->outtype) {
1.90 schwarze 236: case OUTT_XHTML:
1.51 schwarze 237: curp->outdata = xhtml_alloc(curp->outopts);
1.77 schwarze 238: curp->outfree = html_free;
1.51 schwarze 239: break;
1.90 schwarze 240: case OUTT_HTML:
1.51 schwarze 241: curp->outdata = html_alloc(curp->outopts);
1.77 schwarze 242: curp->outfree = html_free;
243: break;
1.90 schwarze 244: case OUTT_UTF8:
1.77 schwarze 245: curp->outdata = utf8_alloc(curp->outopts);
246: curp->outfree = ascii_free;
247: break;
1.90 schwarze 248: case OUTT_LOCALE:
1.77 schwarze 249: curp->outdata = locale_alloc(curp->outopts);
250: curp->outfree = ascii_free;
1.51 schwarze 251: break;
1.90 schwarze 252: case OUTT_ASCII:
1.51 schwarze 253: curp->outdata = ascii_alloc(curp->outopts);
254: curp->outfree = ascii_free;
255: break;
1.90 schwarze 256: case OUTT_PDF:
1.51 schwarze 257: curp->outdata = pdf_alloc(curp->outopts);
258: curp->outfree = pspdf_free;
259: break;
1.90 schwarze 260: case OUTT_PS:
1.51 schwarze 261: curp->outdata = ps_alloc(curp->outopts);
262: curp->outfree = pspdf_free;
263: break;
264: default:
265: break;
266: }
267:
268: switch (curp->outtype) {
1.90 schwarze 269: case OUTT_HTML:
1.51 schwarze 270: /* FALLTHROUGH */
1.90 schwarze 271: case OUTT_XHTML:
1.51 schwarze 272: curp->outman = html_man;
273: curp->outmdoc = html_mdoc;
274: break;
1.90 schwarze 275: case OUTT_TREE:
1.51 schwarze 276: curp->outman = tree_man;
277: curp->outmdoc = tree_mdoc;
278: break;
1.90 schwarze 279: case OUTT_MAN:
1.78 schwarze 280: curp->outmdoc = man_mdoc;
1.80 schwarze 281: curp->outman = man_man;
1.78 schwarze 282: break;
1.90 schwarze 283: case OUTT_PDF:
1.51 schwarze 284: /* FALLTHROUGH */
1.90 schwarze 285: case OUTT_ASCII:
1.51 schwarze 286: /* FALLTHROUGH */
1.90 schwarze 287: case OUTT_UTF8:
1.77 schwarze 288: /* FALLTHROUGH */
1.90 schwarze 289: case OUTT_LOCALE:
1.77 schwarze 290: /* FALLTHROUGH */
1.90 schwarze 291: case OUTT_PS:
1.51 schwarze 292: curp->outman = terminal_man;
293: curp->outmdoc = terminal_mdoc;
294: break;
295: default:
296: break;
297: }
298: }
299:
1.88 schwarze 300: mparse_result(curp->mp, &mdoc, &man, NULL);
1.76 schwarze 301:
1.51 schwarze 302: /* Execute the out device, if it exists. */
303:
1.76 schwarze 304: if (man && curp->outman)
305: (*curp->outman)(curp->outdata, man);
306: if (mdoc && curp->outmdoc)
307: (*curp->outmdoc)(curp->outdata, mdoc);
1.51 schwarze 308:
309: cleanup:
1.59 schwarze 310:
1.76 schwarze 311: mparse_reset(curp->mp);
1.59 schwarze 312:
1.76 schwarze 313: if (*level < rc)
314: *level = rc;
1.1 kristaps 315: }
316:
317: static int
1.87 schwarze 318: moptions(int *options, char *arg)
1.1 kristaps 319: {
320:
321: if (0 == strcmp(arg, "doc"))
1.87 schwarze 322: *options |= MPARSE_MDOC;
1.1 kristaps 323: else if (0 == strcmp(arg, "andoc"))
1.87 schwarze 324: /* nothing to do */;
1.1 kristaps 325: else if (0 == strcmp(arg, "an"))
1.87 schwarze 326: *options |= MPARSE_MAN;
1.1 kristaps 327: else {
1.20 schwarze 328: fprintf(stderr, "%s: Bad argument\n", arg);
1.1 kristaps 329: return(0);
330: }
331:
332: return(1);
333: }
334:
335: static int
1.22 schwarze 336: toptions(struct curparse *curp, char *arg)
1.1 kristaps 337: {
338:
339: if (0 == strcmp(arg, "ascii"))
1.22 schwarze 340: curp->outtype = OUTT_ASCII;
341: else if (0 == strcmp(arg, "lint")) {
342: curp->outtype = OUTT_LINT;
1.45 schwarze 343: curp->wlevel = MANDOCLEVEL_WARNING;
1.76 schwarze 344: } else if (0 == strcmp(arg, "tree"))
1.22 schwarze 345: curp->outtype = OUTT_TREE;
1.78 schwarze 346: else if (0 == strcmp(arg, "man"))
347: curp->outtype = OUTT_MAN;
1.17 schwarze 348: else if (0 == strcmp(arg, "html"))
1.22 schwarze 349: curp->outtype = OUTT_HTML;
1.77 schwarze 350: else if (0 == strcmp(arg, "utf8"))
351: curp->outtype = OUTT_UTF8;
352: else if (0 == strcmp(arg, "locale"))
353: curp->outtype = OUTT_LOCALE;
1.21 schwarze 354: else if (0 == strcmp(arg, "xhtml"))
1.22 schwarze 355: curp->outtype = OUTT_XHTML;
1.36 schwarze 356: else if (0 == strcmp(arg, "ps"))
357: curp->outtype = OUTT_PS;
1.43 schwarze 358: else if (0 == strcmp(arg, "pdf"))
359: curp->outtype = OUTT_PDF;
1.1 kristaps 360: else {
1.20 schwarze 361: fprintf(stderr, "%s: Bad argument\n", arg);
1.1 kristaps 362: return(0);
363: }
364:
365: return(1);
366: }
367:
368: static int
1.45 schwarze 369: woptions(struct curparse *curp, char *arg)
1.1 kristaps 370: {
1.10 schwarze 371: char *v, *o;
1.90 schwarze 372: const char *toks[6];
1.1 kristaps 373:
1.45 schwarze 374: toks[0] = "stop";
375: toks[1] = "all";
376: toks[2] = "warning";
377: toks[3] = "error";
378: toks[4] = "fatal";
379: toks[5] = NULL;
1.1 kristaps 380:
1.10 schwarze 381: while (*arg) {
382: o = arg;
1.17 schwarze 383: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.90 schwarze 384: case 0:
1.45 schwarze 385: curp->wstop = 1;
1.1 kristaps 386: break;
1.90 schwarze 387: case 1:
1.45 schwarze 388: /* FALLTHROUGH */
1.90 schwarze 389: case 2:
1.45 schwarze 390: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 391: break;
1.90 schwarze 392: case 3:
1.45 schwarze 393: curp->wlevel = MANDOCLEVEL_ERROR;
1.1 kristaps 394: break;
1.90 schwarze 395: case 4:
1.45 schwarze 396: curp->wlevel = MANDOCLEVEL_FATAL;
1.19 schwarze 397: break;
1.1 kristaps 398: default:
1.45 schwarze 399: fprintf(stderr, "-W%s: Bad argument\n", o);
1.1 kristaps 400: return(0);
401: }
1.10 schwarze 402: }
1.1 kristaps 403:
404: return(1);
405: }
406:
1.75 schwarze 407: static void
1.90 schwarze 408: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76 schwarze 409: const char *file, int line, int col, const char *msg)
1.30 schwarze 410: {
1.45 schwarze 411:
1.91 ! schwarze 412: fprintf(stderr, "%s: %s:%d:%d: %s: %s", progname,
! 413: file, line, col + 1,
1.90 schwarze 414: mparse_strlevel(lvl), mparse_strerror(t));
1.30 schwarze 415:
416: if (msg)
417: fprintf(stderr, ": %s", msg);
1.76 schwarze 418:
1.30 schwarze 419: fputc('\n', stderr);
420: }