Merge branch 'mo/maint-crlf-doc'
[git] / builtin-shortlog.c
1 #include "builtin.h"
2 #include "cache.h"
3 #include "commit.h"
4 #include "diff.h"
5 #include "string-list.h"
6 #include "revision.h"
7 #include "utf8.h"
8 #include "mailmap.h"
9 #include "shortlog.h"
10 #include "parse-options.h"
11
12 static char const * const shortlog_usage[] = {
13         "git shortlog [-n] [-s] [-e] [-w] [rev-opts] [--] [<commit-id>... ]",
14         "",
15         "[rev-opts] are documented in git-rev-list(1)",
16         NULL
17 };
18
19 static int compare_by_number(const void *a1, const void *a2)
20 {
21         const struct string_list_item *i1 = a1, *i2 = a2;
22         const struct string_list *l1 = i1->util, *l2 = i2->util;
23
24         if (l1->nr < l2->nr)
25                 return 1;
26         else if (l1->nr == l2->nr)
27                 return 0;
28         else
29                 return -1;
30 }
31
32 const char *format_subject(struct strbuf *sb, const char *msg,
33                            const char *line_separator);
34
35 static void insert_one_record(struct shortlog *log,
36                               const char *author,
37                               const char *oneline)
38 {
39         const char *dot3 = log->common_repo_prefix;
40         char *buffer, *p;
41         struct string_list_item *item;
42         char namebuf[1024];
43         char emailbuf[1024];
44         size_t len;
45         const char *eol;
46         const char *boemail, *eoemail;
47         struct strbuf subject = STRBUF_INIT;
48
49         boemail = strchr(author, '<');
50         if (!boemail)
51                 return;
52         eoemail = strchr(boemail, '>');
53         if (!eoemail)
54                 return;
55
56         /* copy author name to namebuf, to support matching on both name and email */
57         memcpy(namebuf, author, boemail - author);
58         len = boemail - author;
59         while (len > 0 && isspace(namebuf[len-1]))
60                 len--;
61         namebuf[len] = 0;
62
63         /* copy email name to emailbuf, to allow email replacement as well */
64         memcpy(emailbuf, boemail+1, eoemail - boemail);
65         emailbuf[eoemail - boemail - 1] = 0;
66
67         if (!map_user(&log->mailmap, emailbuf, sizeof(emailbuf), namebuf, sizeof(namebuf))) {
68                 while (author < boemail && isspace(*author))
69                         author++;
70                 for (len = 0;
71                      len < sizeof(namebuf) - 1 && author + len < boemail;
72                      len++)
73                         namebuf[len] = author[len];
74                 while (0 < len && isspace(namebuf[len-1]))
75                         len--;
76                 namebuf[len] = '\0';
77         }
78         else
79                 len = strlen(namebuf);
80
81         if (log->email) {
82                 size_t room = sizeof(namebuf) - len - 1;
83                 int maillen = strlen(emailbuf);
84                 snprintf(namebuf + len, room, " <%.*s>", maillen, emailbuf);
85         }
86
87         item = string_list_insert(namebuf, &log->list);
88         if (item->util == NULL)
89                 item->util = xcalloc(1, sizeof(struct string_list));
90
91         /* Skip any leading whitespace, including any blank lines. */
92         while (*oneline && isspace(*oneline))
93                 oneline++;
94         eol = strchr(oneline, '\n');
95         if (!eol)
96                 eol = oneline + strlen(oneline);
97         if (!prefixcmp(oneline, "[PATCH")) {
98                 char *eob = strchr(oneline, ']');
99                 if (eob && (!eol || eob < eol))
100                         oneline = eob + 1;
101         }
102         while (*oneline && isspace(*oneline) && *oneline != '\n')
103                 oneline++;
104         format_subject(&subject, oneline, " ");
105         buffer = strbuf_detach(&subject, NULL);
106
107         if (dot3) {
108                 int dot3len = strlen(dot3);
109                 if (dot3len > 5) {
110                         while ((p = strstr(buffer, dot3)) != NULL) {
111                                 int taillen = strlen(p) - dot3len;
112                                 memcpy(p, "/.../", 5);
113                                 memmove(p + 5, p + dot3len, taillen + 1);
114                         }
115                 }
116         }
117
118         string_list_append(buffer, item->util);
119 }
120
121 static void read_from_stdin(struct shortlog *log)
122 {
123         char author[1024], oneline[1024];
124
125         while (fgets(author, sizeof(author), stdin) != NULL) {
126                 if (!(author[0] == 'A' || author[0] == 'a') ||
127                     prefixcmp(author + 1, "uthor: "))
128                         continue;
129                 while (fgets(oneline, sizeof(oneline), stdin) &&
130                        oneline[0] != '\n')
131                         ; /* discard headers */
132                 while (fgets(oneline, sizeof(oneline), stdin) &&
133                        oneline[0] == '\n')
134                         ; /* discard blanks */
135                 insert_one_record(log, author + 8, oneline);
136         }
137 }
138
139 void shortlog_add_commit(struct shortlog *log, struct commit *commit)
140 {
141         const char *author = NULL, *buffer;
142
143         buffer = commit->buffer;
144         while (*buffer && *buffer != '\n') {
145                 const char *eol = strchr(buffer, '\n');
146
147                 if (eol == NULL)
148                         eol = buffer + strlen(buffer);
149                 else
150                         eol++;
151
152                 if (!prefixcmp(buffer, "author "))
153                         author = buffer + 7;
154                 buffer = eol;
155         }
156         if (!author)
157                 die("Missing author: %s",
158                     sha1_to_hex(commit->object.sha1));
159         if (log->user_format) {
160                 struct strbuf buf = STRBUF_INIT;
161                 struct pretty_print_context ctx = {0};
162                 ctx.abbrev = DEFAULT_ABBREV;
163                 ctx.subject = "";
164                 ctx.after_subject = "";
165                 ctx.date_mode = DATE_NORMAL;
166                 pretty_print_commit(CMIT_FMT_USERFORMAT, commit, &buf, &ctx);
167                 insert_one_record(log, author, buf.buf);
168                 strbuf_release(&buf);
169                 return;
170         }
171         if (*buffer)
172                 buffer++;
173         insert_one_record(log, author, !*buffer ? "<none>" : buffer);
174 }
175
176 static void get_from_rev(struct rev_info *rev, struct shortlog *log)
177 {
178         struct commit *commit;
179
180         if (prepare_revision_walk(rev))
181                 die("revision walk setup failed");
182         while ((commit = get_revision(rev)) != NULL)
183                 shortlog_add_commit(log, commit);
184 }
185
186 static int parse_uint(char const **arg, int comma, int defval)
187 {
188         unsigned long ul;
189         int ret;
190         char *endp;
191
192         ul = strtoul(*arg, &endp, 10);
193         if (*endp && *endp != comma)
194                 return -1;
195         if (ul > INT_MAX)
196                 return -1;
197         ret = *arg == endp ? defval : (int)ul;
198         *arg = *endp ? endp + 1 : endp;
199         return ret;
200 }
201
202 static const char wrap_arg_usage[] = "-w[<width>[,<indent1>[,<indent2>]]]";
203 #define DEFAULT_WRAPLEN 76
204 #define DEFAULT_INDENT1 6
205 #define DEFAULT_INDENT2 9
206
207 static int parse_wrap_args(const struct option *opt, const char *arg, int unset)
208 {
209         struct shortlog *log = opt->value;
210
211         log->wrap_lines = !unset;
212         if (unset)
213                 return 0;
214         if (!arg) {
215                 log->wrap = DEFAULT_WRAPLEN;
216                 log->in1 = DEFAULT_INDENT1;
217                 log->in2 = DEFAULT_INDENT2;
218                 return 0;
219         }
220
221         log->wrap = parse_uint(&arg, ',', DEFAULT_WRAPLEN);
222         log->in1 = parse_uint(&arg, ',', DEFAULT_INDENT1);
223         log->in2 = parse_uint(&arg, '\0', DEFAULT_INDENT2);
224         if (log->wrap < 0 || log->in1 < 0 || log->in2 < 0)
225                 return error(wrap_arg_usage);
226         if (log->wrap &&
227             ((log->in1 && log->wrap <= log->in1) ||
228              (log->in2 && log->wrap <= log->in2)))
229                 return error(wrap_arg_usage);
230         return 0;
231 }
232
233 void shortlog_init(struct shortlog *log)
234 {
235         memset(log, 0, sizeof(*log));
236
237         read_mailmap(&log->mailmap, &log->common_repo_prefix);
238
239         log->list.strdup_strings = 1;
240         log->wrap = DEFAULT_WRAPLEN;
241         log->in1 = DEFAULT_INDENT1;
242         log->in2 = DEFAULT_INDENT2;
243 }
244
245 int cmd_shortlog(int argc, const char **argv, const char *prefix)
246 {
247         static struct shortlog log;
248         static struct rev_info rev;
249         int nongit;
250
251         static const struct option options[] = {
252                 OPT_BOOLEAN('n', "numbered", &log.sort_by_number,
253                             "sort output according to the number of commits per author"),
254                 OPT_BOOLEAN('s', "summary", &log.summary,
255                             "Suppress commit descriptions, only provides commit count"),
256                 OPT_BOOLEAN('e', "email", &log.email,
257                             "Show the email address of each author"),
258                 { OPTION_CALLBACK, 'w', NULL, &log, "w[,i1[,i2]]",
259                         "Linewrap output", PARSE_OPT_OPTARG, &parse_wrap_args },
260                 OPT_END(),
261         };
262
263         struct parse_opt_ctx_t ctx;
264
265         prefix = setup_git_directory_gently(&nongit);
266         git_config(git_default_config, NULL);
267         shortlog_init(&log);
268         init_revisions(&rev, prefix);
269         parse_options_start(&ctx, argc, argv, prefix, PARSE_OPT_KEEP_DASHDASH |
270                             PARSE_OPT_KEEP_ARGV0);
271
272         for (;;) {
273                 switch (parse_options_step(&ctx, options, shortlog_usage)) {
274                 case PARSE_OPT_HELP:
275                         exit(129);
276                 case PARSE_OPT_DONE:
277                         goto parse_done;
278                 }
279                 parse_revision_opt(&rev, &ctx, options, shortlog_usage);
280         }
281 parse_done:
282         argc = parse_options_end(&ctx);
283
284         if (setup_revisions(argc, argv, &rev, NULL) != 1) {
285                 error("unrecognized argument: %s", argv[1]);
286                 usage_with_options(shortlog_usage, options);
287         }
288
289         log.user_format = rev.commit_format == CMIT_FMT_USERFORMAT;
290
291         /* assume HEAD if from a tty */
292         if (!nongit && !rev.pending.nr && isatty(0))
293                 add_head_to_pending(&rev);
294         if (rev.pending.nr == 0) {
295                 read_from_stdin(&log);
296         }
297         else
298                 get_from_rev(&rev, &log);
299
300         shortlog_output(&log);
301         return 0;
302 }
303
304 void shortlog_output(struct shortlog *log)
305 {
306         int i, j;
307         if (log->sort_by_number)
308                 qsort(log->list.items, log->list.nr, sizeof(struct string_list_item),
309                         compare_by_number);
310         for (i = 0; i < log->list.nr; i++) {
311                 struct string_list *onelines = log->list.items[i].util;
312
313                 if (log->summary) {
314                         printf("%6d\t%s\n", onelines->nr, log->list.items[i].string);
315                 } else {
316                         printf("%s (%d):\n", log->list.items[i].string, onelines->nr);
317                         for (j = onelines->nr - 1; j >= 0; j--) {
318                                 const char *msg = onelines->items[j].string;
319
320                                 if (log->wrap_lines) {
321                                         int col = print_wrapped_text(msg, log->in1, log->in2, log->wrap);
322                                         if (col != log->wrap)
323                                                 putchar('\n');
324                                 }
325                                 else
326                                         printf("      %s\n", msg);
327                         }
328                         putchar('\n');
329                 }
330
331                 onelines->strdup_strings = 1;
332                 string_list_clear(onelines, 0);
333                 free(onelines);
334                 log->list.items[i].util = NULL;
335         }
336
337         log->list.strdup_strings = 1;
338         string_list_clear(&log->list, 1);
339         clear_mailmap(&log->mailmap);
340 }