Merge branch 'sg/test-bash-version-fix'
[git.git] / wt-status.h
blob1fcf93afbf57a9a6384b6be485846cd35fb3f465
1 #ifndef STATUS_H
2 #define STATUS_H
4 #include <stdio.h>
5 #include "string-list.h"
6 #include "color.h"
7 #include "pathspec.h"
8 #include "remote.h"
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 /* commit came from cherry-pick */
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;
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,
64 STATUS_FORMAT_UNSPECIFIED
67 struct wt_status_state {
68 int merge_in_progress;
69 int am_in_progress;
70 int am_empty_patch;
71 int rebase_in_progress;
72 int rebase_interactive_in_progress;
73 int cherry_pick_in_progress;
74 int bisect_in_progress;
75 int revert_in_progress;
76 int detached_at;
77 char *branch;
78 char *onto;
79 char *detached_from;
80 struct object_id detached_oid;
81 struct object_id revert_head_oid;
82 struct object_id cherry_pick_head_oid;
85 struct wt_status {
86 int is_initial;
87 char *branch;
88 const char *reference;
89 struct pathspec pathspec;
90 int verbose;
91 int amend;
92 enum commit_whence whence;
93 int nowarn;
94 int use_color;
95 int no_gettext;
96 int display_comment_prefix;
97 int relative_paths;
98 int submodule_summary;
99 enum show_ignored_type show_ignored_mode;
100 enum untracked_status_type show_untracked_files;
101 const char *ignore_submodule_arg;
102 char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
103 unsigned colopts;
104 int null_termination;
105 int commit_template;
106 int show_branch;
107 int show_stash;
108 int hints;
109 enum ahead_behind_flags ahead_behind_flags;
110 int detect_rename;
111 int rename_score;
112 int rename_limit;
113 enum wt_status_format status_format;
114 struct wt_status_state state;
115 unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */
117 /* These are computed during processing of the individual sections */
118 int committable;
119 int workdir_dirty;
120 const char *index_file;
121 FILE *fp;
122 const char *prefix;
123 struct string_list change;
124 struct string_list untracked;
125 struct string_list ignored;
126 uint32_t untracked_in_ms;
129 size_t wt_status_locate_end(const char *s, size_t len);
130 void wt_status_add_cut_line(FILE *fp);
131 void wt_status_prepare(struct wt_status *s);
132 void wt_status_print(struct wt_status *s);
133 void wt_status_collect(struct wt_status *s);
134 void wt_status_collect_free_buffers(struct wt_status *s);
135 void wt_status_get_state(struct wt_status_state *state, int get_detached_from);
136 int wt_status_check_rebase(const struct worktree *wt,
137 struct wt_status_state *state);
138 int wt_status_check_bisect(const struct worktree *wt,
139 struct wt_status_state *state);
141 __attribute__((format (printf, 3, 4)))
142 void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
143 __attribute__((format (printf, 3, 4)))
144 void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
146 /* The following functions expect that the caller took care of reading the index. */
147 int has_unstaged_changes(int ignore_submodules);
148 int has_uncommitted_changes(int ignore_submodules);
149 int require_clean_work_tree(const char *action, const char *hint,
150 int ignore_submodules, int gently);
152 #endif /* STATUS_H */