sequencer: make the todo_list structure public
[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);
26ae337b 13
bab4d109
BC
14#define APPEND_SIGNOFF_DEDUP (1u << 0)
15
043a4492
RR
16enum replay_action {
17 REPLAY_REVERT,
84583957
JS
18 REPLAY_PICK,
19 REPLAY_INTERACTIVE_REBASE
043a4492
RR
20};
21
28d6daed
PW
22enum commit_msg_cleanup_mode {
23 COMMIT_MSG_CLEANUP_SPACE,
24 COMMIT_MSG_CLEANUP_NONE,
25 COMMIT_MSG_CLEANUP_SCISSORS,
26 COMMIT_MSG_CLEANUP_ALL
27};
28
043a4492
RR
29struct replay_opts {
30 enum replay_action action;
043a4492
RR
31
32 /* Boolean options */
33 int edit;
34 int record_origin;
35 int no_commit;
36 int signoff;
37 int allow_ff;
38 int allow_rerere_auto;
df478b74 39 int allow_empty;
4bee9584 40 int allow_empty_message;
b27cfb0d 41 int keep_redundant_commits;
556907f1 42 int verbose;
043a4492
RR
43
44 int mainline;
45
03a4e260 46 char *gpg_sign;
28d6daed 47 enum commit_msg_cleanup_mode default_msg_cleanup;
3253553e 48
043a4492 49 /* Merge strategy */
03a4e260
JS
50 char *strategy;
51 char **xopts;
043a4492
RR
52 size_t xopts_nr, xopts_alloc;
53
e12a7ef5
JS
54 /* Used by fixup/squash */
55 struct strbuf current_fixups;
56 int current_fixup_count;
57
d87d48b2
JS
58 /* placeholder commit for -i --root */
59 struct object_id squash_onto;
60 int have_squash_onto;
61
043a4492
RR
62 /* Only used by REPLAY_NONE */
63 struct rev_info *revs;
64};
e12a7ef5 65#define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
043a4492 66
44b776c3
AG
67enum missing_commit_check_level {
68 MISSING_COMMIT_CHECK_IGNORE = 0,
69 MISSING_COMMIT_CHECK_WARN,
70 MISSING_COMMIT_CHECK_ERROR
71};
72
73int write_message(const void *buf, size_t len, const char *filename,
74 int append_eol);
75
5d94d545
AG
76/*
77 * Note that ordering matters in this enum. Not only must it match the mapping
78 * of todo_command_info (in sequencer.c), it is also divided into several
79 * sections that matter. When adding new commands, make sure you add it in the
80 * right section.
81 */
82enum todo_command {
83 /* commands that handle commits */
84 TODO_PICK = 0,
85 TODO_REVERT,
86 TODO_EDIT,
87 TODO_REWORD,
88 TODO_FIXUP,
89 TODO_SQUASH,
90 /* commands that do something else than handling a single commit */
91 TODO_EXEC,
92 TODO_BREAK,
93 TODO_LABEL,
94 TODO_RESET,
95 TODO_MERGE,
96 /* commands that do nothing but are counted for reporting progress */
97 TODO_NOOP,
98 TODO_DROP,
99 /* comments (not counted for reporting progress) */
100 TODO_COMMENT
101};
102
103struct todo_item {
104 enum todo_command command;
105 struct commit *commit;
106 unsigned int flags;
107 const char *arg;
108 int arg_len;
109 size_t offset_in_buf;
110};
111
112struct todo_list {
113 struct strbuf buf;
114 struct todo_item *items;
115 int nr, alloc, current;
116 int done_nr, total_nr;
117 struct stat_data stat;
118};
119
120#define TODO_LIST_INIT { STRBUF_INIT }
121
122int todo_list_parse_insn_buffer(struct repository *r, char *buf,
123 struct todo_list *todo_list);
124void todo_list_release(struct todo_list *todo_list);
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);
2863584f 132int sequencer_remove_state(struct replay_opts *opts);
043a4492 133
313a48ea
LB
134#define TODO_LIST_KEEP_EMPTY (1U << 0)
135#define TODO_LIST_SHORTEN_IDS (1U << 1)
d8ae6c84 136#define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
1644c73c 137#define TODO_LIST_REBASE_MERGES (1U << 3)
7543f6f4
JS
138/*
139 * When rebasing merges, commits that do have the base commit as ancestor
140 * ("cousins") are *not* rebased onto the new base by default. If those
141 * commits should be rebased onto the new base, this flag needs to be passed.
142 */
143#define TODO_LIST_REBASE_COUSINS (1U << 4)
f11c9580
NTND
144int sequencer_make_script(struct repository *repo, FILE *out,
145 int argc, const char **argv,
313a48ea 146 unsigned flags);
62db5247 147
005af339
NTND
148int sequencer_add_exec_commands(struct repository *r, const char *command);
149int transform_todos(struct repository *r, unsigned flags);
44b776c3 150enum missing_commit_check_level get_missing_commit_check_level(void);
005af339
NTND
151int check_todo_list(struct repository *r);
152int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
b97e1873
AG
153 const char *shortrevisions, const char *onto_name,
154 const char *onto, const char *orig_head, const char *cmd,
155 unsigned autosquash);
005af339 156int rearrange_squash(struct repository *r);
3546c8d9 157
5ed75e2a
MV
158extern const char sign_off_header[];
159
66e83d9b
JK
160/*
161 * Append a signoff to the commit message in "msgbuf". The ignore_footer
162 * parameter specifies the number of bytes at the end of msgbuf that should
163 * not be considered at all. I.e., they are not checked for existing trailers,
164 * and the new signoff will be spliced into the buffer before those bytes.
165 */
166void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
167
f11c9580 168void append_conflicts_hint(struct index_state *istate, struct strbuf *msgbuf);
d0aaa46f
PW
169int message_is_empty(const struct strbuf *sb,
170 enum commit_msg_cleanup_mode cleanup_mode);
171int template_untouched(const struct strbuf *sb, const char *template_file,
172 enum commit_msg_cleanup_mode cleanup_mode);
0505d604
PW
173int update_head_with_reflog(const struct commit *old_head,
174 const struct object_id *new_head,
175 const char *action, const struct strbuf *msg,
176 struct strbuf *err);
a87a6f3c
PW
177void commit_post_rewrite(const struct commit *current_head,
178 const struct object_id *new_head);
5ed75e2a 179
2c58483a
AG
180int prepare_branch_to_be_rebased(struct replay_opts *opts, const char *commit);
181
e47c6caf
PW
182#define SUMMARY_INITIAL_COMMIT (1 << 0)
183#define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
f11c9580
NTND
184void print_commit_summary(struct repository *repo,
185 const char *prefix,
186 const struct object_id *oid,
e47c6caf 187 unsigned int flags);
bcd33ec2
PW
188
189int read_author_script(const char *path, char **name, char **email, char **date,
190 int allow_missing);
26ae337b 191#endif
65850686
AG
192
193void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
194int write_basic_state(struct replay_opts *opts, const char *head_name,
195 const char *onto, const char *orig_head);