[thirdparty/git.git] / diff.h

/*
 * Copyright (C) 2005 Junio C Hamano
 */
#ifndef DIFF_H
#define DIFF_H

#include "tree-walk.h"

struct rev_info;
struct diff_options;
struct diff_queue_struct;

typedef void (*change_fn_t)(struct diff_options *options,
		 unsigned old_mode, unsigned new_mode,
		 const unsigned char *old_sha1,
		 const unsigned char *new_sha1,
		 const char *base, const char *path);

typedef void (*add_remove_fn_t)(struct diff_options *options,
		    int addremove, unsigned mode,
		    const unsigned char *sha1,
		    const char *base, const char *path);

typedef void (*diff_format_fn_t)(struct diff_queue_struct *q,
		struct diff_options *options, void *data);

#define DIFF_FORMAT_RAW		0x0001
#define DIFF_FORMAT_DIFFSTAT	0x0002
#define DIFF_FORMAT_NUMSTAT	0x0004
#define DIFF_FORMAT_SUMMARY	0x0008
#define DIFF_FORMAT_PATCH	0x0010
#define DIFF_FORMAT_SHORTSTAT	0x0020
#define DIFF_FORMAT_DIRSTAT	0x0040
#define DIFF_FORMAT_CUMULATIVE	0x0080

/* These override all above */
#define DIFF_FORMAT_NAME	0x0100
#define DIFF_FORMAT_NAME_STATUS	0x0200
#define DIFF_FORMAT_CHECKDIFF	0x0400

/* Same as output_format = 0 but we know that -s flag was given
 * and we should not give default value to output_format.
 */
#define DIFF_FORMAT_NO_OUTPUT	0x0800

#define DIFF_FORMAT_CALLBACK	0x1000

#define DIFF_OPT_RECURSIVE           (1 <<  0)
#define DIFF_OPT_TREE_IN_RECURSIVE   (1 <<  1)
#define DIFF_OPT_BINARY              (1 <<  2)
#define DIFF_OPT_TEXT                (1 <<  3)
#define DIFF_OPT_FULL_INDEX          (1 <<  4)
#define DIFF_OPT_SILENT_ON_REMOVE    (1 <<  5)
#define DIFF_OPT_FIND_COPIES_HARDER  (1 <<  6)
#define DIFF_OPT_FOLLOW_RENAMES      (1 <<  7)
#define DIFF_OPT_COLOR_DIFF          (1 <<  8)
#define DIFF_OPT_COLOR_DIFF_WORDS    (1 <<  9)
#define DIFF_OPT_HAS_CHANGES         (1 << 10)
#define DIFF_OPT_QUIET               (1 << 11)
#define DIFF_OPT_NO_INDEX            (1 << 12)
#define DIFF_OPT_ALLOW_EXTERNAL      (1 << 13)
#define DIFF_OPT_EXIT_WITH_STATUS    (1 << 14)
#define DIFF_OPT_REVERSE_DIFF        (1 << 15)
#define DIFF_OPT_CHECK_FAILED        (1 << 16)
#define DIFF_OPT_RELATIVE_NAME       (1 << 17)
#define DIFF_OPT_TST(opts, flag)    ((opts)->flags & DIFF_OPT_##flag)
#define DIFF_OPT_SET(opts, flag)    ((opts)->flags |= DIFF_OPT_##flag)
#define DIFF_OPT_CLR(opts, flag)    ((opts)->flags &= ~DIFF_OPT_##flag)

struct diff_options {
	const char *filter;
	const char *orderfile;
	const char *pickaxe;
	const char *single_follow;
	const char *a_prefix, *b_prefix;
	unsigned flags;
	int context;
	int break_opt;
	int detect_rename;
	int skip_stat_unmatch;
	int line_termination;
	int output_format;
	int pickaxe_opts;
	int rename_score;
	int rename_limit;
	int warn_on_too_large_rename;
	int dirstat_percent;
	int setup;
	int abbrev;
	const char *prefix;
	int prefix_length;
	const char *stat_sep;
	long xdl_opts;

	int stat_width;
	int stat_name_width;

	/* this is set by diffcore for DIFF_FORMAT_PATCH */
	int found_changes;

	FILE *file;
	int close_file;

	int nr_paths;
	const char **paths;
	int *pathlens;
	change_fn_t change;
	add_remove_fn_t add_remove;
	diff_format_fn_t format_callback;
	void *format_callback_data;
};

enum color_diff {
	DIFF_RESET = 0,
	DIFF_PLAIN = 1,
	DIFF_METAINFO = 2,
	DIFF_FRAGINFO = 3,
	DIFF_FILE_OLD = 4,
	DIFF_FILE_NEW = 5,
	DIFF_COMMIT = 6,
	DIFF_WHITESPACE = 7,
};
const char *diff_get_color(int diff_use_color, enum color_diff ix);
#define diff_get_color_opt(o, ix) \
	diff_get_color(DIFF_OPT_TST((o), COLOR_DIFF), ix)


extern const char mime_boundary_leader[];

extern void diff_tree_setup_paths(const char **paths, struct diff_options *);
extern void diff_tree_release_paths(struct diff_options *);
extern int diff_tree(struct tree_desc *t1, struct tree_desc *t2,
		     const char *base, struct diff_options *opt);
extern int diff_tree_sha1(const unsigned char *old, const unsigned char *new,
			  const char *base, struct diff_options *opt);
extern int diff_root_tree_sha1(const unsigned char *new, const char *base,
                               struct diff_options *opt);

struct combine_diff_path {
	struct combine_diff_path *next;
	int len;
	char *path;
	unsigned int mode;
	unsigned char sha1[20];
	struct combine_diff_parent {
		char status;
		unsigned int mode;
		unsigned char sha1[20];
	} parent[FLEX_ARRAY];
};
#define combine_diff_path_size(n, l) \
	(sizeof(struct combine_diff_path) + \
	 sizeof(struct combine_diff_parent) * (n) + (l) + 1)

extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
			      int dense, struct rev_info *);

extern void diff_tree_combined(const unsigned char *sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info *rev);

extern void diff_tree_combined_merge(const unsigned char *sha1, int, struct rev_info *);

extern void diff_addremove(struct diff_options *,
			   int addremove,
			   unsigned mode,
			   const unsigned char *sha1,
			   const char *base,
			   const char *path);

extern void diff_change(struct diff_options *,
			unsigned mode1, unsigned mode2,
			const unsigned char *sha1,
			const unsigned char *sha2,
			const char *base, const char *path);

extern void diff_unmerge(struct diff_options *,
			 const char *path,
			 unsigned mode,
			 const unsigned char *sha1);

#define DIFF_SETUP_REVERSE      	1
#define DIFF_SETUP_USE_CACHE		2
#define DIFF_SETUP_USE_SIZE_CACHE	4

extern int git_diff_basic_config(const char *var, const char *value);
extern int git_diff_ui_config(const char *var, const char *value);
extern int diff_use_color_default;
extern void diff_setup(struct diff_options *);
extern int diff_opt_parse(struct diff_options *, const char **, int);
extern int diff_setup_done(struct diff_options *);

#define DIFF_DETECT_RENAME	1
#define DIFF_DETECT_COPY	2

#define DIFF_PICKAXE_ALL	1
#define DIFF_PICKAXE_REGEX	2

extern void diffcore_std(struct diff_options *);

#define COMMON_DIFF_OPTIONS_HELP \
"\ncommon diff options:\n" \
"  -z            output diff-raw with lines terminated with NUL.\n" \
"  -p            output patch format.\n" \
"  -u            synonym for -p.\n" \
"  --patch-with-raw\n" \
"                output both a patch and the diff-raw format.\n" \
"  --stat        show diffstat instead of patch.\n" \
"  --numstat     show numeric diffstat instead of patch.\n" \
"  --patch-with-stat\n" \
"                output a patch and prepend its diffstat.\n" \
"  --name-only   show only names of changed files.\n" \
"  --name-status show names and status of changed files.\n" \
"  --full-index  show full object name on index lines.\n" \
"  --abbrev=<n>  abbreviate object names in diff-tree header and diff-raw.\n" \
"  -R            swap input file pairs.\n" \
"  -B            detect complete rewrites.\n" \
"  -M            detect renames.\n" \
"  -C            detect copies.\n" \
"  --find-copies-harder\n" \
"                try unchanged files as candidate for copy detection.\n" \
"  -l<n>         limit rename attempts up to <n> paths.\n" \
"  -O<file>      reorder diffs according to the <file>.\n" \
"  -S<string>    find filepair whose only one side contains the string.\n" \
"  --pickaxe-all\n" \
"                show all files diff when -S is used and hit is found.\n" \
"  -a  --text    treat all files as text.\n"

extern int diff_queue_is_empty(void);
extern void diff_flush(struct diff_options*);

/* diff-raw status letters */
#define DIFF_STATUS_ADDED		'A'
#define DIFF_STATUS_COPIED		'C'
#define DIFF_STATUS_DELETED		'D'
#define DIFF_STATUS_MODIFIED		'M'
#define DIFF_STATUS_RENAMED		'R'
#define DIFF_STATUS_TYPE_CHANGED	'T'
#define DIFF_STATUS_UNKNOWN		'X'
#define DIFF_STATUS_UNMERGED		'U'

/* these are not diff-raw status letters proper, but used by
 * diffcore-filter insn to specify additional restrictions.
 */
#define DIFF_STATUS_FILTER_AON		'*'
#define DIFF_STATUS_FILTER_BROKEN	'B'

extern const char *diff_unique_abbrev(const unsigned char *, int);

/* do not report anything on removed paths */
#define DIFF_SILENT_ON_REMOVED 01
/* report racily-clean paths as modified */
#define DIFF_RACY_IS_MODIFIED 02
extern int run_diff_files(struct rev_info *revs, unsigned int option);
extern int setup_diff_no_index(struct rev_info *revs,
		int argc, const char ** argv, int nongit, const char *prefix);
extern int run_diff_files_cmd(struct rev_info *revs, int argc, const char **argv);

extern int run_diff_index(struct rev_info *revs, int cached);

extern int do_diff_cache(const unsigned char *, struct diff_options *);
extern int diff_flush_patch_id(struct diff_options *, unsigned char *);

extern int diff_result_code(struct diff_options *, int);

#endif /* DIFF_H */
Commit	Line	Data
be3cfa85 JH	1	/*
	2	* Copyright (C) 2005 Junio C Hamano
	3	*/
86436c28 JH	4	#ifndef DIFF_H
	5	#define DIFF_H
	6
1b0c7174	7	#include "tree-walk.h"
50f9a858	8
91539833	9	struct rev_info;
ac1b3d12	10	struct diff_options;
04245581	11	struct diff_queue_struct;
ac1b3d12 LT	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
04245581 JK	24	typedef void (diff_format_fn_t)(struct diff_queue_struct q,
	25	struct diff_options options, void data);
	26
c6744349 TH	27	#define DIFF_FORMAT_RAW 0x0001
c6744349 TH	28	#define DIFF_FORMAT_DIFFSTAT 0x0002
74e2abe5 JH	29	#define DIFF_FORMAT_NUMSTAT 0x0004
	30	#define DIFF_FORMAT_SUMMARY 0x0008
	31	#define DIFF_FORMAT_PATCH 0x0010
ebd124c6	32	#define DIFF_FORMAT_SHORTSTAT 0x0020
7df7c019 LT	33	#define DIFF_FORMAT_DIRSTAT 0x0040
7df7c019 LT	34	#define DIFF_FORMAT_CUMULATIVE 0x0080
c6744349 TH	35
c6744349 TH	36	/* These override all above */
74e2abe5 JH	37	#define DIFF_FORMAT_NAME 0x0100
	38	#define DIFF_FORMAT_NAME_STATUS 0x0200
	39	#define DIFF_FORMAT_CHECKDIFF 0x0400
c6744349 TH	40
	41	/* Same as output_format = 0 but we know that -s flag was given
	42	* and we should not give default value to output_format.
	43	*/
74e2abe5	44	#define DIFF_FORMAT_NO_OUTPUT 0x0800
c6744349	45
74e2abe5	46	#define DIFF_FORMAT_CALLBACK 0x1000
04245581	47
8f67f8ae PH	48	#define DIFF_OPT_RECURSIVE (1 << 0)
	49	#define DIFF_OPT_TREE_IN_RECURSIVE (1 << 1)
	50	#define DIFF_OPT_BINARY (1 << 2)
	51	#define DIFF_OPT_TEXT (1 << 3)
	52	#define DIFF_OPT_FULL_INDEX (1 << 4)
	53	#define DIFF_OPT_SILENT_ON_REMOVE (1 << 5)
	54	#define DIFF_OPT_FIND_COPIES_HARDER (1 << 6)
	55	#define DIFF_OPT_FOLLOW_RENAMES (1 << 7)
	56	#define DIFF_OPT_COLOR_DIFF (1 << 8)
	57	#define DIFF_OPT_COLOR_DIFF_WORDS (1 << 9)
	58	#define DIFF_OPT_HAS_CHANGES (1 << 10)
	59	#define DIFF_OPT_QUIET (1 << 11)
	60	#define DIFF_OPT_NO_INDEX (1 << 12)
	61	#define DIFF_OPT_ALLOW_EXTERNAL (1 << 13)
	62	#define DIFF_OPT_EXIT_WITH_STATUS (1 << 14)
	63	#define DIFF_OPT_REVERSE_DIFF (1 << 15)
62c64895	64	#define DIFF_OPT_CHECK_FAILED (1 << 16)
cd676a51	65	#define DIFF_OPT_RELATIVE_NAME (1 << 17)
8f67f8ae PH	66	#define DIFF_OPT_TST(opts, flag) ((opts)->flags & DIFF_OPT_##flag)
	67	#define DIFF_OPT_SET(opts, flag) ((opts)->flags \|= DIFF_OPT_##flag)
	68	#define DIFF_OPT_CLR(opts, flag) ((opts)->flags &= ~DIFF_OPT_##flag)
	69
6b5ee137	70	struct diff_options {
6b5ee137 JH	71	const char *filter;
	72	const char *orderfile;
	73	const char *pickaxe;
2f3f8b21	74	const char *single_follow;
eab9a40b	75	const char a_prefix, b_prefix;
8f67f8ae	76	unsigned flags;
ee1e5412	77	int context;
6b5ee137 JH	78	int break_opt;
6b5ee137 JH	79	int detect_rename;
fb13227e	80	int skip_stat_unmatch;
6b5ee137 JH	81	int line_termination;
	82	int output_format;
	83	int pickaxe_opts;
	84	int rename_score;
8082d8d3	85	int rename_limit;
b8960bbe	86	int warn_on_too_large_rename;
7df7c019	87	int dirstat_percent;
6b5ee137	88	int setup;
47dd0d59	89	int abbrev;
cd676a51 JH	90	const char *prefix;
cd676a51 JH	91	int prefix_length;
698ce6f8	92	const char *stat_sep;
0d21efa5	93	long xdl_opts;
ac1b3d12	94
a2540023 JH	95	int stat_width;
	96	int stat_name_width;
	97
34a5e1a2 JS	98	/* this is set by diffcore for DIFF_FORMAT_PATCH */
	99	int found_changes;
	100
c0c77734 DB	101	FILE *file;
	102	int close_file;
	103
a8baa7b9 JH	104	int nr_paths;
	105	const char **paths;
	106	int *pathlens;
ac1b3d12 LT	107	change_fn_t change;
ac1b3d12 LT	108	add_remove_fn_t add_remove;
04245581 JK	109	diff_format_fn_t format_callback;
04245581 JK	110	void *format_callback_data;
6b5ee137 JH	111	};
6b5ee137 JH	112
ce436973 JK	113	enum color_diff {
	114	DIFF_RESET = 0,
	115	DIFF_PLAIN = 1,
	116	DIFF_METAINFO = 2,
	117	DIFF_FRAGINFO = 3,
	118	DIFF_FILE_OLD = 4,
	119	DIFF_FILE_NEW = 5,
	120	DIFF_COMMIT = 6,
448c3ef1	121	DIFF_WHITESPACE = 7,
ce436973 JK	122	};
ce436973 JK	123	const char *diff_get_color(int diff_use_color, enum color_diff ix);
8f67f8ae PH	124	#define diff_get_color_opt(o, ix) \
	125	diff_get_color(DIFF_OPT_TST((o), COLOR_DIFF), ix)
	126
ce436973	127
698ce6f8 JS	128	extern const char mime_boundary_leader[];
698ce6f8 JS	129
a8baa7b9 JH	130	extern void diff_tree_setup_paths(const char *paths, struct diff_options );
a8baa7b9 JH	131	extern void diff_tree_release_paths(struct diff_options *);
ac1b3d12 LT	132	extern int diff_tree(struct tree_desc t1, struct tree_desc t2,
	133	const char base, struct diff_options opt);
	134	extern int diff_tree_sha1(const unsigned char old, const unsigned char new,
	135	const char base, struct diff_options opt);
2b60356d RS	136	extern int diff_root_tree_sha1(const unsigned char new, const char base,
2b60356d RS	137	struct diff_options *opt);
ac1b3d12	138
ea726d02 JH	139	struct combine_diff_path {
	140	struct combine_diff_path *next;
	141	int len;
	142	char *path;
2454c962	143	unsigned int mode;
ea726d02	144	unsigned char sha1[20];
2454c962	145	struct combine_diff_parent {
d416df88	146	char status;
2454c962 JH	147	unsigned int mode;
	148	unsigned char sha1[20];
	149	} parent[FLEX_ARRAY];
ea726d02	150	};
2454c962 JH	151	#define combine_diff_path_size(n, l) \
	152	(sizeof(struct combine_diff_path) + \
	153	sizeof(struct combine_diff_parent) * (n) + (l) + 1)
ea726d02	154
91539833 LT	155	extern void show_combined_diff(struct combine_diff_path *elem, int num_parent,
91539833 LT	156	int dense, struct rev_info *);
ea726d02	157
0fe7c1de JH	158	extern void diff_tree_combined(const unsigned char sha1, const unsigned char parent[][20], int num_parent, int dense, struct rev_info rev);
0fe7c1de JH	159
91539833	160	extern void diff_tree_combined_merge(const unsigned char sha1, int, struct rev_info );
af3feefa	161
6b5ee137 JH	162	extern void diff_addremove(struct diff_options *,
6b5ee137 JH	163	int addremove,
77eb2720 JH	164	unsigned mode,
	165	const unsigned char *sha1,
	166	const char *base,
	167	const char *path);
	168
6b5ee137 JH	169	extern void diff_change(struct diff_options *,
	170	unsigned mode1, unsigned mode2,
	171	const unsigned char *sha1,
	172	const unsigned char *sha2,
	173	const char base, const char path);
77eb2720	174
6b5ee137	175	extern void diff_unmerge(struct diff_options *,
e9c84099 JH	176	const char *path,
	177	unsigned mode,
	178	const unsigned char *sha1);
77eb2720	179
19feebc8	180	#define DIFF_SETUP_REVERSE 1
f0c6b2a2 JH	181	#define DIFF_SETUP_USE_CACHE 2
f0c6b2a2 JH	182	#define DIFF_SETUP_USE_SIZE_CACHE 4
ce240675	183
9a1805a8	184	extern int git_diff_basic_config(const char var, const char value);
83ad63cf	185	extern int git_diff_ui_config(const char var, const char value);
6b2f2d98	186	extern int diff_use_color_default;
6b5ee137 JH	187	extern void diff_setup(struct diff_options *);
	188	extern int diff_opt_parse(struct diff_options , const char *, int);
	189	extern int diff_setup_done(struct diff_options *);
86436c28	190
6b14d7fa JH	191	#define DIFF_DETECT_RENAME 1
	192	#define DIFF_DETECT_COPY 2
	193
367cec1c	194	#define DIFF_PICKAXE_ALL 1
d01d8c67	195	#define DIFF_PICKAXE_REGEX 2
f345b0a0	196
6b5ee137	197	extern void diffcore_std(struct diff_options *);
f2ce9fde	198
dda2d79a JH	199	#define COMMON_DIFF_OPTIONS_HELP \
dda2d79a JH	200	"\ncommon diff options:\n" \
8082d8d3 JH	201	" -z output diff-raw with lines terminated with NUL.\n" \
	202	" -p output patch format.\n" \
	203	" -u synonym for -p.\n" \
5c91da25 PB	204	" --patch-with-raw\n" \
5c91da25 PB	205	" output both a patch and the diff-raw format.\n" \
d75f7952	206	" --stat show diffstat instead of patch.\n" \
74e2abe5	207	" --numstat show numeric diffstat instead of patch.\n" \
29353273 JS	208	" --patch-with-stat\n" \
29353273 JS	209	" output a patch and prepend its diffstat.\n" \
8082d8d3	210	" --name-only show only names of changed files.\n" \
946f5f7c	211	" --name-status show names and status of changed files.\n" \
47dd0d59	212	" --full-index show full object name on index lines.\n" \
913419fc	213	" --abbrev=<n> abbreviate object names in diff-tree header and diff-raw.\n" \
8082d8d3 JH	214	" -R swap input file pairs.\n" \
	215	" -B detect complete rewrites.\n" \
	216	" -M detect renames.\n" \
	217	" -C detect copies.\n" \
dda2d79a	218	" --find-copies-harder\n" \
8082d8d3 JH	219	" try unchanged files as candidate for copy detection.\n" \
	220	" -l<n> limit rename attempts up to <n> paths.\n" \
	221	" -O<file> reorder diffs according to the <file>.\n" \
	222	" -S<string> find filepair whose only one side contains the string.\n" \
dda2d79a	223	" --pickaxe-all\n" \
ca49920f SF	224	" show all files diff when -S is used and hit is found.\n" \
ca49920f SF	225	" -a --text treat all files as text.\n"
dda2d79a	226
38c6f780	227	extern int diff_queue_is_empty(void);
6b5ee137	228	extern void diff_flush(struct diff_options*);
86436c28	229
e7baa4f4	230	/* diff-raw status letters */
ca8c9156	231	#define DIFF_STATUS_ADDED 'A'
e7baa4f4 JH	232	#define DIFF_STATUS_COPIED 'C'
	233	#define DIFF_STATUS_DELETED 'D'
	234	#define DIFF_STATUS_MODIFIED 'M'
	235	#define DIFF_STATUS_RENAMED 'R'
	236	#define DIFF_STATUS_TYPE_CHANGED 'T'
	237	#define DIFF_STATUS_UNKNOWN 'X'
	238	#define DIFF_STATUS_UNMERGED 'U'
	239
	240	/* these are not diff-raw status letters proper, but used by
	241	* diffcore-filter insn to specify additional restrictions.
	242	*/
0b34379a	243	#define DIFF_STATUS_FILTER_AON '*'
e7baa4f4 JH	244	#define DIFF_STATUS_FILTER_BROKEN 'B'
e7baa4f4 JH	245
47dd0d59 JH	246	extern const char diff_unique_abbrev(const unsigned char , int);
47dd0d59 JH	247
4bd5b7da JH	248	/* do not report anything on removed paths */
4bd5b7da JH	249	#define DIFF_SILENT_ON_REMOVED 01
fb63d7f8 JH	250	/* report racily-clean paths as modified */
fb63d7f8 JH	251	#define DIFF_RACY_IS_MODIFIED 02
4bd5b7da	252	extern int run_diff_files(struct rev_info *revs, unsigned int option);
fcfa33ec JS	253	extern int setup_diff_no_index(struct rev_info *revs,
fcfa33ec JS	254	int argc, const char ** argv, int nongit, const char *prefix);
d516c2d1	255	extern int run_diff_files_cmd(struct rev_info revs, int argc, const char *argv);
6973dcae	256
5c21ac0e	257	extern int run_diff_index(struct rev_info *revs, int cached);
e09ad6e1	258
1cfe7733	259	extern int do_diff_cache(const unsigned char , struct diff_options );
fcb3d0ad JS	260	extern int diff_flush_patch_id(struct diff_options , unsigned char );
fcb3d0ad JS	261
da31b358 JH	262	extern int diff_result_code(struct diff_options *, int);
da31b358 JH	263
86436c28	264	#endif /* DIFF_H */