Merge branch 'pw/no-editor-in-rebase-i-implicit'
[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 struct rev_info;
13 struct diff_options;
14 struct diff_queue_struct;
15 struct strbuf;
16 struct diff_filespec;
17 struct userdiff_driver;
18 struct oid_array;
19 struct commit;
20 struct combine_diff_path;
21 struct repository;
22
23 typedef int (*pathchange_fn_t)(struct diff_options *options,
24                  struct combine_diff_path *path);
25
26 typedef void (*change_fn_t)(struct diff_options *options,
27                  unsigned old_mode, unsigned new_mode,
28                  const struct object_id *old_oid,
29                  const struct object_id *new_oid,
30                  int old_oid_valid, int new_oid_valid,
31                  const char *fullpath,
32                  unsigned old_dirty_submodule, unsigned new_dirty_submodule);
33
34 typedef void (*add_remove_fn_t)(struct diff_options *options,
35                     int addremove, unsigned mode,
36                     const struct object_id *oid,
37                     int oid_valid,
38                     const char *fullpath, unsigned dirty_submodule);
39
40 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
41                 struct diff_options *options, void *data);
42
43 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
44
45 #define DIFF_FORMAT_RAW         0x0001
46 #define DIFF_FORMAT_DIFFSTAT    0x0002
47 #define DIFF_FORMAT_NUMSTAT     0x0004
48 #define DIFF_FORMAT_SUMMARY     0x0008
49 #define DIFF_FORMAT_PATCH       0x0010
50 #define DIFF_FORMAT_SHORTSTAT   0x0020
51 #define DIFF_FORMAT_DIRSTAT     0x0040
52
53 /* These override all above */
54 #define DIFF_FORMAT_NAME        0x0100
55 #define DIFF_FORMAT_NAME_STATUS 0x0200
56 #define DIFF_FORMAT_CHECKDIFF   0x0400
57
58 /* Same as output_format = 0 but we know that -s flag was given
59  * and we should not give default value to output_format.
60  */
61 #define DIFF_FORMAT_NO_OUTPUT   0x0800
62
63 #define DIFF_FORMAT_CALLBACK    0x1000
64
65 #define DIFF_FLAGS_INIT { 0 }
66 struct diff_flags {
67         unsigned recursive:1;
68         unsigned tree_in_recursive:1;
69         unsigned binary:1;
70         unsigned text:1;
71         unsigned full_index:1;
72         unsigned silent_on_remove:1;
73         unsigned find_copies_harder:1;
74         unsigned follow_renames:1;
75         unsigned rename_empty:1;
76         unsigned has_changes:1;
77         unsigned quick:1;
78         unsigned no_index:1;
79         unsigned allow_external:1;
80         unsigned exit_with_status:1;
81         unsigned reverse_diff:1;
82         unsigned check_failed:1;
83         unsigned relative_name:1;
84         unsigned ignore_submodules:1;
85         unsigned dirstat_cumulative:1;
86         unsigned dirstat_by_file:1;
87         unsigned allow_textconv:1;
88         unsigned textconv_set_via_cmdline:1;
89         unsigned diff_from_contents:1;
90         unsigned dirty_submodules:1;
91         unsigned ignore_untracked_in_submodules:1;
92         unsigned ignore_dirty_submodules:1;
93         unsigned override_submodule_config:1;
94         unsigned dirstat_by_line:1;
95         unsigned funccontext:1;
96         unsigned default_follow_renames:1;
97         unsigned stat_with_summary:1;
98         unsigned suppress_diff_headers:1;
99         unsigned dual_color_diffed_diffs:1;
100 };
101
102 static inline void diff_flags_or(struct diff_flags *a,
103                                  const struct diff_flags *b)
104 {
105         char *tmp_a = (char *)a;
106         const char *tmp_b = (const char *)b;
107         int i;
108
109         for (i = 0; i < sizeof(struct diff_flags); i++)
110                 tmp_a[i] |= tmp_b[i];
111 }
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
119 enum diff_words_type {
120         DIFF_WORDS_NONE = 0,
121         DIFF_WORDS_PORCELAIN,
122         DIFF_WORDS_PLAIN,
123         DIFF_WORDS_COLOR
124 };
125
126 enum diff_submodule_format {
127         DIFF_SUBMODULE_SHORT = 0,
128         DIFF_SUBMODULE_LOG,
129         DIFF_SUBMODULE_INLINE_DIFF
130 };
131
132 struct 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         unsigned 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         /* see Documentation/diff-options.txt */
174         char **anchors;
175         size_t anchors_nr, anchors_alloc;
176
177         int stat_width;
178         int stat_name_width;
179         int stat_graph_width;
180         int stat_count;
181         const char *word_regex;
182         enum diff_words_type word_diff;
183         enum diff_submodule_format submodule_format;
184
185         struct oidset *objfind;
186
187         /* this is set by diffcore for DIFF_FORMAT_PATCH */
188         int found_changes;
189
190         /* to support internal diff recursion by --follow hack*/
191         int found_follow;
192
193         void (*set_default)(struct diff_options *);
194
195         FILE *file;
196         int close_file;
197
198 #define OUTPUT_INDICATOR_NEW 0
199 #define OUTPUT_INDICATOR_OLD 1
200 #define OUTPUT_INDICATOR_CONTEXT 2
201         char output_indicators[3];
202
203         struct pathspec pathspec;
204         pathchange_fn_t pathchange;
205         change_fn_t change;
206         add_remove_fn_t add_remove;
207         void *change_fn_data;
208         diff_format_fn_t format_callback;
209         void *format_callback_data;
210         diff_prefix_fn_t output_prefix;
211         void *output_prefix_data;
212
213         int diff_path_counter;
214
215         struct emitted_diff_symbols *emitted_symbols;
216         enum {
217                 COLOR_MOVED_NO = 0,
218                 COLOR_MOVED_PLAIN = 1,
219                 COLOR_MOVED_BLOCKS = 2,
220                 COLOR_MOVED_ZEBRA = 3,
221                 COLOR_MOVED_ZEBRA_DIM = 4,
222         } color_moved;
223         #define COLOR_MOVED_DEFAULT COLOR_MOVED_ZEBRA
224         #define COLOR_MOVED_MIN_ALNUM_COUNT 20
225
226         /* XDF_WHITESPACE_FLAGS regarding block detection are set at 2, 3, 4 */
227         #define COLOR_MOVED_WS_ALLOW_INDENTATION_CHANGE (1<<5)
228         #define COLOR_MOVED_WS_ERROR (1<<0)
229         unsigned color_moved_ws_handling;
230
231         struct repository *repo;
232 };
233
234 void diff_emit_submodule_del(struct diff_options *o, const char *line);
235 void diff_emit_submodule_add(struct diff_options *o, const char *line);
236 void diff_emit_submodule_untracked(struct diff_options *o, const char *path);
237 void diff_emit_submodule_modified(struct diff_options *o, const char *path);
238 void diff_emit_submodule_header(struct diff_options *o, const char *header);
239 void diff_emit_submodule_error(struct diff_options *o, const char *err);
240 void diff_emit_submodule_pipethrough(struct diff_options *o,
241                                      const char *line, int len);
242
243 enum color_diff {
244         DIFF_RESET = 0,
245         DIFF_CONTEXT = 1,
246         DIFF_METAINFO = 2,
247         DIFF_FRAGINFO = 3,
248         DIFF_FILE_OLD = 4,
249         DIFF_FILE_NEW = 5,
250         DIFF_COMMIT = 6,
251         DIFF_WHITESPACE = 7,
252         DIFF_FUNCINFO = 8,
253         DIFF_FILE_OLD_MOVED = 9,
254         DIFF_FILE_OLD_MOVED_ALT = 10,
255         DIFF_FILE_OLD_MOVED_DIM = 11,
256         DIFF_FILE_OLD_MOVED_ALT_DIM = 12,
257         DIFF_FILE_NEW_MOVED = 13,
258         DIFF_FILE_NEW_MOVED_ALT = 14,
259         DIFF_FILE_NEW_MOVED_DIM = 15,
260         DIFF_FILE_NEW_MOVED_ALT_DIM = 16,
261         DIFF_CONTEXT_DIM = 17,
262         DIFF_FILE_OLD_DIM = 18,
263         DIFF_FILE_NEW_DIM = 19,
264         DIFF_CONTEXT_BOLD = 20,
265         DIFF_FILE_OLD_BOLD = 21,
266         DIFF_FILE_NEW_BOLD = 22,
267 };
268 const char *diff_get_color(int diff_use_color, enum color_diff ix);
269 #define diff_get_color_opt(o, ix) \
270         diff_get_color((o)->use_color, ix)
271
272
273 const char *diff_line_prefix(struct diff_options *);
274
275
276 extern const char mime_boundary_leader[];
277
278 struct combine_diff_path *diff_tree_paths(
279         struct combine_diff_path *p, const struct object_id *oid,
280         const struct object_id **parents_oid, int nparent,
281         struct strbuf *base, struct diff_options *opt);
282 int diff_tree_oid(const struct object_id *old_oid,
283                   const struct object_id *new_oid,
284                   const char *base, struct diff_options *opt);
285 int diff_root_tree_oid(const struct object_id *new_oid, const char *base,
286                        struct diff_options *opt);
287
288 struct combine_diff_path {
289         struct combine_diff_path *next;
290         char *path;
291         unsigned int mode;
292         struct object_id oid;
293         struct combine_diff_parent {
294                 char status;
295                 unsigned int mode;
296                 struct object_id oid;
297         } parent[FLEX_ARRAY];
298 };
299 #define combine_diff_path_size(n, l) \
300         st_add4(sizeof(struct combine_diff_path), (l), 1, \
301                 st_mult(sizeof(struct combine_diff_parent), (n)))
302
303 void show_combined_diff(struct combine_diff_path *elem, int num_parent,
304                         int dense, struct rev_info *);
305
306 void diff_tree_combined(const struct object_id *oid, const struct oid_array *parents, int dense, struct rev_info *rev);
307
308 void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
309
310 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
311
312 int diff_can_quit_early(struct diff_options *);
313
314 void diff_addremove(struct diff_options *,
315                     int addremove,
316                     unsigned mode,
317                     const struct object_id *oid,
318                     int oid_valid,
319                     const char *fullpath, unsigned dirty_submodule);
320
321 void diff_change(struct diff_options *,
322                  unsigned mode1, unsigned mode2,
323                  const struct object_id *old_oid,
324                  const struct object_id *new_oid,
325                  int old_oid_valid, int new_oid_valid,
326                  const char *fullpath,
327                  unsigned dirty_submodule1, unsigned dirty_submodule2);
328
329 struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
330
331 #define DIFF_SETUP_REVERSE              1
332 #define DIFF_SETUP_USE_SIZE_CACHE       4
333
334 /*
335  * Poor man's alternative to parse-option, to allow both stuck form
336  * (--option=value) and separate form (--option value).
337  */
338 int parse_long_opt(const char *opt, const char **argv,
339                    const char **optarg);
340
341 int git_diff_basic_config(const char *var, const char *value, void *cb);
342 int git_diff_heuristic_config(const char *var, const char *value, void *cb);
343 void init_diff_ui_defaults(void);
344 int git_diff_ui_config(const char *var, const char *value, void *cb);
345 #ifndef NO_THE_REPOSITORY_COMPATIBILITY_MACROS
346 #define diff_setup(diffopts) repo_diff_setup(the_repository, diffopts)
347 #endif
348 void repo_diff_setup(struct repository *, struct diff_options *);
349 int diff_opt_parse(struct diff_options *, const char **, int, const char *);
350 void diff_setup_done(struct diff_options *);
351 int git_config_rename(const char *var, const char *value);
352
353 #define DIFF_DETECT_RENAME      1
354 #define DIFF_DETECT_COPY        2
355
356 #define DIFF_PICKAXE_ALL        1
357 #define DIFF_PICKAXE_REGEX      2
358
359 #define DIFF_PICKAXE_KIND_S     4 /* traditional plumbing counter */
360 #define DIFF_PICKAXE_KIND_G     8 /* grep in the patch */
361 #define DIFF_PICKAXE_KIND_OBJFIND       16 /* specific object IDs */
362
363 #define DIFF_PICKAXE_KINDS_MASK (DIFF_PICKAXE_KIND_S | \
364                                  DIFF_PICKAXE_KIND_G | \
365                                  DIFF_PICKAXE_KIND_OBJFIND)
366
367 #define DIFF_PICKAXE_IGNORE_CASE        32
368
369 void diffcore_std(struct diff_options *);
370 void diffcore_fix_diff_index(struct diff_options *);
371
372 #define COMMON_DIFF_OPTIONS_HELP \
373 "\ncommon diff options:\n" \
374 "  -z            output diff-raw with lines terminated with NUL.\n" \
375 "  -p            output patch format.\n" \
376 "  -u            synonym for -p.\n" \
377 "  --patch-with-raw\n" \
378 "                output both a patch and the diff-raw format.\n" \
379 "  --stat        show diffstat instead of patch.\n" \
380 "  --numstat     show numeric diffstat instead of patch.\n" \
381 "  --patch-with-stat\n" \
382 "                output a patch and prepend its diffstat.\n" \
383 "  --name-only   show only names of changed files.\n" \
384 "  --name-status show names and status of changed files.\n" \
385 "  --full-index  show full object name on index lines.\n" \
386 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
387 "  -R            swap input file pairs.\n" \
388 "  -B            detect complete rewrites.\n" \
389 "  -M            detect renames.\n" \
390 "  -C            detect copies.\n" \
391 "  --find-copies-harder\n" \
392 "                try unchanged files as candidate for copy detection.\n" \
393 "  -l<n>         limit rename attempts up to <n> paths.\n" \
394 "  -O<file>      reorder diffs according to the <file>.\n" \
395 "  -S<string>    find filepair whose only one side contains the string.\n" \
396 "  --pickaxe-all\n" \
397 "                show all files diff when -S is used and hit is found.\n" \
398 "  -a  --text    treat all files as text.\n"
399
400 int diff_queue_is_empty(void);
401 void diff_flush(struct diff_options*);
402 void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
403
404 /* diff-raw status letters */
405 #define DIFF_STATUS_ADDED               'A'
406 #define DIFF_STATUS_COPIED              'C'
407 #define DIFF_STATUS_DELETED             'D'
408 #define DIFF_STATUS_MODIFIED            'M'
409 #define DIFF_STATUS_RENAMED             'R'
410 #define DIFF_STATUS_TYPE_CHANGED        'T'
411 #define DIFF_STATUS_UNKNOWN             'X'
412 #define DIFF_STATUS_UNMERGED            'U'
413
414 /* these are not diff-raw status letters proper, but used by
415  * diffcore-filter insn to specify additional restrictions.
416  */
417 #define DIFF_STATUS_FILTER_AON          '*'
418 #define DIFF_STATUS_FILTER_BROKEN       'B'
419
420 /*
421  * This is different from find_unique_abbrev() in that
422  * it stuffs the result with dots for alignment.
423  */
424 const char *diff_aligned_abbrev(const struct object_id *sha1, int);
425
426 /* do not report anything on removed paths */
427 #define DIFF_SILENT_ON_REMOVED 01
428 /* report racily-clean paths as modified */
429 #define DIFF_RACY_IS_MODIFIED 02
430 int run_diff_files(struct rev_info *revs, unsigned int option);
431 int run_diff_index(struct rev_info *revs, int cached);
432
433 int do_diff_cache(const struct object_id *, struct diff_options *);
434 int diff_flush_patch_id(struct diff_options *, struct object_id *, int);
435
436 int diff_result_code(struct diff_options *, int);
437
438 void diff_no_index(struct repository *, struct rev_info *, int, const char **);
439
440 int index_differs_from(struct repository *r, const char *def,
441                        const struct diff_flags *flags,
442                        int ita_invisible_in_index);
443
444 /*
445  * Fill the contents of the filespec "df", respecting any textconv defined by
446  * its userdiff driver.  The "driver" parameter must come from a
447  * previous call to get_textconv(), and therefore should either be NULL or have
448  * textconv enabled.
449  *
450  * Note that the memory ownership of the resulting buffer depends on whether
451  * the driver field is NULL. If it is, then the memory belongs to the filespec
452  * struct. If it is non-NULL, then "outbuf" points to a newly allocated buffer
453  * that should be freed by the caller.
454  */
455 size_t fill_textconv(struct repository *r,
456                      struct userdiff_driver *driver,
457                      struct diff_filespec *df,
458                      char **outbuf);
459
460 /*
461  * Look up the userdiff driver for the given filespec, and return it if
462  * and only if it has textconv enabled (otherwise return NULL). The result
463  * can be passed to fill_textconv().
464  */
465 struct userdiff_driver *get_textconv(struct repository *r,
466                                      struct diff_filespec *one);
467
468 /*
469  * Prepare diff_filespec and convert it using diff textconv API
470  * if the textconv driver exists.
471  * Return 1 if the conversion succeeds, 0 otherwise.
472  */
473 int textconv_object(struct repository *repo,
474                     const char *path,
475                     unsigned mode,
476                     const struct object_id *oid, int oid_valid,
477                     char **buf, unsigned long *buf_size);
478
479 int parse_rename_score(const char **cp_p);
480
481 long parse_algorithm_value(const char *value);
482
483 void print_stat_summary(FILE *fp, int files,
484                         int insertions, int deletions);
485 void setup_diff_pager(struct diff_options *);
486
487 #endif /* DIFF_H */