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