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 repository;
  11 struct worktree;
  12
  13 enum color_wt_status {
  14         WT_STATUS_HEADER = 0,
  15         WT_STATUS_UPDATED,
  16         WT_STATUS_CHANGED,
  17         WT_STATUS_UNTRACKED,
  18         WT_STATUS_NOBRANCH,
  19         WT_STATUS_UNMERGED,
  20         WT_STATUS_LOCAL_BRANCH,
  21         WT_STATUS_REMOTE_BRANCH,
  22         WT_STATUS_ONBRANCH,
  23         WT_STATUS_MAXSLOT
  24 };
  25
  26 enum untracked_status_type {
  27         SHOW_NO_UNTRACKED_FILES,
  28         SHOW_NORMAL_UNTRACKED_FILES,
  29         SHOW_ALL_UNTRACKED_FILES
  30 };
  31
  32 enum show_ignored_type {
  33         SHOW_NO_IGNORED,
  34         SHOW_TRADITIONAL_IGNORED,
  35         SHOW_MATCHING_IGNORED,
  36 };
  37
  38 /* from where does this commit originate */
  39 enum commit_whence {
  40         FROM_COMMIT,     /* normal */
  41         FROM_MERGE,      /* commit came from merge */
  42         FROM_CHERRY_PICK /* commit came from cherry-pick */
  43 };
  44
  45 struct wt_status_change_data {
  46         int worktree_status;
  47         int index_status;
  48         int stagemask;
  49         int mode_head, mode_index, mode_worktree;
  50         struct object_id oid_head, oid_index;
  51         int rename_status;
  52         int rename_score;
  53         char *rename_source;
  54         unsigned dirty_submodule       : 2;
  55         unsigned new_submodule_commits : 1;
  56 };
  57
  58 enum wt_status_format {
  59         STATUS_FORMAT_NONE = 0,
  60         STATUS_FORMAT_LONG,
  61         STATUS_FORMAT_SHORT,
  62         STATUS_FORMAT_PORCELAIN,
  63         STATUS_FORMAT_PORCELAIN_V2,
  64
  65         STATUS_FORMAT_UNSPECIFIED
  66 };
  67
  68 struct wt_status_state {
  69         int merge_in_progress;
  70         int am_in_progress;
  71         int am_empty_patch;
  72         int rebase_in_progress;
  73         int rebase_interactive_in_progress;
  74         int cherry_pick_in_progress;
  75         int bisect_in_progress;
  76         int revert_in_progress;
  77         int detached_at;
  78         char *branch;
  79         char *onto;
  80         char *detached_from;
  81         struct object_id detached_oid;
  82         struct object_id revert_head_oid;
  83         struct object_id cherry_pick_head_oid;
  84 };
  85
  86 struct wt_status {
  87         struct repository *repo;
  88         int is_initial;
  89         char *branch;
  90         const char *reference;
  91         struct pathspec pathspec;
  92         int verbose;
  93         int amend;
  94         enum commit_whence whence;
  95         int nowarn;
  96         int use_color;
  97         int no_gettext;
  98         int display_comment_prefix;
  99         int relative_paths;
 100         int submodule_summary;
 101         enum show_ignored_type show_ignored_mode;
 102         enum untracked_status_type show_untracked_files;
 103         const char *ignore_submodule_arg;
 104         char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
 105         unsigned colopts;
 106         int null_termination;
 107         int commit_template;
 108         int show_branch;
 109         int show_stash;
 110         int hints;
 111         enum ahead_behind_flags ahead_behind_flags;
 112         int detect_rename;
 113         int rename_score;
 114         int rename_limit;
 115         enum wt_status_format status_format;
 116         struct wt_status_state state;
 117         unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */
 118
 119         /* These are computed during processing of the individual sections */
 120         int committable;
 121         int workdir_dirty;
 122         const char *index_file;
 123         FILE *fp;
 124         const char *prefix;
 125         struct string_list change;
 126         struct string_list untracked;
 127         struct string_list ignored;
 128         uint32_t untracked_in_ms;
 129 };
 130
 131 size_t wt_status_locate_end(const char *s, size_t len);
 132 void wt_status_append_cut_line(struct strbuf *buf);
 133 void wt_status_add_cut_line(FILE *fp);
 134 void wt_status_prepare(struct repository *r, struct wt_status *s);
 135 void wt_status_print(struct wt_status *s);
 136 void wt_status_collect(struct wt_status *s);
 137 void wt_status_collect_free_buffers(struct wt_status *s);
 138 void wt_status_get_state(struct repository *repo,
 139                          struct wt_status_state *state,
 140                          int get_detached_from);
 141 int wt_status_check_rebase(const struct worktree *wt,
 142                            struct wt_status_state *state);
 143 int wt_status_check_bisect(const struct worktree *wt,
 144                            struct wt_status_state *state);
 145
 146 __attribute__((format (printf, 3, 4)))
 147 void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
 148 __attribute__((format (printf, 3, 4)))
 149 void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
 150
 151 /* The following functions expect that the caller took care of reading the index. */
 152 int has_unstaged_changes(struct repository *repo,
 153                          int ignore_submodules);
 154 int has_uncommitted_changes(struct repository *repo,
 155                             int ignore_submodules);
 156 int require_clean_work_tree(struct repository *repo,
 157                             const char *action,
 158                             const char *hint,
 159                             int ignore_submodules,
 160                             int gently);
 161
 162 #endif /* STATUS_H */