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