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