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