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