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