Adding mdoclint.1 manual.

[mandoc.git] / argv.c

diff --git a/argv.c b/argv.c
index dedacdb95da539b3206fd9ea66d1a2ca148f47ef..f26fca0a7e655f7063403af57172c0120c57ef75 100644 (file)
--- a/argv.c
+++ b/argv.c
@@ -1,4 +1,4 @@
-/* $Id: argv.c,v 1.25 2009/01/22 12:21:03 kristaps Exp $ */
+/* $Id: argv.c,v 1.27 2009/02/23 12:45:19 kristaps Exp $ */

 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *
 /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
  *


@@ -26,10 +26,9 @@
 #include "private.h"
 
 /*
 #include "private.h"
 
 /*

- * Parse arguments and parameters of macros.  Arguments follow the
- * syntax of `-arg [val [valN...]]', while parameters are free-form text
- * following arguments (if any).  This file must correctly handle the
- * strange punctuation rules dictated by groff.
+ * Routines to parse arguments of macros.  Arguments follow the syntax
+ * of `-arg [val [valN...]]'.  Arguments come in all types:  quoted
+ * arguments, multiple arguments per value, no-value arguments, etc.

  */
 
 #define        ARGS_QUOTED     (1 << 0)
  */
 
 #define        ARGS_QUOTED     (1 << 0)


@@ -37,22 +36,28 @@
 #define        ARGS_TABSEP     (1 << 2)
 
 static int              lookup(int, const char *);
 #define        ARGS_TABSEP     (1 << 2)
 
 static int              lookup(int, const char *);

-static int              parse(struct mdoc *, int,
+static int              args(struct mdoc *, int, int *, 
+                               char *, int, char **);
+static int              argv(struct mdoc *, int,

                                struct mdoc_arg *, int *, char *);
                                struct mdoc_arg *, int *, char *);

-static int              parse_single(struct mdoc *, int, 
+static int              argv_single(struct mdoc *, int, 

                                struct mdoc_arg *, int *, char *);
                                struct mdoc_arg *, int *, char *);

-static int              parse_multi(struct mdoc *, int, 
+static int              argv_multi(struct mdoc *, int, 

                                struct mdoc_arg *, int *, char *);
                                struct mdoc_arg *, int *, char *);

-static int              postparse(struct mdoc *, int, 
+static int              postargv(struct mdoc *, int, 

                                const struct mdoc_arg *, int);
 static int              pwarn(struct mdoc *, int, int, int);
 static int              perr(struct mdoc *, int, int, int);
 
                                const struct mdoc_arg *, int);
 static int              pwarn(struct mdoc *, int, int, int);
 static int              perr(struct mdoc *, int, int, int);
 

+/* Warning messages. */
+

 #define        WQUOTPARM       (0)
 #define        WARGVPARM       (1)
 #define        WCOLEMPTY       (2)
 #define        WTAILWS         (3)
 
 #define        WQUOTPARM       (0)
 #define        WARGVPARM       (1)
 #define        WCOLEMPTY       (2)
 #define        WTAILWS         (3)
 

+/* Error messages. */
+

 #define        EQUOTTERM       (0)
 #define        EOFFSET         (1)
 #define        EARGVAL         (2)
 #define        EQUOTTERM       (0)
 #define        EOFFSET         (1)
 #define        EARGVAL         (2)


@@ -232,25 +237,11 @@ int
 mdoc_args(struct mdoc *mdoc, int line, 
                int *pos, char *buf, int tok, char **v)
 {
 mdoc_args(struct mdoc *mdoc, int line, 
                int *pos, char *buf, int tok, char **v)
 {

-       int               i, c, fl;
-       char             *p, *pp;
+       int               fl, c, i;

        struct mdoc_node *n;
 
        struct mdoc_node *n;
 

-       assert(*pos > 0);
-
-       if (0 == buf[*pos])
-               return(ARGS_EOLN);
-

        fl = (0 == tok) ? 0 : mdoc_argflags[tok];
 
        fl = (0 == tok) ? 0 : mdoc_argflags[tok];
 

-       if ('\"' == buf[*pos] && ! (fl & ARGS_QUOTED))
-               if ( ! pwarn(mdoc, line, *pos, WQUOTPARM))
-                       return(ARGS_ERROR);
-
-       if ('-' == buf[*pos]) 
-               if ( ! pwarn(mdoc, line, *pos, WARGVPARM))
-                       return(ARGS_ERROR);
-

        /* 
         * First see if we should use TABSEP (Bl -column).  This
         * invalidates the use of ARGS_DELIM.
        /* 
         * First see if we should use TABSEP (Bl -column).  This
         * invalidates the use of ARGS_DELIM.


@@ -264,14 +255,41 @@ mdoc_args(struct mdoc *mdoc, int line,
                assert(n);
                c = (int)n->data.block.argc;
                assert(c > 0);
                assert(n);
                c = (int)n->data.block.argc;
                assert(c > 0);

+
+               /* LINTED */

                for (i = 0; i < c; i++) {
                        if (MDOC_Column != n->data.block.argv[i].arg)
                                continue;
                        fl |= ARGS_TABSEP;
                        fl &= ~ARGS_DELIM;
                for (i = 0; i < c; i++) {
                        if (MDOC_Column != n->data.block.argv[i].arg)
                                continue;
                        fl |= ARGS_TABSEP;
                        fl &= ~ARGS_DELIM;

+                       break;

                }
        }
 
                }
        }
 

+       return(args(mdoc, line, pos, buf, fl, v));
+}
+
+
+static int
+args(struct mdoc *mdoc, int line, 
+               int *pos, char *buf, int fl, char **v)
+{
+       int               i, c;
+       char             *p, *pp;
+
+       assert(*pos > 0);
+
+       if (0 == buf[*pos])
+               return(ARGS_EOLN);
+
+       if ('\"' == buf[*pos] && ! (fl & ARGS_QUOTED))
+               if ( ! pwarn(mdoc, line, *pos, WQUOTPARM))
+                       return(ARGS_ERROR);
+
+       if ('-' == buf[*pos]) 
+               if ( ! pwarn(mdoc, line, *pos, WARGVPARM))
+                       return(ARGS_ERROR);
+

        /* 
         * If the first character is a delimiter and we're to look for
         * delimited strings, then pass down the buffer seeing if it
        /* 
         * If the first character is a delimiter and we're to look for
         * delimited strings, then pass down the buffer seeing if it


@@ -374,17 +392,18 @@ mdoc_args(struct mdoc *mdoc, int line,
                                if ( ! pwarn(mdoc, line, *pos, WTAILWS))
                                        return(0);
 
                                if ( ! pwarn(mdoc, line, *pos, WTAILWS))
                                        return(0);
 

+                       if (p)
+                               return(ARGS_WORD);
+

                        /* Configure the eoln case, too. */
 
                        /* Configure the eoln case, too. */
 

-                       if (NULL == p) {
-                               p = strchr(*v, 0);
-                               assert(p);
+                       p = strchr(*v, 0);
+                       assert(p);

 
 

-                               if (p > *v && ' ' == *(p - 1))
-                                       if ( ! pwarn(mdoc, line, *pos, WTAILWS))
-                                               return(0);
-                               *pos += p - *v;
-                       }
+                       if (p > *v && ' ' == *(p - 1))
+                               if ( ! pwarn(mdoc, line, *pos, WTAILWS))
+                                       return(0);
+                       *pos += p - *v;

 
                        return(ARGS_WORD);
                } 
 
                        return(ARGS_WORD);
                } 


@@ -618,7 +637,7 @@ lookup(int tok, const char *argv)
 
 
 static int
 
 
 static int

-postparse(struct mdoc *mdoc, int line, const struct mdoc_arg *v, int pos)
+postargv(struct mdoc *mdoc, int line, const struct mdoc_arg *v, int pos)

 {
 
        switch (v->arg) {
 {
 
        switch (v->arg) {


@@ -645,7 +664,7 @@ postparse(struct mdoc *mdoc, int line, const struct mdoc_arg *v, int pos)
 
 
 static int
 
 
 static int

-parse_multi(struct mdoc *mdoc, int line, 
+argv_multi(struct mdoc *mdoc, int line, 

                struct mdoc_arg *v, int *pos, char *buf)
 {
        int              c, ppos;
                struct mdoc_arg *v, int *pos, char *buf)
 {
        int              c, ppos;


@@ -659,7 +678,7 @@ parse_multi(struct mdoc *mdoc, int line,
        for (v->sz = 0; v->sz < MDOC_LINEARG_MAX; v->sz++) {
                if ('-' == buf[*pos])
                        break;
        for (v->sz = 0; v->sz < MDOC_LINEARG_MAX; v->sz++) {
                if ('-' == buf[*pos])
                        break;

-               c = mdoc_args(mdoc, line, pos, buf, ARGS_QUOTED, &p);
+               c = args(mdoc, line, pos, buf, ARGS_QUOTED, &p);

                if (ARGS_ERROR == c) {
                        free(v->value);
                        return(0);
                if (ARGS_ERROR == c) {
                        free(v->value);
                        return(0);


@@ -680,7 +699,7 @@ parse_multi(struct mdoc *mdoc, int line,
 
 
 static int
 
 
 static int

-parse_single(struct mdoc *mdoc, int line, 
+argv_single(struct mdoc *mdoc, int line, 

                struct mdoc_arg *v, int *pos, char *buf)
 {
        int              c, ppos;
                struct mdoc_arg *v, int *pos, char *buf)
 {
        int              c, ppos;


@@ -688,7 +707,7 @@ parse_single(struct mdoc *mdoc, int line,
 
        ppos = *pos;
 
 
        ppos = *pos;
 

-       c = mdoc_args(mdoc, line, pos, buf, ARGS_QUOTED, &p);
+       c = args(mdoc, line, pos, buf, ARGS_QUOTED, &p);

        if (ARGS_ERROR == c)
                return(0);
        if (ARGS_EOLN == c)
        if (ARGS_ERROR == c)
                return(0);
        if (ARGS_EOLN == c)


@@ -702,7 +721,7 @@ parse_single(struct mdoc *mdoc, int line,
 
 
 static int
 
 
 static int

-parse(struct mdoc *mdoc, int line, 
+argv(struct mdoc *mdoc, int line, 

                struct mdoc_arg *v, int *pos, char *buf)
 {
 
                struct mdoc_arg *v, int *pos, char *buf)
 {
 


@@ -715,9 +734,9 @@ parse(struct mdoc *mdoc, int line,
        case(MDOC_Width):
                /* FALLTHROUGH */
        case(MDOC_Offset):
        case(MDOC_Width):
                /* FALLTHROUGH */
        case(MDOC_Offset):

-               return(parse_single(mdoc, line, v, pos, buf));
+               return(argv_single(mdoc, line, v, pos, buf));

        case(MDOC_Column):
        case(MDOC_Column):

-               return(parse_multi(mdoc, line, v, pos, buf));
+               return(argv_multi(mdoc, line, v, pos, buf));

        default:
                break;
        }
        default:
                break;
        }


@@ -731,7 +750,7 @@ mdoc_argv(struct mdoc *mdoc, int line, int tok,
                struct mdoc_arg *v, int *pos, char *buf)
 {
        int              i, ppos;
                struct mdoc_arg *v, int *pos, char *buf)
 {
        int              i, ppos;

-       char            *argv;
+       char            *p;

 
        (void)memset(v, 0, sizeof(struct mdoc_arg));
 
 
        (void)memset(v, 0, sizeof(struct mdoc_arg));
 


@@ -744,12 +763,14 @@ mdoc_argv(struct mdoc *mdoc, int line, int tok,
                return(ARGV_WORD);
 
        i = *pos;
                return(ARGV_WORD);
 
        i = *pos;

-       argv = &buf[++(*pos)];
+       p = &buf[++(*pos)];

 
        v->line = line;
        v->pos = *pos;
 
        assert(*pos > 0);
 
        v->line = line;
        v->pos = *pos;
 
        assert(*pos > 0);

+
+       /* LINTED */

        while (buf[*pos]) {
                if (isspace((int)buf[*pos])) 
                        if ('\\' != buf[*pos - 1])
        while (buf[*pos]) {
                if (isspace((int)buf[*pos])) 
                        if ('\\' != buf[*pos - 1])


@@ -760,7 +781,7 @@ mdoc_argv(struct mdoc *mdoc, int line, int tok,
        if (buf[*pos])
                buf[(*pos)++] = 0;
 
        if (buf[*pos])
                buf[(*pos)++] = 0;
 

-       if (MDOC_ARG_MAX == (v->arg = lookup(tok, argv))) {
+       if (MDOC_ARG_MAX == (v->arg = lookup(tok, p))) {

                if ( ! pwarn(mdoc, line, i, WARGVPARM))
                        return(ARGV_ERROR);
                return(ARGV_WORD);
                if ( ! pwarn(mdoc, line, i, WARGVPARM))
                        return(ARGV_ERROR);
                return(ARGV_WORD);


@@ -772,9 +793,9 @@ mdoc_argv(struct mdoc *mdoc, int line, int tok,
        /* FIXME: whitespace if no value. */
 
        ppos = *pos;
        /* FIXME: whitespace if no value. */
 
        ppos = *pos;

-       if ( ! parse(mdoc, line, v, pos, buf))
+       if ( ! argv(mdoc, line, v, pos, buf))

                return(ARGV_ERROR);
                return(ARGV_ERROR);

-       if ( ! postparse(mdoc, line, v, ppos))
+       if ( ! postargv(mdoc, line, v, ppos))

                return(ARGV_ERROR);
 
        return(ARGV_ARG);
                return(ARGV_ERROR);
 
        return(ARGV_ARG);