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