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