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