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