fetch-pack.c: rename some parameters from "path" to "refname"
[git/mjg.git] / diff.h
blobae71f4ccf94369b31b1a77373861b02d478d705a
1 /*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4 #ifndef DIFF_H
5 #define DIFF_H
7 #include "tree-walk.h"
9 struct rev_info;
10 struct diff_options;
11 struct diff_queue_struct;
12 struct strbuf;
13 struct diff_filespec;
14 struct userdiff_driver;
15 struct sha1_array;
16 struct commit;
18 typedef void (*change_fn_t)(struct diff_options *options,
19 unsigned old_mode, unsigned new_mode,
20 const unsigned char *old_sha1,
21 const unsigned char *new_sha1,
22 const char *fullpath,
23 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
25 typedef void (*add_remove_fn_t)(struct diff_options *options,
26 int addremove, unsigned mode,
27 const unsigned char *sha1,
28 const char *fullpath, unsigned dirty_submodule);
30 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
31 struct diff_options *options, void *data);
33 typedef struct strbuf *(*diff_prefix_fn_t)(struct diff_options *opt, void *data);
35 #define DIFF_FORMAT_RAW 0x0001
36 #define DIFF_FORMAT_DIFFSTAT 0x0002
37 #define DIFF_FORMAT_NUMSTAT 0x0004
38 #define DIFF_FORMAT_SUMMARY 0x0008
39 #define DIFF_FORMAT_PATCH 0x0010
40 #define DIFF_FORMAT_SHORTSTAT 0x0020
41 #define DIFF_FORMAT_DIRSTAT 0x0040
43 /* These override all above */
44 #define DIFF_FORMAT_NAME 0x0100
45 #define DIFF_FORMAT_NAME_STATUS 0x0200
46 #define DIFF_FORMAT_CHECKDIFF 0x0400
48 /* Same as output_format = 0 but we know that -s flag was given
49 * and we should not give default value to output_format.
51 #define DIFF_FORMAT_NO_OUTPUT 0x0800
53 #define DIFF_FORMAT_CALLBACK 0x1000
55 #define DIFF_OPT_RECURSIVE (1 << 0)
56 #define DIFF_OPT_TREE_IN_RECURSIVE (1 << 1)
57 #define DIFF_OPT_BINARY (1 << 2)
58 #define DIFF_OPT_TEXT (1 << 3)
59 #define DIFF_OPT_FULL_INDEX (1 << 4)
60 #define DIFF_OPT_SILENT_ON_REMOVE (1 << 5)
61 #define DIFF_OPT_FIND_COPIES_HARDER (1 << 6)
62 #define DIFF_OPT_FOLLOW_RENAMES (1 << 7)
63 /* (1 << 8) unused */
64 /* (1 << 9) unused */
65 #define DIFF_OPT_HAS_CHANGES (1 << 10)
66 #define DIFF_OPT_QUICK (1 << 11)
67 #define DIFF_OPT_NO_INDEX (1 << 12)
68 #define DIFF_OPT_ALLOW_EXTERNAL (1 << 13)
69 #define DIFF_OPT_EXIT_WITH_STATUS (1 << 14)
70 #define DIFF_OPT_REVERSE_DIFF (1 << 15)
71 #define DIFF_OPT_CHECK_FAILED (1 << 16)
72 #define DIFF_OPT_RELATIVE_NAME (1 << 17)
73 #define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
74 #define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
75 #define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
76 #define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
77 #define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
78 #define DIFF_OPT_SUBMODULE_LOG (1 << 23)
79 #define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
80 #define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
81 #define DIFF_OPT_IGNORE_DIRTY_SUBMODULES (1 << 26)
82 #define DIFF_OPT_OVERRIDE_SUBMODULE_CONFIG (1 << 27)
83 #define DIFF_OPT_DIRSTAT_BY_LINE (1 << 28)
84 #define DIFF_OPT_FUNCCONTEXT (1 << 29)
86 #define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
87 #define DIFF_OPT_SET(opts, flag) ((opts)->flags |= DIFF_OPT_##flag)
88 #define DIFF_OPT_CLR(opts, flag) ((opts)->flags &= ~DIFF_OPT_##flag)
89 #define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
90 #define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
91 #define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
93 enum diff_words_type {
94 DIFF_WORDS_NONE = 0,
95 DIFF_WORDS_PORCELAIN,
96 DIFF_WORDS_PLAIN,
97 DIFF_WORDS_COLOR
100 struct diff_options {
101 const char *filter;
102 const char *orderfile;
103 const char *pickaxe;
104 const char *single_follow;
105 const char *a_prefix, *b_prefix;
106 unsigned flags;
107 int use_color;
108 int context;
109 int interhunkcontext;
110 int break_opt;
111 int detect_rename;
112 int irreversible_delete;
113 int skip_stat_unmatch;
114 int line_termination;
115 int output_format;
116 int pickaxe_opts;
117 int rename_score;
118 int rename_limit;
119 int needed_rename_limit;
120 int degraded_cc_to_c;
121 int show_rename_progress;
122 int dirstat_permille;
123 int setup;
124 int abbrev;
125 const char *prefix;
126 int prefix_length;
127 const char *stat_sep;
128 long xdl_opts;
130 int stat_width;
131 int stat_name_width;
132 int stat_count;
133 const char *word_regex;
134 enum diff_words_type word_diff;
136 /* this is set by diffcore for DIFF_FORMAT_PATCH */
137 int found_changes;
139 /* to support internal diff recursion by --follow hack*/
140 int found_follow;
142 FILE *file;
143 int close_file;
145 struct pathspec pathspec;
146 change_fn_t change;
147 add_remove_fn_t add_remove;
148 diff_format_fn_t format_callback;
149 void *format_callback_data;
150 diff_prefix_fn_t output_prefix;
151 void *output_prefix_data;
154 enum color_diff {
155 DIFF_RESET = 0,
156 DIFF_PLAIN = 1,
157 DIFF_METAINFO = 2,
158 DIFF_FRAGINFO = 3,
159 DIFF_FILE_OLD = 4,
160 DIFF_FILE_NEW = 5,
161 DIFF_COMMIT = 6,
162 DIFF_WHITESPACE = 7,
163 DIFF_FUNCINFO = 8
165 const char *diff_get_color(int diff_use_color, enum color_diff ix);
166 #define diff_get_color_opt(o, ix) \
167 diff_get_color((o)->use_color, ix)
170 extern const char mime_boundary_leader[];
172 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
173 extern void diff_tree_release_paths(struct diff_options *);
174 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
175 const char *base, struct diff_options *opt);
176 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
177 const char *base, struct diff_options *opt);
178 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
179 struct diff_options *opt);
181 struct combine_diff_path {
182 struct combine_diff_path *next;
183 int len;
184 char *path;
185 unsigned int mode;
186 unsigned char sha1[20];
187 struct combine_diff_parent {
188 char status;
189 unsigned int mode;
190 unsigned char sha1[20];
191 } parent[FLEX_ARRAY];
193 #define combine_diff_path_size(n, l) \
194 (sizeof(struct combine_diff_path) + \
195 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
197 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
198 int dense, struct rev_info *);
200 extern void diff_tree_combined(const unsigned char *sha1, const struct sha1_array *parents, int dense, struct rev_info *rev);
202 extern void diff_tree_combined_merge(const struct commit *commit, int dense, struct rev_info *rev);
204 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
206 extern int diff_can_quit_early(struct diff_options *);
208 extern void diff_addremove(struct diff_options *,
209 int addremove,
210 unsigned mode,
211 const unsigned char *sha1,
212 const char *fullpath, unsigned dirty_submodule);
214 extern void diff_change(struct diff_options *,
215 unsigned mode1, unsigned mode2,
216 const unsigned char *sha1,
217 const unsigned char *sha2,
218 const char *fullpath,
219 unsigned dirty_submodule1, unsigned dirty_submodule2);
221 extern struct diff_filepair *diff_unmerge(struct diff_options *, const char *path);
223 #define DIFF_SETUP_REVERSE 1
224 #define DIFF_SETUP_USE_CACHE 2
225 #define DIFF_SETUP_USE_SIZE_CACHE 4
228 * Poor man's alternative to parse-option, to allow both sticked form
229 * (--option=value) and separate form (--option value).
231 extern int parse_long_opt(const char *opt, const char **argv,
232 const char **optarg);
234 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
235 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
236 extern int diff_use_color_default;
237 extern void diff_setup(struct diff_options *);
238 extern int diff_opt_parse(struct diff_options *, const char **, int);
239 extern int diff_setup_done(struct diff_options *);
241 #define DIFF_DETECT_RENAME 1
242 #define DIFF_DETECT_COPY 2
244 #define DIFF_PICKAXE_ALL 1
245 #define DIFF_PICKAXE_REGEX 2
247 #define DIFF_PICKAXE_KIND_S 4 /* traditional plumbing counter */
248 #define DIFF_PICKAXE_KIND_G 8 /* grep in the patch */
250 extern void diffcore_std(struct diff_options *);
251 extern void diffcore_fix_diff_index(struct diff_options *);
253 #define COMMON_DIFF_OPTIONS_HELP \
254 "\ncommon diff options:\n" \
255 " -z output diff-raw with lines terminated with NUL.\n" \
256 " -p output patch format.\n" \
257 " -u synonym for -p.\n" \
258 " --patch-with-raw\n" \
259 " output both a patch and the diff-raw format.\n" \
260 " --stat show diffstat instead of patch.\n" \
261 " --numstat show numeric diffstat instead of patch.\n" \
262 " --patch-with-stat\n" \
263 " output a patch and prepend its diffstat.\n" \
264 " --name-only show only names of changed files.\n" \
265 " --name-status show names and status of changed files.\n" \
266 " --full-index show full object name on index lines.\n" \
267 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
268 " -R swap input file pairs.\n" \
269 " -B detect complete rewrites.\n" \
270 " -M detect renames.\n" \
271 " -C detect copies.\n" \
272 " --find-copies-harder\n" \
273 " try unchanged files as candidate for copy detection.\n" \
274 " -l<n> limit rename attempts up to <n> paths.\n" \
275 " -O<file> reorder diffs according to the <file>.\n" \
276 " -S<string> find filepair whose only one side contains the string.\n" \
277 " --pickaxe-all\n" \
278 " show all files diff when -S is used and hit is found.\n" \
279 " -a --text treat all files as text.\n"
281 extern int diff_queue_is_empty(void);
282 extern void diff_flush(struct diff_options*);
283 extern void diff_warn_rename_limit(const char *varname, int needed, int degraded_cc);
285 /* diff-raw status letters */
286 #define DIFF_STATUS_ADDED 'A'
287 #define DIFF_STATUS_COPIED 'C'
288 #define DIFF_STATUS_DELETED 'D'
289 #define DIFF_STATUS_MODIFIED 'M'
290 #define DIFF_STATUS_RENAMED 'R'
291 #define DIFF_STATUS_TYPE_CHANGED 'T'
292 #define DIFF_STATUS_UNKNOWN 'X'
293 #define DIFF_STATUS_UNMERGED 'U'
295 /* these are not diff-raw status letters proper, but used by
296 * diffcore-filter insn to specify additional restrictions.
298 #define DIFF_STATUS_FILTER_AON '*'
299 #define DIFF_STATUS_FILTER_BROKEN 'B'
301 extern const char *diff_unique_abbrev(const unsigned char *, int);
303 /* do not report anything on removed paths */
304 #define DIFF_SILENT_ON_REMOVED 01
305 /* report racily-clean paths as modified */
306 #define DIFF_RACY_IS_MODIFIED 02
307 extern int run_diff_files(struct rev_info *revs, unsigned int option);
308 extern int run_diff_index(struct rev_info *revs, int cached);
310 extern int do_diff_cache(const unsigned char *, struct diff_options *);
311 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
313 extern int diff_result_code(struct diff_options *, int);
315 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
317 extern int index_differs_from(const char *def, int diff_flags);
319 extern size_t fill_textconv(struct userdiff_driver *driver,
320 struct diff_filespec *df,
321 char **outbuf);
323 extern struct userdiff_driver *get_textconv(struct diff_filespec *one);
325 extern int parse_rename_score(const char **cp_p);
327 #endif /* DIFF_H */