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