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#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_TOUCHED(opts, flag)    ((opts)->touched_flags & DIFF_OPT_##flag)
  92#define DIFF_OPT_SET(opts, flag)    (((opts)->flags |= DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
  93#define DIFF_OPT_CLR(opts, flag)    (((opts)->flags &= ~DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
  94#define DIFF_XDL_TST(opts, flag)    ((opts)->xdl_opts & XDF_##flag)
  95#define DIFF_XDL_SET(opts, flag)    ((opts)->xdl_opts |= XDF_##flag)
  96#define DIFF_XDL_CLR(opts, flag)    ((opts)->xdl_opts &= ~XDF_##flag)
  97
  98#define DIFF_WITH_ALG(opts, flag)   (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
  99
 100enum diff_words_type {
 101        DIFF_WORDS_NONE = 0,
 102        DIFF_WORDS_PORCELAIN,
 103        DIFF_WORDS_PLAIN,
 104        DIFF_WORDS_COLOR
 105};
 106
 107struct diff_options {
 108        const char *orderfile;
 109        const char *pickaxe;
 110        const char *single_follow;
 111        const char *a_prefix, *b_prefix;
 112        unsigned flags;
 113        unsigned touched_flags;
 114
 115        /* diff-filter bits */
 116        unsigned int filter;
 117
 118        int use_color;
 119        int context;
 120        int interhunkcontext;
 121        int break_opt;
 122        int detect_rename;
 123        int irreversible_delete;
 124        int skip_stat_unmatch;
 125        int line_termination;
 126        int output_format;
 127        int pickaxe_opts;
 128        int rename_score;
 129        int rename_limit;
 130        int needed_rename_limit;
 131        int degraded_cc_to_c;
 132        int show_rename_progress;
 133        int dirstat_permille;
 134        int setup;
 135        int abbrev;
 136        const char *prefix;
 137        int prefix_length;
 138        const char *stat_sep;
 139        long xdl_opts;
 140
 141        int stat_width;
 142        int stat_name_width;
 143        int stat_graph_width;
 144        int stat_count;
 145        const char *word_regex;
 146        enum diff_words_type word_diff;
 147
 148        /* this is set by diffcore for DIFF_FORMAT_PATCH */
 149        int found_changes;
 150
 151        /* to support internal diff recursion by --follow hack*/
 152        int found_follow;
 153
 154        void (*set_default)(struct diff_options *);
 155
 156        FILE *file;
 157        int close_file;
 158
 159        struct pathspec pathspec;
 160        change_fn_t change;
 161        add_remove_fn_t add_remove;
 162        diff_format_fn_t format_callback;
 163        void *format_callback_data;
 164        diff_prefix_fn_t output_prefix;
 165        int output_prefix_length;
 166        void *output_prefix_data;
 167
 168        int diff_path_counter;
 169};
 170
 171enum color_diff {
 172        DIFF_RESET = 0,
 173        DIFF_PLAIN = 1,
 174        DIFF_METAINFO = 2,
 175        DIFF_FRAGINFO = 3,
 176        DIFF_FILE_OLD = 4,
 177        DIFF_FILE_NEW = 5,
 178        DIFF_COMMIT = 6,
 179        DIFF_WHITESPACE = 7,
 180        DIFF_FUNCINFO = 8
 181};
 182const char *diff_get_color(int diff_use_color, enum color_diff ix);
 183#define diff_get_color_opt(o, ix) \
 184        diff_get_color((o)->use_color, ix)
 185
 186
 187const char *diff_line_prefix(struct diff_options *);
 188
 189
 190extern const char mime_boundary_leader[];
 191
 192extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
 193                     const char *base, struct diff_options *opt);
 194extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
 195                          const char *base, struct diff_options *opt);
 196extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
 197                               struct diff_options *opt);
 198
 199struct combine_diff_path {
 200        struct combine_diff_path *next;
 201        int len;
 202        char *path;
 203        unsigned int mode;
 204        unsigned char sha1[20];
 205        struct combine_diff_parent {
 206                char status;
 207                unsigned int mode;
 208                unsigned char sha1[20];
 209        } parent[FLEX_ARRAY];
 210};
 211#define combine_diff_path_size(n, l) \
 212        (sizeof(struct combine_diff_path) + \
 213         sizeof(struct combine_diff_parent) * (n) + (l) + 1)
 214
 215extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
 216                              int dense, struct rev_info *);
 217
 218extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
 219
 220extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
 221
 222void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
 223
 224extern int diff_can_quit_early(struct diff_options *);
 225
 226extern void diff_addremove(struct diff_options *,
 227                           int addremove,
 228                           unsigned mode,
 229                           const unsigned char *sha1,
 230                           int sha1_valid,
 231                           const char *fullpath, unsigned dirty_submodule);
 232
 233extern void diff_change(struct diff_options *,
 234                        unsigned mode1, unsigned mode2,
 235                        const unsigned char *sha1,
 236                        const unsigned char *sha2,
 237                        int sha1_valid,
 238                        int sha2_valid,
 239                        const char *fullpath,
 240                        unsigned dirty_submodule1, unsigned dirty_submodule2);
 241
 242extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
 243
 244#define DIFF_SETUP_REVERSE              1
 245#define DIFF_SETUP_USE_CACHE            2
 246#define DIFF_SETUP_USE_SIZE_CACHE       4
 247
 248/*
 249 * Poor man's alternative to parse-option, to allow both stuck form
 250 * (--option=value) and separate form (--option value).
 251 */
 252extern int parse_long_opt(const char *opt, const char **argv,
 253                         const char **optarg);
 254
 255extern int git_diff_basic_config(const char *var, const char *value, void *cb);
 256extern int git_diff_ui_config(const char *var, const char *value, void *cb);
 257extern void diff_setup(struct diff_options *);
 258extern int diff_opt_parse(struct diff_options *, const char **, int);
 259extern void diff_setup_done(struct diff_options *);
 260
 261#define DIFF_DETECT_RENAME      1
 262#define DIFF_DETECT_COPY        2
 263
 264#define DIFF_PICKAXE_ALL        1
 265#define DIFF_PICKAXE_REGEX      2
 266
 267#define DIFF_PICKAXE_KIND_S     4 /* traditional plumbing counter */
 268#define DIFF_PICKAXE_KIND_G     8 /* grep in the patch */
 269
 270extern void diffcore_std(struct diff_options *);
 271extern void diffcore_fix_diff_index(struct diff_options *);
 272
 273#define COMMON_DIFF_OPTIONS_HELP \
 274"\ncommon diff options:\n" \
 275"  -z            output diff-raw with lines terminated with NUL.\n" \
 276"  -p            output patch format.\n" \
 277"  -u            synonym for -p.\n" \
 278"  --patch-with-raw\n" \
 279"                output both a patch and the diff-raw format.\n" \
 280"  --stat        show diffstat instead of patch.\n" \
 281"  --numstat     show numeric diffstat instead of patch.\n" \
 282"  --patch-with-stat\n" \
 283"                output a patch and prepend its diffstat.\n" \
 284"  --name-only   show only names of changed files.\n" \
 285"  --name-status show names and status of changed files.\n" \
 286"  --full-index  show full object name on index lines.\n" \
 287"  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
 288"  -R            swap input file pairs.\n" \
 289"  -B            detect complete rewrites.\n" \
 290"  -M            detect renames.\n" \
 291"  -C            detect copies.\n" \
 292"  --find-copies-harder\n" \
 293"                try unchanged files as candidate for copy detection.\n" \
 294"  -l<n>         limit rename attempts up to <n> paths.\n" \
 295"  -O<file>      reorder diffs according to the <file>.\n" \
 296"  -S<string>    find filepair whose only one side contains the string.\n" \
 297"  --pickaxe-all\n" \
 298"                show all files diff when -S is used and hit is found.\n" \
 299"  -a  --text    treat all files as text.\n"
 300
 301extern int diff_queue_is_empty(void);
 302extern void diff_flush(struct diff_options*);
 303extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
 304
 305/* diff-raw status letters */
 306#define DIFF_STATUS_ADDED               'A'
 307#define DIFF_STATUS_COPIED              'C'
 308#define DIFF_STATUS_DELETED             'D'
 309#define DIFF_STATUS_MODIFIED            'M'
 310#define DIFF_STATUS_RENAMED             'R'
 311#define DIFF_STATUS_TYPE_CHANGED        'T'
 312#define DIFF_STATUS_UNKNOWN             'X'
 313#define DIFF_STATUS_UNMERGED            'U'
 314
 315/* these are not diff-raw status letters proper, but used by
 316 * diffcore-filter insn to specify additional restrictions.
 317 */
 318#define DIFF_STATUS_FILTER_AON          '*'
 319#define DIFF_STATUS_FILTER_BROKEN       'B'
 320
 321extern const char *diff_unique_abbrev(const unsigned char *, int);
 322
 323/* do not report anything on removed paths */
 324#define DIFF_SILENT_ON_REMOVED 01
 325/* report racily-clean paths as modified */
 326#define DIFF_RACY_IS_MODIFIED 02
 327extern int run_diff_files(struct rev_info *revs, unsigned int option);
 328extern int run_diff_index(struct rev_info *revs, int cached);
 329
 330extern int do_diff_cache(const unsigned char *, struct diff_options *);
 331extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
 332
 333extern int diff_result_code(struct diff_options *, int);
 334
 335extern void diff_no_index(struct rev_info *, int, const char **, const char *);
 336
 337extern int index_differs_from(const char *def, int diff_flags);
 338
 339extern size_t fill_textconv(struct userdiff_driver *driver,
 340                            struct diff_filespec *df,
 341                            char **outbuf);
 342
 343extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
 344
 345extern int parse_rename_score(const char **cp_p);
 346
 347extern long parse_algorithm_value(const char *value);
 348
 349extern void handle_deprecated_show_diff_q(struct diff_options *);
 350
 351extern int print_stat_summary(FILE *fp, int files,
 352                              int insertions, int deletions);
 353extern void setup_diff_pager(struct diff_options *);
 354
 355#endif /* DIFF_H */