revision.h

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