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