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