implement -h (synopsis only) for preformatted (cat) pages;

[mandoc.git] / mdoc_validate.c

diff --git a/mdoc_validate.c b/mdoc_validate.c
index a566ad0095586b782312d57684c1e43552adf8f4..c0ed2621f30771841c649e61cdf30e8da067079d 100644 (file)
--- a/mdoc_validate.c
+++ b/mdoc_validate.c
@@ -1,4 +1,4 @@
-/*     $Id: mdoc_validate.c,v 1.249 2014/09/12 00:54:10 schwarze Exp $ */
+/*     $Id: mdoc_validate.c,v 1.254 2014/10/30 20:10:02 schwarze Exp $ */

 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
 /*
  * Copyright (c) 2008-2012 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>


@@ -70,6 +70,7 @@ static        void     check_args(struct mdoc *, struct mdoc_node *);
 static int      child_an(const struct mdoc_node *);
 static enum mdoc_sec   a2sec(const char *);
 static size_t          macro2len(enum mdoct);
 static int      child_an(const struct mdoc_node *);
 static enum mdoc_sec   a2sec(const char *);
 static size_t          macro2len(enum mdoct);

+static void     rewrite_macro2len(char **);

 
 static int      ebool(POST_ARGS);
 static int      berr_ge1(POST_ARGS);
 
 static int      ebool(POST_ARGS);
 static int      berr_ge1(POST_ARGS);


@@ -88,7 +89,6 @@ static        int      post_bf(POST_ARGS);
 static int      post_bk(POST_ARGS);
 static int      post_bl(POST_ARGS);
 static int      post_bl_block(POST_ARGS);
 static int      post_bk(POST_ARGS);
 static int      post_bl(POST_ARGS);
 static int      post_bl_block(POST_ARGS);

-static int      post_bl_block_width(POST_ARGS);

 static int      post_bl_block_tag(POST_ARGS);
 static int      post_bl_head(POST_ARGS);
 static int      post_bx(POST_ARGS);
 static int      post_bl_block_tag(POST_ARGS);
 static int      post_bl_head(POST_ARGS);
 static int      post_bx(POST_ARGS);


@@ -101,6 +101,8 @@ static      int      post_es(POST_ARGS);
 static int      post_eoln(POST_ARGS);
 static int      post_ex(POST_ARGS);
 static int      post_fa(POST_ARGS);
 static int      post_eoln(POST_ARGS);
 static int      post_ex(POST_ARGS);
 static int      post_fa(POST_ARGS);

+static int      post_fn(POST_ARGS);
+static int      post_fname(POST_ARGS);

 static int      post_fo(POST_ARGS);
 static int      post_hyph(POST_ARGS);
 static int      post_hyphtext(POST_ARGS);
 static int      post_fo(POST_ARGS);
 static int      post_hyph(POST_ARGS);
 static int      post_hyphtext(POST_ARGS);


@@ -161,7 +163,7 @@ static      const struct valids mdoc_valids[MDOC_MAX] = {
        { NULL, post_fa },                      /* Fa */
        { NULL, ewarn_ge1 },                    /* Fd */
        { NULL, NULL },                         /* Fl */
        { NULL, post_fa },                      /* Fa */
        { NULL, ewarn_ge1 },                    /* Fd */
        { NULL, NULL },                         /* Fl */

-       { NULL, post_fa },                      /* Fn */
+       { NULL, post_fn },                      /* Fn */

        { NULL, NULL },                         /* Ft */
        { NULL, NULL },                         /* Ic */
        { NULL, ewarn_eq1 },                    /* In */
        { NULL, NULL },                         /* Ft */
        { NULL, NULL },                         /* Ic */
        { NULL, ewarn_eq1 },                    /* In */


@@ -595,6 +597,7 @@ pre_bl(PRE_ARGS)
                                    mdoc->parse, argv->line,
                                    argv->pos, "Bl -width %s",
                                    argv->value[0]);
                                    mdoc->parse, argv->line,
                                    argv->pos, "Bl -width %s",
                                    argv->value[0]);

+                       rewrite_macro2len(argv->value);

                        n->norm->Bl.width = argv->value[0];
                        break;
                case MDOC_Offset:
                        n->norm->Bl.width = argv->value[0];
                        break;
                case MDOC_Offset:


@@ -609,6 +612,7 @@ pre_bl(PRE_ARGS)
                                    mdoc->parse, argv->line,
                                    argv->pos, "Bl -offset %s",
                                    argv->value[0]);
                                    mdoc->parse, argv->line,
                                    argv->pos, "Bl -offset %s",
                                    argv->value[0]);

+                       rewrite_macro2len(argv->value);

                        n->norm->Bl.offs = argv->value[0];
                        break;
                default:
                        n->norm->Bl.offs = argv->value[0];
                        break;
                default:


@@ -756,6 +760,7 @@ pre_bd(PRE_ARGS)
                                    mdoc->parse, argv->line,
                                    argv->pos, "Bd -offset %s",
                                    argv->value[0]);
                                    mdoc->parse, argv->line,
                                    argv->pos, "Bd -offset %s",
                                    argv->value[0]);

+                       rewrite_macro2len(argv->value);

                        n->norm->Bd.offs = argv->value[0];
                        break;
                case MDOC_Compact:
                        n->norm->Bd.offs = argv->value[0];
                        break;
                case MDOC_Compact:


@@ -999,12 +1004,39 @@ post_eoln(POST_ARGS)
        return(1);
 }
 
        return(1);
 }
 

+static int
+post_fname(POST_ARGS)
+{
+       const struct mdoc_node  *n;
+       const char              *cp;
+       size_t                   pos;
+
+       n = mdoc->last->child;
+       pos = strcspn(n->string, "()");
+       cp = n->string + pos;
+       if ( ! (cp[0] == '\0' || (cp[0] == '(' && cp[1] == '*')))
+               mandoc_msg(MANDOCERR_FN_PAREN, mdoc->parse,
+                   n->line, n->pos + pos, n->string);
+       return(1);
+}
+
+static int
+post_fn(POST_ARGS)
+{
+
+       post_fname(mdoc);
+       post_fa(mdoc);
+       return(1);
+}
+

 static int
 post_fo(POST_ARGS)
 {
 
        hwarn_eq1(mdoc);
        bwarn_ge1(mdoc);
 static int
 post_fo(POST_ARGS)
 {
 
        hwarn_eq1(mdoc);
        bwarn_ge1(mdoc);

+       if (mdoc->last->type == MDOC_HEAD && mdoc->last->nchild)
+               post_fname(mdoc);

        return(1);
 }
 
        return(1);
 }
 


@@ -1307,10 +1339,6 @@ post_bl_block(POST_ARGS)
                if ( ! post_bl_block_tag(mdoc))
                        return(0);
                assert(n->norm->Bl.width);
                if ( ! post_bl_block_tag(mdoc))
                        return(0);
                assert(n->norm->Bl.width);

-       } else if (NULL != n->norm->Bl.width) {
-               if ( ! post_bl_block_width(mdoc))
-                       return(0);
-               assert(n->norm->Bl.width);

        }
 
        for (ni = n->body->child; ni; ni = ni->next) {
        }
 
        for (ni = n->body->child; ni; ni = ni->next) {


@@ -1350,50 +1378,27 @@ post_bl_block(POST_ARGS)
        return(1);
 }
 
        return(1);
 }
 

-static int
-post_bl_block_width(POST_ARGS)
+/*
+ * If the argument of -offset or -width is a macro,
+ * replace it with the associated default width.
+ */
+void
+rewrite_macro2len(char **arg)

 {
        size_t            width;
 {
        size_t            width;

-       int               i;

        enum mdoct        tok;
        enum mdoct        tok;

-       struct mdoc_node *n;
-       char              buf[24];
-
-       n = mdoc->last;
-
-       /*
-        * Calculate the real width of a list from the -width string,
-        * which may contain a macro (with a known default width), a
-        * literal string, or a scaling width.
-        *
-        * If the value to -width is a macro, then we re-write it to be
-        * the macro's width as set in share/tmac/mdoc/doc-common.
-        */

 
 

-       if (0 == strcmp(n->norm->Bl.width, "Ds"))
+       if (*arg == NULL)
+               return;
+       else if ( ! strcmp(*arg, "Ds"))

                width = 6;
                width = 6;

-       else if (MDOC_MAX == (tok = mdoc_hash_find(n->norm->Bl.width)))
-               return(1);
+       else if ((tok = mdoc_hash_find(*arg)) == MDOC_MAX)
+               return;

        else
                width = macro2len(tok);
 
        else
                width = macro2len(tok);
 

-       /* The value already exists: free and reallocate it. */
-
-       assert(n->args);
-
-       for (i = 0; i < (int)n->args->argc; i++)
-               if (MDOC_Width == n->args->argv[i].arg)
-                       break;
-
-       assert(i < (int)n->args->argc);
-
-       (void)snprintf(buf, sizeof(buf), "%un", (unsigned int)width);
-       free(n->args->argv[i].value[0]);
-       n->args->argv[i].value[0] = mandoc_strdup(buf);
-
-       /* Set our width! */
-       n->norm->Bl.width = n->args->argv[i].value[0];
-       return(1);
+       free(*arg);
+       mandoc_asprintf(arg, "%zun", width);

 }
 
 static int
 }
 
 static int


@@ -1408,7 +1413,7 @@ post_bl_block_tag(POST_ARGS)
         * Calculate the -width for a `Bl -tag' list if it hasn't been
         * provided.  Uses the first head macro.  NOTE AGAIN: this is
         * ONLY if the -width argument has NOT been provided.  See
         * Calculate the -width for a `Bl -tag' list if it hasn't been
         * provided.  Uses the first head macro.  NOTE AGAIN: this is
         * ONLY if the -width argument has NOT been provided.  See

-        * post_bl_block_width() for converting the -width string.
+        * rewrite_macro2len() for converting the -width string.

         */
 
        sz = 10;
         */
 
        sz = 10;


@@ -1960,7 +1965,8 @@ post_sh_see_also(POST_ARGS)
                                    mdoc->parse, n->line, n->pos,
                                    "%s(%s) after %s(%s)", name,
                                    sec, lastname, lastsec);
                                    mdoc->parse, n->line, n->pos,
                                    "%s(%s) after %s(%s)", name,
                                    sec, lastname, lastsec);

-                       else if (cmp == 0 && strcmp(lastname, name) > 0)
+                       else if (cmp == 0 &&
+                           strcasecmp(lastname, name) > 0)

                                mandoc_vmsg(MANDOCERR_XR_ORDER,
                                    mdoc->parse, n->line, n->pos,
                                    "%s after %s", name, lastname);
                                mandoc_vmsg(MANDOCERR_XR_ORDER,
                                    mdoc->parse, n->line, n->pos,
                                    "%s after %s", name, lastname);