[thirdparty/git.git] / wt-status.h

#ifndef STATUS_H
#define STATUS_H

#include <stdio.h>
#include "string-list.h"
#include "color.h"
#include "pathspec.h"
#include "remote.h"

struct repository;
struct worktree;

enum color_wt_status {
	WT_STATUS_HEADER = 0,
	WT_STATUS_UPDATED,
	WT_STATUS_CHANGED,
	WT_STATUS_UNTRACKED,
	WT_STATUS_NOBRANCH,
	WT_STATUS_UNMERGED,
	WT_STATUS_LOCAL_BRANCH,
	WT_STATUS_REMOTE_BRANCH,
	WT_STATUS_ONBRANCH,
	WT_STATUS_MAXSLOT
};

enum untracked_status_type {
	SHOW_NO_UNTRACKED_FILES,
	SHOW_NORMAL_UNTRACKED_FILES,
	SHOW_ALL_UNTRACKED_FILES
};

enum show_ignored_type {
	SHOW_NO_IGNORED,
	SHOW_TRADITIONAL_IGNORED,
	SHOW_MATCHING_IGNORED,
};

/* from where does this commit originate */
enum commit_whence {
	FROM_COMMIT,     /* normal */
	FROM_MERGE,      /* commit came from merge */
	FROM_CHERRY_PICK /* commit came from cherry-pick */
};

struct wt_status_change_data {
	int worktree_status;
	int index_status;
	int stagemask;
	int mode_head, mode_index, mode_worktree;
	struct object_id oid_head, oid_index;
	int rename_status;
	int rename_score;
	char *rename_source;
	unsigned dirty_submodule       : 2;
	unsigned new_submodule_commits : 1;
};

enum wt_status_format {
	STATUS_FORMAT_NONE = 0,
	STATUS_FORMAT_LONG,
	STATUS_FORMAT_SHORT,
	STATUS_FORMAT_PORCELAIN,
	STATUS_FORMAT_PORCELAIN_V2,

	STATUS_FORMAT_UNSPECIFIED
};

struct wt_status_state {
	int merge_in_progress;
	int am_in_progress;
	int am_empty_patch;
	int rebase_in_progress;
	int rebase_interactive_in_progress;
	int cherry_pick_in_progress;
	int bisect_in_progress;
	int revert_in_progress;
	int detached_at;
	char *branch;
	char *onto;
	char *detached_from;
	struct object_id detached_oid;
	struct object_id revert_head_oid;
	struct object_id cherry_pick_head_oid;
};

struct wt_status {
	struct repository *repo;
	int is_initial;
	char *branch;
	const char *reference;
	struct pathspec pathspec;
	int verbose;
	int amend;
	enum commit_whence whence;
	int nowarn;
	int use_color;
	int no_gettext;
	int display_comment_prefix;
	int relative_paths;
	int submodule_summary;
	enum show_ignored_type show_ignored_mode;
	enum untracked_status_type show_untracked_files;
	const char *ignore_submodule_arg;
	char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
	unsigned colopts;
	int null_termination;
	int commit_template;
	int show_branch;
	int show_stash;
	int hints;
	enum ahead_behind_flags ahead_behind_flags;
	int detect_rename;
	int rename_score;
	int rename_limit;
	enum wt_status_format status_format;
	struct wt_status_state state;
	unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */

	/* These are computed during processing of the individual sections */
	int committable;
	int workdir_dirty;
	const char *index_file;
	FILE *fp;
	const char *prefix;
	struct string_list change;
	struct string_list untracked;
	struct string_list ignored;
	uint32_t untracked_in_ms;
};

size_t wt_status_locate_end(const char *s, size_t len);
void wt_status_add_cut_line(FILE *fp);
void wt_status_prepare(struct repository *r, struct wt_status *s);
void wt_status_print(struct wt_status *s);
void wt_status_collect(struct wt_status *s);
void wt_status_collect_free_buffers(struct wt_status *s);
void wt_status_get_state(struct repository *repo,
			 struct wt_status_state *state,
			 int get_detached_from);
int wt_status_check_rebase(const struct worktree *wt,
			   struct wt_status_state *state);
int wt_status_check_bisect(const struct worktree *wt,
			   struct wt_status_state *state);

__attribute__((format (printf, 3, 4)))
void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
__attribute__((format (printf, 3, 4)))
void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);

/* The following functions expect that the caller took care of reading the index. */
int has_unstaged_changes(struct repository *repo,
			 int ignore_submodules);
int has_uncommitted_changes(struct repository *repo,
			    int ignore_submodules);
int require_clean_work_tree(struct repository *repo,
			    const char *action,
			    const char *hint,
			    int ignore_submodules,
			    int gently);

#endif /* STATUS_H */
Commit	Line	Data
c91f0d92 JK	1	#ifndef STATUS_H
	2	#define STATUS_H
	3
f26a0012	4	#include <stdio.h>
50b7e70f	5	#include "string-list.h"
23900a96	6	#include "color.h"
7aa9b9ba	7	#include "pathspec.h"
fd9b544a	8	#include "remote.h"
f26a0012	9
5b02ca38	10	struct repository;
81eff27b NTND	11	struct worktree;
81eff27b NTND	12
c91f0d92	13	enum color_wt_status {
23900a96	14	WT_STATUS_HEADER = 0,
c91f0d92 JK	15	WT_STATUS_UPDATED,
	16	WT_STATUS_CHANGED,
	17	WT_STATUS_UNTRACKED,
950ce2e2	18	WT_STATUS_NOBRANCH,
4d4d5726	19	WT_STATUS_UNMERGED,
05a59a08	20	WT_STATUS_LOCAL_BRANCH,
1d282327 AA	21	WT_STATUS_REMOTE_BRANCH,
	22	WT_STATUS_ONBRANCH,
	23	WT_STATUS_MAXSLOT
c91f0d92 JK	24	};
c91f0d92 JK	25
4bfee30a	26	enum untracked_status_type {
6c2ce048 MSO	27	SHOW_NO_UNTRACKED_FILES,
6c2ce048 MSO	28	SHOW_NORMAL_UNTRACKED_FILES,
4bfee30a MSO	29	SHOW_ALL_UNTRACKED_FILES
4bfee30a MSO	30	};
4bfee30a	31
eec0f7f2 JM	32	enum show_ignored_type {
	33	SHOW_NO_IGNORED,
	34	SHOW_TRADITIONAL_IGNORED,
	35	SHOW_MATCHING_IGNORED,
	36	};
	37
37f7a857 JS	38	/* from where does this commit originate */
	39	enum commit_whence {
	40	FROM_COMMIT, /* normal */
	41	FROM_MERGE, /* commit came from merge */
	42	FROM_CHERRY_PICK /* commit came from cherry-pick */
	43	};
	44
50b7e70f JH	45	struct wt_status_change_data {
	46	int worktree_status;
	47	int index_status;
	48	int stagemask;
1ecdecce JH	49	int mode_head, mode_index, mode_worktree;
1ecdecce JH	50	struct object_id oid_head, oid_index;
5134ccde NTND	51	int rename_status;
	52	int rename_score;
	53	char *rename_source;
9297f77e JL	54	unsigned dirty_submodule : 2;
9297f77e JL	55	unsigned new_submodule_commits : 1;
50b7e70f JH	56	};
50b7e70f JH	57
be7e795e JH	58	enum wt_status_format {
	59	STATUS_FORMAT_NONE = 0,
	60	STATUS_FORMAT_LONG,
	61	STATUS_FORMAT_SHORT,
	62	STATUS_FORMAT_PORCELAIN,
1ecdecce	63	STATUS_FORMAT_PORCELAIN_V2,
be7e795e JH	64
	65	STATUS_FORMAT_UNSPECIFIED
	66	};
	67
73ba5d78 SS	68	struct wt_status_state {
	69	int merge_in_progress;
	70	int am_in_progress;
	71	int am_empty_patch;
	72	int rebase_in_progress;
	73	int rebase_interactive_in_progress;
	74	int cherry_pick_in_progress;
	75	int bisect_in_progress;
	76	int revert_in_progress;
	77	int detached_at;
	78	char *branch;
	79	char *onto;
	80	char *detached_from;
	81	struct object_id detached_oid;
	82	struct object_id revert_head_oid;
	83	struct object_id cherry_pick_head_oid;
	84	};
	85
c91f0d92	86	struct wt_status {
5b02ca38	87	struct repository *repo;
c91f0d92 JK	88	int is_initial;
	89	char *branch;
	90	const char *reference;
15b55ae0	91	struct pathspec pathspec;
c91f0d92 JK	92	int verbose;
c91f0d92 JK	93	int amend;
37f7a857	94	enum commit_whence whence;
37d07f8f	95	int nowarn;
d249b098	96	int use_color;
7a76c28f	97	int no_gettext;
2556b996	98	int display_comment_prefix;
d249b098 JH	99	int relative_paths;
d249b098 JH	100	int submodule_summary;
eec0f7f2	101	enum show_ignored_type show_ignored_mode;
d249b098	102	enum untracked_status_type show_untracked_files;
46a958b3	103	const char *ignore_submodule_arg;
1d282327	104	char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
4d2292e9	105	unsigned colopts;
3207a3a2	106	int null_termination;
4ddb1354	107	int commit_template;
d4a6bf1f	108	int show_branch;
c1b5d019	109	int show_stash;
6a964f57	110	int hints;
fd9b544a	111	enum ahead_behind_flags ahead_behind_flags;
e8b2dc2c BP	112	int detect_rename;
	113	int rename_score;
	114	int rename_limit;
be7e795e	115	enum wt_status_format status_format;
73ba5d78	116	struct wt_status_state state;
cd02599c	117	unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */
be7e795e	118
2a3a3c24	119	/* These are computed during processing of the individual sections */
6fa90194	120	int committable;
2a3a3c24	121	int workdir_dirty;
0f729f21	122	const char *index_file;
f26a0012	123	FILE *fp;
367c9886	124	const char *prefix;
50b7e70f	125	struct string_list change;
76378683	126	struct string_list untracked;
6cb3f6b2	127	struct string_list ignored;
6a38ef2c	128	uint32_t untracked_in_ms;
c91f0d92 JK	129	};
c91f0d92 JK	130
d76650b8	131	size_t wt_status_locate_end(const char *s, size_t len);
fcef9312	132	void wt_status_add_cut_line(FILE *fp);
5b02ca38	133	void wt_status_prepare(struct repository r, struct wt_status s);
be7e795e	134	void wt_status_print(struct wt_status *s);
76378683	135	void wt_status_collect(struct wt_status *s);
73ba5d78	136	void wt_status_collect_free_buffers(struct wt_status *s);
78845457 NTND	137	void wt_status_get_state(struct repository *repo,
	138	struct wt_status_state *state,
	139	int get_detached_from);
81eff27b NTND	140	int wt_status_check_rebase(const struct worktree *wt,
81eff27b NTND	141	struct wt_status_state *state);
f5d067a2 NTND	142	int wt_status_check_bisect(const struct worktree *wt,
f5d067a2 NTND	143	struct wt_status_state *state);
c91f0d92	144
8dd0ee82 JK	145	__attribute__((format (printf, 3, 4)))
	146	void status_printf_ln(struct wt_status s, const char color, const char *fmt, ...);
	147	__attribute__((format (printf, 3, 4)))
	148	void status_printf(struct wt_status s, const char color, const char *fmt, ...);
becbdae8	149
41a5dd6d	150	/* The following functions expect that the caller took care of reading the index. */
5b02ca38 NTND	151	int has_unstaged_changes(struct repository *repo,
	152	int ignore_submodules);
	153	int has_uncommitted_changes(struct repository *repo,
	154	int ignore_submodules);
	155	int require_clean_work_tree(struct repository *repo,
	156	const char *action,
	157	const char *hint,
	158	int ignore_submodules,
	159	int gently);
fd84986f	160
c91f0d92	161	#endif /* STATUS_H */