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