builtin / name-rev.con commit strbuf_branchname: add docstring (0705fe2)
   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        const char *ref_filter;
 112};
 113
 114static struct tip_table {
 115        struct tip_table_entry {
 116                unsigned char sha1[20];
 117                const char *refname;
 118        } *table;
 119        int nr;
 120        int alloc;
 121        int sorted;
 122} tip_table;
 123
 124static void add_to_tip_table(const unsigned char *sha1, const char *refname,
 125                             int shorten_unambiguous)
 126{
 127        refname = name_ref_abbrev(refname, shorten_unambiguous);
 128
 129        ALLOC_GROW(tip_table.table, tip_table.nr + 1, tip_table.alloc);
 130        hashcpy(tip_table.table[tip_table.nr].sha1, sha1);
 131        tip_table.table[tip_table.nr].refname = xstrdup(refname);
 132        tip_table.nr++;
 133        tip_table.sorted = 0;
 134}
 135
 136static int tipcmp(const void *a_, const void *b_)
 137{
 138        const struct tip_table_entry *a = a_, *b = b_;
 139        return hashcmp(a->sha1, b->sha1);
 140}
 141
 142static int name_ref(const char *path, const struct object_id *oid, int flags, void *cb_data)
 143{
 144        struct object *o = parse_object(oid->hash);
 145        struct name_ref_data *data = cb_data;
 146        int can_abbreviate_output = data->tags_only && data->name_only;
 147        int deref = 0;
 148        unsigned long taggerdate = ULONG_MAX;
 149
 150        if (data->tags_only && !starts_with(path, "refs/tags/"))
 151                return 0;
 152
 153        if (data->ref_filter) {
 154                switch (subpath_matches(path, data->ref_filter)) {
 155                case -1: /* did not match */
 156                        return 0;
 157                case 0:  /* matched fully */
 158                        break;
 159                default: /* matched subpath */
 160                        can_abbreviate_output = 1;
 161                        break;
 162                }
 163        }
 164
 165        add_to_tip_table(oid->hash, path, can_abbreviate_output);
 166
 167        while (o && o->type == OBJ_TAG) {
 168                struct tag *t = (struct tag *) o;
 169                if (!t->tagged)
 170                        break; /* broken repository */
 171                o = parse_object(t->tagged->oid.hash);
 172                deref = 1;
 173                taggerdate = t->date;
 174        }
 175        if (o && o->type == OBJ_COMMIT) {
 176                struct commit *commit = (struct commit *)o;
 177
 178                path = name_ref_abbrev(path, can_abbreviate_output);
 179                name_rev(commit, xstrdup(path), taggerdate, 0, 0, deref);
 180        }
 181        return 0;
 182}
 183
 184static const unsigned char *nth_tip_table_ent(size_t ix, void *table_)
 185{
 186        struct tip_table_entry *table = table_;
 187        return table[ix].sha1;
 188}
 189
 190static const char *get_exact_ref_match(const struct object *o)
 191{
 192        int found;
 193
 194        if (!tip_table.table || !tip_table.nr)
 195                return NULL;
 196
 197        if (!tip_table.sorted) {
 198                QSORT(tip_table.table, tip_table.nr, tipcmp);
 199                tip_table.sorted = 1;
 200        }
 201
 202        found = sha1_pos(o->oid.hash, tip_table.table, tip_table.nr,
 203                         nth_tip_table_ent);
 204        if (0 <= found)
 205                return tip_table.table[found].refname;
 206        return NULL;
 207}
 208
 209/* returns a static buffer */
 210static const char *get_rev_name(const struct object *o)
 211{
 212        static char buffer[1024];
 213        struct rev_name *n;
 214        struct commit *c;
 215
 216        if (o->type != OBJ_COMMIT)
 217                return get_exact_ref_match(o);
 218        c = (struct commit *) o;
 219        n = c->util;
 220        if (!n)
 221                return NULL;
 222
 223        if (!n->generation)
 224                return n->tip_name;
 225        else {
 226                int len = strlen(n->tip_name);
 227                if (len > 2 && !strcmp(n->tip_name + len - 2, "^0"))
 228                        len -= 2;
 229                snprintf(buffer, sizeof(buffer), "%.*s~%d", len, n->tip_name,
 230                                n->generation);
 231
 232                return buffer;
 233        }
 234}
 235
 236static void show_name(const struct object *obj,
 237                      const char *caller_name,
 238                      int always, int allow_undefined, int name_only)
 239{
 240        const char *name;
 241        const struct object_id *oid = &obj->oid;
 242
 243        if (!name_only)
 244                printf("%s ", caller_name ? caller_name : oid_to_hex(oid));
 245        name = get_rev_name(obj);
 246        if (name)
 247                printf("%s\n", name);
 248        else if (allow_undefined)
 249                printf("undefined\n");
 250        else if (always)
 251                printf("%s\n", find_unique_abbrev(oid->hash, DEFAULT_ABBREV));
 252        else
 253                die("cannot describe '%s'", oid_to_hex(oid));
 254}
 255
 256static char const * const name_rev_usage[] = {
 257        N_("git name-rev [<options>] <commit>..."),
 258        N_("git name-rev [<options>] --all"),
 259        N_("git name-rev [<options>] --stdin"),
 260        NULL
 261};
 262
 263static void name_rev_line(char *p, struct name_ref_data *data)
 264{
 265        int forty = 0;
 266        char *p_start;
 267        for (p_start = p; *p; p++) {
 268#define ishex(x) (isdigit((x)) || ((x) >= 'a' && (x) <= 'f'))
 269                if (!ishex(*p))
 270                        forty = 0;
 271                else if (++forty == 40 &&
 272                         !ishex(*(p+1))) {
 273                        unsigned char sha1[40];
 274                        const char *name = NULL;
 275                        char c = *(p+1);
 276                        int p_len = p - p_start + 1;
 277
 278                        forty = 0;
 279
 280                        *(p+1) = 0;
 281                        if (!get_sha1(p - 39, sha1)) {
 282                                struct object *o =
 283                                        lookup_object(sha1);
 284                                if (o)
 285                                        name = get_rev_name(o);
 286                        }
 287                        *(p+1) = c;
 288
 289                        if (!name)
 290                                continue;
 291
 292                        if (data->name_only)
 293                                printf("%.*s%s", p_len - 40, p_start, name);
 294                        else
 295                                printf("%.*s (%s)", p_len, p_start, name);
 296                        p_start = p + 1;
 297                }
 298        }
 299
 300        /* flush */
 301        if (p_start != p)
 302                fwrite(p_start, p - p_start, 1, stdout);
 303}
 304
 305int cmd_name_rev(int argc, const char **argv, const char *prefix)
 306{
 307        struct object_array revs = OBJECT_ARRAY_INIT;
 308        int all = 0, transform_stdin = 0, allow_undefined = 1, always = 0, peel_tag = 0;
 309        struct name_ref_data data = { 0, 0, NULL };
 310        struct option opts[] = {
 311                OPT_BOOL(0, "name-only", &data.name_only, N_("print only names (no SHA-1)")),
 312                OPT_BOOL(0, "tags", &data.tags_only, N_("only use tags to name the commits")),
 313                OPT_STRING(0, "refs", &data.ref_filter, N_("pattern"),
 314                                   N_("only use refs matching <pattern>")),
 315                OPT_GROUP(""),
 316                OPT_BOOL(0, "all", &all, N_("list all commits reachable from all refs")),
 317                OPT_BOOL(0, "stdin", &transform_stdin, N_("read from stdin")),
 318                OPT_BOOL(0, "undefined", &allow_undefined, N_("allow to print `undefined` names (default)")),
 319                OPT_BOOL(0, "always",     &always,
 320                           N_("show abbreviated commit object as fallback")),
 321                {
 322                        /* A Hidden OPT_BOOL */
 323                        OPTION_SET_INT, 0, "peel-tag", &peel_tag, NULL,
 324                        N_("dereference tags in the input (internal use)"),
 325                        PARSE_OPT_NOARG | PARSE_OPT_HIDDEN, NULL, 1,
 326                },
 327                OPT_END(),
 328        };
 329
 330        git_config(git_default_config, NULL);
 331        argc = parse_options(argc, argv, prefix, opts, name_rev_usage, 0);
 332        if (all + transform_stdin + !!argc > 1) {
 333                error("Specify either a list, or --all, not both!");
 334                usage_with_options(name_rev_usage, opts);
 335        }
 336        if (all || transform_stdin)
 337                cutoff = 0;
 338
 339        for (; argc; argc--, argv++) {
 340                unsigned char sha1[20];
 341                struct object *object;
 342                struct commit *commit;
 343
 344                if (get_sha1(*argv, sha1)) {
 345                        fprintf(stderr, "Could not get sha1 for %s. Skipping.\n",
 346                                        *argv);
 347                        continue;
 348                }
 349
 350                commit = NULL;
 351                object = parse_object(sha1);
 352                if (object) {
 353                        struct object *peeled = deref_tag(object, *argv, 0);
 354                        if (peeled && peeled->type == OBJ_COMMIT)
 355                                commit = (struct commit *)peeled;
 356                }
 357
 358                if (!object) {
 359                        fprintf(stderr, "Could not get object for %s. Skipping.\n",
 360                                        *argv);
 361                        continue;
 362                }
 363
 364                if (commit) {
 365                        if (cutoff > commit->date)
 366                                cutoff = commit->date;
 367                }
 368
 369                if (peel_tag) {
 370                        if (!commit) {
 371                                fprintf(stderr, "Could not get commit for %s. Skipping.\n",
 372                                        *argv);
 373                                continue;
 374                        }
 375                        object = (struct object *)commit;
 376                }
 377                add_object_array(object, *argv, &revs);
 378        }
 379
 380        if (cutoff)
 381                cutoff = cutoff - CUTOFF_DATE_SLOP;
 382        for_each_ref(name_ref, &data);
 383
 384        if (transform_stdin) {
 385                char buffer[2048];
 386
 387                while (!feof(stdin)) {
 388                        char *p = fgets(buffer, sizeof(buffer), stdin);
 389                        if (!p)
 390                                break;
 391                        name_rev_line(p, &data);
 392                }
 393        } else if (all) {
 394                int i, max;
 395
 396                max = get_max_object_index();
 397                for (i = 0; i < max; i++) {
 398                        struct object *obj = get_indexed_object(i);
 399                        if (!obj || obj->type != OBJ_COMMIT)
 400                                continue;
 401                        show_name(obj, NULL,
 402                                  always, allow_undefined, data.name_only);
 403                }
 404        } else {
 405                int i;
 406                for (i = 0; i < revs.nr; i++)
 407                        show_name(revs.objects[i].item, revs.objects[i].name,
 408                                  always, allow_undefined, data.name_only);
 409        }
 410
 411        return 0;
 412}