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