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