builtin / name-rev.con commit Merge branch 'jk/describe-omit-some-refs' (1b32498)
   1#include "builtin.h"
   2#include "cache.h"
   3#include "commit.h"
   4#include "tag.h"
   5#include "refs.h"
   6#include "parse-options.h"
   7#include "sha1-lookup.h"
   8
   9#define CUTOFF_DATE_SLOP 86400 /* one day */
  10
  11typedef struct rev_name {
  12        const char *tip_name;
  13        unsigned long taggerdate;
  14        int generation;
  15        int distance;
  16} rev_name;
  17
  18static long cutoff = LONG_MAX;
  19
  20/* How many generations are maximally preferred over _one_ merge traversal? */
  21#define MERGE_TRAVERSAL_WEIGHT 65535
  22
  23static void name_rev(struct commit *commit,
  24                const char *tip_name, unsigned long taggerdate,
  25                int generation, int distance,
  26                int deref)
  27{
  28        struct rev_name *name = (struct rev_name *)commit->util;
  29        struct commit_list *parents;
  30        int parent_number = 1;
  31
  32        parse_commit(commit);
  33
  34        if (commit->date < cutoff)
  35                return;
  36
  37        if (deref) {
  38                tip_name = xstrfmt("%s^0", tip_name);
  39
  40                if (generation)
  41                        die("generation: %d, but deref?", generation);
  42        }
  43
  44        if (name == NULL) {
  45                name = xmalloc(sizeof(rev_name));
  46                commit->util = name;
  47                goto copy_data;
  48        } else if (name->taggerdate > taggerdate ||
  49                        (name->taggerdate == taggerdate &&
  50                         name->distance > distance)) {
  51copy_data:
  52                name->tip_name = tip_name;
  53                name->taggerdate = taggerdate;
  54                name->generation = generation;
  55                name->distance = distance;
  56        } else
  57                return;
  58
  59        for (parents = commit->parents;
  60                        parents;
  61                        parents = parents->next, parent_number++) {
  62                if (parent_number > 1) {
  63                        size_t len;
  64                        char *new_name;
  65
  66                        strip_suffix(tip_name, "^0", &len);
  67                        if (generation > 0)
  68                                new_name = xstrfmt("%.*s~%d^%d", (int)len, tip_name,
  69                                                   generation, parent_number);
  70                        else
  71                                new_name = xstrfmt("%.*s^%d", (int)len, tip_name,
  72                                                   parent_number);
  73
  74                        name_rev(parents->item, new_name, taggerdate, 0,
  75                                distance + MERGE_TRAVERSAL_WEIGHT, 0);
  76                } else {
  77                        name_rev(parents->item, tip_name, taggerdate,
  78                                generation + 1, distance + 1, 0);
  79                }
  80        }
  81}
  82
  83static int subpath_matches(const char *path, const char *filter)
  84{
  85        const char *subpath = path;
  86
  87        while (subpath) {
  88                if (!wildmatch(filter, subpath, 0, NULL))
  89                        return subpath - path;
  90                subpath = strchr(subpath, '/');
  91                if (subpath)
  92                        subpath++;
  93        }
  94        return -1;
  95}
  96
  97static const char *name_ref_abbrev(const char *refname, int shorten_unambiguous)
  98{
  99        if (shorten_unambiguous)
 100                refname = shorten_unambiguous_ref(refname, 0);
 101        else if (starts_with(refname, "refs/heads/"))
 102                refname = refname + 11;
 103        else if (starts_with(refname, "refs/"))
 104                refname = refname + 5;
 105        return refname;
 106}
 107
 108struct name_ref_data {
 109        int tags_only;
 110        int name_only;
 111        struct string_list ref_filters;
 112        struct string_list exclude_filters;
 113};
 114
 115static struct tip_table {
 116        struct tip_table_entry {
 117                unsigned char sha1[20];
 118                const char *refname;
 119        } *table;
 120        int nr;
 121        int alloc;
 122        int sorted;
 123} tip_table;
 124
 125static void add_to_tip_table(const unsigned char *sha1, const char *refname,
 126                             int shorten_unambiguous)
 127{
 128        refname = name_ref_abbrev(refname, shorten_unambiguous);
 129
 130        ALLOC_GROW(tip_table.table, tip_table.nr + 1, tip_table.alloc);
 131        hashcpy(tip_table.table[tip_table.nr].sha1, sha1);
 132        tip_table.table[tip_table.nr].refname = xstrdup(refname);
 133        tip_table.nr++;
 134        tip_table.sorted = 0;
 135}
 136
 137static int tipcmp(const void *a_, const void *b_)
 138{
 139        const struct tip_table_entry *a = a_, *b = b_;
 140        return hashcmp(a->sha1, b->sha1);
 141}
 142
 143static int name_ref(const char *path, const struct object_id *oid, int flags, void *cb_data)
 144{
 145        struct object *o = parse_object(oid->hash);
 146        struct name_ref_data *data = cb_data;
 147        int can_abbreviate_output = data->tags_only && data->name_only;
 148        int deref = 0;
 149        unsigned long taggerdate = ULONG_MAX;
 150
 151        if (data->tags_only && !starts_with(path, "refs/tags/"))
 152                return 0;
 153
 154        if (data->exclude_filters.nr) {
 155                struct string_list_item *item;
 156
 157                for_each_string_list_item(item, &data->exclude_filters) {
 158                        if (subpath_matches(path, item->string) >= 0)
 159                                return 0;
 160                }
 161        }
 162
 163        if (data->ref_filters.nr) {
 164                struct string_list_item *item;
 165                int matched = 0;
 166
 167                /* See if any of the patterns match. */
 168                for_each_string_list_item(item, &data->ref_filters) {
 169                        /*
 170                         * Check all patterns even after finding a match, so
 171                         * that we can see if a match with a subpath exists.
 172                         * When a user asked for 'refs/tags/v*' and 'v1.*',
 173                         * both of which match, the user is showing her
 174                         * willingness to accept a shortened output by having
 175                         * the 'v1.*' in the acceptable refnames, so we
 176                         * shouldn't stop when seeing 'refs/tags/v1.4' matches
 177                         * 'refs/tags/v*'.  We should show it as 'v1.4'.
 178                         */
 179                        switch (subpath_matches(path, item->string)) {
 180                        case -1: /* did not match */
 181                                break;
 182                        case 0: /* matched fully */
 183                                matched = 1;
 184                                break;
 185                        default: /* matched subpath */
 186                                matched = 1;
 187                                can_abbreviate_output = 1;
 188                                break;
 189                        }
 190                }
 191
 192                /* If none of the patterns matched, stop now */
 193                if (!matched)
 194                        return 0;
 195        }
 196
 197        add_to_tip_table(oid->hash, path, can_abbreviate_output);
 198
 199        while (o && o->type == OBJ_TAG) {
 200                struct tag *t = (struct tag *) o;
 201                if (!t->tagged)
 202                        break; /* broken repository */
 203                o = parse_object(t->tagged->oid.hash);
 204                deref = 1;
 205                taggerdate = t->date;
 206        }
 207        if (o && o->type == OBJ_COMMIT) {
 208                struct commit *commit = (struct commit *)o;
 209
 210                path = name_ref_abbrev(path, can_abbreviate_output);
 211                name_rev(commit, xstrdup(path), taggerdate, 0, 0, deref);
 212        }
 213        return 0;
 214}
 215
 216static const unsigned char *nth_tip_table_ent(size_t ix, void *table_)
 217{
 218        struct tip_table_entry *table = table_;
 219        return table[ix].sha1;
 220}
 221
 222static const char *get_exact_ref_match(const struct object *o)
 223{
 224        int found;
 225
 226        if (!tip_table.table || !tip_table.nr)
 227                return NULL;
 228
 229        if (!tip_table.sorted) {
 230                QSORT(tip_table.table, tip_table.nr, tipcmp);
 231                tip_table.sorted = 1;
 232        }
 233
 234        found = sha1_pos(o->oid.hash, tip_table.table, tip_table.nr,
 235                         nth_tip_table_ent);
 236        if (0 <= found)
 237                return tip_table.table[found].refname;
 238        return NULL;
 239}
 240
 241/* returns a static buffer */
 242static const char *get_rev_name(const struct object *o)
 243{
 244        static char buffer[1024];
 245        struct rev_name *n;
 246        struct commit *c;
 247
 248        if (o->type != OBJ_COMMIT)
 249                return get_exact_ref_match(o);
 250        c = (struct commit *) o;
 251        n = c->util;
 252        if (!n)
 253                return NULL;
 254
 255        if (!n->generation)
 256                return n->tip_name;
 257        else {
 258                int len = strlen(n->tip_name);
 259                if (len > 2 && !strcmp(n->tip_name + len - 2, "^0"))
 260                        len -= 2;
 261                snprintf(buffer, sizeof(buffer), "%.*s~%d", len, n->tip_name,
 262                                n->generation);
 263
 264                return buffer;
 265        }
 266}
 267
 268static void show_name(const struct object *obj,
 269                      const char *caller_name,
 270                      int always, int allow_undefined, int name_only)
 271{
 272        const char *name;
 273        const struct object_id *oid = &obj->oid;
 274
 275        if (!name_only)
 276                printf("%s ", caller_name ? caller_name : oid_to_hex(oid));
 277        name = get_rev_name(obj);
 278        if (name)
 279                printf("%s\n", name);
 280        else if (allow_undefined)
 281                printf("undefined\n");
 282        else if (always)
 283                printf("%s\n", find_unique_abbrev(oid->hash, DEFAULT_ABBREV));
 284        else
 285                die("cannot describe '%s'", oid_to_hex(oid));
 286}
 287
 288static char const * const name_rev_usage[] = {
 289        N_("git name-rev [<options>] <commit>..."),
 290        N_("git name-rev [<options>] --all"),
 291        N_("git name-rev [<options>] --stdin"),
 292        NULL
 293};
 294
 295static void name_rev_line(char *p, struct name_ref_data *data)
 296{
 297        int forty = 0;
 298        char *p_start;
 299        for (p_start = p; *p; p++) {
 300#define ishex(x) (isdigit((x)) || ((x) >= 'a' && (x) <= 'f'))
 301                if (!ishex(*p))
 302                        forty = 0;
 303                else if (++forty == 40 &&
 304                         !ishex(*(p+1))) {
 305                        unsigned char sha1[40];
 306                        const char *name = NULL;
 307                        char c = *(p+1);
 308                        int p_len = p - p_start + 1;
 309
 310                        forty = 0;
 311
 312                        *(p+1) = 0;
 313                        if (!get_sha1(p - 39, sha1)) {
 314                                struct object *o =
 315                                        lookup_object(sha1);
 316                                if (o)
 317                                        name = get_rev_name(o);
 318                        }
 319                        *(p+1) = c;
 320
 321                        if (!name)
 322                                continue;
 323
 324                        if (data->name_only)
 325                                printf("%.*s%s", p_len - 40, p_start, name);
 326                        else
 327                                printf("%.*s (%s)", p_len, p_start, name);
 328                        p_start = p + 1;
 329                }
 330        }
 331
 332        /* flush */
 333        if (p_start != p)
 334                fwrite(p_start, p - p_start, 1, stdout);
 335}
 336
 337int cmd_name_rev(int argc, const char **argv, const char *prefix)
 338{
 339        struct object_array revs = OBJECT_ARRAY_INIT;
 340        int all = 0, transform_stdin = 0, allow_undefined = 1, always = 0, peel_tag = 0;
 341        struct name_ref_data data = { 0, 0, STRING_LIST_INIT_NODUP, STRING_LIST_INIT_NODUP };
 342        struct option opts[] = {
 343                OPT_BOOL(0, "name-only", &data.name_only, N_("print only names (no SHA-1)")),
 344                OPT_BOOL(0, "tags", &data.tags_only, N_("only use tags to name the commits")),
 345                OPT_STRING_LIST(0, "refs", &data.ref_filters, N_("pattern"),
 346                                   N_("only use refs matching <pattern>")),
 347                OPT_STRING_LIST(0, "exclude", &data.exclude_filters, N_("pattern"),
 348                                   N_("ignore refs matching <pattern>")),
 349                OPT_GROUP(""),
 350                OPT_BOOL(0, "all", &all, N_("list all commits reachable from all refs")),
 351                OPT_BOOL(0, "stdin", &transform_stdin, N_("read from stdin")),
 352                OPT_BOOL(0, "undefined", &allow_undefined, N_("allow to print `undefined` names (default)")),
 353                OPT_BOOL(0, "always",     &always,
 354                           N_("show abbreviated commit object as fallback")),
 355                {
 356                        /* A Hidden OPT_BOOL */
 357                        OPTION_SET_INT, 0, "peel-tag", &peel_tag, NULL,
 358                        N_("dereference tags in the input (internal use)"),
 359                        PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1,
 360                },
 361                OPT_END(),
 362        };
 363
 364        git_config(git_default_config, NULL);
 365        argc = parse_options(argc, argv, prefix, opts, name_rev_usage, 0);
 366        if (all + transform_stdin + !!argc > 1) {
 367                error("Specify either a list, or --all, not both!");
 368                usage_with_options(name_rev_usage, opts);
 369        }
 370        if (all || transform_stdin)
 371                cutoff = 0;
 372
 373        for (; argc; argc--, argv++) {
 374                unsigned char sha1[20];
 375                struct object *object;
 376                struct commit *commit;
 377
 378                if (get_sha1(*argv, sha1)) {
 379                        fprintf(stderr, "Could not get sha1 for %s. Skipping.\n",
 380                                        *argv);
 381                        continue;
 382                }
 383
 384                commit = NULL;
 385                object = parse_object(sha1);
 386                if (object) {
 387                        struct object *peeled = deref_tag(object, *argv, 0);
 388                        if (peeled && peeled->type == OBJ_COMMIT)
 389                                commit = (struct commit *)peeled;
 390                }
 391
 392                if (!object) {
 393                        fprintf(stderr, "Could not get object for %s. Skipping.\n",
 394                                        *argv);
 395                        continue;
 396                }
 397
 398                if (commit) {
 399                        if (cutoff > commit->date)
 400                                cutoff = commit->date;
 401                }
 402
 403                if (peel_tag) {
 404                        if (!commit) {
 405                                fprintf(stderr, "Could not get commit for %s. Skipping.\n",
 406                                        *argv);
 407                                continue;
 408                        }
 409                        object = (struct object *)commit;
 410                }
 411                add_object_array(object, *argv, &revs);
 412        }
 413
 414        if (cutoff)
 415                cutoff = cutoff - CUTOFF_DATE_SLOP;
 416        for_each_ref(name_ref, &data);
 417
 418        if (transform_stdin) {
 419                char buffer[2048];
 420
 421                while (!feof(stdin)) {
 422                        char *p = fgets(buffer, sizeof(buffer), stdin);
 423                        if (!p)
 424                                break;
 425                        name_rev_line(p, &data);
 426                }
 427        } else if (all) {
 428                int i, max;
 429
 430                max = get_max_object_index();
 431                for (i = 0; i < max; i++) {
 432                        struct object *obj = get_indexed_object(i);
 433                        if (!obj || obj->type != OBJ_COMMIT)
 434                                continue;
 435                        show_name(obj, NULL,
 436                                  always, allow_undefined, data.name_only);
 437                }
 438        } else {
 439                int i;
 440                for (i = 0; i < revs.nr; i++)
 441                        show_name(revs.objects[i].item, revs.objects[i].name,
 442                                  always, allow_undefined, data.name_only);
 443        }
 444
 445        return 0;
 446}