]> git.cameronkatri.com Git - mandoc.git/blob - mdoc_validate.c
git.ckatri.com / mandoc.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
history | raw | HEAD
Scaling factor made floating point (as per groff.7) and, e.g., gnu/usr.bin/cvs/man...
[mandoc.git] / mdoc_validate.c
1 /* $Id: mdoc_validate.c,v 1.44 2009/09/24 15:08:41 kristaps Exp $ */
2 /*
3 * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
4 *
5 * Permission to use, copy, modify, and distribute this software for any
6 * purpose with or without fee is hereby granted, provided that the above
7 * copyright notice and this permission notice appear in all copies.
8 *
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.
16 */
17 #include <sys/types.h>
18
19 #include <assert.h>
20 #include <ctype.h>
21 #include <errno.h>
22 #include <limits.h>
23 #include <stdarg.h>
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "libmdoc.h"
28 #include "libmandoc.h"
29
30 /* FIXME: .Bl -diag can't have non-text children in HEAD. */
31 /* TODO: ignoring Pp (it's superfluous in some invocations). */
32
33 #define PRE_ARGS struct mdoc *mdoc, const struct mdoc_node *n
34 #define POST_ARGS struct mdoc *mdoc
35
36 typedef int (*v_pre)(PRE_ARGS);
37 typedef int (*v_post)(POST_ARGS);
38
39 struct valids {
40 v_pre *pre;
41 v_post *post;
42 };
43
44 static int check_parent(PRE_ARGS, int, enum mdoc_type);
45 static int check_msec(PRE_ARGS, ...);
46 static int check_sec(PRE_ARGS, ...);
47 static int check_stdarg(PRE_ARGS);
48 static int check_text(struct mdoc *, int, int, const char *);
49 static int check_argv(struct mdoc *,
50 const struct mdoc_node *,
51 const struct mdoc_argv *);
52 static int check_args(struct mdoc *,
53 const struct mdoc_node *);
54 static int err_child_lt(struct mdoc *, const char *, int);
55 static int warn_child_lt(struct mdoc *, const char *, int);
56 static int err_child_gt(struct mdoc *, const char *, int);
57 static int warn_child_gt(struct mdoc *, const char *, int);
58 static int err_child_eq(struct mdoc *, const char *, int);
59 static int warn_child_eq(struct mdoc *, const char *, int);
60 static int warn_print(struct mdoc *, int, int);
61 static int warn_count(struct mdoc *, const char *,
62 int, const char *, int);
63 static int err_count(struct mdoc *, const char *,
64 int, const char *, int);
65
66 #ifdef __linux__
67 extern size_t strlcat(char *, const char *, size_t);
68 #endif
69
70 static int berr_ge1(POST_ARGS);
71 static int bwarn_ge1(POST_ARGS);
72 static int ebool(POST_ARGS);
73 static int eerr_eq0(POST_ARGS);
74 static int eerr_eq1(POST_ARGS);
75 static int eerr_ge1(POST_ARGS);
76 static int eerr_le2(POST_ARGS);
77 static int ewarn_ge1(POST_ARGS);
78 static int herr_eq0(POST_ARGS);
79 static int herr_ge1(POST_ARGS);
80 static int hwarn_eq1(POST_ARGS);
81 static int hwarn_le1(POST_ARGS);
82
83 static int post_an(POST_ARGS);
84 static int post_at(POST_ARGS);
85 static int post_bf(POST_ARGS);
86 static int post_bl(POST_ARGS);
87 static int post_bl_head(POST_ARGS);
88 static int post_it(POST_ARGS);
89 static int post_lb(POST_ARGS);
90 static int post_nm(POST_ARGS);
91 static int post_root(POST_ARGS);
92 static int post_rs(POST_ARGS);
93 static int post_sh(POST_ARGS);
94 static int post_sh_body(POST_ARGS);
95 static int post_sh_head(POST_ARGS);
96 static int post_sp(POST_ARGS);
97 static int post_st(POST_ARGS);
98 static int pre_an(PRE_ARGS);
99 static int pre_bd(PRE_ARGS);
100 static int pre_bl(PRE_ARGS);
101 static int pre_cd(PRE_ARGS);
102 static int pre_dd(PRE_ARGS);
103 static int pre_display(PRE_ARGS);
104 static int pre_dt(PRE_ARGS);
105 static int pre_er(PRE_ARGS);
106 static int pre_ex(PRE_ARGS);
107 static int pre_fd(PRE_ARGS);
108 static int pre_it(PRE_ARGS);
109 static int pre_lb(PRE_ARGS);
110 static int pre_os(PRE_ARGS);
111 static int pre_rv(PRE_ARGS);
112 static int pre_sh(PRE_ARGS);
113 static int pre_ss(PRE_ARGS);
114
115 static v_post posts_an[] = { post_an, NULL };
116 static v_post posts_at[] = { post_at, NULL };
117 static v_post posts_bd[] = { herr_eq0, bwarn_ge1, NULL };
118 static v_post posts_bf[] = { hwarn_le1, post_bf, NULL };
119 static v_post posts_bl[] = { bwarn_ge1, post_bl, NULL };
120 static v_post posts_bool[] = { eerr_eq1, ebool, NULL };
121 static v_post posts_fo[] = { hwarn_eq1, bwarn_ge1, NULL };
122 static v_post posts_in[] = { eerr_eq1, NULL };
123 static v_post posts_it[] = { post_it, NULL };
124 static v_post posts_lb[] = { eerr_eq1, post_lb, NULL };
125 static v_post posts_nd[] = { berr_ge1, NULL };
126 static v_post posts_nm[] = { post_nm, NULL };
127 static v_post posts_notext[] = { eerr_eq0, NULL };
128 static v_post posts_pf[] = { eerr_eq1, NULL };
129 static v_post posts_rs[] = { berr_ge1, herr_eq0, post_rs, NULL };
130 static v_post posts_sh[] = { herr_ge1, bwarn_ge1, post_sh, NULL };
131 static v_post posts_sp[] = { post_sp, NULL };
132 static v_post posts_ss[] = { herr_ge1, NULL };
133 static v_post posts_st[] = { eerr_eq1, post_st, NULL };
134 static v_post posts_text[] = { eerr_ge1, NULL };
135 static v_post posts_wline[] = { bwarn_ge1, herr_eq0, NULL };
136 static v_post posts_wtext[] = { ewarn_ge1, NULL };
137 static v_post posts_xr[] = { eerr_ge1, eerr_le2, NULL };
138 static v_pre pres_an[] = { pre_an, NULL };
139 static v_pre pres_bd[] = { pre_display, pre_bd, NULL };
140 static v_pre pres_bl[] = { pre_bl, NULL };
141 static v_pre pres_cd[] = { pre_cd, NULL };
142 static v_pre pres_d1[] = { pre_display, NULL };
143 static v_pre pres_dd[] = { pre_dd, NULL };
144 static v_pre pres_dt[] = { pre_dt, NULL };
145 static v_pre pres_er[] = { pre_er, NULL };
146 static v_pre pres_ex[] = { pre_ex, NULL };
147 static v_pre pres_fd[] = { pre_fd, NULL };
148 static v_pre pres_it[] = { pre_it, NULL };
149 static v_pre pres_lb[] = { pre_lb, NULL };
150 static v_pre pres_os[] = { pre_os, NULL };
151 static v_pre pres_rv[] = { pre_rv, NULL };
152 static v_pre pres_sh[] = { pre_sh, NULL };
153 static v_pre pres_ss[] = { pre_ss, NULL };
154
155 const struct valids mdoc_valids[MDOC_MAX] = {
156 { NULL, NULL }, /* Ap */
157 { pres_dd, posts_text }, /* Dd */
158 { pres_dt, NULL }, /* Dt */
159 { pres_os, NULL }, /* Os */
160 { pres_sh, posts_sh }, /* Sh */
161 { pres_ss, posts_ss }, /* Ss */
162 { NULL, posts_notext }, /* Pp */
163 { pres_d1, posts_wline }, /* D1 */
164 { pres_d1, posts_wline }, /* Dl */
165 { pres_bd, posts_bd }, /* Bd */
166 { NULL, NULL }, /* Ed */
167 { pres_bl, posts_bl }, /* Bl */
168 { NULL, NULL }, /* El */
169 { pres_it, posts_it }, /* It */
170 { NULL, posts_text }, /* Ad */
171 { pres_an, posts_an }, /* An */
172 { NULL, NULL }, /* Ar */
173 { pres_cd, posts_text }, /* Cd */
174 { NULL, NULL }, /* Cm */
175 { NULL, NULL }, /* Dv */
176 { pres_er, posts_text }, /* Er */
177 { NULL, NULL }, /* Ev */
178 { pres_ex, NULL }, /* Ex */
179 { NULL, NULL }, /* Fa */
180 { pres_fd, posts_wtext }, /* Fd */
181 { NULL, NULL }, /* Fl */
182 { NULL, posts_text }, /* Fn */
183 { NULL, posts_wtext }, /* Ft */
184 { NULL, posts_text }, /* Ic */
185 { NULL, posts_in }, /* In */
186 { NULL, NULL }, /* Li */
187 { NULL, posts_nd }, /* Nd */
188 { NULL, posts_nm }, /* Nm */
189 { NULL, posts_wline }, /* Op */
190 { NULL, NULL }, /* Ot */
191 { NULL, NULL }, /* Pa */
192 { pres_rv, NULL }, /* Rv */
193 { NULL, posts_st }, /* St */
194 { NULL, NULL }, /* Va */
195 { NULL, posts_text }, /* Vt */
196 { NULL, posts_xr }, /* Xr */
197 { NULL, posts_text }, /* %A */
198 { NULL, posts_text }, /* %B */
199 { NULL, posts_text }, /* %D */
200 { NULL, posts_text }, /* %I */
201 { NULL, posts_text }, /* %J */
202 { NULL, posts_text }, /* %N */
203 { NULL, posts_text }, /* %O */
204 { NULL, posts_text }, /* %P */
205 { NULL, posts_text }, /* %R */
206 { NULL, posts_text }, /* %T */
207 { NULL, posts_text }, /* %V */
208 { NULL, NULL }, /* Ac */
209 { NULL, NULL }, /* Ao */
210 { NULL, posts_wline }, /* Aq */
211 { NULL, posts_at }, /* At */
212 { NULL, NULL }, /* Bc */
213 { NULL, posts_bf }, /* Bf */
214 { NULL, NULL }, /* Bo */
215 { NULL, posts_wline }, /* Bq */
216 { NULL, NULL }, /* Bsx */
217 { NULL, NULL }, /* Bx */
218 { NULL, posts_bool }, /* Db */
219 { NULL, NULL }, /* Dc */
220 { NULL, NULL }, /* Do */
221 { NULL, posts_wline }, /* Dq */
222 { NULL, NULL }, /* Ec */
223 { NULL, NULL }, /* Ef */
224 { NULL, NULL }, /* Em */
225 { NULL, NULL }, /* Eo */
226 { NULL, NULL }, /* Fx */
227 { NULL, posts_text }, /* Ms */
228 { NULL, posts_notext }, /* No */
229 { NULL, posts_notext }, /* Ns */
230 { NULL, NULL }, /* Nx */
231 { NULL, NULL }, /* Ox */
232 { NULL, NULL }, /* Pc */
233 { NULL, posts_pf }, /* Pf */
234 { NULL, NULL }, /* Po */
235 { NULL, posts_wline }, /* Pq */
236 { NULL, NULL }, /* Qc */
237 { NULL, posts_wline }, /* Ql */
238 { NULL, NULL }, /* Qo */
239 { NULL, posts_wline }, /* Qq */
240 { NULL, NULL }, /* Re */
241 { NULL, posts_rs }, /* Rs */
242 { NULL, NULL }, /* Sc */
243 { NULL, NULL }, /* So */
244 { NULL, posts_wline }, /* Sq */
245 { NULL, posts_bool }, /* Sm */
246 { NULL, posts_text }, /* Sx */
247 { NULL, posts_text }, /* Sy */
248 { NULL, posts_text }, /* Tn */
249 { NULL, NULL }, /* Ux */
250 { NULL, NULL }, /* Xc */
251 { NULL, NULL }, /* Xo */
252 { NULL, posts_fo }, /* Fo */
253 { NULL, NULL }, /* Fc */
254 { NULL, NULL }, /* Oo */
255 { NULL, NULL }, /* Oc */
256 { NULL, posts_wline }, /* Bk */
257 { NULL, NULL }, /* Ek */
258 { NULL, posts_notext }, /* Bt */
259 { NULL, NULL }, /* Hf */
260 { NULL, NULL }, /* Fr */
261 { NULL, posts_notext }, /* Ud */
262 { pres_lb, posts_lb }, /* Lb */
263 { NULL, posts_notext }, /* Lp */
264 { NULL, NULL }, /* Lk */
265 { NULL, posts_text }, /* Mt */
266 { NULL, posts_wline }, /* Brq */
267 { NULL, NULL }, /* Bro */
268 { NULL, NULL }, /* Brc */
269 { NULL, posts_text }, /* %C */
270 { NULL, NULL }, /* Es */
271 { NULL, NULL }, /* En */
272 { NULL, NULL }, /* Dx */
273 { NULL, posts_text }, /* %Q */
274 { NULL, posts_notext }, /* br */
275 { NULL, posts_sp }, /* sp */
276 };
277
278
279 int
280 mdoc_valid_pre(struct mdoc *mdoc, const struct mdoc_node *n)
281 {
282 v_pre *p;
283 int line, pos;
284 const char *tp;
285
286 if (MDOC_TEXT == n->type) {
287 tp = n->string;
288 line = n->line;
289 pos = n->pos;
290 return(check_text(mdoc, line, pos, tp));
291 }
292
293 if ( ! check_args(mdoc, n))
294 return(0);
295 if (NULL == mdoc_valids[n->tok].pre)
296 return(1);
297 for (p = mdoc_valids[n->tok].pre; *p; p++)
298 if ( ! (*p)(mdoc, n))
299 return(0);
300 return(1);
301 }
302
303
304 int
305 mdoc_valid_post(struct mdoc *mdoc)
306 {
307 v_post *p;
308
309 if (MDOC_VALID & mdoc->last->flags)
310 return(1);
311 mdoc->last->flags |= MDOC_VALID;
312
313 if (MDOC_TEXT == mdoc->last->type)
314 return(1);
315 if (MDOC_ROOT == mdoc->last->type)
316 return(post_root(mdoc));
317
318 if (NULL == mdoc_valids[mdoc->last->tok].post)
319 return(1);
320 for (p = mdoc_valids[mdoc->last->tok].post; *p; p++)
321 if ( ! (*p)(mdoc))
322 return(0);
323
324 return(1);
325 }
326
327
328 static int
329 warn_print(struct mdoc *m, int ln, int pos)
330 {
331
332 if (MDOC_IGN_CHARS & m->pflags)
333 return(mdoc_pwarn(m, ln, pos, EPRINT));
334 return(mdoc_perr(m, ln, pos, EPRINT));
335 }
336
337
338 static inline int
339 warn_count(struct mdoc *m, const char *k,
340 int want, const char *v, int has)
341 {
342
343 return(mdoc_vwarn(m, m->last->line, m->last->pos,
344 "suggests %s %s %d (has %d)", v, k, want, has));
345 }
346
347
348 static inline int
349 err_count(struct mdoc *m, const char *k,
350 int want, const char *v, int has)
351 {
352
353 return(mdoc_verr(m, m->last->line, m->last->pos,
354 "requires %s %s %d (has %d)", v, k, want, has));
355 }
356
357
358 /*
359 * Build these up with macros because they're basically the same check
360 * for different inequalities. Yes, this could be done with functions,
361 * but this is reasonable for now.
362 */
363
364 #define CHECK_CHILD_DEFN(lvl, name, ineq) \
365 static int \
366 lvl##_child_##name(struct mdoc *mdoc, const char *p, int sz) \
367 { \
368 if (mdoc->last->nchild ineq sz) \
369 return(1); \
370 return(lvl##_count(mdoc, #ineq, sz, p, mdoc->last->nchild)); \
371 }
372
373 #define CHECK_BODY_DEFN(name, lvl, func, num) \
374 static int \
375 b##lvl##_##name(POST_ARGS) \
376 { \
377 if (MDOC_BODY != mdoc->last->type) \
378 return(1); \
379 return(func(mdoc, "multi-line arguments", (num))); \
380 }
381
382 #define CHECK_ELEM_DEFN(name, lvl, func, num) \
383 static int \
384 e##lvl##_##name(POST_ARGS) \
385 { \
386 assert(MDOC_ELEM == mdoc->last->type); \
387 return(func(mdoc, "line arguments", (num))); \
388 }
389
390 #define CHECK_HEAD_DEFN(name, lvl, func, num) \
391 static int \
392 h##lvl##_##name(POST_ARGS) \
393 { \
394 if (MDOC_HEAD != mdoc->last->type) \
395 return(1); \
396 return(func(mdoc, "line arguments", (num))); \
397 }
398
399
400 CHECK_CHILD_DEFN(warn, gt, >) /* warn_child_gt() */
401 CHECK_CHILD_DEFN(err, gt, >) /* err_child_gt() */
402 CHECK_CHILD_DEFN(warn, eq, ==) /* warn_child_eq() */
403 CHECK_CHILD_DEFN(err, eq, ==) /* err_child_eq() */
404 CHECK_CHILD_DEFN(err, lt, <) /* err_child_lt() */
405 CHECK_CHILD_DEFN(warn, lt, <) /* warn_child_lt() */
406 CHECK_BODY_DEFN(ge1, warn, warn_child_gt, 0) /* bwarn_ge1() */
407 CHECK_BODY_DEFN(ge1, err, err_child_gt, 0) /* berr_ge1() */
408 CHECK_ELEM_DEFN(ge1, warn, warn_child_gt, 0) /* ewarn_gt1() */
409 CHECK_ELEM_DEFN(eq1, err, err_child_eq, 1) /* eerr_eq1() */
410 CHECK_ELEM_DEFN(le2, err, err_child_lt, 3) /* eerr_le2() */
411 CHECK_ELEM_DEFN(eq0, err, err_child_eq, 0) /* eerr_eq0() */
412 CHECK_ELEM_DEFN(ge1, err, err_child_gt, 0) /* eerr_ge1() */
413 CHECK_HEAD_DEFN(eq0, err, err_child_eq, 0) /* herr_eq0() */
414 CHECK_HEAD_DEFN(le1, warn, warn_child_lt, 2) /* hwarn_le1() */
415 CHECK_HEAD_DEFN(ge1, err, err_child_gt, 0) /* herr_ge1() */
416 CHECK_HEAD_DEFN(eq1, warn, warn_child_eq, 1) /* hwarn_eq1() */
417
418
419 static int
420 check_stdarg(PRE_ARGS)
421 {
422
423 if (n->args && 1 == n->args->argc)
424 if (MDOC_Std == n->args->argv[0].arg)
425 return(1);
426 return(mdoc_nwarn(mdoc, n, EARGVAL));
427 }
428
429
430 static int
431 check_sec(PRE_ARGS, ...)
432 {
433 enum mdoc_sec sec;
434 va_list ap;
435
436 va_start(ap, n);
437
438 for (;;) {
439 /* LINTED */
440 sec = (enum mdoc_sec)va_arg(ap, int);
441 if (SEC_CUSTOM == sec)
442 break;
443 if (sec != mdoc->lastsec)
444 continue;
445 va_end(ap);
446 return(1);
447 }
448
449 va_end(ap);
450 return(mdoc_nwarn(mdoc, n, EBADSEC));
451 }
452
453
454 static int
455 check_msec(PRE_ARGS, ...)
456 {
457 va_list ap;
458 int msec;
459
460 va_start(ap, n);
461 for (;;) {
462 /* LINTED */
463 if (0 == (msec = va_arg(ap, int)))
464 break;
465 if (msec != mdoc->meta.msec)
466 continue;
467 va_end(ap);
468 return(1);
469 }
470
471 va_end(ap);
472 return(mdoc_nwarn(mdoc, n, EBADMSEC));
473 }
474
475
476 static int
477 check_args(struct mdoc *m, const struct mdoc_node *n)
478 {
479 int i;
480
481 if (NULL == n->args)
482 return(1);
483
484 assert(n->args->argc);
485 for (i = 0; i < (int)n->args->argc; i++)
486 if ( ! check_argv(m, n, &n->args->argv[i]))
487 return(0);
488
489 return(1);
490 }
491
492
493 static int
494 check_argv(struct mdoc *m, const struct mdoc_node *n,
495 const struct mdoc_argv *v)
496 {
497 int i;
498
499 for (i = 0; i < (int)v->sz; i++)
500 if ( ! check_text(m, v->line, v->pos, v->value[i]))
501 return(0);
502
503 if (MDOC_Std == v->arg) {
504 /* `Nm' name must be set. */
505 if (v->sz || m->meta.name)
506 return(1);
507 return(mdoc_nerr(m, n, ENAME));
508 }
509
510 return(1);
511 }
512
513
514 static int
515 check_text(struct mdoc *mdoc, int line, int pos, const char *p)
516 {
517 int c;
518
519 for ( ; *p; p++, pos++) {
520 if ('\t' == *p) {
521 if ( ! (MDOC_LITERAL & mdoc->flags))
522 if ( ! warn_print(mdoc, line, pos))
523 return(0);
524 } else if ( ! isprint((u_char)*p))
525 if ( ! warn_print(mdoc, line, pos))
526 return(0);
527
528 if ('\\' != *p)
529 continue;
530
531 c = mandoc_special(p);
532 if (c) {
533 p += c - 1;
534 pos += c - 1;
535 continue;
536 }
537 if ( ! (MDOC_IGN_ESCAPE & mdoc->pflags))
538 return(mdoc_perr(mdoc, line, pos, EESCAPE));
539 if ( ! mdoc_pwarn(mdoc, line, pos, EESCAPE))
540 return(0);
541 }
542
543 return(1);
544 }
545
546
547
548
549 static int
550 check_parent(PRE_ARGS, int tok, enum mdoc_type t)
551 {
552
553 assert(n->parent);
554 if ((MDOC_ROOT == t || tok == n->parent->tok) &&
555 (t == n->parent->type))
556 return(1);
557
558 return(mdoc_verr(mdoc, n->line, n->pos, "require parent %s",
559 MDOC_ROOT == t ? "<root>" : mdoc_macronames[tok]));
560 }
561
562
563
564 static int
565 pre_display(PRE_ARGS)
566 {
567 struct mdoc_node *node;
568
569 /* Display elements (`Bd', `D1'...) cannot be nested. */
570
571 if (MDOC_BLOCK != n->type)
572 return(1);
573
574 /* LINTED */
575 for (node = mdoc->last->parent; node; node = node->parent)
576 if (MDOC_BLOCK == node->type)
577 if (MDOC_Bd == node->tok)
578 break;
579 if (NULL == node)
580 return(1);
581
582 return(mdoc_nerr(mdoc, n, ENESTDISP));
583 }
584
585
586 static int
587 pre_bl(PRE_ARGS)
588 {
589 int pos, type, width, offset;
590
591 if (MDOC_BLOCK != n->type)
592 return(1);
593 if (NULL == n->args)
594 return(mdoc_nerr(mdoc, n, ELISTTYPE));
595
596 /* Make sure that only one type of list is specified. */
597
598 type = offset = width = -1;
599
600 /* LINTED */
601 for (pos = 0; pos < (int)n->args->argc; pos++)
602 switch (n->args->argv[pos].arg) {
603 case (MDOC_Bullet):
604 /* FALLTHROUGH */
605 case (MDOC_Dash):
606 /* FALLTHROUGH */
607 case (MDOC_Enum):
608 /* FALLTHROUGH */
609 case (MDOC_Hyphen):
610 /* FALLTHROUGH */
611 case (MDOC_Item):
612 /* FALLTHROUGH */
613 case (MDOC_Tag):
614 /* FALLTHROUGH */
615 case (MDOC_Diag):
616 /* FALLTHROUGH */
617 case (MDOC_Hang):
618 /* FALLTHROUGH */
619 case (MDOC_Ohang):
620 /* FALLTHROUGH */
621 case (MDOC_Inset):
622 /* FALLTHROUGH */
623 case (MDOC_Column):
624 if (-1 != type)
625 return(mdoc_nerr(mdoc, n, EMULTILIST));
626 type = n->args->argv[pos].arg;
627 break;
628 case (MDOC_Width):
629 if (-1 != width)
630 return(mdoc_nerr(mdoc, n, EARGREP));
631 width = n->args->argv[pos].arg;
632 break;
633 case (MDOC_Offset):
634 if (-1 != offset)
635 return(mdoc_nerr(mdoc, n, EARGREP));
636 offset = n->args->argv[pos].arg;
637 break;
638 default:
639 break;
640 }
641
642 if (-1 == type)
643 return(mdoc_nerr(mdoc, n, ELISTTYPE));
644
645 /*
646 * Validate the width field. Some list types don't need width
647 * types and should be warned about them. Others should have it
648 * and must also be warned.
649 */
650
651 switch (type) {
652 case (MDOC_Tag):
653 if (-1 == width && ! mdoc_nwarn(mdoc, n, EMISSWIDTH))
654 return(0);
655 break;
656 case (MDOC_Column):
657 /* FALLTHROUGH */
658 case (MDOC_Diag):
659 /* FALLTHROUGH */
660 case (MDOC_Inset):
661 /* FALLTHROUGH */
662 case (MDOC_Item):
663 if (-1 != width && ! mdoc_nwarn(mdoc, n, ENOWIDTH))
664 return(0);
665 break;
666 default:
667 break;
668 }
669
670 return(1);
671 }
672
673
674 static int
675 pre_bd(PRE_ARGS)
676 {
677 int i, type, err;
678
679 if (MDOC_BLOCK != n->type)
680 return(1);
681 if (NULL == n->args)
682 return(mdoc_nerr(mdoc, n, EDISPTYPE));
683
684 /* Make sure that only one type of display is specified. */
685
686 /* LINTED */
687 for (i = 0, err = type = 0; ! err &&
688 i < (int)n->args->argc; i++)
689 switch (n->args->argv[i].arg) {
690 case (MDOC_Ragged):
691 /* FALLTHROUGH */
692 case (MDOC_Unfilled):
693 /* FALLTHROUGH */
694 case (MDOC_Filled):
695 /* FALLTHROUGH */
696 case (MDOC_Literal):
697 /* FALLTHROUGH */
698 case (MDOC_File):
699 if (0 == type++)
700 break;
701 return(mdoc_nerr(mdoc, n, EMULTIDISP));
702 default:
703 break;
704 }
705
706 if (type)
707 return(1);
708 return(mdoc_nerr(mdoc, n, EDISPTYPE));
709 }
710
711
712 static int
713 pre_ss(PRE_ARGS)
714 {
715
716 if (MDOC_BLOCK != n->type)
717 return(1);
718 return(check_parent(mdoc, n, MDOC_Sh, MDOC_BODY));
719 }
720
721
722 static int
723 pre_sh(PRE_ARGS)
724 {
725
726 if (MDOC_BLOCK != n->type)
727 return(1);
728 return(check_parent(mdoc, n, -1, MDOC_ROOT));
729 }
730
731
732 static int
733 pre_it(PRE_ARGS)
734 {
735
736 if (MDOC_BLOCK != n->type)
737 return(1);
738 return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
739 }
740
741
742 static int
743 pre_an(PRE_ARGS)
744 {
745
746 if (NULL == n->args || 1 == n->args->argc)
747 return(1);
748 return(mdoc_verr(mdoc, n->line, n->pos,
749 "only one argument allowed"));
750 }
751
752
753 static int
754 pre_lb(PRE_ARGS)
755 {
756
757 return(check_sec(mdoc, n, SEC_LIBRARY, SEC_CUSTOM));
758 }
759
760
761 static int
762 pre_rv(PRE_ARGS)
763 {
764
765 if ( ! check_msec(mdoc, n, 2, 3, 0))
766 return(0);
767 return(check_stdarg(mdoc, n));
768 }
769
770
771 static int
772 pre_ex(PRE_ARGS)
773 {
774
775 if ( ! check_msec(mdoc, n, 1, 6, 8, 0))
776 return(0);
777 return(check_stdarg(mdoc, n));
778 }
779
780
781 static int
782 pre_er(PRE_ARGS)
783 {
784
785 return(check_msec(mdoc, n, 2, 3, 9, 0));
786 }
787
788
789 static int
790 pre_cd(PRE_ARGS)
791 {
792
793 return(check_msec(mdoc, n, 4, 0));
794 }
795
796
797 static int
798 pre_dt(PRE_ARGS)
799 {
800
801 if (0 == mdoc->meta.date || mdoc->meta.os)
802 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
803 return(0);
804 if (mdoc->meta.title)
805 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
806 return(0);
807 return(1);
808 }
809
810
811 static int
812 pre_os(PRE_ARGS)
813 {
814
815 if (NULL == mdoc->meta.title || 0 == mdoc->meta.date)
816 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
817 return(0);
818 if (mdoc->meta.os)
819 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
820 return(0);
821 return(1);
822 }
823
824
825 static int
826 pre_dd(PRE_ARGS)
827 {
828
829 if (mdoc->meta.title || mdoc->meta.os)
830 if ( ! mdoc_nwarn(mdoc, n, EPROLOOO))
831 return(0);
832 if (mdoc->meta.date)
833 if ( ! mdoc_nwarn(mdoc, n, EPROLREP))
834 return(0);
835 return(1);
836 }
837
838
839 static int
840 post_bf(POST_ARGS)
841 {
842 char *p;
843 struct mdoc_node *head;
844
845 if (MDOC_BLOCK != mdoc->last->type)
846 return(1);
847
848 head = mdoc->last->head;
849
850 if (mdoc->last->args && head->child)
851 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
852 else if (mdoc->last->args)
853 return(1);
854
855 if (NULL == head->child || MDOC_TEXT != head->child->type)
856 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
857
858 p = head->child->string;
859
860 if (0 == strcmp(p, "Em"))
861 return(1);
862 else if (0 == strcmp(p, "Li"))
863 return(1);
864 else if (0 == strcmp(p, "Sy"))
865 return(1);
866
867 return(mdoc_nerr(mdoc, head, EFONT));
868 }
869
870
871 static int
872 post_lb(POST_ARGS)
873 {
874
875 if (mdoc_a2lib(mdoc->last->child->string))
876 return(1);
877 return(mdoc_nwarn(mdoc, mdoc->last, ELIB));
878 }
879
880
881 static int
882 post_nm(POST_ARGS)
883 {
884
885 if (mdoc->last->child)
886 return(1);
887 if (mdoc->meta.name)
888 return(1);
889 return(mdoc_nerr(mdoc, mdoc->last, ENAME));
890 }
891
892
893 static int
894 post_at(POST_ARGS)
895 {
896
897 if (NULL == mdoc->last->child)
898 return(1);
899 if (MDOC_TEXT != mdoc->last->child->type)
900 return(mdoc_nerr(mdoc, mdoc->last, EATT));
901 if (mdoc_a2att(mdoc->last->child->string))
902 return(1);
903 return(mdoc_nerr(mdoc, mdoc->last, EATT));
904 }
905
906
907 static int
908 post_an(POST_ARGS)
909 {
910
911 if (mdoc->last->args) {
912 if (NULL == mdoc->last->child)
913 return(1);
914 return(mdoc_nerr(mdoc, mdoc->last, ENOLINE));
915 }
916
917 if (mdoc->last->child)
918 return(1);
919 return(mdoc_nerr(mdoc, mdoc->last, ELINE));
920 }
921
922
923 static int
924 post_it(POST_ARGS)
925 {
926 int type, i, cols;
927 struct mdoc_node *n, *c;
928
929 if (MDOC_BLOCK != mdoc->last->type)
930 return(1);
931
932 n = mdoc->last->parent->parent;
933 if (NULL == n->args)
934 return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE));
935
936 /* Some types require block-head, some not. */
937
938 /* LINTED */
939 for (cols = type = -1, i = 0; -1 == type &&
940 i < (int)n->args->argc; i++)
941 switch (n->args->argv[i].arg) {
942 case (MDOC_Tag):
943 /* FALLTHROUGH */
944 case (MDOC_Diag):
945 /* FALLTHROUGH */
946 case (MDOC_Hang):
947 /* FALLTHROUGH */
948 case (MDOC_Ohang):
949 /* FALLTHROUGH */
950 case (MDOC_Inset):
951 /* FALLTHROUGH */
952 case (MDOC_Bullet):
953 /* FALLTHROUGH */
954 case (MDOC_Dash):
955 /* FALLTHROUGH */
956 case (MDOC_Enum):
957 /* FALLTHROUGH */
958 case (MDOC_Hyphen):
959 /* FALLTHROUGH */
960 case (MDOC_Item):
961 type = n->args->argv[i].arg;
962 break;
963 case (MDOC_Column):
964 type = n->args->argv[i].arg;
965 cols = (int)n->args->argv[i].sz;
966 break;
967 default:
968 break;
969 }
970
971 if (-1 == type)
972 return(mdoc_nerr(mdoc, mdoc->last, ELISTTYPE));
973
974 switch (type) {
975 case (MDOC_Tag):
976 if (NULL == mdoc->last->head->child)
977 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
978 return(0);
979 break;
980 case (MDOC_Hang):
981 /* FALLTHROUGH */
982 case (MDOC_Ohang):
983 /* FALLTHROUGH */
984 case (MDOC_Inset):
985 /* FALLTHROUGH */
986 case (MDOC_Diag):
987 if (NULL == mdoc->last->head->child)
988 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
989 return(0);
990 if (NULL == mdoc->last->body->child)
991 if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE))
992 return(0);
993 break;
994 case (MDOC_Bullet):
995 /* FALLTHROUGH */
996 case (MDOC_Dash):
997 /* FALLTHROUGH */
998 case (MDOC_Enum):
999 /* FALLTHROUGH */
1000 case (MDOC_Hyphen):
1001 /* FALLTHROUGH */
1002 case (MDOC_Item):
1003 if (mdoc->last->head->child)
1004 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOLINE))
1005 return(0);
1006 if (NULL == mdoc->last->body->child)
1007 if ( ! mdoc_nwarn(mdoc, mdoc->last, EMULTILINE))
1008 return(0);
1009 break;
1010 case (MDOC_Column):
1011 if (NULL == mdoc->last->head->child)
1012 if ( ! mdoc_nwarn(mdoc, mdoc->last, ELINE))
1013 return(0);
1014 if (mdoc->last->body->child)
1015 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENOMULTILINE))
1016 return(0);
1017 c = mdoc->last->child;
1018 for (i = 0; c && MDOC_HEAD == c->type; c = c->next)
1019 i++;
1020
1021 if (i < cols || i == (cols + 1)) {
1022 if ( ! mdoc_vwarn(mdoc, mdoc->last->line,
1023 mdoc->last->pos, "column "
1024 "mismatch: have %d, want %d",
1025 i, cols))
1026 return(0);
1027 break;
1028 } else if (i == cols)
1029 break;
1030
1031 return(mdoc_verr(mdoc, mdoc->last->line,
1032 mdoc->last->pos, "column mismatch: "
1033 "have %d, want %d", i, cols));
1034 default:
1035 break;
1036 }
1037
1038 return(1);
1039 }
1040
1041
1042 static int
1043 post_bl_head(POST_ARGS)
1044 {
1045 int i;
1046 const struct mdoc_node *n;
1047
1048 n = mdoc->last->parent;
1049 assert(n->args);
1050
1051 for (i = 0; i < (int)n->args->argc; i++)
1052 if (n->args->argv[i].arg == MDOC_Column)
1053 break;
1054
1055 if (i == (int)n->args->argc)
1056 return(1);
1057
1058 if (n->args->argv[i].sz && mdoc->last->child)
1059 return(mdoc_nerr(mdoc, n, ECOLMIS));
1060
1061 return(1);
1062 }
1063
1064
1065 static int
1066 post_bl(POST_ARGS)
1067 {
1068 struct mdoc_node *n;
1069
1070 if (MDOC_HEAD == mdoc->last->type)
1071 return(post_bl_head(mdoc));
1072 if (MDOC_BODY != mdoc->last->type)
1073 return(1);
1074 if (NULL == mdoc->last->child)
1075 return(1);
1076
1077 /* LINTED */
1078 for (n = mdoc->last->child; n; n = n->next) {
1079 if (MDOC_BLOCK == n->type)
1080 if (MDOC_It == n->tok)
1081 continue;
1082 return(mdoc_nerr(mdoc, n, EBADCHILD));
1083 }
1084
1085 return(1);
1086 }
1087
1088
1089 static int
1090 ebool(struct mdoc *mdoc)
1091 {
1092 struct mdoc_node *n;
1093
1094 /* LINTED */
1095 for (n = mdoc->last->child; n; n = n->next) {
1096 if (MDOC_TEXT != n->type)
1097 break;
1098 if (0 == strcmp(n->string, "on"))
1099 continue;
1100 if (0 == strcmp(n->string, "off"))
1101 continue;
1102 break;
1103 }
1104
1105 if (NULL == n)
1106 return(1);
1107 return(mdoc_nerr(mdoc, n, EBOOL));
1108 }
1109
1110
1111 static int
1112 post_root(POST_ARGS)
1113 {
1114
1115 if (NULL == mdoc->first->child)
1116 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1117 if ( ! (MDOC_PBODY & mdoc->flags))
1118 return(mdoc_nerr(mdoc, mdoc->first, ENOPROLOGUE));
1119
1120 if (MDOC_BLOCK != mdoc->first->child->type)
1121 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1122 if (MDOC_Sh != mdoc->first->child->tok)
1123 return(mdoc_nerr(mdoc, mdoc->first, ENODAT));
1124
1125 return(1);
1126 }
1127
1128
1129 static int
1130 post_sp(POST_ARGS)
1131 {
1132 long lval;
1133 char *ep, *buf;
1134
1135 if (NULL == mdoc->last->child)
1136 return(1);
1137 else if ( ! eerr_eq1(mdoc))
1138 return(0);
1139
1140 assert(MDOC_TEXT == mdoc->last->child->type);
1141 buf = mdoc->last->child->string;
1142 assert(buf);
1143
1144 /* From OpenBSD's strtol(3). */
1145 errno = 0;
1146 lval = strtol(buf, &ep, 10);
1147 if (buf[0] == '\0' || *ep != '\0')
1148 return(mdoc_nerr(mdoc, mdoc->last->child, ENUMFMT));
1149
1150 if ((errno == ERANGE && (lval == LONG_MAX || lval == LONG_MIN)) ||
1151 (lval > INT_MAX || lval < 0))
1152 return(mdoc_nerr(mdoc, mdoc->last->child, ENUMFMT));
1153
1154 return(1);
1155 }
1156
1157
1158
1159
1160 static int
1161 post_st(POST_ARGS)
1162 {
1163
1164 if (mdoc_a2st(mdoc->last->child->string))
1165 return(1);
1166 return(mdoc_nerr(mdoc, mdoc->last, EBADSTAND));
1167 }
1168
1169
1170 static int
1171 post_rs(POST_ARGS)
1172 {
1173 struct mdoc_node *nn;
1174
1175 if (MDOC_BODY != mdoc->last->type)
1176 return(1);
1177
1178 for (nn = mdoc->last->child; nn; nn = nn->next)
1179 switch (nn->tok) {
1180 case(MDOC__Q):
1181 /* FALLTHROUGH */
1182 case(MDOC__C):
1183 /* FALLTHROUGH */
1184 case(MDOC__A):
1185 /* FALLTHROUGH */
1186 case(MDOC__B):
1187 /* FALLTHROUGH */
1188 case(MDOC__D):
1189 /* FALLTHROUGH */
1190 case(MDOC__I):
1191 /* FALLTHROUGH */
1192 case(MDOC__J):
1193 /* FALLTHROUGH */
1194 case(MDOC__N):
1195 /* FALLTHROUGH */
1196 case(MDOC__O):
1197 /* FALLTHROUGH */
1198 case(MDOC__P):
1199 /* FALLTHROUGH */
1200 case(MDOC__R):
1201 /* FALLTHROUGH */
1202 case(MDOC__T):
1203 /* FALLTHROUGH */
1204 case(MDOC__V):
1205 break;
1206 default:
1207 return(mdoc_nerr(mdoc, nn, EBADCHILD));
1208 }
1209
1210 return(1);
1211 }
1212
1213
1214 static int
1215 post_sh(POST_ARGS)
1216 {
1217
1218 if (MDOC_HEAD == mdoc->last->type)
1219 return(post_sh_head(mdoc));
1220 if (MDOC_BODY == mdoc->last->type)
1221 return(post_sh_body(mdoc));
1222
1223 return(1);
1224 }
1225
1226
1227 static int
1228 post_sh_body(POST_ARGS)
1229 {
1230 struct mdoc_node *n;
1231
1232 if (SEC_NAME != mdoc->lastsec)
1233 return(1);
1234
1235 /*
1236 * Warn if the NAME section doesn't contain the `Nm' and `Nd'
1237 * macros (can have multiple `Nm' and one `Nd'). Note that the
1238 * children of the BODY declaration can also be "text".
1239 */
1240
1241 if (NULL == (n = mdoc->last->child))
1242 return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1243
1244 for ( ; n && n->next; n = n->next) {
1245 if (MDOC_ELEM == n->type && MDOC_Nm == n->tok)
1246 continue;
1247 if (MDOC_TEXT == n->type)
1248 continue;
1249 if ( ! mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC))
1250 return(0);
1251 }
1252
1253 assert(n);
1254 if (MDOC_BLOCK == n->type && MDOC_Nd == n->tok)
1255 return(1);
1256 return(mdoc_nwarn(mdoc, mdoc->last, ENAMESECINC));
1257 }
1258
1259
1260 static int
1261 post_sh_head(POST_ARGS)
1262 {
1263 char buf[64];
1264 enum mdoc_sec sec;
1265 const struct mdoc_node *n;
1266
1267 /*
1268 * Process a new section. Sections are either "named" or
1269 * "custom"; custom sections are user-defined, while named ones
1270 * usually follow a conventional order and may only appear in
1271 * certain manual sections.
1272 */
1273
1274 buf[0] = 0;
1275
1276 for (n = mdoc->last->child; n; n = n->next) {
1277 /* XXX - copied from compact(). */
1278 assert(MDOC_TEXT == n->type);
1279
1280 if (strlcat(buf, n->string, 64) >= 64)
1281 return(mdoc_nerr(mdoc, n, ETOOLONG));
1282 if (NULL == n->next)
1283 continue;
1284 if (strlcat(buf, " ", 64) >= 64)
1285 return(mdoc_nerr(mdoc, n, ETOOLONG));
1286 }
1287
1288 sec = mdoc_atosec(buf);
1289
1290 /*
1291 * Check: NAME should always be first, CUSTOM has no roles,
1292 * non-CUSTOM has a conventional order to be followed.
1293 */
1294
1295 if (SEC_NAME != sec && SEC_NONE == mdoc->lastnamed)
1296 return(mdoc_nerr(mdoc, mdoc->last, ESECNAME));
1297 if (SEC_CUSTOM == sec)
1298 return(1);
1299 if (sec == mdoc->lastnamed)
1300 if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECREP))
1301 return(0);
1302 if (sec < mdoc->lastnamed)
1303 if ( ! mdoc_nwarn(mdoc, mdoc->last, ESECOOO))
1304 return(0);
1305
1306 /*
1307 * Check particular section/manual conventions. LIBRARY can
1308 * only occur in msec 2, 3 (TODO: are there more of these?).
1309 */
1310
1311 switch (sec) {
1312 case (SEC_LIBRARY):
1313 switch (mdoc->meta.msec) {
1314 case (2):
1315 /* FALLTHROUGH */
1316 case (3):
1317 break;
1318 default:
1319 return(mdoc_nwarn(mdoc, mdoc->last, EWRONGMSEC));
1320 }
1321 break;
1322 default:
1323 break;
1324 }
1325
1326 return(1);
1327 }
1328
1329
1330 static int
1331 pre_fd(PRE_ARGS)
1332 {
1333
1334 return(check_sec(mdoc, n, SEC_SYNOPSIS, SEC_CUSTOM));
1335 }
A git conversion mirror of mandoc.bsd.lv