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