Andrew's git - gitweb.git/blob

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