wt-status.h

   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
  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
  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         char *bisecting_from;
  98         struct object_id detached_oid;
  99         struct object_id revert_head_oid;
 100         struct object_id cherry_pick_head_oid;
 101 };
 102
 103 struct wt_status {
 104         struct repository *repo;
 105         int is_initial;
 106         char *branch;
 107         const char *reference;
 108         struct pathspec pathspec;
 109         int verbose;
 110         int amend;
 111         enum commit_whence whence;
 112         int nowarn;
 113         int use_color;
 114         int no_gettext;
 115         int display_comment_prefix;
 116         int relative_paths;
 117         int submodule_summary;
 118         enum show_ignored_type show_ignored_mode;
 119         enum untracked_status_type show_untracked_files;
 120         const char *ignore_submodule_arg;
 121         char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
 122         unsigned colopts;
 123         int null_termination;
 124         int commit_template;
 125         int show_branch;
 126         int show_stash;
 127         int hints;
 128         enum ahead_behind_flags ahead_behind_flags;
 129         int detect_rename;
 130         int rename_score;
 131         int rename_limit;
 132         enum wt_status_format status_format;
 133         unsigned char added_cut_line; /* boolean */
 134         struct wt_status_state state;
 135         struct object_id oid_commit; /* when not Initial */
 136
 137         /* These are computed during processing of the individual sections */
 138         int committable;
 139         int workdir_dirty;
 140         const char *index_file;
 141         FILE *fp;
 142         const char *prefix;
 143         struct string_list change;
 144         struct string_list untracked;
 145         struct string_list ignored;
 146         uint32_t untracked_in_ms;
 147 };
 148
 149 size_t wt_status_locate_end(const char *s, size_t len);
 150 void wt_status_append_cut_line(struct strbuf *buf);
 151 void wt_status_add_cut_line(struct wt_status *s);
 152 void wt_status_prepare(struct repository *r, struct wt_status *s);
 153 void wt_status_print(struct wt_status *s);
 154 void wt_status_collect(struct wt_status *s);
 155 /*
 156  * Frees the buffers allocated by wt_status_collect.
 157  */
 158 void wt_status_collect_free_buffers(struct wt_status *s);
 159 /*
 160  * Frees the buffers of the wt_status_state.
 161  */
 162 void wt_status_state_free_buffers(struct wt_status_state *s);
 163 void wt_status_get_state(struct repository *repo,
 164                          struct wt_status_state *state,
 165                          int get_detached_from);
 166 int wt_status_check_rebase(const struct worktree *wt,
 167                            struct wt_status_state *state);
 168 int wt_status_check_bisect(const struct worktree *wt,
 169                            struct wt_status_state *state);
 170
 171 __attribute__((format (printf, 3, 4)))
 172 void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
 173 __attribute__((format (printf, 3, 4)))
 174 void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
 175
 176 /* The following functions expect that the caller took care of reading the index. */
 177 int has_unstaged_changes(struct repository *repo,
 178                          int ignore_submodules);
 179 int has_uncommitted_changes(struct repository *repo,
 180                             int ignore_submodules);
 181 int require_clean_work_tree(struct repository *repo,
 182                             const char *action,
 183                             const char *hint,
 184                             int ignore_submodules,
 185                             int gently);
 186
 187 #endif /* STATUS_H */