diff.h

   1 /*
   2  * Copyright (C) 2005 Junio C Hamano
   3  */
   4 #ifndef DIFF_H
   5 #define DIFF_H
   6
   7 #include "hash.h"
   8 #include "pathspec.h"
   9 #include "strbuf.h"
  10
  11 struct oidset;
  12
  13 /**
  14  * The diff API is for programs that compare two sets of files (e.g. two trees,
  15  * one tree and the index) and present the found difference in various ways.
  16  * The calling program is responsible for feeding the API pairs of files, one
  17  * from the "old" set and the corresponding one from "new" set, that are
  18  * different.
  19  * The library called through this API is called diffcore, and is responsible
  20  * for two things.
  21  *
  22  * - finding total rewrites (`-B`), renames (`-M`) and copies (`-C`), and
  23  * changes that touch a string (`-S`), as specified by the caller.
  24  *
  25  * - outputting the differences in various formats, as specified by the caller.
  26  *
  27  * Calling sequence
  28  * ----------------
  29  *
  30  * - Prepare `struct diff_options` to record the set of diff options, and then
  31  * call `repo_diff_setup()` to initialize this structure.  This sets up the
  32  * vanilla default.
  33  *
  34  * - Fill in the options structure to specify desired output format, rename
  35  * detection, etc.  `diff_opt_parse()` can be used to parse options given
  36  * from the command line in a way consistent with existing git-diff family
  37  * of programs.
  38  *
  39  * - Call `diff_setup_done()`; this inspects the options set up so far for
  40  * internal consistency and make necessary tweaking to it (e.g. if textual
  41  * patch output was asked, recursive behaviour is turned on); the callback
  42  * set_default in diff_options can be used to tweak this more.
  43  *
  44  * - As you find different pairs of files, call `diff_change()` to feed
  45  * modified files, `diff_addremove()` to feed created or deleted files, or
  46  * `diff_unmerge()` to feed a file whose state is 'unmerged' to the API.
  47  * These are thin wrappers to a lower-level `diff_queue()` function that is
  48  * flexible enough to record any of these kinds of changes.
  49  *
  50  * - Once you finish feeding the pairs of files, call `diffcore_std()`.
  51  * This will tell the diffcore library to go ahead and do its work.
  52  *
  53  * - Calling `diff_flush()` will produce the output, it will call
  54  *   `diff_free()` to free any resources, e.g. those allocated in
  55  *   `diff_opt_parse()`.
  56  *
  57  * - Set `.no_free = 1` before calling `diff_flush()` to defer the
  58  *   freeing of allocated memory in diff_options. This is useful when
  59  *   `diff_flush()` is being called in a loop, rather than as a
  60  *   one-off. When setting `.no_free = 1` you must ensure that
  61  *   `diff_free()` is called at the end, either by flipping the flag
  62  *   before the last `diff_flush()` call, or by flipping it before
  63  *   calling `diff_free()` yourself.
  64  */
  65
  66 struct combine_diff_path;
  67 struct commit;
  68 struct diff_filespec;
  69 struct diff_options;
  70 struct diff_queue_struct;
  71 struct oid_array;
  72 struct option;
  73 struct repository;
  74 struct rev_info;
  75 struct userdiff_driver;
  76
  77 typedef int (*pathchange_fn_t)(struct diff_options *options,
  78                  struct combine_diff_path *path);
  79
  80 typedef void (*change_fn_t)(struct diff_options *options,
  81                  unsigned old_mode, unsigned new_mode,
  82                  const struct object_id *old_oid,
  83                  const struct object_id *new_oid,
  84                  int old_oid_valid, int new_oid_valid,
  85                  const char *fullpath,
  86                  unsigned old_dirty_submodule, unsigned new_dirty_submodule);
  87
  88 typedef void (*add_remove_fn_t)(struct diff_options *options,
  89                     int addremove, unsigned mode,
  90                     const struct object_id *oid,
  91                     int oid_valid,
  92                     const char *fullpath, unsigned dirty_submodule);
  93
  94 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
  95                 struct diff_options *options, void *data);
  96
  97 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
  98
  99 #define DIFF_FORMAT_RAW         0x0001
 100 #define DIFF_FORMAT_DIFFSTAT    0x0002
 101 #define DIFF_FORMAT_NUMSTAT     0x0004
 102 #define DIFF_FORMAT_SUMMARY     0x0008
 103 #define DIFF_FORMAT_PATCH       0x0010
 104 #define DIFF_FORMAT_SHORTSTAT   0x0020
 105 #define DIFF_FORMAT_DIRSTAT     0x0040
 106
 107 /* These override all above */
 108 #define DIFF_FORMAT_NAME        0x0100
 109 #define DIFF_FORMAT_NAME_STATUS 0x0200
 110 #define DIFF_FORMAT_CHECKDIFF   0x0400
 111
 112 /* Same as output_format = 0 but we know that -s flag was given
 113  * and we should not give default value to output_format.
 114  */
 115 #define DIFF_FORMAT_NO_OUTPUT   0x0800
 116
 117 #define DIFF_FORMAT_CALLBACK    0x1000
 118
 119 #define DIFF_FLAGS_INIT { 0 }
 120 struct diff_flags {
 121
 122         /**
 123          * Tells if tree traversal done by tree-diff should recursively descend
 124          * into a tree object pair that are different in preimage and postimage set.
 125          */
 126         unsigned recursive;
 127         unsigned tree_in_recursive;
 128
 129         /* Affects the way how a file that is seemingly binary is treated. */
 130         unsigned binary;
 131         unsigned text;
 132
 133         /**
 134          * Tells the patch output format not to use abbreviated object names on the
 135          * "index" lines.
 136          */
 137         unsigned full_index;
 138
 139         /* Affects if diff-files shows removed files. */
 140         unsigned silent_on_remove;
 141
 142         /**
 143          * Tells the diffcore library that the caller is feeding unchanged
 144          * filepairs to allow copies from unmodified files be detected.
 145          */
 146         unsigned find_copies_harder;
 147
 148         unsigned follow_renames;
 149         unsigned rename_empty;
 150
 151         /* Internal; used for optimization to see if there is any change. */
 152         unsigned has_changes;
 153
 154         unsigned quick;
 155
 156         /**
 157          * Tells diff-files that the input is not tracked files but files in random
 158          * locations on the filesystem.
 159          */
 160         unsigned no_index;
 161
 162         /**
 163          * Tells output routine that it is Ok to call user specified patch output
 164          * routine.  Plumbing disables this to ensure stable output.
 165          */
 166         unsigned allow_external;
 167
 168         /**
 169          * For communication between the calling program and the options parser;
 170          * tell the calling program to signal the presence of difference using
 171          * program exit code.
 172          */
 173         unsigned exit_with_status;
 174
 175         /**
 176          * Tells the library that the calling program is feeding the filepairs
 177          * reversed; `one` is two, and `two` is one.
 178          */
 179         unsigned reverse_diff;
 180
 181         unsigned check_failed;
 182         unsigned relative_name;
 183         unsigned ignore_submodules;
 184         unsigned dirstat_cumulative;
 185         unsigned dirstat_by_file;
 186         unsigned allow_textconv;
 187         unsigned textconv_set_via_cmdline;
 188         unsigned diff_from_contents;
 189         unsigned dirty_submodules;
 190         unsigned ignore_untracked_in_submodules;
 191         unsigned ignore_submodule_set;
 192         unsigned ignore_dirty_submodules;
 193         unsigned override_submodule_config;
 194         unsigned dirstat_by_line;
 195         unsigned funccontext;
 196         unsigned default_follow_renames;
 197         unsigned stat_with_summary;
 198         unsigned suppress_diff_headers;
 199         unsigned dual_color_diffed_diffs;
 200         unsigned suppress_hunk_header_line_count;
 201 };
 202
 203 static inline void diff_flags_or(struct diff_flags *a,
 204                                  const struct diff_flags *b)
 205 {
 206         char *tmp_a = (char *)a;
 207         const char *tmp_b = (const char *)b;
 208         int i;
 209
 210         for (i = 0; i < sizeof(struct diff_flags); i++)
 211                 tmp_a[i] |= tmp_b[i];
 212 }
 213
 214 #define DIFF_XDL_TST(opts, flag)    ((opts)->xdl_opts & XDF_##flag)
 215 #define DIFF_XDL_SET(opts, flag)    ((opts)->xdl_opts |= XDF_##flag)
 216 #define DIFF_XDL_CLR(opts, flag)    ((opts)->xdl_opts &= ~XDF_##flag)
 217
 218 #define DIFF_WITH_ALG(opts, flag)   (((opts)->xdl_opts & ~XDF_DIFF_ALGORITHM_MASK) | XDF_##flag)
 219
 220 enum diff_words_type {
 221         DIFF_WORDS_NONE = 0,
 222         DIFF_WORDS_PORCELAIN,
 223         DIFF_WORDS_PLAIN,
 224         DIFF_WORDS_COLOR
 225 };
 226
 227 enum diff_submodule_format {
 228         DIFF_SUBMODULE_SHORT = 0,
 229         DIFF_SUBMODULE_LOG,
 230         DIFF_SUBMODULE_INLINE_DIFF
 231 };
 232
 233 /**
 234  * the set of options the calling program wants to affect the operation of
 235  * diffcore library with.
 236  */
 237 struct diff_options {
 238         const char *orderfile;
 239
 240         /*
 241          * "--rotate-to=<file>" would start showing at <file> and when
 242          * the output reaches the end, wrap around by default.
 243          * Setting skip_instead_of_rotate to true stops the output at the
 244          * end, effectively discarding the earlier part of the output
 245          * before <file>'s diff (this is used to implement the
 246          * "--skip-to=<file>" option).
 247          *
 248          * When rotate_to_strict is set, it is an error if there is no
 249          * <file> in the diff.  Otherwise, the output starts at the
 250          * path that is the same as, or first path that sorts after,
 251          * <file>.  Because it is unreasonable to require the exact
 252          * match for "git log -p --rotate-to=<file>" (i.e. not all
 253          * commit would touch that single <file>), "git log" sets it
 254          * to false.  "git diff" sets it to true to detect an error
 255          * in the command line option.
 256          */
 257         const char *rotate_to;
 258         int skip_instead_of_rotate;
 259         int rotate_to_strict;
 260
 261         /**
 262          * A constant string (can and typically does contain newlines to look for
 263          * a block of text, not just a single line) to filter out the filepairs
 264          * that do not change the number of strings contained in its preimage and
 265          * postimage of the diff_queue.
 266          */
 267         const char *pickaxe;
 268         unsigned pickaxe_opts;
 269
 270         /* -I<regex> */
 271         regex_t **ignore_regex;
 272         size_t ignore_regex_nr, ignore_regex_alloc;
 273
 274         const char *single_follow;
 275         const char *a_prefix, *b_prefix;
 276         const char *line_prefix;
 277         size_t line_prefix_length;
 278
 279         /**
 280          * collection of boolean options that affects the operation, but some do
 281          * not have anything to do with the diffcore library.
 282          */
 283         struct diff_flags flags;
 284
 285         /* diff-filter bits */
 286         unsigned int filter, filter_not;
 287
 288         int use_color;
 289
 290         /* Number of context lines to generate in patch output. */
 291         int context;
 292
 293         int interhunkcontext;
 294
 295         /* Affects the way detection logic for complete rewrites, renames and
 296          * copies.
 297          */
 298         int break_opt;
 299         int detect_rename;
 300
 301         int irreversible_delete;
 302         int skip_stat_unmatch;
 303         int line_termination;
 304
 305         /* The output format used when `diff_flush()` is run. */
 306         int output_format;
 307
 308         /* Affects the way detection logic for complete rewrites, renames and
 309          * copies.
 310          */
 311         int rename_score;
 312         int rename_limit;
 313
 314         int needed_rename_limit;
 315         int degraded_cc_to_c;
 316         int show_rename_progress;
 317         int dirstat_permille;
 318         int setup;
 319
 320         /* Number of hexdigits to abbreviate raw format output to. */
 321         int abbrev;
 322
 323         /* If non-zero, then stop computing after this many changes. */
 324         int max_changes;
 325
 326         int ita_invisible_in_index;
 327 /* white-space error highlighting */
 328 #define WSEH_NEW (1<<12)
 329 #define WSEH_CONTEXT (1<<13)
 330 #define WSEH_OLD (1<<14)
 331         unsigned ws_error_highlight;
 332         const char *prefix;
 333         int prefix_length;
 334         const char *stat_sep;
 335         int xdl_opts;
 336         int ignore_driver_algorithm;
 337
 338         /* see Documentation/diff-options.txt */
 339         char **anchors;
 340         size_t anchors_nr, anchors_alloc;
 341
 342         int stat_width;
 343         int stat_name_width;
 344         int stat_graph_width;
 345         int stat_count;
 346         const char *word_regex;
 347         enum diff_words_type word_diff;
 348         enum diff_submodule_format submodule_format;
 349
 350         struct oidset *objfind;
 351
 352         /* this is set by diffcore for DIFF_FORMAT_PATCH */
 353         int found_changes;
 354
 355         /* to support internal diff recursion by --follow hack*/
 356         int found_follow;
 357
 358         /* Callback which allows tweaking the options in diff_setup_done(). */
 359         void (*set_default)(struct diff_options *);
 360
 361         FILE *file;
 362         int close_file;
 363
 364 #define OUTPUT_INDICATOR_NEW 0
 365 #define OUTPUT_INDICATOR_OLD 1
 366 #define OUTPUT_INDICATOR_CONTEXT 2
 367         char output_indicators[3];
 368
 369         struct pathspec pathspec;
 370         pathchange_fn_t pathchange;
 371         change_fn_t change;
 372         add_remove_fn_t add_remove;
 373         void *change_fn_data;
 374         diff_format_fn_t format_callback;
 375         void *format_callback_data;
 376         diff_prefix_fn_t output_prefix;
 377         void *output_prefix_data;
 378
 379         int diff_path_counter;
 380
 381         struct emitted_diff_symbols *emitted_symbols;
 382         enum {
 383                 COLOR_MOVED_NO = 0,
 384                 COLOR_MOVED_PLAIN = 1,
 385                 COLOR_MOVED_BLOCKS = 2,
 386                 COLOR_MOVED_ZEBRA = 3,
 387                 COLOR_MOVED_ZEBRA_DIM = 4,
 388         } color_moved;
 389         #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
 390         #define COLOR_MOVED_MIN_ALNUM_COUNT 20
 391
 392         /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
 393         #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
 394         #define COLOR_MOVED_WS_ERROR (1<<0)
 395         unsigned color_moved_ws_handling;
 396
 397         struct repository *repo;
 398         struct strmap *additional_path_headers;
 399
 400         int no_free;
 401 };
 402
 403 unsigned diff_filter_bit(char status);
 404
 405 void diff_emit_submodule_del(struct diff_options *o, const char *line);
 406 void diff_emit_submodule_add(struct diff_options *o, const char *line);
 407 void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
 408 void diff_emit_submodule_modified(struct diff_options *o, const char *path);
 409 void diff_emit_submodule_header(struct diff_options *o, const char *header);
 410 void diff_emit_submodule_error(struct diff_options *o, const char *err);
 411 void diff_emit_submodule_pipethrough(struct diff_options *o,
 412                                      const char *line, int len);
 413
 414 struct diffstat_t {
 415         int nr;
 416         int alloc;
 417         struct diffstat_file {
 418                 char *from_name;
 419                 char *name;
 420                 char *print_name;
 421                 const char *comments;
 422                 unsigned is_unmerged:1;
 423                 unsigned is_binary:1;
 424                 unsigned is_renamed:1;
 425                 unsigned is_interesting:1;
 426                 uintmax_t added, deleted;
 427         } **files;
 428 };
 429
 430 enum color_diff {
 431         DIFF_RESET = 0,
 432         DIFF_CONTEXT = 1,
 433         DIFF_METAINFO = 2,
 434         DIFF_FRAGINFO = 3,
 435         DIFF_FILE_OLD = 4,
 436         DIFF_FILE_NEW = 5,
 437         DIFF_COMMIT = 6,
 438         DIFF_WHITESPACE = 7,
 439         DIFF_FUNCINFO = 8,
 440         DIFF_FILE_OLD_MOVED = 9,
 441         DIFF_FILE_OLD_MOVED_ALT = 10,
 442         DIFF_FILE_OLD_MOVED_DIM = 11,
 443         DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
 444         DIFF_FILE_NEW_MOVED = 13,
 445         DIFF_FILE_NEW_MOVED_ALT = 14,
 446         DIFF_FILE_NEW_MOVED_DIM = 15,
 447         DIFF_FILE_NEW_MOVED_ALT_DIM = 16,
 448         DIFF_CONTEXT_DIM = 17,
 449         DIFF_FILE_OLD_DIM = 18,
 450         DIFF_FILE_NEW_DIM = 19,
 451         DIFF_CONTEXT_BOLD = 20,
 452         DIFF_FILE_OLD_BOLD = 21,
 453         DIFF_FILE_NEW_BOLD = 22,
 454 };
 455
 456 const char *diff_get_color(int diff_use_color, enum color_diff ix);
 457 #define diff_get_color_opt(o, ix) \
 458         diff_get_color((o)->use_color, ix)
 459
 460
 461 const char *diff_line_prefix(struct diff_options *);
 462
 463
 464 extern const char mime_boundary_leader[];
 465
 466 struct combine_diff_path *diff_tree_paths(
 467         struct combine_diff_path *p, const struct object_id *oid,
 468         const struct object_id **parents_oid, int nparent,
 469         struct strbuf *base, struct diff_options *opt);
 470 void diff_tree_oid(const struct object_id *old_oid,
 471                    const struct object_id *new_oid,
 472                    const char *base, struct diff_options *opt);
 473 void diff_root_tree_oid(const struct object_id *new_oid, const char *base,
 474                         struct diff_options *opt);
 475
 476 struct combine_diff_path {
 477         struct combine_diff_path *next;
 478         char *path;
 479         unsigned int mode;
 480         struct object_id oid;
 481         struct combine_diff_parent {
 482                 char status;
 483                 unsigned int mode;
 484                 struct object_id oid;
 485                 struct strbuf path;
 486         } parent[FLEX_ARRAY];
 487 };
 488 #define combine_diff_path_size(n, l) \
 489         st_add4(sizeof(struct combine_diff_path), (l), 1, \
 490                 st_mult(sizeof(struct combine_diff_parent), (n)))
 491
 492 void show_combined_diff(struct combine_diff_path *elem, int num_parent,
 493                         struct rev_info *);
 494
 495 void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, struct rev_info *rev);
 496
 497 void diff_tree_combined_merge(const struct commit *commit, struct rev_info *rev);
 498
 499 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
 500 void diff_set_noprefix(struct diff_options *options);
 501 void diff_set_default_prefix(struct diff_options *options);
 502
 503 int diff_can_quit_early(struct diff_options *);
 504
 505 void diff_addremove(struct diff_options *,
 506                     int addremove,
 507                     unsigned mode,
 508                     const struct object_id *oid,
 509                     int oid_valid,
 510                     const char *fullpath, unsigned dirty_submodule);
 511
 512 void diff_change(struct diff_options *,
 513                  unsigned mode1, unsigned mode2,
 514                  const struct object_id *old_oid,
 515                  const struct object_id *new_oid,
 516                  int old_oid_valid, int new_oid_valid,
 517                  const char *fullpath,
 518                  unsigned dirty_submodule1, unsigned dirty_submodule2);
 519
 520 struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
 521
 522 void compute_diffstat(struct diff_options *options, struct diffstat_t *diffstat,
 523                       struct diff_queue_struct *q);
 524 void free_diffstat_info(struct diffstat_t *diffstat);
 525
 526 #define DIFF_SETUP_REVERSE              1
 527 #define DIFF_SETUP_USE_SIZE_CACHE       4
 528
 529 /*
 530  * Poor man's alternative to parse-option, to allow both stuck form
 531  * (--option=value) and separate form (--option value).
 532  */
 533 int parse_long_opt(const char *opt, const char **argv,
 534                    const char **optarg);
 535
 536 struct config_context;
 537 int git_diff_basic_config(const char *var, const char *value,
 538                           const struct config_context *ctx, void *cb);
 539 int git_diff_heuristic_config(const char *var, const char *value, void *cb);
 540 void init_diff_ui_defaults(void);
 541 int git_diff_ui_config(const char *var, const char *value,
 542                        const struct config_context *ctx, void *cb);
 543 void repo_diff_setup(struct repository *, struct diff_options *);
 544 struct option *add_diff_options(const struct option *, struct diff_options *);
 545 int diff_opt_parse(struct diff_options *, const char **, int, const char *);
 546 void diff_setup_done(struct diff_options *);
 547
 548 /*
 549  * Returns true if the pathspec can work with --follow mode. If die_on_error is
 550  * set, die() with a specific error message rather than returning false.
 551  */
 552 int diff_check_follow_pathspec(struct pathspec *ps, int die_on_error);
 553
 554 int git_config_rename(const char *var, const char *value);
 555
 556 #define DIFF_DETECT_RENAME      1
 557 #define DIFF_DETECT_COPY        2
 558
 559 #define DIFF_PICKAXE_ALL        1
 560 #define DIFF_PICKAXE_REGEX      2
 561
 562 #define DIFF_PICKAXE_KIND_S     4 /* traditional plumbing counter */
 563 #define DIFF_PICKAXE_KIND_G     8 /* grep in the patch */
 564 #define DIFF_PICKAXE_KIND_OBJFIND       16 /* specific object IDs */
 565
 566 #define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
 567                                  DIFF_PICKAXE_KIND_G | \
 568                                  DIFF_PICKAXE_KIND_OBJFIND)
 569 #define DIFF_PICKAXE_KINDS_G_REGEX_MASK (DIFF_PICKAXE_KIND_G | \
 570                                          DIFF_PICKAXE_REGEX)
 571 #define DIFF_PICKAXE_KINDS_ALL_OBJFIND_MASK (DIFF_PICKAXE_ALL | \
 572                                              DIFF_PICKAXE_KIND_OBJFIND)
 573
 574 #define DIFF_PICKAXE_IGNORE_CASE        32
 575
 576 void init_diffstat_widths(struct diff_options *);
 577 void diffcore_std(struct diff_options *);
 578 void diffcore_fix_diff_index(void);
 579
 580 #define COMMON_DIFF_OPTIONS_HELP \
 581 "\ncommon diff options:\n" \
 582 "  -z            output diff-raw with lines terminated with NUL.\n" \
 583 "  -p            output patch format.\n" \
 584 "  -u            synonym for -p.\n" \
 585 "  --patch-with-raw\n" \
 586 "                output both a patch and the diff-raw format.\n" \
 587 "  --stat        show diffstat instead of patch.\n" \
 588 "  --numstat     show numeric diffstat instead of patch.\n" \
 589 "  --patch-with-stat\n" \
 590 "                output a patch and prepend its diffstat.\n" \
 591 "  --name-only   show only names of changed files.\n" \
 592 "  --name-status show names and status of changed files.\n" \
 593 "  --full-index  show full object name on index lines.\n" \
 594 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
 595 "  -R            swap input file pairs.\n" \
 596 "  -B            detect complete rewrites.\n" \
 597 "  -M            detect renames.\n" \
 598 "  -C            detect copies.\n" \
 599 "  --find-copies-harder\n" \
 600 "                try unchanged files as candidate for copy detection.\n" \
 601 "  -l<n>         limit rename attempts up to <n> paths.\n" \
 602 "  -O<file>      reorder diffs according to the <file>.\n" \
 603 "  -S<string>    find filepair whose only one side contains the string.\n" \
 604 "  --pickaxe-all\n" \
 605 "                show all files diff when -S is used and hit is found.\n" \
 606 "  -a  --text    treat all files as text.\n"
 607
 608 int diff_queue_is_empty(struct diff_options *o);
 609 void diff_flush(struct diff_options*);
 610 void diff_free(struct diff_options*);
 611 void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
 612
 613 /* diff-raw status letters */
 614 #define DIFF_STATUS_ADDED               'A'
 615 #define DIFF_STATUS_COPIED              'C'
 616 #define DIFF_STATUS_DELETED             'D'
 617 #define DIFF_STATUS_MODIFIED            'M'
 618 #define DIFF_STATUS_RENAMED             'R'
 619 #define DIFF_STATUS_TYPE_CHANGED        'T'
 620 #define DIFF_STATUS_UNKNOWN             'X'
 621 #define DIFF_STATUS_UNMERGED            'U'
 622
 623 /* these are not diff-raw status letters proper, but used by
 624  * diffcore-filter insn to specify additional restrictions.
 625  */
 626 #define DIFF_STATUS_FILTER_AON          '*'
 627 #define DIFF_STATUS_FILTER_BROKEN       'B'
 628
 629 /*
 630  * This is different from repo_find_unique_abbrev() in that
 631  * it stuffs the result with dots for alignment.
 632  */
 633 const char *diff_aligned_abbrev(const struct object_id *sha1, int);
 634
 635 void diff_get_merge_base(const struct rev_info *revs, struct object_id *mb);
 636
 637 /* do not report anything on removed paths */
 638 #define DIFF_SILENT_ON_REMOVED 01
 639 /* report racily-clean paths as modified */
 640 #define DIFF_RACY_IS_MODIFIED 02
 641 void run_diff_files(struct rev_info *revs, unsigned int option);
 642
 643 #define DIFF_INDEX_CACHED 01
 644 #define DIFF_INDEX_MERGE_BASE 02
 645 void run_diff_index(struct rev_info *revs, unsigned int option);
 646
 647 int do_diff_cache(const struct object_id *, struct diff_options *);
 648 int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
 649 void flush_one_hunk(struct object_id *result, git_hash_ctx *ctx);
 650
 651 int diff_result_code(struct rev_info *);
 652
 653 int diff_no_index(struct rev_info *,
 654                   int implicit_no_index, int, const char **);
 655
 656 int index_differs_from(struct repository *r, const char *def,
 657                        const struct diff_flags *flags,
 658                        int ita_invisible_in_index);
 659
 660 /*
 661  * Emit an interdiff of two object ID's to 'diff_options.file' optionally
 662  * indented by 'indent' spaces.
 663  */
 664 void show_interdiff(const struct object_id *, const struct object_id *,
 665                     int indent, struct diff_options *);
 666
 667 /*
 668  * Fill the contents of the filespec "df", respecting any textconv defined by
 669  * its userdiff driver.  The "driver" parameter must come from a
 670  * previous call to get_textconv(), and therefore should either be NULL or have
 671  * textconv enabled.
 672  *
 673  * Note that the memory ownership of the resulting buffer depends on whether
 674  * the driver field is NULL. If it is, then the memory belongs to the filespec
 675  * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
 676  * that should be freed by the caller.
 677  */
 678 size_t fill_textconv(struct repository *r,
 679                      struct userdiff_driver *driver,
 680                      struct diff_filespec *df,
 681                      char **outbuf);
 682
 683 /*
 684  * Look up the userdiff driver for the given filespec, and return it if
 685  * and only if it has textconv enabled (otherwise return NULL). The result
 686  * can be passed to fill_textconv().
 687  */
 688 struct userdiff_driver *get_textconv(struct repository *r,
 689                                      struct diff_filespec *one);
 690
 691 /*
 692  * Prepare diff_filespec and convert it using diff textconv API
 693  * if the textconv driver exists.
 694  * Return 1 if the conversion succeeds, 0 otherwise.
 695  */
 696 int textconv_object(struct repository *repo,
 697                     const char *path,
 698                     unsigned mode,
 699                     const struct object_id *oid, int oid_valid,
 700                     char **buf, unsigned long *buf_size);
 701
 702 int parse_rename_score(const char **cp_p);
 703
 704 long parse_algorithm_value(const char *value);
 705
 706 void print_stat_summary(FILE *fp, int files,
 707                         int insertions, int deletions);
 708 void setup_diff_pager(struct diff_options *);
 709
 710 extern int diff_auto_refresh_index;
 711
 712 #endif /* DIFF_H */