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