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