X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/3af8774ea2ab5d8754b454942f421fe037c959d7..6a7bb912e604ba64776ee45363d112e110366707:/tig.c diff --git a/tig.c b/tig.c index d525251..308106b 100644 --- a/tig.c +++ b/tig.c @@ -1,5 +1,15 @@ /* Copyright (c) 2006 Jonas Fonseca - * See license info at the bottom. */ + * + * 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) * ====== @@ -20,11 +30,19 @@ * * DESCRIPTION * ----------- - * Browse changes in a git repository. + * 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.1" +#define VERSION "tig-0.3" #endif #ifndef DEBUG @@ -46,7 +64,9 @@ static void die(const char *err, ...); static void report(const char *msg, ...); +static int read_properties(const char *cmd, int separator, 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); #define ABS(x) ((x) >= 0 ? (x) : -(x)) #define MIN(x, y) ((x) < (y) ? (x) : (y)) @@ -60,13 +80,19 @@ static void set_nonblocking_input(bool loading); /* 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 ") +#define AUTHOR_COLS 20 + /* The default interval between line numbers. */ #define NUMBER_INTERVAL 1 +#define TABSIZE 8 + #define SCALE_SPLIT_VIEW(height) ((height) * 2 / 3) /* Some ascii-shorthands fitted into the ncurses namespace. */ @@ -74,6 +100,7 @@ static void set_nonblocking_input(bool loading); #define KEY_RETURN '\r' #define KEY_ESC 27 + /* User action requests. */ enum request { /* Offset all requests to avoid conflicts with ncurses getch values. */ @@ -96,6 +123,9 @@ enum request { REQ_STOP_LOADING, REQ_TOGGLE_LINE_NUMBERS, REQ_VIEW_NEXT, + REQ_VIEW_CLOSE, + REQ_NEXT, + REQ_PREVIOUS, REQ_MOVE_UP, REQ_MOVE_DOWN, @@ -111,26 +141,21 @@ enum request { }; struct ref { - char *name; - char id[41]; - unsigned int tag:1; - unsigned int next:1; + char *name; /* Ref name; tag or head names are shortened. */ + char id[41]; /* Commit SHA1 ID */ + unsigned int tag:1; /* Is it a tag? */ + unsigned int next:1; /* For ref lists: are there more refs? */ }; -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. */ -}; +static struct ref **get_refs(char *id); + /* * String helpers */ static inline void -string_ncopy(char *dst, char *src, int dstlen) +string_ncopy(char *dst, const char *src, int dstlen) { strncpy(dst, src, dstlen - 1); dst[dstlen - 1] = 0; @@ -141,6 +166,7 @@ string_ncopy(char *dst, char *src, int dstlen) #define string_copy(dst, src) \ string_ncopy(dst, src, sizeof(dst)) + /* Shell quoting * * NOTE: The following is a slightly modified copy of the git project's shell @@ -163,7 +189,7 @@ sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src) { char c; -#define BUFPUT(x) ( (bufsize < SIZEOF_CMD) && (buf[bufsize++] = (x)) ) +#define BUFPUT(x) do { if (bufsize < SIZEOF_CMD) buf[bufsize++] = (x); } while (0) BUFPUT('\''); while ((c = *src++)) { @@ -187,10 +213,33 @@ sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src) * ------- **/ -static int opt_line_number = FALSE; +static const char usage[] = +VERSION " (" __DATE__ ")\n" +"\n" +"Usage: tig [options]\n" +" or: tig [options] [--] [git log options]\n" +" or: tig [options] log [git log options]\n" +" or: tig [options] diff [git diff options]\n" +" or: tig [options] show [git show options]\n" +" or: tig [options] < [git command output]\n" +"\n" +"Options:\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" +" -- 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 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; /* Returns the index of log or diff command or -1 to exit. */ @@ -244,6 +293,26 @@ parse_options(int argc, char *argv[]) } /** + * -b[NSPACES], --tab-size[=NSPACES]:: + * Set the number of spaces tabs should be expanded to. + **/ + if (!strncmp(opt, "-b", 2) || + !strncmp(opt, "--tab-size", 10)) { + char *num = opt; + + if (opt[1] == 'b') { + 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); + continue; + } + + /** * -v, --version:: * Show version and exit. **/ @@ -254,9 +323,19 @@ parse_options(int argc, char *argv[]) } /** + * -h, --help:: + * Show help message and exit. + **/ + if (!strcmp(opt, "-h") || + !strcmp(opt, "--help")) { + printf(usage); + return FALSE; + } + + /** * \--:: - * End of tig(1) options. Useful when specifying commands - * for the main view. Example: + * End of tig(1) options. Useful when specifying command + * options for the main view. Example: * * $ tig -- --since=1.month **/ @@ -266,13 +345,13 @@ parse_options(int argc, char *argv[]) } /** - * log [options]:: + * log [git log options]:: * Open log view using the given git log options. * - * diff [options]:: + * diff [git diff options]:: * Open diff view using the given git diff options. * - * show [options]:: + * show [git show options]:: * Open diff view using the given git show options. **/ if (!strcmp(opt, "log") || @@ -283,11 +362,16 @@ parse_options(int argc, char *argv[]) break; } - /* Make stuff like: + /** + * [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 - * - * work. */ + **/ if (opt[0] && opt[0] != '-') break; @@ -317,16 +401,21 @@ parse_options(int argc, char *argv[]) * ~~~~~~~~~~~~~~~~~~~ * All git command options specified on the command line will * be passed to the given command and all will be shell quoted - * before used. + * before they are passed to the shell. * - * NOTE: It is possible to specify options even for the main - * view. If doing this you should not touch the `--pretty` - * option. + * 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) @@ -349,139 +438,87 @@ parse_options(int argc, char *argv[]) } + if (*opt_encoding && strcasecmp(opt_encoding, "UTF-8")) + opt_utf8 = FALSE; + return TRUE; } /** - * 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-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 HELP "(d)iff, (l)og, (m)ain, (q)uit, (v)ersion, (h)elp" - -struct keymap { - int alias; - int request; -}; - -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 }, +#define TIG_LS_REMOTE \ + "git ls-remote . 2>/dev/null" - /** - * 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 }, +/** + * [[history-commands]] + * History 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. + **/ - /** - * 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 }, +#define TIG_DIFF_CMD \ + "git show --patch-with-stat --find-copies-harder -B -C %s" - /* wgetch() with nodelay() enabled returns ERR when there's no input. */ - { ERR, REQ_SCREEN_UPDATE }, +#define TIG_LOG_CMD \ + "git log --cc --stat -n100 %s" - /* Use the ncurses SIGWINCH handler. */ - { KEY_RESIZE, REQ_SCREEN_RESIZE }, -}; +#define TIG_MAIN_CMD \ + "git log --topo-order --stat --pretty=raw %s" -static enum request -get_request(int key) -{ - int i; +/* ... silently ignore that the following are also exported. */ - for (i = 0; i < ARRAY_SIZE(keymap); i++) - if (keymap[i].alias == key) - return keymap[i].request; +#define TIG_HELP_CMD \ + "man tig 2>/dev/null" - return (enum request) key; -} +#define TIG_PAGER_CMD \ + "" /* @@ -540,7 +577,7 @@ enum line_type { }; struct line_info { - char *line; /* The start of line to match. */ + 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. */ }; @@ -597,98 +634,64 @@ init_colors(void) } } +struct line { + enum line_type type; + void *data; /* User data */ +}; -/** - * 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: - * - * $ 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 TIG_LS_REMOTE \ - "git ls-remote ." /** - * 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: + * 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. * - * $ 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. + * If you are in the log view and press 'Enter' when the current line is a + * commit line, such as: * - * TIG_LOG_CMD:: - * The command used for the log view. + * commit 4d55caff4cc89335192f3e566004b4ceef572521 * - * 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. + * 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'. **/ -#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" +struct view; +struct view_ops; -/* We silently ignore that the following are also exported. */ +/* The display array of active views and the index of the current view. */ +static struct view *display[2]; +static unsigned int current_view; -#define TIG_HELP_CMD \ - "man tig 2> /dev/null" +#define foreach_view(view, i) \ + for (i = 0; i < ARRAY_SIZE(display) && (view = display[i]); i++) -#define TIG_PAGER_CMD \ - "" +#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. + **/ -/* - * Viewer - */ +static char ref_commit[SIZEOF_REF] = "HEAD"; +static char ref_head[SIZEOF_REF] = "HEAD"; struct view { 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; + const char *cmd_fmt; /* Default command line format */ + const char *cmd_env; /* Command line set via environment */ + const char *id; /* Points to either of ref_{head,commit} */ + + struct view_ops *ops; /* View operations */ char cmd[SIZEOF_CMD]; /* Command buffer */ char ref[SIZEOF_REF]; /* Hovered commit reference */ @@ -702,9 +705,13 @@ struct view { unsigned long offset; /* Offset of the window top */ unsigned long lineno; /* Current line number */ + /* If non-NULL, points to the view that opened this view. If this view + * is closed tig will switch back to the parent view. */ + struct view *parent; + /* Buffering */ unsigned long lines; /* Total number of lines */ - void **line; /* Line index; each line contains user data */ + struct line *line; /* Line index */ unsigned int digits; /* Number of digits in the lines member. */ /* Loading */ @@ -712,35 +719,75 @@ struct view { time_t start_time; }; +struct view_ops { + /* What type of content being displayed. Used in the title bar. */ + const char *type; + /* 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); + /* Depending on view, change display based on current line. */ + bool (*enter)(struct view *view, struct line *line); +}; + static struct view_ops pager_ops; static struct view_ops main_ops; -char ref_head[SIZEOF_REF] = "HEAD"; -char ref_commit[SIZEOF_REF] = "HEAD"; +#define VIEW_STR(name, cmd, env, ref, ops) \ + { name, cmd, #env, ref, ops } -#define VIEW_STR(name, cmd, env, ref, objsize, ops) \ - { name, cmd, #env, ref, objsize, ops } +#define VIEW_(id, name, ops, ref) \ + VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, ops) -#define VIEW_(id, name, ops, ref, objsize) \ - VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, objsize, ops) +/** + * 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, 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)), + VIEW_(MAIN, "main", &main_ops, ref_head), + VIEW_(DIFF, "diff", &pager_ops, ref_commit), + VIEW_(LOG, "log", &pager_ops, ref_head), + VIEW_(HELP, "help", &pager_ops, "static"), + VIEW_(PAGER, "pager", &pager_ops, "static"), }; #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 < ARRAY_SIZE(display) && (view = display[i]); i++) +static bool +draw_view_line(struct view *view, unsigned int lineno) +{ + if (view->offset + lineno >= view->lines) + return FALSE; + return view->ops->draw(view, &view->line[view->offset + lineno], lineno); +} static void redraw_view_from(struct view *view, int lineno) @@ -748,7 +795,7 @@ redraw_view_from(struct view *view, int lineno) assert(0 <= lineno && lineno < view->height); for (; lineno < view->height; lineno++) { - if (!view->ops->draw(view, lineno)) + if (!draw_view_line(view, lineno)) break; } @@ -763,6 +810,58 @@ redraw_view(struct view *view) redraw_view_from(view, 0); } + +/** + * 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) +{ + 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); + + if (*view->ref) + wprintw(view->title, "[%s] %s", view->name, view->ref); + else + wprintw(view->title, "[%s]", view->name); + + if (view->lines || view->pipe) { + unsigned int lines = view->lines + ? (view->lineno + 1) * 100 / view->lines + : 0; + + wprintw(view->title, " - %s %d of %d (%d%%)", + view->ops->type, + view->lineno + 1, + view->lines, + lines); + } + + if (view->pipe) { + time_t secs = time(NULL) - view->start_time; + + /* Three git seconds are a long time ... */ + if (secs > 2) + wprintw(view->title, " %lds", secs); + } + + wmove(view->title, 0, view->width - 1); + wrefresh(view->title); +} + static void resize_display(void) { @@ -808,7 +907,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; @@ -816,34 +914,30 @@ resize_display(void) } static void -update_view_title(struct view *view) +redraw_display(void) { - 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); + struct view *view; + int i; - /* [main] ref: 334b506... - commit 6 of 4383 (0%) */ + foreach_view (view, i) { + redraw_view(view); + update_view_title(view); + } +} - if (*view->ref) - wprintw(view->title, "[%s] ref: %s", view->name, view->ref); - else - wprintw(view->title, "[%s]", view->name); +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) { - 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); + wmove(view->win, view->lineno - view->offset, view->width - 1); + wrefresh(view->win); } - - wrefresh(view->title); } /* @@ -852,7 +946,7 @@ update_view_title(struct view *view) /* Scrolling backend */ static void -do_scroll_view(struct view *view, int lines) +do_scroll_view(struct view *view, int lines, bool redraw) { /* The rendering expects the new offset. */ view->offset += lines; @@ -871,7 +965,7 @@ do_scroll_view(struct view *view, int lines) wscrl(view->win, lines); for (; line < end; line++) { - if (!view->ops->draw(view, line)) + if (!draw_view_line(view, line)) break; } } @@ -879,15 +973,24 @@ do_scroll_view(struct view *view, int lines) /* Move current line into the view. */ if (view->lineno < view->offset) { view->lineno = view->offset; - view->ops->draw(view, 0); + draw_view_line(view, 0); } else if (view->lineno >= view->offset + view->height) { + if (view->lineno == view->offset + view->height) { + /* Clear the hidden line so it doesn't show if the view + * is scrolled up. */ + wmove(view->win, view->height, 0); + wclrtoeol(view->win); + } view->lineno = view->offset + view->height - 1; - view->ops->draw(view, view->lineno - view->offset); + draw_view_line(view, view->lineno - view->offset); } assert(view->offset <= view->lineno && view->lineno < view->lines); + if (!redraw) + return; + redrawwin(view->win); wrefresh(view->win); report(""); @@ -930,12 +1033,12 @@ scroll_view(struct view *view, enum request request) die("request %d not handled in switch", request); } - do_scroll_view(view, lines); + do_scroll_view(view, lines, TRUE); } /* Cursor moving */ static void -move_view(struct view *view, enum request request) +move_view(struct view *view, enum request request, bool redraw) { int steps; @@ -989,7 +1092,7 @@ move_view(struct view *view, enum request request) wmove(view->win, prev_lineno, 0); wclrtoeol(view->win); - view->ops->draw(view, prev_lineno); + draw_view_line(view, prev_lineno); } /* Check whether the view needs to be scrolled */ @@ -1007,12 +1110,15 @@ move_view(struct view *view, enum request request) } } - do_scroll_view(view, steps); + do_scroll_view(view, steps, redraw); return; } /* Draw the current line */ - view->ops->draw(view, view->lineno - view->offset); + draw_view_line(view, view->lineno - view->offset); + + if (!redraw) + return; redrawwin(view->win); wrefresh(view->win); @@ -1024,10 +1130,26 @@ move_view(struct view *view, enum request request) * Incremental updating */ +static void +end_update(struct view *view) +{ + if (!view->pipe) + return; + set_nonblocking_input(FALSE); + if (view->pipe == stdin) + fclose(view->pipe); + else + pclose(view->pipe); + view->pipe = NULL; +} + static bool begin_update(struct view *view) { - char *id = view->id; + const char *id = view->id; + + if (view->pipe) + end_update(view); if (opt_cmd[0]) { string_copy(view->cmd, opt_cmd); @@ -1036,7 +1158,7 @@ begin_update(struct view *view) * invalid so clear it. */ view->ref[0] = 0; } else { - char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt; + 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)) @@ -1065,8 +1187,8 @@ begin_update(struct view *view) int i; for (i = 0; i < view->lines; i++) - if (view->line[i]) - free(view->line[i]); + if (view->line[i].data) + free(view->line[i].data); free(view->line); view->line = NULL; @@ -1077,25 +1199,12 @@ begin_update(struct view *view) return TRUE; } -static void -end_update(struct view *view) -{ - if (!view->pipe) - return; - set_nonblocking_input(FALSE); - if (view->pipe == stdin) - fclose(view->pipe); - else - pclose(view->pipe); - view->pipe = NULL; -} - static bool update_view(struct view *view) { char buffer[BUFSIZ]; char *line; - void **tmp; + 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. */ @@ -1118,10 +1227,14 @@ update_view(struct view *view) 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, line)) + if (!view->ops->read(view, prev, line)) goto alloc_error; if (lines-- == 1) @@ -1162,15 +1275,21 @@ update_view(struct view *view) goto end; } else if (feof(view->pipe)) { - time_t secs = time(NULL) - view->start_time; - if (view == VIEW(REQ_VIEW_HELP)) { - report("%s", 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("Loaded %d lines in %ld second%s", view->lines, secs, - secs == 1 ? "" : "s"); + report(""); goto end; } @@ -1198,21 +1317,8 @@ open_view(struct view *prev, enum request request, enum open_flags flags) bool split = !!(flags & OPEN_SPLIT); bool reload = !!(flags & OPEN_RELOAD); struct view *view = VIEW(request); - struct view *displayed; - 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; - } - } + int nviews = displayed_views(); + struct view *base_view = display[0]; if (view == prev && nviews == 1 && !reload) { report("Already in %s view", view->name); @@ -1236,7 +1342,11 @@ open_view(struct view *prev, enum request request, enum open_flags flags) display[current_view] = view; } - resize_display(); + /* Resize the view when switching between split- and full-screen, + * or when switching between two different full-screen views. */ + if (nviews != displayed_views() || + (nviews == 1 && base_view != display[0])) + resize_display(); if (split && prev->lineno - prev->offset >= prev->height) { /* Take the title line into account. */ @@ -1244,27 +1354,35 @@ open_view(struct view *prev, enum request request, enum open_flags flags) /* Scroll the view that was split if the current line is * outside the new limited view. */ - do_scroll_view(prev, lines); + do_scroll_view(prev, lines, TRUE); } if (prev && view != prev) { - /* "Blur" the previous view. */ - update_view_title(prev); + if (split && !backgrounded) { + /* "Blur" the previous view. */ + update_view_title(prev); + } - /* Continue loading split views in the background. */ - if (!split) - end_update(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("Loading..."); + report(""); } else { redraw_view(view); - report(""); + if (view == VIEW(REQ_VIEW_HELP)) + report("%s", TIG_HELP); + else + report(""); } + + /* If the view is backgrounded the above calls to report() + * won't redraw the view title. */ + if (backgrounded) + update_view_title(view); } @@ -1284,7 +1402,7 @@ view_driver(struct view *view, enum request request) case REQ_MOVE_PAGE_DOWN: case REQ_MOVE_FIRST_LINE: case REQ_MOVE_LAST_LINE: - move_view(view, request); + move_view(view, request, TRUE); break; case REQ_SCROLL_LINE_DOWN: @@ -1302,16 +1420,34 @@ view_driver(struct view *view, enum request request) open_view(view, request, OPEN_DEFAULT); break; + case REQ_NEXT: + case REQ_PREVIOUS: + request = request == REQ_NEXT ? REQ_MOVE_DOWN : REQ_MOVE_UP; + + if (view == VIEW(REQ_VIEW_DIFF) && + view->parent == VIEW(REQ_VIEW_MAIN)) { + bool redraw = display[1] == view; + + view = view->parent; + move_view(view, request, redraw); + if (redraw) + update_view_title(view); + } else { + move_view(view, request, TRUE); + break; + } + /* Fall-through */ + case REQ_ENTER: if (!view->lines) { report("Nothing to enter"); break; } - return view->ops->enter(view); + return view->ops->enter(view, &view->line[view->lineno]); case REQ_VIEW_NEXT: { - int nviews = display[1] ? 2 : 1; + int nviews = displayed_views(); int next_view = (current_view + 1) % nviews; if (next_view == current_view) { @@ -1322,12 +1458,12 @@ view_driver(struct view *view, enum request request) 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); + report(""); break; } case REQ_TOGGLE_LINE_NUMBERS: opt_line_number = !opt_line_number; - redraw_view(view); + redraw_display(); break; case REQ_PROMPT: @@ -1338,35 +1474,47 @@ view_driver(struct view *view, enum request request) case REQ_STOP_LOADING: foreach_view (view, i) { if (view->pipe) - report("Stopped loaded of %s view", view->name), + report("Stopped loading the %s view", view->name), end_update(view); } break; case REQ_SHOW_VERSION: - report("Version: %s", VERSION); + report("%s (built %s)", VERSION, __DATE__); return TRUE; case REQ_SCREEN_RESIZE: resize_display(); /* Fall-through */ case REQ_SCREEN_REDRAW: - foreach_view (view, i) { - redraw_view(view); - update_view_title(view); - } + redraw_display(); break; case REQ_SCREEN_UPDATE: doupdate(); return TRUE; + case REQ_VIEW_CLOSE: + /* 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 = view; + resize_display(); + redraw_display(); + break; + } + /* Fall-through */ case REQ_QUIT: return FALSE; default: /* An unknown key will show most commonly used commands. */ - report("%s", HELP); + report("Unknown key, press 'h' for help"); return TRUE; } @@ -1375,195 +1523,250 @@ view_driver(struct view *view, enum request request) /* - * View backend handlers + * Pager backend */ static bool -pager_draw(struct view *view, unsigned int lineno) +pager_draw(struct view *view, struct line *line, unsigned int lineno) { - enum line_type type; - char *line; - int linelen; + char *text = line->data; + enum line_type type = line->type; + int textlen = strlen(text); int attr; - if (view->offset + lineno >= view->lines) - return FALSE; - - line = view->line[view->offset + lineno]; - type = get_line_type(line); + wmove(view->win, lineno, 0); if (view->offset + lineno == view->lineno) { if (type == LINE_COMMIT) { - string_copy(view->ref, line + 7); + string_copy(view->ref, text + 7); string_copy(ref_commit, view->ref); } type = LINE_CURSOR; + wchgat(view->win, -1, 0, type, NULL); } attr = get_line_attr(type); wattrset(view->win, attr); - linelen = strlen(line); - linelen = MIN(linelen, view->width); + if (opt_line_number || opt_tab_size < TABSIZE) { + static char spaces[] = " "; + int col_offset = 0, col = 0; - if (opt_line_number) { - static char indent[] = " "; - unsigned long real_lineno = view->offset + lineno + 1; - int col = 0; + if (opt_line_number) { + unsigned long real_lineno = view->offset + lineno + 1; - if (real_lineno == 1 || (real_lineno % opt_num_interval) == 0) - mvwprintw(view->win, lineno, 0, "%.*d", view->digits, real_lineno); + if (real_lineno == 1 || + (real_lineno % opt_num_interval) == 0) { + wprintw(view->win, "%.*d", view->digits, real_lineno); - else if (view->digits < sizeof(indent)) - mvwaddnstr(view->win, lineno, 0, indent, view->digits); + } else { + waddnstr(view->win, spaces, + MIN(view->digits, STRING_SIZE(spaces))); + } + waddstr(view->win, ": "); + col_offset = view->digits + 2; + } - waddstr(view->win, ": "); + while (text && col_offset + col < view->width) { + int cols_max = view->width - col_offset - col; + char *pos = text; + int cols; - while (line) { - if (*line == '\t') { - waddnstr(view->win, " ", 8 - (col % 8)); - col += 8 - (col % 8); - line++; + if (*text == '\t') { + text++; + assert(sizeof(spaces) > TABSIZE); + pos = spaces; + cols = opt_tab_size - (col % opt_tab_size); } else { - char *tab = strchr(line, '\t'); - - if (tab) - waddnstr(view->win, line, tab - line); - else - waddstr(view->win, line); - col += tab - line; - line = tab; + text = strchr(text, '\t'); + cols = line ? text - pos : strlen(pos); } + + waddnstr(view->win, pos, MIN(cols, cols_max)); + col += cols; } - 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 = " ", linelen = 1; -#endif - mvwaddnstr(view->win, lineno, 0, line, linelen); - } + int col = 0, pos = 0; - /* Paint the rest of the line if it's the cursor line. */ - if (type == LINE_CURSOR) - wchgat(view->win, -1, 0, type, NULL); + for (; pos < textlen && col < view->width; pos++, col++) + if (text[pos] == '\t') + col += TABSIZE - (col % TABSIZE) - 1; + + waddnstr(view->win, text, pos); + } return TRUE; } static bool -pager_read(struct view *view, char *line) +pager_read(struct view *view, struct line *prev, char *line) { - view->line[view->lines] = strdup(line); - if (!view->line[view->lines]) + /* Compress empty lines in the help view. */ + if (view == VIEW(REQ_VIEW_HELP) && + !*line && prev && !*((char *) prev->data)) + return TRUE; + + view->line[view->lines].data = strdup(line); + if (!view->line[view->lines].data) return FALSE; + view->line[view->lines].type = get_line_type(line); + view->lines++; return TRUE; } static bool -pager_enter(struct view *view) +pager_enter(struct view *view, struct line *line) { - char *line = view->line[view->lineno]; + int split = 0; - if (get_line_type(line) == LINE_COMMIT) { - open_view(view, REQ_VIEW_DIFF, OPEN_DEFAULT); + if (line->type == LINE_COMMIT && + (view == VIEW(REQ_VIEW_LOG) || + view == VIEW(REQ_VIEW_PAGER))) { + open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT); + split = 1; } + /* Always scroll the view even if it was split. That way + * you can use Enter to scroll through the log view and + * split open each commit diff. */ + scroll_view(view, REQ_SCROLL_LINE_DOWN); + + /* FIXME: A minor workaround. Scrolling the view will call report("") + * but if we are scrolling a non-current view this won't properly + * update the view title. */ + if (split) + update_view_title(view); + return TRUE; } static struct view_ops pager_ops = { + "line", pager_draw, pager_read, pager_enter, }; -static struct ref **get_refs(char *id); +/* + * Main view backend + */ + +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. */ +}; static bool -main_draw(struct view *view, unsigned int lineno) +main_draw(struct view *view, struct line *line, unsigned int lineno) { char buf[DATE_COLS + 1]; - struct commit *commit; + struct commit *commit = line->data; enum line_type type; - int cols = 0; + int col = 0; size_t timelen; + size_t authorlen; + int trimmed = 1; - if (view->offset + lineno >= view->lines) - return FALSE; - - commit = view->line[view->offset + lineno]; if (!*commit->author) return FALSE; + wmove(view->win, lineno, col); + if (view->offset + lineno == view->lineno) { string_copy(view->ref, commit->id); string_copy(ref_commit, view->ref); type = LINE_CURSOR; + wattrset(view->win, get_line_attr(type)); + wchgat(view->win, -1, 0, type, NULL); + } else { type = LINE_MAIN_COMMIT; + wattrset(view->win, get_line_attr(LINE_MAIN_DATE)); } - wmove(view->win, lineno, cols); - wattrset(view->win, get_line_attr(LINE_MAIN_DATE)); - timelen = strftime(buf, sizeof(buf), DATE_FORMAT, &commit->time); waddnstr(view->win, buf, timelen); waddstr(view->win, " "); - cols += DATE_COLS; - wmove(view->win, lineno, cols); - wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR)); + col += DATE_COLS; + wmove(view->win, lineno, col); + if (type != LINE_CURSOR) + wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR)); - if (strlen(commit->author) > 19) { - waddnstr(view->win, commit->author, 18); - wattrset(view->win, get_line_attr(LINE_MAIN_DELIM)); + 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); + if (type != LINE_CURSOR) + wattrset(view->win, get_line_attr(LINE_MAIN_DELIM)); waddch(view->win, '~'); } else { waddstr(view->win, commit->author); } - cols += 20; - wattrset(view->win, A_NORMAL); - mvwaddch(view->win, lineno, cols, ACS_LTEE); - wmove(view->win, lineno, cols + 2); + col += AUTHOR_COLS; + 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 (commit->refs) { size_t i = 0; do { - if (commit->refs[i]->tag) + if (type == LINE_CURSOR) + ; + else 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); + if (type != LINE_CURSOR) + wattrset(view->win, A_NORMAL); waddstr(view->win, " "); + col += strlen(commit->refs[i]->name) + STRING_SIZE("[] "); } while (commit->refs[i++]->next); } - wattrset(view->win, get_line_attr(type)); - waddstr(view->win, commit->title); - wattrset(view->win, A_NORMAL); + if (type != LINE_CURSOR) + wattrset(view->win, get_line_attr(type)); + + { + int titlelen = strlen(commit->title); + + if (col + titlelen > view->width) + titlelen = view->width - col; + + waddnstr(view->win, commit->title, titlelen); + } return TRUE; } /* Reads git log --pretty=raw output and parses it into the commit struct. */ static bool -main_read(struct view *view, char *line) +main_read(struct view *view, struct line *prev, char *line) { enum line_type type = get_line_type(line); struct commit *commit; @@ -1576,7 +1779,7 @@ main_read(struct view *view, char *line) line += STRING_SIZE("commit "); - view->line[view->lines++] = commit; + view->line[view->lines++].data = commit; string_copy(commit->id, line); commit->refs = get_refs(commit->id); break; @@ -1586,12 +1789,16 @@ main_read(struct view *view, char *line) char *ident = line + STRING_SIZE("author "); char *end = strchr(ident, '<'); + if (!prev) + break; + + commit = prev->data; + if (end) { for (; end > ident && isspace(end[-1]); end--) ; *end = 0; } - commit = view->line[view->lines - 1]; string_copy(commit->author, ident); /* Parse epoch and timezone */ @@ -1625,13 +1832,12 @@ 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) + if (!prev) break; + commit = prev->data; + /* Fill in the commit title if it has not already been set. */ - commit = view->line[view->lines - 1]; if (commit->title[0]) break; @@ -1650,25 +1856,343 @@ main_read(struct view *view, char *line) } static bool -main_enter(struct view *view) +main_enter(struct view *view, struct line *line) { - open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT | OPEN_BACKGROUNDED); + enum open_flags flags = display[0] == view ? OPEN_SPLIT : OPEN_DEFAULT; + + open_view(view, REQ_VIEW_DIFF, flags); return TRUE; } static struct view_ops main_ops = { + "commit", main_draw, main_read, main_enter, }; +/** + * 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 + * + * NOTE: Much of the following code for dealing with unicode is derived from + * ELinks' UTF-8 code developed by Scrool . Origin file is + * src/intl/charset.c from the utf8 branch commit elinks-0.11.0-g31f2c28. + */ + +/* I've (over)annotated a lot of code snippets because I am not entirely + * confident that the approach taken by this small UTF-8 interface is correct. + * --jonas */ + +static inline int +unicode_width(unsigned long c) +{ + if (c >= 0x1100 && + (c <= 0x115f /* Hangul Jamo */ + || c == 0x2329 + || c == 0x232a + || (c >= 0x2e80 && c <= 0xa4cf && c != 0x303f) + /* CJK ... Yi */ + || (c >= 0xac00 && c <= 0xd7a3) /* Hangul Syllables */ + || (c >= 0xf900 && c <= 0xfaff) /* CJK Compatibility Ideographs */ + || (c >= 0xfe30 && c <= 0xfe6f) /* CJK Compatibility Forms */ + || (c >= 0xff00 && c <= 0xff60) /* Fullwidth Forms */ + || (c >= 0xffe0 && c <= 0xffe6) + || (c >= 0x20000 && c <= 0x2fffd) + || (c >= 0x30000 && c <= 0x3fffd))) + return 2; + + return 1; +} + +/* Number of bytes used for encoding a UTF-8 character indexed by first byte. + * Illegal bytes are set one. */ +static const unsigned char utf8_bytes[256] = { + 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, + 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, + 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, + 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, + 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, + 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, 1,1,1,1,1,1,1,1, + 2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2, 2,2,2,2,2,2,2,2, + 3,3,3,3,3,3,3,3, 3,3,3,3,3,3,3,3, 4,4,4,4,4,4,4,4, 5,5,5,5,6,6,1,1, +}; + +/* Decode UTF-8 multi-byte representation into a unicode character. */ +static inline unsigned long +utf8_to_unicode(const char *string, size_t length) +{ + unsigned long unicode; + + switch (length) { + case 1: + unicode = string[0]; + break; + case 2: + unicode = (string[0] & 0x1f) << 6; + unicode += (string[1] & 0x3f); + break; + case 3: + unicode = (string[0] & 0x0f) << 12; + unicode += ((string[1] & 0x3f) << 6); + unicode += (string[2] & 0x3f); + break; + case 4: + unicode = (string[0] & 0x0f) << 18; + unicode += ((string[1] & 0x3f) << 12); + unicode += ((string[2] & 0x3f) << 6); + unicode += (string[3] & 0x3f); + break; + case 5: + unicode = (string[0] & 0x0f) << 24; + unicode += ((string[1] & 0x3f) << 18); + unicode += ((string[2] & 0x3f) << 12); + unicode += ((string[3] & 0x3f) << 6); + unicode += (string[4] & 0x3f); + break; + case 6: + unicode = (string[0] & 0x01) << 30; + unicode += ((string[1] & 0x3f) << 24); + unicode += ((string[2] & 0x3f) << 18); + unicode += ((string[3] & 0x3f) << 12); + unicode += ((string[4] & 0x3f) << 6); + unicode += (string[5] & 0x3f); + break; + default: + die("Invalid unicode length"); + } + + /* Invalid characters could return the special 0xfffd value but NUL + * should be just as good. */ + return unicode > 0xffff ? 0 : unicode; +} + +/* Calculates how much of string can be shown within the given maximum width + * and sets trimmed parameter to non-zero value if all of string could not be + * shown. + * + * Additionally, adds to coloffset how many many columns to move to align with + * the expected position. Takes into account how multi-byte and double-width + * characters will effect the cursor position. + * + * Returns the number of bytes to output from string to satisfy max_width. */ +static size_t +utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed) +{ + const char *start = string; + const char *end = strchr(string, '\0'); + size_t mbwidth = 0; + size_t width = 0; + + *trimmed = 0; + + while (string < end) { + int c = *(unsigned char *) string; + unsigned char bytes = utf8_bytes[c]; + size_t ucwidth; + unsigned long unicode; + + if (string + bytes > end) + break; + + /* Change representation to figure out whether + * it is a single- or double-width character. */ + + unicode = utf8_to_unicode(string, bytes); + /* FIXME: Graceful handling of invalid unicode character. */ + if (!unicode) + break; + + ucwidth = unicode_width(unicode); + width += ucwidth; + if (width > max_width) { + *trimmed = 1; + break; + } + + /* The column offset collects the differences between the + * number of bytes encoding a character and the number of + * columns will be used for rendering said character. + * + * So if some character A is encoded in 2 bytes, but will be + * represented on the screen using only 1 byte this will and up + * adding 1 to the multi-byte column offset. + * + * Assumes that no double-width character can be encoding in + * less than two bytes. */ + if (bytes > ucwidth) + mbwidth += bytes - ucwidth; + + string += bytes; + } + + *coloffset += mbwidth; + + return string - start; +} + + /* * Status management */ /* Whether or not the curses interface has been initialized. */ -bool cursed = FALSE; +static bool cursed = FALSE; /* The status window is used for polling keystrokes. */ static WINDOW *status_win; @@ -1677,32 +2201,39 @@ static WINDOW *status_win; static void report(const char *msg, ...) { - va_list args; + static bool empty = TRUE; + struct view *view = display[current_view]; - /* Update the title window first, so the cursor ends up in the status - * window. */ - update_view_title(display[current_view]); + if (!empty || *msg) { + va_list args; - va_start(args, msg); + va_start(args, msg); - werase(status_win); - wmove(status_win, 0, 0); - if (*msg) - vwprintw(status_win, msg, args); - wrefresh(status_win); + werase(status_win); + wmove(status_win, 0, 0); + if (*msg) { + vwprintw(status_win, msg, args); + empty = FALSE; + } else { + empty = TRUE; + } + wrefresh(status_win); - va_end(args); + va_end(args); + } + + update_view_title(view); + update_display_cursor(); } /* 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; + static unsigned int loading_views; - if ((loading == FALSE && nloading-- == 1) || - (loading == TRUE && nloading++ == 0)) + if ((loading == FALSE && loading_views-- == 1) || + (loading == TRUE && loading_views++ == 0)) nodelay(status_win, loading); } @@ -1748,109 +2279,187 @@ init_display(void) */ static struct ref *refs; -size_t refs_size; +static size_t refs_size; + +/* Id <-> ref store */ +static struct ref ***id_refs; +static size_t id_refs_size; static struct ref ** get_refs(char *id) { - struct ref **id_refs = NULL; - size_t id_refs_size = 0; + struct ref ***tmp_id_refs; + struct ref **ref_list = NULL; + size_t ref_list_size = 0; size_t i; + for (i = 0; i < id_refs_size; i++) + if (!strcmp(id, id_refs[i][0]->id)) + return id_refs[i]; + + tmp_id_refs = realloc(id_refs, (id_refs_size + 1) * sizeof(*id_refs)); + if (!tmp_id_refs) + return NULL; + + id_refs = tmp_id_refs; + 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)); + tmp = realloc(ref_list, (ref_list_size + 1) * sizeof(*ref_list)); if (!tmp) { - if (id_refs) - free(id_refs); + if (ref_list) + free(ref_list); return NULL; } - id_refs = tmp; - if (id_refs_size > 0) - id_refs[id_refs_size - 1]->next = 1; - id_refs[id_refs_size] = &refs[i]; + ref_list = tmp; + if (ref_list_size > 0) + ref_list[ref_list_size - 1]->next = 1; + ref_list[ref_list_size] = &refs[i]; /* XXX: The properties of the commit chains ensures that we can * safely modify the shared ref. The repo references will * always be similar for the same id. */ - id_refs[id_refs_size]->next = 0; - id_refs_size++; + ref_list[ref_list_size]->next = 0; + ref_list_size++; } - return id_refs; + if (ref_list) + id_refs[id_refs_size++] = ref_list; + + return ref_list; } static int -load_refs(void) +read_ref(char *id, int idlen, char *name, int namelen) { - 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; + struct ref *ref; + bool tag = FALSE; + bool tag_commit = FALSE; + + /* 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; + } - if (!pipe) - return ERR; + if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) { + if (!tag_commit) + return OK; + name += STRING_SIZE("refs/tags/"); + tag = TRUE; - while ((line = fgets(buffer, sizeof(buffer), pipe))) { - char *name = strchr(line, '\t'); - struct ref *ref; - int namelen; - bool tag = FALSE; + } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) { + name += STRING_SIZE("refs/heads/"); - if (!name) - continue; + } else if (!strcmp(name, "HEAD")) { + return OK; + } - *name++ = 0; - namelen = strlen(name) - 1; - if (name[namelen - 1] == '}') { - while (namelen > 0 && name[namelen] != '^') - namelen--; - } - name[namelen] = 0; + refs = realloc(refs, sizeof(*refs) * (refs_size + 1)); + if (!refs) + return ERR; - if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) { - name += STRING_SIZE("refs/tags/"); - tag = TRUE; + ref = &refs[refs_size++]; + ref->name = strdup(name); + if (!ref->name) + return ERR; - } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) { - name += STRING_SIZE("refs/heads/"); + ref->tag = tag; + string_copy(ref->id, id); - } else if (!strcmp(name, "HEAD")) { - continue; - } + return OK; +} - refs = realloc(refs, sizeof(*refs) * (refs_size + 1)); - if (!refs) - return ERR; +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; - ref = &refs[refs_size++]; - ref->tag = tag; - ref->name = strdup(name); - if (!ref->name) - return ERR; + return read_properties(cmd, '\t', read_ref); +} - string_copy(ref->id, line); +static int +read_config_option(char *name, int namelen, char *value, int valuelen) +{ + if (!strcmp(name, "i18n.commitencoding")) { + string_copy(opt_encoding, value); } - if (ferror(pipe)) + return OK; +} + +static int +load_config(void) +{ + return read_properties("git repo-config --list", '=', + read_config_option); +} + +static int +read_properties(const char *cmd, int separator, + int (*read_property)(char *, int, char *, int)) +{ + FILE *pipe = popen(cmd, "r"); + char buffer[BUFSIZ]; + char *name; + int state = OK; + + if (!pipe) return ERR; + while (state == OK && (name = fgets(buffer, sizeof(buffer), pipe))) { + char *value = strchr(name, separator); + int namelen; + int valuelen; + + if (value) { + namelen = value - name; + *value++ = 0; + valuelen = strlen(value); + if (valuelen > 0) { + valuelen--; + value[valuelen] = 0; + } + + } else { + namelen = strlen(name); + value = ""; + valuelen = 0; + } + + if (namelen) + state = read_property(name, namelen, value, valuelen); + } + + if (state != ERR && ferror(pipe)) + state = ERR; + pclose(pipe); - return OK; + return state; } + /* * Main */ -static void +#if __GNUC__ >= 3 +#define __NORETURN __attribute__((__noreturn__)) +#else +#define __NORETURN +#endif + +static void __NORETURN quit(int sig) { /* XXX: Restore tty modes and let the OS cleanup the rest! */ @@ -1859,7 +2468,8 @@ quit(int sig) exit(0); } -static void die(const char *err, ...) +static void __NORETURN +die(const char *err, ...) { va_list args; @@ -1883,12 +2493,21 @@ main(int argc, char *argv[]) signal(SIGINT, quit); + /* Load the repo config file first so options can be overwritten from + * the command line. */ + if (load_config() == ERR) + die("Failed to load repo config."); + if (!parse_options(argc, argv)) return 0; if (load_refs() == ERR) die("Failed to load refs."); + /* Require a git repository unless when running in pager mode. */ + if (refs_size == 0 && opt_request != REQ_VIEW_PAGER) + die("Not a git repository"); + for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++) view->cmd_env = getenv(view->cmd_env); @@ -1907,7 +2526,7 @@ main(int argc, char *argv[]) key = wgetch(status_win); request = get_request(key); - /* Some low-level request handling. This keeps handling of + /* Some low-level request handling. This keeps access to * status_win restricted. */ switch (request) { case REQ_PROMPT: @@ -1921,7 +2540,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(); @@ -1952,6 +2573,116 @@ main(int argc, char *argv[]) } /** + * [[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. + * + * - The prompt doesn't work while loading. + * * TODO * ---- * Features that should be explored. @@ -1962,7 +2693,7 @@ main(int argc, char *argv[]) * * COPYRIGHT * --------- - * Copyright (c) Jonas Fonseca , 2006 + * 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 @@ -1971,9 +2702,12 @@ 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. + * - link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)], + * - link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)] + * + * Other git repository browsers: + * + * - gitk(1) + * - qgit(1) + * - gitview(1) **/