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