revision.h

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