sequencer.h

   1 #ifndef SEQUENCER_H
   2 #define SEQUENCER_H
   3
   4 #include "strbuf.h"
   5 #include "strvec.h"
   6 #include "wt-status.h"
   7
   8 struct commit;
   9 struct index_state;
  10 struct repository;
  11
  12 const char *git_path_commit_editmsg(void);
  13 const char *rebase_path_todo(void);
  14 const char *rebase_path_todo_backup(void);
  15 const char *rebase_path_dropped(void);
  16
  17 extern const char *rebase_resolvemsg;
  18
  19 #define APPEND_SIGNOFF_DEDUP (1u << 0)
  20
  21 enum replay_action {
  22         REPLAY_REVERT,
  23         REPLAY_PICK,
  24         REPLAY_INTERACTIVE_REBASE
  25 };
  26
  27 enum commit_msg_cleanup_mode {
  28         COMMIT_MSG_CLEANUP_SPACE,
  29         COMMIT_MSG_CLEANUP_NONE,
  30         COMMIT_MSG_CLEANUP_SCISSORS,
  31         COMMIT_MSG_CLEANUP_ALL
  32 };
  33
  34 struct replay_opts {
  35         enum replay_action action;
  36
  37         /* Tri-state options: unspecified, false, or true */
  38         int edit;
  39
  40         /* Boolean options */
  41         int record_origin;
  42         int no_commit;
  43         int signoff;
  44         int allow_ff;
  45         int allow_rerere_auto;
  46         int allow_empty;
  47         int allow_empty_message;
  48         int drop_redundant_commits;
  49         int keep_redundant_commits;
  50         int verbose;
  51         int quiet;
  52         int reschedule_failed_exec;
  53         int committer_date_is_author_date;
  54         int ignore_date;
  55         int commit_use_reference;
  56
  57         int mainline;
  58
  59         char *gpg_sign;
  60         enum commit_msg_cleanup_mode default_msg_cleanup;
  61         int explicit_cleanup;
  62
  63         /* Merge strategy */
  64         char *default_strategy;  /* from config options */
  65         char *strategy;
  66         struct strvec xopts;
  67
  68         /* Reflog */
  69         char *reflog_action;
  70
  71         /* Used by fixup/squash */
  72         struct strbuf current_fixups;
  73         int current_fixup_count;
  74
  75         /* placeholder commit for -i --root */
  76         struct object_id squash_onto;
  77         int have_squash_onto;
  78
  79         /* Only used by REPLAY_NONE */
  80         struct rev_info *revs;
  81
  82         /* Private use */
  83         const char *reflog_message;
  84 };
  85 #define REPLAY_OPTS_INIT {                      \
  86         .edit = -1,                             \
  87         .action = -1,                           \
  88         .current_fixups = STRBUF_INIT,          \
  89         .xopts = STRVEC_INIT,                   \
  90 }
  91
  92 /*
  93  * Note that ordering matters in this enum. Not only must it match the mapping
  94  * of todo_command_info (in sequencer.c), it is also divided into several
  95  * sections that matter.  When adding new commands, make sure you add it in the
  96  * right section.
  97  */
  98 enum todo_command {
  99         /* commands that handle commits */
 100         TODO_PICK = 0,
 101         TODO_REVERT,
 102         TODO_EDIT,
 103         TODO_REWORD,
 104         TODO_FIXUP,
 105         TODO_SQUASH,
 106         /* commands that do something else than handling a single commit */
 107         TODO_EXEC,
 108         TODO_BREAK,
 109         TODO_LABEL,
 110         TODO_RESET,
 111         TODO_MERGE,
 112         TODO_UPDATE_REF,
 113         /* commands that do nothing but are counted for reporting progress */
 114         TODO_NOOP,
 115         TODO_DROP,
 116         /* comments (not counted for reporting progress) */
 117         TODO_COMMENT
 118 };
 119
 120 struct todo_item {
 121         enum todo_command command;
 122         struct commit *commit;
 123         unsigned int flags;
 124         int arg_len;
 125         /* The offset of the command and its argument in the strbuf */
 126         size_t offset_in_buf, arg_offset;
 127 };
 128
 129 struct todo_list {
 130         struct strbuf buf;
 131         struct todo_item *items;
 132         int nr, alloc, current;
 133         int done_nr, total_nr;
 134 };
 135
 136 #define TODO_LIST_INIT { \
 137         .buf = STRBUF_INIT, \
 138 }
 139
 140 int todo_list_parse_insn_buffer(struct repository *r, char *buf,
 141                                 struct todo_list *todo_list);
 142 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
 143                             const char *file, const char *shortrevisions,
 144                             const char *shortonto, int num, unsigned flags);
 145 void todo_list_release(struct todo_list *todo_list);
 146 const char *todo_item_get_arg(struct todo_list *todo_list,
 147                               struct todo_item *item);
 148
 149 /*
 150  * Parse the update-refs file for the current rebase, then remove the
 151  * refs that do not appear in the todo_list (and have not had updated
 152  * values stored) and add refs that are in the todo_list but not
 153  * represented in the update-refs file.
 154  *
 155  * If there are changes to the update-refs list, then write the new state
 156  * to disk.
 157  */
 158 void todo_list_filter_update_refs(struct repository *r,
 159                                   struct todo_list *todo_list);
 160
 161 /* Call this to setup defaults before parsing command line options */
 162 void sequencer_init_config(struct replay_opts *opts);
 163 int sequencer_pick_revisions(struct repository *repo,
 164                              struct replay_opts *opts);
 165 int sequencer_continue(struct repository *repo, struct replay_opts *opts);
 166 int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
 167 int sequencer_skip(struct repository *repo, struct replay_opts *opts);
 168 void replay_opts_release(struct replay_opts *opts);
 169 int sequencer_remove_state(struct replay_opts *opts);
 170
 171 #define TODO_LIST_KEEP_EMPTY (1U << 0)
 172 #define TODO_LIST_SHORTEN_IDS (1U << 1)
 173 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
 174 #define TODO_LIST_REBASE_MERGES (1U << 3)
 175 /*
 176  * When rebasing merges, commits that do have the base commit as ancestor
 177  * ("cousins") are *not* rebased onto the new base by default. If those
 178  * commits should be rebased onto the new base, this flag needs to be passed.
 179  */
 180 #define TODO_LIST_REBASE_COUSINS (1U << 4)
 181 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
 182 /*
 183  * When generating a script that rebases merges with `--root` *and* with
 184  * `--onto`, we do not want to re-generate the root commits.
 185  */
 186 #define TODO_LIST_ROOT_WITH_ONTO (1U << 6)
 187 #define TODO_LIST_REAPPLY_CHERRY_PICKS (1U << 7)
 188 #define TODO_LIST_WARN_SKIPPED_CHERRY_PICKS (1U << 8)
 189
 190 int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
 191                           const char **argv, unsigned flags);
 192
 193 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
 194                     const char *shortrevisions, const char *onto_name,
 195                     struct commit *onto, const struct object_id *orig_head,
 196                     struct string_list *commands, unsigned autosquash,
 197                     unsigned update_refs,
 198                     struct todo_list *todo_list);
 199 int todo_list_rearrange_squash(struct todo_list *todo_list);
 200
 201 /*
 202  * Append a signoff to the commit message in "msgbuf". The ignore_footer
 203  * parameter specifies the number of bytes at the end of msgbuf that should
 204  * not be considered at all. I.e., they are not checked for existing trailers,
 205  * and the new signoff will be spliced into the buffer before those bytes.
 206  */
 207 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
 208
 209 void append_conflicts_hint(struct index_state *istate,
 210                 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
 211 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
 212         int use_editor);
 213
 214 void cleanup_message(struct strbuf *msgbuf,
 215         enum commit_msg_cleanup_mode cleanup_mode, int verbose);
 216
 217 int message_is_empty(const struct strbuf *sb,
 218                      enum commit_msg_cleanup_mode cleanup_mode);
 219 int template_untouched(const struct strbuf *sb, const char *template_file,
 220                        enum commit_msg_cleanup_mode cleanup_mode);
 221 int update_head_with_reflog(const struct commit *old_head,
 222                             const struct object_id *new_head,
 223                             const char *action, const struct strbuf *msg,
 224                             struct strbuf *err);
 225 void commit_post_rewrite(struct repository *r,
 226                          const struct commit *current_head,
 227                          const struct object_id *new_head);
 228
 229 void create_autostash(struct repository *r, const char *path);
 230 void create_autostash_ref(struct repository *r, const char *refname);
 231 int save_autostash(const char *path);
 232 int save_autostash_ref(struct repository *r, const char *refname);
 233 int apply_autostash(const char *path);
 234 int apply_autostash_oid(const char *stash_oid);
 235 int apply_autostash_ref(struct repository *r, const char *refname);
 236
 237 #define SUMMARY_INITIAL_COMMIT   (1 << 0)
 238 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
 239 void print_commit_summary(struct repository *repo,
 240                           const char *prefix,
 241                           const struct object_id *oid,
 242                           unsigned int flags);
 243
 244 #define READ_ONELINER_SKIP_IF_EMPTY (1 << 0)
 245 #define READ_ONELINER_WARN_MISSING (1 << 1)
 246
 247 /*
 248  * Reads a file that was presumably written by a shell script, i.e. with an
 249  * end-of-line marker that needs to be stripped.
 250  *
 251  * Note that only the last end-of-line marker is stripped, consistent with the
 252  * behavior of "$(cat path)" in a shell script.
 253  *
 254  * Returns 1 if the file was read, 0 if it could not be read or does not exist.
 255  */
 256 int read_oneliner(struct strbuf *buf,
 257         const char *path, unsigned flags);
 258 int read_author_script(const char *path, char **name, char **email, char **date,
 259                        int allow_missing);
 260 int write_basic_state(struct replay_opts *opts, const char *head_name,
 261                       struct commit *onto, const struct object_id *orig_head);
 262 void sequencer_post_commit_cleanup(struct repository *r, int verbose);
 263 int sequencer_get_last_command(struct repository* r,
 264                                enum replay_action *action);
 265 int sequencer_determine_whence(struct repository *r, enum commit_whence *whence);
 266
 267 /**
 268  * Append the set of ref-OID pairs that are currently stored for the 'git
 269  * rebase --update-refs' feature if such a rebase is currently happening.
 270  *
 271  * Localized to a worktree's git dir.
 272  */
 273 int sequencer_get_update_refs_state(const char *wt_dir, struct string_list *refs);
 274
 275 #endif /* SEQUENCER_H */