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