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