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                        show_all:1,
  94                        remove_empty_trees:1,
  95                        simplify_history:1,
  96                        topo_order:1,
  97                        simplify_merges:1,
  98                        simplify_by_decoration:1,
  99                        single_worktree:1,
 100                        tag_objects:1,
 101                        tree_objects:1,
 102                        blob_objects:1,
 103                        verify_objects:1,
 104                        edge_hint:1,
 105                        edge_hint_aggressive:1,
 106                        limited:1,
 107                        unpacked:1,
 108                        boundary:2,
 109                        count:1,
 110                        left_right:1,
 111                        left_only:1,
 112                        right_only:1,
 113                        rewrite_parents:1,
 114                        print_parents:1,
 115                        show_source:1,
 116                        show_decorations:1,
 117                        reverse:1,
 118                        reverse_output_stage:1,
 119                        cherry_pick:1,
 120                        cherry_mark:1,
 121                        bisect:1,
 122                        ancestry_path:1,
 123                        first_parent_only:1,
 124                        line_level_traverse:1,
 125                        tree_blobs_in_commit_order:1;
 126
 127        /* Diff flags */
 128        unsigned int    diff:1,
 129                        full_diff:1,
 130                        show_root_diff:1,
 131                        no_commit_id:1,
 132                        verbose_header:1,
 133                        ignore_merges:1,
 134                        combine_merges:1,
 135                        dense_combined_merges:1,
 136                        always_show_header:1;
 137
 138        /* Format info */
 139        unsigned int    shown_one:1,
 140                        shown_dashes:1,
 141                        show_merge:1,
 142                        show_notes:1,
 143                        show_notes_given:1,
 144                        show_signature:1,
 145                        pretty_given:1,
 146                        abbrev_commit:1,
 147                        abbrev_commit_given:1,
 148                        zero_commit:1,
 149                        use_terminator:1,
 150                        missing_newline:1,
 151                        date_mode_explicit:1,
 152                        preserve_subject:1;
 153        unsigned int    disable_stdin:1;
 154        /*
 155         * Set `leak_pending` to prevent `prepare_revision_walk()` from clearing
 156         * the array of pending objects (`pending`). It will still forget about
 157         * the array and its entries, so they really are leaked. This can be
 158         * useful if the `struct object_array` `pending` is copied before
 159         * calling `prepare_revision_walk()`. By setting `leak_pending`, you
 160         * effectively claim ownership of the old array, so you should most
 161         * likely call `object_array_clear(&pending_copy)` once you are done.
 162         * Observe that this is about ownership of the array and its entries,
 163         * not the commits referenced by those entries.
 164         */
 165        unsigned int    leak_pending:1;
 166        /* --show-linear-break */
 167        unsigned int    track_linear:1,
 168                        track_first_time:1,
 169                        linear:1;
 170
 171        struct date_mode date_mode;
 172        int             expand_tabs_in_log; /* unset if negative */
 173        int             expand_tabs_in_log_default;
 174
 175        unsigned int    abbrev;
 176        enum cmit_fmt   commit_format;
 177        struct log_info *loginfo;
 178        int             nr, total;
 179        const char      *mime_boundary;
 180        const char      *patch_suffix;
 181        int             numbered_files;
 182        int             reroll_count;
 183        char            *message_id;
 184        struct ident_split from_ident;
 185        struct string_list *ref_message_ids;
 186        int             add_signoff;
 187        const char      *extra_headers;
 188        const char      *log_reencode;
 189        const char      *subject_prefix;
 190        int             no_inline;
 191        int             show_log_size;
 192        struct string_list *mailmap;
 193
 194        /* Filter by commit log message */
 195        struct grep_opt grep_filter;
 196        /* Negate the match of grep_filter */
 197        int invert_grep;
 198
 199        /* Display history graph */
 200        struct git_graph *graph;
 201
 202        /* special limits */
 203        int skip_count;
 204        int max_count;
 205        timestamp_t max_age;
 206        timestamp_t min_age;
 207        int min_parents;
 208        int max_parents;
 209        int (*include_check)(struct commit *, void *);
 210        void *include_check_data;
 211
 212        /* diff info for patches and for paths limiting */
 213        struct diff_options diffopt;
 214        struct diff_options pruning;
 215
 216        struct reflog_walk_info *reflog_info;
 217        struct decoration children;
 218        struct decoration merge_simplification;
 219        struct decoration treesame;
 220
 221        /* notes-specific options: which refs to show */
 222        struct display_notes_opt notes_opt;
 223
 224        /* commit counts */
 225        int count_left;
 226        int count_right;
 227        int count_same;
 228
 229        /* line level range that we are chasing */
 230        struct decoration line_log_data;
 231
 232        /* copies of the parent lists, for --full-diff display */
 233        struct saved_parents *saved_parents_slab;
 234
 235        struct commit_list *previous_parents;
 236        const char *break_bar;
 237};
 238
 239extern int ref_excluded(struct string_list *, const char *path);
 240void clear_ref_exclusion(struct string_list **);
 241void add_ref_exclusion(struct string_list **, const char *exclude);
 242
 243
 244#define REV_TREE_SAME           0
 245#define REV_TREE_NEW            1       /* Only new files */
 246#define REV_TREE_OLD            2       /* Only files removed */
 247#define REV_TREE_DIFFERENT      3       /* Mixed changes */
 248
 249/* revision.c */
 250typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
 251extern volatile show_early_output_fn_t show_early_output;
 252
 253struct setup_revision_opt {
 254        const char *def;
 255        void (*tweak)(struct rev_info *, struct setup_revision_opt *);
 256        const char *submodule;
 257        int assume_dashdash;
 258        unsigned revarg_opt;
 259};
 260
 261extern void init_revisions(struct rev_info *revs, const char *prefix);
 262extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
 263                           struct setup_revision_opt *);
 264extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
 265                               const struct option *options,
 266                               const char * const usagestr[]);
 267#define REVARG_CANNOT_BE_FILENAME 01
 268#define REVARG_COMMITTISH 02
 269extern int handle_revision_arg(const char *arg, struct rev_info *revs,
 270                               int flags, unsigned revarg_opt);
 271
 272extern void reset_revision_walk(void);
 273extern int prepare_revision_walk(struct rev_info *revs);
 274extern struct commit *get_revision(struct rev_info *revs);
 275extern char *get_revision_mark(const struct rev_info *revs,
 276                               const struct commit *commit);
 277extern void put_revision_mark(const struct rev_info *revs,
 278                              const struct commit *commit);
 279
 280extern void mark_parents_uninteresting(struct commit *commit);
 281extern void mark_tree_uninteresting(struct tree *tree);
 282
 283extern void show_object_with_name(FILE *, struct object *, const char *);
 284
 285extern void add_pending_object(struct rev_info *revs,
 286                               struct object *obj, const char *name);
 287extern void add_pending_oid(struct rev_info *revs,
 288                            const char *name, const struct object_id *oid,
 289                            unsigned int flags);
 290
 291extern void add_head_to_pending(struct rev_info *);
 292extern void add_reflogs_to_pending(struct rev_info *, unsigned int flags);
 293extern void add_index_objects_to_pending(struct rev_info *, unsigned int flags);
 294
 295enum commit_action {
 296        commit_ignore,
 297        commit_show,
 298        commit_error
 299};
 300
 301extern enum commit_action get_commit_action(struct rev_info *revs,
 302                                            struct commit *commit);
 303extern enum commit_action simplify_commit(struct rev_info *revs,
 304                                          struct commit *commit);
 305
 306enum rewrite_result {
 307        rewrite_one_ok,
 308        rewrite_one_noparents,
 309        rewrite_one_error
 310};
 311
 312typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
 313
 314extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
 315        rewrite_parent_fn_t rewrite_parent);
 316
 317/*
 318 * The log machinery saves the original parent list so that
 319 * get_saved_parents() can later tell what the real parents of the
 320 * commits are, when commit->parents has been modified by history
 321 * simpification.
 322 *
 323 * get_saved_parents() will transparently return commit->parents if
 324 * history simplification is off.
 325 */
 326extern struct commit_list *get_saved_parents(struct rev_info *revs, const struct commit *commit);
 327
 328#endif