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