1#ifndef SEQUENCER_H
2#define SEQUENCER_H
3
4#include "cache.h"
5#include "strbuf.h"
6
7struct commit;
8struct repository;
9
10const char *git_path_commit_editmsg(void);
11const char *git_path_seq_dir(void);
12const char *rebase_path_todo(void);
13const char *rebase_path_todo_backup(void);
14
15#define APPEND_SIGNOFF_DEDUP (1u << 0)
16
17enum replay_action {
18 REPLAY_REVERT,
19 REPLAY_PICK,
20 REPLAY_INTERACTIVE_REBASE
21};
22
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
30struct replay_opts {
31 enum replay_action action;
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;
40 int allow_empty;
41 int allow_empty_message;
42 int keep_redundant_commits;
43 int verbose;
44
45 int mainline;
46
47 char *gpg_sign;
48 enum commit_msg_cleanup_mode default_msg_cleanup;
49
50 /* Merge strategy */
51 char *strategy;
52 char **xopts;
53 size_t xopts_nr, xopts_alloc;
54
55 /* Used by fixup/squash */
56 struct strbuf current_fixups;
57 int current_fixup_count;
58
59 /* placeholder commit for -i --root */
60 struct object_id squash_onto;
61 int have_squash_onto;
62
63 /* Only used by REPLAY_NONE */
64 struct rev_info *revs;
65};
66#define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
67
68/*
69 * Note that ordering matters in this enum. Not only must it match the mapping
70 * of todo_command_info (in sequencer.c), it is also divided into several
71 * sections that matter. When adding new commands, make sure you add it in the
72 * right section.
73 */
74enum todo_command {
75 /* commands that handle commits */
76 TODO_PICK = 0,
77 TODO_REVERT,
78 TODO_EDIT,
79 TODO_REWORD,
80 TODO_FIXUP,
81 TODO_SQUASH,
82 /* commands that do something else than handling a single commit */
83 TODO_EXEC,
84 TODO_BREAK,
85 TODO_LABEL,
86 TODO_RESET,
87 TODO_MERGE,
88 /* commands that do nothing but are counted for reporting progress */
89 TODO_NOOP,
90 TODO_DROP,
91 /* comments (not counted for reporting progress) */
92 TODO_COMMENT
93};
94
95struct todo_item {
96 enum todo_command command;
97 struct commit *commit;
98 unsigned int flags;
99 int arg_len;
100 /* The offset of the command and its argument in the strbuf */
101 size_t offset_in_buf, arg_offset;
102};
103
104struct todo_list {
105 struct strbuf buf;
106 struct todo_item *items;
107 int nr, alloc, current;
108 int done_nr, total_nr;
109 struct stat_data stat;
110};
111
112#define TODO_LIST_INIT { STRBUF_INIT }
113
114int todo_list_parse_insn_buffer(struct repository *r, char *buf,
115 struct todo_list *todo_list);
116int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
117 const char *file, const char *shortrevisions,
118 const char *shortonto, int num, unsigned flags);
119void todo_list_release(struct todo_list *todo_list);
120const char *todo_item_get_arg(struct todo_list *todo_list,
121 struct todo_item *item);
122
123/* Call this to setup defaults before parsing command line options */
124void sequencer_init_config(struct replay_opts *opts);
125int sequencer_pick_revisions(struct repository *repo,
126 struct replay_opts *opts);
127int sequencer_continue(struct repository *repo, struct replay_opts *opts);
128int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
129int sequencer_remove_state(struct replay_opts *opts);
130
131#define TODO_LIST_KEEP_EMPTY (1U << 0)
132#define TODO_LIST_SHORTEN_IDS (1U << 1)
133#define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
134#define TODO_LIST_REBASE_MERGES (1U << 3)
135/*
136 * When rebasing merges, commits that do have the base commit as ancestor
137 * ("cousins") are *not* rebased onto the new base by default. If those
138 * commits should be rebased onto the new base, this flag needs to be passed.
139 */
140#define TODO_LIST_REBASE_COUSINS (1U << 4)
141#define TODO_LIST_APPEND_TODO_HELP (1U << 5)
142
143int sequencer_make_script(struct repository *r, struct strbuf *out, int argc,
144 const char **argv, unsigned flags);
145
146void todo_list_add_exec_commands(struct todo_list *todo_list,
147 struct string_list *commands);
148int check_todo_list_from_file(struct repository *r);
149int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
150 const char *shortrevisions, const char *onto_name,
151 const char *onto, const char *orig_head, struct string_list *commands,
152 unsigned autosquash, struct todo_list *todo_list);
153int todo_list_rearrange_squash(struct todo_list *todo_list);
154
155extern const char sign_off_header[];
156
157/*
158 * Append a signoff to the commit message in "msgbuf". The ignore_footer
159 * parameter specifies the number of bytes at the end of msgbuf that should
160 * not be considered at all. I.e., they are not checked for existing trailers,
161 * and the new signoff will be spliced into the buffer before those bytes.
162 */
163void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
164
165void append_conflicts_hint(struct index_state *istate, struct strbuf *msgbuf);
166int message_is_empty(const struct strbuf *sb,
167 enum commit_msg_cleanup_mode cleanup_mode);
168int template_untouched(const struct strbuf *sb, const char *template_file,
169 enum commit_msg_cleanup_mode cleanup_mode);
170int update_head_with_reflog(const struct commit *old_head,
171 const struct object_id *new_head,
172 const char *action, const struct strbuf *msg,
173 struct strbuf *err);
174void commit_post_rewrite(const struct commit *current_head,
175 const struct object_id *new_head);
176
177int prepare_branch_to_be_rebased(struct replay_opts *opts, const char *commit);
178
179#define SUMMARY_INITIAL_COMMIT (1 << 0)
180#define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
181void print_commit_summary(struct repository *repo,
182 const char *prefix,
183 const struct object_id *oid,
184 unsigned int flags);
185
186int read_author_script(const char *path, char **name, char **email, char **date,
187 int allow_missing);
188#endif
189
190void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
191int write_basic_state(struct replay_opts *opts, const char *head_name,
192 const char *onto, const char *orig_head);