Basic documentation for git-show
[git/dscho.git] / diff.h
blob5c5e7fa91fc943e56759da556be733694184ee88
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 unsigned int mode;
70 unsigned char sha1[20];
71 } parent[FLEX_ARRAY];
73 #define combine_diff_path_size(n, l) \
74 (sizeof(struct combine_diff_path) + \
75 sizeof(struct combine_diff_parent) * (n) + (l) + 1)
77 int show_combined_diff(struct combine_diff_path *elem, int num_parent,
78 int dense, const char *header);
80 extern int diff_tree_combined_merge(const unsigned char *sha1, const char *, int);
82 extern void diff_addremove(struct diff_options *,
83 int addremove,
84 unsigned mode,
85 const unsigned char *sha1,
86 const char *base,
87 const char *path);
89 extern void diff_change(struct diff_options *,
90 unsigned mode1, unsigned mode2,
91 const unsigned char *sha1,
92 const unsigned char *sha2,
93 const char *base, const char *path);
95 extern void diff_unmerge(struct diff_options *,
96 const char *path);
98 extern int diff_scoreopt_parse(const char *opt);
100 #define DIFF_SETUP_REVERSE 1
101 #define DIFF_SETUP_USE_CACHE 2
102 #define DIFF_SETUP_USE_SIZE_CACHE 4
104 extern int git_diff_config(const char *var, const char *value);
105 extern void diff_setup(struct diff_options *);
106 extern int diff_opt_parse(struct diff_options *, const char **, int);
107 extern int diff_setup_done(struct diff_options *);
109 #define DIFF_DETECT_RENAME 1
110 #define DIFF_DETECT_COPY 2
112 #define DIFF_PICKAXE_ALL 1
114 extern void diffcore_std(struct diff_options *);
116 extern void diffcore_std_no_resolve(struct diff_options *);
118 #define COMMON_DIFF_OPTIONS_HELP \
119 "\ncommon diff options:\n" \
120 " -z output diff-raw with lines terminated with NUL.\n" \
121 " -p output patch format.\n" \
122 " -u synonym for -p.\n" \
123 " --name-only show only names of changed files.\n" \
124 " --name-status show names and status of changed files.\n" \
125 " --full-index show full object name on index lines.\n" \
126 " --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
127 " -R swap input file pairs.\n" \
128 " -B detect complete rewrites.\n" \
129 " -M detect renames.\n" \
130 " -C detect copies.\n" \
131 " --find-copies-harder\n" \
132 " try unchanged files as candidate for copy detection.\n" \
133 " -l<n> limit rename attempts up to <n> paths.\n" \
134 " -O<file> reorder diffs according to the <file>.\n" \
135 " -S<string> find filepair whose only one side contains the string.\n" \
136 " --pickaxe-all\n" \
137 " show all files diff when -S is used and hit is found.\n"
139 extern int diff_queue_is_empty(void);
141 #define DIFF_FORMAT_RAW 1
142 #define DIFF_FORMAT_PATCH 2
143 #define DIFF_FORMAT_NO_OUTPUT 3
144 #define DIFF_FORMAT_NAME 4
145 #define DIFF_FORMAT_NAME_STATUS 5
147 extern void diff_flush(struct diff_options*);
149 /* diff-raw status letters */
150 #define DIFF_STATUS_ADDED 'A'
151 #define DIFF_STATUS_COPIED 'C'
152 #define DIFF_STATUS_DELETED 'D'
153 #define DIFF_STATUS_MODIFIED 'M'
154 #define DIFF_STATUS_RENAMED 'R'
155 #define DIFF_STATUS_TYPE_CHANGED 'T'
156 #define DIFF_STATUS_UNKNOWN 'X'
157 #define DIFF_STATUS_UNMERGED 'U'
159 /* these are not diff-raw status letters proper, but used by
160 * diffcore-filter insn to specify additional restrictions.
162 #define DIFF_STATUS_FILTER_AON '*'
163 #define DIFF_STATUS_FILTER_BROKEN 'B'
165 extern const char *diff_unique_abbrev(const unsigned char *, int);
167 #endif /* DIFF_H */