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