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