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