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