]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_argv.c
Make args_checkpunct() use mdoc_isdelim() instead of mdoc_iscdelim(),
[mandoc.git] / mdoc_argv.c
index 2d9ed2d161b0eaecdd581a32d242955ff3de78c7..dc28916ca34ce46d3f2021ac391a57a1e37f8422 100644 (file)
@@ -1,6 +1,6 @@
-/*     $Id: mdoc_argv.c,v 1.33 2010/01/01 17:14:29 kristaps Exp $ */
+/*     $Id: mdoc_argv.c,v 1.65 2011/03/17 01:23:28 kristaps Exp $ */
 /*
- * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
+ * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
@@ -26,6 +26,7 @@
 #include <stdio.h>
 #include <string.h>
 
+#include "mandoc.h"
 #include "libmdoc.h"
 #include "libmandoc.h"
 
 
 #define        MULTI_STEP       5
 
-static int              argv_a2arg(int, const char *);
-static int              args(struct mdoc *, int, int *, 
+static enum mdocargt    argv_a2arg(enum mdoct, const char *);
+static enum margserr    args(struct mdoc *, int, int *, 
                                char *, int, char **);
+static int              args_checkpunct(const char *);
 static int              argv(struct mdoc *, int, 
                                struct mdoc_argv *, int *, char *);
 static int              argv_single(struct mdoc *, int, 
@@ -94,7 +96,7 @@ static        int mdoc_argflags[MDOC_MAX] = {
        0, /* Os */
        0, /* Sh */
        0, /* Ss */ 
-       ARGS_DELIM, /* Pp */ 
+       0, /* Pp */ 
        ARGS_DELIM, /* D1 */
        ARGS_DELIM, /* Dl */
        0, /* Bd */
@@ -195,7 +197,7 @@ static      int mdoc_argflags[MDOC_MAX] = {
        0, /* Fr */
        0, /* Ud */
        0, /* Lb */
-       ARGS_DELIM, /* Lp */
+       0, /* Lp */
        ARGS_DELIM, /* Lk */
        ARGS_DELIM, /* Mt */
        ARGS_DELIM, /* Brq */
@@ -209,6 +211,7 @@ static      int mdoc_argflags[MDOC_MAX] = {
        0, /* br */
        0, /* sp */
        0, /* %U */
+       0, /* Ta */
 };
 
 
@@ -217,15 +220,15 @@ static    int mdoc_argflags[MDOC_MAX] = {
  * [value0...], which may either have a single mandatory value, at least
  * one mandatory value, an optional single value, or no value.
  */
-int
-mdoc_argv(struct mdoc *m, int line, int tok,
+enum margverr
+mdoc_argv(struct mdoc *m, int line, enum mdoct tok,
                struct mdoc_arg **v, int *pos, char *buf)
 {
        char             *p, sv;
        struct mdoc_argv tmp;
        struct mdoc_arg  *arg;
 
-       if (0 == buf[*pos])
+       if ('\0' == buf[*pos])
                return(ARGV_EOLN);
 
        assert(' ' != buf[*pos]);
@@ -246,10 +249,10 @@ mdoc_argv(struct mdoc *m, int line, int tok,
 
        /* XXX - save zeroed byte, if not an argument. */
 
-       sv = 0;
+       sv = '\0';
        if (buf[*pos]) {
                sv = buf[*pos];
-               buf[(*pos)++] = 0;
+               buf[(*pos)++] = '\0';
        }
 
        (void)memset(&tmp, 0, sizeof(struct mdoc_argv));
@@ -288,7 +291,7 @@ mdoc_argv(struct mdoc *m, int line, int tok,
 void
 mdoc_argv_free(struct mdoc_arg *p)
 {
-       int              i, j;
+       int              i;
 
        if (NULL == p)
                return;
@@ -300,27 +303,34 @@ mdoc_argv_free(struct mdoc_arg *p)
        }
        assert(p->argc);
 
-       /* LINTED */
-       for (i = 0; i < (int)p->argc; i++) {
-               if (0 == p->argv[i].sz)
-                       continue;
-               if (NULL == p->argv[i].value)
-                       continue;
-
-               /* LINTED */
-               for (j = 0; j < (int)p->argv[i].sz; j++) 
-                       if (p->argv[i].value[j])
-                               free(p->argv[i].value[j]);
-
-               free(p->argv[i].value);
-       }
+       for (i = (int)p->argc - 1; i >= 0; i--)
+               mdoc_argn_free(p, i);
 
        free(p->argv);
        free(p);
 }
 
 
-int
+void
+mdoc_argn_free(struct mdoc_arg *p, int iarg)
+{
+       struct mdoc_argv *arg;
+       int               j;
+
+       arg = &p->argv[iarg];
+
+       if (arg->sz && arg->value) {
+               for (j = (int)arg->sz - 1; j >= 0; j--) 
+                       free(arg->value[j]);
+               free(arg->value);
+       }
+
+       for (--p->argc; iarg < (int)p->argc; iarg++)
+               p->argv[iarg] = p->argv[iarg+1];
+}
+
+
+enum margserr
 mdoc_zargs(struct mdoc *m, int line, int *pos, 
                char *buf, int flags, char **v)
 {
@@ -329,50 +339,45 @@ mdoc_zargs(struct mdoc *m, int line, int *pos,
 }
 
 
-int
-mdoc_args(struct mdoc *m, int line, 
-               int *pos, char *buf, int tok, char **v)
+enum margserr
+mdoc_args(struct mdoc *m, int line, int *pos, 
+               char *buf, enum mdoct tok, char **v)
 {
-       int               fl, c, i;
+       int               fl;
        struct mdoc_node *n;
 
-       fl = (0 == tok) ? 0 : mdoc_argflags[tok];
+       fl = mdoc_argflags[tok];
 
        if (MDOC_It != tok)
                return(args(m, line, pos, buf, fl, v));
 
-       /* 
-        * The `It' macro is a special case, as it acquires parameters from its
-        * parent `Bl' context, specifically, we're concerned with -column.
+       /*
+        * We know that we're in an `It', so it's reasonable to expect
+        * us to be sitting in a `Bl'.  Someday this may not be the case
+        * (if we allow random `It's sitting out there), so provide a
+        * safe fall-back into the default behaviour.
         */
 
        for (n = m->last; n; n = n->parent)
-               if (MDOC_BLOCK == n->type && MDOC_Bl == n->tok)
+               if (MDOC_Bl == n->tok)
                        break;
 
-       assert(n);
-       c = (int)(n->args ? n->args->argc : 0);
-       assert(c > 0);
-
-       /* LINTED */
-       for (i = 0; i < c; i++) {
-               if (MDOC_Column != n->args->argv[i].arg) 
-                       continue;
+       if (n && LIST_column == n->norm->Bl.type) {
                fl |= ARGS_TABSEP;
                fl &= ~ARGS_DELIM;
-               break;
        }
 
        return(args(m, line, pos, buf, fl, v));
 }
 
 
-static int
+static enum margserr
 args(struct mdoc *m, int line, int *pos, 
                char *buf, int fl, char **v)
 {
-       int               i;
-       char             *p, *pp;
+       int              i;
+       char            *p, *pp;
+       enum margserr    rc;
 
        /*
         * Parse out the terms (like `val' in `.Xx -arg val' or simply
@@ -389,44 +394,38 @@ args(struct mdoc *m, int line, int *pos,
         *   phrases like in `Bl -column'.
         */
 
-       assert(*pos);
        assert(' ' != buf[*pos]);
 
-       if (0 == buf[*pos])
-               return(ARGS_EOLN);
+       if ('\0' == buf[*pos]) {
+               if (MDOC_PPHRASE & m->flags)
+                       return(ARGS_EOLN);
+               /*
+                * If we're not in a partial phrase and the flag for
+                * being a phrase literal is still set, the punctuation
+                * is unterminated.
+                */
+               if (MDOC_PHRASELIT & m->flags)
+                       if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_BADQUOTE))
+                               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
-        * follows the pattern of [[::delim::][ ]+]+.
-        */
+               m->flags &= ~MDOC_PHRASELIT;
+               return(ARGS_EOLN);
+       }
 
-       if ((fl & ARGS_DELIM) && mdoc_iscdelim(buf[*pos])) {
-               for (i = *pos; buf[i]; ) {
-                       if ( ! mdoc_iscdelim(buf[i]))
-                               break;
-                       i++;
-                       if (0 == buf[i] || ' ' != buf[i])
-                               break;
-                       i++;
-                       while (buf[i] && ' ' == buf[i])
-                               i++;
-               }
+       *v = &buf[*pos];
 
-               if (0 == buf[i]) {
-                       *v = &buf[*pos];
-                       if (' ' != buf[i - 1])
-                               return(ARGS_PUNCT);
-                       if (ARGS_NOWARN & fl)
-                               return(ARGS_PUNCT);
-                       if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
-                               return(ARGS_ERROR);
+       if (ARGS_DELIM & fl && args_checkpunct(&buf[*pos])) {
+               i = strlen(&buf[*pos]) + *pos;
+               if (i && ' ' != buf[i - 1])
                        return(ARGS_PUNCT);
-               }
+               if (ARGS_NOWARN & fl)
+                       return(ARGS_PUNCT);
+               /* FIXME: remove conditional messages... */
+               if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE))
+                       return(ARGS_ERROR);
+               return(ARGS_PUNCT);
        }
 
-       *v = &buf[*pos];
-
        /*
         * First handle TABSEP items, restricted to `Bl -column'.  This
         * ignores conventional token parsing and instead uses tabs or
@@ -437,16 +436,21 @@ args(struct mdoc *m, int line, int *pos,
        if (ARGS_TABSEP & fl) {
                /* Scan ahead to tab (can't be escaped). */
                p = strchr(*v, '\t');
+               pp = NULL;
 
                /* Scan ahead to unescaped `Ta'. */
-               for (pp = *v; ; pp++) {
-                       if (NULL == (pp = strstr(pp, "Ta")))
-                               break;
-                       if (pp > *v && ' ' != *(pp - 1))
-                               continue;
-                       if (' ' == *(pp + 2) || 0 == *(pp + 2))
-                               break;
-               }
+               if ( ! (MDOC_PHRASELIT & m->flags)) 
+                       for (pp = *v; ; pp++) {
+                               if (NULL == (pp = strstr(pp, "Ta")))
+                                       break;
+                               if (pp > *v && ' ' != *(pp - 1))
+                                       continue;
+                               if (' ' == *(pp + 2) || '\0' == *(pp + 2))
+                                       break;
+                       }
+
+               /* By default, assume a phrase. */
+               rc = ARGS_PHRASE;
 
                /* 
                 * Adjust new-buffer position to be beyond delimiter
@@ -454,18 +458,22 @@ args(struct mdoc *m, int line, int *pos,
                 */
                if (p && pp) {
                        *pos += pp < p ? 2 : 1;
+                       rc = pp < p ? ARGS_PHRASE : ARGS_PPHRASE;
                        p = pp < p ? pp : p;
                } else if (p && ! pp) {
+                       rc = ARGS_PPHRASE;
                        *pos += 1;
                } else if (pp && ! p) {
                        p = pp;
                        *pos += 2;
-               } else
+               } else {
+                       rc = ARGS_PEND;
                        p = strchr(*v, 0);
+               }
 
                /* Whitespace check for eoln case... */
-               if (0 == *p && ' ' == *(p - 1) && ! (ARGS_NOWARN & fl))
-                       if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+               if ('\0' == *p && ' ' == *(p - 1) && ! (ARGS_NOWARN & fl))
+                       if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE))
                                return(ARGS_ERROR);
 
                *pos += (int)(p - *v);
@@ -483,7 +491,7 @@ args(struct mdoc *m, int line, int *pos,
                for (pp = &buf[*pos]; ' ' == *pp; pp++, (*pos)++)
                        /* Skip ahead. */ ;
 
-               return(ARGS_PHRASE);
+               return(rc);
        } 
 
        /* 
@@ -492,8 +500,12 @@ args(struct mdoc *m, int line, int *pos,
         * Whitespace is NOT involved in literal termination.
         */
 
-       if ('\"' == buf[*pos]) {
-               *v = &buf[++(*pos)];
+       if (MDOC_PHRASELIT & m->flags || '\"' == buf[*pos]) {
+               if ( ! (MDOC_PHRASELIT & m->flags))
+                       *v = &buf[++(*pos)];
+
+               if (MDOC_PPHRASE & m->flags)
+                       m->flags |= MDOC_PHRASELIT;
 
                for ( ; buf[*pos]; (*pos)++) {
                        if ('\"' != buf[*pos])
@@ -503,24 +515,25 @@ args(struct mdoc *m, int line, int *pos,
                        (*pos)++;
                }
 
-               if (0 == buf[*pos]) {
-                       if (ARGS_NOWARN & fl)
+               if ('\0' == buf[*pos]) {
+                       if (ARGS_NOWARN & fl || MDOC_PPHRASE & m->flags)
                                return(ARGS_QWORD);
-                       if ( ! mdoc_pwarn(m, line, *pos, EQUOTTERM))
+                       if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_BADQUOTE))
                                return(ARGS_ERROR);
                        return(ARGS_QWORD);
                }
 
-               buf[(*pos)++] = 0;
+               m->flags &= ~MDOC_PHRASELIT;
+               buf[(*pos)++] = '\0';
 
-               if (0 == buf[*pos])
+               if ('\0' == buf[*pos])
                        return(ARGS_QWORD);
 
                while (' ' == buf[*pos])
                        (*pos)++;
 
                if (0 == buf[*pos] && ! (ARGS_NOWARN & fl))
-                       if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+                       if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE))
                                return(ARGS_ERROR);
 
                return(ARGS_QWORD);
@@ -532,121 +545,142 @@ args(struct mdoc *m, int line, int *pos,
         */
 
        for ( ; buf[*pos]; (*pos)++)
-               if (' ' == buf[*pos] && '\\' != buf[*pos - 1])
+               if (*pos && ' ' == buf[*pos] && '\\' != buf[*pos - 1])
                        break;
 
-       if (0 == buf[*pos])
+       if ('\0' == buf[*pos])
                return(ARGS_WORD);
 
-       buf[(*pos)++] = 0;
+       buf[(*pos)++] = '\0';
 
        while (' ' == buf[*pos])
                (*pos)++;
 
-       if (0 == buf[*pos] && ! (ARGS_NOWARN & fl))
-               if ( ! mdoc_pwarn(m, line, *pos, ETAILWS))
+       if ('\0' == buf[*pos] && ! (ARGS_NOWARN & fl))
+               if ( ! mdoc_pmsg(m, line, *pos, MANDOCERR_EOLNSPACE))
                        return(ARGS_ERROR);
 
        return(ARGS_WORD);
 }
 
-
+/* 
+ * Check if the string consists only of space-separated closing
+ * delimiters.  This is a bit of a dance: the first must be a close
+ * delimiter, but it may be followed by middle delimiters.  Arbitrary
+ * whitespace may separate these tokens.
+ */
 static int
-argv_a2arg(int tok, const char *p)
+args_checkpunct(const char *p)
 {
+       int              i, j;
+       char             buf[DELIMSZ];
+       enum mdelim      d;
 
-       /*
-        * Parse an argument identifier from its text.  XXX - this
-        * should really be table-driven to clarify the code.
-        *
-        * If you add an argument to the list, make sure that you
-        * register it here with its one or more macros!
-        */
+       i = 0;
+
+       /* First token must be a close-delimiter. */
+
+       for (j = 0; p[i] && ' ' != p[i] && j < DELIMSZ; j++, i++)
+               buf[j] = p[i];
+
+       if (DELIMSZ == j)
+               return(0);
+
+       buf[j] = '\0';
+       if (DELIM_CLOSE != mdoc_isdelim(buf))
+               return(0);
+
+       while (' ' == p[i])
+               i++;
+
+       /* Remaining must NOT be open/none. */
+       
+       while (p[i]) {
+               j = 0;
+               while (p[i] && ' ' != p[i] && j < DELIMSZ)
+                       buf[j++] = p[i++];
+
+               if (DELIMSZ == j)
+                       return(0);
+
+               buf[j] = '\0';
+               d = mdoc_isdelim(buf);
+               if (DELIM_NONE == d || DELIM_OPEN == d)
+                       return(0);
+
+               while (' ' == p[i])
+                       i++;
+       }
+
+       return('\0' == p[i]);
+}
+
+/*
+ * Match up an argument string (e.g., `-foo bar' having "foo") with the
+ * correrct identifier.  It must apply to the given macro.  If none was
+ * found (including bad matches), return MDOC_ARG_MAX.
+ */
+static enum mdocargt
+argv_a2arg(enum mdoct tok, const char *p)
+{
+       enum mdocargt    args[MDOC_ARG_MAX];
+       int              i, len;
+
+       len = 0;
 
        switch (tok) {
        case (MDOC_An):
-               if (0 == strcmp(p, "split"))
-                       return(MDOC_Split);
-               else if (0 == strcmp(p, "nosplit"))
-                       return(MDOC_Nosplit);
+               args[len++] = MDOC_Split;
+               args[len++] = MDOC_Nosplit;
                break;
-
        case (MDOC_Bd):
-               if (0 == strcmp(p, "ragged"))
-                       return(MDOC_Ragged);
-               else if (0 == strcmp(p, "unfilled"))
-                       return(MDOC_Unfilled);
-               else if (0 == strcmp(p, "filled"))
-                       return(MDOC_Filled);
-               else if (0 == strcmp(p, "literal"))
-                       return(MDOC_Literal);
-               else if (0 == strcmp(p, "file"))
-                       return(MDOC_File);
-               else if (0 == strcmp(p, "offset"))
-                       return(MDOC_Offset);
-               else if (0 == strcmp(p, "compact"))
-                       return(MDOC_Compact);
-               else if (0 == strcmp(p, "centered"))
-                       return(MDOC_Centred);
+               args[len++] = MDOC_Ragged;
+               args[len++] = MDOC_Unfilled;
+               args[len++] = MDOC_Filled;
+               args[len++] = MDOC_Literal;
+               args[len++] = MDOC_File;
+               args[len++] = MDOC_Offset;
+               args[len++] = MDOC_Compact;
+               args[len++] = MDOC_Centred;
                break;
-
        case (MDOC_Bf):
-               if (0 == strcmp(p, "emphasis"))
-                       return(MDOC_Emphasis);
-               else if (0 == strcmp(p, "literal"))
-                       return(MDOC_Literal);
-               else if (0 == strcmp(p, "symbolic"))
-                       return(MDOC_Symbolic);
+               args[len++] = MDOC_Emphasis;
+               args[len++] = MDOC_Literal;
+               args[len++] = MDOC_Symbolic;
                break;
-
        case (MDOC_Bk):
-               if (0 == strcmp(p, "words"))
-                       return(MDOC_Words);
+               args[len++] = MDOC_Words;
                break;
-
        case (MDOC_Bl):
-               if (0 == strcmp(p, "bullet"))
-                       return(MDOC_Bullet);
-               else if (0 == strcmp(p, "dash"))
-                       return(MDOC_Dash);
-               else if (0 == strcmp(p, "hyphen"))
-                       return(MDOC_Hyphen);
-               else if (0 == strcmp(p, "item"))
-                       return(MDOC_Item);
-               else if (0 == strcmp(p, "enum"))
-                       return(MDOC_Enum);
-               else if (0 == strcmp(p, "tag"))
-                       return(MDOC_Tag);
-               else if (0 == strcmp(p, "diag"))
-                       return(MDOC_Diag);
-               else if (0 == strcmp(p, "hang"))
-                       return(MDOC_Hang);
-               else if (0 == strcmp(p, "ohang"))
-                       return(MDOC_Ohang);
-               else if (0 == strcmp(p, "inset"))
-                       return(MDOC_Inset);
-               else if (0 == strcmp(p, "column"))
-                       return(MDOC_Column);
-               else if (0 == strcmp(p, "width"))
-                       return(MDOC_Width);
-               else if (0 == strcmp(p, "offset"))
-                       return(MDOC_Offset);
-               else if (0 == strcmp(p, "compact"))
-                       return(MDOC_Compact);
-               else if (0 == strcmp(p, "nested"))
-                       return(MDOC_Nested);
+               args[len++] = MDOC_Bullet;
+               args[len++] = MDOC_Dash;
+               args[len++] = MDOC_Hyphen;
+               args[len++] = MDOC_Item;
+               args[len++] = MDOC_Enum;
+               args[len++] = MDOC_Tag;
+               args[len++] = MDOC_Diag;
+               args[len++] = MDOC_Hang;
+               args[len++] = MDOC_Ohang;
+               args[len++] = MDOC_Inset;
+               args[len++] = MDOC_Column;
+               args[len++] = MDOC_Width;
+               args[len++] = MDOC_Offset;
+               args[len++] = MDOC_Compact;
+               args[len++] = MDOC_Nested;
                break;
-       
        case (MDOC_Rv):
                /* FALLTHROUGH */
        case (MDOC_Ex):
-               if (0 == strcmp(p, "std"))
-                       return(MDOC_Std);
+               args[len++] = MDOC_Std;
                break;
        default:
                break;
        }
 
+       for (i = 0; i < len; i++)
+               if (0 == strcmp(p, mdoc_argnames[args[i]]))
+                       return(args[i]);
+
        return(MDOC_ARG_MAX);
 }
 
@@ -655,16 +689,16 @@ static int
 argv_multi(struct mdoc *m, int line, 
                struct mdoc_argv *v, int *pos, char *buf)
 {
-       int              c;
+       enum margserr    ac;
        char            *p;
 
        for (v->sz = 0; ; v->sz++) {
                if ('-' == buf[*pos])
                        break;
-               c = args(m, line, pos, buf, 0, &p);
-               if (ARGS_ERROR == c)
+               ac = args(m, line, pos, buf, 0, &p);
+               if (ARGS_ERROR == ac)
                        return(0);
-               else if (ARGS_EOLN == c)
+               else if (ARGS_EOLN == ac)
                        break;
 
                if (0 == v->sz % MULTI_STEP)
@@ -682,16 +716,16 @@ static int
 argv_opt_single(struct mdoc *m, int line, 
                struct mdoc_argv *v, int *pos, char *buf)
 {
-       int              c;
+       enum margserr    ac;
        char            *p;
 
        if ('-' == buf[*pos])
                return(1);
 
-       c = args(m, line, pos, buf, 0, &p);
-       if (ARGS_ERROR == c)
+       ac = args(m, line, pos, buf, 0, &p);
+       if (ARGS_ERROR == ac)
                return(0);
-       if (ARGS_EOLN == c)
+       if (ARGS_EOLN == ac)
                return(1);
 
        v->sz = 1;
@@ -709,16 +743,18 @@ static int
 argv_single(struct mdoc *m, int line, 
                struct mdoc_argv *v, int *pos, char *buf)
 {
-       int              c, ppos;
+       int              ppos;
+       enum margserr    ac;
        char            *p;
 
        ppos = *pos;
 
-       c = args(m, line, pos, buf, 0, &p);
-       if (ARGS_ERROR == c)
+       ac = args(m, line, pos, buf, 0, &p);
+       if (ARGS_EOLN == ac) {
+               mdoc_pmsg(m, line, ppos, MANDOCERR_SYNTARGVCOUNT);
+               return(0);
+       } else if (ARGS_ERROR == ac)
                return(0);
-       if (ARGS_EOLN == c)
-               return(mdoc_perr(m, line, ppos, EARGVAL));
 
        v->sz = 1;
        v->value = mandoc_malloc(sizeof(char *));