]> git.cameronkatri.com Git - mandoc.git/blobdiff - mdoc_argv.c
Show the flags MDOC_DELIMO, MDOC_DELIMC, MDOC_EOS, and MAN_EOS.
[mandoc.git] / mdoc_argv.c
index cd5ab1f23b8fd1df7c26e86cd222b64fad34eff0..a223d295d42370206308a68f9fd9ed256ed4fb07 100644 (file)
@@ -1,23 +1,21 @@
-/*     $Id: mdoc_argv.c,v 1.94 2014/07/02 03:48:07 schwarze Exp $ */
+/*     $Id: mdoc_argv.c,v 1.104 2015/04/19 14:00:19 schwarze Exp $ */
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
 /*
  * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
- * Copyright (c) 2012 Ingo Schwarze <schwarze@openbsd.org>
+ * Copyright (c) 2012, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *
  *
  * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
  *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
-#ifdef HAVE_CONFIG_H
 #include "config.h"
 #include "config.h"
-#endif
 
 #include <sys/types.h>
 
 
 #include <sys/types.h>
 
 #include <stdio.h>
 #include <string.h>
 
 #include <stdio.h>
 #include <string.h>
 
-#include "mdoc.h"
-#include "mandoc.h"
 #include "mandoc_aux.h"
 #include "mandoc_aux.h"
-#include "libmdoc.h"
+#include "mandoc.h"
+#include "roff.h"
+#include "mdoc.h"
 #include "libmandoc.h"
 #include "libmandoc.h"
+#include "libmdoc.h"
 
 #define        MULTI_STEP       5 /* pre-allocate argument values */
 #define        DELIMSZ          6 /* max possible size of a delimiter */
 
 #define        MULTI_STEP       5 /* pre-allocate argument values */
 #define        DELIMSZ          6 /* max possible size of a delimiter */
@@ -53,12 +52,12 @@ struct      mdocarg {
 };
 
 static void             argn_free(struct mdoc_arg *, int);
 };
 
 static void             argn_free(struct mdoc_arg *, int);
-static enum margserr    args(struct mdoc *, int, int *,
+static enum margserr    args(struct roff_man *, int, int *,
                                char *, enum argsflag, char **);
 static int              args_checkpunct(const char *, int);
                                char *, enum argsflag, char **);
 static int              args_checkpunct(const char *, int);
-static int              argv_multi(struct mdoc *, int,
+static void             argv_multi(struct roff_man *, int,
                                struct mdoc_argv *, int *, char *);
                                struct mdoc_argv *, int *, char *);
-static int              argv_single(struct mdoc *, int,
+static void             argv_single(struct roff_man *, int,
                                struct mdoc_argv *, int *, char *);
 
 static const enum argvflag argvflags[MDOC_ARG_MAX] = {
                                struct mdoc_argv *, int *, char *);
 
 static const enum argvflag argvflags[MDOC_ARG_MAX] = {
@@ -272,100 +271,105 @@ static  const struct mdocarg mdocargs[MDOC_MAX] = {
 
 
 /*
 
 
 /*
- * Parse an argument from line text.  This comes in the form of -key
- * [value0...], which may either have a single mandatory value, at least
- * one mandatory value, an optional single value, or no value.
+ * Parse flags and their arguments from the input line.
+ * These come in the form -flag [argument ...].
+ * Some flags take no argument, some one, some multiple.
  */
  */
-enum margverr
-mdoc_argv(struct mdoc *mdoc, int line, enum mdoct tok,
-               struct mdoc_arg **v, int *pos, char *buf)
+void
+mdoc_argv(struct roff_man *mdoc, int line, int tok,
+       struct mdoc_arg **reta, int *pos, char *buf)
 {
 {
-       char             *p, sv;
-       struct mdoc_argv tmp;
-       struct mdoc_arg  *arg;
-       const enum mdocargt *ap;
+       struct mdoc_argv          tmpv;
+       struct mdoc_argv        **retv;
+       const enum mdocargt      *argtable;
+       char                     *argname;
+       int                       ipos, retc;
+       char                      savechar;
 
 
-       if ('\0' == buf[*pos])
-               return(ARGV_EOLN);
-       else if (NULL == (ap = mdocargs[tok].argvs))
-               return(ARGV_WORD);
-       else if ('-' != buf[*pos])
-               return(ARGV_WORD);
+       *reta = NULL;
 
 
-       /* Seek to the first unescaped space. */
+       /* Which flags does this macro support? */
 
 
-       p = &buf[++(*pos)];
+       argtable = mdocargs[tok].argvs;
+       if (argtable == NULL)
+               return;
 
 
-       assert(*pos > 0);
+       /* Loop over the flags on the input line. */
 
 
-       for ( ; buf[*pos] ; (*pos)++)
-               if (' ' == buf[*pos] && '\\' != buf[*pos - 1])
-                       break;
+       ipos = *pos;
+       while (buf[ipos] == '-') {
 
 
-       /*
-        * We want to nil-terminate the word to look it up (it's easier
-        * that way).  But we may not have a flag, in which case we need
-        * to restore the line as-is.  So keep around the stray byte,
-        * which we'll reset upon exiting (if necessary).
-        */
+               /* Seek to the first unescaped space. */
 
 
-       if ('\0' != (sv = buf[*pos]))
-               buf[(*pos)++] = '\0';
+               for (argname = buf + ++ipos; buf[ipos] != '\0'; ipos++)
+                       if (buf[ipos] == ' ' && buf[ipos - 1] != '\\')
+                               break;
 
 
-       /*
-        * Now look up the word as a flag.  Use temporary storage that
-        * we'll copy into the node's flags, if necessary.
-        */
+               /*
+                * We want to nil-terminate the word to look it up.
+                * But we may not have a flag, in which case we need
+                * to restore the line as-is.  So keep around the
+                * stray byte, which we'll reset upon exiting.
+                */
 
 
-       memset(&tmp, 0, sizeof(struct mdoc_argv));
+               if ((savechar = buf[ipos]) != '\0')
+                       buf[ipos++] = '\0';
 
 
-       tmp.line = line;
-       tmp.pos = *pos;
-       tmp.arg = MDOC_ARG_MAX;
+               /*
+                * Now look up the word as a flag.  Use temporary
+                * storage that we'll copy into the node's flags.
+                */
 
 
-       while (MDOC_ARG_MAX != (tmp.arg = *ap++))
-               if (0 == strcmp(p, mdoc_argnames[tmp.arg]))
+               while ((tmpv.arg = *argtable++) != MDOC_ARG_MAX)
+                       if ( ! strcmp(argname, mdoc_argnames[tmpv.arg]))
+                               break;
+
+               /* If it isn't a flag, restore the saved byte. */
+
+               if (tmpv.arg == MDOC_ARG_MAX) {
+                       if (savechar != '\0')
+                               buf[ipos - 1] = savechar;
                        break;
                        break;
+               }
 
 
-       if (MDOC_ARG_MAX == tmp.arg) {
-               /*
-                * The flag was not found.
-                * Restore saved zeroed byte and return as a word.
-                */
-               if (sv)
-                       buf[*pos - 1] = sv;
-               return(ARGV_WORD);
-       }
+               /* Read to the next word (the first argument). */
 
 
-       /* Read to the next word (the argument). */
-
-       while (buf[*pos] && ' ' == buf[*pos])
-               (*pos)++;
-
-       switch (argvflags[tmp.arg]) {
-       case ARGV_SINGLE:
-               if ( ! argv_single(mdoc, line, &tmp, pos, buf))
-                       return(ARGV_ERROR);
-               break;
-       case ARGV_MULTI:
-               if ( ! argv_multi(mdoc, line, &tmp, pos, buf))
-                       return(ARGV_ERROR);
-               break;
-       case ARGV_NONE:
-               break;
-       }
+               while (buf[ipos] == ' ')
+                       ipos++;
+
+               /* Parse the arguments of the flag. */
 
 
-       if (NULL == (arg = *v))
-               arg = *v = mandoc_calloc(1, sizeof(struct mdoc_arg));
+               tmpv.line  = line;
+               tmpv.pos   = *pos;
+               tmpv.sz    = 0;
+               tmpv.value = NULL;
+
+               switch (argvflags[tmpv.arg]) {
+               case ARGV_SINGLE:
+                       argv_single(mdoc, line, &tmpv, &ipos, buf);
+                       break;
+               case ARGV_MULTI:
+                       argv_multi(mdoc, line, &tmpv, &ipos, buf);
+                       break;
+               case ARGV_NONE:
+                       break;
+               }
 
 
-       arg->argc++;
-       arg->argv = mandoc_reallocarray(arg->argv,
-           arg->argc, sizeof(struct mdoc_argv));
+               /* Append to the return values. */
 
 
-       memcpy(&arg->argv[(int)arg->argc - 1], &tmp,
-           sizeof(struct mdoc_argv));
+               if (*reta == NULL)
+                       *reta = mandoc_calloc(1, sizeof(**reta));
 
 
-       return(ARGV_ARG);
+               retc = ++(*reta)->argc;
+               retv = &(*reta)->argv;
+               *retv = mandoc_reallocarray(*retv, retc, sizeof(**retv));
+               memcpy(*retv + retc - 1, &tmpv, sizeof(**retv));
+
+               /* Prepare for parsing the next flag. */
+
+               *pos = ipos;
+               argtable = mdocargs[tok].argvs;
+       }
 }
 
 void
 }
 
 void
@@ -409,22 +413,17 @@ argn_free(struct mdoc_arg *p, int iarg)
 }
 
 enum margserr
 }
 
 enum margserr
-mdoc_zargs(struct mdoc *mdoc, int line, int *pos, char *buf, char **v)
-{
-
-       return(args(mdoc, line, pos, buf, ARGSFL_NONE, v));
-}
-
-enum margserr
-mdoc_args(struct mdoc *mdoc, int line, int *pos,
-               char *buf, enum mdoct tok, char **v)
+mdoc_args(struct roff_man *mdoc, int line, int *pos,
+       char *buf, int tok, char **v)
 {
 {
+       struct roff_node *n;
+       char             *v_local;
        enum argsflag     fl;
        enum argsflag     fl;
-       struct mdoc_node *n;
-
-       fl = mdocargs[tok].flags;
 
 
-       if (MDOC_It != tok)
+       if (v == NULL)
+               v = &v_local;
+       fl = tok == TOKEN_NONE ? ARGSFL_NONE : mdocargs[tok].flags;
+       if (tok != MDOC_It)
                return(args(mdoc, line, pos, buf, fl, v));
 
        /*
                return(args(mdoc, line, pos, buf, fl, v));
 
        /*
@@ -445,7 +444,7 @@ mdoc_args(struct mdoc *mdoc, int line, int *pos,
 }
 
 static enum margserr
 }
 
 static enum margserr
-args(struct mdoc *mdoc, int line, int *pos,
+args(struct roff_man *mdoc, int line, int *pos,
                char *buf, enum argsflag fl, char **v)
 {
        char            *p, *pp;
                char *buf, enum argsflag fl, char **v)
 {
        char            *p, *pp;
@@ -461,7 +460,8 @@ args(struct mdoc *mdoc, int line, int *pos,
                 * is unterminated.
                 */
                if (MDOC_PHRASELIT & mdoc->flags)
                 * is unterminated.
                 */
                if (MDOC_PHRASELIT & mdoc->flags)
-                       mdoc_pmsg(mdoc, line, *pos, MANDOCERR_BADQUOTE);
+                       mandoc_msg(MANDOCERR_ARG_QUOTE,
+                           mdoc->parse, line, *pos, NULL);
 
                mdoc->flags &= ~MDOC_PHRASELIT;
                return(ARGS_EOLN);
 
                mdoc->flags &= ~MDOC_PHRASELIT;
                return(ARGS_EOLN);
@@ -520,7 +520,8 @@ args(struct mdoc *mdoc, int line, int *pos,
 
                /* Whitespace check for eoln case... */
                if ('\0' == *p && ' ' == *(p - 1))
 
                /* Whitespace check for eoln case... */
                if ('\0' == *p && ' ' == *(p - 1))
-                       mdoc_pmsg(mdoc, line, *pos, MANDOCERR_EOLNSPACE);
+                       mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
+                           line, *pos, NULL);
 
                *pos += (int)(p - *v);
 
 
                *pos += (int)(p - *v);
 
@@ -575,7 +576,8 @@ args(struct mdoc *mdoc, int line, int *pos,
                if ('\0' == buf[*pos]) {
                        if (MDOC_PPHRASE & mdoc->flags)
                                return(ARGS_QWORD);
                if ('\0' == buf[*pos]) {
                        if (MDOC_PPHRASE & mdoc->flags)
                                return(ARGS_QWORD);
-                       mdoc_pmsg(mdoc, line, *pos, MANDOCERR_BADQUOTE);
+                       mandoc_msg(MANDOCERR_ARG_QUOTE,
+                           mdoc->parse, line, *pos, NULL);
                        return(ARGS_QWORD);
                }
 
                        return(ARGS_QWORD);
                }
 
@@ -589,7 +591,8 @@ args(struct mdoc *mdoc, int line, int *pos,
                        (*pos)++;
 
                if ('\0' == buf[*pos])
                        (*pos)++;
 
                if ('\0' == buf[*pos])
-                       mdoc_pmsg(mdoc, line, *pos, MANDOCERR_EOLNSPACE);
+                       mandoc_msg(MANDOCERR_SPACE_EOL, mdoc->parse,
+                           line, *pos, NULL);
 
                return(ARGS_QWORD);
        }
 
                return(ARGS_QWORD);
        }
@@ -650,48 +653,40 @@ args_checkpunct(const char *buf, int i)
        return('\0' == buf[i]);
 }
 
        return('\0' == buf[i]);
 }
 
-static int
-argv_multi(struct mdoc *mdoc, int line,
+static void
+argv_multi(struct roff_man *mdoc, int line,
                struct mdoc_argv *v, int *pos, char *buf)
 {
        enum margserr    ac;
        char            *p;
 
        for (v->sz = 0; ; v->sz++) {
                struct mdoc_argv *v, int *pos, char *buf)
 {
        enum margserr    ac;
        char            *p;
 
        for (v->sz = 0; ; v->sz++) {
-               if ('-' == buf[*pos])
+               if (buf[*pos] == '-')
                        break;
                ac = args(mdoc, line, pos, buf, ARGSFL_NONE, &p);
                        break;
                ac = args(mdoc, line, pos, buf, ARGSFL_NONE, &p);
-               if (ARGS_ERROR == ac)
-                       return(0);
-               else if (ARGS_EOLN == ac)
+               if (ac == ARGS_EOLN)
                        break;
 
                        break;
 
-               if (0 == v->sz % MULTI_STEP)
+               if (v->sz % MULTI_STEP == 0)
                        v->value = mandoc_reallocarray(v->value,
                            v->sz + MULTI_STEP, sizeof(char *));
 
                v->value[(int)v->sz] = mandoc_strdup(p);
        }
                        v->value = mandoc_reallocarray(v->value,
                            v->sz + MULTI_STEP, sizeof(char *));
 
                v->value[(int)v->sz] = mandoc_strdup(p);
        }
-
-       return(1);
 }
 
 }
 
-static int
-argv_single(struct mdoc *mdoc, int line,
+static void
+argv_single(struct roff_man *mdoc, int line,
                struct mdoc_argv *v, int *pos, char *buf)
 {
        enum margserr    ac;
        char            *p;
 
        ac = args(mdoc, line, pos, buf, ARGSFL_NONE, &p);
                struct mdoc_argv *v, int *pos, char *buf)
 {
        enum margserr    ac;
        char            *p;
 
        ac = args(mdoc, line, pos, buf, ARGSFL_NONE, &p);
-       if (ARGS_ERROR == ac)
-               return(0);
-       if (ARGS_EOLN == ac)
-               return(1);
+       if (ac == ARGS_EOLN)
+               return;
 
        v->sz = 1;
        v->value = mandoc_malloc(sizeof(char *));
        v->value[0] = mandoc_strdup(p);
 
        v->sz = 1;
        v->value = mandoc_malloc(sizeof(char *));
        v->value[0] = mandoc_strdup(p);
-
-       return(1);
 }
 }