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