1 #ifndef STATUS_H
2 #define STATUS_H
3
4 #include "string-list.h"
5 #include "color.h"
6 #include "pathspec.h"
7 #include "remote.h"
8
9 struct repository;
10 struct worktree;
11
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
23 };
24
25 enum untracked_status_type {
26 SHOW_NO_UNTRACKED_FILES,
27 SHOW_NORMAL_UNTRACKED_FILES,
28 SHOW_ALL_UNTRACKED_FILES
29 };
30
31 enum show_ignored_type {
32 SHOW_NO_IGNORED,
33 SHOW_TRADITIONAL_IGNORED,
34 SHOW_MATCHING_IGNORED,
35 };
36
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 */
44 };
45
is_from_cherry_pick(enum commit_whence whence)46 static inline int is_from_cherry_pick(enum commit_whence whence)
47 {
48 return whence == FROM_CHERRY_PICK_SINGLE ||
49 whence == FROM_CHERRY_PICK_MULTI;
50 }
51
is_from_rebase(enum commit_whence whence)52 static inline int is_from_rebase(enum commit_whence whence)
53 {
54 return whence == FROM_REBASE_PICK;
55 }
56
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;
68 };
69
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,
76
77 STATUS_FORMAT_UNSPECIFIED
78 };
79
80 #define SPARSE_CHECKOUT_DISABLED -1
81 #define SPARSE_CHECKOUT_SPARSE_INDEX -2
82
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 int sparse_checkout_percentage; /* SPARSE_CHECKOUT_DISABLED if not sparse */
94 char *branch;
95 char *onto;
96 char *detached_from;
97 struct object_id detached_oid;
98 struct object_id revert_head_oid;
99 struct object_id cherry_pick_head_oid;
100 };
101
102 struct wt_status {
103 struct repository *repo;
104 int is_initial;
105 char *branch;
106 const char *reference;
107 struct pathspec pathspec;
108 int verbose;
109 int amend;
110 enum commit_whence whence;
111 int nowarn;
112 int use_color;
113 int no_gettext;
114 int display_comment_prefix;
115 int relative_paths;
116 int submodule_summary;
117 enum show_ignored_type show_ignored_mode;
118 enum untracked_status_type show_untracked_files;
119 const char *ignore_submodule_arg;
120 char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
121 unsigned colopts;
122 int null_termination;
123 int commit_template;
124 int show_branch;
125 int show_stash;
126 int hints;
127 enum ahead_behind_flags ahead_behind_flags;
128 int detect_rename;
129 int rename_score;
130 int rename_limit;
131 enum wt_status_format status_format;
132 struct wt_status_state state;
133 struct object_id oid_commit; /* when not Initial */
134
135 /* These are computed during processing of the individual sections */
136 int committable;
137 int workdir_dirty;
138 const char *index_file;
139 FILE *fp;
140 const char *prefix;
141 struct string_list change;
142 struct string_list untracked;
143 struct string_list ignored;
144 uint32_t untracked_in_ms;
145 };
146
147 size_t wt_status_locate_end(const char *s, size_t len);
148 void wt_status_append_cut_line(struct strbuf *buf);
149 void wt_status_add_cut_line(FILE *fp);
150 void wt_status_prepare(struct repository *r, struct wt_status *s);
151 void wt_status_print(struct wt_status *s);
152 void wt_status_collect(struct wt_status *s);
153 /*
154 * Frees the buffers allocated by wt_status_collect.
155 */
156 void wt_status_collect_free_buffers(struct wt_status *s);
157 /*
158 * Frees the buffers of the wt_status_state.
159 */
160 void wt_status_state_free_buffers(struct wt_status_state *s);
161 void wt_status_get_state(struct repository *repo,
162 struct wt_status_state *state,
163 int get_detached_from);
164 int wt_status_check_rebase(const struct worktree *wt,
165 struct wt_status_state *state);
166 int wt_status_check_bisect(const struct worktree *wt,
167 struct wt_status_state *state);
168
169 __attribute__((format (printf, 3, 4)))
170 void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
171 __attribute__((format (printf, 3, 4)))
172 void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
173
174 /* The following functions expect that the caller took care of reading the index. */
175 int has_unstaged_changes(struct repository *repo,
176 int ignore_submodules);
177 int has_uncommitted_changes(struct repository *repo,
178 int ignore_submodules);
179 int require_clean_work_tree(struct repository *repo,
180 const char *action,
181 const char *hint,
182 int ignore_submodules,
183 int gently);
184
185 #endif /* STATUS_H */
186