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 #define HEAD_DETACHED_AT _("HEAD detached at ")
  69 #define HEAD_DETACHED_FROM _("HEAD detached from ")
  70
  71 struct wt_status_state {
  72         int merge_in_progress;
  73         int am_in_progress;
  74         int am_empty_patch;
  75         int rebase_in_progress;
  76         int rebase_interactive_in_progress;
  77         int cherry_pick_in_progress;
  78         int bisect_in_progress;
  79         int revert_in_progress;
  80         int detached_at;
  81         char *branch;
  82         char *onto;
  83         char *detached_from;
  84         struct object_id detached_oid;
  85         struct object_id revert_head_oid;
  86         struct object_id cherry_pick_head_oid;
  87 };
  88
  89 struct wt_status {
  90         struct repository *repo;
  91         int is_initial;
  92         char *branch;
  93         const char *reference;
  94         struct pathspec pathspec;
  95         int verbose;
  96         int amend;
  97         enum commit_whence whence;
  98         int nowarn;
  99         int use_color;
 100         int no_gettext;
 101         int display_comment_prefix;
 102         int relative_paths;
 103         int submodule_summary;
 104         enum show_ignored_type show_ignored_mode;
 105         enum untracked_status_type show_untracked_files;
 106         const char *ignore_submodule_arg;
 107         char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
 108         unsigned colopts;
 109         int null_termination;
 110         int commit_template;
 111         int show_branch;
 112         int show_stash;
 113         int hints;
 114         enum ahead_behind_flags ahead_behind_flags;
 115         int detect_rename;
 116         int rename_score;
 117         int rename_limit;
 118         enum wt_status_format status_format;
 119         struct wt_status_state state;
 120         unsigned char sha1_commit[GIT_MAX_RAWSZ]; /* when not Initial */
 121
 122         /* These are computed during processing of the individual sections */
 123         int committable;
 124         int workdir_dirty;
 125         const char *index_file;
 126         FILE *fp;
 127         const char *prefix;
 128         struct string_list change;
 129         struct string_list untracked;
 130         struct string_list ignored;
 131         uint32_t untracked_in_ms;
 132 };
 133
 134 size_t wt_status_locate_end(const char *s, size_t len);
 135 void wt_status_append_cut_line(struct strbuf *buf);
 136 void wt_status_add_cut_line(FILE *fp);
 137 void wt_status_prepare(struct repository *r, struct wt_status *s);
 138 void wt_status_print(struct wt_status *s);
 139 void wt_status_collect(struct wt_status *s);
 140 void wt_status_collect_free_buffers(struct wt_status *s);
 141 void wt_status_get_state(struct repository *repo,
 142                          struct wt_status_state *state,
 143                          int get_detached_from);
 144 int wt_status_check_rebase(const struct worktree *wt,
 145                            struct wt_status_state *state);
 146 int wt_status_check_bisect(const struct worktree *wt,
 147                            struct wt_status_state *state);
 148
 149 __attribute__((format (printf, 3, 4)))
 150 void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
 151 __attribute__((format (printf, 3, 4)))
 152 void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
 153
 154 /* The following functions expect that the caller took care of reading the index. */
 155 int has_unstaged_changes(struct repository *repo,
 156                          int ignore_submodules);
 157 int has_uncommitted_changes(struct repository *repo,
 158                             int ignore_submodules);
 159 int require_clean_work_tree(struct repository *repo,
 160                             const char *action,
 161                             const char *hint,
 162                             int ignore_submodules,
 163                             int gently);
 164
 165 #endif /* STATUS_H */