sequencer.h

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