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#include "object.h"
  10
  11struct rev_info;
  12struct diff_options;
  13struct diff_queue_struct;
  14struct strbuf;
  15struct diff_filespec;
  16struct userdiff_driver;
  17struct oid_array;
  18struct commit;
  19struct combine_diff_path;
  20
  21typedef int (*pathchange_fn_t)(struct diff_options *options,
  22                 struct combine_diff_path *path);
  23
  24typedef void (*change_fn_t)(struct diff_options *options,
  25                 unsigned old_mode, unsigned new_mode,
  26                 const struct object_id *old_oid,
  27                 const struct object_id *new_oid,
  28                 int old_oid_valid, int new_oid_valid,
  29                 const char *fullpath,
  30                 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
  31
  32typedef void (*add_remove_fn_t)(struct diff_options *options,
  33                    int addremove, unsigned mode,
  34                    const struct object_id *oid,
  35                    int oid_valid,
  36                    const char *fullpath, unsigned dirty_submodule);
  37
  38typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
  39                struct diff_options *options, void *data);
  40
  41typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
  42
  43#define DIFF_FORMAT_RAW         0x0001
  44#define DIFF_FORMAT_DIFFSTAT    0x0002
  45#define DIFF_FORMAT_NUMSTAT     0x0004
  46#define DIFF_FORMAT_SUMMARY     0x0008
  47#define DIFF_FORMAT_PATCH       0x0010
  48#define DIFF_FORMAT_SHORTSTAT   0x0020
  49#define DIFF_FORMAT_DIRSTAT     0x0040
  50
  51/* These override all above */
  52#define DIFF_FORMAT_NAME        0x0100
  53#define DIFF_FORMAT_NAME_STATUS 0x0200
  54#define DIFF_FORMAT_CHECKDIFF   0x0400
  55
  56/* Same as output_format = 0 but we know that -s flag was given
  57 * and we should not give default value to output_format.
  58 */
  59#define DIFF_FORMAT_NO_OUTPUT   0x0800
  60
  61#define DIFF_FORMAT_CALLBACK    0x1000
  62
  63#define DIFF_OPT_RECURSIVE           (1 <<  0)
  64#define DIFF_OPT_TREE_IN_RECURSIVE   (1 <<  1)
  65#define DIFF_OPT_BINARY              (1 <<  2)
  66#define DIFF_OPT_TEXT                (1 <<  3)
  67#define DIFF_OPT_FULL_INDEX          (1 <<  4)
  68#define DIFF_OPT_SILENT_ON_REMOVE    (1 <<  5)
  69#define DIFF_OPT_FIND_COPIES_HARDER  (1 <<  6)
  70#define DIFF_OPT_FOLLOW_RENAMES      (1 <<  7)
  71#define DIFF_OPT_RENAME_EMPTY        (1 <<  8)
  72/* (1 <<  9) unused */
  73#define DIFF_OPT_HAS_CHANGES         (1 << 10)
  74#define DIFF_OPT_QUICK               (1 << 11)
  75#define DIFF_OPT_NO_INDEX            (1 << 12)
  76#define DIFF_OPT_ALLOW_EXTERNAL      (1 << 13)
  77#define DIFF_OPT_EXIT_WITH_STATUS    (1 << 14)
  78#define DIFF_OPT_REVERSE_DIFF        (1 << 15)
  79#define DIFF_OPT_CHECK_FAILED        (1 << 16)
  80#define DIFF_OPT_RELATIVE_NAME       (1 << 17)
  81#define DIFF_OPT_IGNORE_SUBMODULES   (1 << 18)
  82#define DIFF_OPT_DIRSTAT_CUMULATIVE  (1 << 19)
  83#define DIFF_OPT_DIRSTAT_BY_FILE     (1 << 20)
  84#define DIFF_OPT_ALLOW_TEXTCONV      (1 << 21)
  85#define DIFF_OPT_DIFF_FROM_CONTENTS  (1 << 22)
  86#define DIFF_OPT_DIRTY_SUBMODULES    (1 << 24)
  87#define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
  88#define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
  89#define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
  90#define DIFF_OPT_DIRSTAT_BY_LINE     (1 << 28)
  91#define DIFF_OPT_FUNCCONTEXT         (1 << 29)
  92#define DIFF_OPT_PICKAXE_IGNORE_CASE (1 << 30)
  93#define DIFF_OPT_DEFAULT_FOLLOW_RENAMES (1U << 31)
  94
  95#define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
  96#define DIFF_OPT_TOUCHED(opts, flag)    ((opts)->touched_flags & DIFF_OPT_##flag)
  97#define DIFF_OPT_SET(opts, flag)    (((opts)->flags |= DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
  98#define DIFF_OPT_CLR(opts, flag)    (((opts)->flags &= ~DIFF_OPT_##flag),((opts)->touched_flags |= DIFF_OPT_##flag))
  99#define DIFF_XDL_TST(opts, flag)    ((opts)->xdl_opts & XDF_##flag)
 100#define DIFF_XDL_SET(opts, flag)    ((opts)->xdl_opts |= XDF_##flag)
 101#define DIFF_XDL_CLR(opts, flag)    ((opts)->xdl_opts &= ~XDF_##flag)
 102
 103#define DIFF_WITH_ALG(opts, flag)   (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
 104
 105enum diff_words_type {
 106        DIFF_WORDS_NONE = 0,
 107        DIFF_WORDS_PORCELAIN,
 108        DIFF_WORDS_PLAIN,
 109        DIFF_WORDS_COLOR
 110};
 111
 112enum diff_submodule_format {
 113        DIFF_SUBMODULE_SHORT = 0,
 114        DIFF_SUBMODULE_LOG,
 115        DIFF_SUBMODULE_INLINE_DIFF
 116};
 117
 118struct diff_options {
 119        const char *orderfile;
 120        const char *pickaxe;
 121        const char *single_follow;
 122        const char *a_prefix, *b_prefix;
 123        const char *line_prefix;
 124        size_t line_prefix_length;
 125        unsigned flags;
 126        unsigned touched_flags;
 127
 128        /* diff-filter bits */
 129        unsigned int filter;
 130
 131        int use_color;
 132        int context;
 133        int interhunkcontext;
 134        int break_opt;
 135        int detect_rename;
 136        int irreversible_delete;
 137        int skip_stat_unmatch;
 138        int line_termination;
 139        int output_format;
 140        int pickaxe_opts;
 141        int rename_score;
 142        int rename_limit;
 143        int needed_rename_limit;
 144        int degraded_cc_to_c;
 145        int show_rename_progress;
 146        int dirstat_permille;
 147        int setup;
 148        int abbrev;
 149        int ita_invisible_in_index;
 150/* white-space error highlighting */
 151#define WSEH_NEW (1<<12)
 152#define WSEH_CONTEXT (1<<13)
 153#define WSEH_OLD (1<<14)
 154        unsigned ws_error_highlight;
 155        const char *prefix;
 156        int prefix_length;
 157        const char *stat_sep;
 158        long xdl_opts;
 159
 160        int stat_width;
 161        int stat_name_width;
 162        int stat_graph_width;
 163        int stat_count;
 164        const char *word_regex;
 165        enum diff_words_type word_diff;
 166        enum diff_submodule_format submodule_format;
 167
 168        /* this is set by diffcore for DIFF_FORMAT_PATCH */
 169        int found_changes;
 170
 171        /* to support internal diff recursion by --follow hack*/
 172        int found_follow;
 173
 174        void (*set_default)(struct diff_options *);
 175
 176        FILE *file;
 177        int close_file;
 178
 179        struct pathspec pathspec;
 180        pathchange_fn_t pathchange;
 181        change_fn_t change;
 182        add_remove_fn_t add_remove;
 183        void *change_fn_data;
 184        diff_format_fn_t format_callback;
 185        void *format_callback_data;
 186        diff_prefix_fn_t output_prefix;
 187        void *output_prefix_data;
 188
 189        int diff_path_counter;
 190
 191        struct emitted_diff_symbols *emitted_symbols;
 192        enum {
 193                COLOR_MOVED_NO = 0,
 194                COLOR_MOVED_PLAIN = 1,
 195                COLOR_MOVED_ZEBRA = 2,
 196                COLOR_MOVED_ZEBRA_DIM = 3,
 197        } color_moved;
 198        #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
 199        #define COLOR_MOVED_MIN_ALNUM_COUNT 20
 200};
 201
 202void diff_emit_submodule_del(struct diff_options *o, const char *line);
 203void diff_emit_submodule_add(struct diff_options *o, const char *line);
 204void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
 205void diff_emit_submodule_modified(struct diff_options *o, const char *path);
 206void diff_emit_submodule_header(struct diff_options *o, const char *header);
 207void diff_emit_submodule_error(struct diff_options *o, const char *err);
 208void diff_emit_submodule_pipethrough(struct diff_options *o,
 209                                     const char *line, int len);
 210
 211enum color_diff {
 212        DIFF_RESET = 0,
 213        DIFF_CONTEXT = 1,
 214        DIFF_METAINFO = 2,
 215        DIFF_FRAGINFO = 3,
 216        DIFF_FILE_OLD = 4,
 217        DIFF_FILE_NEW = 5,
 218        DIFF_COMMIT = 6,
 219        DIFF_WHITESPACE = 7,
 220        DIFF_FUNCINFO = 8,
 221        DIFF_FILE_OLD_MOVED = 9,
 222        DIFF_FILE_OLD_MOVED_ALT = 10,
 223        DIFF_FILE_OLD_MOVED_DIM = 11,
 224        DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
 225        DIFF_FILE_NEW_MOVED = 13,
 226        DIFF_FILE_NEW_MOVED_ALT = 14,
 227        DIFF_FILE_NEW_MOVED_DIM = 15,
 228        DIFF_FILE_NEW_MOVED_ALT_DIM = 16
 229};
 230const char *diff_get_color(int diff_use_color, enum color_diff ix);
 231#define diff_get_color_opt(o, ix) \
 232        diff_get_color((o)->use_color, ix)
 233
 234
 235const char *diff_line_prefix(struct diff_options *);
 236
 237
 238extern const char mime_boundary_leader[];
 239
 240extern struct combine_diff_path *diff_tree_paths(
 241        struct combine_diff_path *p, const struct object_id *oid,
 242        const struct object_id **parents_oid, int nparent,
 243        struct strbuf *base, struct diff_options *opt);
 244extern int diff_tree_oid(const struct object_id *old_oid,
 245                         const struct object_id *new_oid,
 246                         const char *base, struct diff_options *opt);
 247extern int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
 248                              struct diff_options *opt);
 249
 250struct combine_diff_path {
 251        struct combine_diff_path *next;
 252        char *path;
 253        unsigned int mode;
 254        struct object_id oid;
 255        struct combine_diff_parent {
 256                char status;
 257                unsigned int mode;
 258                struct object_id oid;
 259        } parent[FLEX_ARRAY];
 260};
 261#define combine_diff_path_size(n, l) \
 262        st_add4(sizeof(struct combine_diff_path), (l), 1, \
 263                st_mult(sizeof(struct combine_diff_parent), (n)))
 264
 265extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
 266                              int dense, struct rev_info *);
 267
 268extern void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
 269
 270extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
 271
 272void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
 273
 274extern int diff_can_quit_early(struct diff_options *);
 275
 276extern void diff_addremove(struct diff_options *,
 277                           int addremove,
 278                           unsigned mode,
 279                           const struct object_id *oid,
 280                           int oid_valid,
 281                           const char *fullpath, unsigned dirty_submodule);
 282
 283extern void diff_change(struct diff_options *,
 284                        unsigned mode1, unsigned mode2,
 285                        const struct object_id *old_oid,
 286                        const struct object_id *new_oid,
 287                        int old_oid_valid, int new_oid_valid,
 288                        const char *fullpath,
 289                        unsigned dirty_submodule1, unsigned dirty_submodule2);
 290
 291extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
 292
 293#define DIFF_SETUP_REVERSE              1
 294#define DIFF_SETUP_USE_CACHE            2
 295#define DIFF_SETUP_USE_SIZE_CACHE       4
 296
 297/*
 298 * Poor man's alternative to parse-option, to allow both stuck form
 299 * (--option=value) and separate form (--option value).
 300 */
 301extern int parse_long_opt(const char *opt, const char **argv,
 302                         const char **optarg);
 303
 304extern int git_diff_basic_config(const char *var, const char *value, void *cb);
 305extern int git_diff_heuristic_config(const char *var, const char *value, void *cb);
 306extern void init_diff_ui_defaults(void);
 307extern int git_diff_ui_config(const char *var, const char *value, void *cb);
 308extern void diff_setup(struct diff_options *);
 309extern int diff_opt_parse(struct diff_options *, const char **, int, const char *);
 310extern void diff_setup_done(struct diff_options *);
 311
 312#define DIFF_DETECT_RENAME      1
 313#define DIFF_DETECT_COPY        2
 314
 315#define DIFF_PICKAXE_ALL        1
 316#define DIFF_PICKAXE_REGEX      2
 317
 318#define DIFF_PICKAXE_KIND_S     4 /* traditional plumbing counter */
 319#define DIFF_PICKAXE_KIND_G     8 /* grep in the patch */
 320
 321extern void diffcore_std(struct diff_options *);
 322extern void diffcore_fix_diff_index(struct diff_options *);
 323
 324#define COMMON_DIFF_OPTIONS_HELP \
 325"\ncommon diff options:\n" \
 326"  -z            output diff-raw with lines terminated with NUL.\n" \
 327"  -p            output patch format.\n" \
 328"  -u            synonym for -p.\n" \
 329"  --patch-with-raw\n" \
 330"                output both a patch and the diff-raw format.\n" \
 331"  --stat        show diffstat instead of patch.\n" \
 332"  --numstat     show numeric diffstat instead of patch.\n" \
 333"  --patch-with-stat\n" \
 334"                output a patch and prepend its diffstat.\n" \
 335"  --name-only   show only names of changed files.\n" \
 336"  --name-status show names and status of changed files.\n" \
 337"  --full-index  show full object name on index lines.\n" \
 338"  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
 339"  -R            swap input file pairs.\n" \
 340"  -B            detect complete rewrites.\n" \
 341"  -M            detect renames.\n" \
 342"  -C            detect copies.\n" \
 343"  --find-copies-harder\n" \
 344"                try unchanged files as candidate for copy detection.\n" \
 345"  -l<n>         limit rename attempts up to <n> paths.\n" \
 346"  -O<file>      reorder diffs according to the <file>.\n" \
 347"  -S<string>    find filepair whose only one side contains the string.\n" \
 348"  --pickaxe-all\n" \
 349"                show all files diff when -S is used and hit is found.\n" \
 350"  -a  --text    treat all files as text.\n"
 351
 352extern int diff_queue_is_empty(void);
 353extern void diff_flush(struct diff_options*);
 354extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
 355
 356/* diff-raw status letters */
 357#define DIFF_STATUS_ADDED               'A'
 358#define DIFF_STATUS_COPIED              'C'
 359#define DIFF_STATUS_DELETED             'D'
 360#define DIFF_STATUS_MODIFIED            'M'
 361#define DIFF_STATUS_RENAMED             'R'
 362#define DIFF_STATUS_TYPE_CHANGED        'T'
 363#define DIFF_STATUS_UNKNOWN             'X'
 364#define DIFF_STATUS_UNMERGED            'U'
 365
 366/* these are not diff-raw status letters proper, but used by
 367 * diffcore-filter insn to specify additional restrictions.
 368 */
 369#define DIFF_STATUS_FILTER_AON          '*'
 370#define DIFF_STATUS_FILTER_BROKEN       'B'
 371
 372/*
 373 * This is different from find_unique_abbrev() in that
 374 * it stuffs the result with dots for alignment.
 375 */
 376extern const char *diff_aligned_abbrev(const struct object_id *sha1, int);
 377
 378/* do not report anything on removed paths */
 379#define DIFF_SILENT_ON_REMOVED 01
 380/* report racily-clean paths as modified */
 381#define DIFF_RACY_IS_MODIFIED 02
 382extern int run_diff_files(struct rev_info *revs, unsigned int option);
 383extern int run_diff_index(struct rev_info *revs, int cached);
 384
 385extern int do_diff_cache(const struct object_id *, struct diff_options *);
 386extern int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
 387
 388extern int diff_result_code(struct diff_options *, int);
 389
 390extern void diff_no_index(struct rev_info *, int, const char **);
 391
 392extern int index_differs_from(const char *def, int diff_flags, int ita_invisible_in_index);
 393
 394/*
 395 * Fill the contents of the filespec "df", respecting any textconv defined by
 396 * its userdiff driver.  The "driver" parameter must come from a
 397 * previous call to get_textconv(), and therefore should either be NULL or have
 398 * textconv enabled.
 399 *
 400 * Note that the memory ownership of the resulting buffer depends on whether
 401 * the driver field is NULL. If it is, then the memory belongs to the filespec
 402 * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
 403 * that should be freed by the caller.
 404 */
 405extern size_t fill_textconv(struct userdiff_driver *driver,
 406                            struct diff_filespec *df,
 407                            char **outbuf);
 408
 409/*
 410 * Look up the userdiff driver for the given filespec, and return it if
 411 * and only if it has textconv enabled (otherwise return NULL). The result
 412 * can be passed to fill_textconv().
 413 */
 414extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
 415
 416/*
 417 * Prepare diff_filespec and convert it using diff textconv API
 418 * if the textconv driver exists.
 419 * Return 1 if the conversion succeeds, 0 otherwise.
 420 */
 421extern int textconv_object(const char *path, unsigned mode, const struct object_id *oid, int oid_valid, char **buf, unsigned long *buf_size);
 422
 423extern int parse_rename_score(const char **cp_p);
 424
 425extern long parse_algorithm_value(const char *value);
 426
 427extern void print_stat_summary(FILE *fp, int files,
 428                               int insertions, int deletions);
 429extern void setup_diff_pager(struct diff_options *);
 430
 431#endif /* DIFF_H */