Annotation of mandoc/main.c, Revision 1.10
1.10 ! kristaps 1: /* $Id: main.c,v 1.9 2009/03/22 19:10:48 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
19: #include <sys/stat.h>
20:
21: #include <assert.h>
22: #include <err.h>
23: #include <fcntl.h>
24: #include <stdio.h>
25: #include <stdlib.h>
26: #include <string.h>
27: #include <unistd.h>
28:
29: #include "mdoc.h"
1.10 ! kristaps 30: #include "man.h"
1.1 kristaps 31:
1.3 kristaps 32: #ifdef __linux__
33: extern int getsubopt(char **, char * const *, char **);
34: # ifndef __dead
35: # define __dead __attribute__((__noreturn__))
36: # endif
1.10 ! kristaps 37: #elif defined(__FreeBSD__)
! 38: # ifndef __dead
! 39: # define __dead __dead2
! 40: # endif
1.3 kristaps 41: #endif
42:
1.5 kristaps 43: struct buf {
44: char *buf;
45: size_t sz;
46: };
47:
48: struct curparse {
49: const char *file;
50: int wflags;
1.1 kristaps 51: #define WARN_WALL 0x03 /* All-warnings mask. */
52: #define WARN_WCOMPAT (1 << 0) /* Compatibility warnings. */
53: #define WARN_WSYNTAX (1 << 1) /* Syntax warnings. */
54: #define WARN_WERR (1 << 2) /* Warnings->errors. */
1.5 kristaps 55: };
1.1 kristaps 56:
1.10 ! kristaps 57: enum intt {
! 58: INTT_MDOC = 0,
! 59: INTT_MAN
! 60: };
! 61:
! 62: enum outt {
! 63: OUTT_ASCII = 0,
1.1 kristaps 64: OUTT_LATIN1,
65: OUTT_UTF8,
66: OUTT_TREE,
67: OUTT_LINT
68: };
69:
70: typedef int (*out_run)(void *, const struct mdoc *);
71: typedef void (*out_free)(void *);
72:
73: extern char *__progname;
74:
75: extern void *ascii_alloc(void);
76: extern void *latin1_alloc(void);
77: extern void *utf8_alloc(void);
78: extern int terminal_run(void *, const struct mdoc *);
79: extern int tree_run(void *, const struct mdoc *);
80: extern void terminal_free(void *);
81:
82: static int foptions(int *, char *);
83: static int toptions(enum outt *, char *);
1.10 ! kristaps 84: static int moptions(enum intt *, char *);
1.1 kristaps 85: static int woptions(int *, char *);
86: static int merr(void *, int, int, const char *);
87: static int mwarn(void *, int, int,
88: enum mdoc_warn, const char *);
1.10 ! kristaps 89: static int file(struct buf *, struct buf *,
! 90: const char *,
! 91: struct man *, struct mdoc *);
1.5 kristaps 92: static int fdesc(struct buf *, struct buf *,
1.10 ! kristaps 93: const char *, int,
! 94: struct man *, struct mdoc *);
! 95:
! 96: __dead static void version(void);
! 97: __dead static void usage(void);
1.1 kristaps 98:
99:
100: int
101: main(int argc, char *argv[])
102: {
1.7 kristaps 103: int c, rc, fflags;
1.1 kristaps 104: struct mdoc_cb cb;
1.10 ! kristaps 105: struct man *man;
1.1 kristaps 106: struct mdoc *mdoc;
107: void *outdata;
108: enum outt outtype;
1.10 ! kristaps 109: enum intt inttype;
1.5 kristaps 110: struct buf ln, blk;
1.1 kristaps 111: out_run outrun;
112: out_free outfree;
1.5 kristaps 113: struct curparse curp;
1.1 kristaps 114:
1.7 kristaps 115: fflags = 0;
1.1 kristaps 116: outtype = OUTT_ASCII;
1.10 ! kristaps 117: inttype = INTT_MDOC;
1.1 kristaps 118:
1.5 kristaps 119: bzero(&curp, sizeof(struct curparse));
120:
1.1 kristaps 121: /* LINTED */
1.10 ! kristaps 122: while (-1 != (c = getopt(argc, argv, "f:m:VW:T:")))
1.1 kristaps 123: switch (c) {
124: case ('f'):
125: if ( ! foptions(&fflags, optarg))
126: return(0);
127: break;
1.10 ! kristaps 128: case ('m'):
! 129: if ( ! moptions(&inttype, optarg))
! 130: return(0);
! 131: break;
1.1 kristaps 132: case ('T'):
133: if ( ! toptions(&outtype, optarg))
134: return(0);
135: break;
136: case ('W'):
1.5 kristaps 137: if ( ! woptions(&curp.wflags, optarg))
1.1 kristaps 138: return(0);
139: break;
140: case ('V'):
141: version();
142: /* NOTREACHED */
143: default:
144: usage();
145: /* NOTREACHED */
146: }
147:
148: argc -= optind;
149: argv += optind;
150:
151: /*
152: * Allocate the appropriate front-end. Note that utf8, ascii
153: * and latin1 all resolve to the terminal front-end with
154: * different encodings (see terminal.c). Not all frontends have
155: * cleanup or alloc routines.
156: */
157:
158: switch (outtype) {
159: case (OUTT_LATIN1):
160: outdata = latin1_alloc();
161: outrun = terminal_run;
162: outfree = terminal_free;
163: break;
164: case (OUTT_UTF8):
165: outdata = utf8_alloc();
166: outrun = terminal_run;
167: outfree = terminal_free;
168: break;
169: case (OUTT_TREE):
170: outdata = NULL;
171: outrun = tree_run;
172: outfree = NULL;
173: break;
174: case (OUTT_LINT):
175: outdata = NULL;
176: outrun = NULL;
177: outfree = NULL;
178: break;
179: default:
180: outdata = ascii_alloc();
181: outrun = terminal_run;
182: outfree = terminal_free;
183: break;
184: }
185:
186: /*
187: * All callbacks route into here, where we print them onto the
188: * screen. XXX - for now, no path for debugging messages.
189: */
190:
191: cb.mdoc_msg = NULL;
192: cb.mdoc_err = merr;
193: cb.mdoc_warn = mwarn;
194:
1.5 kristaps 195: bzero(&ln, sizeof(struct buf));
196: bzero(&blk, sizeof(struct buf));
1.1 kristaps 197:
1.10 ! kristaps 198: man = NULL;
! 199: mdoc = NULL;
! 200:
! 201: switch (inttype) {
! 202: case (INTT_MAN):
! 203: man = man_alloc();
! 204: break;
! 205: default:
! 206: mdoc = mdoc_alloc(&curp, fflags, &cb);
! 207: break;
! 208: }
1.1 kristaps 209:
1.4 kristaps 210: /*
211: * Loop around available files.
212: */
1.1 kristaps 213:
1.4 kristaps 214: if (NULL == *argv) {
1.5 kristaps 215: curp.file = "<stdin>";
1.4 kristaps 216: rc = 0;
1.10 ! kristaps 217: c = fdesc(&blk, &ln, "stdin",
! 218: STDIN_FILENO, man, mdoc);
! 219:
1.4 kristaps 220: if (c && NULL == outrun)
221: rc = 1;
1.10 ! kristaps 222: #if 0
1.4 kristaps 223: else if (c && outrun && (*outrun)(outdata, mdoc))
224: rc = 1;
1.10 ! kristaps 225: #endif
1.4 kristaps 226: } else {
227: while (*argv) {
1.5 kristaps 228: curp.file = *argv;
1.10 ! kristaps 229: c = file(&blk, &ln, *argv, man, mdoc);
1.4 kristaps 230: if ( ! c)
231: break;
1.10 ! kristaps 232: #if 0
1.4 kristaps 233: if (outrun && ! (*outrun)(outdata, mdoc))
234: break;
1.10 ! kristaps 235: #endif
! 236: if (man)
! 237: man_reset(man);
! 238: if (mdoc)
! 239: mdoc_reset(mdoc);
! 240:
1.4 kristaps 241: argv++;
242: }
243: rc = NULL == *argv;
1.1 kristaps 244: }
245:
1.5 kristaps 246: if (blk.buf)
247: free(blk.buf);
248: if (ln.buf)
249: free(ln.buf);
1.1 kristaps 250: if (outfree)
251: (*outfree)(outdata);
1.10 ! kristaps 252: if (mdoc)
! 253: mdoc_free(mdoc);
! 254: if (man)
! 255: man_free(man);
1.1 kristaps 256:
257: return(rc ? EXIT_SUCCESS : EXIT_FAILURE);
258: }
259:
260:
261: __dead static void
262: version(void)
263: {
264:
265: (void)printf("%s %s\n", __progname, VERSION);
266: exit(0);
267: /* NOTREACHED */
268: }
269:
270:
271: __dead static void
272: usage(void)
273: {
274:
275: (void)fprintf(stderr, "usage: %s\n", __progname);
276: exit(1);
277: /* NOTREACHED */
278: }
279:
280:
281: static int
1.10 ! kristaps 282: file(struct buf *blk, struct buf *ln, const char *file,
! 283: struct man *man, struct mdoc *mdoc)
1.1 kristaps 284: {
285: int fd, c;
286:
287: if (-1 == (fd = open(file, O_RDONLY, 0))) {
288: warn("%s", file);
289: return(0);
290: }
291:
1.10 ! kristaps 292: c = fdesc(blk, ln, file, fd, man, mdoc);
1.1 kristaps 293:
294: if (-1 == close(fd))
295: warn("%s", file);
296:
297: return(c);
298: }
299:
300:
301: static int
1.5 kristaps 302: fdesc(struct buf *blk, struct buf *ln,
1.10 ! kristaps 303: const char *f, int fd,
! 304: struct man *man, struct mdoc *mdoc)
1.1 kristaps 305: {
306: size_t sz;
307: ssize_t ssz;
308: struct stat st;
309: int j, i, pos, lnn;
1.10 ! kristaps 310:
! 311: assert( ! (man && mdoc));
1.1 kristaps 312:
313: /*
314: * Two buffers: ln and buf. buf is the input buffer, optimised
315: * for each file's block size. ln is a line buffer. Both
316: * growable, hence passed in by ptr-ptr.
317: */
318:
1.6 kristaps 319: sz = BUFSIZ;
320:
321: if (-1 == fstat(fd, &st))
1.1 kristaps 322: warnx("%s", f);
1.6 kristaps 323: else if ((size_t)st.st_blksize > sz)
324: sz = st.st_blksize;
1.1 kristaps 325:
1.5 kristaps 326: if (sz > blk->sz) {
327: blk->buf = realloc(blk->buf, sz);
328: if (NULL == blk->buf)
1.1 kristaps 329: err(1, "realloc");
1.5 kristaps 330: blk->sz = sz;
1.1 kristaps 331: }
332:
333: /*
334: * Fill buf with file blocksize and parse newlines into ln.
335: */
336:
337: for (lnn = 1, pos = 0; ; ) {
1.5 kristaps 338: if (-1 == (ssz = read(fd, blk->buf, sz))) {
1.1 kristaps 339: warn("%s", f);
340: return(0);
341: } else if (0 == ssz)
342: break;
343:
344: for (i = 0; i < (int)ssz; i++) {
1.5 kristaps 345: if (pos >= (int)ln->sz) {
346: ln->sz += 256; /* Step-size. */
347: ln->buf = realloc(ln->buf, ln->sz);
348: if (NULL == ln->buf)
1.1 kristaps 349: err(1, "realloc");
350: }
351:
1.5 kristaps 352: if ('\n' != blk->buf[i]) {
353: ln->buf[pos++] = blk->buf[i];
1.1 kristaps 354: continue;
355: }
356:
357: /* Check for CPP-escaped newline. */
358:
1.5 kristaps 359: if (pos > 0 && '\\' == ln->buf[pos - 1]) {
1.1 kristaps 360: for (j = pos - 1; j >= 0; j--)
1.5 kristaps 361: if ('\\' != ln->buf[j])
1.1 kristaps 362: break;
363:
364: if ( ! ((pos - j) % 2)) {
365: pos--;
366: lnn++;
367: continue;
368: }
369: }
370:
1.5 kristaps 371: ln->buf[pos] = 0;
1.10 ! kristaps 372: if (mdoc && ! mdoc_parseln(mdoc, lnn, ln->buf))
! 373: return(0);
! 374: if (man && ! man_parseln(man, lnn, ln->buf))
1.1 kristaps 375: return(0);
376: lnn++;
1.9 kristaps 377: pos = 0;
1.1 kristaps 378: }
379: }
380:
1.10 ! kristaps 381: if (mdoc)
! 382: return(mdoc_endparse(mdoc));
! 383:
! 384: return(man_endparse(man));
! 385: }
! 386:
! 387:
! 388: static int
! 389: moptions(enum intt *tflags, char *arg)
! 390: {
! 391:
! 392: if (0 == strcmp(arg, "mdoc"))
! 393: *tflags = INTT_MDOC;
! 394: else if (0 == strcmp(arg, "man"))
! 395: *tflags = INTT_MAN;
! 396: else {
! 397: warnx("bad argument: -m%s", arg);
! 398: return(0);
! 399: }
! 400:
! 401: return(1);
1.1 kristaps 402: }
403:
404:
405: static int
406: toptions(enum outt *tflags, char *arg)
407: {
408:
409: if (0 == strcmp(arg, "ascii"))
410: *tflags = OUTT_ASCII;
411: else if (0 == strcmp(arg, "latin1"))
412: *tflags = OUTT_LATIN1;
413: else if (0 == strcmp(arg, "utf8"))
414: *tflags = OUTT_UTF8;
415: else if (0 == strcmp(arg, "lint"))
416: *tflags = OUTT_LINT;
417: else if (0 == strcmp(arg, "tree"))
418: *tflags = OUTT_TREE;
419: else {
420: warnx("bad argument: -T%s", arg);
421: return(0);
422: }
423:
424: return(1);
425: }
426:
427:
428: /*
429: * Parse out the options for [-fopt...] setting compiler options. These
430: * can be comma-delimited or called again.
431: */
432: static int
433: foptions(int *fflags, char *arg)
434: {
435: char *v;
436: char *toks[4];
437:
438: toks[0] = "ign-scope";
439: toks[1] = "ign-escape";
440: toks[2] = "ign-macro";
441: toks[3] = NULL;
442:
443: while (*arg)
444: switch (getsubopt(&arg, toks, &v)) {
445: case (0):
446: *fflags |= MDOC_IGN_SCOPE;
447: break;
448: case (1):
449: *fflags |= MDOC_IGN_ESCAPE;
450: break;
451: case (2):
452: *fflags |= MDOC_IGN_MACRO;
453: break;
454: default:
455: warnx("bad argument: -f%s", arg);
456: return(0);
457: }
458:
459: return(1);
460: }
461:
462:
463: /*
464: * Parse out the options for [-Werr...], which sets warning modes.
465: * These can be comma-delimited or called again.
466: */
467: static int
468: woptions(int *wflags, char *arg)
469: {
470: char *v;
471: char *toks[5];
472:
473: toks[0] = "all";
474: toks[1] = "compat";
475: toks[2] = "syntax";
476: toks[3] = "error";
477: toks[4] = NULL;
478:
479: while (*arg)
480: switch (getsubopt(&arg, toks, &v)) {
481: case (0):
482: *wflags |= WARN_WALL;
483: break;
484: case (1):
485: *wflags |= WARN_WCOMPAT;
486: break;
487: case (2):
488: *wflags |= WARN_WSYNTAX;
489: break;
490: case (3):
491: *wflags |= WARN_WERR;
492: break;
493: default:
494: warnx("bad argument: -W%s", arg);
495: return(0);
496: }
497:
498: return(1);
499: }
500:
501:
1.2 kristaps 502: /* ARGSUSED */
1.1 kristaps 503: static int
504: merr(void *arg, int line, int col, const char *msg)
505: {
1.5 kristaps 506: struct curparse *curp;
507:
508: curp = (struct curparse *)arg;
1.1 kristaps 509:
1.5 kristaps 510: warnx("%s:%d: error: %s (column %d)",
511: curp->file, line, msg, col);
1.1 kristaps 512: return(0);
513: }
514:
515:
516: static int
517: mwarn(void *arg, int line, int col,
518: enum mdoc_warn type, const char *msg)
519: {
1.5 kristaps 520: struct curparse *curp;
1.1 kristaps 521: char *wtype;
522:
1.5 kristaps 523: curp = (struct curparse *)arg;
1.1 kristaps 524: wtype = NULL;
525:
526: switch (type) {
527: case (WARN_COMPAT):
528: wtype = "compat";
1.5 kristaps 529: if (curp->wflags & WARN_WCOMPAT)
1.1 kristaps 530: break;
531: return(1);
532: case (WARN_SYNTAX):
533: wtype = "syntax";
1.5 kristaps 534: if (curp->wflags & WARN_WSYNTAX)
1.1 kristaps 535: break;
536: return(1);
537: }
538:
539: assert(wtype);
1.5 kristaps 540: warnx("%s:%d: %s warning: %s (column %d)",
541: curp->file, line, wtype, msg, col);
1.1 kristaps 542:
1.5 kristaps 543: if ( ! (curp->wflags & WARN_WERR))
1.1 kristaps 544: return(1);
545:
546: warnx("%s: considering warnings as errors",
547: __progname);
548: return(0);
549: }
550:
551:
CVSweb