Documentation: mention branches rather than heads
[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_QUIET               (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_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
70 #define DIFF_OPT_SET(opts, flag)    ((opts)->flags |= DIFF_OPT_##flag)
71 #define DIFF_OPT_CLR(opts, flag)    ((opts)->flags &= ~DIFF_OPT_##flag)
72
73 struct diff_options {
74         const char *filter;
75         const char *orderfile;
76         const char *pickaxe;
77         const char *single_follow;
78         const char *a_prefix, *b_prefix;
79         unsigned flags;
80         int context;
81         int break_opt;
82         int detect_rename;
83         int skip_stat_unmatch;
84         int line_termination;
85         int output_format;
86         int pickaxe_opts;
87         int rename_score;
88         int rename_limit;
89         int warn_on_too_large_rename;
90         int dirstat_percent;
91         int setup;
92         int abbrev;
93         const char *prefix;
94         int prefix_length;
95         const char *stat_sep;
96         long xdl_opts;
97
98         int stat_width;
99         int stat_name_width;
100
101         /* this is set by diffcore for DIFF_FORMAT_PATCH */
102         int found_changes;
103
104         FILE *file;
105         int close_file;
106
107         int nr_paths;
108         const char **paths;
109         int *pathlens;
110         change_fn_t change;
111         add_remove_fn_t add_remove;
112         diff_format_fn_t format_callback;
113         void *format_callback_data;
114 };
115
116 enum color_diff {
117         DIFF_RESET = 0,
118         DIFF_PLAIN = 1,
119         DIFF_METAINFO = 2,
120         DIFF_FRAGINFO = 3,
121         DIFF_FILE_OLD = 4,
122         DIFF_FILE_NEW = 5,
123         DIFF_COMMIT = 6,
124         DIFF_WHITESPACE = 7,
125 };
126 const char *diff_get_color(int diff_use_color, enum color_diff ix);
127 #define diff_get_color_opt(o, ix) \
128         diff_get_color(DIFF_OPT_TST((o), COLOR_DIFF), ix)
129
130
131 extern const char mime_boundary_leader[];
132
133 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
134 extern void diff_tree_release_paths(struct diff_options *);
135 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
136                      const char *base, struct diff_options *opt);
137 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
138                           const char *base, struct diff_options *opt);
139 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
140                                struct diff_options *opt);
141
142 struct combine_diff_path {
143         struct combine_diff_path *next;
144         int len;
145         char *path;
146         unsigned int mode;
147         unsigned char sha1[20];
148         struct combine_diff_parent {
149                 char status;
150                 unsigned int mode;
151                 unsigned char sha1[20];
152         } parent[FLEX_ARRAY];
153 };
154 #define combine_diff_path_size(n, l) \
155         (sizeof(struct combine_diff_path) + \
156          sizeof(struct combine_diff_parent) * (n) + (l) + 1)
157
158 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
159                               int dense, struct rev_info *);
160
161 extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);
162
163 extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);
164
165 void diff_set_mnemonic_prefix(struct diff_options *options, const char *a, const char *b);
166
167 extern void diff_addremove(struct diff_options *,
168                            int addremove,
169                            unsigned mode,
170                            const unsigned char *sha1,
171                            const char *fullpath);
172
173 extern void diff_change(struct diff_options *,
174                         unsigned mode1, unsigned mode2,
175                         const unsigned char *sha1,
176                         const unsigned char *sha2,
177                         const char *fullpath);
178
179 extern void diff_unmerge(struct diff_options *,
180                          const char *path,
181                          unsigned mode,
182                          const unsigned char *sha1);
183
184 #define DIFF_SETUP_REVERSE              1
185 #define DIFF_SETUP_USE_CACHE            2
186 #define DIFF_SETUP_USE_SIZE_CACHE       4
187
188 extern int git_diff_basic_config(const char *var, const char *value, void *cb);
189 extern int git_diff_ui_config(const char *var, const char *value, void *cb);
190 extern int diff_use_color_default;
191 extern void diff_setup(struct diff_options *);
192 extern int diff_opt_parse(struct diff_options *, const char **, int);
193 extern int diff_setup_done(struct diff_options *);
194
195 #define DIFF_DETECT_RENAME      1
196 #define DIFF_DETECT_COPY        2
197
198 #define DIFF_PICKAXE_ALL        1
199 #define DIFF_PICKAXE_REGEX      2
200
201 extern void diffcore_std(struct diff_options *);
202
203 #define COMMON_DIFF_OPTIONS_HELP \
204 "\ncommon diff options:\n" \
205 "  -z            output diff-raw with lines terminated with NUL.\n" \
206 "  -p            output patch format.\n" \
207 "  -u            synonym for -p.\n" \
208 "  --patch-with-raw\n" \
209 "                output both a patch and the diff-raw format.\n" \
210 "  --stat        show diffstat instead of patch.\n" \
211 "  --numstat     show numeric diffstat instead of patch.\n" \
212 "  --patch-with-stat\n" \
213 "                output a patch and prepend its diffstat.\n" \
214 "  --name-only   show only names of changed files.\n" \
215 "  --name-status show names and status of changed files.\n" \
216 "  --full-index  show full object name on index lines.\n" \
217 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
218 "  -R            swap input file pairs.\n" \
219 "  -B            detect complete rewrites.\n" \
220 "  -M            detect renames.\n" \
221 "  -C            detect copies.\n" \
222 "  --find-copies-harder\n" \
223 "                try unchanged files as candidate for copy detection.\n" \
224 "  -l<n>         limit rename attempts up to <n> paths.\n" \
225 "  -O<file>      reorder diffs according to the <file>.\n" \
226 "  -S<string>    find filepair whose only one side contains the string.\n" \
227 "  --pickaxe-all\n" \
228 "                show all files diff when -S is used and hit is found.\n" \
229 "  -a  --text    treat all files as text.\n"
230
231 extern int diff_queue_is_empty(void);
232 extern void diff_flush(struct diff_options*);
233
234 /* diff-raw status letters */
235 #define DIFF_STATUS_ADDED               'A'
236 #define DIFF_STATUS_COPIED              'C'
237 #define DIFF_STATUS_DELETED             'D'
238 #define DIFF_STATUS_MODIFIED            'M'
239 #define DIFF_STATUS_RENAMED             'R'
240 #define DIFF_STATUS_TYPE_CHANGED        'T'
241 #define DIFF_STATUS_UNKNOWN             'X'
242 #define DIFF_STATUS_UNMERGED            'U'
243
244 /* these are not diff-raw status letters proper, but used by
245  * diffcore-filter insn to specify additional restrictions.
246  */
247 #define DIFF_STATUS_FILTER_AON          '*'
248 #define DIFF_STATUS_FILTER_BROKEN       'B'
249
250 extern const char *diff_unique_abbrev(const unsigned char *, int);
251
252 /* do not report anything on removed paths */
253 #define DIFF_SILENT_ON_REMOVED 01
254 /* report racily-clean paths as modified */
255 #define DIFF_RACY_IS_MODIFIED 02
256 extern int run_diff_files(struct rev_info *revs, unsigned int option);
257 extern int run_diff_index(struct rev_info *revs, int cached);
258
259 extern int do_diff_cache(const unsigned char *, struct diff_options *);
260 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
261
262 extern int diff_result_code(struct diff_options *, int);
263
264 extern void diff_no_index(struct rev_info *, int, const char **, int, const char *);
265
266 #endif /* DIFF_H */