git.oblomov.eu Git - git/blob - 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                         /*
 129                          * Blobs are shown without regard for their existence.
 130                          * But not so for trees: unless exclude_promisor_objects
 131                          * is set and the tree in question is a promisor object;
 132                          * OR ignore_missing_links is set, the revision walker
 133                          * dies with a "bad tree object HASH" message when
 134                          * encountering a missing tree. For callers that can
 135                          * handle missing trees and want them to be filterable
 136                          * and showable, set this to true. The revision walker
 137                          * will filter and show such a missing tree as usual,
 138                          * but will not attempt to recurse into this tree
 139                          * object.
 140                          */
 141                         do_not_die_on_missing_tree:1,
 142
 143                         /* for internal use only */
 144                         exclude_promisor_objects:1;
 145
 146         /* Diff flags */
 147         unsigned int    diff:1,
 148                         full_diff:1,
 149                         show_root_diff:1,
 150                         no_commit_id:1,
 151                         verbose_header:1,
 152                         ignore_merges:1,
 153                         combine_merges:1,
 154                         dense_combined_merges:1,
 155                         always_show_header:1;
 156
 157         /* Format info */
 158         unsigned int    shown_one:1,
 159                         shown_dashes:1,
 160                         show_merge:1,
 161                         show_notes:1,
 162                         show_notes_given:1,
 163                         show_signature:1,
 164                         pretty_given:1,
 165                         abbrev_commit:1,
 166                         abbrev_commit_given:1,
 167                         zero_commit:1,
 168                         use_terminator:1,
 169                         missing_newline:1,
 170                         date_mode_explicit:1,
 171                         preserve_subject:1;
 172         unsigned int    disable_stdin:1;
 173         /* --show-linear-break */
 174         unsigned int    track_linear:1,
 175                         track_first_time:1,
 176                         linear:1;
 177
 178         struct date_mode date_mode;
 179         int             expand_tabs_in_log; /* unset if negative */
 180         int             expand_tabs_in_log_default;
 181
 182         unsigned int    abbrev;
 183         enum cmit_fmt   commit_format;
 184         struct log_info *loginfo;
 185         int             nr, total;
 186         const char      *mime_boundary;
 187         const char      *patch_suffix;
 188         int             numbered_files;
 189         int             reroll_count;
 190         char            *message_id;
 191         struct ident_split from_ident;
 192         struct string_list *ref_message_ids;
 193         int             add_signoff;
 194         const char      *extra_headers;
 195         const char      *log_reencode;
 196         const char      *subject_prefix;
 197         int             no_inline;
 198         int             show_log_size;
 199         struct string_list *mailmap;
 200
 201         /* Filter by commit log message */
 202         struct grep_opt grep_filter;
 203         /* Negate the match of grep_filter */
 204         int invert_grep;
 205
 206         /* Display history graph */
 207         struct git_graph *graph;
 208
 209         /* special limits */
 210         int skip_count;
 211         int max_count;
 212         timestamp_t max_age;
 213         timestamp_t min_age;
 214         int min_parents;
 215         int max_parents;
 216         int (*include_check)(struct commit *, void *);
 217         void *include_check_data;
 218
 219         /* diff info for patches and for paths limiting */
 220         struct diff_options diffopt;
 221         struct diff_options pruning;
 222
 223         struct reflog_walk_info *reflog_info;
 224         struct decoration children;
 225         struct decoration merge_simplification;
 226         struct decoration treesame;
 227
 228         /* notes-specific options: which refs to show */
 229         struct display_notes_opt notes_opt;
 230
 231         /* commit counts */
 232         int count_left;
 233         int count_right;
 234         int count_same;
 235
 236         /* line level range that we are chasing */
 237         struct decoration line_log_data;
 238
 239         /* copies of the parent lists, for --full-diff display */
 240         struct saved_parents *saved_parents_slab;
 241
 242         struct commit_list *previous_parents;
 243         const char *break_bar;
 244
 245         struct revision_sources *sources;
 246 };
 247
 248 extern int ref_excluded(struct string_list *, const char *path);
 249 void clear_ref_exclusion(struct string_list **);
 250 void add_ref_exclusion(struct string_list **, const char *exclude);
 251
 252
 253 #define REV_TREE_SAME           0
 254 #define REV_TREE_NEW            1       /* Only new files */
 255 #define REV_TREE_OLD            2       /* Only files removed */
 256 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
 257
 258 /* revision.c */
 259 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
 260 extern volatile show_early_output_fn_t show_early_output;
 261
 262 struct setup_revision_opt {
 263         const char *def;
 264         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
 265         const char *submodule;
 266         int assume_dashdash;
 267         unsigned revarg_opt;
 268 };
 269
 270 extern void init_revisions(struct rev_info *revs, const char *prefix);
 271 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
 272                            struct setup_revision_opt *);
 273 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
 274                                const struct option *options,
 275                                const char * const usagestr[]);
 276 #define REVARG_CANNOT_BE_FILENAME 01
 277 #define REVARG_COMMITTISH 02
 278 extern int handle_revision_arg(const char *arg, struct rev_info *revs,
 279                                int flags, unsigned revarg_opt);
 280
 281 extern void reset_revision_walk(void);
 282 extern int prepare_revision_walk(struct rev_info *revs);
 283 extern struct commit *get_revision(struct rev_info *revs);
 284 extern char *get_revision_mark(const struct rev_info *revs,
 285                                const struct commit *commit);
 286 extern void put_revision_mark(const struct rev_info *revs,
 287                               const struct commit *commit);
 288
 289 extern void mark_parents_uninteresting(struct commit *commit);
 290 extern void mark_tree_uninteresting(struct tree *tree);
 291
 292 extern void show_object_with_name(FILE *, struct object *, const char *);
 293
 294 extern void add_pending_object(struct rev_info *revs,
 295                                struct object *obj, const char *name);
 296 extern void add_pending_oid(struct rev_info *revs,
 297                             const char *name, const struct object_id *oid,
 298                             unsigned int flags);
 299
 300 extern void add_head_to_pending(struct rev_info *);
 301 extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
 302 extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
 303
 304 enum commit_action {
 305         commit_ignore,
 306         commit_show,
 307         commit_error
 308 };
 309
 310 extern enum commit_action get_commit_action(struct rev_info *revs,
 311                                             struct commit *commit);
 312 extern enum commit_action simplify_commit(struct rev_info *revs,
 313                                           struct commit *commit);
 314
 315 enum rewrite_result {
 316         rewrite_one_ok,
 317         rewrite_one_noparents,
 318         rewrite_one_error
 319 };
 320
 321 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
 322
 323 extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
 324         rewrite_parent_fn_t rewrite_parent);
 325
 326 /*
 327  * The log machinery saves the original parent list so that
 328  * get_saved_parents() can later tell what the real parents of the
 329  * commits are, when commit->parents has been modified by history
 330  * simpification.
 331  *
 332  * get_saved_parents() will transparently return commit->parents if
 333  * history simplification is off.
 334  */
 335 extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
 336
 337 #endif