revision.h

   1 #ifndef REVISION_H
   2 #define REVISION_H
   3
   4 #include "commit.h"
   5 #include "grep.h"
   6 #include "notes.h"
   7 #include "oidset.h"
   8 #include "pretty.h"
   9 #include "diff.h"
  10 #include "commit-slab-decl.h"
  11 #include "decorate.h"
  12 #include "ident.h"
  13 #include "list-objects-filter-options.h"
  14 #include "strvec.h"
  15
  16 /**
  17  * The revision walking API offers functions to build a list of revisions
  18  * and then iterate over that list.
  19  *
  20  * Calling sequence
  21  * ----------------
  22  *
  23  * The walking API has a given calling sequence: first you need to initialize
  24  * a rev_info structure, then add revisions to control what kind of revision
  25  * list do you want to get, finally you can iterate over the revision list.
  26  *
  27  */
  28
  29 /* Remember to update object flag allocation in object.h */
  30 #define SEEN            (1u<<0)
  31 #define UNINTERESTING   (1u<<1)
  32 #define TREESAME        (1u<<2)
  33 #define SHOWN           (1u<<3)
  34 #define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
  35 #define BOUNDARY        (1u<<5)
  36 #define CHILD_SHOWN     (1u<<6)
  37 #define ADDED           (1u<<7) /* Parents already parsed and added? */
  38 #define SYMMETRIC_LEFT  (1u<<8)
  39 #define PATCHSAME       (1u<<9)
  40 #define BOTTOM          (1u<<10)
  41
  42 /* WARNING: This is also used as REACHABLE in commit-graph.c. */
  43 #define PULL_MERGE      (1u<<15)
  44
  45 #define TOPO_WALK_EXPLORED      (1u<<23)
  46 #define TOPO_WALK_INDEGREE      (1u<<24)
  47
  48 /*
  49  * Indicates object was reached by traversal. i.e. not given by user on
  50  * command-line or stdin.
  51  */
  52 #define NOT_USER_GIVEN  (1u<<25)
  53 #define TRACK_LINEAR    (1u<<26)
  54 #define ANCESTRY_PATH   (1u<<27)
  55 #define ALL_REV_FLAGS   (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR | PULL_MERGE)
  56
  57 #define DECORATE_SHORT_REFS     1
  58 #define DECORATE_FULL_REFS      2
  59
  60 struct log_info;
  61 struct repository;
  62 struct rev_info;
  63 struct string_list;
  64 struct saved_parents;
  65 struct bloom_key;
  66 struct bloom_filter_settings;
  67 struct option;
  68 struct parse_opt_ctx_t;
  69 define_shared_commit_slab(revision_sources, char *);
  70
  71 struct rev_cmdline_info {
  72         unsigned int nr;
  73         unsigned int alloc;
  74         struct rev_cmdline_entry {
  75                 struct object *item;
  76                 const char *name;
  77                 enum {
  78                         REV_CMD_REF,
  79                         REV_CMD_PARENTS_ONLY,
  80                         REV_CMD_LEFT,
  81                         REV_CMD_RIGHT,
  82                         REV_CMD_MERGE_BASE,
  83                         REV_CMD_REV
  84                 } whence;
  85                 unsigned flags;
  86         } *rev;
  87 };
  88
  89 struct ref_exclusions {
  90         /*
  91          * Excluded refs is a list of wildmatch patterns. If any of the
  92          * patterns match, the reference will be excluded.
  93          */
  94         struct string_list excluded_refs;
  95
  96         /*
  97          * Hidden refs is a list of patterns that is to be hidden via
  98          * `ref_is_hidden()`.
  99          */
 100         struct strvec hidden_refs;
 101
 102         /*
 103          * Indicates whether hidden refs have been configured. This is to
 104          * distinguish between no hidden refs existing and hidden refs not
 105          * being parsed.
 106          */
 107         char hidden_refs_configured;
 108 };
 109
 110 /**
 111  * Initialize a `struct ref_exclusions` with a macro.
 112  */
 113 #define REF_EXCLUSIONS_INIT { \
 114         .excluded_refs = STRING_LIST_INIT_DUP, \
 115         .hidden_refs = STRVEC_INIT, \
 116 }
 117
 118 struct oidset;
 119 struct topo_walk_info;
 120
 121 struct rev_info {
 122         /* Starting list */
 123         struct commit_list *commits;
 124         struct object_array pending;
 125         struct repository *repo;
 126
 127         /* Parents of shown commits */
 128         struct object_array boundary_commits;
 129
 130         /* The end-points specified by the end user */
 131         struct rev_cmdline_info cmdline;
 132
 133         /*
 134          * Object filter options. No filtering is specified
 135          * if and only if filter.choice is zero.
 136          */
 137         struct list_objects_filter_options filter;
 138
 139         /* excluding from --branches, --refs, etc. expansion */
 140         struct ref_exclusions ref_excludes;
 141
 142         /* Basic information */
 143         const char *prefix;
 144         const char *def;
 145         struct pathspec prune_data;
 146
 147         /*
 148          * Whether the arguments parsed by setup_revisions() included any
 149          * "input" revisions that might still have yielded an empty pending
 150          * list (e.g., patterns like "--all" or "--glob").
 151          */
 152         int rev_input_given;
 153
 154         /*
 155          * Whether we read from stdin due to the --stdin option.
 156          */
 157         int read_from_stdin;
 158
 159         /* topo-sort */
 160         enum rev_sort_order sort_order;
 161
 162         unsigned int early_output;
 163
 164         unsigned int    ignore_missing:1,
 165                         ignore_missing_links:1;
 166
 167         /* Traversal flags */
 168         unsigned int    dense:1,
 169                         prune:1,
 170                         no_walk:1,
 171                         unsorted_input:1,
 172                         remove_empty_trees:1,
 173                         simplify_history:1,
 174                         show_pulls:1,
 175                         topo_order:1,
 176                         simplify_merges:1,
 177                         simplify_by_decoration:1,
 178                         single_worktree:1,
 179                         tag_objects:1,
 180                         tree_objects:1,
 181                         blob_objects:1,
 182                         verify_objects:1,
 183                         edge_hint:1,
 184                         edge_hint_aggressive:1,
 185                         limited:1,
 186                         unpacked:1,
 187                         no_kept_objects:1,
 188                         boundary:2,
 189                         count:1,
 190                         left_right:1,
 191                         left_only:1,
 192                         right_only:1,
 193                         rewrite_parents:1,
 194                         print_parents:1,
 195                         show_decorations:1,
 196                         reverse:1,
 197                         reverse_output_stage:1,
 198                         cherry_pick:1,
 199                         cherry_mark:1,
 200                         bisect:1,
 201                         ancestry_path:1,
 202
 203                         /* True if --ancestry-path was specified without an
 204                          * argument. The bottom revisions are implicitly
 205                          * the arguments in this case.
 206                          */
 207                         ancestry_path_implicit_bottoms:1,
 208
 209                         first_parent_only:1,
 210                         exclude_first_parent_only:1,
 211                         line_level_traverse:1,
 212                         tree_blobs_in_commit_order:1,
 213
 214                         /*
 215                          * Blobs are shown without regard for their existence.
 216                          * But not so for trees/commits: unless exclude_promisor_objects
 217                          * is set and the tree in question is a promisor object;
 218                          * OR ignore_missing_links is set, the revision walker
 219                          * dies with a "bad <type> object HASH" message when
 220                          * encountering a missing object. For callers that can
 221                          * handle missing trees/commits and want them to be filterable
 222                          * and showable, set this to true. The revision walker
 223                          * will filter and show such a missing object as usual,
 224                          * but will not attempt to recurse into this tree/commit
 225                          * object. The revision walker will also set the MISSING
 226                          * flag for such objects.
 227                          */
 228                         do_not_die_on_missing_objects:1,
 229
 230                         /* for internal use only */
 231                         exclude_promisor_objects:1;
 232
 233         /* Diff flags */
 234         unsigned int    diff:1,
 235                         full_diff:1,
 236                         show_root_diff:1,
 237                         match_missing:1,
 238                         no_commit_id:1,
 239                         verbose_header:1,
 240                         always_show_header:1,
 241                         /* Diff-merge flags */
 242                         explicit_diff_merges: 1,
 243                         merges_need_diff: 1,
 244                         merges_imply_patch:1,
 245                         separate_merges: 1,
 246                         combine_merges:1,
 247                         combined_all_paths:1,
 248                         dense_combined_merges:1,
 249                         first_parent_merges:1,
 250                         remerge_diff:1;
 251
 252         /* Format info */
 253         int             show_notes;
 254         unsigned int    shown_one:1,
 255                         shown_dashes:1,
 256                         show_merge:1,
 257                         show_notes_given:1,
 258                         show_notes_by_default:1,
 259                         show_signature:1,
 260                         pretty_given:1,
 261                         abbrev_commit:1,
 262                         abbrev_commit_given:1,
 263                         zero_commit:1,
 264                         use_terminator:1,
 265                         missing_newline:1,
 266                         date_mode_explicit:1,
 267                         preserve_subject:1,
 268                         force_in_body_from:1,
 269                         encode_email_headers:1,
 270                         include_header:1;
 271         unsigned int    disable_stdin:1;
 272         /* --show-linear-break */
 273         unsigned int    track_linear:1,
 274                         track_first_time:1,
 275                         linear:1;
 276
 277         struct date_mode date_mode;
 278         int             expand_tabs_in_log; /* unset if negative */
 279         int             expand_tabs_in_log_default;
 280
 281         unsigned int    abbrev;
 282         enum cmit_fmt   commit_format;
 283         struct log_info *loginfo;
 284         int             nr, total;
 285         const char      *mime_boundary;
 286         const char      *patch_suffix;
 287         int             numbered_files;
 288         const char      *reroll_count;
 289         char            *message_id;
 290         struct ident_split from_ident;
 291         struct string_list *ref_message_ids;
 292         int             add_signoff;
 293         const char      *extra_headers;
 294         const char      *log_reencode;
 295         const char      *subject_prefix;
 296         int             patch_name_max;
 297         int             no_inline;
 298         int             show_log_size;
 299         struct string_list *mailmap;
 300
 301         /* Filter by commit log message */
 302         struct grep_opt grep_filter;
 303
 304         /* Display history graph */
 305         struct git_graph *graph;
 306
 307         /* special limits */
 308         int skip_count;
 309         int max_count;
 310         timestamp_t max_age;
 311         timestamp_t max_age_as_filter;
 312         timestamp_t min_age;
 313         int min_parents;
 314         int max_parents;
 315         int (*include_check)(struct commit *, void *);
 316         int (*include_check_obj)(struct object *obj, void *);
 317         void *include_check_data;
 318
 319         /* diff info for patches and for paths limiting */
 320         struct diff_options diffopt;
 321         struct diff_options pruning;
 322
 323         struct reflog_walk_info *reflog_info;
 324         struct decoration children;
 325         struct decoration merge_simplification;
 326         struct decoration treesame;
 327
 328         /* notes-specific options: which refs to show */
 329         struct display_notes_opt notes_opt;
 330
 331         /* interdiff */
 332         const struct object_id *idiff_oid1;
 333         const struct object_id *idiff_oid2;
 334         const char *idiff_title;
 335
 336         /* range-diff */
 337         const char *rdiff1;
 338         const char *rdiff2;
 339         int creation_factor;
 340         const char *rdiff_title;
 341
 342         /* commit counts */
 343         int count_left;
 344         int count_right;
 345         int count_same;
 346
 347         /* line level range that we are chasing */
 348         struct decoration line_log_data;
 349
 350         /* copies of the parent lists, for --full-diff display */
 351         struct saved_parents *saved_parents_slab;
 352
 353         struct commit_list *previous_parents;
 354         struct commit_list *ancestry_path_bottoms;
 355         const char *break_bar;
 356
 357         struct revision_sources *sources;
 358
 359         struct topo_walk_info *topo_walk_info;
 360
 361         /* Commit graph bloom filter fields */
 362         /* The bloom filter key(s) for the pathspec */
 363         struct bloom_key *bloom_keys;
 364         int bloom_keys_nr;
 365
 366         /*
 367          * The bloom filter settings used to generate the key.
 368          * This is loaded from the commit-graph being used.
 369          */
 370         struct bloom_filter_settings *bloom_filter_settings;
 371
 372         /* misc. flags related to '--no-kept-objects' */
 373         unsigned keep_pack_cache_flags;
 374
 375         /* Location where temporary objects for remerge-diff are written. */
 376         struct tmp_objdir *remerge_objdir;
 377
 378         /* Missing commits to be tracked without failing traversal. */
 379         struct oidset missing_commits;
 380 };
 381
 382 /**
 383  * Initialize the "struct rev_info" structure with a macro.
 384  *
 385  * This will not fully initialize a "struct rev_info", the
 386  * repo_init_revisions() function needs to be called before
 387  * setup_revisions() and any revision walking takes place.
 388  *
 389  * Use REV_INFO_INIT to make the "struct rev_info" safe for passing to
 390  * release_revisions() when it's inconvenient (e.g. due to a "goto
 391  * cleanup" pattern) to arrange for repo_init_revisions() to be called
 392  * before release_revisions() is called.
 393  *
 394  * Initializing with this REV_INFO_INIT is redundant to invoking
 395  * repo_init_revisions(). If repo_init_revisions() is guaranteed to be
 396  * called before release_revisions() the "struct rev_info" can be left
 397  * uninitialized.
 398  */
 399 #define REV_INFO_INIT { \
 400         .abbrev = DEFAULT_ABBREV, \
 401         .simplify_history = 1, \
 402         .pruning.flags.recursive = 1, \
 403         .pruning.flags.quick = 1, \
 404         .sort_order = REV_SORT_IN_GRAPH_ORDER, \
 405         .dense = 1, \
 406         .max_age = -1, \
 407         .max_age_as_filter = -1, \
 408         .min_age = -1, \
 409         .skip_count = -1, \
 410         .max_count = -1, \
 411         .max_parents = -1, \
 412         .expand_tabs_in_log = -1, \
 413         .commit_format = CMIT_FMT_DEFAULT, \
 414         .expand_tabs_in_log_default = 8, \
 415 }
 416
 417 /**
 418  * Initialize a rev_info structure with default values. The third parameter may
 419  * be NULL or can be prefix path, and then the `.prefix` variable will be set
 420  * to it. This is typically the first function you want to call when you want
 421  * to deal with a revision list. After calling this function, you are free to
 422  * customize options, like set `.ignore_merges` to 0 if you don't want to
 423  * ignore merges, and so on.
 424  */
 425 void repo_init_revisions(struct repository *r,
 426                          struct rev_info *revs,
 427                          const char *prefix);
 428
 429 /**
 430  * Parse revision information, filling in the `rev_info` structure, and
 431  * removing the used arguments from the argument list. Returns the number
 432  * of arguments left that weren't recognized, which are also moved to the
 433  * head of the argument list. The last parameter is used in case no
 434  * parameter given by the first two arguments.
 435  */
 436 struct setup_revision_opt {
 437         const char *def;
 438         void (*tweak)(struct rev_info *);
 439         unsigned int    assume_dashdash:1,
 440                         allow_exclude_promisor_objects:1,
 441                         free_removed_argv_elements:1;
 442         unsigned revarg_opt;
 443 };
 444 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
 445                     struct setup_revision_opt *);
 446
 447 /**
 448  * Free data allocated in a "struct rev_info" after it's been
 449  * initialized with repo_init_revisions() or REV_INFO_INIT.
 450  */
 451 void release_revisions(struct rev_info *revs);
 452
 453 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
 454                         const struct option *options,
 455                         const char * const usagestr[]);
 456 #define REVARG_CANNOT_BE_FILENAME 01
 457 #define REVARG_COMMITTISH 02
 458 int handle_revision_arg(const char *arg, struct rev_info *revs,
 459                         int flags, unsigned revarg_opt);
 460 void revision_opts_finish(struct rev_info *revs);
 461
 462 /**
 463  * Reset the flags used by the revision walking api. You can use this to do
 464  * multiple sequential revision walks.
 465  */
 466 void reset_revision_walk(void);
 467
 468 /**
 469  * Prepares the rev_info structure for a walk. You should check if it returns
 470  * any error (non-zero return code) and if it does not, you can start using
 471  * get_revision() to do the iteration.
 472  */
 473 int prepare_revision_walk(struct rev_info *revs);
 474
 475 /**
 476  * Takes a pointer to a `rev_info` structure and iterates over it, returning a
 477  * `struct commit *` each time you call it. The end of the revision list is
 478  * indicated by returning a NULL pointer.
 479  */
 480 struct commit *get_revision(struct rev_info *revs);
 481
 482 const char *get_revision_mark(const struct rev_info *revs,
 483                               const struct commit *commit);
 484 void put_revision_mark(const struct rev_info *revs,
 485                        const struct commit *commit);
 486
 487 void mark_parents_uninteresting(struct rev_info *revs, struct commit *commit);
 488 void mark_tree_uninteresting(struct repository *r, struct tree *tree);
 489 void mark_trees_uninteresting_sparse(struct repository *r, struct oidset *trees);
 490
 491 void show_object_with_name(FILE *, struct object *, const char *);
 492
 493 /**
 494  * Helpers to check if a reference should be excluded.
 495  */
 496
 497 int ref_excluded(const struct ref_exclusions *exclusions, const char *path);
 498 void init_ref_exclusions(struct ref_exclusions *);
 499 void clear_ref_exclusions(struct ref_exclusions *);
 500 void add_ref_exclusion(struct ref_exclusions *, const char *exclude);
 501 void exclude_hidden_refs(struct ref_exclusions *, const char *section);
 502
 503 /**
 504  * This function can be used if you want to add commit objects as revision
 505  * information. You can use the `UNINTERESTING` object flag to indicate if
 506  * you want to include or exclude the given commit (and commits reachable
 507  * from the given commit) from the revision list.
 508  *
 509  * NOTE: If you have the commits as a string list then you probably want to
 510  * use setup_revisions(), instead of parsing each string and using this
 511  * function.
 512  */
 513 void add_pending_object(struct rev_info *revs,
 514                         struct object *obj, const char *name);
 515
 516 void add_pending_oid(struct rev_info *revs,
 517                      const char *name, const struct object_id *oid,
 518                      unsigned int flags);
 519
 520 void add_head_to_pending(struct rev_info *);
 521 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
 522 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
 523
 524 enum commit_action {
 525         commit_ignore,
 526         commit_show,
 527         commit_error
 528 };
 529
 530 enum commit_action get_commit_action(struct rev_info *revs,
 531                                      struct commit *commit);
 532 enum commit_action simplify_commit(struct rev_info *revs,
 533                                    struct commit *commit);
 534
 535 enum rewrite_result {
 536         rewrite_one_ok,
 537         rewrite_one_noparents,
 538         rewrite_one_error
 539 };
 540
 541 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
 542
 543 int rewrite_parents(struct rev_info *revs,
 544                     struct commit *commit,
 545                     rewrite_parent_fn_t rewrite_parent);
 546
 547 /*
 548  * The log machinery saves the original parent list so that
 549  * get_saved_parents() can later tell what the real parents of the
 550  * commits are, when commit->parents has been modified by history
 551  * simpification.
 552  *
 553  * get_saved_parents() will transparently return commit->parents if
 554  * history simplification is off.
 555  */
 556 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
 557
 558 /**
 559  * Global for the (undocumented) "--early-output" flag for "git log".
 560  */
 561 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
 562 extern volatile show_early_output_fn_t show_early_output;
 563
 564 #endif