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