hooks--update: fix test for properly set up project description file
[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 struct diff_options {
47         const char *filter;
48         const char *orderfile;
49         const char *pickaxe;
50         const char *single_follow;
51         unsigned recursive:1,
52                  tree_in_recursive:1,
53                  binary:1,
54                  text:1,
55                  full_index:1,
56                  silent_on_remove:1,
57                  find_copies_harder:1,
58                  follow_renames:1,
59                  color_diff:1,
60                  color_diff_words:1,
61                  has_changes:1,
62                  quiet:1,
63                  no_index:1,
64                  allow_external:1,
65                  exit_with_status:1;
66         int context;
67         int break_opt;
68         int detect_rename;
69         int skip_stat_unmatch;
70         int line_termination;
71         int output_format;
72         int pickaxe_opts;
73         int rename_score;
74         int reverse_diff;
75         int rename_limit;
76         int setup;
77         int abbrev;
78         const char *msg_sep;
79         const char *stat_sep;
80         long xdl_opts;
81
82         int stat_width;
83         int stat_name_width;
84
85         /* this is set by diffcore for DIFF_FORMAT_PATCH */
86         int found_changes;
87
88         int nr_paths;
89         const char **paths;
90         int *pathlens;
91         change_fn_t change;
92         add_remove_fn_t add_remove;
93         diff_format_fn_t format_callback;
94         void *format_callback_data;
95 };
96
97 enum color_diff {
98         DIFF_RESET = 0,
99         DIFF_PLAIN = 1,
100         DIFF_METAINFO = 2,
101         DIFF_FRAGINFO = 3,
102         DIFF_FILE_OLD = 4,
103         DIFF_FILE_NEW = 5,
104         DIFF_COMMIT = 6,
105         DIFF_WHITESPACE = 7,
106 };
107 const char *diff_get_color(int diff_use_color, enum color_diff ix);
108
109 extern const char mime_boundary_leader[];
110
111 extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
112 extern void diff_tree_release_paths(struct diff_options *);
113 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
114                      const char *base, struct diff_options *opt);
115 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
116                           const char *base, struct diff_options *opt);
117 extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
118                                struct diff_options *opt);
119
120 struct combine_diff_path {
121         struct combine_diff_path *next;
122         int len;
123         char *path;
124         unsigned int mode;
125         unsigned char sha1[20];
126         struct combine_diff_parent {
127                 char status;
128                 unsigned int mode;
129                 unsigned char sha1[20];
130         } parent[FLEX_ARRAY];
131 };
132 #define combine_diff_path_size(n, l) \
133         (sizeof(struct combine_diff_path) + \
134          sizeof(struct combine_diff_parent) * (n) + (l) + 1)
135
136 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
137                               int dense, struct rev_info *);
138
139 extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);
140
141 extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);
142
143 extern void diff_addremove(struct diff_options *,
144                            int addremove,
145                            unsigned mode,
146                            const unsigned char *sha1,
147                            const char *base,
148                            const char *path);
149
150 extern void diff_change(struct diff_options *,
151                         unsigned mode1, unsigned mode2,
152                         const unsigned char *sha1,
153                         const unsigned char *sha2,
154                         const char *base, const char *path);
155
156 extern void diff_unmerge(struct diff_options *,
157                          const char *path,
158                          unsigned mode,
159                          const unsigned char *sha1);
160
161 #define DIFF_SETUP_REVERSE              1
162 #define DIFF_SETUP_USE_CACHE            2
163 #define DIFF_SETUP_USE_SIZE_CACHE       4
164
165 extern int git_diff_ui_config(const char *var, const char *value);
166 extern void diff_setup(struct diff_options *);
167 extern int diff_opt_parse(struct diff_options *, const char **, int);
168 extern int diff_setup_done(struct diff_options *);
169
170 #define DIFF_DETECT_RENAME      1
171 #define DIFF_DETECT_COPY        2
172
173 #define DIFF_PICKAXE_ALL        1
174 #define DIFF_PICKAXE_REGEX      2
175
176 extern void diffcore_std(struct diff_options *);
177
178 #define COMMON_DIFF_OPTIONS_HELP \
179 "\ncommon diff options:\n" \
180 "  -z            output diff-raw with lines terminated with NUL.\n" \
181 "  -p            output patch format.\n" \
182 "  -u            synonym for -p.\n" \
183 "  --patch-with-raw\n" \
184 "                output both a patch and the diff-raw format.\n" \
185 "  --stat        show diffstat instead of patch.\n" \
186 "  --numstat     show numeric diffstat instead of patch.\n" \
187 "  --patch-with-stat\n" \
188 "                output a patch and prepend its diffstat.\n" \
189 "  --name-only   show only names of changed files.\n" \
190 "  --name-status show names and status of changed files.\n" \
191 "  --full-index  show full object name on index lines.\n" \
192 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
193 "  -R            swap input file pairs.\n" \
194 "  -B            detect complete rewrites.\n" \
195 "  -M            detect renames.\n" \
196 "  -C            detect copies.\n" \
197 "  --find-copies-harder\n" \
198 "                try unchanged files as candidate for copy detection.\n" \
199 "  -l<n>         limit rename attempts up to <n> paths.\n" \
200 "  -O<file>      reorder diffs according to the <file>.\n" \
201 "  -S<string>    find filepair whose only one side contains the string.\n" \
202 "  --pickaxe-all\n" \
203 "                show all files diff when -S is used and hit is found.\n" \
204 "  -a  --text    treat all files as text.\n"
205
206 extern int diff_queue_is_empty(void);
207 extern void diff_flush(struct diff_options*);
208
209 /* diff-raw status letters */
210 #define DIFF_STATUS_ADDED               'A'
211 #define DIFF_STATUS_COPIED              'C'
212 #define DIFF_STATUS_DELETED             'D'
213 #define DIFF_STATUS_MODIFIED            'M'
214 #define DIFF_STATUS_RENAMED             'R'
215 #define DIFF_STATUS_TYPE_CHANGED        'T'
216 #define DIFF_STATUS_UNKNOWN             'X'
217 #define DIFF_STATUS_UNMERGED            'U'
218
219 /* these are not diff-raw status letters proper, but used by
220  * diffcore-filter insn to specify additional restrictions.
221  */
222 #define DIFF_STATUS_FILTER_AON          '*'
223 #define DIFF_STATUS_FILTER_BROKEN       'B'
224
225 extern const char *diff_unique_abbrev(const unsigned char *, int);
226
227 extern int run_diff_files(struct rev_info *revs, int silent_on_removed);
228 extern int setup_diff_no_index(struct rev_info *revs,
229                 int argc, const char ** argv, int nongit, const char *prefix);
230 extern int run_diff_files_cmd(struct rev_info *revs, int argc, const char **argv);
231
232 extern int run_diff_index(struct rev_info *revs, int cached);
233
234 extern int do_diff_cache(const unsigned char *, struct diff_options *);
235 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
236
237 #endif /* DIFF_H */