sequencer: refactor transform_todos() to work on a todo_list
[git/git.git] / sequencer.h
... / ...
CommitLineData
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);
13
14#define APPEND_SIGNOFF_DEDUP (1u << 0)
15
16enum replay_action {
17 REPLAY_REVERT,
18 REPLAY_PICK,
19 REPLAY_INTERACTIVE_REBASE
20};
21
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
29struct replay_opts {
30 enum replay_action action;
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;
39 int allow_empty;
40 int allow_empty_message;
41 int keep_redundant_commits;
42 int verbose;
43
44 int mainline;
45
46 char *gpg_sign;
47 enum commit_msg_cleanup_mode default_msg_cleanup;
48
49 /* Merge strategy */
50 char *strategy;
51 char **xopts;
52 size_t xopts_nr, xopts_alloc;
53
54 /* Used by fixup/squash */
55 struct strbuf current_fixups;
56 int current_fixup_count;
57
58 /* placeholder commit for -i --root */
59 struct object_id squash_onto;
60 int have_squash_onto;
61
62 /* Only used by REPLAY_NONE */
63 struct rev_info *revs;
64};
65#define REPLAY_OPTS_INIT { .action = -1, .current_fixups = STRBUF_INIT }
66
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
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 int arg_len;
108 /* The offset of the command and its argument in the strbuf */
109 size_t offset_in_buf, arg_offset;
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_transform(struct repository *r, struct todo_list *todo_list,
125 unsigned flags);
126void todo_list_release(struct todo_list *todo_list);
127const char *todo_item_get_arg(struct todo_list *todo_list,
128 struct todo_item *item);
129
130/* Call this to setup defaults before parsing command line options */
131void sequencer_init_config(struct replay_opts *opts);
132int sequencer_pick_revisions(struct repository *repo,
133 struct replay_opts *opts);
134int sequencer_continue(struct repository *repo, struct replay_opts *opts);
135int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
136int sequencer_remove_state(struct replay_opts *opts);
137
138#define TODO_LIST_KEEP_EMPTY (1U << 0)
139#define TODO_LIST_SHORTEN_IDS (1U << 1)
140#define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
141#define TODO_LIST_REBASE_MERGES (1U << 3)
142/*
143 * When rebasing merges, commits that do have the base commit as ancestor
144 * ("cousins") are *not* rebased onto the new base by default. If those
145 * commits should be rebased onto the new base, this flag needs to be passed.
146 */
147#define TODO_LIST_REBASE_COUSINS (1U << 4)
148int sequencer_make_script(struct repository *repo, FILE *out,
149 int argc, const char **argv,
150 unsigned flags);
151
152int sequencer_add_exec_commands(struct repository *r, const char *command);
153int transform_todo_file(struct repository *r, unsigned flags);
154enum missing_commit_check_level get_missing_commit_check_level(void);
155int check_todo_list(struct repository *r);
156int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
157 const char *shortrevisions, const char *onto_name,
158 const char *onto, const char *orig_head, const char *cmd,
159 unsigned autosquash);
160int rearrange_squash(struct repository *r);
161
162extern const char sign_off_header[];
163
164/*
165 * Append a signoff to the commit message in "msgbuf". The ignore_footer
166 * parameter specifies the number of bytes at the end of msgbuf that should
167 * not be considered at all. I.e., they are not checked for existing trailers,
168 * and the new signoff will be spliced into the buffer before those bytes.
169 */
170void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
171
172void append_conflicts_hint(struct index_state *istate, struct strbuf *msgbuf);
173int message_is_empty(const struct strbuf *sb,
174 enum commit_msg_cleanup_mode cleanup_mode);
175int template_untouched(const struct strbuf *sb, const char *template_file,
176 enum commit_msg_cleanup_mode cleanup_mode);
177int update_head_with_reflog(const struct commit *old_head,
178 const struct object_id *new_head,
179 const char *action, const struct strbuf *msg,
180 struct strbuf *err);
181void commit_post_rewrite(const struct commit *current_head,
182 const struct object_id *new_head);
183
184int prepare_branch_to_be_rebased(struct replay_opts *opts, const char *commit);
185
186#define SUMMARY_INITIAL_COMMIT (1 << 0)
187#define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
188void print_commit_summary(struct repository *repo,
189 const char *prefix,
190 const struct object_id *oid,
191 unsigned int flags);
192
193int read_author_script(const char *path, char **name, char **email, char **date,
194 int allow_missing);
195#endif
196
197void parse_strategy_opts(struct replay_opts *opts, char *raw_opts);
198int write_basic_state(struct replay_opts *opts, const char *head_name,
199 const char *onto, const char *orig_head);