Add new git-rm command with documentation
[alt-git.git] / diff.h
blob8fac465a9df9b1d8789d17f008968295baa27ad1
1 /*
2 * Copyright (C) 2005 Junio C Hamano
3 */
4 #ifndef DIFF_H
5 #define DIFF_H
7 #define DIFF_FILE_CANON_MODE(mode) \
8 (S_ISREG(mode) ? (S_IFREG | ce_permissions(mode)) : \
9 S_ISLNK(mode) ? S_IFLNK : S_IFDIR)
11 struct tree_desc {
12 void *buf;
13 unsigned long size;
16 extern void update_tree_entry(struct tree_desc *);
17 extern const unsigned char *tree_entry_extract(struct tree_desc *, const char **, unsigned int *);
19 struct diff_options;
21 typedef void (*change_fn_t)(struct diff_options *options,
22 unsigned old_mode, unsigned new_mode,
23 const unsigned char *old_sha1,
24 const unsigned char *new_sha1,
25 const char *base, const char *path);
27 typedef void (*add_remove_fn_t)(struct diff_options *options,
28 int addremove, unsigned mode,
29 const unsigned char *sha1,
30 const char *base, const char *path);
32 struct diff_options {
33 const char **paths;
34 const char *filter;
35 const char *orderfile;
36 const char *pickaxe;
37 unsigned recursive:1,
38 tree_in_recursive:1,
39 full_index:1;
40 int break_opt;
41 int detect_rename;
42 int find_copies_harder;
43 int line_termination;
44 int output_format;
45 int pickaxe_opts;
46 int rename_score;
47 int reverse_diff;
48 int rename_limit;
49 int setup;
50 int abbrev;
52 change_fn_t change;
53 add_remove_fn_t add_remove;
56 extern void diff_tree_setup_paths(const char **paths);
57 extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
58 const char *base, struct diff_options *opt);
59 extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
60 const char *base, struct diff_options *opt);
62 struct combine_diff_path {
63 struct combine_diff_path *next;
64 int len;
65 char *path;
66 unsigned int mode;
67 unsigned char sha1[20];
68 struct combine_diff_parent {
69 char status;
70 unsigned int mode;
71 unsigned char sha1[20];
72 } parent[FLEX_ARRAY];
74 #define combine_diff_path_size(n, l) \
75 (sizeof(struct combine_diff_path) + \
76 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
78 extern int show_combined_diff(struct combine_diff_path *elem, int num_parent,
79 int dense, const char *header,
80 struct diff_options *);
82 extern const char *diff_tree_combined_merge(const unsigned char *sha1, const char *, int, struct diff_options *opt);
84 extern void diff_addremove(struct diff_options *,
85 int addremove,
86 unsigned mode,
87 const unsigned char *sha1,
88 const char *base,
89 const char *path);
91 extern void diff_change(struct diff_options *,
92 unsigned mode1, unsigned mode2,
93 const unsigned char *sha1,
94 const unsigned char *sha2,
95 const char *base, const char *path);
97 extern void diff_unmerge(struct diff_options *,
98 const char *path);
100 extern int diff_scoreopt_parse(const char *opt);
102 #define DIFF_SETUP_REVERSE 1
103 #define DIFF_SETUP_USE_CACHE 2
104 #define DIFF_SETUP_USE_SIZE_CACHE 4
106 extern int git_diff_config(const char *var, const char *value);
107 extern void diff_setup(struct diff_options *);
108 extern int diff_opt_parse(struct diff_options *, const char **, int);
109 extern int diff_setup_done(struct diff_options *);
111 #define DIFF_DETECT_RENAME 1
112 #define DIFF_DETECT_COPY 2
114 #define DIFF_PICKAXE_ALL 1
116 extern void diffcore_std(struct diff_options *);
118 extern void diffcore_std_no_resolve(struct diff_options *);
120 #define COMMON_DIFF_OPTIONS_HELP \
121 "\ncommon diff options:\n" \
122 " -z output diff-raw with lines terminated with NUL.\n" \
123 " -p output patch format.\n" \
124 " -u synonym for -p.\n" \
125 " --name-only show only names of changed files.\n" \
126 " --name-status show names and status of changed files.\n" \
127 " --full-index show full object name on index lines.\n" \
128 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
129 " -R swap input file pairs.\n" \
130 " -B detect complete rewrites.\n" \
131 " -M detect renames.\n" \
132 " -C detect copies.\n" \
133 " --find-copies-harder\n" \
134 " try unchanged files as candidate for copy detection.\n" \
135 " -l<n> limit rename attempts up to <n> paths.\n" \
136 " -O<file> reorder diffs according to the <file>.\n" \
137 " -S<string> find filepair whose only one side contains the string.\n" \
138 " --pickaxe-all\n" \
139 " show all files diff when -S is used and hit is found.\n"
141 extern int diff_queue_is_empty(void);
143 #define DIFF_FORMAT_RAW 1
144 #define DIFF_FORMAT_PATCH 2
145 #define DIFF_FORMAT_NO_OUTPUT 3
146 #define DIFF_FORMAT_NAME 4
147 #define DIFF_FORMAT_NAME_STATUS 5
149 extern void diff_flush(struct diff_options*);
151 /* diff-raw status letters */
152 #define DIFF_STATUS_ADDED 'A'
153 #define DIFF_STATUS_COPIED 'C'
154 #define DIFF_STATUS_DELETED 'D'
155 #define DIFF_STATUS_MODIFIED 'M'
156 #define DIFF_STATUS_RENAMED 'R'
157 #define DIFF_STATUS_TYPE_CHANGED 'T'
158 #define DIFF_STATUS_UNKNOWN 'X'
159 #define DIFF_STATUS_UNMERGED 'U'
161 /* these are not diff-raw status letters proper, but used by
162 * diffcore-filter insn to specify additional restrictions.
164 #define DIFF_STATUS_FILTER_AON '*'
165 #define DIFF_STATUS_FILTER_BROKEN 'B'
167 extern const char *diff_unique_abbrev(const unsigned char *, int);
169 #endif /* DIFF_H */