Annotation of mandoc/mdoc_validate.c, Revision 1.144
1.144 ! kristaps 1: /* $Id: mdoc_validate.c,v 1.143 2010/12/16 00:57:50 kristaps Exp $ */
1.1 kristaps 2: /*
1.110 schwarze 3: * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.5 kristaps 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.5 kristaps 9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 16: */
1.56 kristaps 17: #ifdef HAVE_CONFIG_H
18: #include "config.h"
19: #endif
20:
1.132 kristaps 21: #ifndef OSNAME
22: #include <sys/utsname.h>
23: #endif
24:
1.1 kristaps 25: #include <sys/types.h>
26:
27: #include <assert.h>
28: #include <ctype.h>
1.35 kristaps 29: #include <limits.h>
1.81 kristaps 30: #include <stdio.h>
1.1 kristaps 31: #include <stdlib.h>
1.2 kristaps 32: #include <string.h>
1.132 kristaps 33: #include <time.h>
1.1 kristaps 34:
1.79 kristaps 35: #include "mandoc.h"
1.1 kristaps 36: #include "libmdoc.h"
1.18 kristaps 37: #include "libmandoc.h"
1.1 kristaps 38:
39: /* FIXME: .Bl -diag can't have non-text children in HEAD. */
40:
1.91 kristaps 41: #define PRE_ARGS struct mdoc *mdoc, struct mdoc_node *n
1.32 kristaps 42: #define POST_ARGS struct mdoc *mdoc
1.1 kristaps 43:
1.131 kristaps 44: #define NUMSIZ 32
1.135 kristaps 45: #define DATESIZE 32
1.131 kristaps 46:
1.120 kristaps 47: enum check_ineq {
48: CHECK_LT,
49: CHECK_GT,
50: CHECK_EQ
51: };
52:
53: enum check_lvl {
54: CHECK_WARN,
55: CHECK_ERROR,
56: CHECK_FATAL
57: };
58:
1.1 kristaps 59: typedef int (*v_pre)(PRE_ARGS);
60: typedef int (*v_post)(POST_ARGS);
61:
62: struct valids {
63: v_pre *pre;
64: v_post *post;
65: };
66:
1.120 kristaps 67: static int check_count(struct mdoc *, enum mdoc_type,
68: enum check_lvl, enum check_ineq, int);
1.59 kristaps 69: static int check_parent(PRE_ARGS, enum mdoct, enum mdoc_type);
1.133 kristaps 70: static void check_text(struct mdoc *, int, int, char *);
71: static void check_argv(struct mdoc *,
1.92 kristaps 72: struct mdoc_node *, struct mdoc_argv *);
1.133 kristaps 73: static void check_args(struct mdoc *, struct mdoc_node *);
1.32 kristaps 74:
1.132 kristaps 75: static int concat(struct mdoc *, char *,
76: const struct mdoc_node *, size_t);
77:
1.120 kristaps 78: static int ebool(POST_ARGS);
1.32 kristaps 79: static int berr_ge1(POST_ARGS);
80: static int bwarn_ge1(POST_ARGS);
1.120 kristaps 81: static int eerr_eq0(POST_ARGS);
1.32 kristaps 82: static int eerr_eq1(POST_ARGS);
83: static int eerr_ge1(POST_ARGS);
1.46 kristaps 84: static int eerr_le1(POST_ARGS);
1.116 kristaps 85: static int ewarn_eq0(POST_ARGS);
1.32 kristaps 86: static int ewarn_ge1(POST_ARGS);
87: static int herr_eq0(POST_ARGS);
88: static int herr_ge1(POST_ARGS);
1.120 kristaps 89: static int hwarn_eq0(POST_ARGS);
1.32 kristaps 90: static int hwarn_eq1(POST_ARGS);
91: static int hwarn_le1(POST_ARGS);
92:
93: static int post_an(POST_ARGS);
94: static int post_at(POST_ARGS);
95: static int post_bf(POST_ARGS);
96: static int post_bl(POST_ARGS);
1.131 kristaps 97: static int post_bl_block(POST_ARGS);
98: static int post_bl_block_width(POST_ARGS);
99: static int post_bl_block_tag(POST_ARGS);
1.32 kristaps 100: static int post_bl_head(POST_ARGS);
1.132 kristaps 101: static int post_dd(POST_ARGS);
102: static int post_dt(POST_ARGS);
1.123 kristaps 103: static int post_defaults(POST_ARGS);
1.128 kristaps 104: static int post_literal(POST_ARGS);
1.123 kristaps 105: static int post_eoln(POST_ARGS);
1.32 kristaps 106: static int post_it(POST_ARGS);
107: static int post_lb(POST_ARGS);
108: static int post_nm(POST_ARGS);
1.132 kristaps 109: static int post_os(POST_ARGS);
1.140 kristaps 110: static int post_ignpar(POST_ARGS);
1.132 kristaps 111: static int post_prol(POST_ARGS);
1.32 kristaps 112: static int post_root(POST_ARGS);
1.43 kristaps 113: static int post_rs(POST_ARGS);
1.32 kristaps 114: static int post_sh(POST_ARGS);
115: static int post_sh_body(POST_ARGS);
116: static int post_sh_head(POST_ARGS);
117: static int post_st(POST_ARGS);
1.132 kristaps 118: static int post_std(POST_ARGS);
1.57 kristaps 119: static int post_vt(POST_ARGS);
1.32 kristaps 120: static int pre_an(PRE_ARGS);
121: static int pre_bd(PRE_ARGS);
122: static int pre_bl(PRE_ARGS);
123: static int pre_dd(PRE_ARGS);
124: static int pre_display(PRE_ARGS);
125: static int pre_dt(PRE_ARGS);
126: static int pre_it(PRE_ARGS);
1.128 kristaps 127: static int pre_literal(PRE_ARGS);
1.32 kristaps 128: static int pre_os(PRE_ARGS);
1.124 kristaps 129: static int pre_par(PRE_ARGS);
1.32 kristaps 130: static int pre_sh(PRE_ARGS);
131: static int pre_ss(PRE_ARGS);
1.133 kristaps 132: static int pre_std(PRE_ARGS);
1.32 kristaps 133:
134: static v_post posts_an[] = { post_an, NULL };
1.126 kristaps 135: static v_post posts_at[] = { post_at, post_defaults, NULL };
1.128 kristaps 136: static v_post posts_bd[] = { post_literal, hwarn_eq0, bwarn_ge1, NULL };
1.32 kristaps 137: static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
1.128 kristaps 138: static v_post posts_bk[] = { hwarn_eq0, bwarn_ge1, NULL };
1.32 kristaps 139: static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
140: static v_post posts_bool[] = { eerr_eq1, ebool, NULL };
1.84 kristaps 141: static v_post posts_eoln[] = { post_eoln, NULL };
1.123 kristaps 142: static v_post posts_defaults[] = { post_defaults, NULL };
1.132 kristaps 143: static v_post posts_dd[] = { ewarn_ge1, post_dd, post_prol, NULL };
1.128 kristaps 144: static v_post posts_dl[] = { post_literal, bwarn_ge1, herr_eq0, NULL };
1.132 kristaps 145: static v_post posts_dt[] = { post_dt, post_prol, NULL };
1.32 kristaps 146: static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
1.143 kristaps 147: static v_post posts_it[] = { post_it, NULL };
1.32 kristaps 148: static v_post posts_lb[] = { eerr_eq1, post_lb, NULL };
149: static v_post posts_nd[] = { berr_ge1, NULL };
150: static v_post posts_nm[] = { post_nm, NULL };
1.116 kristaps 151: static v_post posts_notext[] = { ewarn_eq0, NULL };
1.132 kristaps 152: static v_post posts_os[] = { post_os, post_prol, NULL };
1.44 kristaps 153: static v_post posts_rs[] = { berr_ge1, herr_eq0, post_rs, NULL };
1.140 kristaps 154: static v_post posts_sh[] = { post_ignpar, herr_ge1, bwarn_ge1, post_sh, NULL };
1.46 kristaps 155: static v_post posts_sp[] = { eerr_le1, NULL };
1.140 kristaps 156: static v_post posts_ss[] = { post_ignpar, herr_ge1, bwarn_ge1, NULL };
1.32 kristaps 157: static v_post posts_st[] = { eerr_eq1, post_st, NULL };
1.132 kristaps 158: static v_post posts_std[] = { post_std, NULL };
1.32 kristaps 159: static v_post posts_text[] = { eerr_ge1, NULL };
1.51 kristaps 160: static v_post posts_text1[] = { eerr_eq1, NULL };
1.57 kristaps 161: static v_post posts_vt[] = { post_vt, NULL };
1.32 kristaps 162: static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
163: static v_post posts_wtext[] = { ewarn_ge1, NULL };
164: static v_pre pres_an[] = { pre_an, NULL };
1.128 kristaps 165: static v_pre pres_bd[] = { pre_display, pre_bd, pre_literal, pre_par, NULL };
1.124 kristaps 166: static v_pre pres_bl[] = { pre_bl, pre_par, NULL };
1.32 kristaps 167: static v_pre pres_d1[] = { pre_display, NULL };
1.128 kristaps 168: static v_pre pres_dl[] = { pre_literal, pre_display, NULL };
1.32 kristaps 169: static v_pre pres_dd[] = { pre_dd, NULL };
170: static v_pre pres_dt[] = { pre_dt, NULL };
1.67 kristaps 171: static v_pre pres_er[] = { NULL, NULL };
1.77 kristaps 172: static v_pre pres_fd[] = { NULL, NULL };
1.141 kristaps 173: static v_pre pres_it[] = { pre_it, pre_par, NULL };
1.32 kristaps 174: static v_pre pres_os[] = { pre_os, NULL };
1.124 kristaps 175: static v_pre pres_pp[] = { pre_par, NULL };
1.32 kristaps 176: static v_pre pres_sh[] = { pre_sh, NULL };
177: static v_pre pres_ss[] = { pre_ss, NULL };
1.133 kristaps 178: static v_pre pres_std[] = { pre_std, NULL };
1.1 kristaps 179:
180: const struct valids mdoc_valids[MDOC_MAX] = {
1.10 kristaps 181: { NULL, NULL }, /* Ap */
1.132 kristaps 182: { pres_dd, posts_dd }, /* Dd */
1.85 kristaps 183: { pres_dt, posts_dt }, /* Dt */
1.132 kristaps 184: { pres_os, posts_os }, /* Os */
1.1 kristaps 185: { pres_sh, posts_sh }, /* Sh */
186: { pres_ss, posts_ss }, /* Ss */
1.117 kristaps 187: { pres_pp, posts_notext }, /* Pp */
1.1 kristaps 188: { pres_d1, posts_wline }, /* D1 */
1.128 kristaps 189: { pres_dl, posts_dl }, /* Dl */
190: { pres_bd, posts_bd }, /* Bd */
1.1 kristaps 191: { NULL, NULL }, /* Ed */
192: { pres_bl, posts_bl }, /* Bl */
193: { NULL, NULL }, /* El */
194: { pres_it, posts_it }, /* It */
195: { NULL, posts_text }, /* Ad */
196: { pres_an, posts_an }, /* An */
1.123 kristaps 197: { NULL, posts_defaults }, /* Ar */
1.69 kristaps 198: { NULL, posts_text }, /* Cd */
1.1 kristaps 199: { NULL, NULL }, /* Cm */
200: { NULL, NULL }, /* Dv */
201: { pres_er, posts_text }, /* Er */
202: { NULL, NULL }, /* Ev */
1.133 kristaps 203: { pres_std, posts_std }, /* Ex */
1.1 kristaps 204: { NULL, NULL }, /* Fa */
205: { pres_fd, posts_wtext }, /* Fd */
206: { NULL, NULL }, /* Fl */
207: { NULL, posts_text }, /* Fn */
208: { NULL, posts_wtext }, /* Ft */
209: { NULL, posts_text }, /* Ic */
1.51 kristaps 210: { NULL, posts_text1 }, /* In */
1.123 kristaps 211: { NULL, posts_defaults }, /* Li */
1.27 kristaps 212: { NULL, posts_nd }, /* Nd */
1.1 kristaps 213: { NULL, posts_nm }, /* Nm */
1.139 kristaps 214: { NULL, NULL }, /* Op */
1.1 kristaps 215: { NULL, NULL }, /* Ot */
1.129 kristaps 216: { NULL, posts_defaults }, /* Pa */
1.133 kristaps 217: { pres_std, posts_std }, /* Rv */
1.1 kristaps 218: { NULL, posts_st }, /* St */
219: { NULL, NULL }, /* Va */
1.57 kristaps 220: { NULL, posts_vt }, /* Vt */
1.84 kristaps 221: { NULL, posts_wtext }, /* Xr */
1.1 kristaps 222: { NULL, posts_text }, /* %A */
1.47 kristaps 223: { NULL, posts_text }, /* %B */ /* FIXME: can be used outside Rs/Re. */
1.54 kristaps 224: { NULL, posts_text }, /* %D */ /* FIXME: check date with mandoc_a2time(). */
1.1 kristaps 225: { NULL, posts_text }, /* %I */
226: { NULL, posts_text }, /* %J */
227: { NULL, posts_text }, /* %N */
228: { NULL, posts_text }, /* %O */
229: { NULL, posts_text }, /* %P */
230: { NULL, posts_text }, /* %R */
1.47 kristaps 231: { NULL, posts_text }, /* %T */ /* FIXME: can be used outside Rs/Re. */
1.1 kristaps 232: { NULL, posts_text }, /* %V */
233: { NULL, NULL }, /* Ac */
234: { NULL, NULL }, /* Ao */
1.139 kristaps 235: { NULL, NULL }, /* Aq */
1.1 kristaps 236: { NULL, posts_at }, /* At */
237: { NULL, NULL }, /* Bc */
238: { NULL, posts_bf }, /* Bf */
239: { NULL, NULL }, /* Bo */
1.139 kristaps 240: { NULL, NULL }, /* Bq */
1.1 kristaps 241: { NULL, NULL }, /* Bsx */
242: { NULL, NULL }, /* Bx */
243: { NULL, posts_bool }, /* Db */
244: { NULL, NULL }, /* Dc */
245: { NULL, NULL }, /* Do */
1.139 kristaps 246: { NULL, NULL }, /* Dq */
1.1 kristaps 247: { NULL, NULL }, /* Ec */
248: { NULL, NULL }, /* Ef */
249: { NULL, NULL }, /* Em */
250: { NULL, NULL }, /* Eo */
251: { NULL, NULL }, /* Fx */
252: { NULL, posts_text }, /* Ms */
253: { NULL, posts_notext }, /* No */
254: { NULL, posts_notext }, /* Ns */
255: { NULL, NULL }, /* Nx */
256: { NULL, NULL }, /* Ox */
257: { NULL, NULL }, /* Pc */
1.51 kristaps 258: { NULL, posts_text1 }, /* Pf */
1.1 kristaps 259: { NULL, NULL }, /* Po */
1.139 kristaps 260: { NULL, NULL }, /* Pq */
1.1 kristaps 261: { NULL, NULL }, /* Qc */
1.139 kristaps 262: { NULL, NULL }, /* Ql */
1.1 kristaps 263: { NULL, NULL }, /* Qo */
1.139 kristaps 264: { NULL, NULL }, /* Qq */
1.1 kristaps 265: { NULL, NULL }, /* Re */
1.43 kristaps 266: { NULL, posts_rs }, /* Rs */
1.1 kristaps 267: { NULL, NULL }, /* Sc */
268: { NULL, NULL }, /* So */
1.139 kristaps 269: { NULL, NULL }, /* Sq */
1.1 kristaps 270: { NULL, posts_bool }, /* Sm */
271: { NULL, posts_text }, /* Sx */
272: { NULL, posts_text }, /* Sy */
273: { NULL, posts_text }, /* Tn */
274: { NULL, NULL }, /* Ux */
275: { NULL, NULL }, /* Xc */
276: { NULL, NULL }, /* Xo */
277: { NULL, posts_fo }, /* Fo */
278: { NULL, NULL }, /* Fc */
279: { NULL, NULL }, /* Oo */
280: { NULL, NULL }, /* Oc */
1.128 kristaps 281: { NULL, posts_bk }, /* Bk */
1.1 kristaps 282: { NULL, NULL }, /* Ek */
1.84 kristaps 283: { NULL, posts_eoln }, /* Bt */
1.1 kristaps 284: { NULL, NULL }, /* Hf */
285: { NULL, NULL }, /* Fr */
1.84 kristaps 286: { NULL, posts_eoln }, /* Ud */
1.83 kristaps 287: { NULL, posts_lb }, /* Lb */
1.34 kristaps 288: { NULL, posts_notext }, /* Lp */
1.51 kristaps 289: { NULL, posts_text }, /* Lk */
1.123 kristaps 290: { NULL, posts_defaults }, /* Mt */
1.139 kristaps 291: { NULL, NULL }, /* Brq */
1.1 kristaps 292: { NULL, NULL }, /* Bro */
293: { NULL, NULL }, /* Brc */
294: { NULL, posts_text }, /* %C */
295: { NULL, NULL }, /* Es */
296: { NULL, NULL }, /* En */
297: { NULL, NULL }, /* Dx */
298: { NULL, posts_text }, /* %Q */
1.33 kristaps 299: { NULL, posts_notext }, /* br */
1.119 schwarze 300: { pres_pp, posts_sp }, /* sp */
1.51 kristaps 301: { NULL, posts_text1 }, /* %U */
1.88 kristaps 302: { NULL, NULL }, /* Ta */
1.1 kristaps 303: };
304:
1.122 kristaps 305: #define RSORD_MAX 14 /* Number of `Rs' blocks. */
306:
307: static const enum mdoct rsord[RSORD_MAX] = {
308: MDOC__A,
309: MDOC__T,
310: MDOC__B,
311: MDOC__I,
312: MDOC__J,
313: MDOC__R,
314: MDOC__N,
315: MDOC__V,
316: MDOC__P,
317: MDOC__Q,
318: MDOC__D,
319: MDOC__O,
320: MDOC__C,
321: MDOC__U
322: };
323:
1.1 kristaps 324:
325: int
1.91 kristaps 326: mdoc_valid_pre(struct mdoc *mdoc, struct mdoc_node *n)
1.1 kristaps 327: {
328: v_pre *p;
329: int line, pos;
1.92 kristaps 330: char *tp;
1.1 kristaps 331:
332: if (MDOC_TEXT == n->type) {
333: tp = n->string;
334: line = n->line;
335: pos = n->pos;
1.133 kristaps 336: check_text(mdoc, line, pos, tp);
337: return(1);
1.1 kristaps 338: }
339:
1.133 kristaps 340: check_args(mdoc, n);
341:
1.1 kristaps 342: if (NULL == mdoc_valids[n->tok].pre)
343: return(1);
344: for (p = mdoc_valids[n->tok].pre; *p; p++)
345: if ( ! (*p)(mdoc, n))
346: return(0);
347: return(1);
348: }
349:
350:
351: int
352: mdoc_valid_post(struct mdoc *mdoc)
353: {
354: v_post *p;
355:
356: if (MDOC_VALID & mdoc->last->flags)
357: return(1);
358: mdoc->last->flags |= MDOC_VALID;
359:
360: if (MDOC_TEXT == mdoc->last->type)
361: return(1);
362: if (MDOC_ROOT == mdoc->last->type)
363: return(post_root(mdoc));
364:
365: if (NULL == mdoc_valids[mdoc->last->tok].post)
366: return(1);
367: for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
368: if ( ! (*p)(mdoc))
369: return(0);
370:
371: return(1);
372: }
373:
1.120 kristaps 374: static int
375: check_count(struct mdoc *m, enum mdoc_type type,
376: enum check_lvl lvl, enum check_ineq ineq, int val)
377: {
378: const char *p;
379:
380: if (m->last->type != type)
381: return(1);
382:
383: switch (ineq) {
384: case (CHECK_LT):
385: p = "less than ";
386: if (m->last->nchild < val)
387: return(1);
388: break;
389: case (CHECK_GT):
390: p = "greater than ";
391: if (m->last->nchild > val)
392: return(1);
393: break;
394: case (CHECK_EQ):
395: p = "";
396: if (val == m->last->nchild)
397: return(1);
398: break;
1.133 kristaps 399: default:
400: abort();
401: /* NOTREACHED */
1.120 kristaps 402: }
403:
404: if (CHECK_WARN == lvl) {
405: return(mdoc_vmsg(m, MANDOCERR_ARGCOUNT,
406: m->last->line, m->last->pos,
407: "want %s%d children (have %d)",
408: p, val, m->last->nchild));
409: }
410:
1.133 kristaps 411: /* FIXME: THIS IS THE SAME AS THE ABOVE. */
412:
1.120 kristaps 413: return(mdoc_vmsg(m, MANDOCERR_ARGCOUNT,
414: m->last->line, m->last->pos,
415: "require %s%d children (have %d)",
416: p, val, m->last->nchild));
417: }
418:
419: static int
420: berr_ge1(POST_ARGS)
421: {
422:
423: return(check_count(mdoc, MDOC_BODY, CHECK_FATAL, CHECK_GT, 0));
424: }
425:
426: static int
427: bwarn_ge1(POST_ARGS)
428: {
429: return(check_count(mdoc, MDOC_BODY, CHECK_WARN, CHECK_GT, 0));
430: }
431:
432: static int
433: eerr_eq0(POST_ARGS)
434: {
435: return(check_count(mdoc, MDOC_ELEM, CHECK_FATAL, CHECK_EQ, 0));
436: }
1.1 kristaps 437:
1.120 kristaps 438: static int
439: eerr_eq1(POST_ARGS)
1.1 kristaps 440: {
1.120 kristaps 441: return(check_count(mdoc, MDOC_ELEM, CHECK_FATAL, CHECK_EQ, 1));
442: }
1.1 kristaps 443:
1.120 kristaps 444: static int
445: eerr_ge1(POST_ARGS)
446: {
447: return(check_count(mdoc, MDOC_ELEM, CHECK_FATAL, CHECK_GT, 0));
1.1 kristaps 448: }
449:
1.120 kristaps 450: static int
451: eerr_le1(POST_ARGS)
452: {
453: return(check_count(mdoc, MDOC_ELEM, CHECK_FATAL, CHECK_LT, 2));
454: }
1.1 kristaps 455:
1.120 kristaps 456: static int
457: ewarn_eq0(POST_ARGS)
1.1 kristaps 458: {
1.120 kristaps 459: return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_EQ, 0));
460: }
1.1 kristaps 461:
1.120 kristaps 462: static int
463: ewarn_ge1(POST_ARGS)
464: {
465: return(check_count(mdoc, MDOC_ELEM, CHECK_WARN, CHECK_GT, 0));
1.1 kristaps 466: }
467:
1.120 kristaps 468: static int
469: herr_eq0(POST_ARGS)
470: {
471: return(check_count(mdoc, MDOC_HEAD, CHECK_FATAL, CHECK_EQ, 0));
472: }
1.1 kristaps 473:
1.120 kristaps 474: static int
475: herr_ge1(POST_ARGS)
476: {
477: return(check_count(mdoc, MDOC_HEAD, CHECK_FATAL, CHECK_GT, 0));
478: }
1.1 kristaps 479:
1.120 kristaps 480: static int
481: hwarn_eq0(POST_ARGS)
482: {
483: return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 0));
1.1 kristaps 484: }
485:
1.120 kristaps 486: static int
487: hwarn_eq1(POST_ARGS)
488: {
489: return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_EQ, 1));
490: }
1.1 kristaps 491:
1.120 kristaps 492: static int
493: hwarn_le1(POST_ARGS)
494: {
495: return(check_count(mdoc, MDOC_HEAD, CHECK_WARN, CHECK_LT, 2));
496: }
1.1 kristaps 497:
1.133 kristaps 498: static void
1.92 kristaps 499: check_args(struct mdoc *m, struct mdoc_node *n)
1.1 kristaps 500: {
501: int i;
502:
503: if (NULL == n->args)
1.133 kristaps 504: return;
1.1 kristaps 505:
506: assert(n->args->argc);
507: for (i = 0; i < (int)n->args->argc; i++)
1.133 kristaps 508: check_argv(m, n, &n->args->argv[i]);
1.1 kristaps 509: }
510:
1.133 kristaps 511: static void
1.92 kristaps 512: check_argv(struct mdoc *m, struct mdoc_node *n, struct mdoc_argv *v)
1.1 kristaps 513: {
514: int i;
515:
516: for (i = 0; i < (int)v->sz; i++)
1.133 kristaps 517: check_text(m, v->line, v->pos, v->value[i]);
1.1 kristaps 518:
1.133 kristaps 519: /* FIXME: move to post_std(). */
1.1 kristaps 520:
1.133 kristaps 521: if (MDOC_Std == v->arg)
522: if ( ! (v->sz || m->meta.name))
523: mdoc_nmsg(m, n, MANDOCERR_NONAME);
1.1 kristaps 524: }
525:
1.133 kristaps 526: static void
1.112 kristaps 527: check_text(struct mdoc *m, int ln, int pos, char *p)
1.1 kristaps 528: {
1.18 kristaps 529: int c;
1.112 kristaps 530: size_t sz;
1.102 kristaps 531:
1.112 kristaps 532: for ( ; *p; p++, pos++) {
533: sz = strcspn(p, "\t\\");
534: p += (int)sz;
535:
536: if ('\0' == *p)
537: break;
538:
539: pos += (int)sz;
1.1 kristaps 540:
541: if ('\t' == *p) {
1.133 kristaps 542: if ( ! (MDOC_LITERAL & m->flags))
543: mdoc_pmsg(m, ln, pos, MANDOCERR_BADTAB);
544: continue;
1.112 kristaps 545: }
1.1 kristaps 546:
1.133 kristaps 547: if (0 == (c = mandoc_special(p))) {
548: mdoc_pmsg(m, ln, pos, MANDOCERR_BADESCAPE);
549: continue;
550: }
1.1 kristaps 551:
1.133 kristaps 552: p += c - 1;
553: pos += c - 1;
1.1 kristaps 554: }
555: }
556:
557: static int
1.59 kristaps 558: check_parent(PRE_ARGS, enum mdoct tok, enum mdoc_type t)
1.1 kristaps 559: {
560:
561: assert(n->parent);
562: if ((MDOC_ROOT == t || tok == n->parent->tok) &&
563: (t == n->parent->type))
564: return(1);
565:
1.79 kristaps 566: mdoc_vmsg(mdoc, MANDOCERR_SYNTCHILD,
567: n->line, n->pos, "want parent %s",
568: MDOC_ROOT == t ? "<root>" :
569: mdoc_macronames[tok]);
570: return(0);
1.1 kristaps 571: }
572:
573:
574: static int
575: pre_display(PRE_ARGS)
576: {
577: struct mdoc_node *node;
578:
579: if (MDOC_BLOCK != n->type)
580: return(1);
581:
582: for (node = mdoc->last->parent; node; node = node->parent)
583: if (MDOC_BLOCK == node->type)
584: if (MDOC_Bd == node->tok)
585: break;
1.128 kristaps 586:
1.135 kristaps 587: if (node)
588: mdoc_nmsg(mdoc, n, MANDOCERR_NESTEDDISP);
1.1 kristaps 589:
1.135 kristaps 590: return(1);
1.1 kristaps 591: }
592:
593:
594: static int
595: pre_bl(PRE_ARGS)
596: {
1.104 kristaps 597: int i, comp, dup;
598: const char *offs, *width;
599: enum mdoc_list lt;
600: struct mdoc_node *np;
1.1 kristaps 601:
1.91 kristaps 602: if (MDOC_BLOCK != n->type) {
1.104 kristaps 603: if (ENDBODY_NOT != n->end) {
604: assert(n->pending);
605: np = n->pending->parent;
606: } else
607: np = n->parent;
608:
609: assert(np);
610: assert(MDOC_BLOCK == np->type);
611: assert(MDOC_Bl == np->tok);
612: assert(np->data.Bl);
613: n->data.Bl = np->data.Bl;
1.1 kristaps 614: return(1);
1.79 kristaps 615: }
1.1 kristaps 616:
1.91 kristaps 617: /*
618: * First figure out which kind of list to use: bind ourselves to
619: * the first mentioned list type and warn about any remaining
620: * ones. If we find no list type, we default to LIST_item.
621: */
1.1 kristaps 622:
1.104 kristaps 623: assert(NULL == n->data.Bl);
624: n->data.Bl = mandoc_calloc(1, sizeof(struct mdoc_bl));
1.1 kristaps 625:
626: /* LINTED */
1.91 kristaps 627: for (i = 0; n->args && i < (int)n->args->argc; i++) {
628: lt = LIST__NONE;
1.97 kristaps 629: dup = comp = 0;
1.99 kristaps 630: width = offs = NULL;
1.91 kristaps 631: switch (n->args->argv[i].arg) {
632: /* Set list types. */
1.1 kristaps 633: case (MDOC_Bullet):
1.91 kristaps 634: lt = LIST_bullet;
635: break;
1.1 kristaps 636: case (MDOC_Dash):
1.91 kristaps 637: lt = LIST_dash;
638: break;
1.1 kristaps 639: case (MDOC_Enum):
1.91 kristaps 640: lt = LIST_enum;
641: break;
1.1 kristaps 642: case (MDOC_Hyphen):
1.91 kristaps 643: lt = LIST_hyphen;
644: break;
1.1 kristaps 645: case (MDOC_Item):
1.91 kristaps 646: lt = LIST_item;
647: break;
1.1 kristaps 648: case (MDOC_Tag):
1.91 kristaps 649: lt = LIST_tag;
650: break;
1.1 kristaps 651: case (MDOC_Diag):
1.91 kristaps 652: lt = LIST_diag;
653: break;
1.1 kristaps 654: case (MDOC_Hang):
1.91 kristaps 655: lt = LIST_hang;
656: break;
1.1 kristaps 657: case (MDOC_Ohang):
1.91 kristaps 658: lt = LIST_ohang;
659: break;
1.1 kristaps 660: case (MDOC_Inset):
1.91 kristaps 661: lt = LIST_inset;
662: break;
1.1 kristaps 663: case (MDOC_Column):
1.91 kristaps 664: lt = LIST_column;
665: break;
666: /* Set list arguments. */
1.45 kristaps 667: case (MDOC_Compact):
1.104 kristaps 668: dup = n->data.Bl->comp;
1.97 kristaps 669: comp = 1;
1.91 kristaps 670: break;
1.1 kristaps 671: case (MDOC_Width):
1.104 kristaps 672: dup = (NULL != n->data.Bl->width);
1.99 kristaps 673: width = n->args->argv[i].value[0];
1.8 kristaps 674: break;
1.1 kristaps 675: case (MDOC_Offset):
1.98 kristaps 676: /* NB: this can be empty! */
677: if (n->args->argv[i].sz) {
678: offs = n->args->argv[i].value[0];
1.104 kristaps 679: dup = (NULL != n->data.Bl->offs);
1.98 kristaps 680: break;
681: }
1.133 kristaps 682: mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
1.1 kristaps 683: break;
1.113 kristaps 684: default:
685: continue;
1.1 kristaps 686: }
687:
1.91 kristaps 688: /* Check: duplicate auxiliary arguments. */
689:
1.133 kristaps 690: if (dup)
691: mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP);
1.97 kristaps 692:
693: if (comp && ! dup)
1.104 kristaps 694: n->data.Bl->comp = comp;
1.98 kristaps 695: if (offs && ! dup)
1.104 kristaps 696: n->data.Bl->offs = offs;
1.99 kristaps 697: if (width && ! dup)
1.104 kristaps 698: n->data.Bl->width = width;
1.91 kristaps 699:
700: /* Check: multiple list types. */
701:
1.104 kristaps 702: if (LIST__NONE != lt && n->data.Bl->type != LIST__NONE)
1.133 kristaps 703: mdoc_nmsg(mdoc, n, MANDOCERR_LISTREP);
1.91 kristaps 704:
705: /* Assign list type. */
706:
1.109 kristaps 707: if (LIST__NONE != lt && n->data.Bl->type == LIST__NONE) {
1.104 kristaps 708: n->data.Bl->type = lt;
1.109 kristaps 709: /* Set column information, too. */
710: if (LIST_column == lt) {
711: n->data.Bl->ncols =
712: n->args->argv[i].sz;
713: n->data.Bl->cols = (const char **)
714: n->args->argv[i].value;
715: }
716: }
1.91 kristaps 717:
718: /* The list type should come first. */
719:
1.104 kristaps 720: if (n->data.Bl->type == LIST__NONE)
721: if (n->data.Bl->width ||
722: n->data.Bl->offs ||
723: n->data.Bl->comp)
1.133 kristaps 724: mdoc_nmsg(mdoc, n, MANDOCERR_LISTFIRST);
1.91 kristaps 725:
726: continue;
727: }
728:
729: /* Allow lists to default to LIST_item. */
730:
1.104 kristaps 731: if (LIST__NONE == n->data.Bl->type) {
1.133 kristaps 732: mdoc_nmsg(mdoc, n, MANDOCERR_LISTTYPE);
1.104 kristaps 733: n->data.Bl->type = LIST_item;
1.79 kristaps 734: }
1.1 kristaps 735:
1.8 kristaps 736: /*
737: * Validate the width field. Some list types don't need width
738: * types and should be warned about them. Others should have it
739: * and must also be warned.
740: */
741:
1.104 kristaps 742: switch (n->data.Bl->type) {
1.91 kristaps 743: case (LIST_tag):
1.104 kristaps 744: if (n->data.Bl->width)
1.91 kristaps 745: break;
1.133 kristaps 746: mdoc_nmsg(mdoc, n, MANDOCERR_NOWIDTHARG);
747: break;
1.91 kristaps 748: case (LIST_column):
1.1 kristaps 749: /* FALLTHROUGH */
1.91 kristaps 750: case (LIST_diag):
1.1 kristaps 751: /* FALLTHROUGH */
1.91 kristaps 752: case (LIST_ohang):
1.53 kristaps 753: /* FALLTHROUGH */
1.91 kristaps 754: case (LIST_inset):
1.1 kristaps 755: /* FALLTHROUGH */
1.91 kristaps 756: case (LIST_item):
1.137 kristaps 757: if (n->data.Bl->width)
758: mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
1.133 kristaps 759: break;
1.8 kristaps 760: default:
761: break;
762: }
763:
1.1 kristaps 764: return(1);
765: }
766:
767:
768: static int
769: pre_bd(PRE_ARGS)
770: {
1.104 kristaps 771: int i, dup, comp;
772: enum mdoc_disp dt;
773: const char *offs;
774: struct mdoc_node *np;
1.1 kristaps 775:
1.93 kristaps 776: if (MDOC_BLOCK != n->type) {
1.104 kristaps 777: if (ENDBODY_NOT != n->end) {
778: assert(n->pending);
779: np = n->pending->parent;
780: } else
781: np = n->parent;
782:
783: assert(np);
784: assert(MDOC_BLOCK == np->type);
785: assert(MDOC_Bd == np->tok);
786: assert(np->data.Bd);
787: n->data.Bd = np->data.Bd;
1.1 kristaps 788: return(1);
1.79 kristaps 789: }
1.1 kristaps 790:
1.104 kristaps 791: assert(NULL == n->data.Bd);
792: n->data.Bd = mandoc_calloc(1, sizeof(struct mdoc_bd));
1.1 kristaps 793:
794: /* LINTED */
1.93 kristaps 795: for (i = 0; n->args && i < (int)n->args->argc; i++) {
796: dt = DISP__NONE;
1.94 kristaps 797: dup = comp = 0;
798: offs = NULL;
799:
1.1 kristaps 800: switch (n->args->argv[i].arg) {
1.49 kristaps 801: case (MDOC_Centred):
1.93 kristaps 802: dt = DISP_centred;
803: break;
1.1 kristaps 804: case (MDOC_Ragged):
1.93 kristaps 805: dt = DISP_ragged;
806: break;
1.1 kristaps 807: case (MDOC_Unfilled):
1.93 kristaps 808: dt = DISP_unfilled;
809: break;
1.1 kristaps 810: case (MDOC_Filled):
1.93 kristaps 811: dt = DISP_filled;
812: break;
1.1 kristaps 813: case (MDOC_Literal):
1.93 kristaps 814: dt = DISP_literal;
1.79 kristaps 815: break;
1.93 kristaps 816: case (MDOC_File):
817: mdoc_nmsg(mdoc, n, MANDOCERR_BADDISP);
818: return(0);
819: case (MDOC_Offset):
1.94 kristaps 820: /* NB: this can be empty! */
821: if (n->args->argv[i].sz) {
822: offs = n->args->argv[i].value[0];
1.104 kristaps 823: dup = (NULL != n->data.Bd->offs);
1.94 kristaps 824: break;
825: }
1.133 kristaps 826: mdoc_nmsg(mdoc, n, MANDOCERR_IGNARGV);
1.94 kristaps 827: break;
1.93 kristaps 828: case (MDOC_Compact):
1.94 kristaps 829: comp = 1;
1.104 kristaps 830: dup = n->data.Bd->comp;
1.94 kristaps 831: break;
1.1 kristaps 832: default:
1.94 kristaps 833: abort();
834: /* NOTREACHED */
1.1 kristaps 835: }
836:
1.94 kristaps 837: /* Check whether we have duplicates. */
838:
1.133 kristaps 839: if (dup)
840: mdoc_nmsg(mdoc, n, MANDOCERR_ARGVREP);
1.94 kristaps 841:
842: /* Make our auxiliary assignments. */
843:
844: if (offs && ! dup)
1.104 kristaps 845: n->data.Bd->offs = offs;
1.94 kristaps 846: if (comp && ! dup)
1.104 kristaps 847: n->data.Bd->comp = comp;
1.94 kristaps 848:
849: /* Check whether a type has already been assigned. */
850:
1.104 kristaps 851: if (DISP__NONE != dt && n->data.Bd->type != DISP__NONE)
1.133 kristaps 852: mdoc_nmsg(mdoc, n, MANDOCERR_DISPREP);
1.93 kristaps 853:
1.94 kristaps 854: /* Make our type assignment. */
855:
1.104 kristaps 856: if (DISP__NONE != dt && n->data.Bd->type == DISP__NONE)
857: n->data.Bd->type = dt;
1.93 kristaps 858: }
859:
1.104 kristaps 860: if (DISP__NONE == n->data.Bd->type) {
1.133 kristaps 861: mdoc_nmsg(mdoc, n, MANDOCERR_DISPTYPE);
1.104 kristaps 862: n->data.Bd->type = DISP_ragged;
1.93 kristaps 863: }
864:
865: return(1);
1.1 kristaps 866: }
867:
868:
869: static int
870: pre_ss(PRE_ARGS)
871: {
872:
873: if (MDOC_BLOCK != n->type)
874: return(1);
875: return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
876: }
877:
878:
879: static int
880: pre_sh(PRE_ARGS)
881: {
882:
883: if (MDOC_BLOCK != n->type)
884: return(1);
1.100 kristaps 885:
886: mdoc->regs->regs[(int)REG_nS].set = 0;
1.70 kristaps 887: return(check_parent(mdoc, n, MDOC_MAX, MDOC_ROOT));
1.1 kristaps 888: }
889:
890:
891: static int
892: pre_it(PRE_ARGS)
893: {
894:
895: if (MDOC_BLOCK != n->type)
896: return(1);
1.133 kristaps 897:
1.1 kristaps 898: return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
899: }
900:
901:
902: static int
903: pre_an(PRE_ARGS)
904: {
1.121 kristaps 905: int i;
1.1 kristaps 906:
1.144 ! kristaps 907: assert(NULL == n->data.An);
! 908: n->data.An = mandoc_calloc(1, sizeof(struct mdoc_an));
! 909:
1.107 kristaps 910: if (NULL == n->args)
1.1 kristaps 911: return(1);
1.121 kristaps 912:
913: for (i = 1; i < (int)n->args->argc; i++)
1.133 kristaps 914: mdoc_pmsg(mdoc, n->args->argv[i].line,
915: n->args->argv[i].pos, MANDOCERR_IGNARGV);
1.120 kristaps 916:
1.107 kristaps 917: if (MDOC_Split == n->args->argv[0].arg)
1.144 ! kristaps 918: n->data.An->auth = AUTH_split;
1.107 kristaps 919: else if (MDOC_Nosplit == n->args->argv[0].arg)
1.144 ! kristaps 920: n->data.An->auth = AUTH_nosplit;
1.107 kristaps 921: else
922: abort();
923:
924: return(1);
1.1 kristaps 925: }
926:
927: static int
1.133 kristaps 928: pre_std(PRE_ARGS)
1.1 kristaps 929: {
930:
1.133 kristaps 931: if (n->args && 1 == n->args->argc)
932: if (MDOC_Std == n->args->argv[0].arg)
933: return(1);
934:
935: mdoc_nmsg(mdoc, n, MANDOCERR_NOARGV);
936: return(1);
1.1 kristaps 937: }
938:
1.85 kristaps 939: static int
1.1 kristaps 940: pre_dt(PRE_ARGS)
941: {
1.54 kristaps 942:
1.1 kristaps 943: if (0 == mdoc->meta.date || mdoc->meta.os)
1.133 kristaps 944: mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
945:
1.1 kristaps 946: if (mdoc->meta.title)
1.133 kristaps 947: mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
948:
1.1 kristaps 949: return(1);
950: }
951:
952: static int
953: pre_os(PRE_ARGS)
954: {
955:
956: if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
1.133 kristaps 957: mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
958:
1.1 kristaps 959: if (mdoc->meta.os)
1.133 kristaps 960: mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
961:
1.1 kristaps 962: return(1);
963: }
964:
965: static int
966: pre_dd(PRE_ARGS)
967: {
968:
969: if (mdoc->meta.title || mdoc->meta.os)
1.133 kristaps 970: mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGOOO);
971:
1.1 kristaps 972: if (mdoc->meta.date)
1.133 kristaps 973: mdoc_nmsg(mdoc, n, MANDOCERR_PROLOGREP);
974:
1.1 kristaps 975: return(1);
976: }
977:
978:
979: static int
980: post_bf(POST_ARGS)
981: {
1.105 kristaps 982: struct mdoc_node *np;
1.113 kristaps 983: enum mdocargt arg;
1.105 kristaps 984:
985: /*
986: * Unlike other data pointers, these are "housed" by the HEAD
987: * element, which contains the goods.
988: */
1.1 kristaps 989:
1.105 kristaps 990: if (MDOC_HEAD != mdoc->last->type) {
991: if (ENDBODY_NOT != mdoc->last->end) {
992: assert(mdoc->last->pending);
993: np = mdoc->last->pending->parent->head;
994: } else if (MDOC_BLOCK != mdoc->last->type) {
995: np = mdoc->last->parent->head;
996: } else
997: np = mdoc->last->head;
998:
999: assert(np);
1000: assert(MDOC_HEAD == np->type);
1001: assert(MDOC_Bf == np->tok);
1002: assert(np->data.Bf);
1003: mdoc->last->data.Bf = np->data.Bf;
1.1 kristaps 1004: return(1);
1.105 kristaps 1005: }
1.1 kristaps 1006:
1.105 kristaps 1007: np = mdoc->last;
1.106 kristaps 1008: assert(MDOC_BLOCK == np->parent->type);
1009: assert(MDOC_Bf == np->parent->tok);
1.105 kristaps 1010: np->data.Bf = mandoc_calloc(1, sizeof(struct mdoc_bf));
1.1 kristaps 1011:
1.105 kristaps 1012: /*
1013: * Cannot have both argument and parameter.
1014: * If neither is specified, let it through with a warning.
1015: */
1016:
1.106 kristaps 1017: if (np->parent->args && np->child) {
1.105 kristaps 1018: mdoc_nmsg(mdoc, np, MANDOCERR_SYNTARGVCOUNT);
1.79 kristaps 1019: return(0);
1.133 kristaps 1020: } else if (NULL == np->parent->args && NULL == np->child) {
1021: mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE);
1022: return(1);
1023: }
1.105 kristaps 1024:
1025: /* Extract argument into data. */
1026:
1.106 kristaps 1027: if (np->parent->args) {
1028: arg = np->parent->args->argv[0].arg;
1.105 kristaps 1029: if (MDOC_Emphasis == arg)
1030: np->data.Bf->font = FONT_Em;
1031: else if (MDOC_Literal == arg)
1032: np->data.Bf->font = FONT_Li;
1033: else if (MDOC_Symbolic == arg)
1034: np->data.Bf->font = FONT_Sy;
1035: else
1036: abort();
1.13 kristaps 1037: return(1);
1.79 kristaps 1038: }
1.1 kristaps 1039:
1.105 kristaps 1040: /* Extract parameter into data. */
1.1 kristaps 1041:
1.105 kristaps 1042: if (0 == strcmp(np->child->string, "Em"))
1043: np->data.Bf->font = FONT_Em;
1044: else if (0 == strcmp(np->child->string, "Li"))
1045: np->data.Bf->font = FONT_Li;
1046: else if (0 == strcmp(np->child->string, "Sy"))
1047: np->data.Bf->font = FONT_Sy;
1.133 kristaps 1048: else
1049: mdoc_nmsg(mdoc, np, MANDOCERR_FONTTYPE);
1.1 kristaps 1050:
1.105 kristaps 1051: return(1);
1.1 kristaps 1052: }
1053:
1054: static int
1.31 kristaps 1055: post_lb(POST_ARGS)
1056: {
1.127 kristaps 1057: const char *p;
1058: char *buf;
1059: size_t sz;
1060:
1061: assert(mdoc->last->child);
1062: assert(MDOC_TEXT == mdoc->last->child->type);
1063:
1064: p = mdoc_a2lib(mdoc->last->child->string);
1065:
1066: /* If lookup ok, replace with table value. */
1.31 kristaps 1067:
1.127 kristaps 1068: if (p) {
1069: free(mdoc->last->child->string);
1070: mdoc->last->child->string = mandoc_strdup(p);
1.31 kristaps 1071: return(1);
1.127 kristaps 1072: }
1073:
1074: /* If not, use "library ``xxxx''. */
1075:
1076: sz = strlen(mdoc->last->child->string) +
1077: 2 + strlen("\\(lqlibrary\\(rq");
1078: buf = mandoc_malloc(sz);
1079: snprintf(buf, sz, "library \\(lq%s\\(rq",
1080: mdoc->last->child->string);
1081: free(mdoc->last->child->string);
1082: mdoc->last->child->string = buf;
1083: return(1);
1.84 kristaps 1084: }
1085:
1086: static int
1087: post_eoln(POST_ARGS)
1088: {
1089:
1.133 kristaps 1090: if (mdoc->last->child)
1091: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST);
1092: return(1);
1.31 kristaps 1093: }
1094:
1095:
1096: static int
1.57 kristaps 1097: post_vt(POST_ARGS)
1098: {
1099: const struct mdoc_node *n;
1100:
1101: /*
1102: * The Vt macro comes in both ELEM and BLOCK form, both of which
1103: * have different syntaxes (yet more context-sensitive
1104: * behaviour). ELEM types must have a child; BLOCK types,
1105: * specifically the BODY, should only have TEXT children.
1106: */
1107:
1108: if (MDOC_ELEM == mdoc->last->type)
1109: return(eerr_ge1(mdoc));
1110: if (MDOC_BODY != mdoc->last->type)
1111: return(1);
1112:
1113: for (n = mdoc->last->child; n; n = n->next)
1114: if (MDOC_TEXT != n->type)
1.133 kristaps 1115: mdoc_nmsg(mdoc, n, MANDOCERR_CHILD);
1.57 kristaps 1116:
1117: return(1);
1118: }
1119:
1120:
1121: static int
1.1 kristaps 1122: post_nm(POST_ARGS)
1123: {
1.132 kristaps 1124: char buf[BUFSIZ];
1.129 kristaps 1125:
1126: /* If no child specified, make sure we have the meta name. */
1.1 kristaps 1127:
1.129 kristaps 1128: if (NULL == mdoc->last->child && NULL == mdoc->meta.name) {
1129: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NONAME);
1.1 kristaps 1130: return(1);
1.129 kristaps 1131: } else if (mdoc->meta.name)
1.1 kristaps 1132: return(1);
1.129 kristaps 1133:
1134: /* If no meta name, set it from the child. */
1135:
1.132 kristaps 1136: if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ))
1137: return(0);
1.129 kristaps 1138:
1.132 kristaps 1139: mdoc->meta.name = mandoc_strdup(buf);
1.129 kristaps 1140:
1141: return(1);
1.1 kristaps 1142: }
1143:
1.123 kristaps 1144: static int
1.128 kristaps 1145: post_literal(POST_ARGS)
1146: {
1147:
1148: /*
1149: * The `Dl' (note "el" not "one") and `Bd' macros unset the
1150: * MDOC_LITERAL flag as they leave. Note that `Bd' only sets
1151: * this in literal mode, but it doesn't hurt to just switch it
1152: * off in general since displays can't be nested.
1153: */
1154:
1155: if (MDOC_BODY == mdoc->last->type)
1.134 kristaps 1156: mdoc->flags &= ~MDOC_LITERAL;
1.128 kristaps 1157:
1158: return(1);
1159: }
1160:
1161: static int
1.123 kristaps 1162: post_defaults(POST_ARGS)
1163: {
1164: struct mdoc_node *nn;
1165:
1166: /*
1167: * The `Ar' defaults to "file ..." if no value is provided as an
1.129 kristaps 1168: * argument; the `Mt' and `Pa' macros use "~"; the `Li' just
1169: * gets an empty string.
1.123 kristaps 1170: */
1171:
1172: if (mdoc->last->child)
1173: return(1);
1174:
1175: nn = mdoc->last;
1176: mdoc->next = MDOC_NEXT_CHILD;
1177:
1178: switch (nn->tok) {
1179: case (MDOC_Ar):
1180: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "file"))
1181: return(0);
1182: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "..."))
1183: return(0);
1184: break;
1.126 kristaps 1185: case (MDOC_At):
1186: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "AT&T"))
1187: return(0);
1188: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "UNIX"))
1189: return(0);
1190: break;
1.123 kristaps 1191: case (MDOC_Li):
1192: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, ""))
1193: return(0);
1194: break;
1.129 kristaps 1195: case (MDOC_Pa):
1196: /* FALLTHROUGH */
1.123 kristaps 1197: case (MDOC_Mt):
1198: if ( ! mdoc_word_alloc(mdoc, nn->line, nn->pos, "~"))
1199: return(0);
1200: break;
1201: default:
1202: abort();
1203: /* NOTREACHED */
1204: }
1205:
1206: mdoc->last = nn;
1207: return(1);
1208: }
1.1 kristaps 1209:
1210: static int
1211: post_at(POST_ARGS)
1212: {
1.126 kristaps 1213: const char *p, *q;
1214: char *buf;
1215: size_t sz;
1.1 kristaps 1216:
1.126 kristaps 1217: /*
1218: * If we have a child, look it up in the standard keys. If a
1219: * key exist, use that instead of the child; if it doesn't,
1220: * prefix "AT&T UNIX " to the existing data.
1221: */
1222:
1.1 kristaps 1223: if (NULL == mdoc->last->child)
1224: return(1);
1.126 kristaps 1225:
1.79 kristaps 1226: assert(MDOC_TEXT == mdoc->last->child->type);
1.126 kristaps 1227: p = mdoc_a2att(mdoc->last->child->string);
1228:
1229: if (p) {
1230: free(mdoc->last->child->string);
1231: mdoc->last->child->string = mandoc_strdup(p);
1232: } else {
1233: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADATT);
1234: p = "AT&T UNIX ";
1235: q = mdoc->last->child->string;
1236: sz = strlen(p) + strlen(q) + 1;
1237: buf = mandoc_malloc(sz);
1238: strlcpy(buf, p, sz);
1239: strlcat(buf, q, sz);
1240: free(mdoc->last->child->string);
1241: mdoc->last->child->string = buf;
1242: }
1243:
1244: return(1);
1.1 kristaps 1245: }
1246:
1247: static int
1248: post_an(POST_ARGS)
1249: {
1.107 kristaps 1250: struct mdoc_node *np;
1.1 kristaps 1251:
1.107 kristaps 1252: np = mdoc->last;
1.144 ! kristaps 1253: if (AUTH__NONE != np->data.An->auth && np->child)
1.120 kristaps 1254: return(eerr_eq0(mdoc));
1.133 kristaps 1255:
1.120 kristaps 1256: /*
1257: * FIXME: make this ewarn and make sure that the front-ends
1258: * don't print the arguments.
1259: */
1.144 ! kristaps 1260: if (AUTH__NONE != np->data.An->auth || np->child)
1.1 kristaps 1261: return(1);
1.133 kristaps 1262:
1263: mdoc_nmsg(mdoc, np, MANDOCERR_NOARGS);
1264: return(1);
1.1 kristaps 1265: }
1266:
1267:
1268: static int
1269: post_it(POST_ARGS)
1270: {
1.89 kristaps 1271: int i, cols, rc;
1272: enum mdoc_list lt;
1.1 kristaps 1273: struct mdoc_node *n, *c;
1.89 kristaps 1274: enum mandocerr er;
1.1 kristaps 1275:
1276: if (MDOC_BLOCK != mdoc->last->type)
1277: return(1);
1278:
1279: n = mdoc->last->parent->parent;
1.104 kristaps 1280: assert(n->data.Bl);
1281: lt = n->data.Bl->type;
1.89 kristaps 1282:
1283: if (LIST__NONE == lt) {
1.79 kristaps 1284: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_LISTTYPE);
1.133 kristaps 1285: return(1);
1.79 kristaps 1286: }
1.1 kristaps 1287:
1.89 kristaps 1288: switch (lt) {
1289: case (LIST_tag):
1290: if (mdoc->last->head->child)
1.1 kristaps 1291: break;
1.89 kristaps 1292: /* FIXME: give this a dummy value. */
1.133 kristaps 1293: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS);
1.1 kristaps 1294: break;
1.89 kristaps 1295: case (LIST_hang):
1.1 kristaps 1296: /* FALLTHROUGH */
1.89 kristaps 1297: case (LIST_ohang):
1.1 kristaps 1298: /* FALLTHROUGH */
1.89 kristaps 1299: case (LIST_inset):
1.1 kristaps 1300: /* FALLTHROUGH */
1.89 kristaps 1301: case (LIST_diag):
1.1 kristaps 1302: if (NULL == mdoc->last->head->child)
1.133 kristaps 1303: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOARGS);
1.1 kristaps 1304: break;
1.89 kristaps 1305: case (LIST_bullet):
1.1 kristaps 1306: /* FALLTHROUGH */
1.89 kristaps 1307: case (LIST_dash):
1.1 kristaps 1308: /* FALLTHROUGH */
1.89 kristaps 1309: case (LIST_enum):
1.1 kristaps 1310: /* FALLTHROUGH */
1.89 kristaps 1311: case (LIST_hyphen):
1.108 schwarze 1312: if (NULL == mdoc->last->body->child)
1.133 kristaps 1313: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY);
1.1 kristaps 1314: /* FALLTHROUGH */
1.89 kristaps 1315: case (LIST_item):
1.1 kristaps 1316: if (mdoc->last->head->child)
1.133 kristaps 1317: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_ARGSLOST);
1.1 kristaps 1318: break;
1.89 kristaps 1319: case (LIST_column):
1.109 kristaps 1320: cols = (int)n->data.Bl->ncols;
1.89 kristaps 1321:
1.87 kristaps 1322: assert(NULL == mdoc->last->head->child);
1.89 kristaps 1323:
1.87 kristaps 1324: if (NULL == mdoc->last->body->child)
1.133 kristaps 1325: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NOBODY);
1.87 kristaps 1326:
1.89 kristaps 1327: for (i = 0, c = mdoc->last->child; c; c = c->next)
1.87 kristaps 1328: if (MDOC_BODY == c->type)
1329: i++;
1.38 kristaps 1330:
1.89 kristaps 1331: if (i < cols)
1332: er = MANDOCERR_ARGCOUNT;
1333: else if (i == cols || i == cols + 1)
1.38 kristaps 1334: break;
1.89 kristaps 1335: else
1336: er = MANDOCERR_SYNTARGCOUNT;
1.38 kristaps 1337:
1.89 kristaps 1338: rc = mdoc_vmsg(mdoc, er,
1.79 kristaps 1339: mdoc->last->line, mdoc->last->pos,
1340: "columns == %d (have %d)", cols, i);
1.89 kristaps 1341: return(rc);
1.1 kristaps 1342: default:
1343: break;
1344: }
1345:
1346: return(1);
1347: }
1348:
1.131 kristaps 1349: static int
1350: post_bl_block(POST_ARGS)
1351: {
1352: struct mdoc_node *n;
1353:
1354: /*
1355: * These are fairly complicated, so we've broken them into two
1356: * functions. post_bl_block_tag() is called when a -tag is
1357: * specified, but no -width (it must be guessed). The second
1358: * when a -width is specified (macro indicators must be
1359: * rewritten into real lengths).
1360: */
1361:
1362: n = mdoc->last;
1363:
1364: if (LIST_tag == n->data.Bl->type &&
1365: NULL == n->data.Bl->width) {
1366: if ( ! post_bl_block_tag(mdoc))
1367: return(0);
1368: } else if (NULL != n->data.Bl->width) {
1369: if ( ! post_bl_block_width(mdoc))
1370: return(0);
1371: } else
1372: return(1);
1373:
1374: assert(n->data.Bl->width);
1375: return(1);
1376: }
1377:
1378: static int
1379: post_bl_block_width(POST_ARGS)
1380: {
1381: size_t width;
1382: int i;
1383: enum mdoct tok;
1384: struct mdoc_node *n;
1385: char buf[NUMSIZ];
1386:
1387: n = mdoc->last;
1388:
1389: /*
1390: * Calculate the real width of a list from the -width string,
1391: * which may contain a macro (with a known default width), a
1392: * literal string, or a scaling width.
1393: *
1394: * If the value to -width is a macro, then we re-write it to be
1395: * the macro's width as set in share/tmac/mdoc/doc-common.
1396: */
1397:
1398: if (0 == strcmp(n->data.Bl->width, "Ds"))
1399: width = 6;
1400: else if (MDOC_MAX == (tok = mdoc_hash_find(n->data.Bl->width)))
1401: return(1);
1.133 kristaps 1402: else if (0 == (width = mdoc_macro2len(tok))) {
1403: mdoc_nmsg(mdoc, n, MANDOCERR_BADWIDTH);
1404: return(1);
1405: }
1.131 kristaps 1406:
1407: /* The value already exists: free and reallocate it. */
1408:
1409: assert(n->args);
1410:
1411: for (i = 0; i < (int)n->args->argc; i++)
1412: if (MDOC_Width == n->args->argv[i].arg)
1413: break;
1414:
1415: assert(i < (int)n->args->argc);
1416:
1417: snprintf(buf, NUMSIZ, "%zun", width);
1418: free(n->args->argv[i].value[0]);
1419: n->args->argv[i].value[0] = mandoc_strdup(buf);
1420:
1421: /* Set our width! */
1422: n->data.Bl->width = n->args->argv[i].value[0];
1423: return(1);
1424: }
1425:
1426: static int
1427: post_bl_block_tag(POST_ARGS)
1428: {
1429: struct mdoc_node *n, *nn;
1430: size_t sz, ssz;
1431: int i;
1432: char buf[NUMSIZ];
1433:
1434: /*
1435: * Calculate the -width for a `Bl -tag' list if it hasn't been
1436: * provided. Uses the first head macro. NOTE AGAIN: this is
1437: * ONLY if the -width argument has NOT been provided. See
1438: * post_bl_block_width() for converting the -width string.
1439: */
1440:
1441: sz = 10;
1442: n = mdoc->last;
1443:
1444: for (nn = n->body->child; nn; nn = nn->next) {
1445: if (MDOC_It != nn->tok)
1446: continue;
1447:
1448: assert(MDOC_BLOCK == nn->type);
1449: nn = nn->head->child;
1450:
1.138 kristaps 1451: if (nn == NULL)
1.131 kristaps 1452: break;
1453:
1454: if (MDOC_TEXT == nn->type) {
1455: sz = strlen(nn->string) + 1;
1456: break;
1457: }
1458:
1459: if (0 != (ssz = mdoc_macro2len(nn->tok)))
1460: sz = ssz;
1461:
1462: break;
1463: }
1464:
1465: /* Defaults to ten ens. */
1466:
1467: snprintf(buf, NUMSIZ, "%zun", sz);
1468:
1469: /*
1470: * We have to dynamically add this to the macro's argument list.
1471: * We're guaranteed that a MDOC_Width doesn't already exist.
1472: */
1473:
1474: assert(n->args);
1475: i = (int)(n->args->argc)++;
1476:
1477: n->args->argv = mandoc_realloc(n->args->argv,
1478: n->args->argc * sizeof(struct mdoc_argv));
1479:
1480: n->args->argv[i].arg = MDOC_Width;
1481: n->args->argv[i].line = n->line;
1482: n->args->argv[i].pos = n->pos;
1483: n->args->argv[i].sz = 1;
1484: n->args->argv[i].value = mandoc_malloc(sizeof(char *));
1485: n->args->argv[i].value[0] = mandoc_strdup(buf);
1486:
1487: /* Set our width! */
1488: n->data.Bl->width = n->args->argv[i].value[0];
1489: return(1);
1490: }
1491:
1.1 kristaps 1492:
1493: static int
1.14 kristaps 1494: post_bl_head(POST_ARGS)
1495: {
1.130 kristaps 1496: struct mdoc_node *np, *nn, *nnp;
1497: int i, j;
1.14 kristaps 1498:
1.130 kristaps 1499: if (LIST_column != mdoc->last->data.Bl->type)
1500: /* FIXME: this should be ERROR class... */
1501: return(hwarn_eq0(mdoc));
1.14 kristaps 1502:
1.130 kristaps 1503: /*
1504: * Convert old-style lists, where the column width specifiers
1505: * trail as macro parameters, to the new-style ("normal-form")
1506: * lists where they're argument values following -column.
1507: */
1508:
1509: /* First, disallow both types and allow normal-form. */
1510:
1511: /*
1512: * TODO: technically, we can accept both and just merge the two
1513: * lists, but I'll leave that for another day.
1514: */
1515:
1516: if (mdoc->last->data.Bl->ncols && mdoc->last->nchild) {
1517: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_COLUMNS);
1518: return(0);
1519: } else if (NULL == mdoc->last->child)
1.90 kristaps 1520: return(1);
1.130 kristaps 1521:
1522: np = mdoc->last->parent;
1523: assert(np->args);
1524:
1525: for (j = 0; j < (int)np->args->argc; j++)
1526: if (MDOC_Column == np->args->argv[j].arg)
1527: break;
1528:
1529: assert(j < (int)np->args->argc);
1530: assert(0 == np->args->argv[j].sz);
1531:
1532: /*
1533: * Accomodate for new-style groff column syntax. Shuffle the
1534: * child nodes, all of which must be TEXT, as arguments for the
1535: * column field. Then, delete the head children.
1536: */
1537:
1538: np->args->argv[j].sz = (size_t)mdoc->last->nchild;
1539: np->args->argv[j].value = mandoc_malloc
1540: ((size_t)mdoc->last->nchild * sizeof(char *));
1541:
1542: mdoc->last->data.Bl->ncols = np->args->argv[j].sz;
1543: mdoc->last->data.Bl->cols = (const char **)np->args->argv[j].value;
1544:
1545: for (i = 0, nn = mdoc->last->child; nn; i++) {
1546: np->args->argv[j].value[i] = nn->string;
1547: nn->string = NULL;
1548: nnp = nn;
1549: nn = nn->next;
1550: mdoc_node_delete(NULL, nnp);
1.65 kristaps 1551: }
1.14 kristaps 1552:
1.130 kristaps 1553: mdoc->last->nchild = 0;
1554: mdoc->last->child = NULL;
1555:
1556: return(1);
1.14 kristaps 1557: }
1558:
1559: static int
1.1 kristaps 1560: post_bl(POST_ARGS)
1561: {
1562: struct mdoc_node *n;
1563:
1.14 kristaps 1564: if (MDOC_HEAD == mdoc->last->type)
1565: return(post_bl_head(mdoc));
1.131 kristaps 1566: if (MDOC_BLOCK == mdoc->last->type)
1567: return(post_bl_block(mdoc));
1.1 kristaps 1568: if (MDOC_BODY != mdoc->last->type)
1569: return(1);
1570:
1571: for (n = mdoc->last->child; n; n = n->next) {
1.141 kristaps 1572: switch (n->tok) {
1573: case (MDOC_It):
1.55 kristaps 1574: continue;
1.141 kristaps 1575: case (MDOC_Sm):
1576: /* FALLTHROUGH */
1577: case (MDOC_Pp):
1578: mdoc_nmsg(mdoc, n, MANDOCERR_CHILD);
1.55 kristaps 1579: continue;
1.141 kristaps 1580: default:
1581: break;
1582: }
1583:
1.79 kristaps 1584: mdoc_nmsg(mdoc, n, MANDOCERR_SYNTCHILD);
1585: return(0);
1.1 kristaps 1586: }
1587:
1588: return(1);
1589: }
1590:
1591: static int
1592: ebool(struct mdoc *mdoc)
1593: {
1594:
1.133 kristaps 1595: if (NULL == mdoc->last->child)
1596: return(1);
1597:
1598: assert(MDOC_TEXT == mdoc->last->child->type);
1.1 kristaps 1599:
1.133 kristaps 1600: if (0 == strcmp(mdoc->last->child->string, "on"))
1.1 kristaps 1601: return(1);
1.133 kristaps 1602: if (0 == strcmp(mdoc->last->child->string, "off"))
1603: return(1);
1604:
1605: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADBOOL);
1606: return(1);
1.1 kristaps 1607: }
1608:
1609: static int
1610: post_root(POST_ARGS)
1611: {
1.133 kristaps 1612: int erc;
1613: struct mdoc_node *n;
1.1 kristaps 1614:
1.133 kristaps 1615: erc = 0;
1616:
1617: /* Check that we have a finished prologue. */
1618:
1619: if ( ! (MDOC_PBODY & mdoc->flags)) {
1620: erc++;
1.79 kristaps 1621: mdoc_nmsg(mdoc, mdoc->first, MANDOCERR_NODOCPROLOG);
1.133 kristaps 1622: }
1623:
1624: n = mdoc->first;
1625: assert(n);
1626:
1627: /* Check that we begin with a proper `Sh'. */
1628:
1629: if (NULL == n->child) {
1630: erc++;
1631: mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY);
1632: } else if (MDOC_BLOCK != n->child->type ||
1633: MDOC_Sh != n->child->tok) {
1634: erc++;
1635: /* Can this be lifted? See rxdebug.1 for example. */
1636: mdoc_nmsg(mdoc, n, MANDOCERR_NODOCBODY);
1637: }
1.1 kristaps 1638:
1.133 kristaps 1639: return(erc ? 0 : 1);
1.1 kristaps 1640: }
1641:
1642: static int
1643: post_st(POST_ARGS)
1644: {
1.128 kristaps 1645: const char *p;
1646:
1647: assert(MDOC_TEXT == mdoc->last->child->type);
1648:
1649: p = mdoc_a2st(mdoc->last->child->string);
1650:
1651: if (p == NULL) {
1652: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADSTANDARD);
1653: mdoc_node_delete(mdoc, mdoc->last);
1654: } else {
1655: free(mdoc->last->child->string);
1656: mdoc->last->child->string = mandoc_strdup(p);
1657: }
1.1 kristaps 1658:
1.128 kristaps 1659: return(1);
1.1 kristaps 1660: }
1661:
1662: static int
1.43 kristaps 1663: post_rs(POST_ARGS)
1664: {
1.122 kristaps 1665: struct mdoc_node *nn, *next, *prev;
1666: int i, j;
1.43 kristaps 1667:
1668: if (MDOC_BODY != mdoc->last->type)
1669: return(1);
1670:
1.122 kristaps 1671: /*
1672: * Make sure only certain types of nodes are allowed within the
1673: * the `Rs' body. Delete offending nodes and raise a warning.
1674: * Do this before re-ordering for the sake of clarity.
1675: */
1676:
1677: next = NULL;
1678: for (nn = mdoc->last->child; nn; nn = next) {
1679: for (i = 0; i < RSORD_MAX; i++)
1680: if (nn->tok == rsord[i])
1681: break;
1682:
1683: if (i < RSORD_MAX) {
1684: next = nn->next;
1685: continue;
1686: }
1687:
1688: next = nn->next;
1689: mdoc_nmsg(mdoc, nn, MANDOCERR_CHILD);
1690: mdoc_node_delete(mdoc, nn);
1691: }
1692:
1693: /*
1694: * The full `Rs' block needs special handling to order the
1695: * sub-elements according to `rsord'. Pick through each element
1696: * and correctly order it. This is a insertion sort.
1697: */
1698:
1699: next = NULL;
1700: for (nn = mdoc->last->child->next; nn; nn = next) {
1701: /* Determine order of `nn'. */
1702: for (i = 0; i < RSORD_MAX; i++)
1703: if (rsord[i] == nn->tok)
1704: break;
1705:
1706: /*
1707: * Remove `nn' from the chain. This somewhat
1708: * repeats mdoc_node_unlink(), but since we're
1709: * just re-ordering, there's no need for the
1710: * full unlink process.
1711: */
1712:
1713: if (NULL != (next = nn->next))
1714: next->prev = nn->prev;
1715:
1716: if (NULL != (prev = nn->prev))
1717: prev->next = nn->next;
1718:
1719: nn->prev = nn->next = NULL;
1720:
1721: /*
1722: * Scan back until we reach a node that's
1723: * ordered before `nn'.
1724: */
1725:
1726: for ( ; prev ; prev = prev->prev) {
1727: /* Determine order of `prev'. */
1728: for (j = 0; j < RSORD_MAX; j++)
1729: if (rsord[j] == prev->tok)
1730: break;
1731:
1732: if (j <= i)
1733: break;
1734: }
1735:
1736: /*
1737: * Set `nn' back into its correct place in front
1738: * of the `prev' node.
1739: */
1740:
1741: nn->prev = prev;
1742:
1743: if (prev) {
1744: if (prev->next)
1745: prev->next->prev = nn;
1746: nn->next = prev->next;
1747: prev->next = nn;
1748: } else {
1749: mdoc->last->child->prev = nn;
1750: nn->next = mdoc->last->child;
1751: mdoc->last->child = nn;
1.43 kristaps 1752: }
1.122 kristaps 1753: }
1.43 kristaps 1754:
1755: return(1);
1756: }
1757:
1758: static int
1.1 kristaps 1759: post_sh(POST_ARGS)
1760: {
1761:
1762: if (MDOC_HEAD == mdoc->last->type)
1763: return(post_sh_head(mdoc));
1764: if (MDOC_BODY == mdoc->last->type)
1765: return(post_sh_body(mdoc));
1766:
1767: return(1);
1768: }
1769:
1770: static int
1771: post_sh_body(POST_ARGS)
1772: {
1773: struct mdoc_node *n;
1774:
1.29 kristaps 1775: if (SEC_NAME != mdoc->lastsec)
1.1 kristaps 1776: return(1);
1777:
1778: /*
1779: * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1780: * macros (can have multiple `Nm' and one `Nd'). Note that the
1781: * children of the BODY declaration can also be "text".
1782: */
1783:
1.133 kristaps 1784: if (NULL == (n = mdoc->last->child)) {
1785: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1786: return(1);
1787: }
1.1 kristaps 1788:
1789: for ( ; n && n->next; n = n->next) {
1790: if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1791: continue;
1.28 kristaps 1792: if (MDOC_TEXT == n->type)
1793: continue;
1.133 kristaps 1794: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1.1 kristaps 1795: }
1796:
1.41 kristaps 1797: assert(n);
1.27 kristaps 1798: if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1.1 kristaps 1799: return(1);
1.133 kristaps 1800:
1801: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_BADNAMESEC);
1802: return(1);
1.1 kristaps 1803: }
1804:
1805: static int
1806: post_sh_head(POST_ARGS)
1807: {
1.132 kristaps 1808: char buf[BUFSIZ];
1809: enum mdoc_sec sec;
1.1 kristaps 1810:
1811: /*
1812: * Process a new section. Sections are either "named" or
1.125 kristaps 1813: * "custom". Custom sections are user-defined, while named ones
1814: * follow a conventional order and may only appear in certain
1815: * manual sections.
1.1 kristaps 1816: */
1817:
1.132 kristaps 1818: if ( ! concat(mdoc, buf, mdoc->last->child, BUFSIZ))
1819: return(0);
1.1 kristaps 1820:
1.72 kristaps 1821: sec = mdoc_str2sec(buf);
1.1 kristaps 1822:
1.125 kristaps 1823: /* The NAME should be first. */
1.1 kristaps 1824:
1.72 kristaps 1825: if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1.125 kristaps 1826: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_NAMESECFIRST);
1827:
1828: /* The SYNOPSIS gets special attention in other areas. */
1829:
1830: if (SEC_SYNOPSIS == sec)
1831: mdoc->flags |= MDOC_SYNOPSIS;
1832: else
1833: mdoc->flags &= ~MDOC_SYNOPSIS;
1834:
1835: /* Mark our last section. */
1836:
1837: mdoc->lastsec = sec;
1838:
1839: /* We don't care about custom sections after this. */
1.72 kristaps 1840:
1.1 kristaps 1841: if (SEC_CUSTOM == sec)
1842: return(1);
1.72 kristaps 1843:
1.125 kristaps 1844: /*
1845: * Check whether our non-custom section is being repeated or is
1846: * out of order.
1847: */
1848:
1.1 kristaps 1849: if (sec == mdoc->lastnamed)
1.125 kristaps 1850: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECREP);
1.72 kristaps 1851:
1.1 kristaps 1852: if (sec < mdoc->lastnamed)
1.125 kristaps 1853: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECOOO);
1854:
1855: /* Mark the last named section. */
1856:
1857: mdoc->lastnamed = sec;
1858:
1859: /* Check particular section/manual conventions. */
1.1 kristaps 1860:
1.125 kristaps 1861: assert(mdoc->meta.msec);
1.1 kristaps 1862:
1863: switch (sec) {
1.125 kristaps 1864: case (SEC_RETURN_VALUES):
1865: /* FALLTHROUGH */
1866: case (SEC_ERRORS):
1867: /* FALLTHROUGH */
1.1 kristaps 1868: case (SEC_LIBRARY):
1.78 kristaps 1869: if (*mdoc->meta.msec == '2')
1870: break;
1871: if (*mdoc->meta.msec == '3')
1872: break;
1873: if (*mdoc->meta.msec == '9')
1.1 kristaps 1874: break;
1.125 kristaps 1875: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_SECMSEC);
1876: break;
1.1 kristaps 1877: default:
1878: break;
1879: }
1.140 kristaps 1880:
1881: return(1);
1882: }
1883:
1884: static int
1885: post_ignpar(POST_ARGS)
1886: {
1887: struct mdoc_node *np;
1888:
1889: if (MDOC_BODY != mdoc->last->type)
1890: return(1);
1891:
1.143 kristaps 1892: if (NULL != (np = mdoc->last->child))
1.140 kristaps 1893: if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
1894: mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR);
1895: mdoc_node_delete(mdoc, np);
1896: }
1897:
1898: if (NULL != (np = mdoc->last->last))
1899: if (MDOC_Pp == np->tok || MDOC_Lp == np->tok) {
1900: mdoc_nmsg(mdoc, np, MANDOCERR_IGNPAR);
1901: mdoc_node_delete(mdoc, np);
1902: }
1.1 kristaps 1903:
1.117 kristaps 1904: return(1);
1905: }
1906:
1907: static int
1.124 kristaps 1908: pre_par(PRE_ARGS)
1.117 kristaps 1909: {
1910:
1.118 kristaps 1911: if (NULL == mdoc->last)
1912: return(1);
1.141 kristaps 1913: if (MDOC_ELEM != n->type && MDOC_BLOCK != n->type)
1914: return(1);
1.118 kristaps 1915:
1.124 kristaps 1916: /*
1917: * Don't allow prior `Lp' or `Pp' prior to a paragraph-type
1918: * block: `Lp', `Pp', or non-compact `Bd' or `Bl'.
1919: */
1.118 kristaps 1920:
1921: if (MDOC_Pp != mdoc->last->tok && MDOC_Lp != mdoc->last->tok)
1.117 kristaps 1922: return(1);
1923: if (MDOC_Bl == n->tok && n->data.Bl->comp)
1924: return(1);
1925: if (MDOC_Bd == n->tok && n->data.Bd->comp)
1.141 kristaps 1926: return(1);
1927: if (MDOC_It == n->tok && n->parent->data.Bl->comp)
1.117 kristaps 1928: return(1);
1929:
1930: mdoc_nmsg(mdoc, mdoc->last, MANDOCERR_IGNPAR);
1931: mdoc_node_delete(mdoc, mdoc->last);
1.128 kristaps 1932: return(1);
1933: }
1934:
1935: static int
1936: pre_literal(PRE_ARGS)
1937: {
1938:
1939: if (MDOC_BODY != n->type)
1940: return(1);
1941:
1942: /*
1943: * The `Dl' (note "el" not "one") and `Bd -literal' and `Bd
1944: * -unfilled' macros set MDOC_LITERAL on entrance to the body.
1945: */
1946:
1947: switch (n->tok) {
1948: case (MDOC_Dl):
1949: mdoc->flags |= MDOC_LITERAL;
1950: break;
1951: case (MDOC_Bd):
1952: assert(n->data.Bd);
1953: if (DISP_literal == n->data.Bd->type)
1954: mdoc->flags |= MDOC_LITERAL;
1955: if (DISP_unfilled == n->data.Bd->type)
1956: mdoc->flags |= MDOC_LITERAL;
1957: break;
1958: default:
1959: abort();
1960: /* NOTREACHED */
1961: }
1962:
1.1 kristaps 1963: return(1);
1964: }
1.132 kristaps 1965:
1966: static int
1967: post_dd(POST_ARGS)
1968: {
1.135 kristaps 1969: char buf[DATESIZE];
1.132 kristaps 1970: struct mdoc_node *n;
1971:
1972: n = mdoc->last;
1973:
1974: if (NULL == n->child) {
1975: mdoc->meta.date = time(NULL);
1.133 kristaps 1976: return(1);
1.132 kristaps 1977: }
1978:
1.135 kristaps 1979: if ( ! concat(mdoc, buf, n->child, DATESIZE))
1.132 kristaps 1980: return(0);
1981:
1982: mdoc->meta.date = mandoc_a2time
1983: (MTIME_MDOCDATE | MTIME_CANONICAL, buf);
1984:
1985: if (0 == mdoc->meta.date) {
1.133 kristaps 1986: mdoc_nmsg(mdoc, n, MANDOCERR_BADDATE);
1.132 kristaps 1987: mdoc->meta.date = time(NULL);
1988: }
1989:
1990: return(1);
1991: }
1992:
1993: static int
1994: post_dt(POST_ARGS)
1995: {
1996: struct mdoc_node *nn, *n;
1997: const char *cp;
1998: char *p;
1999:
2000: n = mdoc->last;
2001:
2002: if (mdoc->meta.title)
2003: free(mdoc->meta.title);
2004: if (mdoc->meta.vol)
2005: free(mdoc->meta.vol);
2006: if (mdoc->meta.arch)
2007: free(mdoc->meta.arch);
2008:
2009: mdoc->meta.title = mdoc->meta.vol = mdoc->meta.arch = NULL;
2010:
2011: /* First make all characters uppercase. */
2012:
2013: if (NULL != (nn = n->child))
2014: for (p = nn->string; *p; p++) {
2015: if (toupper((u_char)*p) == *p)
2016: continue;
1.133 kristaps 2017:
2018: /*
2019: * FIXME: don't be lazy: have this make all
2020: * characters be uppercase and just warn once.
2021: */
2022: mdoc_nmsg(mdoc, nn, MANDOCERR_UPPERCASE);
1.132 kristaps 2023: break;
2024: }
2025:
2026: /* Handles: `.Dt'
2027: * --> title = unknown, volume = local, msec = 0, arch = NULL
2028: */
2029:
2030: if (NULL == (nn = n->child)) {
2031: /* XXX: make these macro values. */
2032: /* FIXME: warn about missing values. */
2033: mdoc->meta.title = mandoc_strdup("UNKNOWN");
2034: mdoc->meta.vol = mandoc_strdup("LOCAL");
2035: mdoc->meta.msec = mandoc_strdup("1");
2036: return(1);
2037: }
2038:
2039: /* Handles: `.Dt TITLE'
2040: * --> title = TITLE, volume = local, msec = 0, arch = NULL
2041: */
2042:
2043: mdoc->meta.title = mandoc_strdup
2044: ('\0' == nn->string[0] ? "UNKNOWN" : nn->string);
2045:
2046: if (NULL == (nn = nn->next)) {
2047: /* FIXME: warn about missing msec. */
2048: /* XXX: make this a macro value. */
2049: mdoc->meta.vol = mandoc_strdup("LOCAL");
2050: mdoc->meta.msec = mandoc_strdup("1");
2051: return(1);
2052: }
2053:
2054: /* Handles: `.Dt TITLE SEC'
2055: * --> title = TITLE, volume = SEC is msec ?
2056: * format(msec) : SEC,
2057: * msec = SEC is msec ? atoi(msec) : 0,
2058: * arch = NULL
2059: */
2060:
2061: cp = mdoc_a2msec(nn->string);
2062: if (cp) {
2063: mdoc->meta.vol = mandoc_strdup(cp);
2064: mdoc->meta.msec = mandoc_strdup(nn->string);
1.133 kristaps 2065: } else {
2066: mdoc_nmsg(mdoc, n, MANDOCERR_BADMSEC);
1.132 kristaps 2067: mdoc->meta.vol = mandoc_strdup(nn->string);
2068: mdoc->meta.msec = mandoc_strdup(nn->string);
1.133 kristaps 2069: }
1.132 kristaps 2070:
2071: if (NULL == (nn = nn->next))
2072: return(1);
2073:
2074: /* Handles: `.Dt TITLE SEC VOL'
2075: * --> title = TITLE, volume = VOL is vol ?
2076: * format(VOL) :
2077: * VOL is arch ? format(arch) :
2078: * VOL
2079: */
2080:
2081: cp = mdoc_a2vol(nn->string);
2082: if (cp) {
2083: free(mdoc->meta.vol);
2084: mdoc->meta.vol = mandoc_strdup(cp);
2085: } else {
2086: /* FIXME: warn about bad arch. */
2087: cp = mdoc_a2arch(nn->string);
2088: if (NULL == cp) {
2089: free(mdoc->meta.vol);
2090: mdoc->meta.vol = mandoc_strdup(nn->string);
2091: } else
2092: mdoc->meta.arch = mandoc_strdup(cp);
2093: }
2094:
2095: /* Ignore any subsequent parameters... */
2096: /* FIXME: warn about subsequent parameters. */
2097:
2098: return(1);
2099: }
2100:
2101: static int
2102: post_prol(POST_ARGS)
2103: {
2104: /*
2105: * Remove prologue macros from the document after they're
2106: * processed. The final document uses mdoc_meta for these
2107: * values and discards the originals.
2108: */
2109:
2110: mdoc_node_delete(mdoc, mdoc->last);
2111: if (mdoc->meta.title && mdoc->meta.date && mdoc->meta.os)
2112: mdoc->flags |= MDOC_PBODY;
2113:
2114: return(1);
2115: }
2116:
2117: static int
2118: post_os(POST_ARGS)
2119: {
2120: struct mdoc_node *n;
2121: char buf[BUFSIZ];
2122: #ifndef OSNAME
2123: struct utsname utsname;
2124: #endif
2125:
2126: n = mdoc->last;
2127:
2128: /*
2129: * Set the operating system by way of the `Os' macro. Note that
2130: * if an argument isn't provided and -DOSNAME="\"foo\"" is
2131: * provided during compilation, this value will be used instead
2132: * of filling in "sysname release" from uname().
2133: */
2134:
2135: if (mdoc->meta.os)
2136: free(mdoc->meta.os);
2137:
2138: if ( ! concat(mdoc, buf, n->child, BUFSIZ))
2139: return(0);
2140:
2141: /* XXX: yes, these can all be dynamically-adjusted buffers, but
2142: * it's really not worth the extra hackery.
2143: */
2144:
2145: if ('\0' == buf[0]) {
2146: #ifdef OSNAME
2147: if (strlcat(buf, OSNAME, BUFSIZ) >= BUFSIZ) {
2148: mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2149: return(0);
2150: }
2151: #else /*!OSNAME */
1.136 kristaps 2152: if (uname(&utsname)) {
2153: mdoc_nmsg(mdoc, n, MANDOCERR_UNAME);
2154: mdoc->meta.os = mandoc_strdup("UNKNOWN");
2155: return(post_prol(mdoc));
2156: }
1.132 kristaps 2157:
2158: if (strlcat(buf, utsname.sysname, BUFSIZ) >= BUFSIZ) {
2159: mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2160: return(0);
2161: }
1.136 kristaps 2162: if (strlcat(buf, " ", BUFSIZ) >= BUFSIZ) {
1.132 kristaps 2163: mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2164: return(0);
2165: }
2166: if (strlcat(buf, utsname.release, BUFSIZ) >= BUFSIZ) {
2167: mdoc_nmsg(mdoc, n, MANDOCERR_MEM);
2168: return(0);
2169: }
2170: #endif /*!OSNAME*/
2171: }
2172:
2173: mdoc->meta.os = mandoc_strdup(buf);
2174: return(1);
2175: }
2176:
2177: static int
2178: post_std(POST_ARGS)
2179: {
2180: struct mdoc_node *nn, *n;
2181:
2182: n = mdoc->last;
2183:
2184: /*
2185: * Macros accepting `-std' as an argument have the name of the
2186: * current document (`Nm') filled in as the argument if it's not
2187: * provided.
2188: */
2189:
2190: if (n->child)
2191: return(1);
1.133 kristaps 2192:
1.132 kristaps 2193: if (NULL == mdoc->meta.name)
2194: return(1);
2195:
2196: nn = n;
2197: mdoc->next = MDOC_NEXT_CHILD;
2198:
2199: if ( ! mdoc_word_alloc(mdoc, n->line, n->pos, mdoc->meta.name))
2200: return(0);
1.133 kristaps 2201:
1.132 kristaps 2202: mdoc->last = nn;
2203: return(1);
2204: }
2205:
2206: static int
2207: concat(struct mdoc *m, char *p, const struct mdoc_node *n, size_t sz)
2208: {
2209:
2210: p[0] = '\0';
2211:
2212: /*
2213: * Concatenate sibling nodes together. All siblings must be of
2214: * type MDOC_TEXT or an assertion is raised. Concatenation is
1.133 kristaps 2215: * separated by a single whitespace. Returns 0 on fatal (string
2216: * overrun) error.
1.132 kristaps 2217: */
2218:
2219: for ( ; n; n = n->next) {
2220: assert(MDOC_TEXT == n->type);
2221:
2222: if (strlcat(p, n->string, sz) >= sz) {
2223: mdoc_nmsg(m, n, MANDOCERR_MEM);
2224: return(0);
2225: }
2226:
2227: if (NULL == n->next)
2228: continue;
2229:
2230: if (strlcat(p, " ", sz) >= sz) {
2231: mdoc_nmsg(m, n, MANDOCERR_MEM);
2232: return(0);
2233: }
2234: }
2235:
2236: return(1);
2237: }
2238:
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mdoc_validate.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc