| 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 | extern const char *rebase_resolvemsg; |
| 18 | |
| 19 | #define APPEND_SIGNOFF_DEDUP (1u << 0) |
| 20 | |
| 21 | enum replay_action { |
| 22 | REPLAY_REVERT, |
| 23 | REPLAY_PICK, |
| 24 | REPLAY_INTERACTIVE_REBASE |
| 25 | }; |
| 26 | |
| 27 | enum commit_msg_cleanup_mode { |
| 28 | COMMIT_MSG_CLEANUP_SPACE, |
| 29 | COMMIT_MSG_CLEANUP_NONE, |
| 30 | COMMIT_MSG_CLEANUP_SCISSORS, |
| 31 | COMMIT_MSG_CLEANUP_ALL |
| 32 | }; |
| 33 | |
| 34 | struct replay_ctx; |
| 35 | struct replay_ctx* replay_ctx_new(void); |
| 36 | |
| 37 | struct replay_opts { |
| 38 | enum replay_action action; |
| 39 | |
| 40 | /* Tri-state options: unspecified, false, or true */ |
| 41 | int edit; |
| 42 | |
| 43 | /* Boolean options */ |
| 44 | int record_origin; |
| 45 | int no_commit; |
| 46 | int signoff; |
| 47 | int allow_ff; |
| 48 | int allow_rerere_auto; |
| 49 | int allow_empty; |
| 50 | int allow_empty_message; |
| 51 | int drop_redundant_commits; |
| 52 | int keep_redundant_commits; |
| 53 | int verbose; |
| 54 | int quiet; |
| 55 | int reschedule_failed_exec; |
| 56 | int committer_date_is_author_date; |
| 57 | int ignore_date; |
| 58 | int commit_use_reference; |
| 59 | |
| 60 | struct strvec trailer_args; |
| 61 | |
| 62 | int mainline; |
| 63 | |
| 64 | char *gpg_sign; |
| 65 | enum commit_msg_cleanup_mode default_msg_cleanup; |
| 66 | int explicit_cleanup; |
| 67 | |
| 68 | /* Merge strategy */ |
| 69 | char *default_strategy; /* from config options */ |
| 70 | char *strategy; |
| 71 | struct strvec xopts; |
| 72 | |
| 73 | /* Reflog */ |
| 74 | char *reflog_action; |
| 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 | .trailer_args = STRVEC_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, struct replay_opts *opts, |
| 143 | char *buf, 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, |
| 193 | struct strvec *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 | const char *message, bool silent); |
| 234 | int save_autostash(const char *path); |
| 235 | int save_autostash_ref(struct repository *r, const char *refname); |
| 236 | int apply_autostash(const char *path); |
| 237 | int apply_autostash_oid(const char *stash_oid); |
| 238 | int apply_autostash_ref(struct repository *r, const char *refname, |
| 239 | const char *label_ours, const char *label_theirs, |
| 240 | const char *label_base, const char *stash_msg); |
| 241 | |
| 242 | #define SUMMARY_INITIAL_COMMIT (1 << 0) |
| 243 | #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1) |
| 244 | void print_commit_summary(struct repository *repo, |
| 245 | const char *prefix, |
| 246 | const struct object_id *oid, |
| 247 | unsigned int flags); |
| 248 | |
| 249 | #define READ_ONELINER_SKIP_IF_EMPTY (1 << 0) |
| 250 | #define READ_ONELINER_WARN_MISSING (1 << 1) |
| 251 | |
| 252 | /* |
| 253 | * Reads a file that was presumably written by a shell script, i.e. with an |
| 254 | * end-of-line marker that needs to be stripped. |
| 255 | * |
| 256 | * Note that only the last end-of-line marker is stripped, consistent with the |
| 257 | * behavior of "$(cat path)" in a shell script. |
| 258 | * |
| 259 | * Returns 1 if the file was read, 0 if it could not be read or does not exist. |
| 260 | */ |
| 261 | int read_oneliner(struct strbuf *buf, |
| 262 | const char *path, unsigned flags); |
| 263 | int read_author_script(const char *path, char **name, char **email, char **date, |
| 264 | int allow_missing); |
| 265 | int write_basic_state(struct replay_opts *opts, const char *head_name, |
| 266 | struct commit *onto, const struct object_id *orig_head); |
| 267 | void sequencer_post_commit_cleanup(struct repository *r, int verbose); |
| 268 | int sequencer_get_last_command(struct repository* r, |
| 269 | enum replay_action *action); |
| 270 | int sequencer_determine_whence(struct repository *r, enum commit_whence *whence); |
| 271 | |
| 272 | /** |
| 273 | * Append the set of ref-OID pairs that are currently stored for the 'git |
| 274 | * rebase --update-refs' feature if such a rebase is currently happening. |
| 275 | * |
| 276 | * Localized to a worktree's git dir. |
| 277 | */ |
| 278 | int sequencer_get_update_refs_state(const char *wt_dir, struct string_list *refs); |
| 279 | |
| 280 | /* |
| 281 | * Format a revert commit message with appropriate 'Revert "<subject>"' or |
| 282 | * 'Reapply "<subject>"' prefix and 'This reverts commit <ref>.' body. |
| 283 | * When use_commit_reference is set, <ref> is an abbreviated hash with |
| 284 | * subject and date; otherwise the full hex hash is used. |
| 285 | */ |
| 286 | void sequencer_format_revert_message(struct repository *r, |
| 287 | const char *subject, |
| 288 | const struct commit *commit, |
| 289 | const struct commit *parent, |
| 290 | bool use_commit_reference, |
| 291 | struct strbuf *message); |
| 292 | |
| 293 | #endif /* SEQUENCER_H */ |