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