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