X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/219ee52a04d3b9d46f5d8165a9d61ee12e67bd01..04e2b7b214944044250edfea5634cbf919473cf4:/tig.c diff --git a/tig.c b/tig.c index cfdf026..cb943bc 100644 --- a/tig.c +++ b/tig.c @@ -1,44 +1,15 @@ /* Copyright (c) 2006 Jonas Fonseca * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation. + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License as + * published by the Free Software Foundation; either version 2 of + * the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. */ -/** - * TIG(1) - * ====== - * - * NAME - * ---- - * tig - text-mode interface for git - * - * SYNOPSIS - * -------- - * [verse] - * tig [options] - * tig [options] [--] [git log options] - * tig [options] log [git log options] - * tig [options] diff [git diff options] - * tig [options] show [git show options] - * tig [options] < [git command output] - * - * DESCRIPTION - * ----------- - * Browse changes in a git repository. Additionally, tig(1) can also act - * as a pager for output of various git commands. - * - * When browsing repositories, tig(1) uses the underlying git commands - * to present the user with various views, such as summarized commit log - * and showing the commit with the log message, diffstat, and the diff. - * - * Using tig(1) as a pager, it will display input from stdin and try - * to colorize it. - **/ #ifndef VERSION #define VERSION "tig-0.3" @@ -61,8 +32,15 @@ #include -static void die(const char *err, ...); +#if __GNUC__ >= 3 +#define __NORETURN __attribute__((__noreturn__)) +#else +#define __NORETURN +#endif + +static void __NORETURN die(const char *err, ...); static void report(const char *msg, ...); +static int read_properties(FILE *pipe, const char *separators, int (*read)(char *, int, char *, int)); static void set_nonblocking_input(bool loading); static size_t utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed); @@ -74,12 +52,11 @@ static size_t utf8_length(const char *string, size_t max_width, int *coloffset, #define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */ #define SIZEOF_CMD 1024 /* Size of command buffer. */ +#define SIZEOF_REVGRAPH 19 /* Size of revision ancestry graphics. */ /* This color name can be used to refer to the default term colors. */ #define COLOR_DEFAULT (-1) -#define TIG_HELP "(d)iff, (l)og, (m)ain, (q)uit, (h)elp" - /* The format and size of the date column in the main view. */ #define DATE_FORMAT "%Y-%m-%d %H:%M" #define DATE_COLS STRING_SIZE("2006-04-29 14:21 ") @@ -93,51 +70,28 @@ static size_t utf8_length(const char *string, size_t max_width, int *coloffset, #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3) +#define TIG_LS_REMOTE \ + "git ls-remote . 2>/dev/null" + +#define TIG_DIFF_CMD \ + "git show --patch-with-stat --find-copies-harder -B -C %s" + +#define TIG_LOG_CMD \ + "git log --cc --stat -n100 %s" + +#define TIG_MAIN_CMD \ + "git log --topo-order --stat --pretty=raw %s" + +/* XXX: Needs to be defined to the empty string. */ +#define TIG_HELP_CMD "" +#define TIG_PAGER_CMD "" + /* Some ascii-shorthands fitted into the ncurses namespace. */ #define KEY_TAB '\t' #define KEY_RETURN '\r' #define KEY_ESC 27 -/* User action requests. */ -enum request { - /* Offset all requests to avoid conflicts with ncurses getch values. */ - REQ_OFFSET = KEY_MAX + 1, - - /* XXX: Keep the view request first and in sync with views[]. */ - REQ_VIEW_MAIN, - REQ_VIEW_DIFF, - REQ_VIEW_LOG, - REQ_VIEW_HELP, - REQ_VIEW_PAGER, - - REQ_ENTER, - REQ_QUIT, - REQ_PROMPT, - REQ_SCREEN_REDRAW, - REQ_SCREEN_RESIZE, - REQ_SCREEN_UPDATE, - REQ_SHOW_VERSION, - REQ_STOP_LOADING, - REQ_TOGGLE_LINE_NUMBERS, - REQ_VIEW_NEXT, - REQ_VIEW_CLOSE, - REQ_NEXT, - REQ_PREVIOUS, - - REQ_MOVE_UP, - REQ_MOVE_DOWN, - REQ_MOVE_PAGE_UP, - REQ_MOVE_PAGE_DOWN, - REQ_MOVE_FIRST_LINE, - REQ_MOVE_LAST_LINE, - - REQ_SCROLL_LINE_UP, - REQ_SCROLL_LINE_DOWN, - REQ_SCROLL_PAGE_UP, - REQ_SCROLL_PAGE_DOWN, -}; - struct ref { char *name; /* Ref name; tag or head names are shortened. */ char id[41]; /* Commit SHA1 ID */ @@ -147,6 +101,29 @@ struct ref { static struct ref **get_refs(char *id); +struct int_map { + const char *name; + int namelen; + int value; +}; + +static int +set_from_int_map(struct int_map *map, size_t map_size, + int *value, const char *name, int namelen) +{ + + int i; + + for (i = 0; i < map_size; i++) + if (namelen == map[i].namelen && + !strncasecmp(name, map[i].name, namelen)) { + *value = map[i].value; + return OK; + } + + return ERR; +} + /* * String helpers @@ -164,6 +141,64 @@ string_ncopy(char *dst, const char *src, int dstlen) #define string_copy(dst, src) \ string_ncopy(dst, src, sizeof(dst)) +static char * +chomp_string(char *name) +{ + int namelen; + + while (isspace(*name)) + name++; + + namelen = strlen(name) - 1; + while (namelen > 0 && isspace(name[namelen])) + name[namelen--] = 0; + + return name; +} + +static bool +string_nformat(char *buf, size_t bufsize, int *bufpos, const char *fmt, ...) +{ + va_list args; + int pos = bufpos ? *bufpos : 0; + + va_start(args, fmt); + pos += vsnprintf(buf + pos, bufsize - pos, fmt, args); + va_end(args); + + if (bufpos) + *bufpos = pos; + + return pos >= bufsize ? FALSE : TRUE; +} + +#define string_format(buf, fmt, args...) \ + string_nformat(buf, sizeof(buf), NULL, fmt, args) + +#define string_format_from(buf, from, fmt, args...) \ + string_nformat(buf, sizeof(buf), from, fmt, args) + +static int +string_enum_compare(const char *str1, const char *str2, int len) +{ + size_t i; + +#define string_enum_sep(x) ((x) == '-' || (x) == '_' || (x) == '.') + + /* Diff-Header == DIFF_HEADER */ + for (i = 0; i < len; i++) { + if (toupper(str1[i]) == toupper(str2[i])) + continue; + + if (string_enum_sep(str1[i]) && + string_enum_sep(str2[i])) + continue; + + return str1[i] - str2[i]; + } + + return 0; +} /* Shell quoting * @@ -206,10 +241,99 @@ sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src) } -/** - * OPTIONS - * ------- - **/ +/* + * User requests + */ + +#define REQ_INFO \ + /* XXX: Keep the view request first and in sync with views[]. */ \ + REQ_GROUP("View switching") \ + REQ_(VIEW_MAIN, "Show main view"), \ + REQ_(VIEW_DIFF, "Show diff view"), \ + REQ_(VIEW_LOG, "Show log view"), \ + REQ_(VIEW_HELP, "Show help page"), \ + REQ_(VIEW_PAGER, "Show pager view"), \ + \ + REQ_GROUP("View manipulation") \ + REQ_(ENTER, "Enter current line and scroll"), \ + REQ_(NEXT, "Move to next"), \ + REQ_(PREVIOUS, "Move to previous"), \ + REQ_(VIEW_NEXT, "Move focus to next view"), \ + REQ_(VIEW_CLOSE, "Close the current view"), \ + REQ_(QUIT, "Close all views and quit"), \ + \ + REQ_GROUP("Cursor navigation") \ + REQ_(MOVE_UP, "Move cursor one line up"), \ + REQ_(MOVE_DOWN, "Move cursor one line down"), \ + REQ_(MOVE_PAGE_DOWN, "Move cursor one page down"), \ + REQ_(MOVE_PAGE_UP, "Move cursor one page up"), \ + REQ_(MOVE_FIRST_LINE, "Move cursor to first line"), \ + REQ_(MOVE_LAST_LINE, "Move cursor to last line"), \ + \ + REQ_GROUP("Scrolling") \ + REQ_(SCROLL_LINE_UP, "Scroll one line up"), \ + REQ_(SCROLL_LINE_DOWN, "Scroll one line down"), \ + REQ_(SCROLL_PAGE_UP, "Scroll one page up"), \ + REQ_(SCROLL_PAGE_DOWN, "Scroll one page down"), \ + \ + REQ_GROUP("Misc") \ + REQ_(PROMPT, "Bring up the prompt"), \ + REQ_(SCREEN_UPDATE, "Update the screen"), \ + REQ_(SCREEN_REDRAW, "Redraw the screen"), \ + REQ_(SCREEN_RESIZE, "Resize the screen"), \ + REQ_(SHOW_VERSION, "Show version information"), \ + REQ_(STOP_LOADING, "Stop all loading views"), \ + REQ_(TOGGLE_LINENO, "Toggle line numbers"), \ + REQ_(TOGGLE_REV_GRAPH, "Toggle revision graph visualization") + + +/* User action requests. */ +enum request { +#define REQ_GROUP(help) +#define REQ_(req, help) REQ_##req + + /* Offset all requests to avoid conflicts with ncurses getch values. */ + REQ_OFFSET = KEY_MAX + 1, + REQ_INFO, + REQ_UNKNOWN, + +#undef REQ_GROUP +#undef REQ_ +}; + +struct request_info { + enum request request; + char *name; + int namelen; + char *help; +}; + +static struct request_info req_info[] = { +#define REQ_GROUP(help) { 0, NULL, 0, (help) }, +#define REQ_(req, help) { REQ_##req, (#req), STRING_SIZE(#req), (help) } + REQ_INFO +#undef REQ_GROUP +#undef REQ_ +}; + +static enum request +get_request(const char *name) +{ + int namelen = strlen(name); + int i; + + for (i = 0; i < ARRAY_SIZE(req_info); i++) + if (req_info[i].namelen == namelen && + !string_enum_compare(req_info[i].name, name, namelen)) + return req_info[i].request; + + return REQ_UNKNOWN; +} + + +/* + * Options + */ static const char usage[] = VERSION " (" __DATE__ ")\n" @@ -225,19 +349,65 @@ VERSION " (" __DATE__ ")\n" " -l Start up in log view\n" " -d Start up in diff view\n" " -n[I], --line-number[=I] Show line numbers with given interval\n" -" -t[N], --tab-size[=N] Set number of spaces for tab expansion\n" +" -b[N], --tab-size[=N] Set number of spaces for tab expansion\n" " -- Mark end of tig options\n" " -v, --version Show version and exit\n" " -h, --help Show help message and exit\n"; /* Option and state variables. */ static bool opt_line_number = FALSE; +static bool opt_rev_graph = TRUE; static int opt_num_interval = NUMBER_INTERVAL; static int opt_tab_size = TABSIZE; static enum request opt_request = REQ_VIEW_MAIN; static char opt_cmd[SIZEOF_CMD] = ""; +static char opt_encoding[20] = ""; +static bool opt_utf8 = TRUE; static FILE *opt_pipe = NULL; +enum option_type { + OPT_NONE, + OPT_INT, +}; + +static bool +check_option(char *opt, char short_name, char *name, enum option_type type, ...) +{ + va_list args; + char *value = ""; + int *number; + + if (opt[0] != '-') + return FALSE; + + if (opt[1] == '-') { + int namelen = strlen(name); + + opt += 2; + + if (strncmp(opt, name, namelen)) + return FALSE; + + if (opt[namelen] == '=') + value = opt + namelen + 1; + + } else { + if (!short_name || opt[1] != short_name) + return FALSE; + value = opt + 2; + } + + va_start(args, type); + if (type == OPT_INT) { + number = va_arg(args, int *); + if (isdigit(*value)) + *number = atoi(value); + } + va_end(args); + + return TRUE; +} + /* Returns the index of log or diff command or -1 to exit. */ static bool parse_options(int argc, char *argv[]) @@ -247,109 +417,41 @@ parse_options(int argc, char *argv[]) for (i = 1; i < argc; i++) { char *opt = argv[i]; - /** - * -l:: - * Start up in log view using the internal log command. - **/ if (!strcmp(opt, "-l")) { opt_request = REQ_VIEW_LOG; continue; } - /** - * -d:: - * Start up in diff view using the internal diff command. - **/ if (!strcmp(opt, "-d")) { opt_request = REQ_VIEW_DIFF; continue; } - /** - * -n[INTERVAL], --line-number[=INTERVAL]:: - * Prefix line numbers in log and diff view. - * Optionally, with interval different than each line. - **/ - if (!strncmp(opt, "-n", 2) || - !strncmp(opt, "--line-number", 13)) { - char *num = opt; - - if (opt[1] == 'n') { - num = opt + 2; - - } else if (opt[STRING_SIZE("--line-number")] == '=') { - num = opt + STRING_SIZE("--line-number="); - } - - if (isdigit(*num)) - opt_num_interval = atoi(num); - + if (check_option(opt, 'n', "line-number", OPT_INT, &opt_num_interval)) { opt_line_number = TRUE; continue; } - /** - * -t[NSPACES], --tab-size[=NSPACES]:: - * Set the number of spaces tabs should be expanded to. - **/ - if (!strncmp(opt, "-t", 2) || - !strncmp(opt, "--tab-size", 10)) { - char *num = opt; - - if (opt[1] == 't') { - num = opt + 2; - - } else if (opt[STRING_SIZE("--tab-size")] == '=') { - num = opt + STRING_SIZE("--tab-size="); - } - - if (isdigit(*num)) - opt_tab_size = MIN(atoi(num), TABSIZE); + if (check_option(opt, 'b', "tab-size", OPT_INT, &opt_tab_size)) { + opt_tab_size = MIN(opt_tab_size, TABSIZE); continue; } - /** - * -v, --version:: - * Show version and exit. - **/ - if (!strcmp(opt, "-v") || - !strcmp(opt, "--version")) { + if (check_option(opt, 'v', "version", OPT_NONE)) { printf("tig version %s\n", VERSION); return FALSE; } - /** - * -h, --help:: - * Show help message and exit. - **/ - if (!strcmp(opt, "-h") || - !strcmp(opt, "--help")) { + if (check_option(opt, 'h', "help", OPT_NONE)) { printf(usage); return FALSE; } - /** - * \--:: - * End of tig(1) options. Useful when specifying command - * options for the main view. Example: - * - * $ tig -- --since=1.month - **/ if (!strcmp(opt, "--")) { i++; break; } - /** - * log [git log options]:: - * Open log view using the given git log options. - * - * diff [git diff options]:: - * Open diff view using the given git diff options. - * - * show [git show options]:: - * Open diff view using the given git show options. - **/ if (!strcmp(opt, "log") || !strcmp(opt, "diff") || !strcmp(opt, "show")) { @@ -358,62 +460,19 @@ parse_options(int argc, char *argv[]) break; } - /** - * [git log options]:: - * tig(1) will stop the option parsing when the first - * command line parameter not starting with "-" is - * encountered. All options including this one will be - * passed to git log when loading the main view. - * This makes it possible to say: - * - * $ tig tag-1.0..HEAD - **/ if (opt[0] && opt[0] != '-') break; - die("unknown command '%s'", opt); + die("unknown option '%s'\n\n%s", opt, usage); } if (!isatty(STDIN_FILENO)) { - /** - * Pager mode - * ~~~~~~~~~~ - * If stdin is a pipe, any log or diff options will be ignored and the - * pager view will be opened loading data from stdin. The pager mode - * can be used for colorizing output from various git commands. - * - * Example on how to colorize the output of git-show(1): - * - * $ git show | tig - **/ opt_request = REQ_VIEW_PAGER; opt_pipe = stdin; } else if (i < argc) { size_t buf_size; - /** - * Git command options - * ~~~~~~~~~~~~~~~~~~~ - * All git command options specified on the command line will - * be passed to the given command and all will be shell quoted - * before they are passed to the shell. - * - * NOTE: If you specify options for the main view, you should - * not use the `--pretty` option as this option will be set - * automatically to the format expected by the main view. - * - * Example on how to open the log view and show both author and - * committer information: - * - * $ tig log --pretty=fuller - * - * See the <> section below - * for an introduction to revision options supported by the git - * commands. For details on specific git command options, refer - * to the man page of the command in question. - **/ - if (opt_request == REQ_VIEW_MAIN) /* XXX: This is vulnerable to the user overriding * options required for the main view parser. */ @@ -434,122 +493,45 @@ parse_options(int argc, char *argv[]) } + if (*opt_encoding && strcasecmp(opt_encoding, "UTF-8")) + opt_utf8 = FALSE; + return TRUE; } -/** - * ENVIRONMENT VARIABLES - * --------------------- - * Several options related to the interface with git can be configured - * via environment options. - * - * Repository references - * ~~~~~~~~~~~~~~~~~~~~~ - * Commits that are referenced by tags and branch heads will be marked - * by the reference name surrounded by '[' and ']': - * - * 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1 - * - * If you want to filter out certain directories under `.git/refs/`, say - * `tmp` you can do it by setting the following variable: - * - * $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig - * - * Or set the variable permanently in your environment. - * - * TIG_LS_REMOTE:: - * Set command for retrieving all repository references. The command - * should output data in the same format as git-ls-remote(1). - **/ - -#define TIG_LS_REMOTE \ - "git ls-remote . 2>/dev/null" - -/** - * [[view-commands]] - * View commands - * ~~~~~~~~~~~~~ - * It is possible to alter which commands are used for the different views. - * If for example you prefer commits in the main view to be sorted by date - * and only show 500 commits, use: - * - * $ TIG_MAIN_CMD="git log --date-order -n500 --pretty=raw %s" tig - * - * Or set the variable permanently in your environment. - * - * Notice, how `%s` is used to specify the commit reference. There can - * be a maximum of 5 `%s` ref specifications. - * - * TIG_DIFF_CMD:: - * The command used for the diff view. By default, git show is used - * as a backend. - * - * TIG_LOG_CMD:: - * The command used for the log view. If you prefer to have both - * author and committer shown in the log view be sure to pass - * `--pretty=fuller` to git log. - * - * TIG_MAIN_CMD:: - * The command used for the main view. Note, you must always specify - * the option: `--pretty=raw` since the main view parser expects to - * read that format. - **/ - -#define TIG_DIFF_CMD \ - "git show --patch-with-stat --find-copies-harder -B -C %s" - -#define TIG_LOG_CMD \ - "git log --cc --stat -n100 %s" - -#define TIG_MAIN_CMD \ - "git log --topo-order --stat --pretty=raw %s" - -/* ... silently ignore that the following are also exported. */ - -#define TIG_HELP_CMD \ - "man tig 2>/dev/null" - -#define TIG_PAGER_CMD \ - "" - - /* * Line-oriented content detection. */ #define LINE_INFO \ -/* Line type String to match Foreground Background Attributes - * --------- --------------- ---------- ---------- ---------- */ \ -/* Diff markup */ \ -LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \ +LINE(DIFF_HEADER, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \ LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \ LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \ -LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -/* Pretty print commit header */ \ +LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \ +LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_COPY_FROM, "copy from", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_COPY_TO, "copy to", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_RENAME_FROM, "rename from", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_RENAME_TO, "rename to", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_SIMILARITY, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_DISSIMILARITY,"dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \ LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \ LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \ LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \ LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -/* Raw commit header */ \ +LINE(PP_REFS, "Refs: ", COLOR_RED, COLOR_DEFAULT, 0), \ LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \ LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \ LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \ LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \ LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \ -/* Misc */ \ -LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \ LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \ -/* UI colors */ \ LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \ LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \ LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \ @@ -560,7 +542,7 @@ LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_DEFAULT, 0), \ LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \ LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \ LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \ -LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD), +LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD), \ enum line_type { #define LINE(type, line, fg, bg, attr) \ @@ -570,6 +552,8 @@ enum line_type { }; struct line_info { + const char *name; /* Option name. */ + int namelen; /* Size of option name. */ const char *line; /* The start of line to match. */ int linelen; /* Size of string to match. */ int fg, bg, attr; /* Color and text attributes for the lines. */ @@ -577,7 +561,7 @@ struct line_info { static struct line_info line_info[] = { #define LINE(type, line, fg, bg, attr) \ - { (line), STRING_SIZE(line), (fg), (bg), (attr) } + { #type, STRING_SIZE(#type), (line), STRING_SIZE(line), (fg), (bg), (attr) } LINE_INFO #undef LINE }; @@ -604,6 +588,19 @@ get_line_attr(enum line_type type) return COLOR_PAIR(type) | line_info[type].attr; } +static struct line_info * +get_line_info(char *name, int namelen) +{ + enum line_type type; + + for (type = 0; type < ARRAY_SIZE(line_info); type++) + if (namelen == line_info[type].namelen && + !string_enum_compare(line_info[type].name, name, namelen)) + return &line_info[type]; + + return NULL; +} + static void init_colors(void) { @@ -633,23 +630,461 @@ struct line { }; -/** +/* + * Keys + */ + +struct keybinding { + int alias; + enum request request; + struct keybinding *next; +}; + +static struct keybinding default_keybindings[] = { + /* View switching */ + { 'm', REQ_VIEW_MAIN }, + { 'd', REQ_VIEW_DIFF }, + { 'l', REQ_VIEW_LOG }, + { 'p', REQ_VIEW_PAGER }, + { 'h', REQ_VIEW_HELP }, + { '?', REQ_VIEW_HELP }, + + /* View manipulation */ + { 'q', REQ_VIEW_CLOSE }, + { KEY_TAB, REQ_VIEW_NEXT }, + { KEY_RETURN, REQ_ENTER }, + { KEY_UP, REQ_PREVIOUS }, + { KEY_DOWN, REQ_NEXT }, + + /* Cursor navigation */ + { 'k', REQ_MOVE_UP }, + { 'j', REQ_MOVE_DOWN }, + { KEY_HOME, REQ_MOVE_FIRST_LINE }, + { KEY_END, REQ_MOVE_LAST_LINE }, + { KEY_NPAGE, REQ_MOVE_PAGE_DOWN }, + { ' ', REQ_MOVE_PAGE_DOWN }, + { KEY_PPAGE, REQ_MOVE_PAGE_UP }, + { 'b', REQ_MOVE_PAGE_UP }, + { '-', REQ_MOVE_PAGE_UP }, + + /* Scrolling */ + { KEY_IC, REQ_SCROLL_LINE_UP }, + { KEY_DC, REQ_SCROLL_LINE_DOWN }, + { 'w', REQ_SCROLL_PAGE_UP }, + { 's', REQ_SCROLL_PAGE_DOWN }, + + /* Misc */ + { 'Q', REQ_QUIT }, + { 'z', REQ_STOP_LOADING }, + { 'v', REQ_SHOW_VERSION }, + { 'r', REQ_SCREEN_REDRAW }, + { 'n', REQ_TOGGLE_LINENO }, + { 'g', REQ_TOGGLE_REV_GRAPH}, + { ':', REQ_PROMPT }, + + /* wgetch() with nodelay() enabled returns ERR when there's no input. */ + { ERR, REQ_SCREEN_UPDATE }, + + /* Use the ncurses SIGWINCH handler. */ + { KEY_RESIZE, REQ_SCREEN_RESIZE }, +}; + +#define KEYMAP_INFO \ + KEYMAP_(GENERIC), \ + KEYMAP_(MAIN), \ + KEYMAP_(DIFF), \ + KEYMAP_(LOG), \ + KEYMAP_(PAGER), \ + KEYMAP_(HELP) \ + +enum keymap { +#define KEYMAP_(name) KEYMAP_##name + KEYMAP_INFO +#undef KEYMAP_ +}; + +static struct int_map keymap_table[] = { +#define KEYMAP_(name) { #name, STRING_SIZE(#name), KEYMAP_##name } + KEYMAP_INFO +#undef KEYMAP_ +}; + +#define set_keymap(map, name) \ + set_from_int_map(keymap_table, ARRAY_SIZE(keymap_table), map, name, strlen(name)) + +static struct keybinding *keybindings[ARRAY_SIZE(keymap_table)]; + +static void +add_keybinding(enum keymap keymap, enum request request, int key) +{ + struct keybinding *keybinding; + + keybinding = calloc(1, sizeof(*keybinding)); + if (!keybinding) + die("Failed to allocate keybinding"); + + keybinding->alias = key; + keybinding->request = request; + keybinding->next = keybindings[keymap]; + keybindings[keymap] = keybinding; +} + +/* Looks for a key binding first in the given map, then in the generic map, and + * lastly in the default keybindings. */ +static enum request +get_keybinding(enum keymap keymap, int key) +{ + struct keybinding *kbd; + int i; + + for (kbd = keybindings[keymap]; kbd; kbd = kbd->next) + if (kbd->alias == key) + return kbd->request; + + for (kbd = keybindings[KEYMAP_GENERIC]; kbd; kbd = kbd->next) + if (kbd->alias == key) + return kbd->request; + + for (i = 0; i < ARRAY_SIZE(default_keybindings); i++) + if (default_keybindings[i].alias == key) + return default_keybindings[i].request; + + return (enum request) key; +} + + +struct key { + char *name; + int value; +}; + +static struct key key_table[] = { + { "Enter", KEY_RETURN }, + { "Space", ' ' }, + { "Backspace", KEY_BACKSPACE }, + { "Tab", KEY_TAB }, + { "Escape", KEY_ESC }, + { "Left", KEY_LEFT }, + { "Right", KEY_RIGHT }, + { "Up", KEY_UP }, + { "Down", KEY_DOWN }, + { "Insert", KEY_IC }, + { "Delete", KEY_DC }, + { "Home", KEY_HOME }, + { "End", KEY_END }, + { "PageUp", KEY_PPAGE }, + { "PageDown", KEY_NPAGE }, + { "F1", KEY_F(1) }, + { "F2", KEY_F(2) }, + { "F3", KEY_F(3) }, + { "F4", KEY_F(4) }, + { "F5", KEY_F(5) }, + { "F6", KEY_F(6) }, + { "F7", KEY_F(7) }, + { "F8", KEY_F(8) }, + { "F9", KEY_F(9) }, + { "F10", KEY_F(10) }, + { "F11", KEY_F(11) }, + { "F12", KEY_F(12) }, +}; + +static int +get_key_value(const char *name) +{ + int i; + + for (i = 0; i < ARRAY_SIZE(key_table); i++) + if (!strcasecmp(key_table[i].name, name)) + return key_table[i].value; + + if (strlen(name) == 1 && isprint(*name)) + return (int) *name; + + return ERR; +} + +static char * +get_key(enum request request) +{ + static char buf[BUFSIZ]; + static char key_char[] = "'X'"; + int pos = 0; + char *sep = " "; + int i; + + buf[pos] = 0; + + for (i = 0; i < ARRAY_SIZE(default_keybindings); i++) { + struct keybinding *keybinding = &default_keybindings[i]; + char *seq = NULL; + int key; + + if (keybinding->request != request) + continue; + + for (key = 0; key < ARRAY_SIZE(key_table); key++) + if (key_table[key].value == keybinding->alias) + seq = key_table[key].name; + + if (seq == NULL && + keybinding->alias < 127 && + isprint(keybinding->alias)) { + key_char[1] = (char) keybinding->alias; + seq = key_char; + } + + if (!seq) + seq = "'?'"; + + if (!string_format_from(buf, &pos, "%s%s", sep, seq)) + return "Too many keybindings!"; + sep = ", "; + } + + return buf; +} + + +/* + * User config file handling. + */ + +static struct int_map color_map[] = { +#define COLOR_MAP(name) { #name, STRING_SIZE(#name), COLOR_##name } + COLOR_MAP(DEFAULT), + COLOR_MAP(BLACK), + COLOR_MAP(BLUE), + COLOR_MAP(CYAN), + COLOR_MAP(GREEN), + COLOR_MAP(MAGENTA), + COLOR_MAP(RED), + COLOR_MAP(WHITE), + COLOR_MAP(YELLOW), +}; + +#define set_color(color, name) \ + set_from_int_map(color_map, ARRAY_SIZE(color_map), color, name, strlen(name)) + +static struct int_map attr_map[] = { +#define ATTR_MAP(name) { #name, STRING_SIZE(#name), A_##name } + ATTR_MAP(NORMAL), + ATTR_MAP(BLINK), + ATTR_MAP(BOLD), + ATTR_MAP(DIM), + ATTR_MAP(REVERSE), + ATTR_MAP(STANDOUT), + ATTR_MAP(UNDERLINE), +}; + +#define set_attribute(attr, name) \ + set_from_int_map(attr_map, ARRAY_SIZE(attr_map), attr, name, strlen(name)) + +static int config_lineno; +static bool config_errors; +static char *config_msg; + +/* Wants: object fgcolor bgcolor [attr] */ +static int +option_color_command(int argc, char *argv[]) +{ + struct line_info *info; + + if (argc != 3 && argc != 4) { + config_msg = "Wrong number of arguments given to color command"; + return ERR; + } + + info = get_line_info(argv[0], strlen(argv[0])); + if (!info) { + config_msg = "Unknown color name"; + return ERR; + } + + if (set_color(&info->fg, argv[1]) == ERR) { + config_msg = "Unknown color"; + return ERR; + } + + if (set_color(&info->bg, argv[2]) == ERR) { + config_msg = "Unknown color"; + return ERR; + } + + if (argc == 4 && set_attribute(&info->attr, argv[3]) == ERR) { + config_msg = "Unknown attribute"; + return ERR; + } + + return OK; +} + +/* Wants: name = value */ +static int +option_set_command(int argc, char *argv[]) +{ + if (argc != 3) { + config_msg = "Wrong number of arguments given to set command"; + return ERR; + } + + if (strcmp(argv[1], "=")) { + config_msg = "No value assigned"; + return ERR; + } + + if (!strcmp(argv[0], "show-rev-graph")) { + opt_rev_graph = (!strcmp(argv[2], "1") || + !strcmp(argv[2], "true") || + !strcmp(argv[2], "yes")); + return OK; + } + + if (!strcmp(argv[0], "line-number-interval")) { + opt_num_interval = atoi(argv[2]); + return OK; + } + + if (!strcmp(argv[0], "tab-size")) { + opt_tab_size = atoi(argv[2]); + return OK; + } + + if (!strcmp(argv[0], "encoding")) { + string_copy(opt_encoding, argv[2]); + return OK; + } + + return ERR; +} + +/* Wants: mode request key */ +static int +option_bind_command(int argc, char *argv[]) +{ + enum request request; + int keymap; + int key; + + if (argc != 3) { + config_msg = "Wrong number of arguments given to bind command"; + return ERR; + } + + if (set_keymap(&keymap, argv[0]) == ERR) { + config_msg = "Unknown key map"; + return ERR; + } + + key = get_key_value(argv[1]); + if (key == ERR) { + config_msg = "Unknown key"; + return ERR; + } + + request = get_request(argv[2]); + if (request == REQ_UNKNOWN) { + config_msg = "Unknown request name"; + return ERR; + } + + add_keybinding(keymap, request, key); + + return OK; +} + +static int +set_option(char *opt, char *value) +{ + char *argv[16]; + int valuelen; + int argc = 0; + + /* Tokenize */ + while (argc < ARRAY_SIZE(argv) && (valuelen = strcspn(value, " \t"))) { + argv[argc++] = value; + + value += valuelen; + if (!*value) + break; + + *value++ = 0; + while (isspace(*value)) + value++; + } + + if (!strcmp(opt, "color")) + return option_color_command(argc, argv); + + if (!strcmp(opt, "set")) + return option_set_command(argc, argv); + + if (!strcmp(opt, "bind")) + return option_bind_command(argc, argv); + + return ERR; +} + +static int +read_option(char *opt, int optlen, char *value, int valuelen) +{ + config_lineno++; + config_msg = "Internal error"; + + optlen = strcspn(opt, "#;"); + if (optlen == 0) { + /* The whole line is a commend or empty. */ + return OK; + + } else if (opt[optlen] != 0) { + /* Part of the option name is a comment, so the value part + * should be ignored. */ + valuelen = 0; + opt[optlen] = value[valuelen] = 0; + } else { + /* Else look for comment endings in the value. */ + valuelen = strcspn(value, "#;"); + value[valuelen] = 0; + } + + if (set_option(opt, value) == ERR) { + fprintf(stderr, "Error on line %d, near '%.*s' option: %s\n", + config_lineno, optlen, opt, config_msg); + config_errors = TRUE; + } + + /* Always keep going if errors are encountered. */ + return OK; +} + +static int +load_options(void) +{ + char *home = getenv("HOME"); + char buf[1024]; + FILE *file; + + config_lineno = 0; + config_errors = FALSE; + + if (!home || !string_format(buf, "%s/.tigrc", home)) + return ERR; + + /* It's ok that the file doesn't exist. */ + file = fopen(buf, "r"); + if (!file) + return OK; + + if (read_properties(file, " \t", read_option) == ERR || + config_errors == TRUE) + fprintf(stderr, "Errors while loading %s.\n", buf); + + return OK; +} + + +/* * The viewer - * ---------- - * The display consists of a status window on the last line of the screen and - * one or more views. The default is to only show one view at the time but it - * is possible to split both the main and log view to also show the commit - * diff. - * - * If you are in the log view and press 'Enter' when the current line is a - * commit line, such as: - * - * commit 4d55caff4cc89335192f3e566004b4ceef572521 - * - * You will split the view so that the log view is displayed in the top window - * and the diff view in the bottom window. You can switch between the two - * views by pressing 'Tab'. To maximize the log view again, simply press 'l'. - **/ + */ struct view; struct view_ops; @@ -663,18 +1098,7 @@ static unsigned int current_view; #define displayed_views() (display[1] != NULL ? 2 : 1) -/** - * Current head and commit ID - * ~~~~~~~~~~~~~~~~~~~~~~~~~~ - * The viewer keeps track of both what head and commit ID you are currently - * viewing. The commit ID will follow the cursor line and change everytime time - * you highlight a different commit. Whenever you reopen the diff view it - * will be reloaded, if the commit ID changed. - * - * The head ID is used when opening the main and log view to indicate from - * what revision to show history. - **/ - +/* Current head and commit ID */ static char ref_commit[SIZEOF_REF] = "HEAD"; static char ref_head[SIZEOF_REF] = "HEAD"; @@ -686,6 +1110,8 @@ struct view { struct view_ops *ops; /* View operations */ + enum keymap keymap; /* What keymap does this view have */ + char cmd[SIZEOF_CMD]; /* Command buffer */ char ref[SIZEOF_REF]; /* Hovered commit reference */ char vid[SIZEOF_REF]; /* View ID. Set to id member when updating. */ @@ -705,6 +1131,7 @@ struct view { /* Buffering */ unsigned long lines; /* Total number of lines */ struct line *line; /* Line index */ + unsigned long line_size;/* Total number of allocated lines */ unsigned int digits; /* Number of digits in the lines member. */ /* Loading */ @@ -718,7 +1145,7 @@ struct view_ops { /* Draw one line; @lineno must be < view->height. */ bool (*draw)(struct view *view, struct line *line, unsigned int lineno); /* Read one line; updates view->line. */ - bool (*read)(struct view *view, struct line *prev, char *data); + bool (*read)(struct view *view, char *data); /* Depending on view, change display based on current line. */ bool (*enter)(struct view *view, struct line *line); }; @@ -726,41 +1153,12 @@ struct view_ops { static struct view_ops pager_ops; static struct view_ops main_ops; -#define VIEW_STR(name, cmd, env, ref, ops) \ - { name, cmd, #env, ref, ops } +#define VIEW_STR(name, cmd, env, ref, ops, map) \ + { name, cmd, #env, ref, ops, map} #define VIEW_(id, name, ops, ref) \ - VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, ops) + VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, ops, KEYMAP_##id) -/** - * Views - * ~~~~~ - * tig(1) presents various 'views' of a repository. Each view is based on output - * from an external command, most often 'git log', 'git diff', or 'git show'. - * - * The main view:: - * Is the default view, and it shows a one line summary of each commit - * in the chosen list of revisions. The summary includes commit date, - * author, and the first line of the log message. Additionally, any - * repository references, such as tags, will be shown. - * - * The log view:: - * Presents a more rich view of the revision log showing the whole log - * message and the diffstat. - * - * The diff view:: - * Shows either the diff of the current working tree, that is, what - * has changed since the last commit, or the commit diff complete - * with log message, diffstat and diff. - * - * The pager view:: - * Is used for displaying both input from stdin and output from git - * commands entered in the internal prompt. - * - * The help view:: - * Displays the information from the tig(1) man page. For the help view - * to work you need to have the tig(1) man page installed. - **/ static struct view views[] = { VIEW_(MAIN, "main", &main_ops, ref_head), @@ -804,17 +1202,6 @@ redraw_view(struct view *view) } -/** - * Title windows - * ~~~~~~~~~~~~~ - * Each view has a title window which shows the name of the view, current - * commit ID if available, and where the view is positioned: - * - * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%) - * - * By default, the title of the current view is highlighted using bold font. - **/ - static void update_view_title(struct view *view) { @@ -832,8 +1219,9 @@ update_view_title(struct view *view) wprintw(view->title, "[%s]", view->name); if (view->lines || view->pipe) { + unsigned int view_lines = view->offset + view->height; unsigned int lines = view->lines - ? (view->lineno + 1) * 100 / view->lines + ? MIN(view_lines, view->lines) * 100 / view->lines : 0; wprintw(view->title, " - %s %d of %d (%d%%)", @@ -851,7 +1239,7 @@ update_view_title(struct view *view) wprintw(view->title, " %lds", secs); } - + wmove(view->title, 0, view->width - 1); wrefresh(view->title); } @@ -900,7 +1288,6 @@ resize_display(void) wresize(view->win, view->height, view->width); mvwin(view->win, offset, 0); mvwin(view->title, offset + view->height, 0); - wrefresh(view->win); } offset += view->height + 1; @@ -919,6 +1306,20 @@ redraw_display(void) } } +static void +update_display_cursor(void) +{ + struct view *view = display[current_view]; + + /* Move the cursor to the right-most column of the cursor line. + * + * XXX: This could turn out to be a bit expensive, but it ensures that + * the cursor does not jump around. */ + if (view->lines) { + wmove(view->win, view->lineno - view->offset, view->width - 1); + wrefresh(view->win); + } +} /* * Navigation @@ -1140,8 +1541,7 @@ begin_update(struct view *view) } else { const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt; - if (snprintf(view->cmd, sizeof(view->cmd), format, - id, id, id, id, id) >= sizeof(view->cmd)) + if (!string_format(view->cmd, format, id, id, id, id, id)) return FALSE; } @@ -1179,12 +1579,24 @@ begin_update(struct view *view) return TRUE; } +static struct line * +realloc_lines(struct view *view, size_t line_size) +{ + struct line *tmp = realloc(view->line, sizeof(*view->line) * line_size); + + if (!tmp) + return NULL; + + view->line = tmp; + view->line_size = line_size; + return view->line; +} + static bool update_view(struct view *view) { char buffer[BUFSIZ]; char *line; - struct line *tmp; /* The number of lines to read. If too low it will cause too much * redrawing (and possible flickering), if too high responsiveness * will suffer. */ @@ -1198,23 +1610,16 @@ update_view(struct view *view) if (view->offset + view->height >= view->lines) redraw_from = view->lines - view->offset; - tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines)); - if (!tmp) + if (!realloc_lines(view, view->lines + lines)) goto alloc_error; - view->line = tmp; - while ((line = fgets(buffer, sizeof(buffer), view->pipe))) { int linelen = strlen(line); - struct line *prev = view->lines - ? &view->line[view->lines - 1] - : NULL; - if (linelen) line[linelen - 1] = 0; - if (!view->ops->read(view, prev, line)) + if (!view->ops->read(view, line)) goto alloc_error; if (lines-- == 1) @@ -1255,20 +1660,6 @@ update_view(struct view *view) goto end; } else if (feof(view->pipe)) { - if (view == VIEW(REQ_VIEW_HELP)) { - const char *msg = TIG_HELP; - - if (view->lines == 0) { - /* Slightly ugly, but abusing view->ref keeps - * the error message. */ - string_copy(view->ref, "No help available"); - msg = "The tig(1) manpage is not installed"; - } - - report("%s", msg); - goto end; - } - report(""); goto end; } @@ -1283,6 +1674,49 @@ end: return FALSE; } + +/* + * View opening + */ + +static void open_help_view(struct view *view) +{ + char buf[BUFSIZ]; + int lines = ARRAY_SIZE(req_info) + 2; + int i; + + if (view->lines > 0) + return; + + for (i = 0; i < ARRAY_SIZE(req_info); i++) + if (!req_info[i].request) + lines++; + + view->line = calloc(lines, sizeof(*view->line)); + if (!view->line) { + report("Allocation failure"); + return; + } + + view->ops->read(view, "Quick reference for tig keybindings:"); + + for (i = 0; i < ARRAY_SIZE(req_info); i++) { + char *key; + + if (!req_info[i].request) { + view->ops->read(view, ""); + view->ops->read(view, req_info[i].help); + continue; + } + + key = get_key(req_info[i].request); + if (!string_format(buf, "%-25s %s", key, req_info[i].help)) + continue; + + view->ops->read(view, buf); + } +} + enum open_flags { OPEN_DEFAULT = 0, /* Use default view switching. */ OPEN_SPLIT = 1, /* Split current view. */ @@ -1305,16 +1739,19 @@ open_view(struct view *prev, enum request request, enum open_flags flags) return; } - if ((reload || strcmp(view->vid, view->id)) && - !begin_update(view)) { + if (view == VIEW(REQ_VIEW_HELP)) { + open_help_view(view); + + } else if ((reload || strcmp(view->vid, view->id)) && + !begin_update(view)) { report("Failed to load %s view", view->name); return; } if (split) { - display[current_view + 1] = view; + display[1] = view; if (!backgrounded) - current_view++; + current_view = 1; } else { /* Maximize the current view. */ memset(display, 0, sizeof(display)); @@ -1338,27 +1775,22 @@ open_view(struct view *prev, enum request request, enum open_flags flags) } if (prev && view != prev) { - /* Continue loading split views in the background. */ - if (!split) - end_update(prev); - else if (!backgrounded) + if (split && !backgrounded) { /* "Blur" the previous view. */ update_view_title(prev); + } view->parent = prev; } - if (view->pipe) { + if (view->pipe && view->lines == 0) { /* Clear the old view and let the incremental updating refill * the screen. */ wclear(view->win); report(""); } else { redraw_view(view); - if (view == VIEW(REQ_VIEW_HELP)) - report("%s", TIG_HELP); - else - report(""); + report(""); } /* If the view is backgrounded the above calls to report() @@ -1443,20 +1875,26 @@ view_driver(struct view *view, enum request request) report(""); break; } - case REQ_TOGGLE_LINE_NUMBERS: + case REQ_TOGGLE_LINENO: opt_line_number = !opt_line_number; redraw_display(); break; + case REQ_TOGGLE_REV_GRAPH: + opt_rev_graph = !opt_rev_graph; + redraw_display(); + break; + case REQ_PROMPT: /* Always reload^Wrerun commands from the prompt. */ open_view(view, opt_request, OPEN_RELOAD); break; case REQ_STOP_LOADING: - foreach_view (view, i) { + for (i = 0; i < ARRAY_SIZE(views); i++) { + view = &views[i]; if (view->pipe) - report("Stopped loaded the %s view", view->name), + report("Stopped loading the %s view", view->name), end_update(view); } break; @@ -1477,11 +1915,15 @@ view_driver(struct view *view, enum request request) return TRUE; case REQ_VIEW_CLOSE: - if (view->parent) { + /* XXX: Mark closed views by letting view->parent point to the + * view itself. Parents to closed view should never be + * followed. */ + if (view->parent && + view->parent->parent != view->parent) { memset(display, 0, sizeof(display)); current_view = 0; display[current_view] = view->parent; - view->parent = NULL; + view->parent = view; resize_display(); redraw_display(); break; @@ -1579,21 +2021,59 @@ pager_draw(struct view *view, struct line *line, unsigned int lineno) return TRUE; } +static void +add_pager_refs(struct view *view, struct line *line) +{ + char buf[1024]; + char *data = line->data; + struct ref **refs; + int bufpos = 0, refpos = 0; + const char *sep = "Refs: "; + + assert(line->type == LINE_COMMIT); + + refs = get_refs(data + STRING_SIZE("commit ")); + if (!refs) + return; + + do { + struct ref *ref = refs[refpos]; + char *fmt = ref->tag ? "%s[%s]" : "%s%s"; + + if (!string_format_from(buf, &bufpos, fmt, sep, ref->name)) + return; + sep = ", "; + } while (refs[refpos++]->next); + + if (!realloc_lines(view, view->line_size + 1)) + return; + + line = &view->line[view->lines]; + line->data = strdup(buf); + if (!line->data) + return; + + line->type = LINE_PP_REFS; + view->lines++; +} + static bool -pager_read(struct view *view, struct line *prev, char *line) +pager_read(struct view *view, char *data) { - /* Compress empty lines in the help view. */ - if (view == VIEW(REQ_VIEW_HELP) && - !*line && prev && !*((char *) prev->data)) - return TRUE; + struct line *line = &view->line[view->lines]; - view->line[view->lines].data = strdup(line); - if (!view->line[view->lines].data) + line->data = strdup(data); + if (!line->data) return FALSE; - view->line[view->lines].type = get_line_type(line); - + line->type = get_line_type(line->data); view->lines++; + + if (line->type == LINE_COMMIT && + (view == VIEW(REQ_VIEW_DIFF) || + view == VIEW(REQ_VIEW_LOG))) + add_pager_refs(view, line); + return TRUE; } @@ -1615,8 +2095,8 @@ pager_enter(struct view *view, struct line *line) scroll_view(view, REQ_SCROLL_LINE_DOWN); /* FIXME: A minor workaround. Scrolling the view will call report("") - * but if we are scolling a non-current view this won't properly update - * the view title. */ + * but if we are scrolling a non-current view this won't properly + * update the view title. */ if (split) update_view_title(view); @@ -1636,11 +2116,13 @@ static struct view_ops pager_ops = { */ struct commit { - char id[41]; /* SHA1 ID. */ - char title[75]; /* The first line of the commit message. */ - char author[75]; /* The author of the commit. */ - struct tm time; /* Date from the author ident. */ - struct ref **refs; /* Repository references; tags & branch heads. */ + char id[41]; /* SHA1 ID. */ + char title[75]; /* First line of the commit message. */ + char author[75]; /* Author of the commit. */ + struct tm time; /* Date from the author ident. */ + struct ref **refs; /* Repository references. */ + chtype graph[SIZEOF_REVGRAPH]; /* Ancestry chain graphics. */ + size_t graph_size; /* The width of the graph array. */ }; static bool @@ -1652,7 +2134,7 @@ main_draw(struct view *view, struct line *line, unsigned int lineno) int col = 0; size_t timelen; size_t authorlen; - int trimmed; + int trimmed = 1; if (!*commit->author) return FALSE; @@ -1680,8 +2162,15 @@ main_draw(struct view *view, struct line *line, unsigned int lineno) if (type != LINE_CURSOR) wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR)); - /* FIXME: Make this optional, and add i18n.commitEncoding support. */ - authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed); + if (opt_utf8) { + authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed); + } else { + authorlen = strlen(commit->author); + if (authorlen > AUTHOR_COLS - 2) { + authorlen = AUTHOR_COLS - 2; + trimmed = 1; + } + } if (trimmed) { waddnstr(view->win, commit->author, authorlen); @@ -1696,9 +2185,19 @@ main_draw(struct view *view, struct line *line, unsigned int lineno) if (type != LINE_CURSOR) wattrset(view->win, A_NORMAL); - mvwaddch(view->win, lineno, col, ACS_LTEE); - wmove(view->win, lineno, col + 2); - col += 2; + if (opt_rev_graph && commit->graph_size) { + size_t i; + + wmove(view->win, lineno, col); + /* Using waddch() instead of waddnstr() ensures that + * they'll be rendered correctly for the cursor line. */ + for (i = 0; i < commit->graph_size; i++) + waddch(view->win, commit->graph[i]); + + col += commit->graph_size + 1; + } + + wmove(view->win, lineno, col); if (commit->refs) { size_t i = 0; @@ -1737,10 +2236,11 @@ main_draw(struct view *view, struct line *line, unsigned int lineno) /* Reads git log --pretty=raw output and parses it into the commit struct. */ static bool -main_read(struct view *view, struct line *prev, char *line) +main_read(struct view *view, char *line) { enum line_type type = get_line_type(line); - struct commit *commit; + struct commit *commit = view->lines + ? view->line[view->lines - 1].data : NULL; switch (type) { case LINE_COMMIT: @@ -1753,6 +2253,7 @@ main_read(struct view *view, struct line *prev, char *line) view->line[view->lines++].data = commit; string_copy(commit->id, line); commit->refs = get_refs(commit->id); + commit->graph[commit->graph_size++] = ACS_LTEE; break; case LINE_AUTHOR: @@ -1760,11 +2261,9 @@ main_read(struct view *view, struct line *prev, char *line) char *ident = line + STRING_SIZE("author "); char *end = strchr(ident, '<'); - if (!prev) + if (!commit) break; - commit = prev->data; - if (end) { for (; end > ident && isspace(end[-1]); end--) ; *end = 0; @@ -1803,11 +2302,9 @@ main_read(struct view *view, struct line *prev, char *line) break; } default: - if (!prev) + if (!commit) break; - commit = prev->data; - /* Fill in the commit title if it has not already been set. */ if (commit->title[0]) break; @@ -1843,161 +2340,6 @@ static struct view_ops main_ops = { }; -/** - * KEYS - * ---- - * Below the default key bindings are shown. - **/ - -struct keymap { - int alias; - int request; -}; - -static struct keymap keymap[] = { - /** - * View switching - * ~~~~~~~~~~~~~~ - * m:: - * Switch to main view. - * d:: - * Switch to diff view. - * l:: - * Switch to log view. - * p:: - * Switch to pager view. - * h:: - * Show man page. - **/ - { 'm', REQ_VIEW_MAIN }, - { 'd', REQ_VIEW_DIFF }, - { 'l', REQ_VIEW_LOG }, - { 'p', REQ_VIEW_PAGER }, - { 'h', REQ_VIEW_HELP }, - - /** - * View manipulation - * ~~~~~~~~~~~~~~~~~ - * q:: - * Close view, if multiple views are open it will jump back to the - * previous view in the view stack. If it is the last open view it - * will quit. Use 'Q' to quit all views at once. - * Enter:: - * This key is "context sensitive" depending on what view you are - * currently in. When in log view on a commit line or in the main - * view, split the view and show the commit diff. In the diff view - * pressing Enter will simply scroll the view one line down. - * Tab:: - * Switch to next view. - * Up:: - * This key is "context sensitive" and will move the cursor one - * line up. However, uf you opened a diff view from the main view - * (split- or full-screen) it will change the cursor to point to - * the previous commit in the main view and update the diff view - * to display it. - * Down:: - * Similar to 'Up' but will move down. - **/ - { 'q', REQ_VIEW_CLOSE }, - { KEY_TAB, REQ_VIEW_NEXT }, - { KEY_RETURN, REQ_ENTER }, - { KEY_UP, REQ_PREVIOUS }, - { KEY_DOWN, REQ_NEXT }, - - /** - * Cursor navigation - * ~~~~~~~~~~~~~~~~~ - * j:: - * Move cursor one line up. - * k:: - * Move cursor one line down. - * PgUp:: - * b:: - * -:: - * Move cursor one page up. - * PgDown:: - * Space:: - * Move cursor one page down. - * Home:: - * Jump to first line. - * End:: - * Jump to last line. - **/ - { 'k', REQ_MOVE_UP }, - { 'j', REQ_MOVE_DOWN }, - { KEY_HOME, REQ_MOVE_FIRST_LINE }, - { KEY_END, REQ_MOVE_LAST_LINE }, - { KEY_NPAGE, REQ_MOVE_PAGE_DOWN }, - { ' ', REQ_MOVE_PAGE_DOWN }, - { KEY_PPAGE, REQ_MOVE_PAGE_UP }, - { 'b', REQ_MOVE_PAGE_UP }, - { '-', REQ_MOVE_PAGE_UP }, - - /** - * Scrolling - * ~~~~~~~~~ - * Insert:: - * Scroll view one line up. - * Delete:: - * Scroll view one line down. - * w:: - * Scroll view one page up. - * s:: - * Scroll view one page down. - **/ - { KEY_IC, REQ_SCROLL_LINE_UP }, - { KEY_DC, REQ_SCROLL_LINE_DOWN }, - { 'w', REQ_SCROLL_PAGE_UP }, - { 's', REQ_SCROLL_PAGE_DOWN }, - - /** - * Misc - * ~~~~ - * Q:: - * Quit. - * r:: - * Redraw screen. - * z:: - * Stop all background loading. This can be useful if you use - * tig(1) in a repository with a long history without limiting - * the revision log. - * v:: - * Show version. - * n:: - * Toggle line numbers on/off. - * ':':: - * Open prompt. This allows you to specify what git command - * to run. Example: - * - * :log -p - **/ - { 'Q', REQ_QUIT }, - { 'z', REQ_STOP_LOADING }, - { 'v', REQ_SHOW_VERSION }, - { 'r', REQ_SCREEN_REDRAW }, - { 'n', REQ_TOGGLE_LINE_NUMBERS }, - { ':', REQ_PROMPT }, - - /* wgetch() with nodelay() enabled returns ERR when there's no input. */ - { ERR, REQ_SCREEN_UPDATE }, - - /* Use the ncurses SIGWINCH handler. */ - { KEY_RESIZE, REQ_SCREEN_RESIZE }, -}; - -static enum request -get_request(int key) -{ - int i; - - for (i = 0; i < ARRAY_SIZE(keymap); i++) - if (keymap[i].alias == key) - return keymap[i].request; - - return (enum request) key; -} - - /* * Unicode / UTF-8 handling * @@ -2194,15 +2536,7 @@ report(const char *msg, ...) } update_view_title(view); - - /* Move the cursor to the right-most column of the cursor line. - * - * XXX: This could turn out to be a bit expensive, but it ensures that - * the cursor does not jump around. */ - if (view->lines) { - wmove(view->win, view->lineno - view->offset, view->width - 1); - wrefresh(view->win); - } + update_display_cursor(); } /* Controls when nodelay should be in effect when polling user input. */ @@ -2314,83 +2648,118 @@ get_refs(char *id) } static int +read_ref(char *id, int idlen, char *name, int namelen) +{ + struct ref *ref; + bool tag = FALSE; + + if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) { + /* Commits referenced by tags has "^{}" appended. */ + if (name[namelen - 1] != '}') + return OK; + + while (namelen > 0 && name[namelen] != '^') + namelen--; + + tag = TRUE; + namelen -= STRING_SIZE("refs/tags/"); + name += STRING_SIZE("refs/tags/"); + + } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) { + namelen -= STRING_SIZE("refs/heads/"); + name += STRING_SIZE("refs/heads/"); + + } else if (!strcmp(name, "HEAD")) { + return OK; + } + + refs = realloc(refs, sizeof(*refs) * (refs_size + 1)); + if (!refs) + return ERR; + + ref = &refs[refs_size++]; + ref->name = malloc(namelen + 1); + if (!ref->name) + return ERR; + + strncpy(ref->name, name, namelen); + ref->name[namelen] = 0; + ref->tag = tag; + string_copy(ref->id, id); + + return OK; +} + +static int load_refs(void) { const char *cmd_env = getenv("TIG_LS_REMOTE"); const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE; - FILE *pipe = popen(cmd, "r"); - char buffer[BUFSIZ]; - char *line; - if (!pipe) - return ERR; + return read_properties(popen(cmd, "r"), "\t", read_ref); +} - while ((line = fgets(buffer, sizeof(buffer), pipe))) { - char *name = strchr(line, '\t'); - struct ref *ref; - int namelen; - bool tag = FALSE; - bool tag_commit = FALSE; +static int +read_repo_config_option(char *name, int namelen, char *value, int valuelen) +{ + if (!strcmp(name, "i18n.commitencoding")) + string_copy(opt_encoding, value); - if (!name) - continue; + return OK; +} - *name++ = 0; - namelen = strlen(name) - 1; +static int +load_repo_config(void) +{ + return read_properties(popen("git repo-config --list", "r"), + "=", read_repo_config_option); +} - /* Commits referenced by tags has "^{}" appended. */ - if (name[namelen - 1] == '}') { - while (namelen > 0 && name[namelen] != '^') - namelen--; - if (namelen > 0) - tag_commit = TRUE; - } - name[namelen] = 0; +static int +read_properties(FILE *pipe, const char *separators, + int (*read_property)(char *, int, char *, int)) +{ + char buffer[BUFSIZ]; + char *name; + int state = OK; - if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) { - if (!tag_commit) - continue; - name += STRING_SIZE("refs/tags/"); - tag = TRUE; + if (!pipe) + return ERR; - } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) { - name += STRING_SIZE("refs/heads/"); + while (state == OK && (name = fgets(buffer, sizeof(buffer), pipe))) { + char *value; + size_t namelen; + size_t valuelen; - } else if (!strcmp(name, "HEAD")) { - continue; - } + name = chomp_string(name); + namelen = strcspn(name, separators); - refs = realloc(refs, sizeof(*refs) * (refs_size + 1)); - if (!refs) - return ERR; + if (name[namelen]) { + name[namelen] = 0; + value = chomp_string(name + namelen + 1); + valuelen = strlen(value); - ref = &refs[refs_size++]; - ref->tag = tag; - ref->name = strdup(name); - if (!ref->name) - return ERR; + } else { + value = ""; + valuelen = 0; + } - string_copy(ref->id, line); + state = read_property(name, namelen, value, valuelen); } - if (ferror(pipe)) - return ERR; + if (state != ERR && ferror(pipe)) + state = ERR; pclose(pipe); - return OK; + return state; } + /* * Main */ -#if __GNUC__ >= 3 -#define __NORETURN __attribute__((__noreturn__)) -#else -#define __NORETURN -#endif - static void __NORETURN quit(int sig) { @@ -2425,6 +2794,14 @@ main(int argc, char *argv[]) signal(SIGINT, quit); + if (load_options() == ERR) + die("Failed to load user config."); + + /* Load the repo config file so options can be overwritten from + * the command line. */ + if (load_repo_config() == ERR) + die("Failed to load repo config."); + if (!parse_options(argc, argv)) return 0; @@ -2451,7 +2828,8 @@ main(int argc, char *argv[]) /* Refresh, accept single keystroke of input */ key = wgetch(status_win); - request = get_request(key); + + request = get_keybinding(display[current_view]->keymap, key); /* Some low-level request handling. This keeps access to * status_win restricted. */ @@ -2467,7 +2845,9 @@ main(int argc, char *argv[]) memcpy(opt_cmd, "git ", 4); opt_request = REQ_VIEW_PAGER; } else { - request = ERR; + report("Prompt interrupted by loading view, " + "press 'z' to stop loading views"); + request = REQ_SCREEN_UPDATE; } noecho(); @@ -2496,138 +2876,3 @@ main(int argc, char *argv[]) return 0; } - -/** - * [[refspec]] - * Revision specification - * ---------------------- - * This section describes various ways to specify what revisions to display - * or otherwise limit the view to. tig(1) does not itself parse the described - * revision options so refer to the relevant git man pages for futher - * information. Relevant man pages besides git-log(1) are git-diff(1) and - * git-rev-list(1). - * - * You can tune the interaction with git by making use of the options - * explained in this section. For example, by configuring the environment - * variables described in the <> section. - * - * Limit by path name - * ~~~~~~~~~~~~~~~~~~ - * If you are interested only in those revisions that made changes to a - * specific file (or even several files) list the files like this: - * - * $ tig log Makefile README - * - * To avoid ambiguity with repository references such as tag name, be sure - * to separate file names from other git options using "\--". So if you - * have a file named 'master' it will clash with the reference named - * 'master', and thus you will have to use: - * - * $ tig log -- master - * - * NOTE: For the main view, avoiding ambiguity will in some cases require - * you to specify two "\--" options. The first will make tig(1) stop - * option processing and the latter will be passed to git log. - * - * Limit by date or number - * ~~~~~~~~~~~~~~~~~~~~~~~ - * To speed up interaction with git, you can limit the amount of commits - * to show both for the log and main view. Either limit by date using - * e.g. `--since=1.month` or limit by the number of commits using `-n400`. - * - * If you are only interested in changed that happened between two dates - * you can use: - * - * $ tig -- --after="May 5th" --before="2006-05-16 15:44" - * - * NOTE: If you want to avoid having to quote dates containing spaces you - * can use "." instead, e.g. `--after=May.5th`. - * - * Limiting by commit ranges - * ~~~~~~~~~~~~~~~~~~~~~~~~~ - * Alternatively, commits can be limited to a specific range, such as - * "all commits between 'tag-1.0' and 'tag-2.0'". For example: - * - * $ tig log tag-1.0..tag-2.0 - * - * This way of commit limiting makes it trivial to only browse the commits - * which haven't been pushed to a remote branch. Assuming 'origin' is your - * upstream remote branch, using: - * - * $ tig log origin..HEAD - * - * will list what will be pushed to the remote branch. Optionally, the ending - * 'HEAD' can be left out since it is implied. - * - * Limiting by reachability - * ~~~~~~~~~~~~~~~~~~~~~~~~ - * Git interprets the range specifier "tag-1.0..tag-2.0" as - * "all commits reachable from 'tag-2.0' but not from 'tag-1.0'". - * Where reachability refers to what commits are ancestors (or part of the - * history) of the branch or tagged revision in question. - * - * If you prefer to specify which commit to preview in this way use the - * following: - * - * $ tig log tag-2.0 ^tag-1.0 - * - * You can think of '^' as a negation operator. Using this alternate syntax, - * it is possible to further prune commits by specifying multiple branch - * cut offs. - * - * Combining revisions specification - * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - * Revisions options can to some degree be combined, which makes it possible - * to say "show at most 20 commits from within the last month that changed - * files under the Documentation/ directory." - * - * $ tig -- --since=1.month -n20 -- Documentation/ - * - * Examining all repository references - * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - * In some cases, it can be useful to query changes across all references - * in a repository. An example is to ask "did any line of development in - * this repository change a particular file within the last week". This - * can be accomplished using: - * - * $ tig -- --all --since=1.week -- Makefile - * - * BUGS - * ---- - * Known bugs and problems: - * - * - In it's current state tig is pretty much UTF-8 only. - * - * - If the screen width is very small the main view can draw - * outside the current view causing bad wrapping. Same goes - * for title and status windows. - * - * - The cursor can wrap-around on the last line and cause the - * window to scroll. - * - * TODO - * ---- - * Features that should be explored. - * - * - Searching. - * - * - Locale support. - * - * COPYRIGHT - * --------- - * Copyright (c) 2006 Jonas Fonseca - * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 2 of the License, or - * (at your option) any later version. - * - * SEE ALSO - * -------- - * [verse] - * link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)], - * link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)] - * gitk(1): git repository browser written using tcl/tk, - * qgit(1): git repository browser written using c++/Qt, - * gitview(1): git repository browser written using python/gtk. - **/