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