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 /* Remember to update object flag allocation in object.h */
  13 #define SEEN            (1u<<0)
  14 #define UNINTERESTING   (1u<<1)
  15 #define TREESAME        (1u<<2)
  16 #define SHOWN           (1u<<3)
  17 #define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
  18 #define BOUNDARY        (1u<<5)
  19 #define CHILD_SHOWN     (1u<<6)
  20 #define ADDED           (1u<<7) /* Parents already parsed and added? */
  21 #define SYMMETRIC_LEFT  (1u<<8)
  22 #define PATCHSAME       (1u<<9)
  23 #define BOTTOM          (1u<<10)
  24 #define USER_GIVEN      (1u<<25) /* given directly by the user */
  25 #define TRACK_LINEAR    (1u<<26)
  26 #define ALL_REV_FLAGS   (((1u<<11)-1) | USER_GIVEN | TRACK_LINEAR)
  27 #define TOPO_WALK_EXPLORED      (1u<<27)
  28 #define TOPO_WALK_INDEGREE      (1u<<28)
  29
  30 #define DECORATE_SHORT_REFS     1
  31 #define DECORATE_FULL_REFS      2
  32
  33 struct rev_info;
  34 struct log_info;
  35 struct string_list;
  36 struct saved_parents;
  37 define_shared_commit_slab(revision_sources, char *);
  38
  39 struct rev_cmdline_info {
  40         unsigned int nr;
  41         unsigned int alloc;
  42         struct rev_cmdline_entry {
  43                 struct object *item;
  44                 const char *name;
  45                 enum {
  46                         REV_CMD_REF,
  47                         REV_CMD_PARENTS_ONLY,
  48                         REV_CMD_LEFT,
  49                         REV_CMD_RIGHT,
  50                         REV_CMD_MERGE_BASE,
  51                         REV_CMD_REV
  52                 } whence;
  53                 unsigned flags;
  54         } *rev;
  55 };
  56
  57 #define REVISION_WALK_WALK 0
  58 #define REVISION_WALK_NO_WALK_SORTED 1
  59 #define REVISION_WALK_NO_WALK_UNSORTED 2
  60
  61 struct topo_walk_info;
  62
  63 struct rev_info {
  64         /* Starting list */
  65         struct commit_list *commits;
  66         struct object_array pending;
  67
  68         /* Parents of shown commits */
  69         struct object_array boundary_commits;
  70
  71         /* The end-points specified by the end user */
  72         struct rev_cmdline_info cmdline;
  73
  74         /* excluding from --branches, --refs, etc. expansion */
  75         struct string_list *ref_excludes;
  76
  77         /* Basic information */
  78         const char *prefix;
  79         const char *def;
  80         struct pathspec prune_data;
  81
  82         /*
  83          * Whether the arguments parsed by setup_revisions() included any
  84          * "input" revisions that might still have yielded an empty pending
  85          * list (e.g., patterns like "--all" or "--glob").
  86          */
  87         int rev_input_given;
  88
  89         /*
  90          * Whether we read from stdin due to the --stdin option.
  91          */
  92         int read_from_stdin;
  93
  94         /* topo-sort */
  95         enum rev_sort_order sort_order;
  96
  97         unsigned int early_output;
  98
  99         unsigned int    ignore_missing:1,
 100                         ignore_missing_links:1;
 101
 102         /* Traversal flags */
 103         unsigned int    dense:1,
 104                         prune:1,
 105                         no_walk:2,
 106                         remove_empty_trees:1,
 107                         simplify_history:1,
 108                         topo_order:1,
 109                         simplify_merges:1,
 110                         simplify_by_decoration:1,
 111                         single_worktree:1,
 112                         tag_objects:1,
 113                         tree_objects:1,
 114                         blob_objects:1,
 115                         verify_objects:1,
 116                         edge_hint:1,
 117                         edge_hint_aggressive:1,
 118                         limited:1,
 119                         unpacked:1,
 120                         boundary:2,
 121                         count:1,
 122                         left_right:1,
 123                         left_only:1,
 124                         right_only:1,
 125                         rewrite_parents:1,
 126                         print_parents:1,
 127                         show_decorations:1,
 128                         reverse:1,
 129                         reverse_output_stage:1,
 130                         cherry_pick:1,
 131                         cherry_mark:1,
 132                         bisect:1,
 133                         ancestry_path:1,
 134                         first_parent_only:1,
 135                         line_level_traverse:1,
 136                         tree_blobs_in_commit_order:1,
 137
 138                         /* for internal use only */
 139                         exclude_promisor_objects:1;
 140
 141         /* Diff flags */
 142         unsigned int    diff:1,
 143                         full_diff:1,
 144                         show_root_diff:1,
 145                         no_commit_id:1,
 146                         verbose_header:1,
 147                         ignore_merges:1,
 148                         combine_merges:1,
 149                         dense_combined_merges:1,
 150                         always_show_header:1;
 151
 152         /* Format info */
 153         unsigned int    shown_one:1,
 154                         shown_dashes:1,
 155                         show_merge:1,
 156                         show_notes:1,
 157                         show_notes_given:1,
 158                         show_signature:1,
 159                         pretty_given:1,
 160                         abbrev_commit:1,
 161                         abbrev_commit_given:1,
 162                         zero_commit:1,
 163                         use_terminator:1,
 164                         missing_newline:1,
 165                         date_mode_explicit:1,
 166                         preserve_subject:1;
 167         unsigned int    disable_stdin:1;
 168         /* --show-linear-break */
 169         unsigned int    track_linear:1,
 170                         track_first_time:1,
 171                         linear:1;
 172
 173         struct date_mode date_mode;
 174         int             expand_tabs_in_log; /* unset if negative */
 175         int             expand_tabs_in_log_default;
 176
 177         unsigned int    abbrev;
 178         enum cmit_fmt   commit_format;
 179         struct log_info *loginfo;
 180         int             nr, total;
 181         const char      *mime_boundary;
 182         const char      *patch_suffix;
 183         int             numbered_files;
 184         int             reroll_count;
 185         char            *message_id;
 186         struct ident_split from_ident;
 187         struct string_list *ref_message_ids;
 188         int             add_signoff;
 189         const char      *extra_headers;
 190         const char      *log_reencode;
 191         const char      *subject_prefix;
 192         int             no_inline;
 193         int             show_log_size;
 194         struct string_list *mailmap;
 195
 196         /* Filter by commit log message */
 197         struct grep_opt grep_filter;
 198         /* Negate the match of grep_filter */
 199         int invert_grep;
 200
 201         /* Display history graph */
 202         struct git_graph *graph;
 203
 204         /* special limits */
 205         int skip_count;
 206         int max_count;
 207         timestamp_t max_age;
 208         timestamp_t min_age;
 209         int min_parents;
 210         int max_parents;
 211         int (*include_check)(struct commit *, void *);
 212         void *include_check_data;
 213
 214         /* diff info for patches and for paths limiting */
 215         struct diff_options diffopt;
 216         struct diff_options pruning;
 217
 218         struct reflog_walk_info *reflog_info;
 219         struct decoration children;
 220         struct decoration merge_simplification;
 221         struct decoration treesame;
 222
 223         /* notes-specific options: which refs to show */
 224         struct display_notes_opt notes_opt;
 225
 226         /* interdiff */
 227         const struct object_id *idiff_oid1;
 228         const struct object_id *idiff_oid2;
 229         const char *idiff_title;
 230
 231         /* range-diff */
 232         const char *rdiff1;
 233         const char *rdiff2;
 234         int creation_factor;
 235         const char *rdiff_title;
 236
 237         /* commit counts */
 238         int count_left;
 239         int count_right;
 240         int count_same;
 241
 242         /* line level range that we are chasing */
 243         struct decoration line_log_data;
 244
 245         /* copies of the parent lists, for --full-diff display */
 246         struct saved_parents *saved_parents_slab;
 247
 248         struct commit_list *previous_parents;
 249         const char *break_bar;
 250
 251         struct revision_sources *sources;
 252
 253         struct topo_walk_info *topo_walk_info;
 254 };
 255
 256 int ref_excluded(struct string_list *, const char *path);
 257 void clear_ref_exclusion(struct string_list **);
 258 void add_ref_exclusion(struct string_list **, const char *exclude);
 259
 260
 261 #define REV_TREE_SAME           0
 262 #define REV_TREE_NEW            1       /* Only new files */
 263 #define REV_TREE_OLD            2       /* Only files removed */
 264 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
 265
 266 /* revision.c */
 267 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
 268 extern volatile show_early_output_fn_t show_early_output;
 269
 270 struct setup_revision_opt {
 271         const char *def;
 272         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
 273         const char *submodule;
 274         int assume_dashdash;
 275         unsigned revarg_opt;
 276 };
 277
 278 void init_revisions(struct rev_info *revs, const char *prefix);
 279 int setup_revisions(int argc, const char **argv, struct rev_info *revs,
 280                     struct setup_revision_opt *);
 281 void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
 282                         const struct option *options,
 283                         const char * const usagestr[]);
 284 #define REVARG_CANNOT_BE_FILENAME 01
 285 #define REVARG_COMMITTISH 02
 286 int handle_revision_arg(const char *arg, struct rev_info *revs,
 287                         int flags, unsigned revarg_opt);
 288
 289 void reset_revision_walk(void);
 290 int prepare_revision_walk(struct rev_info *revs);
 291 struct commit *get_revision(struct rev_info *revs);
 292 char *get_revision_mark(const struct rev_info *revs,
 293                         const struct commit *commit);
 294 void put_revision_mark(const struct rev_info *revs,
 295                        const struct commit *commit);
 296
 297 void mark_parents_uninteresting(struct commit *commit);
 298 void mark_tree_uninteresting(struct tree *tree);
 299
 300 void show_object_with_name(FILE *, struct object *, const char *);
 301
 302 void add_pending_object(struct rev_info *revs,
 303                         struct object *obj, const char *name);
 304 void add_pending_oid(struct rev_info *revs,
 305                      const char *name, const struct object_id *oid,
 306                      unsigned int flags);
 307
 308 void add_head_to_pending(struct rev_info *);
 309 void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
 310 void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
 311
 312 enum commit_action {
 313         commit_ignore,
 314         commit_show,
 315         commit_error
 316 };
 317
 318 enum commit_action get_commit_action(struct rev_info *revs,
 319                                      struct commit *commit);
 320 enum commit_action simplify_commit(struct rev_info *revs,
 321                                    struct commit *commit);
 322
 323 enum rewrite_result {
 324         rewrite_one_ok,
 325         rewrite_one_noparents,
 326         rewrite_one_error
 327 };
 328
 329 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
 330
 331 int rewrite_parents(struct rev_info *revs,
 332                     struct commit *commit,
 333                     rewrite_parent_fn_t rewrite_parent);
 334
 335 /*
 336  * The log machinery saves the original parent list so that
 337  * get_saved_parents() can later tell what the real parents of the
 338  * commits are, when commit->parents has been modified by history
 339  * simpification.
 340  *
 341  * get_saved_parents() will transparently return commit->parents if
 342  * history simplification is off.
 343  */
 344 struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
 345
 346 #endif