Minor documentation fixup.
[git/jrn.git] / builtin-rev-parse.c
blob5f5ade45aec781df107d4a49a4a554575ac278bd
1 /*
2 * rev-parse.c
4 * Copyright (C) Linus Torvalds, 2005
5 */
6 #include "cache.h"
7 #include "commit.h"
8 #include "refs.h"
9 #include "quote.h"
10 #include "builtin.h"
12 #define DO_REVS 1
13 #define DO_NOREV 2
14 #define DO_FLAGS 4
15 #define DO_NONFLAGS 8
16 static int filter = ~0;
18 static const char *def = NULL;
20 #define NORMAL 0
21 #define REVERSED 1
22 static int show_type = NORMAL;
23 static int symbolic = 0;
24 static int abbrev = 0;
25 static int output_sq = 0;
27 static int revs_count = 0;
30 * Some arguments are relevant "revision" arguments,
31 * others are about output format or other details.
32 * This sorts it all out.
34 static int is_rev_argument(const char *arg)
36 static const char *rev_args[] = {
37 "--all",
38 "--bisect",
39 "--dense",
40 "--branches",
41 "--header",
42 "--max-age=",
43 "--max-count=",
44 "--min-age=",
45 "--no-merges",
46 "--objects",
47 "--objects-edge",
48 "--parents",
49 "--pretty",
50 "--remotes",
51 "--sparse",
52 "--tags",
53 "--topo-order",
54 "--date-order",
55 "--unpacked",
56 NULL
58 const char **p = rev_args;
60 /* accept -<digit>, like traditional "head" */
61 if ((*arg == '-') && isdigit(arg[1]))
62 return 1;
64 for (;;) {
65 const char *str = *p++;
66 int len;
67 if (!str)
68 return 0;
69 len = strlen(str);
70 if (!strcmp(arg, str) ||
71 (str[len-1] == '=' && !strncmp(arg, str, len)))
72 return 1;
76 /* Output argument as a string, either SQ or normal */
77 static void show(const char *arg)
79 if (output_sq) {
80 int sq = '\'', ch;
82 putchar(sq);
83 while ((ch = *arg++)) {
84 if (ch == sq)
85 fputs("'\\'", stdout);
86 putchar(ch);
88 putchar(sq);
89 putchar(' ');
91 else
92 puts(arg);
95 /* Output a revision, only if filter allows it */
96 static void show_rev(int type, const unsigned char *sha1, const char *name)
98 if (!(filter & DO_REVS))
99 return;
100 def = NULL;
101 revs_count++;
103 if (type != show_type)
104 putchar('^');
105 if (symbolic && name)
106 show(name);
107 else if (abbrev)
108 show(find_unique_abbrev(sha1, abbrev));
109 else
110 show(sha1_to_hex(sha1));
113 /* Output a flag, only if filter allows it. */
114 static int show_flag(const char *arg)
116 if (!(filter & DO_FLAGS))
117 return 0;
118 if (filter & (is_rev_argument(arg) ? DO_REVS : DO_NOREV)) {
119 show(arg);
120 return 1;
122 return 0;
125 static void show_default(void)
127 const char *s = def;
129 if (s) {
130 unsigned char sha1[20];
132 def = NULL;
133 if (!get_sha1(s, sha1)) {
134 show_rev(NORMAL, sha1, s);
135 return;
140 static int show_reference(const char *refname, const unsigned char *sha1)
142 show_rev(NORMAL, sha1, refname);
143 return 0;
146 static void show_datestring(const char *flag, const char *datestr)
148 static char buffer[100];
150 /* date handling requires both flags and revs */
151 if ((filter & (DO_FLAGS | DO_REVS)) != (DO_FLAGS | DO_REVS))
152 return;
153 snprintf(buffer, sizeof(buffer), "%s%lu", flag, approxidate(datestr));
154 show(buffer);
157 static int show_file(const char *arg)
159 show_default();
160 if ((filter & (DO_NONFLAGS|DO_NOREV)) == (DO_NONFLAGS|DO_NOREV)) {
161 show(arg);
162 return 1;
164 return 0;
167 int cmd_rev_parse(int argc, const char **argv, char **envp)
169 int i, as_is = 0, verify = 0;
170 unsigned char sha1[20];
171 const char *prefix = setup_git_directory();
173 git_config(git_default_config);
175 for (i = 1; i < argc; i++) {
176 const char *arg = argv[i];
177 char *dotdot;
179 if (as_is) {
180 if (show_file(arg) && as_is < 2)
181 verify_filename(prefix, arg);
182 continue;
184 if (!strcmp(arg,"-n")) {
185 if (++i >= argc)
186 die("-n requires an argument");
187 if ((filter & DO_FLAGS) && (filter & DO_REVS)) {
188 show(arg);
189 show(argv[i]);
191 continue;
193 if (!strncmp(arg,"-n",2)) {
194 if ((filter & DO_FLAGS) && (filter & DO_REVS))
195 show(arg);
196 continue;
199 if (*arg == '-') {
200 if (!strcmp(arg, "--")) {
201 as_is = 2;
202 /* Pass on the "--" if we show anything but files.. */
203 if (filter & (DO_FLAGS | DO_REVS))
204 show_file(arg);
205 continue;
207 if (!strcmp(arg, "--default")) {
208 def = argv[i+1];
209 i++;
210 continue;
212 if (!strcmp(arg, "--revs-only")) {
213 filter &= ~DO_NOREV;
214 continue;
216 if (!strcmp(arg, "--no-revs")) {
217 filter &= ~DO_REVS;
218 continue;
220 if (!strcmp(arg, "--flags")) {
221 filter &= ~DO_NONFLAGS;
222 continue;
224 if (!strcmp(arg, "--no-flags")) {
225 filter &= ~DO_FLAGS;
226 continue;
228 if (!strcmp(arg, "--verify")) {
229 filter &= ~(DO_FLAGS|DO_NOREV);
230 verify = 1;
231 continue;
233 if (!strcmp(arg, "--short") ||
234 !strncmp(arg, "--short=", 8)) {
235 filter &= ~(DO_FLAGS|DO_NOREV);
236 verify = 1;
237 abbrev = DEFAULT_ABBREV;
238 if (arg[7] == '=')
239 abbrev = strtoul(arg + 8, NULL, 10);
240 if (abbrev < MINIMUM_ABBREV)
241 abbrev = MINIMUM_ABBREV;
242 else if (40 <= abbrev)
243 abbrev = 40;
244 continue;
246 if (!strcmp(arg, "--sq")) {
247 output_sq = 1;
248 continue;
250 if (!strcmp(arg, "--not")) {
251 show_type ^= REVERSED;
252 continue;
254 if (!strcmp(arg, "--symbolic")) {
255 symbolic = 1;
256 continue;
258 if (!strcmp(arg, "--all")) {
259 for_each_ref(show_reference);
260 continue;
262 if (!strcmp(arg, "--branches")) {
263 for_each_branch_ref(show_reference);
264 continue;
266 if (!strcmp(arg, "--tags")) {
267 for_each_tag_ref(show_reference);
268 continue;
270 if (!strcmp(arg, "--remotes")) {
271 for_each_remote_ref(show_reference);
272 continue;
274 if (!strcmp(arg, "--show-prefix")) {
275 if (prefix)
276 puts(prefix);
277 continue;
279 if (!strcmp(arg, "--show-cdup")) {
280 const char *pfx = prefix;
281 while (pfx) {
282 pfx = strchr(pfx, '/');
283 if (pfx) {
284 pfx++;
285 printf("../");
288 putchar('\n');
289 continue;
291 if (!strcmp(arg, "--git-dir")) {
292 const char *gitdir = getenv(GIT_DIR_ENVIRONMENT);
293 static char cwd[PATH_MAX];
294 if (gitdir) {
295 puts(gitdir);
296 continue;
298 if (!prefix) {
299 puts(".git");
300 continue;
302 if (!getcwd(cwd, PATH_MAX))
303 die("unable to get current working directory");
304 printf("%s/.git\n", cwd);
305 continue;
307 if (!strncmp(arg, "--since=", 8)) {
308 show_datestring("--max-age=", arg+8);
309 continue;
311 if (!strncmp(arg, "--after=", 8)) {
312 show_datestring("--max-age=", arg+8);
313 continue;
315 if (!strncmp(arg, "--before=", 9)) {
316 show_datestring("--min-age=", arg+9);
317 continue;
319 if (!strncmp(arg, "--until=", 8)) {
320 show_datestring("--min-age=", arg+8);
321 continue;
323 if (show_flag(arg) && verify)
324 die("Needed a single revision");
325 continue;
328 /* Not a flag argument */
329 dotdot = strstr(arg, "..");
330 if (dotdot) {
331 unsigned char end[20];
332 const char *next = dotdot + 2;
333 const char *this = arg;
334 *dotdot = 0;
335 if (!*next)
336 next = "HEAD";
337 if (dotdot == arg)
338 this = "HEAD";
339 if (!get_sha1(this, sha1) && !get_sha1(next, end)) {
340 show_rev(NORMAL, end, next);
341 show_rev(REVERSED, sha1, this);
342 continue;
344 *dotdot = '.';
346 if (!get_sha1(arg, sha1)) {
347 show_rev(NORMAL, sha1, arg);
348 continue;
350 if (*arg == '^' && !get_sha1(arg+1, sha1)) {
351 show_rev(REVERSED, sha1, arg+1);
352 continue;
354 as_is = 1;
355 if (!show_file(arg))
356 continue;
357 if (verify)
358 die("Needed a single revision");
359 verify_filename(prefix, arg);
361 show_default();
362 if (verify && revs_count != 1)
363 die("Needed a single revision");
364 return 0;