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