Andrew's git - gitweb.git/blob

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