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