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