wt-status: rename commitable to committable
[git/git.git] / wt-status.h
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 #include "remote.h"
9
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 /* commit came from cherry-pick */
42 };
43
44 struct wt_status_change_data {
45 int worktree_status;
46 int index_status;
47 int stagemask;
48 int mode_head, mode_index, mode_worktree;
49 struct object_id oid_head, oid_index;
50 int rename_status;
51 int rename_score;
52 char *rename_source;
53 unsigned dirty_submodule : 2;
54 unsigned new_submodule_commits : 1;
55 };
56
57 enum wt_status_format {
58 STATUS_FORMAT_NONE = 0,
59 STATUS_FORMAT_LONG,
60 STATUS_FORMAT_SHORT,
61 STATUS_FORMAT_PORCELAIN,
62 STATUS_FORMAT_PORCELAIN_V2,
63
64 STATUS_FORMAT_UNSPECIFIED
65 };
66
67 struct wt_status {
68 int is_initial;
69 char *branch;
70 const char *reference;
71 struct pathspec pathspec;
72 int verbose;
73 int amend;
74 enum commit_whence whence;
75 int nowarn;
76 int use_color;
77 int no_gettext;
78 int display_comment_prefix;
79 int relative_paths;
80 int submodule_summary;
81 enum show_ignored_type show_ignored_mode;
82 enum untracked_status_type show_untracked_files;
83 const char *ignore_submodule_arg;
84 char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
85 unsigned colopts;
86 int null_termination;
87 int commit_template;
88 int show_branch;
89 int show_stash;
90 int hints;
91 enum ahead_behind_flags ahead_behind_flags;
92 int detect_rename;
93 int rename_score;
94 int rename_limit;
95 enum wt_status_format status_format;
96 unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */
97
98 /* These are computed during processing of the individual sections */
99 int committable;
100 int workdir_dirty;
101 const char *index_file;
102 FILE *fp;
103 const char *prefix;
104 struct string_list change;
105 struct string_list untracked;
106 struct string_list ignored;
107 uint32_t untracked_in_ms;
108 };
109
110 struct wt_status_state {
111 int merge_in_progress;
112 int am_in_progress;
113 int am_empty_patch;
114 int rebase_in_progress;
115 int rebase_interactive_in_progress;
116 int cherry_pick_in_progress;
117 int bisect_in_progress;
118 int revert_in_progress;
119 int detached_at;
120 char *branch;
121 char *onto;
122 char *detached_from;
123 struct object_id detached_oid;
124 struct object_id revert_head_oid;
125 struct object_id cherry_pick_head_oid;
126 };
127
128 size_t wt_status_locate_end(const char *s, size_t len);
129 void wt_status_add_cut_line(FILE *fp);
130 void wt_status_prepare(struct wt_status *s);
131 void wt_status_print(struct wt_status *s);
132 void wt_status_collect(struct wt_status *s);
133 void wt_status_get_state(struct wt_status_state *state, int get_detached_from);
134 int wt_status_check_rebase(const struct worktree *wt,
135 struct wt_status_state *state);
136 int wt_status_check_bisect(const struct worktree *wt,
137 struct wt_status_state *state);
138
139 __attribute__((format (printf, 3, 4)))
140 void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
141 __attribute__((format (printf, 3, 4)))
142 void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
143
144 /* The following functions expect that the caller took care of reading the index. */
145 int has_unstaged_changes(int ignore_submodules);
146 int has_uncommitted_changes(int ignore_submodules);
147 int require_clean_work_tree(const char *action, const char *hint,
148 int ignore_submodules, int gently);
149
150 #endif /* STATUS_H */