Merge branch 'mg/advice-statushints'
[git/platforms.git] / diff.h
blob9ace08cbae0651d53dd558f80a3d88777b5521c3
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;
13 typedef void (*change_fn_t)(struct diff_options *options,
14 unsigned old_mode, unsigned new_mode,
15 const unsigned char *old_sha1,
16 const unsigned char *new_sha1,
17 const char *fullpath,
18 unsigned old_dirty_submodule, unsigned new_dirty_submodule);
20 typedef void (*add_remove_fn_t)(struct diff_options *options,
21 int addremove, unsigned mode,
22 const unsigned char *sha1,
23 const char *fullpath, unsigned dirty_submodule);
25 typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
26 struct diff_options *options, void *data);
28 #define DIFF_FORMAT_RAW 0x0001
29 #define DIFF_FORMAT_DIFFSTAT 0x0002
30 #define DIFF_FORMAT_NUMSTAT 0x0004
31 #define DIFF_FORMAT_SUMMARY 0x0008
32 #define DIFF_FORMAT_PATCH 0x0010
33 #define DIFF_FORMAT_SHORTSTAT 0x0020
34 #define DIFF_FORMAT_DIRSTAT 0x0040
36 /* These override all above */
37 #define DIFF_FORMAT_NAME 0x0100
38 #define DIFF_FORMAT_NAME_STATUS 0x0200
39 #define DIFF_FORMAT_CHECKDIFF 0x0400
41 /* Same as output_format = 0 but we know that -s flag was given
42 * and we should not give default value to output_format.
44 #define DIFF_FORMAT_NO_OUTPUT 0x0800
46 #define DIFF_FORMAT_CALLBACK 0x1000
48 #define DIFF_OPT_RECURSIVE (1 << 0)
49 #define DIFF_OPT_TREE_IN_RECURSIVE (1 << 1)
50 #define DIFF_OPT_BINARY (1 << 2)
51 #define DIFF_OPT_TEXT (1 << 3)
52 #define DIFF_OPT_FULL_INDEX (1 << 4)
53 #define DIFF_OPT_SILENT_ON_REMOVE (1 << 5)
54 #define DIFF_OPT_FIND_COPIES_HARDER (1 << 6)
55 #define DIFF_OPT_FOLLOW_RENAMES (1 << 7)
56 #define DIFF_OPT_COLOR_DIFF (1 << 8)
57 /* (1 << 9) unused */
58 #define DIFF_OPT_HAS_CHANGES (1 << 10)
59 #define DIFF_OPT_QUICK (1 << 11)
60 #define DIFF_OPT_NO_INDEX (1 << 12)
61 #define DIFF_OPT_ALLOW_EXTERNAL (1 << 13)
62 #define DIFF_OPT_EXIT_WITH_STATUS (1 << 14)
63 #define DIFF_OPT_REVERSE_DIFF (1 << 15)
64 #define DIFF_OPT_CHECK_FAILED (1 << 16)
65 #define DIFF_OPT_RELATIVE_NAME (1 << 17)
66 #define DIFF_OPT_IGNORE_SUBMODULES (1 << 18)
67 #define DIFF_OPT_DIRSTAT_CUMULATIVE (1 << 19)
68 #define DIFF_OPT_DIRSTAT_BY_FILE (1 << 20)
69 #define DIFF_OPT_ALLOW_TEXTCONV (1 << 21)
70 #define DIFF_OPT_DIFF_FROM_CONTENTS (1 << 22)
71 #define DIFF_OPT_SUBMODULE_LOG (1 << 23)
72 #define DIFF_OPT_DIRTY_SUBMODULES (1 << 24)
73 #define DIFF_OPT_IGNORE_UNTRACKED_IN_SUBMODULES (1 << 25)
75 #define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
76 #define DIFF_OPT_SET(opts, flag) ((opts)->flags |= DIFF_OPT_##flag)
77 #define DIFF_OPT_CLR(opts, flag) ((opts)->flags &= ~DIFF_OPT_##flag)
78 #define DIFF_XDL_TST(opts, flag) ((opts)->xdl_opts & XDF_##flag)
79 #define DIFF_XDL_SET(opts, flag) ((opts)->xdl_opts |= XDF_##flag)
80 #define DIFF_XDL_CLR(opts, flag) ((opts)->xdl_opts &= ~XDF_##flag)
82 enum diff_words_type {
83 DIFF_WORDS_NONE = 0,
84 DIFF_WORDS_PORCELAIN,
85 DIFF_WORDS_PLAIN,
86 DIFF_WORDS_COLOR
89 struct diff_options {
90 const char *filter;
91 const char *orderfile;
92 const char *pickaxe;
93 const char *single_follow;
94 const char *a_prefix, *b_prefix;
95 unsigned flags;
96 int context;
97 int interhunkcontext;
98 int break_opt;
99 int detect_rename;
100 int skip_stat_unmatch;
101 int line_termination;
102 int output_format;
103 int pickaxe_opts;
104 int rename_score;
105 int rename_limit;
106 int warn_on_too_large_rename;
107 int dirstat_percent;
108 int setup;
109 int abbrev;
110 const char *prefix;
111 int prefix_length;
112 const char *stat_sep;
113 long xdl_opts;
115 int stat_width;
116 int stat_name_width;
117 const char *word_regex;
118 enum diff_words_type word_diff;
120 /* this is set by diffcore for DIFF_FORMAT_PATCH */
121 int found_changes;
123 FILE *file;
124 int close_file;
126 int nr_paths;
127 const char **paths;
128 int *pathlens;
129 change_fn_t change;
130 add_remove_fn_t add_remove;
131 diff_format_fn_t format_callback;
132 void *format_callback_data;
135 enum color_diff {
136 DIFF_RESET = 0,
137 DIFF_PLAIN = 1,
138 DIFF_METAINFO = 2,
139 DIFF_FRAGINFO = 3,
140 DIFF_FILE_OLD = 4,
141 DIFF_FILE_NEW = 5,
142 DIFF_COMMIT = 6,
143 DIFF_WHITESPACE = 7,
144 DIFF_FUNCINFO = 8,
146 const char *diff_get_color(int diff_use_color, enum color_diff ix);
147 #define diff_get_color_opt(o, ix) \
148 diff_get_color(DIFF_OPT_TST((o), COLOR_DIFF), ix)
151 extern const char mime_boundary_leader[];
153 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
154 extern void diff_tree_release_paths(struct diff_options *);
155 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
156 const char *base, struct diff_options *opt);
157 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
158 const char *base, struct diff_options *opt);
159 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
160 struct diff_options *opt);
162 struct combine_diff_path {
163 struct combine_diff_path *next;
164 int len;
165 char *path;
166 unsigned int mode;
167 unsigned char sha1[20];
168 struct combine_diff_parent {
169 char status;
170 unsigned int mode;
171 unsigned char sha1[20];
172 } parent[FLEX_ARRAY];
174 #define combine_diff_path_size(n, l) \
175 (sizeof(struct combine_diff_path) + \
176 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
178 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
179 int dense, struct rev_info *);
181 extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);
183 extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);
185 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
187 extern void diff_addremove(struct diff_options *,
188 int addremove,
189 unsigned mode,
190 const unsigned char *sha1,
191 const char *fullpath, unsigned dirty_submodule);
193 extern void diff_change(struct diff_options *,
194 unsigned mode1, unsigned mode2,
195 const unsigned char *sha1,
196 const unsigned char *sha2,
197 const char *fullpath,
198 unsigned dirty_submodule1, unsigned dirty_submodule2);
200 extern void diff_unmerge(struct diff_options *,
201 const char *path,
202 unsigned mode,
203 const unsigned char *sha1);
205 #define DIFF_SETUP_REVERSE 1
206 #define DIFF_SETUP_USE_CACHE 2
207 #define DIFF_SETUP_USE_SIZE_CACHE 4
209 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
210 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
211 extern int diff_use_color_default;
212 extern void diff_setup(struct diff_options *);
213 extern int diff_opt_parse(struct diff_options *, const char **, int);
214 extern int diff_setup_done(struct diff_options *);
216 #define DIFF_DETECT_RENAME 1
217 #define DIFF_DETECT_COPY 2
219 #define DIFF_PICKAXE_ALL 1
220 #define DIFF_PICKAXE_REGEX 2
222 extern void diffcore_std(struct diff_options *);
223 extern void diffcore_fix_diff_index(struct diff_options *);
225 #define COMMON_DIFF_OPTIONS_HELP \
226 "\ncommon diff options:\n" \
227 " -z output diff-raw with lines terminated with NUL.\n" \
228 " -p output patch format.\n" \
229 " -u synonym for -p.\n" \
230 " --patch-with-raw\n" \
231 " output both a patch and the diff-raw format.\n" \
232 " --stat show diffstat instead of patch.\n" \
233 " --numstat show numeric diffstat instead of patch.\n" \
234 " --patch-with-stat\n" \
235 " output a patch and prepend its diffstat.\n" \
236 " --name-only show only names of changed files.\n" \
237 " --name-status show names and status of changed files.\n" \
238 " --full-index show full object name on index lines.\n" \
239 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
240 " -R swap input file pairs.\n" \
241 " -B detect complete rewrites.\n" \
242 " -M detect renames.\n" \
243 " -C detect copies.\n" \
244 " --find-copies-harder\n" \
245 " try unchanged files as candidate for copy detection.\n" \
246 " -l<n> limit rename attempts up to <n> paths.\n" \
247 " -O<file> reorder diffs according to the <file>.\n" \
248 " -S<string> find filepair whose only one side contains the string.\n" \
249 " --pickaxe-all\n" \
250 " show all files diff when -S is used and hit is found.\n" \
251 " -a --text treat all files as text.\n"
253 extern int diff_queue_is_empty(void);
254 extern void diff_flush(struct diff_options*);
256 /* diff-raw status letters */
257 #define DIFF_STATUS_ADDED 'A'
258 #define DIFF_STATUS_COPIED 'C'
259 #define DIFF_STATUS_DELETED 'D'
260 #define DIFF_STATUS_MODIFIED 'M'
261 #define DIFF_STATUS_RENAMED 'R'
262 #define DIFF_STATUS_TYPE_CHANGED 'T'
263 #define DIFF_STATUS_UNKNOWN 'X'
264 #define DIFF_STATUS_UNMERGED 'U'
266 /* these are not diff-raw status letters proper, but used by
267 * diffcore-filter insn to specify additional restrictions.
269 #define DIFF_STATUS_FILTER_AON '*'
270 #define DIFF_STATUS_FILTER_BROKEN 'B'
272 extern const char *diff_unique_abbrev(const unsigned char *, int);
274 /* do not report anything on removed paths */
275 #define DIFF_SILENT_ON_REMOVED 01
276 /* report racily-clean paths as modified */
277 #define DIFF_RACY_IS_MODIFIED 02
278 extern int run_diff_files(struct rev_info *revs, unsigned int option);
279 extern int run_diff_index(struct rev_info *revs, int cached);
281 extern int do_diff_cache(const unsigned char *, struct diff_options *);
282 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
284 extern int diff_result_code(struct diff_options *, int);
286 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
288 extern int index_differs_from(const char *def, int diff_flags);
290 #endif /* DIFF_H */