git/wt-status.h

257 строки
6.8 KiB
C

#ifndef STATUS_H
#define STATUS_H
#include "string-list.h"
#include "color.h"
#include "pathspec.h"
#include "pkt-line.h"
#include "remote.h"
struct repository;
struct worktree;
enum color_wt_status {
WT_STATUS_HEADER = 0,
WT_STATUS_UPDATED,
WT_STATUS_CHANGED,
WT_STATUS_UNTRACKED,
WT_STATUS_NOBRANCH,
WT_STATUS_UNMERGED,
WT_STATUS_LOCAL_BRANCH,
WT_STATUS_REMOTE_BRANCH,
WT_STATUS_ONBRANCH,
WT_STATUS_MAXSLOT
};
enum untracked_status_type {
SHOW_NO_UNTRACKED_FILES,
SHOW_NORMAL_UNTRACKED_FILES,
SHOW_ALL_UNTRACKED_FILES,
SHOW_COMPLETE_UNTRACKED_FILES,
};
enum show_ignored_type {
SHOW_NO_IGNORED,
SHOW_TRADITIONAL_IGNORED,
SHOW_MATCHING_IGNORED,
};
/* from where does this commit originate */
enum commit_whence {
FROM_COMMIT, /* normal */
FROM_MERGE, /* commit came from merge */
FROM_CHERRY_PICK_SINGLE, /* commit came from cherry-pick */
FROM_CHERRY_PICK_MULTI, /* commit came from a sequence of cherry-picks */
FROM_REBASE_PICK /* commit came from a pick/reword/edit */
};
static inline int is_from_cherry_pick(enum commit_whence whence)
{
return whence == FROM_CHERRY_PICK_SINGLE ||
whence == FROM_CHERRY_PICK_MULTI;
}
static inline int is_from_rebase(enum commit_whence whence)
{
return whence == FROM_REBASE_PICK;
}
struct wt_status_change_data {
int worktree_status;
int index_status;
int stagemask;
int mode_head, mode_index, mode_worktree;
struct object_id oid_head, oid_index;
int rename_status;
int rename_score;
char *rename_source;
unsigned dirty_submodule : 2;
unsigned new_submodule_commits : 1;
};
enum wt_status_format {
STATUS_FORMAT_NONE = 0,
STATUS_FORMAT_LONG,
STATUS_FORMAT_SHORT,
STATUS_FORMAT_PORCELAIN,
STATUS_FORMAT_PORCELAIN_V2,
STATUS_FORMAT_SERIALIZE_V1,
STATUS_FORMAT_UNSPECIFIED
};
#define SPARSE_CHECKOUT_DISABLED -1
#define SPARSE_CHECKOUT_SPARSE_INDEX -2
struct wt_status_state {
int merge_in_progress;
int am_in_progress;
int am_empty_patch;
int rebase_in_progress;
int rebase_interactive_in_progress;
int cherry_pick_in_progress;
int bisect_in_progress;
int revert_in_progress;
int detached_at;
int sparse_checkout_percentage; /* SPARSE_CHECKOUT_DISABLED if not sparse */
char *branch;
char *onto;
char *detached_from;
struct object_id detached_oid;
struct object_id revert_head_oid;
struct object_id cherry_pick_head_oid;
};
struct wt_status {
struct repository *repo;
int is_initial;
char *branch;
const char *reference;
struct pathspec pathspec;
int verbose;
int amend;
enum commit_whence whence;
int nowarn;
int use_color;
int no_gettext;
int display_comment_prefix;
int relative_paths;
int submodule_summary;
enum show_ignored_type show_ignored_mode;
enum untracked_status_type show_untracked_files;
const char *ignore_submodule_arg;
char color_palette[WT_STATUS_MAXSLOT][COLOR_MAXLEN];
unsigned colopts;
int null_termination;
int commit_template;
int show_branch;
int show_stash;
int hints;
enum ahead_behind_flags ahead_behind_flags;
int detect_rename;
int rename_score;
int rename_limit;
enum wt_status_format status_format;
struct wt_status_state state;
struct object_id oid_commit; /* when not Initial */
/* These are computed during processing of the individual sections */
int committable;
int workdir_dirty;
const char *index_file;
FILE *fp;
const char *prefix;
struct string_list change;
struct string_list untracked;
struct string_list ignored;
uint32_t untracked_in_ms;
};
size_t wt_status_locate_end(const char *s, size_t len);
void wt_status_append_cut_line(struct strbuf *buf);
void wt_status_add_cut_line(FILE *fp);
void wt_status_prepare(struct repository *r, struct wt_status *s);
void wt_status_print(struct wt_status *s);
void wt_status_collect(struct wt_status *s);
/*
* Frees the buffers allocated by wt_status_collect.
*/
void wt_status_collect_free_buffers(struct wt_status *s);
/*
* Frees the buffers of the wt_status_state.
*/
void wt_status_state_free_buffers(struct wt_status_state *s);
void wt_status_get_state(struct repository *repo,
struct wt_status_state *state,
int get_detached_from);
int wt_status_check_rebase(const struct worktree *wt,
struct wt_status_state *state);
int wt_status_check_bisect(const struct worktree *wt,
struct wt_status_state *state);
__attribute__((format (printf, 3, 4)))
void status_printf_ln(struct wt_status *s, const char *color, const char *fmt, ...);
__attribute__((format (printf, 3, 4)))
void status_printf(struct wt_status *s, const char *color, const char *fmt, ...);
/* The following functions expect that the caller took care of reading the index. */
int has_unstaged_changes(struct repository *repo,
int ignore_submodules);
int has_uncommitted_changes(struct repository *repo,
int ignore_submodules);
int require_clean_work_tree(struct repository *repo,
const char *action,
const char *hint,
int ignore_submodules,
int gently);
#define DESERIALIZE_OK 0
#define DESERIALIZE_ERR 1
struct wt_status_serialize_data_fixed
{
uint32_t worktree_status;
uint32_t index_status;
uint32_t stagemask;
uint32_t rename_status;
uint32_t rename_score;
uint32_t mode_head;
uint32_t mode_index;
uint32_t mode_worktree;
uint32_t dirty_submodule;
uint32_t new_submodule_commits;
struct object_id oid_head;
struct object_id oid_index;
};
/*
* Consume the maximum amount of data possible in a
* packet-line record. This is overkill because we
* have at most 2 relative pathnames, but means we
* don't need to allocate a variable length structure.
*/
struct wt_status_serialize_data
{
struct wt_status_serialize_data_fixed fixed;
char variant[LARGE_PACKET_DATA_MAX
- sizeof(struct wt_status_serialize_data_fixed)];
};
enum wt_status_deserialize_wait
{
DESERIALIZE_WAIT__UNSET = -3,
DESERIALIZE_WAIT__FAIL = -2, /* return error, do not fallback */
DESERIALIZE_WAIT__BLOCK = -1, /* unlimited timeout */
DESERIALIZE_WAIT__NO = 0, /* immediately fallback */
/* any positive value is a timeout in tenths of a second */
};
/*
* Serialize computed status scan results using "version 1" format
* to the given file.
*/
void wt_status_serialize_v1(int fd, struct wt_status *s);
/*
* Deserialize existing status results from the given file and
* populate a (new) "struct wt_status". Use the contents of "cmd_s"
* (computed from the command line arguments) to verify that the
* cached data is compatible and overlay various display-related
* fields.
*/
int wt_status_deserialize(const struct wt_status *cmd_s,
const char *path,
enum wt_status_deserialize_wait dw);
int wt_status_deserialize_access(const char *path, int mode);
/*
* A helper routine for serialize and deserialize to compute
* metadata for the user-global and repo-local excludes files.
*/
void wt_serialize_compute_exclude_header(struct strbuf *sb,
const char *key,
const char *path);
#endif /* STATUS_H */