builtin-show-ref.con commit Cleanup subcommand documentation for git-remote. (0f39087)
   1#include "cache.h"
   2#include "refs.h"
   3#include "object.h"
   4#include "tag.h"
   5#include "path-list.h"
   6
   7static const char show_ref_usage[] = "git show-ref [-q|--quiet] [--verify] [-h|--head] [-d|--dereference] [-s|--hash[=<length>]] [--abbrev[=<length>]] [--tags] [--heads] [--] [pattern*] < ref-list";
   8
   9static int deref_tags = 0, show_head = 0, tags_only = 0, heads_only = 0,
  10        found_match = 0, verify = 0, quiet = 0, hash_only = 0, abbrev = 0;
  11static const char **pattern;
  12
  13static void show_one(const char *refname, const unsigned char *sha1)
  14{
  15        const char *hex = find_unique_abbrev(sha1, abbrev);
  16        if (hash_only)
  17                printf("%s\n", hex);
  18        else
  19                printf("%s %s\n", hex, refname);
  20}
  21
  22static int show_ref(const char *refname, const unsigned char *sha1, int flag, void *cbdata)
  23{
  24        struct object *obj;
  25        const char *hex;
  26        unsigned char peeled[20];
  27
  28        if (tags_only || heads_only) {
  29                int match;
  30
  31                match = heads_only && !strncmp(refname, "refs/heads/", 11);
  32                match |= tags_only && !strncmp(refname, "refs/tags/", 10);
  33                if (!match)
  34                        return 0;
  35        }
  36        if (pattern) {
  37                int reflen = strlen(refname);
  38                const char **p = pattern, *m;
  39                while ((m = *p++) != NULL) {
  40                        int len = strlen(m);
  41                        if (len > reflen)
  42                                continue;
  43                        if (memcmp(m, refname + reflen - len, len))
  44                                continue;
  45                        if (len == reflen)
  46                                goto match;
  47                        /* "--verify" requires an exact match */
  48                        if (verify)
  49                                continue;
  50                        if (refname[reflen - len - 1] == '/')
  51                                goto match;
  52                }
  53                return 0;
  54        }
  55
  56match:
  57        found_match++;
  58
  59        /* This changes the semantics slightly that even under quiet we
  60         * detect and return error if the repository is corrupt and
  61         * ref points at a nonexistent object.
  62         */
  63        if (!has_sha1_file(sha1))
  64                die("git-show-ref: bad ref %s (%s)", refname,
  65                    sha1_to_hex(sha1));
  66
  67        if (quiet)
  68                return 0;
  69
  70        show_one(refname, sha1);
  71
  72        if (!deref_tags)
  73                return 0;
  74
  75        if ((flag & REF_ISPACKED) && !peel_ref(refname, peeled)) {
  76                if (!is_null_sha1(peeled)) {
  77                        hex = find_unique_abbrev(peeled, abbrev);
  78                        printf("%s %s^{}\n", hex, refname);
  79                }
  80        }
  81        else {
  82                obj = parse_object(sha1);
  83                if (!obj)
  84                        die("git-show-ref: bad ref %s (%s)", refname,
  85                            sha1_to_hex(sha1));
  86                if (obj->type == OBJ_TAG) {
  87                        obj = deref_tag(obj, refname, 0);
  88                        hex = find_unique_abbrev(obj->sha1, abbrev);
  89                        printf("%s %s^{}\n", hex, refname);
  90                }
  91        }
  92        return 0;
  93}
  94
  95static int add_existing(const char *refname, const unsigned char *sha1, int flag, void *cbdata)
  96{
  97        struct path_list *list = (struct path_list *)cbdata;
  98        path_list_insert(refname, list);
  99        return 0;
 100}
 101
 102/*
 103 * read "^(?:<anything>\s)?<refname>(?:\^\{\})?$" from the standard input,
 104 * and
 105 * (1) strip "^{}" at the end of line if any;
 106 * (2) ignore if match is provided and does not head-match refname;
 107 * (3) warn if refname is not a well-formed refname and skip;
 108 * (4) ignore if refname is a ref that exists in the local repository;
 109 * (5) otherwise output the line.
 110 */
 111static int exclude_existing(const char *match)
 112{
 113        static struct path_list existing_refs = { NULL, 0, 0, 0 };
 114        char buf[1024];
 115        int matchlen = match ? strlen(match) : 0;
 116
 117        for_each_ref(add_existing, &existing_refs);
 118        while (fgets(buf, sizeof(buf), stdin)) {
 119                char *ref;
 120                int len = strlen(buf);
 121
 122                if (len > 0 && buf[len - 1] == '\n')
 123                        buf[--len] = '\0';
 124                if (3 <= len && !strcmp(buf + len - 3, "^{}")) {
 125                        len -= 3;
 126                        buf[len] = '\0';
 127                }
 128                for (ref = buf + len; buf < ref; ref--)
 129                        if (isspace(ref[-1]))
 130                                break;
 131                if (match) {
 132                        int reflen = buf + len - ref;
 133                        if (reflen < matchlen)
 134                                continue;
 135                        if (strncmp(ref, match, matchlen))
 136                                continue;
 137                }
 138                if (check_ref_format(ref)) {
 139                        fprintf(stderr, "warning: ref '%s' ignored\n", ref);
 140                        continue;
 141                }
 142                if (!path_list_has_path(&existing_refs, ref)) {
 143                        printf("%s\n", buf);
 144                }
 145        }
 146        return 0;
 147}
 148
 149int cmd_show_ref(int argc, const char **argv, const char *prefix)
 150{
 151        int i;
 152
 153        for (i = 1; i < argc; i++) {
 154                const char *arg = argv[i];
 155                if (*arg != '-') {
 156                        pattern = argv + i;
 157                        break;
 158                }
 159                if (!strcmp(arg, "--")) {
 160                        pattern = argv + i + 1;
 161                        if (!*pattern)
 162                                pattern = NULL;
 163                        break;
 164                }
 165                if (!strcmp(arg, "-q") || !strcmp(arg, "--quiet")) {
 166                        quiet = 1;
 167                        continue;
 168                }
 169                if (!strcmp(arg, "-h") || !strcmp(arg, "--head")) {
 170                        show_head = 1;
 171                        continue;
 172                }
 173                if (!strcmp(arg, "-d") || !strcmp(arg, "--dereference")) {
 174                        deref_tags = 1;
 175                        continue;
 176                }
 177                if (!strcmp(arg, "-s") || !strcmp(arg, "--hash")) {
 178                        hash_only = 1;
 179                        continue;
 180                }
 181                if (!strncmp(arg, "--hash=", 7) ||
 182                    (!strncmp(arg, "--abbrev", 8) &&
 183                     (arg[8] == '=' || arg[8] == '\0'))) {
 184                        if (arg[2] != 'h' && !arg[8])
 185                                /* --abbrev only */
 186                                abbrev = DEFAULT_ABBREV;
 187                        else {
 188                                /* --hash= or --abbrev= */
 189                                char *end;
 190                                if (arg[2] == 'h') {
 191                                        hash_only = 1;
 192                                        arg += 7;
 193                                }
 194                                else
 195                                        arg += 9;
 196                                abbrev = strtoul(arg, &end, 10);
 197                                if (*end || abbrev > 40)
 198                                        usage(show_ref_usage);
 199                                if (abbrev < MINIMUM_ABBREV)
 200                                        abbrev = MINIMUM_ABBREV;
 201                        }
 202                        continue;
 203                }
 204                if (!strcmp(arg, "--verify")) {
 205                        verify = 1;
 206                        continue;
 207                }
 208                if (!strcmp(arg, "--tags")) {
 209                        tags_only = 1;
 210                        continue;
 211                }
 212                if (!strcmp(arg, "--heads")) {
 213                        heads_only = 1;
 214                        continue;
 215                }
 216                if (!strcmp(arg, "--exclude-existing"))
 217                        return exclude_existing(NULL);
 218                if (!strncmp(arg, "--exclude-existing=", 19))
 219                        return exclude_existing(arg + 19);
 220                usage(show_ref_usage);
 221        }
 222
 223        if (verify) {
 224                unsigned char sha1[20];
 225
 226                while (*pattern) {
 227                        if (!strncmp(*pattern, "refs/", 5) &&
 228                            resolve_ref(*pattern, sha1, 1, NULL)) {
 229                                if (!quiet)
 230                                        show_one(*pattern, sha1);
 231                        }
 232                        else if (!quiet)
 233                                die("'%s' - not a valid ref", *pattern);
 234                        else
 235                                return 1;
 236                        pattern++;
 237                }
 238                return 0;
 239        }
 240
 241        if (show_head)
 242                head_ref(show_ref, NULL);
 243        for_each_ref(show_ref, NULL);
 244        if (!found_match) {
 245                if (verify && !quiet)
 246                        die("No match");
 247                return 1;
 248        }
 249        return 0;
 250}