@leroysheep / rag-system
Code Commits Pulls CI/CD 82,128
seen
bisect jch maint master next seen test todo
h 332 lines 10.6 KB
Raw
1 #ifndef SEQUENCER_H
2 #define SEQUENCER_H
3
4 #include "strbuf.h"
5 #include "strvec.h"
6 #include "wt-status.h"
7
8 struct commit;
9 struct index_state;
10 struct repository;
11
12 const char *git_path_commit_editmsg(void);
13 const char *rebase_path_todo(void);
14 const char *rebase_path_todo_backup(void);
15 const char *rebase_path_dropped(void);
16
17 extern const char *rebase_resolvemsg;
18
19 #define APPEND_SIGNOFF_DEDUP (1u << 0)
20
21 enum replay_action {
22 REPLAY_REVERT,
23 REPLAY_PICK,
24 REPLAY_INTERACTIVE_REBASE
25 };
26
27 enum commit_msg_cleanup_mode {
28 COMMIT_MSG_CLEANUP_SPACE,
29 COMMIT_MSG_CLEANUP_NONE,
30 COMMIT_MSG_CLEANUP_SCISSORS,
31 COMMIT_MSG_CLEANUP_ALL
32 };
33
34 struct replay_ctx;
35 struct replay_ctx* replay_ctx_new(void);
36
37 struct replay_opts {
38 enum replay_action action;
39
40 /* Tri-state options: unspecified, false, or true */
41 int edit;
42
43 /* Boolean options */
44 int record_origin;
45 int no_commit;
46 int signoff;
47 int allow_ff;
48 int allow_rerere_auto;
49 int allow_empty;
50 int allow_empty_message;
51 int drop_redundant_commits;
52 int keep_redundant_commits;
53 int verbose;
54 int quiet;
55 int reschedule_failed_exec;
56 int committer_date_is_author_date;
57 int ignore_date;
58 int commit_use_reference;
59
60 struct strvec trailer_args;
61
62 int mainline;
63
64 char *gpg_sign;
65 enum commit_msg_cleanup_mode default_msg_cleanup;
66 int explicit_cleanup;
67
68 /* Merge strategy */
69 char *default_strategy; /* from config options */
70 char *strategy;
71 struct strvec xopts;
72
73 /* Reflog */
74 char *reflog_action;
75
76 /* placeholder commit for -i --root */
77 struct object_id squash_onto;
78 int have_squash_onto;
79
80 /* Only used by REPLAY_NONE */
81 struct rev_info *revs;
82
83 /* Private use */
84 struct replay_ctx *ctx;
85 };
86 #define REPLAY_OPTS_INIT { \
87 .edit = -1, \
88 .action = -1, \
89 .trailer_args = STRVEC_INIT, \
90 .xopts = STRVEC_INIT, \
91 .ctx = replay_ctx_new(), \
92 }
93
94 /*
95 * Note that ordering matters in this enum. Not only must it match the mapping
96 * of todo_command_info (in sequencer.c), it is also divided into several
97 * sections that matter. When adding new commands, make sure you add it in the
98 * right section.
99 */
100 enum todo_command {
101 /* commands that handle commits */
102 TODO_PICK = 0,
103 TODO_REVERT,
104 TODO_EDIT,
105 TODO_REWORD,
106 TODO_FIXUP,
107 TODO_SQUASH,
108 /* commands that do something else than handling a single commit */
109 TODO_EXEC,
110 TODO_BREAK,
111 TODO_LABEL,
112 TODO_RESET,
113 TODO_MERGE,
114 TODO_UPDATE_REF,
115 /* commands that do nothing but are counted for reporting progress */
116 TODO_NOOP,
117 TODO_DROP,
118 /* comments (not counted for reporting progress) */
119 TODO_COMMENT
120 };
121
122 /* Bits for the "flags" member of struct todo_item */
123 enum todo_item_flags {
124 TODO_EDIT_MERGE_MSG = (1 << 0),
125 TODO_REPLACE_FIXUP_MSG = (1 << 1),
126 TODO_EDIT_FIXUP_MSG = (1 << 2),
127 };
128
129 struct todo_item {
130 enum todo_command command;
131 struct commit *commit;
132 unsigned int flags;
133 int arg_len;
134 /* The offset of the command and its argument in the strbuf */
135 size_t offset_in_buf, arg_offset;
136 };
137
138 struct todo_list {
139 struct strbuf buf;
140 struct todo_item *items;
141 int nr, alloc, current;
142 int done_nr, total_nr;
143 };
144
145 #define TODO_LIST_INIT { \
146 .buf = STRBUF_INIT, \
147 }
148
149 int todo_list_parse_insn_buffer(struct repository *r, struct replay_opts *opts,
150 char *buf, struct todo_list *todo_list);
151 int todo_list_write_to_file(struct repository *r, struct todo_list *todo_list,
152 const char *file, const char *shortrevisions,
153 const char *shortonto, int num, unsigned flags);
154 void todo_list_release(struct todo_list *todo_list);
155 const char *todo_item_get_arg(struct todo_list *todo_list,
156 struct todo_item *item);
157
158 /*
159 * Parse the update-refs file for the current rebase, then remove the
160 * refs that do not appear in the todo_list (and have not had updated
161 * values stored) and add refs that are in the todo_list but not
162 * represented in the update-refs file.
163 *
164 * If there are changes to the update-refs list, then write the new state
165 * to disk.
166 */
167 void todo_list_filter_update_refs(struct repository *r,
168 struct todo_list *todo_list);
169
170 /* Call this to setup defaults before parsing command line options */
171 void sequencer_init_config(struct replay_opts *opts);
172 int sequencer_pick_revisions(struct repository *repo,
173 struct replay_opts *opts);
174 int sequencer_continue(struct repository *repo, struct replay_opts *opts);
175 int sequencer_rollback(struct repository *repo, struct replay_opts *opts);
176 int sequencer_skip(struct repository *repo, struct replay_opts *opts);
177 void replay_opts_release(struct replay_opts *opts);
178 int sequencer_remove_state(struct replay_opts *opts);
179
180 #define TODO_LIST_KEEP_EMPTY (1U << 0)
181 #define TODO_LIST_SHORTEN_IDS (1U << 1)
182 #define TODO_LIST_ABBREVIATE_CMDS (1U << 2)
183 #define TODO_LIST_REBASE_MERGES (1U << 3)
184 /*
185 * When rebasing merges, commits that do have the base commit as ancestor
186 * ("cousins") are *not* rebased onto the new base by default. If those
187 * commits should be rebased onto the new base, this flag needs to be passed.
188 */
189 #define TODO_LIST_REBASE_COUSINS (1U << 4)
190 #define TODO_LIST_APPEND_TODO_HELP (1U << 5)
191 /*
192 * When generating a script that rebases merges with `--root` *and* with
193 * `--onto`, we do not want to re-generate the root commits.
194 */
195 #define TODO_LIST_ROOT_WITH_ONTO (1U << 6)
196 #define TODO_LIST_REAPPLY_CHERRY_PICKS (1U << 7)
197 #define TODO_LIST_WARN_SKIPPED_CHERRY_PICKS (1U << 8)
198
199 int sequencer_make_script(struct repository *r, struct strbuf *out,
200 struct strvec *argv, unsigned flags);
201
202 int complete_action(struct repository *r, struct replay_opts *opts, unsigned flags,
203 const char *shortrevisions, const char *onto_name,
204 struct commit *onto, const struct object_id *orig_head,
205 struct string_list *commands, unsigned autosquash,
206 unsigned update_refs,
207 struct todo_list *todo_list);
208 int todo_list_rearrange_squash(struct todo_list *todo_list);
209
210 /*
211 * Append a signoff to the commit message in "msgbuf". The ignore_footer
212 * parameter specifies the number of bytes at the end of msgbuf that should
213 * not be considered at all. I.e., they are not checked for existing trailers,
214 * and the new signoff will be spliced into the buffer before those bytes.
215 */
216 void append_signoff(struct strbuf *msgbuf, size_t ignore_footer, unsigned flag);
217
218 /*
219 * Append the "This is a combination of N commits." banner that "git rebase
220 * -i" writes at the top of a squashed commit's message, commented out with
221 * the comment character.
222 */
223 void add_squash_combination_header(struct strbuf *buf, int n);
224
225 /*
226 * Append the header (1-based N) that "git rebase -i" writes above each message
227 * when squashing, commented out with the comment character. With SKIP it reads
228 * "The ... commit message will be skipped" for a message that is dropped (a
229 * fixup), otherwise "This is the ... commit message".
230 */
231 void add_squash_message_header(struct strbuf *buf, int n, int skip);
232
233 /*
234 * Return the length of the leading subject of BODY when it should be commented
235 * out in a squash message, or 0 otherwise. An "amend!" subject always
236 * qualifies; "squash!" and "fixup!" subjects only when SQUASHING, since a
237 * plain fixup chain keeps them.
238 */
239 size_t squash_subject_comment_len(const char *body, int squashing);
240
241 void append_conflicts_hint(struct index_state *istate,
242 struct strbuf *msgbuf, enum commit_msg_cleanup_mode cleanup_mode);
243 enum commit_msg_cleanup_mode get_cleanup_mode(const char *cleanup_arg,
244 int use_editor);
245
246 void cleanup_message(struct strbuf *msgbuf,
247 enum commit_msg_cleanup_mode cleanup_mode, int verbose);
248
249 int message_is_empty(const struct strbuf *sb,
250 enum commit_msg_cleanup_mode cleanup_mode);
251 int template_untouched(const struct strbuf *sb, const char *template_file,
252 enum commit_msg_cleanup_mode cleanup_mode);
253 int update_head_with_reflog(const struct commit *old_head,
254 const struct object_id *new_head,
255 const char *action, const struct strbuf *msg,
256 struct strbuf *err);
257 void commit_post_rewrite(struct repository *r,
258 const struct commit *current_head,
259 const struct object_id *new_head);
260
261 void create_autostash(struct repository *r, const char *path);
262 void create_autostash_ref(struct repository *r, const char *refname,
263 const char *message, bool silent);
264 int save_autostash(const char *path);
265 int save_autostash_ref(struct repository *r, const char *refname);
266 int apply_autostash(const char *path);
267 int apply_autostash_oid(const char *stash_oid);
268 int apply_autostash_ref(struct repository *r, const char *refname,
269 const char *label_ours, const char *label_theirs,
270 const char *label_base, const char *stash_msg,
271 bool *conflicted);
272
273 #define SUMMARY_INITIAL_COMMIT (1 << 0)
274 #define SUMMARY_SHOW_AUTHOR_DATE (1 << 1)
275 void print_commit_summary(struct repository *repo,
276 const char *prefix,
277 const struct object_id *oid,
278 unsigned int flags);
279
280 #define READ_ONELINER_SKIP_IF_EMPTY (1 << 0)
281 #define READ_ONELINER_WARN_MISSING (1 << 1)
282
283 /*
284 * Reads a file that was presumably written by a shell script, i.e. with an
285 * end-of-line marker that needs to be stripped.
286 *
287 * Note that only the last end-of-line marker is stripped, consistent with the
288 * behavior of "$(cat path)" in a shell script.
289 *
290 * Returns 1 if the file was read, 0 if it could not be read or does not exist.
291 */
292 int read_oneliner(struct strbuf *buf,
293 const char *path, unsigned flags);
294 int read_author_script(const char *path, char **name, char **email, char **date,
295 int allow_missing);
296 int write_basic_state(struct replay_opts *opts, const char *head_name,
297 struct commit *onto, const struct object_id *orig_head);
298 void sequencer_post_commit_cleanup(struct repository *r, int verbose);
299
300 /*
301 * Try to parse the todo command pointed to by *p. On success sets cmd,
302 * advances p and returns true. On failure returns false, leaves p and
303 * cmd unchanged.
304 */
305 bool sequencer_parse_todo_command(const char **p, enum todo_command *cmd);
306
307 int sequencer_get_last_command(struct repository* r,
308 enum replay_action *action);
309 int sequencer_determine_whence(struct repository *r, enum commit_whence *whence);
310
311 /**
312 * Append the set of ref-OID pairs that are currently stored for the 'git
313 * rebase --update-refs' feature if such a rebase is currently happening.
314 *
315 * Localized to a worktree's git dir.
316 */
317 int sequencer_get_update_refs_state(const char *wt_dir, struct string_list *refs);
318
319 /*
320 * Format a revert commit message with appropriate 'Revert "<subject>"' or
321 * 'Reapply "<subject>"' prefix and 'This reverts commit <ref>.' body.
322 * When use_commit_reference is set, <ref> is an abbreviated hash with
323 * subject and date; otherwise the full hex hash is used.
324 */
325 void sequencer_format_revert_message(struct repository *r,
326 const char *subject,
327 const struct commit *commit,
328 const struct commit *parent,
329 bool use_commit_reference,
330 struct strbuf *message);
331
332 #endif /* SEQUENCER_H */