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