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