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 "commit.h"
   8 #include "diff.h"
   9
  10 /* Remember to update object flag allocation in object.h */
  11 #define SEEN            (1u<<0)
  12 #define UNINTERESTING   (1u<<1)
  13 #define TREESAME        (1u<<2)
  14 #define SHOWN           (1u<<3)
  15 #define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
  16 #define BOUNDARY        (1u<<5)
  17 #define CHILD_SHOWN     (1u<<6)
  18 #define ADDED           (1u<<7) /* Parents already parsed and added? */
  19 #define SYMMETRIC_LEFT  (1u<<8)
  20 #define PATCHSAME       (1u<<9)
  21 #define BOTTOM          (1u<<10)
  22 #define TRACK_LINEAR    (1u<<26)
  23 #define ALL_REV_FLAGS   (((1u<<11)-1) | TRACK_LINEAR)
  24
  25 #define DECORATE_SHORT_REFS     1
  26 #define DECORATE_FULL_REFS      2
  27
  28 struct rev_info;
  29 struct log_info;
  30 struct string_list;
  31 struct saved_parents;
  32
  33 struct rev_cmdline_info {
  34         unsigned int nr;
  35         unsigned int alloc;
  36         struct rev_cmdline_entry {
  37                 struct object *item;
  38                 const char *name;
  39                 enum {
  40                         REV_CMD_REF,
  41                         REV_CMD_PARENTS_ONLY,
  42                         REV_CMD_LEFT,
  43                         REV_CMD_RIGHT,
  44                         REV_CMD_MERGE_BASE,
  45                         REV_CMD_REV
  46                 } whence;
  47                 unsigned flags;
  48         } *rev;
  49 };
  50
  51 #define REVISION_WALK_WALK 0
  52 #define REVISION_WALK_NO_WALK_SORTED 1
  53 #define REVISION_WALK_NO_WALK_UNSORTED 2
  54
  55 struct rev_info {
  56         /* Starting list */
  57         struct commit_list *commits;
  58         struct object_array pending;
  59
  60         /* Parents of shown commits */
  61         struct object_array boundary_commits;
  62
  63         /* The end-points specified by the end user */
  64         struct rev_cmdline_info cmdline;
  65
  66         /* excluding from --branches, --refs, etc. expansion */
  67         struct string_list *ref_excludes;
  68
  69         /* Basic information */
  70         const char *prefix;
  71         const char *def;
  72         struct pathspec prune_data;
  73
  74         /*
  75          * Whether the arguments parsed by setup_revisions() included any
  76          * "input" revisions that might still have yielded an empty pending
  77          * list (e.g., patterns like "--all" or "--glob").
  78          */
  79         int rev_input_given;
  80
  81         /* topo-sort */
  82         enum rev_sort_order sort_order;
  83
  84         unsigned int early_output;
  85
  86         unsigned int    ignore_missing:1,
  87                         ignore_missing_links:1;
  88
  89         /* Traversal flags */
  90         unsigned int    dense:1,
  91                         prune:1,
  92                         no_walk:2,
  93                         show_all:1,
  94                         remove_empty_trees:1,
  95                         simplify_history:1,
  96                         topo_order:1,
  97                         simplify_merges:1,
  98                         simplify_by_decoration:1,
  99                         single_worktree:1,
 100                         tag_objects:1,
 101                         tree_objects:1,
 102                         blob_objects:1,
 103                         verify_objects:1,
 104                         edge_hint:1,
 105                         edge_hint_aggressive:1,
 106                         limited:1,
 107                         unpacked:1,
 108                         boundary:2,
 109                         count:1,
 110                         left_right:1,
 111                         left_only:1,
 112                         right_only:1,
 113                         rewrite_parents:1,
 114                         print_parents:1,
 115                         show_source:1,
 116                         show_decorations:1,
 117                         reverse:1,
 118                         reverse_output_stage:1,
 119                         cherry_pick:1,
 120                         cherry_mark:1,
 121                         bisect:1,
 122                         ancestry_path:1,
 123                         first_parent_only:1,
 124                         line_level_traverse:1,
 125
 126                         /* for internal use only */
 127                         exclude_promisor_objects:1;
 128
 129         /* Diff flags */
 130         unsigned int    diff:1,
 131                         full_diff:1,
 132                         show_root_diff:1,
 133                         no_commit_id:1,
 134                         verbose_header:1,
 135                         ignore_merges:1,
 136                         combine_merges:1,
 137                         dense_combined_merges:1,
 138                         always_show_header:1;
 139
 140         /* Format info */
 141         unsigned int    shown_one:1,
 142                         shown_dashes:1,
 143                         show_merge:1,
 144                         show_notes:1,
 145                         show_notes_given:1,
 146                         show_signature:1,
 147                         pretty_given:1,
 148                         abbrev_commit:1,
 149                         abbrev_commit_given:1,
 150                         zero_commit:1,
 151                         use_terminator:1,
 152                         missing_newline:1,
 153                         date_mode_explicit:1,
 154                         preserve_subject:1;
 155         unsigned int    disable_stdin:1;
 156         /*
 157          * Set `leak_pending` to prevent `prepare_revision_walk()` from clearing
 158          * the array of pending objects (`pending`). It will still forget about
 159          * the array and its entries, so they really are leaked. This can be
 160          * useful if the `struct object_array` `pending` is copied before
 161          * calling `prepare_revision_walk()`. By setting `leak_pending`, you
 162          * effectively claim ownership of the old array, so you should most
 163          * likely call `object_array_clear(&pending_copy)` once you are done.
 164          * Observe that this is about ownership of the array and its entries,
 165          * not the commits referenced by those entries.
 166          */
 167         unsigned int    leak_pending: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         /* commit counts */
 227         int count_left;
 228         int count_right;
 229         int count_same;
 230
 231         /* line level range that we are chasing */
 232         struct decoration line_log_data;
 233
 234         /* copies of the parent lists, for --full-diff display */
 235         struct saved_parents *saved_parents_slab;
 236
 237         struct commit_list *previous_parents;
 238         const char *break_bar;
 239 };
 240
 241 extern int ref_excluded(struct string_list *, const char *path);
 242 void clear_ref_exclusion(struct string_list **);
 243 void add_ref_exclusion(struct string_list **, const char *exclude);
 244
 245
 246 #define REV_TREE_SAME           0
 247 #define REV_TREE_NEW            1       /* Only new files */
 248 #define REV_TREE_OLD            2       /* Only files removed */
 249 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
 250
 251 /* revision.c */
 252 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
 253 extern volatile show_early_output_fn_t show_early_output;
 254
 255 struct setup_revision_opt {
 256         const char *def;
 257         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
 258         const char *submodule;
 259         int assume_dashdash;
 260         unsigned revarg_opt;
 261 };
 262
 263 extern void init_revisions(struct rev_info *revs, const char *prefix);
 264 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
 265                            struct setup_revision_opt *);
 266 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
 267                                const struct option *options,
 268                                const char * const usagestr[]);
 269 #define REVARG_CANNOT_BE_FILENAME 01
 270 #define REVARG_COMMITTISH 02
 271 extern int handle_revision_arg(const char *arg, struct rev_info *revs,
 272                                int flags, unsigned revarg_opt);
 273
 274 extern void reset_revision_walk(void);
 275 extern int prepare_revision_walk(struct rev_info *revs);
 276 extern struct commit *get_revision(struct rev_info *revs);
 277 extern char *get_revision_mark(const struct rev_info *revs,
 278                                const struct commit *commit);
 279 extern void put_revision_mark(const struct rev_info *revs,
 280                               const struct commit *commit);
 281
 282 extern void mark_parents_uninteresting(struct commit *commit);
 283 extern void mark_tree_uninteresting(struct tree *tree);
 284
 285 extern void show_object_with_name(FILE *, struct object *, const char *);
 286
 287 extern void add_pending_object(struct rev_info *revs,
 288                                struct object *obj, const char *name);
 289 extern void add_pending_oid(struct rev_info *revs,
 290                             const char *name, const struct object_id *oid,
 291                             unsigned int flags);
 292
 293 extern void add_head_to_pending(struct rev_info *);
 294 extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
 295 extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
 296
 297 enum commit_action {
 298         commit_ignore,
 299         commit_show,
 300         commit_error
 301 };
 302
 303 extern enum commit_action get_commit_action(struct rev_info *revs,
 304                                             struct commit *commit);
 305 extern enum commit_action simplify_commit(struct rev_info *revs,
 306                                           struct commit *commit);
 307
 308 enum rewrite_result {
 309         rewrite_one_ok,
 310         rewrite_one_noparents,
 311         rewrite_one_error
 312 };
 313
 314 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
 315
 316 extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
 317         rewrite_parent_fn_t rewrite_parent);
 318
 319 /*
 320  * The log machinery saves the original parent list so that
 321  * get_saved_parents() can later tell what the real parents of the
 322  * commits are, when commit->parents has been modified by history
 323  * simpification.
 324  *
 325  * get_saved_parents() will transparently return commit->parents if
 326  * history simplification is off.
 327  */
 328 extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
 329
 330 #endif