* SYNOPSIS
* --------
* [verse]
- * tig [options] [ref]
+ * 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]
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
+#include <unistd.h>
#include <time.h>
#include <curses.h>
REQ_VIEW_DIFF,
REQ_VIEW_LOG,
REQ_VIEW_HELP,
+ REQ_VIEW_PAGER,
- REQ_QUIT,
- REQ_SHOW_VERSION,
REQ_ENTER,
- REQ_STOP_LOADING,
+ REQ_QUIT,
+ REQ_PROMPT,
REQ_SCREEN_REDRAW,
REQ_SCREEN_UPDATE,
+ REQ_SHOW_VERSION,
+ REQ_STOP_LOADING,
REQ_TOGGLE_LINE_NUMBERS,
+ REQ_VIEW_NEXT,
REQ_MOVE_UP,
REQ_MOVE_DOWN,
struct tm time; /* Date from the author ident. */
};
+/*
+ * String helpers
+ */
static inline void
string_ncopy(char *dst, char *src, int dstlen)
{
strncpy(dst, src, dstlen - 1);
dst[dstlen - 1] = 0;
+
}
/* Shorthand for safely copying into a fixed buffer. */
#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
+ * 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;
+}
+
/**
* OPTIONS
static int opt_line_number = FALSE;
static int opt_num_interval = NUMBER_INTERVAL;
static enum request opt_request = REQ_VIEW_MAIN;
-
-char ref_head[SIZEOF_REF] = "HEAD";
-char ref_commit[SIZEOF_REF] = "HEAD";
+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
!strcmp(opt, "diff")) {
opt_request = opt[0] == 'l'
? REQ_VIEW_LOG : REQ_VIEW_DIFF;
- return i;
+ break;
}
/**
}
/**
- * 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
**/
- if (opt[0] && opt[0] != '-') {
- string_copy(ref_head, opt);
- string_copy(ref_commit, opt);
- continue;
+ if (!strcmp(opt, "--")) {
+ i++;
+ break;
}
+ /* Make stuff like:
+ *
+ * $ tig tag-1.0..HEAD
+ *
+ * work.
+ */
+ if (opt[0] && opt[0] != '-')
+ break;
+
die("unknown command '%s'", opt);
}
+ /**
+ * 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
+ **/
+ if (!isatty(STDIN_FILENO)) {
+ opt_request = REQ_VIEW_PAGER;
+ opt_pipe = stdin;
+
+ } else if (i < argc) {
+ size_t buf_size;
+
+ /* XXX: This is vulnerable to the user overriding options
+ * required for the main view parser. */
+ if (opt_request == REQ_VIEW_MAIN)
+ string_copy(opt_cmd, "git log --stat --pretty=raw");
+ else
+ string_copy(opt_cmd, "git");
+ buf_size = strlen(opt_cmd);
+
+ while (buf_size < sizeof(opt_cmd) && i < argc) {
+ opt_cmd[buf_size++] = ' ';
+ buf_size = sq_quote(opt_cmd, buf_size, argv[i++]);
+ }
+
+ if (buf_size >= sizeof(opt_cmd))
+ die("command too long");
+
+ opt_cmd[buf_size] = 0;
+
+ }
+
return i;
}
* 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 },
{ 'h', REQ_VIEW_HELP },
+ { KEY_TAB, REQ_VIEW_NEXT },
{ KEY_RETURN, REQ_ENTER },
/**
* Show version.
* n::
* Toggle line numbers on/off.
+ * ':'::
+ * Open prompt.
**/
{ KEY_ESC, REQ_QUIT },
{ 'q', REQ_QUIT },
{ '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 },
LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
/* Pretty print commit header */ \
-LINE(AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
-LINE(MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
-LINE(DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
+LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
+LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
+LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
+LINE(PP_COMMIT, "Commit: ", COLOR_GREEN, COLOR_DEFAULT, 0), \
/* Raw commit header */ \
LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
*/
struct view {
- const char *name;
- const char *cmd;
- char *id;
-
- size_t objsize; /* Size of objects in the line index */
+ const char *name; /* View name */
+ const char *cmdfmt; /* Default command line format */
+ char *id; /* Points to either of ref_{head,commit} */
+ size_t objsize; /* Size of objects in the line index */
struct view_ops {
bool (*draw)(struct view *view, unsigned int lineno);
bool (*enter)(struct view *view);
} *ops;
- char cmdbuf[SIZEOF_CMD];
- char ref[SIZEOF_REF]; /* Commit reference */
+ 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;
WINDOW *title;
#define HELP_CMD \
"man tig 2> /dev/null"
+char ref_head[SIZEOF_REF] = "HEAD";
+char ref_commit[SIZEOF_REF] = "HEAD";
+
static struct view views[] = {
- { "main", MAIN_CMD, ref_head, sizeof(struct commit), &main_ops },
- { "diff", DIFF_CMD, ref_commit, sizeof(char), &pager_ops },
- { "log", LOG_CMD, ref_head, sizeof(char), &pager_ops },
- { "help", HELP_CMD, ref_head, sizeof(char), &pager_ops },
+ { "main", MAIN_CMD, ref_head, sizeof(struct commit), &main_ops },
+ { "diff", DIFF_CMD, ref_commit, sizeof(char), &pager_ops },
+ { "log", LOG_CMD, ref_head, sizeof(char), &pager_ops },
+ { "help", HELP_CMD, ref_head, sizeof(char), &pager_ops },
+ { "pager", "cat", ref_head, sizeof(char), &pager_ops },
};
#define VIEW(req) (&views[(req) - REQ_OFFSET - 1])
static void
resize_display(void)
{
- int height, width, offset, i;
+ int offset, i;
struct view *base = display[0];
struct view *view = display[1] ? display[1] : display[0];
/* Setup window dimensions */
- getmaxyx(stdscr, height, width);
+ getmaxyx(stdscr, base->height, base->width);
/* Make room for the status window. */
- base->height = height - 1;
- base->width = width;
+ base->height -= 1;
if (view != base) {
+ /* Horizontal split. */
+ view->width = base->width;
view->height = SCALE_SPLIT_VIEW(base->height);
base->height -= view->height;
wmove(view->title, 0, 0);
/* [main] ref: 334b506... - commit 6 of 4383 (0%) */
- wprintw(view->title, "[%s] ref: %s", view->name, ref_commit);
+
+ 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";
lines = view->lines - view->offset;
if (lines == 0 || view->offset + view->height >= view->lines) {
- report("Already at last line");
+ report("Already on last line");
return;
}
break;
lines = view->offset;
if (lines == 0) {
- report("Already at first line");
+ report("Already on first line");
return;
}
lines = -lines;
break;
+
default:
die("request %d not handled in switch", request);
}
}
if (steps <= 0 && view->lineno == 0) {
- report("Already at first line");
+ report("Already on 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("Already on last line");
return;
}
wmove(view->win, prev_lineno, 0);
wclrtoeol(view->win);
- view->ops->draw(view, view->lineno - steps - view->offset);
+ view->ops->draw(view, prev_lineno);
}
/* Check whether the view needs to be scrolled */
* Incremental updating
*/
-static int
+static bool
begin_update(struct view *view)
{
char *id = view->id;
- if (snprintf(view->cmdbuf, sizeof(view->cmdbuf), view->cmd,
- id, id, id) < sizeof(view->cmdbuf))
- view->pipe = popen(view->cmdbuf, "r");
+ if (opt_cmd[0]) {
+ string_copy(view->cmd, opt_cmd);
+ opt_cmd[0] = 0;
+ } else {
+ if (snprintf(view->cmd, sizeof(view->cmd), view->cmdfmt,
+ id, id, id) >= sizeof(view->cmd))
+ return FALSE;
+ }
+
+ /* Special case for the pager view. */
+ if (opt_pipe) {
+ view->pipe = opt_pipe;
+ opt_pipe = NULL;
+ } else {
+ view->pipe = popen(view->cmd, "r");
+ }
if (!view->pipe)
return FALSE;
view->offset = 0;
view->lines = 0;
view->lineno = 0;
+ string_copy(view->vid, id);
if (view->line) {
int i;
static void
end_update(struct view *view)
{
+ if (!view->pipe)
+ return;
set_nonblocking_input(FALSE);
pclose(view->pipe);
view->pipe = NULL;
}
-static int
+static bool
update_view(struct view *view)
{
char buffer[BUFSIZ];
}
if (ferror(view->pipe)) {
- report("Failed to read %s: %s", view->cmd, strerror(errno));
+ report("Failed to read: %s", strerror(errno));
goto end;
} else if (feof(view->pipe)) {
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 void
-switch_view(struct view *prev, enum request request,
- bool backgrounded, bool split)
+open_view(struct view *prev, enum request request, enum open_flags flags)
{
+ bool backgrounded = !!(flags & OPEN_BACKGROUNDED);
+ bool split = !!(flags & OPEN_SPLIT);
+ bool reload = !!(flags & OPEN_RELOAD);
struct view *view = VIEW(request);
struct view *displayed;
int nviews;
- /* Cycle between displayed views */
+ /* Cycle between displayed views and count the views. */
foreach_view (displayed, nviews) {
- if (view == displayed && prev != view) {
+ if (prev != view &&
+ view == displayed &&
+ !strcmp(view->id, prev->id)) {
current_view = nviews;
/* Blur out the title of the previous view. */
update_view_title(prev);
}
}
- if (view == prev && nviews == 1) {
+ if (view == prev && nviews == 1 && !reload) {
report("Already in %s view", view->name);
return;
}
- /* Split to diff view? */
- if (split &&
- nviews == 1 &&
- SCALE_SPLIT_VIEW(prev->height) > 3 &&
- prev == VIEW(REQ_VIEW_MAIN) &&
- view == VIEW(REQ_VIEW_DIFF)) {
- split = TRUE;
- }
-
- if (!begin_update(view)) {
+ if (strcmp(view->vid, view->id) &&
+ !begin_update(view)) {
report("Failed to load %s view", view->name);
return;
}
resize_display();
+ if (split && prev->lineno - prev->offset > prev->height) {
+ /* Take the title line into account. */
+ int lines = prev->lineno - prev->height + 1;
+
+ /* Scroll the view that was split if the current line is
+ * outside the new limited view. */
+ do_scroll_view(prev, lines);
+ }
+
if (prev && view != prev) {
/* "Blur" the previous view. */
update_view_title(prev);
/* Continue loading split views in the background. */
- if (!split && prev->pipe)
+ if (!split)
end_update(prev);
}
- /* Clear the old view and let the incremental updating refill
- * the screen. */
- wclear(view->win);
- report("Loading...");
+ 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("");
+ }
}
case REQ_VIEW_DIFF:
case REQ_VIEW_LOG:
case REQ_VIEW_HELP:
- switch_view(view, request, FALSE, FALSE);
+ case REQ_VIEW_PAGER:
+ open_view(view, request, OPEN_DEFAULT);
break;
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_PROMPT:
+ open_view(view, opt_request, OPEN_RELOAD);
+ break;
+
case REQ_STOP_LOADING:
- foreach_view (view, i)
+ foreach_view (view, i) {
if (view->pipe)
- end_update(view);
+ report("Stopped loaded of %s view", view->name),
+ end_update(view);
+ }
break;
case REQ_SHOW_VERSION:
type = get_line_type(line);
if (view->offset + lineno == view->lineno) {
- if (type == LINE_COMMIT)
- string_copy(ref_commit, line + 7);
+ switch (type) {
+ case LINE_COMMIT:
+ string_copy(view->ref, line + 7);
+ string_copy(ref_commit, view->ref);
+ break;
+ case LINE_PP_COMMIT:
+ string_copy(view->ref, line + 8);
+ string_copy(ref_commit, view->ref);
+ default:
+ break;
+ }
type = LINE_CURSOR;
}
char *line = view->line[view->lineno];
if (get_line_type(line) == LINE_COMMIT) {
- report("FIXME: Open commit");
+ open_view(view, REQ_VIEW_DIFF, OPEN_DEFAULT);
}
return TRUE;
return FALSE;
if (view->offset + lineno == view->lineno) {
- string_copy(ref_commit, commit->id);
+ string_copy(view->ref, commit->id);
+ string_copy(ref_commit, view->ref);
type = LINE_CURSOR;
} else {
type = LINE_MAIN_COMMIT;
static bool
main_enter(struct view *view)
{
- switch_view(view, REQ_VIEW_DIFF, FALSE, TRUE);
+ open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT | OPEN_BACKGROUNDED);
return TRUE;
}
{
int x, y;
- initscr(); /* Initialize the curses library */
+ /* Initialize the curses library */
+ if (isatty(STDIN_FILENO)) {
+ initscr();
+ } else {
+ /* Leave stdin and stdout alone when acting as a pager. */
+ FILE *io = fopen("/dev/tty", "r+");
+
+ newterm(NULL, io, io);
+ }
+
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 */
main(int argc, char *argv[])
{
enum request request;
- int git_cmd;
+ int git_arg;
signal(SIGINT, quit);
- git_cmd = parse_options(argc, argv);
- if (git_cmd < 0)
+ git_arg = parse_options(argc, argv);
+ if (git_arg < 0)
return 0;
- if (git_cmd < argc) {
- die("FIXME: Handle git diff/log options");
- }
-
request = opt_request;
init_display();
/* Refresh, accept single keystroke of input */
key = wgetch(status_win);
request = get_request(key);
+
+ if (request == 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();
+ }
}
quit(0);
*
* - Dynamic scaling of line number indentation.
*
- * - Proper command line handling; ability to take the command that should be
- * shown. Example:
- *
- * $ tig log -p
- *
* - Internal command line (exmode-inspired) which allows to specify what git
* log or git diff command to run. Example:
*
* :log -p
*
- * - Proper resizing support. I am yet to figure out whether catching SIGWINCH
- * is preferred over using ncurses' built-in support for resizing.
+ * - Terminal resizing support. I am yet to figure out whether catching
+ * SIGWINCH is preferred over using ncurses' built-in support for resizing.
*
* - Locale support.
*
~mdw / tig / blobdiff