Andrew's git - gitweb.git/blob

   1/*
   2 * Copyright (C) 2005 Junio C Hamano
   3 */
   4#ifndef DIFF_H
   5#define DIFF_H
   6
   7#include "tree-walk.h"
   8
   9struct rev_info;
  10struct diff_options;
  11struct diff_queue_struct;
  12struct strbuf;
  13struct diff_filespec;
  14struct userdiff_driver;
  15struct sha1_array;
  16struct commit;
  17
  18typedef void (*change_fn_t)(struct diff_options *options,
  19                 unsigned old_mode, unsigned new_mode,
  20                 const unsigned char *old_sha1,
  21                 const unsigned char *new_sha1,
  22                 int old_sha1_valid, int new_sha1_valid,
  23                 const char *fullpath,
  24                 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
  25
  26typedef void (*add_remove_fn_t)(struct diff_options *options,
  27                    int addremove, unsigned mode,
  28                    const unsigned char *sha1,
  29                    int sha1_valid,
  30                    const char *fullpath, unsigned dirty_submodule);
  31
  32typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
  33                struct diff_options *options, void *data);
  34
  35typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
  36
  37#define DIFF_FORMAT_RAW         0x0001
  38#define DIFF_FORMAT_DIFFSTAT    0x0002
  39#define DIFF_FORMAT_NUMSTAT     0x0004
  40#define DIFF_FORMAT_SUMMARY     0x0008
  41#define DIFF_FORMAT_PATCH       0x0010
  42#define DIFF_FORMAT_SHORTSTAT   0x0020
  43#define DIFF_FORMAT_DIRSTAT     0x0040
  44
  45/* These override all above */
  46#define DIFF_FORMAT_NAME        0x0100
  47#define DIFF_FORMAT_NAME_STATUS 0x0200
  48#define DIFF_FORMAT_CHECKDIFF   0x0400
  49
  50/* Same as output_format = 0 but we know that -s flag was given
  51 * and we should not give default value to output_format.
  52 */
  53#define DIFF_FORMAT_NO_OUTPUT   0x0800
  54
  55#define DIFF_FORMAT_CALLBACK    0x1000
  56
  57#define DIFF_OPT_RECURSIVE           (1 <<  0)
  58#define DIFF_OPT_TREE_IN_RECURSIVE   (1 <<  1)
  59#define DIFF_OPT_BINARY              (1 <<  2)
  60#define DIFF_OPT_TEXT                (1 <<  3)
  61#define DIFF_OPT_FULL_INDEX          (1 <<  4)
  62#define DIFF_OPT_SILENT_ON_REMOVE    (1 <<  5)
  63#define DIFF_OPT_FIND_COPIES_HARDER  (1 <<  6)
  64#define DIFF_OPT_FOLLOW_RENAMES      (1 <<  7)
  65#define DIFF_OPT_RENAME_EMPTY        (1 <<  8)
  66/* (1 <<  9) unused */
  67#define DIFF_OPT_HAS_CHANGES         (1 << 10)
  68#define DIFF_OPT_QUICK               (1 << 11)
  69#define DIFF_OPT_NO_INDEX            (1 << 12)
  70#define DIFF_OPT_ALLOW_EXTERNAL      (1 << 13)
  71#define DIFF_OPT_EXIT_WITH_STATUS    (1 << 14)
  72#define DIFF_OPT_REVERSE_DIFF        (1 << 15)
  73#define DIFF_OPT_CHECK_FAILED        (1 << 16)
  74#define DIFF_OPT_RELATIVE_NAME       (1 << 17)
  75#define DIFF_OPT_IGNORE_SUBMODULES   (1 << 18)
  76#define DIFF_OPT_DIRSTAT_CUMULATIVE  (1 << 19)
  77#define DIFF_OPT_DIRSTAT_BY_FILE     (1 << 20)
  78#define DIFF_OPT_ALLOW_TEXTCONV      (1 << 21)
  79#define DIFF_OPT_DIFF_FROM_CONTENTS  (1 << 22)
  80#define DIFF_OPT_SUBMODULE_LOG       (1 << 23)
  81#define DIFF_OPT_DIRTY_SUBMODULES    (1 << 24)
  82#define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
  83#define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
  84#define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
  85#define DIFF_OPT_DIRSTAT_BY_LINE     (1 << 28)
  86#define DIFF_OPT_FUNCCONTEXT         (1 << 29)
  87#define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
  88
  89#define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
  90#define DIFF_OPT_SET(opts, flag)    ((opts)->flags |= DIFF_OPT_##flag)
  91#define DIFF_OPT_CLR(opts, flag)    ((opts)->flags &= ~DIFF_OPT_##flag)
  92#define DIFF_XDL_TST(opts, flag)    ((opts)->xdl_opts & XDF_##flag)
  93#define DIFF_XDL_SET(opts, flag)    ((opts)->xdl_opts |= XDF_##flag)
  94#define DIFF_XDL_CLR(opts, flag)    ((opts)->xdl_opts &= ~XDF_##flag)
  95
  96#define DIFF_WITH_ALG(opts, flag)   (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
  97
  98enum diff_words_type {
  99        DIFF_WORDS_NONE = 0,
 100        DIFF_WORDS_PORCELAIN,
 101        DIFF_WORDS_PLAIN,
 102        DIFF_WORDS_COLOR
 103};
 104
 105struct diff_options {
 106        const char *filter;
 107        const char *orderfile;
 108        const char *pickaxe;
 109        const char *single_follow;
 110        const char *a_prefix, *b_prefix;
 111        unsigned flags;
 112        int use_color;
 113        int context;
 114        int interhunkcontext;
 115        int break_opt;
 116        int detect_rename;
 117        int irreversible_delete;
 118        int skip_stat_unmatch;
 119        int line_termination;
 120        int output_format;
 121        int pickaxe_opts;
 122        int rename_score;
 123        int rename_limit;
 124        int needed_rename_limit;
 125        int degraded_cc_to_c;
 126        int show_rename_progress;
 127        int dirstat_permille;
 128        int setup;
 129        int abbrev;
 130        const char *prefix;
 131        int prefix_length;
 132        const char *stat_sep;
 133        long xdl_opts;
 134
 135        int stat_width;
 136        int stat_name_width;
 137        int stat_graph_width;
 138        int stat_count;
 139        const char *word_regex;
 140        enum diff_words_type word_diff;
 141
 142        /* this is set by diffcore for DIFF_FORMAT_PATCH */
 143        int found_changes;
 144
 145        /* to support internal diff recursion by --follow hack*/
 146        int found_follow;
 147
 148        FILE *file;
 149        int close_file;
 150
 151        struct pathspec pathspec;
 152        change_fn_t change;
 153        add_remove_fn_t add_remove;
 154        diff_format_fn_t format_callback;
 155        void *format_callback_data;
 156        diff_prefix_fn_t output_prefix;
 157        int output_prefix_length;
 158        void *output_prefix_data;
 159};
 160
 161enum color_diff {
 162        DIFF_RESET = 0,
 163        DIFF_PLAIN = 1,
 164        DIFF_METAINFO = 2,
 165        DIFF_FRAGINFO = 3,
 166        DIFF_FILE_OLD = 4,
 167        DIFF_FILE_NEW = 5,
 168        DIFF_COMMIT = 6,
 169        DIFF_WHITESPACE = 7,
 170        DIFF_FUNCINFO = 8
 171};
 172const char *diff_get_color(int diff_use_color, enum color_diff ix);
 173#define diff_get_color_opt(o, ix) \
 174        diff_get_color((o)->use_color, ix)
 175
 176
 177extern const char mime_boundary_leader[];
 178
 179extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
 180extern void diff_tree_release_paths(struct diff_options *);
 181extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
 182                     const char *base, struct diff_options *opt);
 183extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
 184                          const char *base, struct diff_options *opt);
 185extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
 186                               struct diff_options *opt);
 187
 188struct combine_diff_path {
 189        struct combine_diff_path *next;
 190        int len;
 191        char *path;
 192        unsigned int mode;
 193        unsigned char sha1[20];
 194        struct combine_diff_parent {
 195                char status;
 196                unsigned int mode;
 197                unsigned char sha1[20];
 198        } parent[FLEX_ARRAY];
 199};
 200#define combine_diff_path_size(n, l) \
 201        (sizeof(struct combine_diff_path) + \
 202         sizeof(struct combine_diff_parent) * (n) + (l) + 1)
 203
 204extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
 205                              int dense, struct rev_info *);
 206
 207extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
 208
 209extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
 210
 211void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
 212
 213extern int diff_can_quit_early(struct diff_options *);
 214
 215extern void diff_addremove(struct diff_options *,
 216                           int addremove,
 217                           unsigned mode,
 218                           const unsigned char *sha1,
 219                           int sha1_valid,
 220                           const char *fullpath, unsigned dirty_submodule);
 221
 222extern void diff_change(struct diff_options *,
 223                        unsigned mode1, unsigned mode2,
 224                        const unsigned char *sha1,
 225                        const unsigned char *sha2,
 226                        int sha1_valid,
 227                        int sha2_valid,
 228                        const char *fullpath,
 229                        unsigned dirty_submodule1, unsigned dirty_submodule2);
 230
 231extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
 232
 233#define DIFF_SETUP_REVERSE              1
 234#define DIFF_SETUP_USE_CACHE            2
 235#define DIFF_SETUP_USE_SIZE_CACHE       4
 236
 237/*
 238 * Poor man's alternative to parse-option, to allow both sticked form
 239 * (--option=value) and separate form (--option value).
 240 */
 241extern int parse_long_opt(const char *opt, const char **argv,
 242                         const char **optarg);
 243
 244extern int git_diff_basic_config(const char *var, const char *value, void *cb);
 245extern int git_diff_ui_config(const char *var, const char *value, void *cb);
 246extern void diff_setup(struct diff_options *);
 247extern int diff_opt_parse(struct diff_options *, const char **, int);
 248extern void diff_setup_done(struct diff_options *);
 249
 250#define DIFF_DETECT_RENAME      1
 251#define DIFF_DETECT_COPY        2
 252
 253#define DIFF_PICKAXE_ALL        1
 254#define DIFF_PICKAXE_REGEX      2
 255
 256#define DIFF_PICKAXE_KIND_S     4 /* traditional plumbing counter */
 257#define DIFF_PICKAXE_KIND_G     8 /* grep in the patch */
 258
 259extern void diffcore_std(struct diff_options *);
 260extern void diffcore_fix_diff_index(struct diff_options *);
 261
 262#define COMMON_DIFF_OPTIONS_HELP \
 263"\ncommon diff options:\n" \
 264"  -z            output diff-raw with lines terminated with NUL.\n" \
 265"  -p            output patch format.\n" \
 266"  -u            synonym for -p.\n" \
 267"  --patch-with-raw\n" \
 268"                output both a patch and the diff-raw format.\n" \
 269"  --stat        show diffstat instead of patch.\n" \
 270"  --numstat     show numeric diffstat instead of patch.\n" \
 271"  --patch-with-stat\n" \
 272"                output a patch and prepend its diffstat.\n" \
 273"  --name-only   show only names of changed files.\n" \
 274"  --name-status show names and status of changed files.\n" \
 275"  --full-index  show full object name on index lines.\n" \
 276"  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
 277"  -R            swap input file pairs.\n" \
 278"  -B            detect complete rewrites.\n" \
 279"  -M            detect renames.\n" \
 280"  -C            detect copies.\n" \
 281"  --find-copies-harder\n" \
 282"                try unchanged files as candidate for copy detection.\n" \
 283"  -l<n>         limit rename attempts up to <n> paths.\n" \
 284"  -O<file>      reorder diffs according to the <file>.\n" \
 285"  -S<string>    find filepair whose only one side contains the string.\n" \
 286"  --pickaxe-all\n" \
 287"                show all files diff when -S is used and hit is found.\n" \
 288"  -a  --text    treat all files as text.\n"
 289
 290extern int diff_queue_is_empty(void);
 291extern void diff_flush(struct diff_options*);
 292extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
 293
 294/* diff-raw status letters */
 295#define DIFF_STATUS_ADDED               'A'
 296#define DIFF_STATUS_COPIED              'C'
 297#define DIFF_STATUS_DELETED             'D'
 298#define DIFF_STATUS_MODIFIED            'M'
 299#define DIFF_STATUS_RENAMED             'R'
 300#define DIFF_STATUS_TYPE_CHANGED        'T'
 301#define DIFF_STATUS_UNKNOWN             'X'
 302#define DIFF_STATUS_UNMERGED            'U'
 303
 304/* these are not diff-raw status letters proper, but used by
 305 * diffcore-filter insn to specify additional restrictions.
 306 */
 307#define DIFF_STATUS_FILTER_AON          '*'
 308#define DIFF_STATUS_FILTER_BROKEN       'B'
 309
 310extern const char *diff_unique_abbrev(const unsigned char *, int);
 311
 312/* do not report anything on removed paths */
 313#define DIFF_SILENT_ON_REMOVED 01
 314/* report racily-clean paths as modified */
 315#define DIFF_RACY_IS_MODIFIED 02
 316extern int run_diff_files(struct rev_info *revs, unsigned int option);
 317extern int run_diff_index(struct rev_info *revs, int cached);
 318
 319extern int do_diff_cache(const unsigned char *, struct diff_options *);
 320extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
 321
 322extern int diff_result_code(struct diff_options *, int);
 323
 324extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
 325
 326extern int index_differs_from(const char *def, int diff_flags);
 327
 328extern size_t fill_textconv(struct userdiff_driver *driver,
 329                            struct diff_filespec *df,
 330                            char **outbuf);
 331
 332extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
 333
 334extern int parse_rename_score(const char **cp_p);
 335
 336extern int print_stat_summary(FILE *fp, int files,
 337                              int insertions, int deletions);
 338extern void setup_diff_pager(struct diff_options *);
 339
 340#endif /* DIFF_H */