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