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