Annotation of mandoc/mdocml.c, Revision 1.31
1.31 ! kristaps 1: /* $Id: mdocml.c,v 1.30 2008/12/30 19:06:03 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
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: */
1.21 kristaps 19: #include <sys/stat.h>
1.1 kristaps 20: #include <sys/param.h>
21:
22: #include <assert.h>
1.21 kristaps 23: #include <fcntl.h>
1.1 kristaps 24: #include <err.h>
25: #include <getopt.h>
26: #include <stdio.h>
27: #include <stdlib.h>
28: #include <string.h>
29: #include <unistd.h>
30:
1.21 kristaps 31: #include "mdoc.h"
1.1 kristaps 32:
1.21 kristaps 33: #define MD_LINE_SZ (256)
1.2 kristaps 34:
1.21 kristaps 35: struct md_parse {
36: int warn;
37: #define MD_WARN_ALL (1 << 0)
38: #define MD_WARN_ERR (1 << 1)
39: int dbg;
40: struct mdoc *mdoc;
41: char *buf;
42: u_long bufsz;
43: char *name;
44: int fd;
45: int lnn;
46: char *line;
47: };
1.17 kristaps 48:
1.9 kristaps 49: static void usage(void);
50:
1.21 kristaps 51: static int parse_begin(struct md_parse *);
52: static int parse_leave(struct md_parse *, int);
53: static int io_begin(struct md_parse *);
54: static int io_leave(struct md_parse *, int);
55: static int buf_begin(struct md_parse *);
56: static int buf_leave(struct md_parse *, int);
57:
58: static int msg_err(void *, int, int, enum mdoc_err);
59: static int msg_warn(void *, int, int, enum mdoc_warn);
60: static void msg_msg(void *, int, const char *);
1.1 kristaps 61:
1.19 kristaps 62: #ifdef __linux__
63: extern int getsubopt(char **, char *const *, char **);
64: #endif
65:
1.1 kristaps 66: int
67: main(int argc, char *argv[])
68: {
69: int c;
1.21 kristaps 70: struct md_parse parser;
71: char *opts, *v;
1.18 kristaps 72: #define ALL 0
73: #define ERROR 1
74: char *toks[] = { "all", "error", NULL };
1.1 kristaps 75:
76: extern char *optarg;
77: extern int optind;
78:
1.21 kristaps 79: (void)memset(&parser, 0, sizeof(struct md_parse));
1.17 kristaps 80:
1.21 kristaps 81: while (-1 != (c = getopt(argc, argv, "vW:")))
1.1 kristaps 82: switch (c) {
1.13 kristaps 83: case ('v'):
1.21 kristaps 84: parser.dbg++;
1.13 kristaps 85: break;
86: case ('W'):
1.18 kristaps 87: opts = optarg;
88: while (*opts)
89: switch (getsubopt(&opts, toks, &v)) {
90: case (ALL):
1.21 kristaps 91: parser.warn |= MD_WARN_ALL;
1.18 kristaps 92: break;
93: case (ERROR):
1.21 kristaps 94: parser.warn |= MD_WARN_ERR;
1.18 kristaps 95: break;
96: default:
97: usage();
98: return(1);
99: }
1.13 kristaps 100: break;
1.1 kristaps 101: default:
102: usage();
103: return(1);
104: }
105:
106: argv += optind;
1.4 kristaps 107: argc -= optind;
1.1 kristaps 108:
1.21 kristaps 109: parser.name = "-";
1.4 kristaps 110: if (1 == argc)
1.21 kristaps 111: parser.name = *argv++;
112:
113: if ( ! io_begin(&parser))
114: return(EXIT_FAILURE);
1.1 kristaps 115:
1.21 kristaps 116: return(EXIT_SUCCESS);
1.1 kristaps 117: }
118:
119:
120: static int
1.21 kristaps 121: io_leave(struct md_parse *p, int code)
1.1 kristaps 122: {
123:
1.21 kristaps 124: if (-1 == p->fd || STDIN_FILENO == p->fd)
125: return(code);
126:
127: if (-1 == close(p->fd)) {
128: warn("%s", p->name);
129: code = 0;
1.4 kristaps 130: }
1.21 kristaps 131: return(code);
132: }
133:
134:
135: static int
136: io_begin(struct md_parse *p)
137: {
138:
139: p->fd = STDIN_FILENO;
140: if (0 != strncmp(p->name, "-", 1))
141: if (-1 == (p->fd = open(p->name, O_RDONLY, 0))) {
142: warn("%s", p->name);
143: return(io_leave(p, 0));
144: }
1.1 kristaps 145:
1.21 kristaps 146: return(io_leave(p, buf_begin(p)));
1.1 kristaps 147: }
148:
149:
150: static int
1.21 kristaps 151: buf_leave(struct md_parse *p, int code)
1.1 kristaps 152: {
1.4 kristaps 153:
1.21 kristaps 154: if (p->buf)
155: free(p->buf);
156: return(code);
157: }
1.1 kristaps 158:
159:
1.21 kristaps 160: static int
161: buf_begin(struct md_parse *p)
162: {
163: struct stat st;
1.1 kristaps 164:
1.21 kristaps 165: if (-1 == fstat(p->fd, &st)) {
166: warn("%s", p->name);
167: return(1);
168: }
169:
170: p->bufsz = MAX(st.st_blksize, BUFSIZ);
171:
172: if (NULL == (p->buf = malloc(p->bufsz))) {
173: warn("malloc");
174: return(buf_leave(p, 0));
175: }
176:
177: return(buf_leave(p, parse_begin(p)));
178: }
179:
180:
181: static void
182: print_node(const struct mdoc_node *n, int indent)
183: {
1.26 kristaps 184: const char *p, *t;
185: int i, j;
186: size_t argc, sz;
187: char **params;
188: struct mdoc_arg *argv;
1.24 kristaps 189:
190: argv = NULL;
191: argc = 0;
1.26 kristaps 192: params = NULL;
193: sz = 0;
1.21 kristaps 194:
195: switch (n->type) {
196: case (MDOC_TEXT):
197: assert(NULL == n->child);
1.25 kristaps 198: p = n->data.text.string;
1.21 kristaps 199: t = "text";
200: break;
201: case (MDOC_BODY):
202: p = mdoc_macronames[n->data.body.tok];
203: t = "block-body";
204: break;
205: case (MDOC_HEAD):
206: p = mdoc_macronames[n->data.head.tok];
207: t = "block-head";
208: break;
209: case (MDOC_ELEM):
210: assert(NULL == n->child);
211: p = mdoc_macronames[n->data.elem.tok];
212: t = "element";
1.24 kristaps 213: argv = n->data.elem.argv;
214: argc = n->data.elem.argc;
1.26 kristaps 215: params = n->data.elem.args;
216: sz = n->data.elem.sz;
1.21 kristaps 217: break;
218: case (MDOC_BLOCK):
219: p = mdoc_macronames[n->data.block.tok];
220: t = "block";
1.24 kristaps 221: argv = n->data.block.argv;
222: argc = n->data.block.argc;
1.21 kristaps 223: break;
1.22 kristaps 224: default:
225: abort();
226: /* NOTREACHED */
1.21 kristaps 227: }
228:
229: for (i = 0; i < indent; i++)
230: (void)printf(" ");
1.24 kristaps 231: (void)printf("%s (%s)", p, t);
232:
233: for (i = 0; i < (int)argc; i++) {
234: (void)printf(" -%s", mdoc_argnames[argv[i].arg]);
235: for (j = 0; j < (int)argv[i].sz; j++)
236: (void)printf(" \"%s\"", argv[i].value[j]);
237: }
238:
1.26 kristaps 239: for (i = 0; i < (int)sz; i++)
240: (void)printf(" \"%s\"", params[i]);
241:
1.24 kristaps 242: (void)printf("\n");
1.21 kristaps 243:
244: if (n->child)
245: print_node(n->child, indent + 1);
246: if (n->next)
247: print_node(n->next, indent);
248: }
1.1 kristaps 249:
250:
1.21 kristaps 251: static int
252: parse_leave(struct md_parse *p, int code)
253: {
254: const struct mdoc_node *n;
255:
256: if (p->mdoc) {
257: if ((n = mdoc_result(p->mdoc)))
258: print_node(n, 0);
259: mdoc_free(p->mdoc);
260: }
261: return(code);
262: }
263:
264:
265: static int
266: parse_begin(struct md_parse *p)
267: {
268: ssize_t sz, i;
269: size_t pos;
270: char line[256], sv[256];
271: struct mdoc_cb cb;
272:
273: cb.mdoc_err = msg_err;
274: cb.mdoc_warn = msg_warn;
275: cb.mdoc_msg = msg_msg;
276:
277: if (NULL == (p->mdoc = mdoc_alloc(p, &cb)))
278: return(parse_leave(p, 0));
279:
280: p->lnn = 1;
281: p->line = sv;
282:
283: for (pos = 0; ; ) {
284: if (-1 == (sz = read(p->fd, p->buf, p->bufsz))) {
285: warn("%s", p->name);
286: return(parse_leave(p, 0));
287: } else if (0 == sz)
288: break;
289:
290: for (i = 0; i < sz; i++) {
291: if ('\n' != p->buf[i]) {
292: if (pos < sizeof(line)) {
1.23 kristaps 293: sv[(int)pos] = p->buf[(int)i];
294: line[(int)pos++] =
295: p->buf[(int)i];
1.21 kristaps 296: continue;
297: }
298: warnx("%s: line %d too long",
299: p->name, p->lnn);
300: return(parse_leave(p, 0));
301: }
302:
303: line[(int)pos] = sv[(int)pos] = 0;
304: if ( ! mdoc_parseln(p->mdoc, line))
305: return(parse_leave(p, 0));
1.1 kristaps 306:
1.21 kristaps 307: p->lnn++;
308: pos = 0;
1.4 kristaps 309: }
1.21 kristaps 310: }
1.1 kristaps 311:
1.21 kristaps 312: return(parse_leave(p, 1));
1.4 kristaps 313: }
1.1 kristaps 314:
315:
1.4 kristaps 316: static int
1.21 kristaps 317: msg_err(void *arg, int tok, int col, enum mdoc_err type)
318: {
319: char *fmt, *lit;
320: struct md_parse *p;
321: int i;
322:
323: p = (struct md_parse *)arg;
324:
325: fmt = lit = NULL;
326:
327: switch (type) {
328: case (ERR_SYNTAX_QUOTE):
1.24 kristaps 329: lit = "syntax: disallowed argument quotation";
330: break;
331: case (ERR_SYNTAX_UNQUOTE):
1.21 kristaps 332: lit = "syntax: unterminated quotation";
333: break;
334: case (ERR_SYNTAX_WS):
335: lit = "syntax: whitespace in argument";
336: break;
1.25 kristaps 337: case (ERR_SYNTAX_ARGFORM):
1.23 kristaps 338: fmt = "syntax: macro `%s' arguments malformed";
339: break;
1.28 kristaps 340: case (ERR_SYNTAX_NOPUNCT):
341: fmt = "syntax: macro `%s' doesn't understand punctuation";
342: break;
1.25 kristaps 343: case (ERR_SYNTAX_ARG):
1.24 kristaps 344: fmt = "syntax: unknown argument for macro `%s'";
345: break;
1.21 kristaps 346: case (ERR_SCOPE_BREAK):
347: /* Which scope is broken? */
1.24 kristaps 348: fmt = "scope: macro `%s' breaks prior explicit scope";
349: break;
350: case (ERR_SCOPE_NOCTX):
351: fmt = "scope: closure macro `%s' has no context";
1.21 kristaps 352: break;
1.25 kristaps 353: case (ERR_SCOPE_NONEST):
1.26 kristaps 354: fmt = "scope: macro `%s' may not be nested in the current context";
1.25 kristaps 355: break;
1.21 kristaps 356: case (ERR_MACRO_NOTSUP):
357: fmt = "macro `%s' not supported";
358: break;
359: case (ERR_MACRO_NOTCALL):
360: fmt = "macro `%s' not callable";
361: break;
1.23 kristaps 362: case (ERR_SEC_PROLOGUE):
363: fmt = "macro `%s' cannot be called in the prologue";
364: break;
365: case (ERR_SEC_NPROLOGUE):
366: fmt = "macro `%s' called outside of prologue";
367: break;
1.28 kristaps 368: case (ERR_ARGS_EQ0):
369: fmt = "macro `%s' expects zero arguments";
370: break;
1.29 kristaps 371: case (ERR_ARGS_EQ1):
372: fmt = "macro `%s' expects one argument";
373: break;
1.21 kristaps 374: case (ERR_ARGS_GE1):
375: fmt = "macro `%s' expects one or more arguments";
376: break;
1.28 kristaps 377: case (ERR_ARGS_LE2):
378: fmt = "macro `%s' expects two or fewer arguments";
379: break;
1.23 kristaps 380: case (ERR_ARGS_MANY):
381: fmt = "macro `%s' has too many arguments";
382: break;
383: case (ERR_SEC_PROLOGUE_OO):
384: fmt = "prologue macro `%s' is out-of-order";
385: break;
386: case (ERR_SEC_PROLOGUE_REP):
387: fmt = "prologue macro `%s' repeated";
388: break;
389: case (ERR_SEC_NAME):
390: lit = "`NAME' section must be first";
391: break;
1.24 kristaps 392: case (ERR_SYNTAX_ARGVAL):
393: lit = "syntax: expected value for macro argument";
394: break;
1.25 kristaps 395: case (ERR_SYNTAX_ARGBAD):
396: lit = "syntax: invalid value for macro argument";
397: break;
1.24 kristaps 398: case (ERR_SYNTAX_ARGMANY):
399: lit = "syntax: too many values for macro argument";
400: break;
1.31 ! kristaps 401: case (ERR_CHILD_HEAD):
! 402: lit = "scope context expects block-header child";
! 403: break;
1.21 kristaps 404: default:
405: abort();
406: /* NOTREACHED */
407: }
408:
409: if (fmt) {
410: (void)fprintf(stderr, "%s:%d: error: ",
411: p->name, p->lnn);
412: (void)fprintf(stderr, fmt, mdoc_macronames[tok]);
413: } else
414: (void)fprintf(stderr, "%s:%d: error: %s",
415: p->name, p->lnn, lit);
416:
417: if (p->dbg < 1) {
1.23 kristaps 418: if (-1 != col)
419: (void)fprintf(stderr, " (column %d)\n", col);
420: return(0);
421: } else if (-1 == col) {
422: (void)fprintf(stderr, "\nFrom: %s", p->line);
1.21 kristaps 423: return(0);
424: }
425:
426: (void)fprintf(stderr, "\nFrom: %s\n ", p->line);
427: for (i = 0; i < col; i++)
428: (void)fprintf(stderr, " ");
429: (void)fprintf(stderr, "^\n");
430:
431: return(0);
432: }
433:
434:
435: static void
436: msg_msg(void *arg, int col, const char *msg)
1.4 kristaps 437: {
1.21 kristaps 438: struct md_parse *p;
439: int i;
440:
441: p = (struct md_parse *)arg;
442:
443: if (p->dbg < 2)
444: return;
445:
446: (void)printf("%s:%d: %s", p->name, p->lnn, msg);
447:
448: if (p->dbg < 3) {
1.23 kristaps 449: if (-1 != col)
450: (void)printf(" (column %d)\n", col);
451: return;
452: } else if (-1 == col) {
453: (void)printf("\nFrom %s\n", p->line);
1.21 kristaps 454: return;
455: }
456:
457: (void)printf("\nFrom: %s\n ", p->line);
458: for (i = 0; i < col; i++)
459: (void)printf(" ");
460: (void)printf("^\n");
1.1 kristaps 461: }
462:
463:
464: static int
1.21 kristaps 465: msg_warn(void *arg, int tok, int col, enum mdoc_warn type)
1.1 kristaps 466: {
1.21 kristaps 467: char *fmt, *lit;
468: struct md_parse *p;
469: int i;
470: extern char *__progname;
1.1 kristaps 471:
1.21 kristaps 472: p = (struct md_parse *)arg;
1.1 kristaps 473:
1.21 kristaps 474: if ( ! (p->warn & MD_WARN_ALL))
1.1 kristaps 475: return(1);
1.21 kristaps 476:
477: fmt = lit = NULL;
478:
479: switch (type) {
480: case (WARN_SYNTAX_WS_EOLN):
481: lit = "syntax: whitespace at end-of-line";
482: break;
1.25 kristaps 483: case (WARN_SYNTAX_QUOTED):
484: lit = "syntax: quotation mark starting string";
485: break;
1.21 kristaps 486: case (WARN_SYNTAX_MACLIKE):
487: lit = "syntax: macro-like argument";
488: break;
1.24 kristaps 489: case (WARN_SYNTAX_ARGLIKE):
490: lit = "syntax: argument-like value";
491: break;
1.23 kristaps 492: case (WARN_SEC_OO):
493: lit = "section is out of conventional order";
494: break;
1.21 kristaps 495: case (WARN_ARGS_GE1):
496: fmt = "macro `%s' suggests one or more arguments";
497: break;
1.25 kristaps 498: case (WARN_ARGS_EQ0):
499: fmt = "macro `%s' suggests zero arguments";
500: break;
501: case (WARN_IGN_AFTER_BLK):
502: fmt = "ignore: macro `%s' ignored after block macro";
503: break;
1.30 kristaps 504: case (WARN_IGN_OBSOLETE):
505: fmt = "ignore: macro `%s' is obsolete";
506: break;
1.25 kristaps 507: case (WARN_IGN_BEFORE_BLK):
508: fmt = "ignore: macro before block macro `%s' ignored";
509: break;
1.27 kristaps 510: case (WARN_COMPAT_TROFF):
511: fmt = "compat: macro `%s' behaves differently in troff and nroff";
512: break;
1.21 kristaps 513: default:
514: abort();
515: /* NOTREACHED */
1.1 kristaps 516: }
517:
1.21 kristaps 518: if (fmt) {
519: (void)fprintf(stderr, "%s:%d: warning: ",
520: p->name, p->lnn);
521: (void)fprintf(stderr, fmt, mdoc_macronames[tok]);
522: } else
523: (void)fprintf(stderr, "%s:%d: warning: %s",
524: p->name, p->lnn, lit);
525:
526: if (p->dbg >= 1) {
527: (void)fprintf(stderr, "\nFrom: %s\n ", p->line);
528: for (i = 0; i < col; i++)
529: (void)fprintf(stderr, " ");
530: (void)fprintf(stderr, "^\n");
531: } else
532: (void)fprintf(stderr, " (column %d)\n", col);
533:
534: if (p->warn & MD_WARN_ERR) {
535: (void)fprintf(stderr, "%s: considering warnings as "
536: "errors\n", __progname);
537: return(0);
1.1 kristaps 538: }
539:
1.21 kristaps 540: return(1);
1.1 kristaps 541: }
542:
543:
544: static void
545: usage(void)
546: {
547: extern char *__progname;
548:
1.21 kristaps 549: (void)fprintf(stderr, "usage: %s [-v] [-Wwarn...] [infile]\n",
1.19 kristaps 550: __progname);
1.1 kristaps 551: }
1.18 kristaps 552:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdocml.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc