Update documentation for update hook.
[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                  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;
74
75         int stat_width;
76         int stat_name_width;
77
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;
85 };
86
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,
96 };
97 const char *diff_get_color(int diff_use_color, enum color_diff ix);
98
99 extern const char mime_boundary_leader[];
100
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);
109
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];
121 };
122 #define combine_diff_path_size(n, l) \
123         (sizeof(struct combine_diff_path) + \
124          sizeof(struct combine_diff_parent) * (n) + (l) + 1)
125
126 extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
127                               int dense, struct rev_info *);
128
129 extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);
130
131 extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);
132
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);
139
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);
145
146 extern void diff_unmerge(struct diff_options *,
147                          const char *path);
148
149 extern int diff_scoreopt_parse(const char *opt);
150
151 #define DIFF_SETUP_REVERSE              1
152 #define DIFF_SETUP_USE_CACHE            2
153 #define DIFF_SETUP_USE_SIZE_CACHE       4
154
155 extern int git_diff_ui_config(const char *var, const char *value);
156 extern void diff_setup(struct diff_options *);
157 extern int diff_opt_parse(struct diff_options *, const char **, int);
158 extern int diff_setup_done(struct diff_options *);
159
160 #define DIFF_DETECT_RENAME      1
161 #define DIFF_DETECT_COPY        2
162
163 #define DIFF_PICKAXE_ALL        1
164 #define DIFF_PICKAXE_REGEX      2
165
166 extern void diffcore_std(struct diff_options *);
167
168 extern void diffcore_std_no_resolve(struct diff_options *);
169
170 #define COMMON_DIFF_OPTIONS_HELP \
171 "\ncommon diff options:\n" \
172 "  -z            output diff-raw with lines terminated with NUL.\n" \
173 "  -p            output patch format.\n" \
174 "  -u            synonym for -p.\n" \
175 "  --patch-with-raw\n" \
176 "                output both a patch and the diff-raw format.\n" \
177 "  --stat        show diffstat instead of patch.\n" \
178 "  --numstat     show numeric diffstat instead of patch.\n" \
179 "  --patch-with-stat\n" \
180 "                output a patch and prepend its diffstat.\n" \
181 "  --name-only   show only names of changed files.\n" \
182 "  --name-status show names and status of changed files.\n" \
183 "  --full-index  show full object name on index lines.\n" \
184 "  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
185 "  -R            swap input file pairs.\n" \
186 "  -B            detect complete rewrites.\n" \
187 "  -M            detect renames.\n" \
188 "  -C            detect copies.\n" \
189 "  --find-copies-harder\n" \
190 "                try unchanged files as candidate for copy detection.\n" \
191 "  -l<n>         limit rename attempts up to <n> paths.\n" \
192 "  -O<file>      reorder diffs according to the <file>.\n" \
193 "  -S<string>    find filepair whose only one side contains the string.\n" \
194 "  --pickaxe-all\n" \
195 "                show all files diff when -S is used and hit is found.\n" \
196 "  -a  --text    treat all files as text.\n"
197
198 extern int diff_queue_is_empty(void);
199 extern void diff_flush(struct diff_options*);
200
201 /* diff-raw status letters */
202 #define DIFF_STATUS_ADDED               'A'
203 #define DIFF_STATUS_COPIED              'C'
204 #define DIFF_STATUS_DELETED             'D'
205 #define DIFF_STATUS_MODIFIED            'M'
206 #define DIFF_STATUS_RENAMED             'R'
207 #define DIFF_STATUS_TYPE_CHANGED        'T'
208 #define DIFF_STATUS_UNKNOWN             'X'
209 #define DIFF_STATUS_UNMERGED            'U'
210
211 /* these are not diff-raw status letters proper, but used by
212  * diffcore-filter insn to specify additional restrictions.
213  */
214 #define DIFF_STATUS_FILTER_AON          '*'
215 #define DIFF_STATUS_FILTER_BROKEN       'B'
216
217 extern const char *diff_unique_abbrev(const unsigned char *, int);
218
219 extern int run_diff_files(struct rev_info *revs, int silent_on_removed);
220
221 extern int run_diff_index(struct rev_info *revs, int cached);
222
223 extern int diff_flush_patch_id(struct diff_options *, unsigned char *);
224
225 #endif /* DIFF_H */