add parse_pathspec() that converts cmdline args to struct pathspec
authorNguyễn Thái Ngọc Duy <pclouds@gmail.com>
Sun, 14 Jul 2013 08:35:28 +0000 (15:35 +0700)
committerJunio C Hamano <gitster@pobox.com>
Mon, 15 Jul 2013 17:56:06 +0000 (10:56 -0700)
Currently to fill a struct pathspec, we do:

   const char **paths;
   paths = get_pathspec(prefix, argv);
   ...
   init_pathspec(&pathspec, paths);

"paths" can only carry bare strings, which loses information from
command line arguments such as pathspec magic or the prefix part's
length for each argument.

parse_pathspec() is introduced to combine the two calls into one. The
plan is gradually replace all get_pathspec() and init_pathspec() with
parse_pathspec(). get_pathspec() now becomes a thin wrapper of
parse_pathspec().

parse_pathspec() allows the caller to reject the pathspec magics that
it does not support. When a new pathspec magic is introduced, we can
enable it per command after making sure that all underlying code has no
problem with the new magic.

"flags" parameter is currently unused. But it would allow callers to
pass certain instructions to parse_pathspec, for example forcing
literal pathspec when no magic is used.

With the introduction of parse_pathspec, there are now two functions
that can initialize struct pathspec: init_pathspec and
parse_pathspec. Any semantic changes in struct pathspec must be
reflected in both functions. init_pathspec() will be phased out in
favor of parse_pathspec().

Signed-off-by: Nguyễn Thái Ngọc Duy <pclouds@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/technical/api-setup.txt
dir.c
dir.h
pathspec.c
pathspec.h

index 4f63a04..90d1aff 100644 (file)
@@ -8,6 +8,23 @@ Talk about
 * is_inside_git_dir()
 * is_inside_work_tree()
 * setup_work_tree()
 * is_inside_git_dir()
 * is_inside_work_tree()
 * setup_work_tree()
-* get_pathspec()
 
 (Dscho)
 
 (Dscho)
+
+Pathspec
+--------
+
+See glossary-context.txt for the syntax of pathspec. In memory, a
+pathspec set is represented by "struct pathspec" and is prepared by
+parse_pathspec(). This function takes several arguments:
+
+- magic_mask specifies what features that are NOT supported by the
+  following code. If a user attempts to use such a feature,
+  parse_pathspec() can reject it early.
+
+- flags specifies other things that the caller wants parse_pathspec to
+  perform.
+
+- prefix and args come from cmd_* functions
+
+get_pathspec() is obsolete and should never be used in new code.
diff --git a/dir.c b/dir.c
index b0599dd..5f86e46 100644 (file)
--- a/dir.c
+++ b/dir.c
@@ -381,7 +381,7 @@ int match_pathspec_depth(const struct pathspec *ps,
 /*
  * Return the length of the "simple" part of a path match limiter.
  */
 /*
  * Return the length of the "simple" part of a path match limiter.
  */
-static int simple_length(const char *match)
+int simple_length(const char *match)
 {
        int len = -1;
 
 {
        int len = -1;
 
@@ -393,7 +393,7 @@ static int simple_length(const char *match)
        }
 }
 
        }
 }
 
-static int no_wildcard(const char *string)
+int no_wildcard(const char *string)
 {
        return string[simple_length(string)] == '\0';
 }
 {
        return string[simple_length(string)] == '\0';
 }
diff --git a/dir.h b/dir.h
index 3d6b80c..229ccc8 100644 (file)
--- a/dir.h
+++ b/dir.h
@@ -128,6 +128,8 @@ struct dir_struct {
 #define MATCHED_RECURSIVELY 1
 #define MATCHED_FNMATCH 2
 #define MATCHED_EXACTLY 3
 #define MATCHED_RECURSIVELY 1
 #define MATCHED_FNMATCH 2
 #define MATCHED_EXACTLY 3
+extern int simple_length(const char *match);
+extern int no_wildcard(const char *string);
 extern char *common_prefix(const char **pathspec);
 extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
 extern int match_pathspec_depth(const struct pathspec *pathspec,
 extern char *common_prefix(const char **pathspec);
 extern int match_pathspec(const char **pathspec, const char *name, int namelen, int prefix, char *seen);
 extern int match_pathspec_depth(const struct pathspec *pathspec,
index 8fe56cd..ce942db 100644 (file)
@@ -103,10 +103,6 @@ void die_if_path_beyond_symlink(const char *path, const char *prefix)
 /*
  * Magic pathspec
  *
 /*
  * Magic pathspec
  *
- * NEEDSWORK: These need to be moved to dir.h or even to a new
- * pathspec.h when we restructure get_pathspec() users to use the
- * "struct pathspec" interface.
- *
  * Possible future magic semantics include stuff like:
  *
  *     { PATHSPEC_NOGLOB, '!', "noglob" },
  * Possible future magic semantics include stuff like:
  *
  *     { PATHSPEC_NOGLOB, '!', "noglob" },
@@ -115,7 +111,6 @@ void die_if_path_beyond_symlink(const char *path, const char *prefix)
  *     { PATHSPEC_REGEXP, '\0', "regexp" },
  *
  */
  *     { PATHSPEC_REGEXP, '\0', "regexp" },
  *
  */
-#define PATHSPEC_FROMTOP    (1<<0)
 
 static struct pathspec_magic {
        unsigned bit;
 
 static struct pathspec_magic {
        unsigned bit;
@@ -127,7 +122,7 @@ static struct pathspec_magic {
 
 /*
  * Take an element of a pathspec and check for magic signatures.
 
 /*
  * Take an element of a pathspec and check for magic signatures.
- * Append the result to the prefix.
+ * Append the result to the prefix. Return the magic bitmap.
  *
  * For now, we only parse the syntax and throw out anything other than
  * "top" magic.
  *
  * For now, we only parse the syntax and throw out anything other than
  * "top" magic.
@@ -138,10 +133,15 @@ static struct pathspec_magic {
  * the prefix part must always match literally, and a single stupid
  * string cannot express such a case.
  */
  * the prefix part must always match literally, and a single stupid
  * string cannot express such a case.
  */
-static const char *prefix_pathspec(const char *prefix, int prefixlen, const char *elt)
+static unsigned prefix_pathspec(struct pathspec_item *item,
+                               unsigned *p_short_magic,
+                               const char **raw, unsigned flags,
+                               const char *prefix, int prefixlen,
+                               const char *elt)
 {
 {
-       unsigned magic = 0;
+       unsigned magic = 0, short_magic = 0;
        const char *copyfrom = elt;
        const char *copyfrom = elt;
+       char *match;
        int i;
 
        if (elt[0] != ':') {
        int i;
 
        if (elt[0] != ':') {
@@ -184,7 +184,7 @@ static const char *prefix_pathspec(const char *prefix, int prefixlen, const char
                                break;
                        for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++)
                                if (pathspec_magic[i].mnemonic == ch) {
                                break;
                        for (i = 0; i < ARRAY_SIZE(pathspec_magic); i++)
                                if (pathspec_magic[i].mnemonic == ch) {
-                                       magic |= pathspec_magic[i].bit;
+                                       short_magic |= pathspec_magic[i].bit;
                                        break;
                                }
                        if (ARRAY_SIZE(pathspec_magic) <= i)
                                        break;
                                }
                        if (ARRAY_SIZE(pathspec_magic) <= i)
@@ -195,15 +195,128 @@ static const char *prefix_pathspec(const char *prefix, int prefixlen, const char
                        copyfrom++;
        }
 
                        copyfrom++;
        }
 
+       magic |= short_magic;
+       *p_short_magic = short_magic;
+
        if (magic & PATHSPEC_FROMTOP)
        if (magic & PATHSPEC_FROMTOP)
-               return xstrdup(copyfrom);
+               match = xstrdup(copyfrom);
        else
        else
-               return prefix_path(prefix, prefixlen, copyfrom);
+               match = prefix_path(prefix, prefixlen, copyfrom);
+       *raw = item->match = match;
+       item->len = strlen(item->match);
+       if (limit_pathspec_to_literal())
+               item->nowildcard_len = item->len;
+       else
+               item->nowildcard_len = simple_length(item->match);
+       item->flags = 0;
+       if (item->nowildcard_len < item->len &&
+           item->match[item->nowildcard_len] == '*' &&
+           no_wildcard(item->match + item->nowildcard_len + 1))
+               item->flags |= PATHSPEC_ONESTAR;
+       return magic;
+}
+
+static int pathspec_item_cmp(const void *a_, const void *b_)
+{
+       struct pathspec_item *a, *b;
+
+       a = (struct pathspec_item *)a_;
+       b = (struct pathspec_item *)b_;
+       return strcmp(a->match, b->match);
+}
+
+static void NORETURN unsupported_magic(const char *pattern,
+                                      unsigned magic,
+                                      unsigned short_magic)
+{
+       struct strbuf sb = STRBUF_INIT;
+       int i, n;
+       for (n = i = 0; i < ARRAY_SIZE(pathspec_magic); i++) {
+               const struct pathspec_magic *m = pathspec_magic + i;
+               if (!(magic & m->bit))
+                       continue;
+               if (sb.len)
+                       strbuf_addstr(&sb, " ");
+               if (short_magic & m->bit)
+                       strbuf_addf(&sb, "'%c'", m->mnemonic);
+               else
+                       strbuf_addf(&sb, "'%s'", m->name);
+               n++;
+       }
+       /*
+        * We may want to substitute "this command" with a command
+        * name. E.g. when add--interactive dies when running
+        * "checkout -p"
+        */
+       die(_("%s: pathspec magic not supported by this command: %s"),
+           pattern, sb.buf);
+}
+
+/*
+ * Given command line arguments and a prefix, convert the input to
+ * pathspec. die() if any magic in magic_mask is used.
+ */
+void parse_pathspec(struct pathspec *pathspec,
+                   unsigned magic_mask, unsigned flags,
+                   const char *prefix, const char **argv)
+{
+       struct pathspec_item *item;
+       const char *entry = argv ? *argv : NULL;
+       int i, n, prefixlen;
+
+       memset(pathspec, 0, sizeof(*pathspec));
+
+       /* No arguments, no prefix -> no pathspec */
+       if (!entry && !prefix)
+               return;
+
+       /* No arguments with prefix -> prefix pathspec */
+       if (!entry) {
+               static const char *raw[2];
+
+               pathspec->items = item = xmalloc(sizeof(*item));
+               memset(item, 0, sizeof(*item));
+               item->match = prefix;
+               item->nowildcard_len = item->len = strlen(prefix);
+               raw[0] = prefix;
+               raw[1] = NULL;
+               pathspec->nr = 1;
+               pathspec->raw = raw;
+               return;
+       }
+
+       n = 0;
+       while (argv[n])
+               n++;
+
+       pathspec->nr = n;
+       pathspec->items = item = xmalloc(sizeof(*item) * n);
+       pathspec->raw = argv;
+       prefixlen = prefix ? strlen(prefix) : 0;
+
+       for (i = 0; i < n; i++) {
+               unsigned short_magic;
+               entry = argv[i];
+
+               item[i].magic = prefix_pathspec(item + i, &short_magic,
+                                               argv + i, flags,
+                                               prefix, prefixlen, entry);
+               if (item[i].magic & magic_mask)
+                       unsupported_magic(entry,
+                                         item[i].magic & magic_mask,
+                                         short_magic);
+               if (item[i].nowildcard_len < item[i].len)
+                       pathspec->has_wildcard = 1;
+               pathspec->magic |= item[i].magic;
+       }
+
+       qsort(pathspec->items, pathspec->nr,
+             sizeof(struct pathspec_item), pathspec_item_cmp);
 }
 
 /*
  * N.B. get_pathspec() is deprecated in favor of the "struct pathspec"
 }
 
 /*
  * N.B. get_pathspec() is deprecated in favor of the "struct pathspec"
- * based interface - see pathspec_magic above.
+ * based interface - see pathspec.c:parse_pathspec().
  *
  * Arguments:
  *  - prefix - a path relative to the root of the working tree
  *
  * Arguments:
  *  - prefix - a path relative to the root of the working tree
@@ -222,32 +335,11 @@ static const char *prefix_pathspec(const char *prefix, int prefixlen, const char
  */
 const char **get_pathspec(const char *prefix, const char **pathspec)
 {
  */
 const char **get_pathspec(const char *prefix, const char **pathspec)
 {
-       const char *entry = *pathspec;
-       const char **src, **dst;
-       int prefixlen;
-
-       if (!prefix && !entry)
-               return NULL;
-
-       if (!entry) {
-               static const char *spec[2];
-               spec[0] = prefix;
-               spec[1] = NULL;
-               return spec;
-       }
-
-       /* Otherwise we have to re-write the entries.. */
-       src = pathspec;
-       dst = pathspec;
-       prefixlen = prefix ? strlen(prefix) : 0;
-       while (*src) {
-               *(dst++) = prefix_pathspec(prefix, prefixlen, *src);
-               src++;
-       }
-       *dst = NULL;
-       if (!*pathspec)
-               return NULL;
-       return pathspec;
+       struct pathspec ps;
+       parse_pathspec(&ps,
+                      PATHSPEC_ALL_MAGIC & ~PATHSPEC_FROMTOP,
+                      0, prefix, pathspec);
+       return ps.raw;
 }
 
 void copy_pathspec(struct pathspec *dst, const struct pathspec *src)
 }
 
 void copy_pathspec(struct pathspec *dst, const struct pathspec *src)
index a621676..937ec91 100644 (file)
@@ -1,6 +1,10 @@
 #ifndef PATHSPEC_H
 #define PATHSPEC_H
 
 #ifndef PATHSPEC_H
 #define PATHSPEC_H
 
+/* Pathspec magic */
+#define PATHSPEC_FROMTOP       (1<<0)
+#define PATHSPEC_ALL_MAGIC PATHSPEC_FROMTOP
+
 #define PATHSPEC_ONESTAR 1     /* the pathspec pattern sastisfies GFNM_ONESTAR */
 
 struct pathspec {
 #define PATHSPEC_ONESTAR 1     /* the pathspec pattern sastisfies GFNM_ONESTAR */
 
 struct pathspec {
@@ -8,9 +12,11 @@ struct pathspec {
        int nr;
        unsigned int has_wildcard:1;
        unsigned int recursive:1;
        int nr;
        unsigned int has_wildcard:1;
        unsigned int recursive:1;
+       unsigned magic;
        int max_depth;
        struct pathspec_item {
                const char *match;
        int max_depth;
        struct pathspec_item {
                const char *match;
+               unsigned magic;
                int len;
                int nowildcard_len;
                int flags;
                int len;
                int nowildcard_len;
                int flags;
@@ -18,6 +24,11 @@ struct pathspec {
 };
 
 extern int init_pathspec(struct pathspec *, const char **);
 };
 
 extern int init_pathspec(struct pathspec *, const char **);
+extern void parse_pathspec(struct pathspec *pathspec,
+                          unsigned magic_mask,
+                          unsigned flags,
+                          const char *prefix,
+                          const char **args);
 extern void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
 extern void free_pathspec(struct pathspec *);
 
 extern void copy_pathspec(struct pathspec *dst, const struct pathspec *src);
 extern void free_pathspec(struct pathspec *);