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         /* topo-sort */
  75         enum rev_sort_order sort_order;
  76
  77         unsigned int    early_output:1,
  78                         ignore_missing:1,
  79                         ignore_missing_links:1;
  80
  81         /* Traversal flags */
  82         unsigned int    dense:1,
  83                         prune:1,
  84                         no_walk:2,
  85                         show_all:1,
  86                         remove_empty_trees:1,
  87                         simplify_history:1,
  88                         topo_order:1,
  89                         simplify_merges:1,
  90                         simplify_by_decoration:1,
  91                         tag_objects:1,
  92                         tree_objects:1,
  93                         blob_objects:1,
  94                         verify_objects:1,
  95                         edge_hint:1,
  96                         limited:1,
  97                         unpacked:1,
  98                         boundary:2,
  99                         count:1,
 100                         left_right:1,
 101                         left_only:1,
 102                         right_only:1,
 103                         rewrite_parents:1,
 104                         print_parents:1,
 105                         show_source:1,
 106                         show_decorations:1,
 107                         reverse:1,
 108                         reverse_output_stage:1,
 109                         cherry_pick:1,
 110                         cherry_mark:1,
 111                         bisect:1,
 112                         ancestry_path:1,
 113                         first_parent_only:1,
 114                         line_level_traverse:1;
 115
 116         /* Diff flags */
 117         unsigned int    diff:1,
 118                         full_diff:1,
 119                         show_root_diff:1,
 120                         no_commit_id:1,
 121                         verbose_header:1,
 122                         ignore_merges:1,
 123                         combine_merges:1,
 124                         dense_combined_merges:1,
 125                         always_show_header:1;
 126
 127         /* Format info */
 128         unsigned int    shown_one:1,
 129                         shown_dashes:1,
 130                         show_merge:1,
 131                         show_notes:1,
 132                         show_notes_given:1,
 133                         show_signature:1,
 134                         pretty_given:1,
 135                         abbrev_commit:1,
 136                         abbrev_commit_given:1,
 137                         use_terminator:1,
 138                         missing_newline:1,
 139                         date_mode_explicit:1,
 140                         preserve_subject:1;
 141         unsigned int    disable_stdin:1;
 142         unsigned int    leak_pending:1;
 143         /* --show-linear-break */
 144         unsigned int    track_linear:1,
 145                         track_first_time:1,
 146                         linear:1;
 147
 148         enum date_mode date_mode;
 149
 150         unsigned int    abbrev;
 151         enum cmit_fmt   commit_format;
 152         struct log_info *loginfo;
 153         int             nr, total;
 154         const char      *mime_boundary;
 155         const char      *patch_suffix;
 156         int             numbered_files;
 157         int             reroll_count;
 158         char            *message_id;
 159         struct ident_split from_ident;
 160         struct string_list *ref_message_ids;
 161         int             add_signoff;
 162         const char      *extra_headers;
 163         const char      *log_reencode;
 164         const char      *subject_prefix;
 165         int             no_inline;
 166         int             show_log_size;
 167         struct string_list *mailmap;
 168
 169         /* Filter by commit log message */
 170         struct grep_opt grep_filter;
 171
 172         /* Display history graph */
 173         struct git_graph *graph;
 174
 175         /* special limits */
 176         int skip_count;
 177         int max_count;
 178         unsigned long max_age;
 179         unsigned long min_age;
 180         int min_parents;
 181         int max_parents;
 182         int (*include_check)(struct commit *, void *);
 183         void *include_check_data;
 184
 185         /* diff info for patches and for paths limiting */
 186         struct diff_options diffopt;
 187         struct diff_options pruning;
 188
 189         struct reflog_walk_info *reflog_info;
 190         struct decoration children;
 191         struct decoration merge_simplification;
 192         struct decoration treesame;
 193
 194         /* notes-specific options: which refs to show */
 195         struct display_notes_opt notes_opt;
 196
 197         /* commit counts */
 198         int count_left;
 199         int count_right;
 200         int count_same;
 201
 202         /* line level range that we are chasing */
 203         struct decoration line_log_data;
 204
 205         /* copies of the parent lists, for --full-diff display */
 206         struct saved_parents *saved_parents_slab;
 207
 208         struct commit_list *previous_parents;
 209         const char *break_bar;
 210 };
 211
 212 extern int ref_excluded(struct string_list *, const char *path);
 213 void clear_ref_exclusion(struct string_list **);
 214 void add_ref_exclusion(struct string_list **, const char *exclude);
 215
 216
 217 #define REV_TREE_SAME           0
 218 #define REV_TREE_NEW            1       /* Only new files */
 219 #define REV_TREE_OLD            2       /* Only files removed */
 220 #define REV_TREE_DIFFERENT      3       /* Mixed changes */
 221
 222 /* revision.c */
 223 typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
 224 extern volatile show_early_output_fn_t show_early_output;
 225
 226 struct setup_revision_opt {
 227         const char *def;
 228         void (*tweak)(struct rev_info *, struct setup_revision_opt *);
 229         const char *submodule;
 230         int assume_dashdash;
 231         unsigned revarg_opt;
 232 };
 233
 234 extern void init_revisions(struct rev_info *revs, const char *prefix);
 235 extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
 236                            struct setup_revision_opt *);
 237 extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
 238                                const struct option *options,
 239                                const char * const usagestr[]);
 240 #define REVARG_CANNOT_BE_FILENAME 01
 241 #define REVARG_COMMITTISH 02
 242 extern int handle_revision_arg(const char *arg, struct rev_info *revs,
 243                                int flags, unsigned revarg_opt);
 244
 245 extern void reset_revision_walk(void);
 246 extern int prepare_revision_walk(struct rev_info *revs);
 247 extern struct commit *get_revision(struct rev_info *revs);
 248 extern char *get_revision_mark(const struct rev_info *revs,
 249                                const struct commit *commit);
 250 extern void put_revision_mark(const struct rev_info *revs,
 251                               const struct commit *commit);
 252
 253 extern void mark_parents_uninteresting(struct commit *commit);
 254 extern void mark_tree_uninteresting(struct tree *tree);
 255
 256 struct name_path {
 257         struct name_path *up;
 258         int elem_len;
 259         const char *elem;
 260 };
 261
 262 char *path_name(const struct name_path *path, const char *name);
 263
 264 extern void show_object_with_name(FILE *, struct object *,
 265                                   const struct name_path *, const char *);
 266
 267 extern void add_object(struct object *obj,
 268                        struct object_array *p,
 269                        struct name_path *path,
 270                        const char *name);
 271
 272 extern void add_pending_object(struct rev_info *revs,
 273                                struct object *obj, const char *name);
 274 extern void add_pending_sha1(struct rev_info *revs,
 275                              const char *name, const unsigned char *sha1,
 276                              unsigned int flags);
 277
 278 extern void add_head_to_pending(struct rev_info *);
 279 extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
 280 extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
 281
 282 enum commit_action {
 283         commit_ignore,
 284         commit_show,
 285         commit_error
 286 };
 287
 288 extern enum commit_action get_commit_action(struct rev_info *revs,
 289                                             struct commit *commit);
 290 extern enum commit_action simplify_commit(struct rev_info *revs,
 291                                           struct commit *commit);
 292
 293 enum rewrite_result {
 294         rewrite_one_ok,
 295         rewrite_one_noparents,
 296         rewrite_one_error
 297 };
 298
 299 typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
 300
 301 extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
 302         rewrite_parent_fn_t rewrite_parent);
 303
 304 /*
 305  * Save a copy of the parent list, and return the saved copy.  This is
 306  * used by the log machinery to retrieve the original parents when
 307  * commit->parents has been modified by history simpification.
 308  *
 309  * You may only call save_parents() once per commit (this is checked
 310  * for non-root commits).
 311  *
 312  * get_saved_parents() will transparently return commit->parents if
 313  * history simplification is off.
 314  */
 315 extern void save_parents(struct rev_info *revs, struct commit *commit);
 316 extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
 317 extern void free_saved_parents(struct rev_info *revs);
 318
 319 #endif