diff.h

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