Added new old escape sequence \*[nn].

[mandoc.git] / validate.c

diff --git a/validate.c b/validate.c
index 72a5dea0659b3a924d635a207a7980490e97306a..ebd95aee751b02ff149a6592f0d5f0784b99d328 100644 (file)
--- a/validate.c
+++ b/validate.c
@@ -1,4 +1,4 @@
-/* $Id: validate.c,v 1.60 2009/02/25 12:32:50 kristaps Exp $ */
+/* $Id: validate.c,v 1.66 2009/03/02 17:14:46 kristaps Exp $ */
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
@@ -36,9 +36,7 @@
 typedef        int     (*v_pre)(PRE_ARGS);
 typedef        int     (*v_post)(POST_ARGS);
 
-/* FIXME: some sections should only occur in specific msecs. */
-/* FIXME: ignoring Pp. */
-/* FIXME: math symbols. */
+/* TODO: ignoring Pp (it's superfluous in some invocations). */
 
 struct valids {
        v_pre   *pre;
@@ -52,7 +50,7 @@ static        int     check_msec(PRE_ARGS, int, enum mdoc_msec *);
 static int     check_stdarg(PRE_ARGS);
 
 static int     check_text(struct mdoc *, 
-                       size_t, size_t, const char *);
+                       int, int, const char *);
 
 static int     err_child_lt(struct mdoc *, const char *, int);
 static int     warn_child_lt(struct mdoc *, const char *, int);
@@ -278,7 +276,8 @@ mdoc_valid_pre(struct mdoc *mdoc,
 {
        v_pre           *p;
        struct mdoc_arg *argv;
-       size_t           argc, i, j, line, pos;
+       size_t           argc;
+       int              line, pos, i, j;
        const char      *tp;
 
        if (MDOC_TEXT == node->type) {
@@ -296,10 +295,10 @@ mdoc_valid_pre(struct mdoc *mdoc,
                        node->data.block.argc :
                        node->data.elem.argc;
 
-               for (i = 0; i < argc; i++) {
+               for (i = 0; i < (int)argc; i++) {
                        if (0 == argv[i].sz)
                                continue;
-                       for (j = 0; j < argv[i].sz; j++) {
+                       for (j = 0; j < (int)argv[i].sz; j++) {
                                tp = argv[i].value[j];
                                line = argv[i].line;
                                pos = argv[i].pos;
@@ -476,22 +475,24 @@ check_msec(PRE_ARGS, int sz, enum mdoc_msec *msecs)
 
 
 static int
-check_text(struct mdoc *mdoc, size_t line, size_t pos, const char *p)
+check_text(struct mdoc *mdoc, int line, int pos, const char *p)
 {
        size_t           c;
 
+       /* XXX - indicate deprecated escapes \*(xx and \*x. */
+
        for ( ; *p; p++) {
                if ( ! isprint((int)*p) && '\t' != *p)
                        return(mdoc_perr(mdoc, line, pos,
-                                       "invalid characters"));
+                               "invalid non-printing characters"));
                if ('\\' != *p)
                        continue;
                if ((c = mdoc_isescape(p))) {
-                       p += (c - 1);
+                       p += (int)c - 1;
                        continue;
                }
-               return(mdoc_perr(mdoc, line, pos,
-                                       "invalid escape sequence"));
+               return(mdoc_perr(mdoc, line, pos, 
+                               "invalid escape sequence"));
        }
 
        return(1);
@@ -540,7 +541,7 @@ pre_display(PRE_ARGS)
 static int
 pre_bl(PRE_ARGS)
 {
-       int              type, i;
+       int              type, i, width, offset;
        struct mdoc_arg *argv;
        size_t           argc;
 
@@ -551,8 +552,10 @@ pre_bl(PRE_ARGS)
 
        /* Make sure that only one type of list is specified.  */
 
+       type = offset = width = -1;
+
        /* LINTED */
-       for (i = 0, type = 0; i < (int)argc; i++) {
+       for (i = 0; i < (int)argc; i++) {
                argv = &n->data.block.argv[i];
 
                switch (argv->arg) {
@@ -577,18 +580,60 @@ pre_bl(PRE_ARGS)
                case (MDOC_Inset):
                        /* FALLTHROUGH */
                case (MDOC_Column):
-                       if (0 == type++)
+                       if (-1 == type) {
+                               type = argv->arg;
                                break;
+                       }
                        return(mdoc_perr(mdoc, argv->line, argv->pos, 
                                        "multiple types specified"));
+               case (MDOC_Width):
+                       if (-1 == width) {
+                               width = argv->arg;
+                               break;
+                       }
+                       return(mdoc_perr(mdoc, argv->line, argv->pos, 
+                                       "multiple -%s arguments",
+                                       mdoc_argnames[MDOC_Width]));
+               case (MDOC_Offset):
+                       if (-1 == offset) {
+                               offset = argv->arg;
+                               break;
+                       }
+                       return(mdoc_perr(mdoc, argv->line, argv->pos, 
+                                       "multiple -%s arguments",
+                                       mdoc_argnames[MDOC_Offset]));
                default:
                        break;
                }
        }
 
-       if (type)
-               return(1);
-       return(mdoc_err(mdoc, "no type specified"));
+       if (-1 == type)
+               return(mdoc_err(mdoc, "no type specified"));
+
+       switch (type) {
+       case (MDOC_Column):
+               /* FALLTHROUGH */
+       case (MDOC_Diag):
+               /* FALLTHROUGH */
+       case (MDOC_Inset):
+               /* FALLTHROUGH */
+       case (MDOC_Item):
+               if (-1 == width)
+                       break;
+               return(mdoc_nwarn(mdoc, n, WARN_SYNTAX,
+                               "superfluous -%s argument",
+                               mdoc_argnames[MDOC_Width]));
+       case (MDOC_Tag):
+               if (-1 == width && ! mdoc_nwarn(mdoc, n, WARN_SYNTAX, 
+                                       "suggest -%s argument",
+                                       mdoc_argnames[MDOC_Width]))
+                       return(0);
+               break;
+       default:
+               break;
+       }
+
+       return(1);
 }
 
 
@@ -659,9 +704,6 @@ static int
 pre_it(PRE_ARGS)
 {
 
-       /* TODO: -width attribute must be specified for -tag. */
-       /* TODO: children too big for -width? */
-
        if (MDOC_BLOCK != n->type)
                return(1);
        return(check_parent(mdoc, n, MDOC_Bl, MDOC_BODY));
@@ -1010,19 +1052,25 @@ post_bl(POST_ARGS)
 
        if (MDOC_BODY != mdoc->last->type)
                return(1);
+       if (NULL == (mdoc->last->child))
+               return(1);
+
+       /*
+        * Only allow `It' macros to be the immediate descendants of the
+        * `Bl' list. 
+        */
 
        /* LINTED */
        for (n = mdoc->last->child; n; n = n->next) {
                if (MDOC_BLOCK == n->type) 
                        if (MDOC_It == n->tok)
                                continue;
-               break;
-       }
 
-       if (NULL == n)
-               return(1);
+               return(mdoc_nerr(mdoc, n, "bad child of parent %s",
+                               mdoc_macronames[mdoc->last->tok]));
+       }
 
-       return(mdoc_nerr(mdoc, n, "bad child of parent list"));
+       return(1);
 }