X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/b76c2afc7513ecf74694a73bf004bfb4315758f6..c34d9c9f0e09a3ec6e990294a7baceaf4d940259:/tig.c diff --git a/tig.c b/tig.c index b29a2eb..20abf80 100644 --- a/tig.c +++ b/tig.c @@ -1,3 +1,5 @@ +/* Copyright (c) 2006 Jonas Fonseca + * See license info at the bottom. */ /** * TIG(1) * ====== @@ -10,66 +12,174 @@ * -------- * [verse] * tig [options] + * tig [options] [--] [git log options] * tig [options] log [git log options] * tig [options] diff [git diff options] - * tig [options] < [git log or git diff output] + * tig [options] show [git show options] + * tig [options] < [git command output] * * DESCRIPTION * ----------- * Browse changes in a git repository. **/ -#define DEBUG -#ifndef DEBUG -#define NDEBUG -#endif - #ifndef VERSION #define VERSION "tig-0.1" #endif +#ifndef DEBUG +#define NDEBUG +#endif + #include +#include #include #include #include #include #include #include +#include #include #include -#include static void die(const char *err, ...); static void report(const char *msg, ...); +static void set_nonblocking_input(bool loading); + +#define ABS(x) ((x) >= 0 ? (x) : -(x)) +#define MIN(x, y) ((x) < (y) ? (x) : (y)) #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0])) +#define STRING_SIZE(x) (sizeof(x) - 1) + +#define SIZEOF_REF 256 /* Size of symbolic or SHA1 ID. */ +#define SIZEOF_CMD 1024 /* Size of command buffer. */ + +/* This color name can be used to refer to the default term colors. */ +#define COLOR_DEFAULT (-1) + +/* 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 ") -#define KEY_TAB 9 +/* The default interval between line numbers. */ +#define NUMBER_INTERVAL 1 + +#define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3) + +/* Some ascii-shorthands fitted into the ncurses namespace. */ +#define KEY_TAB '\t' +#define KEY_RETURN '\r' #define KEY_ESC 27 -#define KEY_DEL 127 -#define REQ_OFFSET (MAX_COMMAND + 1) +/* 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_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; + char id[41]; + unsigned int tag:1; + unsigned int next:1; +}; + +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. */ +}; + +/* + * String helpers + */ -/* Requests for switching between the different views. */ -#define REQ_DIFF (REQ_OFFSET + 0) -#define REQ_LOG (REQ_OFFSET + 1) -#define REQ_MAIN (REQ_OFFSET + 2) -#define REQ_VIEWS (REQ_OFFSET + 3) +static inline void +string_ncopy(char *dst, char *src, int dstlen) +{ + strncpy(dst, src, dstlen - 1); + dst[dstlen - 1] = 0; -#define REQ_QUIT (REQ_OFFSET + 11) -#define REQ_VERSION (REQ_OFFSET + 12) -#define REQ_STOP (REQ_OFFSET + 13) -#define REQ_UPDATE (REQ_OFFSET + 14) -#define REQ_REDRAW (REQ_OFFSET + 15) -#define REQ_FIRST_LINE (REQ_OFFSET + 16) -#define REQ_LAST_LINE (REQ_OFFSET + 17) -#define REQ_LINE_NUMBER (REQ_OFFSET + 18) +} -#define SIZEOF_VIEWS (REQ_VIEWS - REQ_OFFSET) -#define SIZEOF_ID 1024 +/* Shorthand for safely copying into a fixed buffer. */ +#define string_copy(dst, src) \ + string_ncopy(dst, src, sizeof(dst)) -#define COLOR_TRANSP (-1) +/* Shell quoting + * + * NOTE: The following is a slightly modified copy of the git project's shell + * quoting routines found in the quote.c file. + * + * Help to copy the thing properly quoted for the shell safety. any single + * quote is replaced with '\'', any exclamation point is replaced with '\!', + * and the whole thing is enclosed in a + * + * E.g. + * original sq_quote result + * name ==> name ==> 'name' + * a b ==> a b ==> 'a b' + * a'b ==> a'\''b ==> 'a'\''b' + * a!b ==> a'\!'b ==> 'a'\!'b' + */ + +static size_t +sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src) +{ + char c; + +#define BUFPUT(x) ( (bufsize < SIZEOF_CMD) && (buf[bufsize++] = (x)) ) + + BUFPUT('\''); + while ((c = *src++)) { + if (c == '\'' || c == '!') { + BUFPUT('\''); + BUFPUT('\\'); + BUFPUT(c); + BUFPUT('\''); + } else { + BUFPUT(c); + } + } + BUFPUT('\''); + + return bufsize; +} /** @@ -77,15 +187,14 @@ static void report(const char *msg, ...); * ------- **/ -static int opt_line_number; -static int opt_request = REQ_MAIN; - -char head_id[SIZEOF_ID] = "HEAD"; -char commit_id[SIZEOF_ID] = "HEAD"; - +static int opt_line_number = FALSE; +static int opt_num_interval = NUMBER_INTERVAL; +static enum request opt_request = REQ_VIEW_MAIN; +static char opt_cmd[SIZEOF_CMD] = ""; +static FILE *opt_pipe = NULL; /* Returns the index of log or diff command or -1 to exit. */ -static int +static bool parse_options(int argc, char *argv[]) { int i; @@ -94,293 +203,471 @@ parse_options(int argc, char *argv[]) char *opt = argv[i]; /** - * log [options]:: - * git log options. - **/ - if (!strcmp(opt, "log")) { - opt_request = REQ_LOG; - return i; - - /** - * diff [options]:: - * git diff options. - **/ - } else if (!strcmp(opt, "diff")) { - opt_request = REQ_DIFF; - return i; - - /** * -l:: - * Start up in log view. + * Start up in log view using the internal log command. **/ - } else if (!strcmp(opt, "-l")) { - opt_request = REQ_LOG; + if (!strcmp(opt, "-l")) { + opt_request = REQ_VIEW_LOG; + continue; + } /** * -d:: - * Start up in diff view. + * Start up in diff view using the internal diff command. **/ - } else if (!strcmp(opt, "-d")) { - opt_request = REQ_DIFF; + if (!strcmp(opt, "-d")) { + opt_request = REQ_VIEW_DIFF; + continue; + } /** - * -n, --line-number:: + * -n[INTERVAL], --line-number[=INTERVAL]:: * Prefix line numbers in log and diff view. + * Optionally, with interval different than each line. **/ - } else if (!strcmp(opt, "-n") || - !strcmp(opt, "--line-number")) { - opt_line_number = 1; + 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); + + opt_line_number = TRUE; + continue; + } /** * -v, --version:: * Show version and exit. **/ - } else if (!strcmp(opt, "-v") || - !strcmp(opt, "--version")) { + if (!strcmp(opt, "-v") || + !strcmp(opt, "--version")) { printf("tig version %s\n", VERSION); - return -1; + return FALSE; + } /** - * ref:: - * Commit reference, symbolic or raw SHA1 ID. + * \--:: + * End of tig(1) options. Useful when specifying commands + * for the main view. Example: + * + * $ tig -- --since=1.month **/ - } else if (opt[0] && opt[0] != '-') { - strncpy(head_id, opt, SIZEOF_ID); - strncpy(commit_id, opt, SIZEOF_ID); + if (!strcmp(opt, "--")) { + i++; + break; + } - } else { - die("Unknown command: '%s'", opt); + /** + * log [options]:: + * Open log view using the given git log options. + * + * diff [options]:: + * Open diff view using the given git diff options. + * + * show [options]:: + * Open diff view using the given git show options. + **/ + if (!strcmp(opt, "log") || + !strcmp(opt, "diff") || + !strcmp(opt, "show")) { + opt_request = opt[0] == 'l' + ? REQ_VIEW_LOG : REQ_VIEW_DIFF; + break; } + + /* Make stuff like: + * + * $ tig tag-1.0..HEAD + * + * work. */ + if (opt[0] && opt[0] != '-') + break; + + die("unknown command '%s'", opt); } - return i; -} + 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; -/* - * Line-oriented content detection. - */ + /** + * 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 used. + * + * NOTE: It is possible to specify options even for the main + * view. If doing this you should not touch the `--pretty` + * option. + * + * Example on how to open the log view and show both author and + * committer information: + * + * $ tig log --pretty=fuller + **/ -enum line_type { - LINE_DEFAULT, - LINE_AUTHOR, - LINE_AUTHOR_IDENT, - LINE_COMMIT, - LINE_COMMITTER, - LINE_CURSOR, - LINE_DATE, - LINE_DIFF, - LINE_DIFF_ADD, - LINE_DIFF_CHUNK, - LINE_DIFF_COPY, - LINE_DIFF_DEL, - LINE_DIFF_DISSIM, - LINE_DIFF_NEWMODE, - LINE_DIFF_OLDMODE, - LINE_DIFF_RENAME, - LINE_DIFF_SIM, - LINE_DIFF_TREE, - LINE_INDEX, - LINE_MAIN_AUTHOR, - LINE_MAIN_COMMIT, - LINE_MAIN_DATE, - LINE_MAIN_DELIM, - LINE_MERGE, - LINE_PARENT, - LINE_STATUS, - LINE_TITLE, - LINE_TREE, -}; + if (opt_request == REQ_VIEW_MAIN) + /* XXX: This is vulnerable to the user overriding + * options required for the main view parser. */ + string_copy(opt_cmd, "git log --stat --pretty=raw"); + else + string_copy(opt_cmd, "git"); + buf_size = strlen(opt_cmd); -struct line_info { - enum line_type type; - char *line; - int linelen; + while (buf_size < sizeof(opt_cmd) && i < argc) { + opt_cmd[buf_size++] = ' '; + buf_size = sq_quote(opt_cmd, buf_size, argv[i++]); + } - int fg; - int bg; - int attr; + if (buf_size >= sizeof(opt_cmd)) + die("command too long"); + + opt_cmd[buf_size] = 0; + + } + + return TRUE; +} + + +/** + * KEYS + * ---- + **/ + +#define HELP "(d)iff, (l)og, (m)ain, (q)uit, (v)ersion, (h)elp" + +struct keymap { + int alias; + int request; }; -#define LINE(type, line, fg, bg, attr) \ - { LINE_##type, (line), sizeof(line) - 1, (fg), (bg), (attr) } +struct keymap keymap[] = { + /** + * View switching + * ~~~~~~~~~~~~~~ + * d:: + * Switch to diff view. + * l:: + * Switch to log view. + * m:: + * Switch to main view. + * p:: + * Switch to pager view. + * h:: + * Show man page. + * Return:: + * If in main view split the view + * and show the diff in the bottom view. + * Tab:: + * Switch to next view. + **/ + { 'm', REQ_VIEW_MAIN }, + { 'd', REQ_VIEW_DIFF }, + { 'l', REQ_VIEW_LOG }, + { 'p', REQ_VIEW_PAGER }, + { 'h', REQ_VIEW_HELP }, + + { KEY_TAB, REQ_VIEW_NEXT }, + { KEY_RETURN, REQ_ENTER }, + + /** + * Cursor navigation + * ~~~~~~~~~~~~~~~~~ + * Up, k:: + * Move curser one line up. + * Down, j:: + * Move cursor one line down. + * Page Up:: + * Move curser one page up. + * Page Down:: + * Move cursor one page down. + * Home:: + * Jump to first line. + * End:: + * Jump to last line. + **/ + { KEY_UP, REQ_MOVE_UP }, + { 'k', REQ_MOVE_UP }, + { KEY_DOWN, REQ_MOVE_DOWN }, + { 'j', REQ_MOVE_DOWN }, + { KEY_HOME, REQ_MOVE_FIRST_LINE }, + { KEY_END, REQ_MOVE_LAST_LINE }, + { KEY_NPAGE, REQ_MOVE_PAGE_DOWN }, + { KEY_PPAGE, 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, Escape:: + * Quit + * r:: + * Redraw screen. + * z:: + * Stop all background loading. + * v:: + * Show version. + * n:: + * Toggle line numbers on/off. + * ':':: + * Open prompt. This allows you to specify what git command to run. + * Example: + * + * :log -p + * + **/ + { KEY_ESC, REQ_QUIT }, + { 'q', REQ_QUIT }, + { 'z', REQ_STOP_LOADING }, + { 'v', REQ_SHOW_VERSION }, + { 'r', REQ_SCREEN_REDRAW }, + { 'n', REQ_TOGGLE_LINE_NUMBERS }, + { ':', REQ_PROMPT }, -static struct line_info line_info[] = { - /* Diff markup */ - LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_TRANSP, 0), - LINE(INDEX, "index ", COLOR_BLUE, COLOR_TRANSP, 0), - LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_TRANSP, 0), - LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_TRANSP, 0), - LINE(DIFF_DEL, "-", COLOR_RED, COLOR_TRANSP, 0), - LINE(DIFF_OLDMODE, "old mode ", COLOR_YELLOW, COLOR_TRANSP, 0), - LINE(DIFF_NEWMODE, "new mode ", COLOR_YELLOW, COLOR_TRANSP, 0), - LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_TRANSP, 0), - LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_TRANSP, 0), - LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_TRANSP, 0), - LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_TRANSP, 0), - - /* Pretty print commit header */ - LINE(AUTHOR, "Author: ", COLOR_CYAN, COLOR_TRANSP, 0), - LINE(MERGE, "Merge: ", COLOR_BLUE, COLOR_TRANSP, 0), - LINE(DATE, "Date: ", COLOR_YELLOW, COLOR_TRANSP, 0), - - /* Raw commit header */ - LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_TRANSP, 0), - LINE(PARENT, "parent ", COLOR_BLUE, COLOR_TRANSP, 0), - LINE(TREE, "tree ", COLOR_BLUE, COLOR_TRANSP, 0), - LINE(AUTHOR_IDENT, "author ", COLOR_CYAN, COLOR_TRANSP, 0), - LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_TRANSP, 0), - - LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_TRANSP, 0), - - /* UI colors */ - LINE(DEFAULT, "", COLOR_TRANSP, COLOR_TRANSP, A_NORMAL), - LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), - LINE(STATUS, "", COLOR_GREEN, COLOR_TRANSP, 0), - LINE(TITLE, "", COLOR_YELLOW, COLOR_BLUE, A_BOLD), - LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_TRANSP, 0), - LINE(MAIN_AUTHOR, "", COLOR_GREEN, COLOR_TRANSP, 0), - LINE(MAIN_COMMIT, "", COLOR_TRANSP, COLOR_TRANSP, 0), - LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_TRANSP, 0), + /* 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 struct line_info * -get_line_info(char *line) +static enum request +get_request(int key) { - int linelen = strlen(line); int i; - for (i = 0; i < ARRAY_SIZE(line_info); i++) { - if (linelen < line_info[i].linelen - || strncmp(line_info[i].line, line, line_info[i].linelen)) - continue; - - return &line_info[i]; - } + for (i = 0; i < ARRAY_SIZE(keymap); i++) + if (keymap[i].alias == key) + return keymap[i].request; - return NULL; + return (enum request) key; } + +/* + * 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_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 mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \ +LINE(DIFF_NEWMODE, "new 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(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(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), \ +LINE(TITLE_BLUR, "", COLOR_WHITE, COLOR_BLUE, 0), \ +LINE(TITLE_FOCUS, "", COLOR_WHITE, COLOR_BLUE, A_BOLD), \ +LINE(MAIN_DATE, "", COLOR_BLUE, COLOR_DEFAULT, 0), \ +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), + +enum line_type { +#define LINE(type, line, fg, bg, attr) \ + LINE_##type + LINE_INFO +#undef LINE +}; + +struct line_info { + 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. */ +}; + +static struct line_info line_info[] = { +#define LINE(type, line, fg, bg, attr) \ + { (line), STRING_SIZE(line), (fg), (bg), (attr) } + LINE_INFO +#undef LINE +}; + static enum line_type get_line_type(char *line) { - struct line_info *info = get_line_info(line); + int linelen = strlen(line); + enum line_type type; - return info ? info->type : LINE_DEFAULT; + for (type = 0; type < ARRAY_SIZE(line_info); type++) + /* Case insensitive search matches Signed-off-by lines better. */ + if (linelen >= line_info[type].linelen && + !strncasecmp(line_info[type].line, line, line_info[type].linelen)) + return type; + + return LINE_DEFAULT; } -static int +static inline int get_line_attr(enum line_type type) { - int i; - - for (i = 0; i < ARRAY_SIZE(line_info); i++) - if (line_info[i].type == type) - return COLOR_PAIR(line_info[i].type) | line_info[i].attr; - - return A_NORMAL; + assert(type < ARRAY_SIZE(line_info)); + return COLOR_PAIR(type) | line_info[type].attr; } static void init_colors(void) { - int transparent_bg = COLOR_BLACK; - int transparent_fg = COLOR_WHITE; - int i; + int default_bg = COLOR_BLACK; + int default_fg = COLOR_WHITE; + enum line_type type; start_color(); if (use_default_colors() != ERR) { - transparent_bg = -1; - transparent_fg = -1; + default_bg = -1; + default_fg = -1; } - for (i = 0; i < ARRAY_SIZE(line_info); i++) { - struct line_info *info = &line_info[i]; - int bg = info->bg == COLOR_TRANSP ? transparent_bg : info->bg; - int fg = info->fg == COLOR_TRANSP ? transparent_fg : info->fg; + for (type = 0; type < ARRAY_SIZE(line_info); type++) { + struct line_info *info = &line_info[type]; + int bg = info->bg == COLOR_DEFAULT ? default_bg : info->bg; + int fg = info->fg == COLOR_DEFAULT ? default_fg : info->fg; - init_pair(info->type, fg, bg); + init_pair(type, fg, bg); } } /** - * KEYS - * ---- + * 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-04-18 23:12 Jonas Fonseca | [tig-0.2] tig version 0.2 + * + * If you want to filter out certain directories under `.git/refs/`, say + * `tmp` you can do it by setting the following variable: * - * d:: - * diff - * l:: - * log - * q:: - * quit - * r:: - * redraw screen - * s:: - * stop all background loading - * j:: - * down - * k:: - * up - * h, ?:: - * help - * v:: - * version + * $ TIG_LS_REMOTE="git ls-remote | sed '/\/tmp\//d'" * + * Or set the variable permanently in your environment. + * + * TIG_LS_REMOTE:: + * Set command for retrieving all repository references.private **/ -#define HELP "(d)iff, (l)og, (m)ain, (q)uit, (v)ersion, (h)elp" +#define TIG_LS_REMOTE \ + "git ls-remote ." -struct keymap { - int alias; - int request; -}; +/** + * View commands + * ~~~~~~~~~~~~~ + * It is possible to alter which commands are used for the different views. + * If for example you prefer commits in the main 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. + * + * 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. + **/ -struct keymap keymap[] = { - /* Cursor navigation */ - { KEY_UP, REQ_PREV_LINE }, - { 'k', REQ_PREV_LINE }, - { KEY_DOWN, REQ_NEXT_LINE }, - { 'j', REQ_NEXT_LINE }, - { KEY_HOME, REQ_FIRST_LINE }, - { KEY_END, REQ_LAST_LINE }, - { KEY_NPAGE, REQ_NEXT_PAGE }, - { KEY_PPAGE, REQ_PREV_PAGE }, - - /* Scrolling */ - { KEY_IC, REQ_SCR_BLINE }, /* scroll field backward a line */ - { KEY_DC, REQ_SCR_FLINE }, /* scroll field forward a line */ - { 's', REQ_SCR_FPAGE }, /* scroll field forward a page */ - { 'w', REQ_SCR_BPAGE }, /* scroll field backward a page */ - - { 'd', REQ_DIFF }, - { 'l', REQ_LOG }, - { 'm', REQ_MAIN }, - - { 'n', REQ_LINE_NUMBER }, - - /* No input from wgetch() with nodelay() enabled. */ - { ERR, REQ_UPDATE }, +#define TIG_DIFF_CMD \ + "git show --patch-with-stat --find-copies-harder -B -C %s" - { KEY_ESC, REQ_QUIT }, - { 'q', REQ_QUIT }, - { 's', REQ_STOP }, - { 'v', REQ_VERSION }, - { 'r', REQ_REDRAW }, -}; +#define TIG_LOG_CMD \ + "git log --cc --stat -n100 %s" -static int -get_request(int request) -{ - int i; +#define TIG_MAIN_CMD \ + "git log --topo-order --stat --pretty=raw %s" - for (i = 0; i < ARRAY_SIZE(keymap); i++) - if (keymap[i].alias == request) - return keymap[i].request; +/* We silently ignore that the following are also exported. */ - return request; -} +#define TIG_HELP_CMD \ + "man tig 2> /dev/null" + +#define TIG_PAGER_CMD \ + "" /* @@ -388,18 +675,28 @@ get_request(int request) */ struct view { - char *name; - char *cmd; - char *id; + const char *name; /* View name */ + char *cmd_fmt; /* Default command line format */ + char *cmd_env; /* Command line set via environment */ + char *id; /* Points to either of ref_{head,commit} */ + size_t objsize; /* Size of objects in the line index */ + struct view_ops { + /* Draw one line; @lineno must be < view->height. */ + bool (*draw)(struct view *view, unsigned int lineno); + /* Read one line; updates view->line. */ + bool (*read)(struct view *view, char *line); + /* Depending on view, change display based on current line. */ + bool (*enter)(struct view *view); + } *ops; - /* Rendering */ - int (*read)(struct view *, char *); - int (*draw)(struct view *, unsigned int); - size_t objsize; /* Size of objects in the line index */ + 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. */ - WINDOW *win; - int height, width; + int height, width; /* The width and height of the main window */ + WINDOW *win; /* The main window */ + WINDOW *title; /* The title window living below the main window */ /* Navigation */ unsigned long offset; /* Offset of the window top */ @@ -407,68 +704,51 @@ struct view { /* Buffering */ unsigned long lines; /* Total number of lines */ - void **line; /* Line index */ + void **line; /* Line index; each line contains user data */ + unsigned int digits; /* Number of digits in the lines member. */ /* Loading */ FILE *pipe; + time_t start_time; }; -struct commit { - char id[41]; - char title[75]; - char author[75]; - struct tm time; -}; - -static int pager_draw(struct view *view, unsigned int lineno); -static int pager_read(struct view *view, char *line); - -static int main_draw(struct view *view, unsigned int lineno); -static int main_read(struct view *view, char *line); - -#define DIFF_CMD \ - "git log --stat -n1 %s ; echo; " \ - "git diff --find-copies-harder -B -C %s^ %s" - -#define LOG_CMD \ - "git log --stat -n100 %s" +static struct view_ops pager_ops; +static struct view_ops main_ops; -#define MAIN_CMD \ - "git log --stat --pretty=raw %s" +char ref_head[SIZEOF_REF] = "HEAD"; +char ref_commit[SIZEOF_REF] = "HEAD"; -/* The status window at the bottom. Used for polling keystrokes. */ -static WINDOW *status_win; - -static WINDOW *title_win; - -static unsigned int current_view; -static unsigned int nloading; +#define VIEW_STR(name, cmd, env, ref, objsize, ops) \ + { name, cmd, #env, ref, objsize, ops } -static struct view views[]; -static struct view *display[]; +#define VIEW_(id, name, ops, ref, objsize) \ + VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, objsize, ops) static struct view views[] = { - { "diff", DIFF_CMD, commit_id, pager_read, pager_draw, sizeof(char) }, - { "log", LOG_CMD, head_id, pager_read, pager_draw, sizeof(char) }, - { "main", MAIN_CMD, head_id, main_read, main_draw, sizeof(struct commit) }, + VIEW_(MAIN, "main", &main_ops, ref_head, sizeof(struct commit)), + VIEW_(DIFF, "diff", &pager_ops, ref_commit, sizeof(char)), + VIEW_(LOG, "log", &pager_ops, ref_head, sizeof(char)), + VIEW_(HELP, "help", &pager_ops, ref_head, sizeof(char)), + VIEW_(PAGER, "pager", &pager_ops, "static", sizeof(char)), }; -static struct view *display[ARRAY_SIZE(views)]; +#define VIEW(req) (&views[(req) - REQ_OFFSET - 1]) +/* The display array of active views and the index of the current view. */ +static struct view *display[2]; +static unsigned int current_view; #define foreach_view(view, i) \ - for (i = 0; i < sizeof(display) && (view = display[i]); i++) + for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++) + static void -redraw_view(struct view *view) +redraw_view_from(struct view *view, int lineno) { - int lineno; - - wclear(view->win); - wmove(view->win, 0, 0); + assert(0 <= lineno && lineno < view->height); - for (lineno = 0; lineno < view->height; lineno++) { - if (!view->draw(view, lineno)) + for (; lineno < view->height; lineno++) { + if (!view->ops->draw(view, lineno)) break; } @@ -477,43 +757,102 @@ redraw_view(struct view *view) } static void -resize_view(struct view *view) +redraw_view(struct view *view) +{ + wclear(view->win); + redraw_view_from(view, 0); +} + +static void +resize_display(void) { - int lines, cols; + int offset, i; + struct view *base = display[0]; + struct view *view = display[1] ? display[1] : display[0]; - getmaxyx(stdscr, lines, cols); + /* Setup window dimensions */ - if (view->win) { - mvwin(view->win, 0, 0); - wresize(view->win, lines - 2, cols); + getmaxyx(stdscr, base->height, base->width); - } else { - view->win = newwin(lines - 2, 0, 0, 0); + /* Make room for the status window. */ + base->height -= 1; + + if (view != base) { + /* Horizontal split. */ + view->width = base->width; + view->height = SCALE_SPLIT_VIEW(base->height); + base->height -= view->height; + + /* Make room for the title bar. */ + view->height -= 1; + } + + /* Make room for the title bar. */ + base->height -= 1; + + offset = 0; + + foreach_view (view, i) { if (!view->win) { - report("failed to create %s view", view->name); - return; + view->win = newwin(view->height, 0, offset, 0); + if (!view->win) + die("Failed to create %s view", view->name); + + scrollok(view->win, TRUE); + + view->title = newwin(1, 0, offset + view->height, 0); + if (!view->title) + die("Failed to create title window"); + + } else { + wresize(view->win, view->height, view->width); + mvwin(view->win, offset, 0); + mvwin(view->title, offset + view->height, 0); + wrefresh(view->win); } - scrollok(view->win, TRUE); - } - getmaxyx(view->win, view->height, view->width); + offset += view->height + 1; + } } -/* FIXME: Fix percentage. */ static void -report_position(struct view *view, int all) +update_view_title(struct view *view) { - report(all ? "line %d of %d (%d%%) viewing from %d" - : "line %d of %d", - view->lineno + 1, - view->lines, - view->lines ? view->offset * 100 / view->lines : 0, - view->offset); + if (view == display[current_view]) + wbkgdset(view->title, get_line_attr(LINE_TITLE_FOCUS)); + else + wbkgdset(view->title, get_line_attr(LINE_TITLE_BLUR)); + + werase(view->title); + wmove(view->title, 0, 0); + + /* [main] ref: 334b506... - commit 6 of 4383 (0%) */ + + if (*view->ref) + wprintw(view->title, "[%s] ref: %s", view->name, view->ref); + else + wprintw(view->title, "[%s]", view->name); + + if (view->lines) { + char *type = view == VIEW(REQ_VIEW_MAIN) ? "commit" : "line"; + + wprintw(view->title, " - %s %d of %d (%d%%)", + type, + view->lineno + 1, + view->lines, + (view->lineno + 1) * 100 / view->lines); + } + + wrefresh(view->title); } +/* + * Navigation + */ +/* Scrolling backend */ static void -move_view(struct view *view, int lines) +do_scroll_view(struct view *view, int lines) { /* The rendering expects the new offset. */ view->offset += lines; @@ -521,17 +860,18 @@ move_view(struct view *view, int lines) assert(0 <= view->offset && view->offset < view->lines); assert(lines); - if (view->height < (lines > 0 ? lines : -lines)) { + /* Redraw the whole screen if scrolling is pointless. */ + if (view->height < ABS(lines)) { redraw_view(view); } else { int line = lines > 0 ? view->height - lines : 0; - int end = line + (lines > 0 ? lines : -lines); + int end = line + ABS(lines); wscrl(view->win, lines); for (; line < end; line++) { - if (!view->draw(view, line)) + if (!view->ops->draw(view, line)) break; } } @@ -539,102 +879,120 @@ move_view(struct view *view, int lines) /* Move current line into the view. */ if (view->lineno < view->offset) { view->lineno = view->offset; - view->draw(view, 0); + view->ops->draw(view, 0); } else if (view->lineno >= view->offset + view->height) { view->lineno = view->offset + view->height - 1; - view->draw(view, view->lineno - view->offset); + view->ops->draw(view, view->lineno - view->offset); } - assert(view->offset <= view->lineno && view->lineno <= view->lines); + assert(view->offset <= view->lineno && view->lineno < view->lines); redrawwin(view->win); wrefresh(view->win); - - report_position(view, lines); + report(""); } +/* Scroll frontend */ static void -scroll_view(struct view *view, int request) +scroll_view(struct view *view, enum request request) { int lines = 1; switch (request) { - case REQ_SCR_FPAGE: + case REQ_SCROLL_PAGE_DOWN: lines = view->height; - case REQ_SCR_FLINE: + case REQ_SCROLL_LINE_DOWN: if (view->offset + lines > view->lines) lines = view->lines - view->offset; if (lines == 0 || view->offset + view->height >= view->lines) { - report("already at last line"); + report("Cannot scroll beyond the last line"); return; } break; - case REQ_SCR_BPAGE: + case REQ_SCROLL_PAGE_UP: lines = view->height; - case REQ_SCR_BLINE: + case REQ_SCROLL_LINE_UP: if (lines > view->offset) lines = view->offset; if (lines == 0) { - report("already at first line"); + report("Cannot scroll beyond the first line"); return; } lines = -lines; break; + + default: + die("request %d not handled in switch", request); } - move_view(view, lines); + do_scroll_view(view, lines); } +/* Cursor moving */ static void -navigate_view(struct view *view, int request) +move_view(struct view *view, enum request request) { int steps; switch (request) { - case REQ_FIRST_LINE: + case REQ_MOVE_FIRST_LINE: steps = -view->lineno; break; - case REQ_LAST_LINE: + case REQ_MOVE_LAST_LINE: steps = view->lines - view->lineno - 1; break; - case REQ_PREV_PAGE: + case REQ_MOVE_PAGE_UP: steps = view->height > view->lineno ? -view->lineno : -view->height; break; - case REQ_NEXT_PAGE: + case REQ_MOVE_PAGE_DOWN: steps = view->lineno + view->height >= view->lines ? view->lines - view->lineno - 1 : view->height; break; - case REQ_PREV_LINE: + case REQ_MOVE_UP: steps = -1; break; - case REQ_NEXT_LINE: + case REQ_MOVE_DOWN: steps = 1; break; + + default: + die("request %d not handled in switch", request); } - if (steps < 0 && view->lineno == 0) { - report("already at first line"); + if (steps <= 0 && view->lineno == 0) { + report("Cannot move beyond the first line"); return; - } else if (steps > 0 && view->lineno + 1 == view->lines) { - report("already at last line"); + } else if (steps >= 0 && view->lineno + 1 >= view->lines) { + report("Cannot move beyond the last line"); return; } + /* Move the current line */ view->lineno += steps; - view->draw(view, view->lineno - steps - view->offset); + assert(0 <= view->lineno && view->lineno < view->lines); + + /* Repaint the old "current" line if we be scrolling */ + if (ABS(steps) < view->height) { + int prev_lineno = view->lineno - steps - view->offset; + wmove(view->win, prev_lineno, 0); + wclrtoeol(view->win); + view->ops->draw(view, prev_lineno); + } + + /* Check whether the view needs to be scrolled */ if (view->lineno < view->offset || view->lineno >= view->offset + view->height) { if (steps < 0 && -steps > view->offset) { @@ -649,44 +1007,72 @@ navigate_view(struct view *view, int request) } } - move_view(view, steps); + do_scroll_view(view, steps); return; } - /* Draw the cursor line */ - view->draw(view, view->lineno - view->offset); + /* Draw the current line */ + view->ops->draw(view, view->lineno - view->offset); redrawwin(view->win); wrefresh(view->win); - - report_position(view, view->height); + report(""); } +/* + * Incremental updating + */ static bool begin_update(struct view *view) { - char buf[1024]; - - if (view->cmd) { - char *id = view->id; - - if (snprintf(buf, sizeof(buf), view->cmd, id, id, id) < sizeof(buf)) - view->pipe = popen(buf, "r"); + char *id = view->id; + + if (opt_cmd[0]) { + string_copy(view->cmd, opt_cmd); + opt_cmd[0] = 0; + /* When running random commands, the view ref could have become + * invalid so clear it. */ + view->ref[0] = 0; + } else { + char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt; - if (!view->pipe) + if (snprintf(view->cmd, sizeof(view->cmd), format, + id, id, id, id, id) >= sizeof(view->cmd)) return FALSE; + } - if (nloading++ == 0) - nodelay(status_win, TRUE); + /* Special case for the pager view. */ + if (opt_pipe) { + view->pipe = opt_pipe; + opt_pipe = NULL; + } else { + view->pipe = popen(view->cmd, "r"); } - display[current_view] = view; + if (!view->pipe) + return FALSE; + + set_nonblocking_input(TRUE); view->offset = 0; view->lines = 0; view->lineno = 0; + string_copy(view->vid, id); + + if (view->line) { + int i; + + for (i = 0; i < view->lines; i++) + if (view->line[i]) + free(view->line[i]); + + free(view->line); + view->line = NULL; + } + + view->start_time = time(NULL); return TRUE; } @@ -694,29 +1080,34 @@ begin_update(struct view *view) static void end_update(struct view *view) { - wattrset(view->win, A_NORMAL); - pclose(view->pipe); + if (!view->pipe) + return; + set_nonblocking_input(FALSE); + if (view->pipe == stdin) + fclose(view->pipe); + else + pclose(view->pipe); view->pipe = NULL; - - if (nloading-- == 1) - nodelay(status_win, FALSE); } -static int +static bool update_view(struct view *view) { char buffer[BUFSIZ]; char *line; void **tmp; - int redraw; - int lines = view->height; + /* The number of lines to read. If too low it will cause too much + * redrawing (and possible flickering), if too high responsiveness + * will suffer. */ + unsigned long lines = view->height; + int redraw_from = -1; if (!view->pipe) return TRUE; - /* Only redraw after the first reading session. */ - /* FIXME: ... and possibly more. */ - redraw = view->height > view->lines; + /* Only redraw if lines are visible. */ + 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) @@ -725,152 +1116,248 @@ update_view(struct view *view) view->line = tmp; while ((line = fgets(buffer, sizeof(buffer), view->pipe))) { - int linelen; + int linelen = strlen(line); - linelen = strlen(line); if (linelen) line[linelen - 1] = 0; - if (!view->read(view, line)) + if (!view->ops->read(view, line)) goto alloc_error; if (lines-- == 1) break; } - if (redraw) - redraw_view(view); + { + int digits; + + lines = view->lines; + for (digits = 0; lines; digits++) + lines /= 10; + + /* Keep the displayed view in sync with line number scaling. */ + if (digits != view->digits) { + view->digits = digits; + redraw_from = 0; + } + } + + if (redraw_from >= 0) { + /* If this is an incremental update, redraw the previous line + * since for commits some members could have changed when + * loading the main view. */ + if (redraw_from > 0) + redraw_from--; + + /* Incrementally draw avoids flickering. */ + redraw_view_from(view, redraw_from); + } + + /* Update the title _after_ the redraw so that if the redraw picks up a + * commit reference in view->ref it'll be available here. */ + update_view_title(view); if (ferror(view->pipe)) { - report("failed to read %s", view->cmd); + report("Failed to read: %s", strerror(errno)); goto end; } else if (feof(view->pipe)) { - report_position(view, 0); + time_t secs = time(NULL) - view->start_time; + + if (view == VIEW(REQ_VIEW_HELP)) { + report("%s", HELP); + goto end; + } + + report("Loaded %d lines in %ld second%s", view->lines, secs, + secs == 1 ? "" : "s"); goto end; } return TRUE; alloc_error: - report("allocation failure"); + report("Allocation failure"); end: end_update(view); return FALSE; } +enum open_flags { + OPEN_DEFAULT = 0, /* Use default view switching. */ + OPEN_SPLIT = 1, /* Split current view. */ + OPEN_BACKGROUNDED = 2, /* Backgrounded. */ + OPEN_RELOAD = 4, /* Reload view even if it is the current. */ +}; -static struct view * -switch_view(struct view *prev, int request) +static void +open_view(struct view *prev, enum request request, enum open_flags flags) { - struct view *view = &views[request - REQ_OFFSET]; + bool backgrounded = !!(flags & OPEN_BACKGROUNDED); + bool split = !!(flags & OPEN_SPLIT); + bool reload = !!(flags & OPEN_RELOAD); + struct view *view = VIEW(request); struct view *displayed; - int i; - - if (view == prev) { - foreach_view (displayed, i) ; + int nviews; + + /* Cycle between displayed views and count the views. */ + foreach_view (displayed, nviews) { + if (prev != view && + view == displayed && + !strcmp(view->vid, prev->vid)) { + current_view = nviews; + /* Blur out the title of the previous view. */ + update_view_title(prev); + report("Switching to %s view", view->name); + return; + } + } - if (i == 1) - report("already in %s view", view->name); - else - report("FIXME: Maximize"); + if (view == prev && nviews == 1 && !reload) { + report("Already in %s view", view->name); + return; + } - return view; + 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; + if (!backgrounded) + current_view++; } else { - foreach_view (displayed, i) { - if (view == displayed) { - current_view = i; - report("new current view"); - return view; - } - } + /* Maximize the current view. */ + memset(display, 0, sizeof(display)); + current_view = 0; + display[current_view] = view; } - if (!view->win) - resize_view(view); + resize_display(); - /* Reload */ + if (split && prev->lineno - prev->offset >= prev->height) { + /* Take the title line into account. */ + int lines = prev->lineno - prev->offset - prev->height + 1; - if (view->line) { - for (i = 0; i < view->lines; i++) - if (view->line[i]) - free(view->line[i]); - - free(view->line); - view->line = NULL; + /* Scroll the view that was split if the current line is + * outside the new limited view. */ + do_scroll_view(prev, lines); } - if (prev && prev->pipe) - end_update(prev); + if (prev && view != prev) { + /* "Blur" the previous view. */ + update_view_title(prev); - if (begin_update(view)) { - if (!view->cmd) - report("%s", HELP); - else - report("loading..."); + /* Continue loading split views in the background. */ + if (!split) + end_update(prev); } - return view; + if (view->pipe) { + /* Clear the old view and let the incremental updating refill + * the screen. */ + wclear(view->win); + report("Loading..."); + } else { + redraw_view(view); + report(""); + } } -/* Process a keystroke */ +/* + * User request switch noodle + */ + static int -view_driver(struct view *view, int key) +view_driver(struct view *view, enum request request) { - int request = get_request(key); int i; switch (request) { - case REQ_NEXT_LINE: - case REQ_PREV_LINE: - case REQ_FIRST_LINE: - case REQ_LAST_LINE: - case REQ_NEXT_PAGE: - case REQ_PREV_PAGE: - if (view) - navigate_view(view, request); + case REQ_MOVE_UP: + case REQ_MOVE_DOWN: + case REQ_MOVE_PAGE_UP: + case REQ_MOVE_PAGE_DOWN: + case REQ_MOVE_FIRST_LINE: + case REQ_MOVE_LAST_LINE: + move_view(view, request); break; - case REQ_SCR_FLINE: - case REQ_SCR_BLINE: - case REQ_SCR_FPAGE: - case REQ_SCR_BPAGE: - if (view) - scroll_view(view, request); + case REQ_SCROLL_LINE_DOWN: + case REQ_SCROLL_LINE_UP: + case REQ_SCROLL_PAGE_DOWN: + case REQ_SCROLL_PAGE_UP: + scroll_view(view, request); break; - case REQ_MAIN: - case REQ_LOG: - case REQ_DIFF: - view = switch_view(view, request); + case REQ_VIEW_MAIN: + case REQ_VIEW_DIFF: + case REQ_VIEW_LOG: + case REQ_VIEW_HELP: + case REQ_VIEW_PAGER: + open_view(view, request, OPEN_DEFAULT); break; - case REQ_LINE_NUMBER: + case REQ_ENTER: + if (!view->lines) { + report("Nothing to enter"); + break; + } + return view->ops->enter(view); + + case REQ_VIEW_NEXT: + { + int nviews = display[1] ? 2 : 1; + int next_view = (current_view + 1) % nviews; + + if (next_view == current_view) { + report("Only one view is displayed"); + break; + } + + current_view = next_view; + /* Blur out the title of the previous view. */ + update_view_title(view); + report("Switching to %s view", display[current_view]->name); + break; + } + case REQ_TOGGLE_LINE_NUMBERS: opt_line_number = !opt_line_number; redraw_view(view); break; - case REQ_REDRAW: - redraw_view(view); + case REQ_PROMPT: + /* Always reload^Wrerun commands from the prompt. */ + open_view(view, opt_request, OPEN_RELOAD); break; - case REQ_STOP: + case REQ_STOP_LOADING: foreach_view (view, i) { - if (view->pipe) { - end_update(view); - scroll_view(view, 0); - } + if (view->pipe) + report("Stopped loaded of %s view", view->name), + end_update(view); } break; - case REQ_VERSION: - report("version %s", VERSION); + case REQ_SHOW_VERSION: + report("Version: %s", VERSION); return TRUE; - case REQ_UPDATE: + case REQ_SCREEN_RESIZE: + resize_display(); + /* Fall-through */ + case REQ_SCREEN_REDRAW: + foreach_view (view, i) { + redraw_view(view); + update_view_title(view); + } + break; + + case REQ_SCREEN_UPDATE: doupdate(); return TRUE; @@ -878,7 +1365,8 @@ view_driver(struct view *view, int key) return FALSE; default: - report(HELP); + /* An unknown key will show most commonly used commands. */ + report("%s", HELP); return TRUE; } @@ -887,14 +1375,15 @@ view_driver(struct view *view, int key) /* - * Rendering + * View backend handlers */ -static int +static bool pager_draw(struct view *view, unsigned int lineno) { enum line_type type; char *line; + int linelen; int attr; if (view->offset + lineno >= view->lines) @@ -904,20 +1393,39 @@ pager_draw(struct view *view, unsigned int lineno) type = get_line_type(line); if (view->offset + lineno == view->lineno) { - if (type == LINE_COMMIT) - strncpy(commit_id, line + 7, SIZEOF_ID); + if (type == LINE_COMMIT) { + string_copy(view->ref, line + 7); + string_copy(ref_commit, view->ref); + } + type = LINE_CURSOR; } attr = get_line_attr(type); wattrset(view->win, attr); + linelen = strlen(line); + linelen = MIN(linelen, view->width); + if (opt_line_number) { - mvwprintw(view->win, lineno, 0, "%4d: ", view->offset + lineno + 1); + static char indent[] = " "; + unsigned long real_lineno = view->offset + lineno + 1; + int col = 0; + + if (real_lineno == 1 || (real_lineno % opt_num_interval) == 0) + mvwprintw(view->win, lineno, 0, "%.*d", view->digits, real_lineno); + + else if (view->digits < sizeof(indent)) + mvwaddnstr(view->win, lineno, 0, indent, view->digits); + + waddstr(view->win, ": "); + while (line) { if (*line == '\t') { - waddstr(view->win, " "); + waddnstr(view->win, " ", 8 - (col % 8)); + col += 8 - (col % 8); line++; + } else { char *tab = strchr(line, '\t'); @@ -925,22 +1433,32 @@ pager_draw(struct view *view, unsigned int lineno) waddnstr(view->win, line, tab - line); else waddstr(view->win, line); + col += tab - line; line = tab; } } waddstr(view->win, line); } else { +#if 0 + /* NOTE: Code for only highlighting the text on the cursor line. + * Kept since I've not yet decided whether to highlight the + * entire line or not. --fonseca */ /* No empty lines makes cursor drawing and clearing implicit. */ if (!*line) - line = " "; - mvwaddstr(view->win, lineno, 0, line); + line = " ", linelen = 1; +#endif + mvwaddnstr(view->win, lineno, 0, line, linelen); } + /* Paint the rest of the line if it's the cursor line. */ + if (type == LINE_CURSOR) + wchgat(view->win, -1, 0, type, NULL); + return TRUE; } -static int +static bool pager_read(struct view *view, char *line) { view->line[view->lines] = strdup(line); @@ -951,10 +1469,31 @@ pager_read(struct view *view, char *line) return TRUE; } -static int +static bool +pager_enter(struct view *view) +{ + char *line = view->line[view->lineno]; + + if (get_line_type(line) == LINE_COMMIT) { + open_view(view, REQ_VIEW_DIFF, OPEN_DEFAULT); + } + + return TRUE; +} + +static struct view_ops pager_ops = { + pager_draw, + pager_read, + pager_enter, +}; + + +static struct ref **get_refs(char *id); + +static bool main_draw(struct view *view, unsigned int lineno) { - char buf[21]; + char buf[DATE_COLS + 1]; struct commit *commit; enum line_type type; int cols = 0; @@ -964,10 +1503,12 @@ main_draw(struct view *view, unsigned int lineno) return FALSE; commit = view->line[view->offset + lineno]; - if (!commit) return FALSE; + if (!*commit->author) + return FALSE; if (view->offset + lineno == view->lineno) { - strncpy(commit_id, commit->id, SIZEOF_ID); + string_copy(view->ref, commit->id); + string_copy(ref_commit, view->ref); type = LINE_CURSOR; } else { type = LINE_MAIN_COMMIT; @@ -976,10 +1517,11 @@ main_draw(struct view *view, unsigned int lineno) wmove(view->win, lineno, cols); wattrset(view->win, get_line_attr(LINE_MAIN_DATE)); - timelen = strftime(buf, sizeof(buf), "%Y-%m-%d %H:%M:%S ", &commit->time); + timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time); waddnstr(view->win, buf, timelen); + waddstr(view->win, " "); - cols += 20; + cols += DATE_COLS; wmove(view->win, lineno, cols); wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR)); @@ -994,14 +1536,33 @@ main_draw(struct view *view, unsigned int lineno) cols += 20; wattrset(view->win, A_NORMAL); mvwaddch(view->win, lineno, cols, ACS_LTEE); + wmove(view->win, lineno, cols + 2); + + if (commit->refs) { + size_t i = 0; + + do { + if (commit->refs[i]->tag) + wattrset(view->win, get_line_attr(LINE_MAIN_TAG)); + else + wattrset(view->win, get_line_attr(LINE_MAIN_REF)); + waddstr(view->win, "["); + waddstr(view->win, commit->refs[i]->name); + waddstr(view->win, "]"); + wattrset(view->win, A_NORMAL); + waddstr(view->win, " "); + } while (commit->refs[i++]->next); + } + wattrset(view->win, get_line_attr(type)); - mvwaddstr(view->win, lineno, cols + 2, commit->title); + waddstr(view->win, commit->title); wattrset(view->win, A_NORMAL); return TRUE; } -static int +/* Reads git log --pretty=raw output and parses it into the commit struct. */ +static bool main_read(struct view *view, char *line) { enum line_type type = get_line_type(line); @@ -1013,15 +1574,16 @@ main_read(struct view *view, char *line) if (!commit) return FALSE; - line += sizeof("commit ") - 1; + line += STRING_SIZE("commit "); view->line[view->lines++] = commit; - strncpy(commit->id, line, sizeof(commit->id)); + string_copy(commit->id, line); + commit->refs = get_refs(commit->id); break; - case LINE_AUTHOR_IDENT: + case LINE_AUTHOR: { - char *ident = line + sizeof("author ") - 1; + char *ident = line + STRING_SIZE("author "); char *end = strchr(ident, '<'); if (end) { @@ -1030,8 +1592,9 @@ main_read(struct view *view, char *line) } commit = view->line[view->lines - 1]; - strncpy(commit->author, ident, sizeof(commit->author)); + string_copy(commit->author, ident); + /* Parse epoch and timezone */ if (end) { char *secs = strchr(end + 1, '>'); char *zone; @@ -1043,7 +1606,7 @@ main_read(struct view *view, char *line) secs += 2; time = (time_t) atol(secs); zone = strchr(secs, ' '); - if (zone && strlen(zone) == sizeof(" +0700") - 1) { + if (zone && strlen(zone) == STRING_SIZE(" +0700")) { long tz; zone++; @@ -1062,96 +1625,109 @@ main_read(struct view *view, char *line) break; } default: + /* We should only ever end up here if there has already been a + * commit line, however, be safe. */ + if (view->lines == 0) + break; + + /* Fill in the commit title if it has not already been set. */ commit = view->line[view->lines - 1]; - if (!commit->title[0] && - !strncmp(line, " ", 4) && - !isspace(line[5])) - strncpy(commit->title, line + 4, sizeof(commit->title)); + if (commit->title[0]) + break; + + /* Require titles to start with a non-space character at the + * offset used by git log. */ + /* FIXME: More gracefull handling of titles; append "..." to + * shortened titles, etc. */ + if (strncmp(line, " ", 4) || + isspace(line[4])) + break; + + string_copy(commit->title, line + 4); } return TRUE; } - -/* - * Main - */ - -static void -quit(int sig) +static bool +main_enter(struct view *view) { - if (status_win) - delwin(status_win); - if (title_win) - delwin(title_win); - endwin(); - - /* FIXME: Shutdown gracefully. */ - - exit(0); + open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT | OPEN_BACKGROUNDED); + return TRUE; } -static void die(const char *err, ...) -{ - va_list args; +static struct view_ops main_ops = { + main_draw, + main_read, + main_enter, +}; - endwin(); - va_start(args, err); - fputs("tig: ", stderr); - vfprintf(stderr, err, args); - fputs("\n", stderr); - va_end(args); +/* + * Status management + */ - exit(1); -} +/* Whether or not the curses interface has been initialized. */ +bool cursed = FALSE; + +/* The status window is used for polling keystrokes. */ +static WINDOW *status_win; +/* Update status and title window. */ static void report(const char *msg, ...) { va_list args; - werase(title_win); - wmove(title_win, 0, 0); - wprintw(title_win, "commit %s", commit_id); - wrefresh(title_win); + /* Update the title window first, so the cursor ends up in the status + * window. */ + update_view_title(display[current_view]); va_start(args, msg); werase(status_win); wmove(status_win, 0, 0); - -#if 0 - if (display[current_view]) - wprintw(status_win, "%s %4s: ", commit_id, display[current_view]->name); -#endif - vwprintw(status_win, msg, args); + if (*msg) + vwprintw(status_win, msg, args); wrefresh(status_win); va_end(args); } -int -main(int argc, char *argv[]) +/* Controls when nodelay should be in effect when polling user input. */ +static void +set_nonblocking_input(bool loading) +{ + /* The number of loading views. */ + static unsigned int nloading; + + if ((loading == FALSE && nloading-- == 1) || + (loading == TRUE && nloading++ == 0)) + nodelay(status_win, loading); +} + +static void +init_display(void) { int x, y; - int request; - int git_cmd; - signal(SIGINT, quit); + /* Initialize the curses library */ + if (isatty(STDIN_FILENO)) { + cursed = !!initscr(); + } else { + /* Leave stdin and stdout alone when acting as a pager. */ + FILE *io = fopen("/dev/tty", "r+"); - git_cmd = parse_options(argc, argv); - if (git_cmd < 0) - return 0; + cursed = !!newterm(NULL, io, io); + } - request = opt_request; + if (!cursed) + die("Failed to initialize curses"); - initscr(); /* initialize the curses library */ - nonl(); /* tell curses not to do NL->CR/NL on output */ - cbreak(); /* take input chars one at a time, no wait for \n */ - noecho(); /* don't echo input */ + nonl(); /* Tell curses not to do NL->CR/NL on output */ + cbreak(); /* Take input chars one at a time, no wait for \n */ + noecho(); /* Don't echo input */ leaveok(stdscr, TRUE); - /* curs_set(0); */ if (has_colors()) init_colors(); @@ -1161,37 +1737,200 @@ main(int argc, char *argv[]) if (!status_win) die("Failed to create status window"); - title_win = newwin(1, 0, y - 2, 0); - if (!title_win) - die("Failed to create title window"); - /* Enable keyboard mapping */ keypad(status_win, TRUE); wbkgdset(status_win, get_line_attr(LINE_STATUS)); - wbkgdset(title_win, get_line_attr(LINE_TITLE)); +} + + +/* + * Repository references + */ + +static struct ref *refs; +size_t refs_size; + +static struct ref ** +get_refs(char *id) +{ + struct ref **id_refs = NULL; + size_t id_refs_size = 0; + size_t i; + + for (i = 0; i < refs_size; i++) { + struct ref **tmp; + + if (strcmp(id, refs[i].id)) + continue; + + tmp = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs)); + if (!tmp) { + if (id_refs) + free(id_refs); + return NULL; + } + + id_refs = tmp; + id_refs[id_refs_size++] = &refs[i]; + if (id_refs_size > 1) + id_refs[id_refs_size - 1]->next = 1; + } + + return id_refs; +} + +static int +load_refs(void) +{ + char *cmd_env = getenv("TIG_LS_REMOTE"); + char *cmd = cmd_env ? cmd_env : TIG_LS_REMOTE; + FILE *pipe = popen(cmd, "r"); + char buffer[BUFSIZ]; + char *line; + + if (!pipe) + return ERR; + + while ((line = fgets(buffer, sizeof(buffer), pipe))) { + char *name = strchr(line, '\t'); + struct ref *ref; + int namelen; + bool tag = FALSE; + + if (!name) + continue; + + *name++ = 0; + namelen = strlen(name) - 1; + if (name[namelen - 1] == '}') { + while (namelen > 0 && name[namelen] != '^') + namelen--; + } + name[namelen] = 0; + + if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) { + name += STRING_SIZE("refs/tags/"); + tag = TRUE; + } + + refs = realloc(refs, sizeof(*refs) * (refs_size + 1)); + if (!refs) + return ERR; + + ref = &refs[refs_size++]; + ref->tag = tag; + ref->name = strdup(name); + if (!ref->name) + return ERR; + + string_copy(ref->id, line); + } + + if (ferror(pipe)) + return ERR; + + pclose(pipe); + + return OK; +} + +/* + * Main + */ + +static void +quit(int sig) +{ + /* XXX: Restore tty modes and let the OS cleanup the rest! */ + if (cursed) + endwin(); + exit(0); +} + +static void die(const char *err, ...) +{ + va_list args; + + endwin(); + + va_start(args, err); + fputs("tig: ", stderr); + vfprintf(stderr, err, args); + fputs("\n", stderr); + va_end(args); + + exit(1); +} + +int +main(int argc, char *argv[]) +{ + struct view *view; + enum request request; + size_t i; + + signal(SIGINT, quit); + + if (!parse_options(argc, argv)) + return 0; + + if (load_refs() == ERR) + die("Failed to load refs."); + + for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++) + view->cmd_env = getenv(view->cmd_env); + + request = opt_request; + + init_display(); while (view_driver(display[current_view], request)) { - struct view *view; + int key; int i; - foreach_view (view, i) { - if (view->pipe) { - update_view(view); - } - } + foreach_view (view, i) + update_view(view); /* Refresh, accept single keystroke of input */ - request = wgetch(status_win); - if (request == KEY_RESIZE) { - int lines, cols; + key = wgetch(status_win); + request = get_request(key); + + /* Some low-level request handling. This keeps handling of + * status_win restricted. */ + switch (request) { + case REQ_PROMPT: + report(":"); + /* Temporarily switch to line-oriented and echoed + * input. */ + nocbreak(); + echo(); + + if (wgetnstr(status_win, opt_cmd + 4, sizeof(opt_cmd) - 4) == OK) { + memcpy(opt_cmd, "git ", 4); + opt_request = REQ_VIEW_PAGER; + } else { + request = ERR; + } + + noecho(); + cbreak(); + break; - getmaxyx(stdscr, lines, cols); + case REQ_SCREEN_RESIZE: + { + int height, width; - mvwin(status_win, lines - 1, 0); - wresize(status_win, 1, cols - 1); + getmaxyx(stdscr, height, width); - mvwin(title_win, lines - 2, 0); - wresize(title_win, 1, cols - 1); + /* Resize the status view and let the view driver take + * care of resizing the displayed views. */ + wresize(status_win, 1, width); + mvwin(status_win, height - 1, 0); + wrefresh(status_win); + break; + } + default: + break; } } @@ -1201,9 +1940,17 @@ main(int argc, char *argv[]) } /** + * TODO + * ---- + * Features that should be explored. + * + * - Searching. + * + * - Locale support. + * * COPYRIGHT * --------- - * Copyright (c) Jonas Fonseca, 2006 + * Copyright (c) Jonas Fonseca , 2006 * * 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 @@ -1212,6 +1959,9 @@ main(int argc, char *argv[]) * * 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, + * gitview(1): git repository browser written using python/gtk. **/