revision.hon commit xread/xwrite: clip MAX_IO_SIZE to SSIZE_MAX (a983e6a)
   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
   9#define SEEN            (1u<<0)
  10#define UNINTERESTING   (1u<<1)
  11#define TREESAME        (1u<<2)
  12#define SHOWN           (1u<<3)
  13#define TMP_MARK        (1u<<4) /* for isolated cases; clean after use */
  14#define BOUNDARY        (1u<<5)
  15#define CHILD_SHOWN     (1u<<6)
  16#define ADDED           (1u<<7) /* Parents already parsed and added? */
  17#define SYMMETRIC_LEFT  (1u<<8)
  18#define PATCHSAME       (1u<<9)
  19#define BOTTOM          (1u<<10)
  20#define ALL_REV_FLAGS   ((1u<<11)-1)
  21
  22#define DECORATE_SHORT_REFS     1
  23#define DECORATE_FULL_REFS      2
  24
  25struct rev_info;
  26struct log_info;
  27struct string_list;
  28
  29struct rev_cmdline_info {
  30        unsigned int nr;
  31        unsigned int alloc;
  32        struct rev_cmdline_entry {
  33                struct object *item;
  34                const char *name;
  35                enum {
  36                        REV_CMD_REF,
  37                        REV_CMD_PARENTS_ONLY,
  38                        REV_CMD_LEFT,
  39                        REV_CMD_RIGHT,
  40                        REV_CMD_MERGE_BASE,
  41                        REV_CMD_REV
  42                } whence;
  43                unsigned flags;
  44        } *rev;
  45};
  46
  47#define REVISION_WALK_WALK 0
  48#define REVISION_WALK_NO_WALK_SORTED 1
  49#define REVISION_WALK_NO_WALK_UNSORTED 2
  50
  51struct rev_info {
  52        /* Starting list */
  53        struct commit_list *commits;
  54        struct object_array pending;
  55
  56        /* Parents of shown commits */
  57        struct object_array boundary_commits;
  58
  59        /* The end-points specified by the end user */
  60        struct rev_cmdline_info cmdline;
  61
  62        /* Basic information */
  63        const char *prefix;
  64        const char *def;
  65        struct pathspec prune_data;
  66
  67        /* topo-sort */
  68        enum rev_sort_order sort_order;
  69
  70        unsigned int    early_output:1,
  71                        ignore_missing:1;
  72
  73        /* Traversal flags */
  74        unsigned int    dense:1,
  75                        prune:1,
  76                        no_walk:2,
  77                        show_all:1,
  78                        remove_empty_trees:1,
  79                        simplify_history:1,
  80                        topo_order:1,
  81                        simplify_merges:1,
  82                        simplify_by_decoration:1,
  83                        tag_objects:1,
  84                        tree_objects:1,
  85                        blob_objects:1,
  86                        verify_objects:1,
  87                        edge_hint:1,
  88                        limited:1,
  89                        unpacked:1,
  90                        boundary:2,
  91                        count:1,
  92                        left_right:1,
  93                        left_only:1,
  94                        right_only:1,
  95                        rewrite_parents:1,
  96                        print_parents:1,
  97                        show_source:1,
  98                        show_decorations:1,
  99                        reverse:1,
 100                        reverse_output_stage:1,
 101                        cherry_pick:1,
 102                        cherry_mark:1,
 103                        bisect:1,
 104                        ancestry_path:1,
 105                        first_parent_only:1,
 106                        line_level_traverse:1;
 107
 108        /* Diff flags */
 109        unsigned int    diff:1,
 110                        full_diff:1,
 111                        show_root_diff:1,
 112                        no_commit_id:1,
 113                        verbose_header:1,
 114                        ignore_merges:1,
 115                        combine_merges:1,
 116                        dense_combined_merges:1,
 117                        always_show_header:1;
 118
 119        /* Format info */
 120        unsigned int    shown_one:1,
 121                        shown_dashes:1,
 122                        show_merge:1,
 123                        show_notes:1,
 124                        show_notes_given:1,
 125                        show_signature:1,
 126                        pretty_given:1,
 127                        abbrev_commit:1,
 128                        abbrev_commit_given:1,
 129                        use_terminator:1,
 130                        missing_newline:1,
 131                        date_mode_explicit:1,
 132                        preserve_subject:1;
 133        unsigned int    disable_stdin:1;
 134        unsigned int    leak_pending:1;
 135
 136        enum date_mode date_mode;
 137
 138        unsigned int    abbrev;
 139        enum cmit_fmt   commit_format;
 140        struct log_info *loginfo;
 141        int             nr, total;
 142        const char      *mime_boundary;
 143        const char      *patch_suffix;
 144        int             numbered_files;
 145        int             reroll_count;
 146        char            *message_id;
 147        struct ident_split from_ident;
 148        struct string_list *ref_message_ids;
 149        int             add_signoff;
 150        const char      *extra_headers;
 151        const char      *log_reencode;
 152        const char      *subject_prefix;
 153        int             no_inline;
 154        int             show_log_size;
 155        struct string_list *mailmap;
 156
 157        /* Filter by commit log message */
 158        struct grep_opt grep_filter;
 159
 160        /* Display history graph */
 161        struct git_graph *graph;
 162
 163        /* special limits */
 164        int skip_count;
 165        int max_count;
 166        unsigned long max_age;
 167        unsigned long min_age;
 168        int min_parents;
 169        int max_parents;
 170
 171        /* diff info for patches and for paths limiting */
 172        struct diff_options diffopt;
 173        struct diff_options pruning;
 174
 175        struct reflog_walk_info *reflog_info;
 176        struct decoration children;
 177        struct decoration merge_simplification;
 178        struct decoration treesame;
 179
 180        /* notes-specific options: which refs to show */
 181        struct display_notes_opt notes_opt;
 182
 183        /* commit counts */
 184        int count_left;
 185        int count_right;
 186        int count_same;
 187
 188        /* line level range that we are chasing */
 189        struct decoration line_log_data;
 190};
 191
 192#define REV_TREE_SAME           0
 193#define REV_TREE_NEW            1       /* Only new files */
 194#define REV_TREE_OLD            2       /* Only files removed */
 195#define REV_TREE_DIFFERENT      3       /* Mixed changes */
 196
 197/* revision.c */
 198typedef void (*show_early_output_fn_t)(struct rev_info *, struct commit_list *);
 199extern volatile show_early_output_fn_t show_early_output;
 200
 201struct setup_revision_opt {
 202        const char *def;
 203        void (*tweak)(struct rev_info *, struct setup_revision_opt *);
 204        const char *submodule;
 205        int assume_dashdash;
 206        unsigned revarg_opt;
 207};
 208
 209extern void init_revisions(struct rev_info *revs, const char *prefix);
 210extern int setup_revisions(int argc, const char **argv, struct rev_info *revs,
 211                           struct setup_revision_opt *);
 212extern void parse_revision_opt(struct rev_info *revs, struct parse_opt_ctx_t *ctx,
 213                               const struct option *options,
 214                               const char * const usagestr[]);
 215#define REVARG_CANNOT_BE_FILENAME 01
 216#define REVARG_COMMITTISH 02
 217extern int handle_revision_arg(const char *arg, struct rev_info *revs,
 218                               int flags, unsigned revarg_opt);
 219
 220extern void reset_revision_walk(void);
 221extern int prepare_revision_walk(struct rev_info *revs);
 222extern struct commit *get_revision(struct rev_info *revs);
 223extern char *get_revision_mark(const struct rev_info *revs,
 224                               const struct commit *commit);
 225extern void put_revision_mark(const struct rev_info *revs,
 226                              const struct commit *commit);
 227
 228extern void mark_parents_uninteresting(struct commit *commit);
 229extern void mark_tree_uninteresting(struct tree *tree);
 230
 231struct name_path {
 232        struct name_path *up;
 233        int elem_len;
 234        const char *elem;
 235};
 236
 237char *path_name(const struct name_path *path, const char *name);
 238
 239extern void show_object_with_name(FILE *, struct object *,
 240                                  const struct name_path *, const char *);
 241
 242extern void add_object(struct object *obj,
 243                       struct object_array *p,
 244                       struct name_path *path,
 245                       const char *name);
 246
 247extern void add_pending_object(struct rev_info *revs,
 248                               struct object *obj, const char *name);
 249extern void add_pending_sha1(struct rev_info *revs,
 250                             const char *name, const unsigned char *sha1,
 251                             unsigned int flags);
 252
 253extern void add_head_to_pending(struct rev_info *);
 254
 255enum commit_action {
 256        commit_ignore,
 257        commit_show,
 258        commit_error
 259};
 260
 261extern enum commit_action get_commit_action(struct rev_info *revs,
 262                                            struct commit *commit);
 263extern enum commit_action simplify_commit(struct rev_info *revs,
 264                                          struct commit *commit);
 265
 266enum rewrite_result {
 267        rewrite_one_ok,
 268        rewrite_one_noparents,
 269        rewrite_one_error
 270};
 271
 272typedef enum rewrite_result (*rewrite_parent_fn_t)(struct rev_info *revs, struct commit **pp);
 273
 274extern int rewrite_parents(struct rev_info *revs, struct commit *commit,
 275        rewrite_parent_fn_t rewrite_parent);
 276#endif