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