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