Annotation of mandoc/mdocml.c, Revision 1.24
1.24 ! kristaps 1: /* $Id: mdocml.c,v 1.23 2008/12/17 17:18:38 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: {
184: const char *p, *t;
1.24 ! kristaps 185: int i, j;
! 186: size_t argc;
! 187: struct mdoc_arg *argv;
! 188:
! 189: argv = NULL;
! 190: argc = 0;
1.21 kristaps 191:
192: switch (n->type) {
193: case (MDOC_TEXT):
194: assert(NULL == n->child);
195: p = "<text>";
196: t = "text";
197: break;
198: case (MDOC_BODY):
199: p = mdoc_macronames[n->data.body.tok];
200: t = "block-body";
201: break;
202: case (MDOC_HEAD):
203: p = mdoc_macronames[n->data.head.tok];
204: t = "block-head";
205: break;
206: case (MDOC_ELEM):
207: assert(NULL == n->child);
208: p = mdoc_macronames[n->data.elem.tok];
209: t = "element";
1.24 ! kristaps 210: argv = n->data.elem.argv;
! 211: argc = n->data.elem.argc;
1.21 kristaps 212: break;
213: case (MDOC_BLOCK):
214: p = mdoc_macronames[n->data.block.tok];
215: t = "block";
1.24 ! kristaps 216: argv = n->data.block.argv;
! 217: argc = n->data.block.argc;
1.21 kristaps 218: break;
1.22 kristaps 219: default:
220: abort();
221: /* NOTREACHED */
1.21 kristaps 222: }
223:
224: for (i = 0; i < indent; i++)
225: (void)printf(" ");
1.24 ! kristaps 226: (void)printf("%s (%s)", p, t);
! 227:
! 228: for (i = 0; i < (int)argc; i++) {
! 229: (void)printf(" -%s", mdoc_argnames[argv[i].arg]);
! 230: for (j = 0; j < (int)argv[i].sz; j++)
! 231: (void)printf(" \"%s\"", argv[i].value[j]);
! 232: }
! 233:
! 234: (void)printf("\n");
1.21 kristaps 235:
236: if (n->child)
237: print_node(n->child, indent + 1);
238: if (n->next)
239: print_node(n->next, indent);
240: }
1.1 kristaps 241:
242:
1.21 kristaps 243: static int
244: parse_leave(struct md_parse *p, int code)
245: {
246: const struct mdoc_node *n;
247:
248: if (p->mdoc) {
249: if ((n = mdoc_result(p->mdoc)))
250: print_node(n, 0);
251: mdoc_free(p->mdoc);
252: }
253: return(code);
254: }
255:
256:
257: static int
258: parse_begin(struct md_parse *p)
259: {
260: ssize_t sz, i;
261: size_t pos;
262: char line[256], sv[256];
263: struct mdoc_cb cb;
264:
265: cb.mdoc_err = msg_err;
266: cb.mdoc_warn = msg_warn;
267: cb.mdoc_msg = msg_msg;
268:
269: if (NULL == (p->mdoc = mdoc_alloc(p, &cb)))
270: return(parse_leave(p, 0));
271:
272: p->lnn = 1;
273: p->line = sv;
274:
275: for (pos = 0; ; ) {
276: if (-1 == (sz = read(p->fd, p->buf, p->bufsz))) {
277: warn("%s", p->name);
278: return(parse_leave(p, 0));
279: } else if (0 == sz)
280: break;
281:
282: for (i = 0; i < sz; i++) {
283: if ('\n' != p->buf[i]) {
284: if (pos < sizeof(line)) {
1.23 kristaps 285: sv[(int)pos] = p->buf[(int)i];
286: line[(int)pos++] =
287: p->buf[(int)i];
1.21 kristaps 288: continue;
289: }
290: warnx("%s: line %d too long",
291: p->name, p->lnn);
292: return(parse_leave(p, 0));
293: }
294:
295: line[(int)pos] = sv[(int)pos] = 0;
296: if ( ! mdoc_parseln(p->mdoc, line))
297: return(parse_leave(p, 0));
1.1 kristaps 298:
1.21 kristaps 299: p->lnn++;
300: pos = 0;
1.4 kristaps 301: }
1.21 kristaps 302: }
1.1 kristaps 303:
1.21 kristaps 304: return(parse_leave(p, 1));
1.4 kristaps 305: }
1.1 kristaps 306:
307:
1.4 kristaps 308: static int
1.21 kristaps 309: msg_err(void *arg, int tok, int col, enum mdoc_err type)
310: {
311: char *fmt, *lit;
312: struct md_parse *p;
313: int i;
314:
315: p = (struct md_parse *)arg;
316:
317: fmt = lit = NULL;
318:
319: switch (type) {
320: case (ERR_SYNTAX_QUOTE):
1.24 ! kristaps 321: lit = "syntax: disallowed argument quotation";
! 322: break;
! 323: case (ERR_SYNTAX_UNQUOTE):
1.21 kristaps 324: lit = "syntax: unterminated quotation";
325: break;
326: case (ERR_SYNTAX_WS):
327: lit = "syntax: whitespace in argument";
328: break;
1.23 kristaps 329: case (ERR_SYNTAX_ARGS):
330: fmt = "syntax: macro `%s' arguments malformed";
331: break;
1.24 ! kristaps 332: case (ERR_SYNTAX_BADARG):
! 333: fmt = "syntax: unknown argument for macro `%s'";
! 334: break;
1.21 kristaps 335: case (ERR_SCOPE_BREAK):
336: /* Which scope is broken? */
1.24 ! kristaps 337: fmt = "scope: macro `%s' breaks prior explicit scope";
! 338: break;
! 339: case (ERR_SCOPE_NOCTX):
! 340: fmt = "scope: closure macro `%s' has no context";
1.21 kristaps 341: break;
342: case (ERR_MACRO_NOTSUP):
343: fmt = "macro `%s' not supported";
344: break;
345: case (ERR_MACRO_NOTCALL):
346: fmt = "macro `%s' not callable";
347: break;
1.23 kristaps 348: case (ERR_SEC_PROLOGUE):
349: fmt = "macro `%s' cannot be called in the prologue";
350: break;
351: case (ERR_SEC_NPROLOGUE):
352: fmt = "macro `%s' called outside of prologue";
353: break;
1.21 kristaps 354: case (ERR_ARGS_GE1):
355: fmt = "macro `%s' expects one or more arguments";
356: break;
1.23 kristaps 357: case (ERR_ARGS_MANY):
358: fmt = "macro `%s' has too many arguments";
359: break;
360: case (ERR_SEC_PROLOGUE_OO):
361: fmt = "prologue macro `%s' is out-of-order";
362: break;
363: case (ERR_SEC_PROLOGUE_REP):
364: fmt = "prologue macro `%s' repeated";
365: break;
366: case (ERR_SEC_NAME):
367: lit = "`NAME' section must be first";
368: break;
1.24 ! kristaps 369: case (ERR_SYNTAX_ARGVAL):
! 370: lit = "syntax: expected value for macro argument";
! 371: break;
! 372: case (ERR_SYNTAX_ARGMANY):
! 373: lit = "syntax: too many values for macro argument";
! 374: break;
1.21 kristaps 375: default:
376: abort();
377: /* NOTREACHED */
378: }
379:
380: if (fmt) {
381: (void)fprintf(stderr, "%s:%d: error: ",
382: p->name, p->lnn);
383: (void)fprintf(stderr, fmt, mdoc_macronames[tok]);
384: } else
385: (void)fprintf(stderr, "%s:%d: error: %s",
386: p->name, p->lnn, lit);
387:
388: if (p->dbg < 1) {
1.23 kristaps 389: if (-1 != col)
390: (void)fprintf(stderr, " (column %d)\n", col);
391: return(0);
392: } else if (-1 == col) {
393: (void)fprintf(stderr, "\nFrom: %s", p->line);
1.21 kristaps 394: return(0);
395: }
396:
397: (void)fprintf(stderr, "\nFrom: %s\n ", p->line);
398: for (i = 0; i < col; i++)
399: (void)fprintf(stderr, " ");
400: (void)fprintf(stderr, "^\n");
401:
402: return(0);
403: }
404:
405:
406: static void
407: msg_msg(void *arg, int col, const char *msg)
1.4 kristaps 408: {
1.21 kristaps 409: struct md_parse *p;
410: int i;
411:
412: p = (struct md_parse *)arg;
413:
414: if (p->dbg < 2)
415: return;
416:
417: (void)printf("%s:%d: %s", p->name, p->lnn, msg);
418:
419: if (p->dbg < 3) {
1.23 kristaps 420: if (-1 != col)
421: (void)printf(" (column %d)\n", col);
422: return;
423: } else if (-1 == col) {
424: (void)printf("\nFrom %s\n", p->line);
1.21 kristaps 425: return;
426: }
427:
428: (void)printf("\nFrom: %s\n ", p->line);
429: for (i = 0; i < col; i++)
430: (void)printf(" ");
431: (void)printf("^\n");
1.1 kristaps 432: }
433:
434:
435: static int
1.21 kristaps 436: msg_warn(void *arg, int tok, int col, enum mdoc_warn type)
1.1 kristaps 437: {
1.21 kristaps 438: char *fmt, *lit;
439: struct md_parse *p;
440: int i;
441: extern char *__progname;
1.1 kristaps 442:
1.21 kristaps 443: p = (struct md_parse *)arg;
1.1 kristaps 444:
1.21 kristaps 445: if ( ! (p->warn & MD_WARN_ALL))
1.1 kristaps 446: return(1);
1.21 kristaps 447:
448: fmt = lit = NULL;
449:
450: switch (type) {
451: case (WARN_SYNTAX_WS_EOLN):
452: lit = "syntax: whitespace at end-of-line";
453: break;
454: case (WARN_SYNTAX_MACLIKE):
455: lit = "syntax: macro-like argument";
456: break;
1.24 ! kristaps 457: case (WARN_SYNTAX_ARGLIKE):
! 458: lit = "syntax: argument-like value";
! 459: break;
1.23 kristaps 460: case (WARN_SEC_OO):
461: lit = "section is out of conventional order";
462: break;
1.21 kristaps 463: case (WARN_ARGS_GE1):
464: fmt = "macro `%s' suggests one or more arguments";
465: break;
466: default:
467: abort();
468: /* NOTREACHED */
1.1 kristaps 469: }
470:
1.21 kristaps 471: if (fmt) {
472: (void)fprintf(stderr, "%s:%d: warning: ",
473: p->name, p->lnn);
474: (void)fprintf(stderr, fmt, mdoc_macronames[tok]);
475: } else
476: (void)fprintf(stderr, "%s:%d: warning: %s",
477: p->name, p->lnn, lit);
478:
479: if (p->dbg >= 1) {
480: (void)fprintf(stderr, "\nFrom: %s\n ", p->line);
481: for (i = 0; i < col; i++)
482: (void)fprintf(stderr, " ");
483: (void)fprintf(stderr, "^\n");
484: } else
485: (void)fprintf(stderr, " (column %d)\n", col);
486:
487: if (p->warn & MD_WARN_ERR) {
488: (void)fprintf(stderr, "%s: considering warnings as "
489: "errors\n", __progname);
490: return(0);
1.1 kristaps 491: }
492:
1.21 kristaps 493: return(1);
1.1 kristaps 494: }
495:
496:
497: static void
498: usage(void)
499: {
500: extern char *__progname;
501:
1.21 kristaps 502: (void)fprintf(stderr, "usage: %s [-v] [-Wwarn...] [infile]\n",
1.19 kristaps 503: __progname);
1.1 kristaps 504: }
1.18 kristaps 505:
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