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