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