Annotation of src/usr.bin/mandoc/main.c, Revision 1.93
1.93 ! schwarze 1: /* $Id: main.c,v 1.92 2014/06/20 22:58:41 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,
1.93 ! schwarze 112: "%s: -I%s: Bad argument\n",
! 113: progname, optarg);
1.83 schwarze 114: return((int)MANDOCLEVEL_BADARG);
115: }
116: if (defos) {
1.90 schwarze 117: fprintf(stderr,
1.93 ! schwarze 118: "%s: -I%s: Duplicate argument\n",
! 119: progname, optarg);
1.83 schwarze 120: return((int)MANDOCLEVEL_BADARG);
121: }
122: defos = mandoc_strdup(optarg + 3);
123: break;
1.90 schwarze 124: case 'm':
1.87 schwarze 125: if ( ! moptions(&options, optarg))
1.47 schwarze 126: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 127: break;
1.90 schwarze 128: case 'O':
1.18 schwarze 129: (void)strlcat(curp.outopts, optarg, BUFSIZ);
130: (void)strlcat(curp.outopts, ",", BUFSIZ);
1.17 schwarze 131: break;
1.90 schwarze 132: case 'T':
1.22 schwarze 133: if ( ! toptions(&curp, optarg))
1.47 schwarze 134: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 135: break;
1.90 schwarze 136: case 'W':
1.45 schwarze 137: if ( ! woptions(&curp, optarg))
1.47 schwarze 138: return((int)MANDOCLEVEL_BADARG);
1.1 kristaps 139: break;
1.90 schwarze 140: case 'V':
1.3 schwarze 141: version();
142: /* NOTREACHED */
1.1 kristaps 143: default:
144: usage();
145: /* NOTREACHED */
146: }
147:
1.87 schwarze 148: curp.mp = mparse_alloc(options, curp.wlevel, mmsg, defos);
1.76 schwarze 149:
1.80 schwarze 150: /*
151: * Conditionally start up the lookaside buffer before parsing.
152: */
153: if (OUTT_MAN == curp.outtype)
154: mparse_keep(curp.mp);
155:
1.1 kristaps 156: argc -= optind;
157: argv += optind;
158:
1.76 schwarze 159: rc = MANDOCLEVEL_OK;
1.14 schwarze 160:
1.76 schwarze 161: if (NULL == *argv)
162: parse(&curp, STDIN_FILENO, "<stdin>", &rc);
1.27 schwarze 163:
164: while (*argv) {
1.76 schwarze 165: parse(&curp, -1, *argv, &rc);
166: if (MANDOCLEVEL_OK != rc && curp.wstop)
1.27 schwarze 167: break;
168: ++argv;
1.1 kristaps 169: }
170:
171: if (curp.outfree)
172: (*curp.outfree)(curp.outdata);
1.76 schwarze 173: if (curp.mp)
174: mparse_free(curp.mp);
1.83 schwarze 175: free(defos);
1.1 kristaps 176:
1.76 schwarze 177: return((int)rc);
1.1 kristaps 178: }
179:
1.20 schwarze 180: static void
1.3 schwarze 181: version(void)
182: {
183:
1.76 schwarze 184: printf("%s %s\n", progname, VERSION);
1.47 schwarze 185: exit((int)MANDOCLEVEL_OK);
1.3 schwarze 186: }
187:
1.20 schwarze 188: static void
1.1 kristaps 189: usage(void)
190: {
191:
1.76 schwarze 192: fprintf(stderr, "usage: %s "
1.59 schwarze 193: "[-V] "
1.84 jmc 194: "[-Ios=name] "
1.59 schwarze 195: "[-mformat] "
196: "[-Ooption] "
197: "[-Toutput] "
1.84 jmc 198: "[-Wlevel]\n"
1.90 schwarze 199: "\t [file ...]\n",
1.59 schwarze 200: progname);
201:
1.47 schwarze 202: exit((int)MANDOCLEVEL_BADARG);
1.1 kristaps 203: }
204:
1.27 schwarze 205: static void
1.90 schwarze 206: parse(struct curparse *curp, int fd, const char *file,
207: enum mandoclevel *level)
1.52 schwarze 208: {
1.76 schwarze 209: enum mandoclevel rc;
210: struct mdoc *mdoc;
211: struct man *man;
1.52 schwarze 212:
1.76 schwarze 213: /* Begin by parsing the file itself. */
1.52 schwarze 214:
1.76 schwarze 215: assert(file);
216: assert(fd >= -1);
1.52 schwarze 217:
1.76 schwarze 218: rc = mparse_readfd(curp->mp, fd, file);
1.1 kristaps 219:
1.76 schwarze 220: /* Stop immediately if the parse has failed. */
1.1 kristaps 221:
1.76 schwarze 222: if (MANDOCLEVEL_FATAL <= rc)
1.51 schwarze 223: goto cleanup;
224:
225: /*
1.76 schwarze 226: * With -Wstop and warnings or errors of at least the requested
227: * level, do not produce output.
1.51 schwarze 228: */
229:
1.76 schwarze 230: if (MANDOCLEVEL_OK != rc && curp->wstop)
1.51 schwarze 231: goto cleanup;
232:
233: /* If unset, allocate output dev now (if applicable). */
234:
235: if ( ! (curp->outman && curp->outmdoc)) {
236: switch (curp->outtype) {
1.90 schwarze 237: case OUTT_XHTML:
1.51 schwarze 238: curp->outdata = xhtml_alloc(curp->outopts);
1.77 schwarze 239: curp->outfree = html_free;
1.51 schwarze 240: break;
1.90 schwarze 241: case OUTT_HTML:
1.51 schwarze 242: curp->outdata = html_alloc(curp->outopts);
1.77 schwarze 243: curp->outfree = html_free;
244: break;
1.90 schwarze 245: case OUTT_UTF8:
1.77 schwarze 246: curp->outdata = utf8_alloc(curp->outopts);
247: curp->outfree = ascii_free;
248: break;
1.90 schwarze 249: case OUTT_LOCALE:
1.77 schwarze 250: curp->outdata = locale_alloc(curp->outopts);
251: curp->outfree = ascii_free;
1.51 schwarze 252: break;
1.90 schwarze 253: case OUTT_ASCII:
1.51 schwarze 254: curp->outdata = ascii_alloc(curp->outopts);
255: curp->outfree = ascii_free;
256: break;
1.90 schwarze 257: case OUTT_PDF:
1.51 schwarze 258: curp->outdata = pdf_alloc(curp->outopts);
259: curp->outfree = pspdf_free;
260: break;
1.90 schwarze 261: case OUTT_PS:
1.51 schwarze 262: curp->outdata = ps_alloc(curp->outopts);
263: curp->outfree = pspdf_free;
264: break;
265: default:
266: break;
267: }
268:
269: switch (curp->outtype) {
1.90 schwarze 270: case OUTT_HTML:
1.51 schwarze 271: /* FALLTHROUGH */
1.90 schwarze 272: case OUTT_XHTML:
1.51 schwarze 273: curp->outman = html_man;
274: curp->outmdoc = html_mdoc;
275: break;
1.90 schwarze 276: case OUTT_TREE:
1.51 schwarze 277: curp->outman = tree_man;
278: curp->outmdoc = tree_mdoc;
279: break;
1.90 schwarze 280: case OUTT_MAN:
1.78 schwarze 281: curp->outmdoc = man_mdoc;
1.80 schwarze 282: curp->outman = man_man;
1.78 schwarze 283: break;
1.90 schwarze 284: case OUTT_PDF:
1.51 schwarze 285: /* FALLTHROUGH */
1.90 schwarze 286: case OUTT_ASCII:
1.51 schwarze 287: /* FALLTHROUGH */
1.90 schwarze 288: case OUTT_UTF8:
1.77 schwarze 289: /* FALLTHROUGH */
1.90 schwarze 290: case OUTT_LOCALE:
1.77 schwarze 291: /* FALLTHROUGH */
1.90 schwarze 292: case OUTT_PS:
1.51 schwarze 293: curp->outman = terminal_man;
294: curp->outmdoc = terminal_mdoc;
295: break;
296: default:
297: break;
298: }
299: }
300:
1.88 schwarze 301: mparse_result(curp->mp, &mdoc, &man, NULL);
1.76 schwarze 302:
1.51 schwarze 303: /* Execute the out device, if it exists. */
304:
1.76 schwarze 305: if (man && curp->outman)
306: (*curp->outman)(curp->outdata, man);
307: if (mdoc && curp->outmdoc)
308: (*curp->outmdoc)(curp->outdata, mdoc);
1.51 schwarze 309:
310: cleanup:
1.59 schwarze 311:
1.76 schwarze 312: mparse_reset(curp->mp);
1.59 schwarze 313:
1.76 schwarze 314: if (*level < rc)
315: *level = rc;
1.1 kristaps 316: }
317:
318: static int
1.87 schwarze 319: moptions(int *options, char *arg)
1.1 kristaps 320: {
321:
322: if (0 == strcmp(arg, "doc"))
1.87 schwarze 323: *options |= MPARSE_MDOC;
1.1 kristaps 324: else if (0 == strcmp(arg, "andoc"))
1.87 schwarze 325: /* nothing to do */;
1.1 kristaps 326: else if (0 == strcmp(arg, "an"))
1.87 schwarze 327: *options |= MPARSE_MAN;
1.1 kristaps 328: else {
1.93 ! schwarze 329: fprintf(stderr, "%s: -m%s: Bad argument\n",
! 330: progname, arg);
1.1 kristaps 331: return(0);
332: }
333:
334: return(1);
335: }
336:
337: static int
1.22 schwarze 338: toptions(struct curparse *curp, char *arg)
1.1 kristaps 339: {
340:
341: if (0 == strcmp(arg, "ascii"))
1.22 schwarze 342: curp->outtype = OUTT_ASCII;
343: else if (0 == strcmp(arg, "lint")) {
344: curp->outtype = OUTT_LINT;
1.45 schwarze 345: curp->wlevel = MANDOCLEVEL_WARNING;
1.76 schwarze 346: } else if (0 == strcmp(arg, "tree"))
1.22 schwarze 347: curp->outtype = OUTT_TREE;
1.78 schwarze 348: else if (0 == strcmp(arg, "man"))
349: curp->outtype = OUTT_MAN;
1.17 schwarze 350: else if (0 == strcmp(arg, "html"))
1.22 schwarze 351: curp->outtype = OUTT_HTML;
1.77 schwarze 352: else if (0 == strcmp(arg, "utf8"))
353: curp->outtype = OUTT_UTF8;
354: else if (0 == strcmp(arg, "locale"))
355: curp->outtype = OUTT_LOCALE;
1.21 schwarze 356: else if (0 == strcmp(arg, "xhtml"))
1.22 schwarze 357: curp->outtype = OUTT_XHTML;
1.36 schwarze 358: else if (0 == strcmp(arg, "ps"))
359: curp->outtype = OUTT_PS;
1.43 schwarze 360: else if (0 == strcmp(arg, "pdf"))
361: curp->outtype = OUTT_PDF;
1.1 kristaps 362: else {
1.93 ! schwarze 363: fprintf(stderr, "%s: -T%s: Bad argument\n",
! 364: progname, arg);
1.1 kristaps 365: return(0);
366: }
367:
368: return(1);
369: }
370:
371: static int
1.45 schwarze 372: woptions(struct curparse *curp, char *arg)
1.1 kristaps 373: {
1.10 schwarze 374: char *v, *o;
1.90 schwarze 375: const char *toks[6];
1.1 kristaps 376:
1.45 schwarze 377: toks[0] = "stop";
378: toks[1] = "all";
379: toks[2] = "warning";
380: toks[3] = "error";
381: toks[4] = "fatal";
382: toks[5] = NULL;
1.1 kristaps 383:
1.10 schwarze 384: while (*arg) {
385: o = arg;
1.17 schwarze 386: switch (getsubopt(&arg, UNCONST(toks), &v)) {
1.90 schwarze 387: case 0:
1.45 schwarze 388: curp->wstop = 1;
1.1 kristaps 389: break;
1.90 schwarze 390: case 1:
1.45 schwarze 391: /* FALLTHROUGH */
1.90 schwarze 392: case 2:
1.45 schwarze 393: curp->wlevel = MANDOCLEVEL_WARNING;
1.1 kristaps 394: break;
1.90 schwarze 395: case 3:
1.45 schwarze 396: curp->wlevel = MANDOCLEVEL_ERROR;
1.1 kristaps 397: break;
1.90 schwarze 398: case 4:
1.45 schwarze 399: curp->wlevel = MANDOCLEVEL_FATAL;
1.19 schwarze 400: break;
1.1 kristaps 401: default:
1.93 ! schwarze 402: fprintf(stderr, "%s: -W%s: Bad argument\n",
! 403: progname, o);
1.1 kristaps 404: return(0);
405: }
1.10 schwarze 406: }
1.1 kristaps 407:
408: return(1);
409: }
410:
1.75 schwarze 411: static void
1.90 schwarze 412: mmsg(enum mandocerr t, enum mandoclevel lvl,
1.76 schwarze 413: const char *file, int line, int col, const char *msg)
1.30 schwarze 414: {
1.45 schwarze 415:
1.92 schwarze 416: fprintf(stderr, "%s: %s:", progname, file);
417:
418: if (line)
419: fprintf(stderr, "%d:%d:", line, col + 1);
420:
421: fprintf(stderr, " %s: %s", mparse_strlevel(lvl),
422: mparse_strerror(t));
1.30 schwarze 423:
424: if (msg)
425: fprintf(stderr, ": %s", msg);
1.76 schwarze 426:
1.30 schwarze 427: fputc('\n', stderr);
428: }