builtin.h · leroysheep/LeeRoySheep

test

bisect jch maint master next seen test todo

h 288 lines 17.7 KB

Raw

1	#ifndef BUILTIN_H
2	#define BUILTIN_H
3
4	#include "git-compat-util.h"
5	#include "repository.h"
6
7	/*
8	* builtin API
9	* ===========
10	*
11	* Adding a new built-in
12	* ---------------------
13	*
14	* There are 4 things to do to add a built-in command implementation to
15	* Git:
16	*
17	* . Define the implementation of the built-in command `foo` with
18	* signature:
19	*
20	* int cmd_foo(int argc, const char **argv,
21	* const char prefix, struct repository repo);
22	*
23	* . Add the external declaration for the function to `builtin.h`.
24	*
25	* . Add the command to the `commands[]` table defined in `git.c`.
26	* The entry should look like:
27	*
28	* { "foo", cmd_foo, <options> },
29	*
30	* where options is the bitwise-or of:
31	*
32	* `RUN_SETUP`:
33	*
34	* If there is not a Git directory to work on, abort. If there
35	* is a work tree, chdir to the top of it if the command was
36	* invoked in a subdirectory. If there is no work tree, no
37	* chdir() is done.
38	*
39	* `RUN_SETUP_GENTLY`:
40	*
41	* If there is a Git directory, chdir as per RUN_SETUP, otherwise,
42	* don't chdir anywhere.
43	*
44	* `USE_PAGER`:
45	*
46	* If the standard output is connected to a tty, spawn a pager and
47	* feed our output to it.
48	*
49	* `NEED_WORK_TREE`:
50	*
51	* Make sure there is a work tree, i.e. the command cannot act
52	* on bare repositories.
53	* This only makes sense when `RUN_SETUP` is also set.
54	*
55	* `DELAY_PAGER_CONFIG`:
56	*
57	* If RUN_SETUP or RUN_SETUP_GENTLY is set, git.c normally handles
58	* the `pager.<cmd>`-configuration. If this flag is used, git.c
59	* will skip that step, instead allowing the built-in to make a
60	* more informed decision, e.g., by ignoring `pager.<cmd>` for
61	* certain subcommands.
62	*
63	* `NO_PARSEOPT`:
64	*
65	* Most Git builtins use the parseopt library for parsing options.
66	* This flag indicates that a custom parser is used and thus the
67	* builtin would not appear in 'git --list-cmds=parseopt'.
68	*
69	* . Add `builtin/foo.o` to `BUILTIN_OBJS` in `Makefile`.
70	*
71	* Additionally, if `foo` is a new command, there are 4 more things to do:
72	*
73	* . Add tests to `t/` directory.
74	*
75	* . Write documentation in `Documentation/git-foo.adoc`.
76	*
77	* . Add an entry for `git-foo` to `command-list.txt`.
78	*
79	* . Add an entry for `/git-foo` to `.gitignore`.
80	*
81	* As you work on implementing your builtin, be mindful that the
82	* following tests will check different aspects of the builtin's
83	* readiness and adherence to matching the documentation:
84	*
85	* * t0012-help.sh checks that the builtin can handle -h, which comes
86	* automatically with the parseopt API.
87	*
88	* * t0450-txt-doc-vs-help.sh checks that the -h help output matches the
89	* SYNOPSIS in the documentation for the builtin.
90	*
91	* * t1517-outside-repo.sh checks that the builtin can handle -h when
92	* run outside of the context of a repository. Note that this test
93	* requires that the usage has a space after the builtin name, so some
94	* minimum description of options is required.
95	*
96	*
97	* How a built-in is called
98	* ------------------------
99	*
100	* The implementation `cmd_foo()` takes three parameters, `argc`, `argv,
101	* and `prefix`. The first two are similar to what `main()` of a
102	* standalone command would be called with.
103	*
104	* When `RUN_SETUP` is specified in the `commands[]` table, and when you
105	* were started from a subdirectory of the work tree, `cmd_foo()` is called
106	* after chdir(2) to the top of the work tree, and `prefix` gets the path
107	* to the subdirectory the command started from. This allows you to
108	* convert a user-supplied pathname (typically relative to that directory)
109	* to a pathname relative to the top of the work tree.
110	*
111	* The return value from `cmd_foo()` becomes the exit status of the
112	* command.
113	*/
114
115	extern const char git_usage_string[];
116	extern const char git_more_info_string[];
117
118	/**
119	* If a built-in has DELAY_PAGER_CONFIG set, the built-in should call this early
120	* when it wishes to respect the `pager.foo`-config. The `cmd` is the name of
121	* the built-in, e.g., "foo". If a paging-choice has already been setup, this
122	* does nothing. The default in `def` should be 0 for "pager off", 1 for "pager
123	* on" or -1 for "punt".
124	*
125	* You should most likely use a default of 0 or 1. "Punt" (-1) could be useful
126	* to be able to fall back to some historical compatibility name.
127	*/
128	void setup_auto_pager(const char *cmd, int def);
129
130	int is_builtin(const char *s);
131
132	/*
133	* Builtins which do not use RUN_SETUP should never see
134	* a prefix that is not empty; use this to protect downstream
135	* code which is not prepared to call prefix_filename(), etc.
136	*/
137	#define BUG_ON_NON_EMPTY_PREFIX(prefix) do { \
138	if ((prefix)) \
139	BUG("unexpected prefix in builtin: %s", (prefix)); \
140	} while (0)
141
142	int cmd_add(int argc, const char *argv, const char prefix, struct repository *repo);
143	int cmd_am(int argc, const char *argv, const char prefix, struct repository *repo);
144	int cmd_annotate(int argc, const char *argv, const char prefix, struct repository *repo);
145	int cmd_apply(int argc, const char *argv, const char prefix, struct repository *repo);
146	int cmd_archive(int argc, const char *argv, const char prefix, struct repository *repo);
147	int cmd_backfill(int argc, const char *argv, const char prefix, struct repository *repo);
148	int cmd_bisect(int argc, const char *argv, const char prefix, struct repository *repo);
149	int cmd_blame(int argc, const char *argv, const char prefix, struct repository *repo);
150	int cmd_branch(int argc, const char *argv, const char prefix, struct repository *repo);
151	int cmd_bugreport(int argc, const char *argv, const char prefix, struct repository *repo);
152	int cmd_bundle(int argc, const char *argv, const char prefix, struct repository *repo);
153	int cmd_cat_file(int argc, const char *argv, const char prefix, struct repository *repo);
154	int cmd_checkout(int argc, const char *argv, const char prefix, struct repository *repo);
155	int cmd_checkout__worker(int argc, const char *argv, const char prefix, struct repository *repo);
156	int cmd_checkout_index(int argc, const char *argv, const char prefix, struct repository *repo);
157	int cmd_check_attr(int argc, const char *argv, const char prefix, struct repository *repo);
158	int cmd_check_ignore(int argc, const char *argv, const char prefix, struct repository *repo);
159	int cmd_check_mailmap(int argc, const char *argv, const char prefix, struct repository *repo);
160	int cmd_check_ref_format(int argc, const char *argv, const char prefix, struct repository *repo);
161	int cmd_cherry(int argc, const char *argv, const char prefix, struct repository *repo);
162	int cmd_cherry_pick(int argc, const char *argv, const char prefix, struct repository *repo);
163	int cmd_clone(int argc, const char *argv, const char prefix, struct repository *repo);
164	int cmd_clean(int argc, const char *argv, const char prefix, struct repository *repo);
165	int cmd_column(int argc, const char *argv, const char prefix, struct repository *repo);
166	int cmd_commit(int argc, const char *argv, const char prefix, struct repository *repo);
167	int cmd_commit_graph(int argc, const char *argv, const char prefix, struct repository *repo);
168	int cmd_commit_tree(int argc, const char *argv, const char prefix, struct repository *repo);
169	int cmd_config(int argc, const char *argv, const char prefix, struct repository *repo);
170	int cmd_count_objects(int argc, const char *argv, const char prefix, struct repository *repo);
171	int cmd_credential(int argc, const char *argv, const char prefix, struct repository *repo);
172	int cmd_credential_cache(int argc, const char *argv, const char prefix, struct repository *repo);
173	int cmd_credential_cache_daemon(int argc, const char *argv, const char prefix, struct repository *repo);
174	int cmd_credential_store(int argc, const char *argv, const char prefix, struct repository *repo);
175	int cmd_describe(int argc, const char *argv, const char prefix, struct repository *repo);
176	int cmd_diagnose(int argc, const char *argv, const char prefix, struct repository *repo);
177	int cmd_diff_files(int argc, const char *argv, const char prefix, struct repository *repo);
178	int cmd_diff_index(int argc, const char *argv, const char prefix, struct repository *repo);
179	int cmd_diff(int argc, const char *argv, const char prefix, struct repository *repo);
180	int cmd_diff_pairs(int argc, const char *argv, const char prefix, struct repository *repo);
181	int cmd_diff_tree(int argc, const char *argv, const char prefix, struct repository *repo);
182	int cmd_difftool(int argc, const char *argv, const char prefix, struct repository *repo);
183	int cmd_env__helper(int argc, const char *argv, const char prefix, struct repository *repo);
184	int cmd_fast_export(int argc, const char *argv, const char prefix, struct repository *repo);
185	int cmd_fast_import(int argc, const char *argv, const char prefix, struct repository *repo);
186	int cmd_fetch(int argc, const char *argv, const char prefix, struct repository *repo);
187	int cmd_fetch_pack(int argc, const char *argv, const char prefix, struct repository *repo);
188	int cmd_fmt_merge_msg(int argc, const char *argv, const char prefix, struct repository *repo);
189	int cmd_for_each_ref(int argc, const char *argv, const char prefix, struct repository *repo);
190	int cmd_for_each_repo(int argc, const char *argv, const char prefix, struct repository *repo);
191	int cmd_format_patch(int argc, const char *argv, const char prefix, struct repository *repo);
192	int cmd_format_rev(int argc, const char *argv, const char prefix, struct repository *repo);
193	int cmd_fsck(int argc, const char *argv, const char prefix, struct repository *repo);
194	int cmd_fsmonitor__daemon(int argc, const char *argv, const char prefix, struct repository *repo);
195	int cmd_gc(int argc, const char *argv, const char prefix, struct repository *repo);
196	int cmd_get_tar_commit_id(int argc, const char *argv, const char prefix, struct repository *repo);
197	int cmd_grep(int argc, const char *argv, const char prefix, struct repository *repo);
198	int cmd_hash_object(int argc, const char *argv, const char prefix, struct repository *repo);
199	int cmd_help(int argc, const char *argv, const char prefix, struct repository *repo);
200	int cmd_history(int argc, const char *argv, const char prefix, struct repository *repo);
201	int cmd_hook(int argc, const char *argv, const char prefix, struct repository *repo);
202	int cmd_index_pack(int argc, const char *argv, const char prefix, struct repository *repo);
203	int cmd_init_db(int argc, const char *argv, const char prefix, struct repository *repo);
204	int cmd_interpret_trailers(int argc, const char *argv, const char prefix, struct repository *repo);
205	int cmd_last_modified(int argc, const char *argv, const char prefix, struct repository *repo);
206	int cmd_log_reflog(int argc, const char *argv, const char prefix, struct repository *repo);
207	int cmd_log(int argc, const char *argv, const char prefix, struct repository *repo);
208	int cmd_ls_files(int argc, const char *argv, const char prefix, struct repository *repo);
209	int cmd_ls_tree(int argc, const char *argv, const char prefix, struct repository *repo);
210	int cmd_ls_remote(int argc, const char *argv, const char prefix, struct repository *repo);
211	int cmd_mailinfo(int argc, const char *argv, const char prefix, struct repository *repo);
212	int cmd_mailsplit(int argc, const char *argv, const char prefix, struct repository *repo);
213	int cmd_maintenance(int argc, const char *argv, const char prefix, struct repository *repo);
214	int cmd_merge(int argc, const char *argv, const char prefix, struct repository *repo);
215	int cmd_merge_base(int argc, const char *argv, const char prefix, struct repository *repo);
216	int cmd_merge_index(int argc, const char *argv, const char prefix, struct repository *repo);
217	int cmd_merge_ours(int argc, const char *argv, const char prefix, struct repository *repo);
218	int cmd_merge_file(int argc, const char *argv, const char prefix, struct repository *repo);
219	int cmd_merge_recursive(int argc, const char *argv, const char prefix, struct repository *repo);
220	int cmd_merge_tree(int argc, const char *argv, const char prefix, struct repository *repo);
221	int cmd_mktag(int argc, const char *argv, const char prefix, struct repository *repo);
222	int cmd_mktree(int argc, const char *argv, const char prefix, struct repository *repo);
223	int cmd_multi_pack_index(int argc, const char *argv, const char prefix, struct repository *repo);
224	int cmd_mv(int argc, const char *argv, const char prefix, struct repository *repo);
225	int cmd_name_rev(int argc, const char *argv, const char prefix, struct repository *repo);
226	int cmd_notes(int argc, const char *argv, const char prefix, struct repository *repo);
227	int cmd_pack_objects(int argc, const char *argv, const char prefix, struct repository *repo);
228	int cmd_pack_redundant(int argc, const char *argv, const char prefix, struct repository *repo);
229	int cmd_patch_id(int argc, const char *argv, const char prefix, struct repository *repo);
230	int cmd_prune(int argc, const char *argv, const char prefix, struct repository *repo);
231	int cmd_prune_packed(int argc, const char *argv, const char prefix, struct repository *repo);
232	int cmd_pull(int argc, const char *argv, const char prefix, struct repository *repo);
233	int cmd_push(int argc, const char *argv, const char prefix, struct repository *repo);
234	int cmd_range_diff(int argc, const char *argv, const char prefix, struct repository *repo);
235	int cmd_read_tree(int argc, const char *argv, const char prefix, struct repository *repo);
236	int cmd_rebase(int argc, const char *argv, const char prefix, struct repository *repo);
237	int cmd_rebase__interactive(int argc, const char *argv, const char prefix, struct repository *repo);
238	int cmd_receive_pack(int argc, const char *argv, const char prefix, struct repository *repo);
239	int cmd_reflog(int argc, const char *argv, const char prefix, struct repository *repo);
240	int cmd_refs(int argc, const char *argv, const char prefix, struct repository *repo);
241	int cmd_remote(int argc, const char *argv, const char prefix, struct repository *repo);
242	int cmd_remote_ext(int argc, const char *argv, const char prefix, struct repository *repo);
243	int cmd_remote_fd(int argc, const char *argv, const char prefix, struct repository *repo);
244	int cmd_repack(int argc, const char *argv, const char prefix, struct repository *repo);
245	int cmd_replay(int argc, const char *argv, const char prefix, struct repository *repo);
246	int cmd_repo(int argc, const char *argv, const char prefix, struct repository *repo);
247	int cmd_rerere(int argc, const char *argv, const char prefix, struct repository *repo);
248	int cmd_reset(int argc, const char *argv, const char prefix, struct repository *repo);
249	int cmd_restore(int argc, const char *argv, const char prefix, struct repository *repo);
250	int cmd_rev_list(int argc, const char *argv, const char prefix, struct repository *repo);
251	int cmd_rev_parse(int argc, const char *argv, const char prefix, struct repository *repo);
252	int cmd_revert(int argc, const char *argv, const char prefix, struct repository *repo);
253	int cmd_rm(int argc, const char *argv, const char prefix, struct repository *repo);
254	int cmd_send_pack(int argc, const char *argv, const char prefix, struct repository *repo);
255	int cmd_shortlog(int argc, const char *argv, const char prefix, struct repository *repo);
256	int cmd_show(int argc, const char *argv, const char prefix, struct repository *repo);
257	int cmd_show_branch(int argc, const char *argv, const char prefix, struct repository *repo);
258	int cmd_show_index(int argc, const char *argv, const char prefix, struct repository *repo);
259	int cmd_sparse_checkout(int argc, const char *argv, const char prefix, struct repository *repo);
260	int cmd_status(int argc, const char *argv, const char prefix, struct repository *repo);
261	int cmd_stash(int argc, const char *argv, const char prefix, struct repository *repo);
262	int cmd_stripspace(int argc, const char *argv, const char prefix, struct repository *repo);
263	int cmd_submodule__helper(int argc, const char *argv, const char prefix, struct repository *repo);
264	int cmd_switch(int argc, const char *argv, const char prefix, struct repository *repo);
265	int cmd_symbolic_ref(int argc, const char *argv, const char prefix, struct repository *repo);
266	int cmd_tag(int argc, const char *argv, const char prefix, struct repository *repo);
267	int cmd_unpack_file(int argc, const char *argv, const char prefix, struct repository *repo);
268	int cmd_unpack_objects(int argc, const char *argv, const char prefix, struct repository *repo);
269	int cmd_update_index(int argc, const char *argv, const char prefix, struct repository *repo);
270	int cmd_update_ref(int argc, const char *argv, const char prefix, struct repository *repo);
271	int cmd_update_server_info(int argc, const char *argv, const char prefix, struct repository *repo);
272	int cmd_upload_archive(int argc, const char *argv, const char prefix, struct repository *repo);
273	int cmd_upload_archive_writer(int argc, const char *argv, const char prefix, struct repository *repo);
274	int cmd_upload_pack(int argc, const char *argv, const char prefix, struct repository *repo);
275	int cmd_url_parse(int argc, const char *argv, const char prefix, struct repository *repo);
276	int cmd_var(int argc, const char *argv, const char prefix, struct repository *repo);
277	int cmd_verify_commit(int argc, const char *argv, const char prefix, struct repository *repo);
278	int cmd_verify_tag(int argc, const char *argv, const char prefix, struct repository *repo);
279	int cmd_version(int argc, const char *argv, const char prefix, struct repository *repo);
280	int cmd_whatchanged(int argc, const char *argv, const char prefix, struct repository *repo);
281	int cmd_worktree(int argc, const char *argv, const char prefix, struct repository *repo);
282	int cmd_write_tree(int argc, const char *argv, const char prefix, struct repository *repo);
283	int cmd_verify_pack(int argc, const char *argv, const char prefix, struct repository *repo);
284	int cmd_show_ref(int argc, const char *argv, const char prefix, struct repository *repo);
285	int cmd_pack_refs(int argc, const char *argv, const char prefix, struct repository *repo);
286	int cmd_replace(int argc, const char *argv, const char prefix, struct repository *repo);
287
288	#endif