Git 2.27-rc2
[git.git] / wt-status.h
blob73ab5d4da1c0b4766cb63501b9db06c0a7fea934
1 #ifndef STATUS_H
2 #define STATUS_H
4 #include "string-list.h"
5 #include "color.h"
6 #include "pathspec.h"
7 #include "remote.h"
9 struct repository;
10 struct worktree;
12 enum color_wt_status {
13 WT_STATUS_HEADER = 0,
14 WT_STATUS_UPDATED,
15 WT_STATUS_CHANGED,
16 WT_STATUS_UNTRACKED,
17 WT_STATUS_NOBRANCH,
18 WT_STATUS_UNMERGED,
19 WT_STATUS_LOCAL_BRANCH,
20 WT_STATUS_REMOTE_BRANCH,
21 WT_STATUS_ONBRANCH,
22 WT_STATUS_MAXSLOT
25 enum untracked_status_type {
26 SHOW_NO_UNTRACKED_FILES,
27 SHOW_NORMAL_UNTRACKED_FILES,
28 SHOW_ALL_UNTRACKED_FILES
31 enum show_ignored_type {
32 SHOW_NO_IGNORED,
33 SHOW_TRADITIONAL_IGNORED,
34 SHOW_MATCHING_IGNORED,
37 /* from where does this commit originate */
38 enum commit_whence {
39 FROM_COMMIT, /* normal */
40 FROM_MERGE, /* commit came from merge */
41 FROM_CHERRY_PICK_SINGLE, /* commit came from cherry-pick */
42 FROM_CHERRY_PICK_MULTI, /* commit came from a sequence of cherry-picks */
43 FROM_REBASE_PICK /* commit came from a pick/reword/edit */
46 static inline int is_from_cherry_pick(enum commit_whence whence)
48 return whence == FROM_CHERRY_PICK_SINGLE ||
49 whence == FROM_CHERRY_PICK_MULTI;
52 static inline int is_from_rebase(enum commit_whence whence)
54 return whence == FROM_REBASE_PICK;
57 struct wt_status_change_data {
58 int worktree_status;
59 int index_status;
60 int stagemask;
61 int mode_head, mode_index, mode_worktree;
62 struct object_id oid_head, oid_index;
63 int rename_status;
64 int rename_score;
65 char *rename_source;
66 unsigned dirty_submodule : 2;
67 unsigned new_submodule_commits : 1;
70 enum wt_status_format {
71 STATUS_FORMAT_NONE = 0,
72 STATUS_FORMAT_LONG,
73 STATUS_FORMAT_SHORT,
74 STATUS_FORMAT_PORCELAIN,
75 STATUS_FORMAT_PORCELAIN_V2,
77 STATUS_FORMAT_UNSPECIFIED
80 #define HEAD_DETACHED_AT _("HEAD detached at ")
81 #define HEAD_DETACHED_FROM _("HEAD detached from ")
83 struct wt_status_state {
84 int merge_in_progress;
85 int am_in_progress;
86 int am_empty_patch;
87 int rebase_in_progress;
88 int rebase_interactive_in_progress;
89 int cherry_pick_in_progress;
90 int bisect_in_progress;
91 int revert_in_progress;
92 int detached_at;
93 char *branch;
94 char *onto;
95 char *detached_from;
96 struct object_id detached_oid;
97 struct object_id revert_head_oid;
98 struct object_id cherry_pick_head_oid;
101 struct wt_status {
102 struct repository *repo;
103 int is_initial;
104 char *branch;
105 const char *reference;
106 struct pathspec pathspec;
107 int verbose;
108 int amend;
109 enum commit_whence whence;
110 int nowarn;
111 int use_color;
112 int no_gettext;
113 int display_comment_prefix;
114 int relative_paths;
115 int submodule_summary;
116 enum show_ignored_type show_ignored_mode;
117 enum untracked_status_type show_untracked_files;
118 const char *ignore_submodule_arg;
119 char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
120 unsigned colopts;
121 int null_termination;
122 int commit_template;
123 int show_branch;
124 int show_stash;
125 int hints;
126 enum ahead_behind_flags ahead_behind_flags;
127 int detect_rename;
128 int rename_score;
129 int rename_limit;
130 enum wt_status_format status_format;
131 struct wt_status_state state;
132 struct object_id oid_commit; /* when not Initial */
134 /* These are computed during processing of the individual sections */
135 int committable;
136 int workdir_dirty;
137 const char *index_file;
138 FILE *fp;
139 const char *prefix;
140 struct string_list change;
141 struct string_list untracked;
142 struct string_list ignored;
143 uint32_t untracked_in_ms;
146 size_t wt_status_locate_end(const char *s, size_t len);
147 void wt_status_append_cut_line(struct strbuf *buf);
148 void wt_status_add_cut_line(FILE *fp);
149 void wt_status_prepare(struct repository *r, struct wt_status *s);
150 void wt_status_print(struct wt_status *s);
151 void wt_status_collect(struct wt_status *s);
152 void wt_status_collect_free_buffers(struct wt_status *s);
153 void wt_status_get_state(struct repository *repo,
154 struct wt_status_state *state,
155 int get_detached_from);
156 int wt_status_check_rebase(const struct worktree *wt,
157 struct wt_status_state *state);
158 int wt_status_check_bisect(const struct worktree *wt,
159 struct wt_status_state *state);
161 __attribute__((format (printf, 3, 4)))
162 void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
163 __attribute__((format (printf, 3, 4)))
164 void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
166 /* The following functions expect that the caller took care of reading the index. */
167 int has_unstaged_changes(struct repository *repo,
168 int ignore_submodules);
169 int has_uncommitted_changes(struct repository *repo,
170 int ignore_submodules);
171 int require_clean_work_tree(struct repository *repo,
172 const char *action,
173 const char *hint,
174 int ignore_submodules,
175 int gently);
177 #endif /* STATUS_H */