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