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