Merge branch 'rs/nth-switch-code-simplification'
[git/git.git] / sequencer.h
CommitLineData
26ae337b
RR
1#ifndef SEQUENCER_H
2#define SEQUENCER_H
3
ef3ca954
EN
4#include "cache.h"
5#include "strbuf.h"
6
7struct commit;
f11c9580 8struct repository;
ef3ca954 9
66618a50 10const char *git_path_commit_editmsg(void);
8a2a0f53 11const char *git_path_seq_dir(void);
44b776c3 12const char *rebase_path_todo(void);
a930eb03 13const char *rebase_path_todo_backup(void);
26ae337b 14
bab4d109
BC
15#define APPEND_SIGNOFF_DEDUP (1u << 0)
16
043a4492
RR
17enum replay_action {
18 REPLAY_REVERT,
84583957
JS
19 REPLAY_PICK,
20 REPLAY_INTERACTIVE_REBASE
043a4492
RR
21};
22
28d6daed
PW
23enum commit_msg_cleanup_mode {
24 COMMIT_MSG_CLEANUP_SPACE,
25 COMMIT_MSG_CLEANUP_NONE,
26 COMMIT_MSG_CLEANUP_SCISSORS,
27 COMMIT_MSG_CLEANUP_ALL
28};
29
043a4492
RR
30struct replay_opts {
31 enum replay_action action;
043a4492
RR
32
33 /* Boolean options */
34 int edit;
35 int record_origin;
36 int no_commit;
37 int signoff;
38 int allow_ff;
39 int allow_rerere_auto;
df478b74 40 int allow_empty;
4bee9584 41 int allow_empty_message;
b27cfb0d 42 int keep_redundant_commits;
556907f1 43 int verbose;
899b49c4 44 int quiet;
d421afa0 45 int reschedule_failed_exec;
043a4492
RR
46
47 int mainline;
48
03a4e260 49 char *gpg_sign;
28d6daed 50 enum commit_msg_cleanup_mode default_msg_cleanup;
d74f3e58 51 int explicit_cleanup;
3253553e 52
043a4492 53 /* Merge strategy */
03a4e260
JS
54 char *strategy;
55 char **xopts;
043a4492
RR
56 size_t xopts_nr, xopts_alloc;
57
e12a7ef5
JS
58 /* Used by fixup/squash */
59 struct strbuf current_fixups;
60 int current_fixup_count;
61
d87d48b2
JS
62 /* placeholder commit for -i --root */
63 struct object_id squash_onto;
64 int have_squash_onto;
65
043a4492
RR
66 /* Only used by REPLAY_NONE */
67 struct rev_info *revs;
68};
e12a7ef5 69#define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
043a4492 70
5d94d545
AG
71/*
72 * Note that ordering matters in this enum. Not only must it match the mapping
73 * of todo_command_info (in sequencer.c), it is also divided into several
74 * sections that matter. When adding new commands, make sure you add it in the
75 * right section.
76 */
77enum todo_command {
78 /* commands that handle commits */
79 TODO_PICK = 0,
80 TODO_REVERT,
81 TODO_EDIT,
82 TODO_REWORD,
83 TODO_FIXUP,
84 TODO_SQUASH,
85 /* commands that do something else than handling a single commit */
86 TODO_EXEC,
87 TODO_BREAK,
88 TODO_LABEL,
89 TODO_RESET,
90 TODO_MERGE,
91 /* commands that do nothing but are counted for reporting progress */
92 TODO_NOOP,
93 TODO_DROP,
94 /* comments (not counted for reporting progress) */
95 TODO_COMMENT
44b776c3
AG
96};
97
5d94d545
AG
98struct todo_item {
99 enum todo_command command;
100 struct commit *commit;
101 unsigned int flags;
5d94d545 102 int arg_len;
6ad656db
AG
103 /* The offset of the command and its argument in the strbuf */
104 size_t offset_in_buf, arg_offset;
5d94d545
AG
105};
106
107struct todo_list {
108 struct strbuf buf;
109 struct todo_item *items;
110 int nr, alloc, current;
111 int done_nr, total_nr;
112 struct stat_data stat;
113};
114
115#define TODO_LIST_INIT { STRBUF_INIT }
116
117int todo_list_parse_insn_buffer(struct repository *r, char *buf,
118 struct todo_list *todo_list);
616d7740
AG
119int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
120 const char *file, const char *shortrevisions,
121 const char *shortonto, int num, unsigned flags);
5d94d545 122void todo_list_release(struct todo_list *todo_list);
6ad656db
AG
123const char *todo_item_get_arg(struct todo_list *todo_list,
124 struct todo_item *item);
44b776c3 125
28d6daed
PW
126/* Call this to setup defaults before parsing command line options */
127void sequencer_init_config(struct replay_opts *opts);
f11c9580
NTND
128int sequencer_pick_revisions(struct repository *repo,
129 struct replay_opts *opts);
130int sequencer_continue(struct repository *repo, struct replay_opts *opts);
005af339 131int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
de81ca3f 132int sequencer_skip(struct repository *repo, struct replay_opts *opts);
2863584f 133int sequencer_remove_state(struct replay_opts *opts);
043a4492 134
313a48ea
LB
135#define TODO_LIST_KEEP_EMPTY (1U << 0)
136#define TODO_LIST_SHORTEN_IDS (1U << 1)
d8ae6c84 137#define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
1644c73c 138#define TODO_LIST_REBASE_MERGES (1U << 3)
7543f6f4
JS
139/*
140 * When rebasing merges, commits that do have the base commit as ancestor
141 * ("cousins") are *not* rebased onto the new base by default. If those
142 * commits should be rebased onto the new base, this flag needs to be passed.
143 */
144#define TODO_LIST_REBASE_COUSINS (1U << 4)
616d7740 145#define TODO_LIST_APPEND_TODO_HELP (1U << 5)
e1fac531
JS
146/*
147 * When generating a script that rebases merges with `--root` *and* with
148 * `--onto`, we do not want to re-generate the root commits.
149 */
150#define TODO_LIST_ROOT_WITH_ONTO (1U << 6)
151
616d7740 152
d358fc28
AG
153int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
154 const char **argv, unsigned flags);
62db5247 155
1ba204de
AG
156void todo_list_add_exec_commands(struct todo_list *todo_list,
157 struct string_list *commands);
6ca89c6f 158int check_todo_list_from_file(struct repository *r);
005af339 159int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
b97e1873 160 const char *shortrevisions, const char *onto_name,
7d3488eb 161 struct commit *onto, const char *orig_head, struct string_list *commands,
94bcad79 162 unsigned autosquash, struct todo_list *todo_list);
79d7e883 163int todo_list_rearrange_squash(struct todo_list *todo_list);
3546c8d9 164
66e83d9b
JK
165/*
166 * Append a signoff to the commit message in "msgbuf". The ignore_footer
167 * parameter specifies the number of bytes at the end of msgbuf that should
168 * not be considered at all. I.e., they are not checked for existing trailers,
169 * and the new signoff will be spliced into the buffer before those bytes.
170 */
171void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
172
1a2b985f
DL
173void append_conflicts_hint(struct index_state *istate,
174 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
f29cd862
DL
175enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
176 int use_editor);
177
178void cleanup_message(struct strbuf *msgbuf,
179 enum commit_msg_cleanup_mode cleanup_mode, int verbose);
180
d0aaa46f
PW
181int message_is_empty(const struct strbuf *sb,
182 enum commit_msg_cleanup_mode cleanup_mode);
183int template_untouched(const struct strbuf *sb, const char *template_file,
184 enum commit_msg_cleanup_mode cleanup_mode);
0505d604
PW
185int update_head_with_reflog(const struct commit *old_head,
186 const struct object_id *new_head,
187 const char *action, const struct strbuf *msg,
188 struct strbuf *err);
1d18d758
NTND
189void commit_post_rewrite(struct repository *r,
190 const struct commit *current_head,
a87a6f3c 191 const struct object_id *new_head);
5ed75e2a 192
fc4a6735
PW
193int prepare_branch_to_be_rebased(struct repository *r, struct replay_opts *opts,
194 const char *commit);
2c58483a 195
e47c6caf
PW
196#define SUMMARY_INITIAL_COMMIT (1 << 0)
197#define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
f11c9580
NTND
198void print_commit_summary(struct repository *repo,
199 const char *prefix,
200 const struct object_id *oid,
e47c6caf 201 unsigned int flags);
bcd33ec2
PW
202
203int read_author_script(const char *path, char **name, char **email, char **date,
204 int allow_missing);
26ae337b 205#endif
65850686
AG
206
207void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
208int write_basic_state(struct replay_opts *opts, const char *head_name,
7d3488eb 209 struct commit *onto, const char *orig_head);
f496b064 210void sequencer_post_commit_cleanup(struct repository *r, int verbose);
4a72486d
PW
211int sequencer_get_last_command(struct repository* r,
212 enum replay_action *action);