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