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