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
  14 /**
  15  * The revision walking API offers functions to build a list of revisions
  16  * and then iterate over that list.
  17  *
  18  * Calling sequence
  19  * ----------------
  20  *
  21  * The walking API has a given calling sequence: first you need to initialize
  22  * a rev_info structure, then add revisions to control what kind of revision
  23  * list do you want to get, finally you can iterate over the revision list.
  24  *
  25  */
  26
  27 /* Remember to update object flag allocation in object.h */
  28 #define SEEN            (1u<<0)
  29 #define UNINTERESTING   (1u<<1)
  30 #define TREESAME        (1u<<2)
  31 #define SHOWN           (1u<<3)
  32 #define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
  33 #define BOUNDARY        (1u<<5)
  34 #define CHILD_SHOWN     (1u<<6)
  35 #define ADDED           (1u<<7) /* Parents already parsed and added? */
  36 #define SYMMETRIC_LEFT  (1u<<8)
  37 #define PATCHSAME       (1u<<9)
  38 #define BOTTOM          (1u<<10)
  39
  40 /* WARNING: This is also used as REACHABLE in commit-graph.c. */
  41 #define PULL_MERGE      (1u<<15)
  42
  43 #define TOPO_WALK_EXPLORED      (1u<<23)
  44 #define TOPO_WALK_INDEGREE      (1u<<24)
  45
  46 /*
  47  * Indicates object was reached by traversal. i.e. not given by user on
  48  * command-line or stdin.
  49  */
  50 #define NOT_USER_GIVEN  (1u<<25)
  51 #define TRACK_LINEAR    (1u<<26)
  52 #define ANCESTRY_PATH   (1u<<27)
  53 #define ALL_REV_FLAGS   (((1u<<11)-1) | NOT_USER_GIVEN | TRACK_LINEAR | PULL_MERGE)
  54
  55 #define DECORATE_SHORT_REFS     1
  56 #define DECORATE_FULL_REFS      2
  57
  58 struct log_info;
  59 struct repository;
  60 struct rev_info;
  61 struct string_list;
  62 struct saved_parents;
  63 struct bloom_key;
  64 struct bloom_filter_settings;
  65 struct option;
  66 struct parse_opt_ctx_t;
  67 define_shared_commit_slab(revision_sources, char *);
  68
  69 struct rev_cmdline_info {
  70         unsigned int nr;
  71         unsigned int alloc;
  72         struct rev_cmdline_entry {
  73                 struct object *item;
  74                 const char *name;
  75                 enum {
  76                         REV_CMD_REF,
  77                         REV_CMD_PARENTS_ONLY,
  78                         REV_CMD_LEFT,
  79                         REV_CMD_RIGHT,
  80                         REV_CMD_MERGE_BASE,
  81                         REV_CMD_REV
  82                 } whence;
  83                 unsigned flags;
  84         } *rev;
  85 };
  86
  87 struct ref_exclusions {
  88         /*
  89          * Excluded refs is a list of wildmatch patterns. If any of the
  90          * patterns matches, the reference will be excluded.
  91          */
  92         struct string_list excluded_refs;
  93
  94         /*
  95          * Hidden refs is a list of patterns that is to be hidden via
  96          * `ref_is_hidden()`.
  97          */
  98         struct string_list hidden_refs;
  99
 100         /*
 101          * Indicates whether hidden refs have been configured. This is to
 102          * distinguish between no hidden refs existing and hidden refs not
 103          * being parsed.
 104          */
 105         char hidden_refs_configured;
 106 };
 107
 108 /**
 109  * Initialize a `struct ref_exclusions` with a macro.
 110  */
 111 #define REF_EXCLUSIONS_INIT { \
 112         .excluded_refs = STRING_LIST_INIT_DUP, \
 113         .hidden_refs = STRING_LIST_INIT_DUP, \
 114 }
 115
 116 struct oidset;
 117 struct topo_walk_info;
 118
 119 struct rev_info {
 120         /* Starting list */
 121         struct commit_list *commits;
 122         struct object_array pending;
 123         struct repository *repo;
 124
 125         /* Parents of shown commits */
 126         struct object_array boundary_commits;
 127
 128         /* The end-points specified by the end user */
 129         struct rev_cmdline_info cmdline;
 130
 131         /*
 132          * Object filter options. No filtering is specified
 133          * if and only if filter.choice is zero.
 134          */
 135         struct list_objects_filter_options filter;
 136
 137         /* excluding from --branches, --refs, etc. expansion */
 138         struct ref_exclusions ref_excludes;
 139
 140         /* Basic information */
 141         const char *prefix;
 142         const char *def;
 143         struct pathspec prune_data;
 144
 145         /*
 146          * Whether the arguments parsed by setup_revisions() included any
 147          * "input" revisions that might still have yielded an empty pending
 148          * list (e.g., patterns like "--all" or "--glob").
 149          */
 150         int rev_input_given;
 151
 152         /*
 153          * Whether we read from stdin due to the --stdin option.
 154          */
 155         int read_from_stdin;
 156
 157         /* topo-sort */
 158         enum rev_sort_order sort_order;
 159
 160         unsigned int early_output;
 161
 162         unsigned int    ignore_missing:1,
 163                         ignore_missing_links:1;
 164
 165         /* Traversal flags */
 166         unsigned int    dense:1,
 167                         prune:1,
 168                         no_walk:1,
 169                         unsorted_input:1,
 170                         remove_empty_trees:1,
 171                         simplify_history:1,
 172                         show_pulls:1,
 173                         topo_order:1,
 174                         simplify_merges:1,
 175                         simplify_by_decoration:1,
 176                         single_worktree:1,
 177                         tag_objects:1,
 178                         tree_objects:1,
 179                         blob_objects:1,
 180                         verify_objects:1,
 181                         edge_hint:1,
 182                         edge_hint_aggressive:1,
 183                         limited:1,
 184                         unpacked:1,
 185                         no_kept_objects:1,
 186                         boundary:2,
 187                         count:1,
 188                         left_right:1,
 189                         left_only:1,
 190                         right_only:1,
 191                         rewrite_parents:1,
 192                         print_parents:1,
 193                         show_decorations:1,
 194                         reverse:1,
 195                         reverse_output_stage:1,
 196                         cherry_pick:1,
 197                         cherry_mark:1,
 198                         bisect:1,
 199                         ancestry_path:1,
 200
 201                         /* True if --ancestry-path was specified without an
 202                          * argument. The bottom revisions are implicitly
 203                          * the arguments in this case.
 204                          */
 205                         ancestry_path_implicit_bottoms:1,
 206
 207                         first_parent_only:1,
 208                         exclude_first_parent_only:1,
 209                         line_level_traverse:1,
 210                         tree_blobs_in_commit_order:1,
 211
 212                         /*
 213                          * Blobs are shown without regard for their existence.
 214                          * But not so for trees: unless exclude_promisor_objects
 215                          * is set and the tree in question is a promisor object;
 216                          * OR ignore_missing_links is set, the revision walker
 217                          * dies with a "bad tree object HASH" message when
 218                          * encountering a missing tree. For callers that can
 219                          * handle missing trees and want them to be filterable
 220                          * and showable, set this to true. The revision walker
 221                          * will filter and show such a missing tree as usual,
 222                          * but will not attempt to recurse into this tree
 223                          * object.
 224                          */
 225                         do_not_die_on_missing_tree:1,
 226
 227                         /* for internal use only */
 228                         exclude_promisor_objects:1;
 229
 230         /* Diff flags */
 231         unsigned int    diff:1,
 232                         full_diff:1,
 233                         show_root_diff:1,
 234                         match_missing:1,
 235                         no_commit_id:1,
 236                         verbose_header:1,
 237                         always_show_header:1,
 238                         /* Diff-merge flags */
 239                         explicit_diff_merges: 1,
 240                         merges_need_diff: 1,
 241                         merges_imply_patch:1,
 242                         separate_merges: 1,
 243                         combine_merges:1,
 244                         combined_all_paths:1,
 245                         dense_combined_merges:1,
 246                         first_parent_merges:1,
 247                         remerge_diff:1;
 248
 249         /* Format info */
 250         int             show_notes;
 251         unsigned int    shown_one:1,
 252                         shown_dashes:1,
 253                         show_merge:1,
 254                         show_notes_given:1,
 255                         show_signature:1,
 256                         pretty_given:1,
 257                         abbrev_commit:1,
 258                         abbrev_commit_given:1,
 259                         zero_commit:1,
 260                         use_terminator:1,
 261                         missing_newline:1,
 262                         date_mode_explicit:1,
 263                         preserve_subject:1,
 264                         force_in_body_from:1,
 265                         encode_email_headers:1,
 266                         include_header:1;
 267         unsigned int    disable_stdin:1;
 268         /* --show-linear-break */
 269         unsigned int    track_linear:1,
 270                         track_first_time:1,
 271                         linear:1;
 272
 273         struct date_mode date_mode;
 274         int             expand_tabs_in_log; /* unset if negative */
 275         int             expand_tabs_in_log_default;
 276
 277         unsigned int    abbrev;
 278         enum cmit_fmt   commit_format;
 279         struct log_info *loginfo;
 280         int             nr, total;
 281         const char      *mime_boundary;
 282         const char      *patch_suffix;
 283         int             numbered_files;
 284         const char      *reroll_count;
 285         char            *message_id;
 286         struct ident_split from_ident;
 287         struct string_list *ref_message_ids;
 288         int             add_signoff;
 289         const char      *extra_headers;
 290         const char      *log_reencode;
 291         const char      *subject_prefix;
 292         int             patch_name_max;
 293         int             no_inline;
 294         int             show_log_size;
 295         struct string_list *mailmap;
 296
 297         /* Filter by commit log message */
 298         struct grep_opt grep_filter;
 299
 300         /* Display history graph */
 301         struct git_graph *graph;
 302
 303         /* special limits */
 304         int skip_count;
 305         int max_count;
 306         timestamp_t max_age;
 307         timestamp_t max_age_as_filter;
 308         timestamp_t min_age;
 309         int min_parents;
 310         int max_parents;
 311         int (*include_check)(struct commit *, void *);
 312         int (*include_check_obj)(struct object *obj, void *);
 313         void *include_check_data;
 314
 315         /* diff info for patches and for paths limiting */
 316         struct diff_options diffopt;
 317         struct diff_options pruning;
 318
 319         struct reflog_walk_info *reflog_info;
 320         struct decoration children;
 321         struct decoration merge_simplification;
 322         struct decoration treesame;
 323
 324         /* notes-specific options: which refs to show */
 325         struct display_notes_opt notes_opt;
 326
 327         /* interdiff */
 328         const struct object_id *idiff_oid1;
 329         const struct object_id *idiff_oid2;
 330         const char *idiff_title;
 331
 332         /* range-diff */
 333         const char *rdiff1;
 334         const char *rdiff2;
 335         int creation_factor;
 336         const char *rdiff_title;
 337
 338         /* commit counts */
 339         int count_left;
 340         int count_right;
 341         int count_same;
 342
 343         /* line level range that we are chasing */
 344         struct decoration line_log_data;
 345
 346         /* copies of the parent lists, for --full-diff display */
 347         struct saved_parents *saved_parents_slab;
 348
 349         struct commit_list *previous_parents;
 350         struct commit_list *ancestry_path_bottoms;
 351         const char *break_bar;
 352
 353         struct revision_sources *sources;
 354
 355         struct topo_walk_info *topo_walk_info;
 356
 357         /* Commit graph bloom filter fields */
 358         /* The bloom filter key(s) for the pathspec */
 359         struct bloom_key *bloom_keys;
 360         int bloom_keys_nr;
 361
 362         /*
 363          * The bloom filter settings used to generate the key.
 364          * This is loaded from the commit-graph being used.
 365          */
 366         struct bloom_filter_settings *bloom_filter_settings;
 367
 368         /* misc. flags related to '--no-kept-objects' */
 369         unsigned keep_pack_cache_flags;
 370
 371         /* Location where temporary objects for remerge-diff are written. */
 372         struct tmp_objdir *remerge_objdir;
 373 };
 374
 375 /**
 376  * Initialize the "struct rev_info" structure with a macro.
 377  *
 378  * This will not fully initialize a "struct rev_info", the
 379  * repo_init_revisions() function needs to be called before
 380  * setup_revisions() and any revision walking takes place.
 381  *
 382  * Use REV_INFO_INIT to make the "struct rev_info" safe for passing to
 383  * release_revisions() when it's inconvenient (e.g. due to a "goto
 384  * cleanup" pattern) to arrange for repo_init_revisions() to be called
 385  * before release_revisions() is called.
 386  *
 387  * Initializing with this REV_INFO_INIT is redundant to invoking
 388  * repo_init_revisions(). If repo_init_revisions() is guaranteed to be
 389  * called before release_revisions() the "struct rev_info" can be left
 390  * uninitialized.
 391  */
 392 #define REV_INFO_INIT { \
 393         .abbrev = DEFAULT_ABBREV, \
 394         .simplify_history = 1, \
 395         .pruning.flags.recursive = 1, \
 396         .pruning.flags.quick = 1, \
 397         .sort_order = REV_SORT_IN_GRAPH_ORDER, \
 398         .dense = 1, \
 399         .max_age = -1, \
 400         .max_age_as_filter = -1, \
 401         .min_age = -1, \
 402         .skip_count = -1, \
 403         .max_count = -1, \
 404         .max_parents = -1, \
 405         .expand_tabs_in_log = -1, \
 406         .commit_format = CMIT_FMT_DEFAULT, \
 407         .expand_tabs_in_log_default = 8, \
 408 }
 409
 410 /**
 411  * Initialize a rev_info structure with default values. The third parameter may
 412  * be NULL or can be prefix path, and then the `.prefix` variable will be set
 413  * to it. This is typically the first function you want to call when you want
 414  * to deal with a revision list. After calling this function, you are free to
 415  * customize options, like set `.ignore_merges` to 0 if you don't want to
 416  * ignore merges, and so on.
 417  */
 418 void repo_init_revisions(struct repository *r,
 419                          struct rev_info *revs,
 420                          const char *prefix);
 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