[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"

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 score;
	int mode_head, mode_index, mode_worktree;
	struct object_id oid_head, oid_index;
	char *head_path;
	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 {
	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 wt_status_format status_format;
	unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */

	/* These are computed during processing of the individual sections */
	int commitable;
	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;
};

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;
	unsigned char detached_sha1[20];
	unsigned char revert_head_sha1[20];
	unsigned char cherry_pick_head_sha1[20];
};

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 wt_status *s);
void wt_status_print(struct wt_status *s);
void wt_status_collect(struct wt_status *s);
void wt_status_get_state(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(int ignore_submodules);
int has_uncommitted_changes(int ignore_submodules);
int require_clean_work_tree(const char *action, const char *hint,
	int ignore_submodules, int gently);

#endif /* STATUS_H */
Commit	Line	Data
	1	#ifndef STATUS_H
	2	#define STATUS_H
	3
	4	#include <stdio.h>
	5	#include "string-list.h"
	6	#include "color.h"
	7	#include "pathspec.h"
	8
	9	struct worktree;
	10
	11	enum color_wt_status {
	12	WT_STATUS_HEADER = 0,
	13	WT_STATUS_UPDATED,
	14	WT_STATUS_CHANGED,
	15	WT_STATUS_UNTRACKED,
	16	WT_STATUS_NOBRANCH,
	17	WT_STATUS_UNMERGED,
	18	WT_STATUS_LOCAL_BRANCH,
	19	WT_STATUS_REMOTE_BRANCH,
	20	WT_STATUS_ONBRANCH,
	21	WT_STATUS_MAXSLOT
	22	};
	23
	24	enum untracked_status_type {
	25	SHOW_NO_UNTRACKED_FILES,
	26	SHOW_NORMAL_UNTRACKED_FILES,
	27	SHOW_ALL_UNTRACKED_FILES
	28	};
	29
	30	enum show_ignored_type {
	31	SHOW_NO_IGNORED,
	32	SHOW_TRADITIONAL_IGNORED,
	33	SHOW_MATCHING_IGNORED,
	34	};
	35
	36	/* from where does this commit originate */
	37	enum commit_whence {
	38	FROM_COMMIT, /* normal */
	39	FROM_MERGE, /* commit came from merge */
	40	FROM_CHERRY_PICK /* commit came from cherry-pick */
	41	};
	42
	43	struct wt_status_change_data {
	44	int worktree_status;
	45	int index_status;
	46	int stagemask;
	47	int score;
	48	int mode_head, mode_index, mode_worktree;
	49	struct object_id oid_head, oid_index;
	50	char *head_path;
	51	unsigned dirty_submodule : 2;
	52	unsigned new_submodule_commits : 1;
	53	};
	54
	55	enum wt_status_format {
	56	STATUS_FORMAT_NONE = 0,
	57	STATUS_FORMAT_LONG,
	58	STATUS_FORMAT_SHORT,
	59	STATUS_FORMAT_PORCELAIN,
	60	STATUS_FORMAT_PORCELAIN_V2,
	61
	62	STATUS_FORMAT_UNSPECIFIED
	63	};
	64
	65	struct wt_status {
	66	int is_initial;
	67	char *branch;
	68	const char *reference;
	69	struct pathspec pathspec;
	70	int verbose;
	71	int amend;
	72	enum commit_whence whence;
	73	int nowarn;
	74	int use_color;
	75	int no_gettext;
	76	int display_comment_prefix;
	77	int relative_paths;
	78	int submodule_summary;
	79	enum show_ignored_type show_ignored_mode;
	80	enum untracked_status_type show_untracked_files;
	81	const char *ignore_submodule_arg;
	82	char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
	83	unsigned colopts;
	84	int null_termination;
	85	int commit_template;
	86	int show_branch;
	87	int show_stash;
	88	int hints;
	89
	90	enum wt_status_format status_format;
	91	unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */
	92
	93	/* These are computed during processing of the individual sections */
	94	int commitable;
	95	int workdir_dirty;
	96	const char *index_file;
	97	FILE *fp;
	98	const char *prefix;
	99	struct string_list change;
	100	struct string_list untracked;
	101	struct string_list ignored;
	102	uint32_t untracked_in_ms;
	103	};
	104
	105	struct wt_status_state {
	106	int merge_in_progress;
	107	int am_in_progress;
	108	int am_empty_patch;
	109	int rebase_in_progress;
	110	int rebase_interactive_in_progress;
	111	int cherry_pick_in_progress;
	112	int bisect_in_progress;
	113	int revert_in_progress;
	114	int detached_at;
	115	char *branch;
	116	char *onto;
	117	char *detached_from;
	118	unsigned char detached_sha1[20];
	119	unsigned char revert_head_sha1[20];
	120	unsigned char cherry_pick_head_sha1[20];
	121	};
	122
	123	size_t wt_status_locate_end(const char *s, size_t len);
	124	void wt_status_add_cut_line(FILE *fp);
	125	void wt_status_prepare(struct wt_status *s);
	126	void wt_status_print(struct wt_status *s);
	127	void wt_status_collect(struct wt_status *s);
	128	void wt_status_get_state(struct wt_status_state *state, int get_detached_from);
	129	int wt_status_check_rebase(const struct worktree *wt,
	130	struct wt_status_state *state);
	131	int wt_status_check_bisect(const struct worktree *wt,
	132	struct wt_status_state *state);
	133
	134	__attribute__((format (printf, 3, 4)))
	135	void status_printf_ln(struct wt_status s, const char color, const char *fmt, ...);
	136	__attribute__((format (printf, 3, 4)))
	137	void status_printf(struct wt_status s, const char color, const char *fmt, ...);
	138
	139	/* The following functions expect that the caller took care of reading the index. */
	140	int has_unstaged_changes(int ignore_submodules);
	141	int has_uncommitted_changes(int ignore_submodules);
	142	int require_clean_work_tree(const char action, const char hint,
	143	int ignore_submodules, int gently);
	144
	145	#endif /* STATUS_H */