**/
#ifndef VERSION
-#define VERSION "tig-0.1"
+#define VERSION "tig-0.3"
#endif
#ifndef DEBUG
/* 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, (Enter) show diff"
+#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"
*/
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;
{
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++)) {
/**
* \--::
- * End of tig(1) options. Useful when specifying commands
+ * End of tig(1) options. Useful when specifying command
* options for the main view. Example:
*
* $ tig -- --since=1.month
*
* $ tig log --pretty=fuller
*
- * See the "Specifying revisions" 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.
+ * See the <<refspec, "Specifying revisions">> 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)
};
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. */
};
**/
#define TIG_LS_REMOTE \
- "git ls-remote ."
+ "git ls-remote . 2>/dev/null"
/**
+ * [[view-commands]]
* View commands
* ~~~~~~~~~~~~~
* It is possible to alter which commands are used for the different views.
#define TIG_MAIN_CMD \
"git log --topo-order --stat --pretty=raw %s"
-/* We silently ignore that the following are also exported. */
+/* ... silently ignore that the following are also exported. */
#define TIG_HELP_CMD \
- "man tig 2> /dev/null"
+ "man tig 2>/dev/null"
#define TIG_PAGER_CMD \
""
+
/**
* 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(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 revision. 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.
+ * If you are in the log view and press 'Enter' when the current line is a
+ * commit line, such as:
*
- * 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.
+ * commit 4d55caff4cc89335192f3e566004b4ceef572521
*
- * The pager view::
- * Is used for displaying both input from stdin and output from git
- * commands entered in the internal prompt.
+ * You will split the view so that the log view is displayed in the top window
+ * and the diff view in the bottom window. You can switch between the two
+ * views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
+ **/
+
+struct view;
+
+/* 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++)
+
+
+/**
+ * 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 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.
+ * The head ID is used when opening the main and log view to indicate from
+ * what revision to show history.
**/
+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} */
+ 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} */
size_t objsize; /* Size of objects in the line index */
struct view_ops {
/* What type of content being displayed. Used in the
* title bar. */
- char *type;
+ const char *type;
/* Draw one line; @lineno must be < view->height. */
bool (*draw)(struct view *view, unsigned int lineno);
/* Read one line; updates view->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, objsize, ops) \
{ name, cmd, #env, ref, objsize, 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_(HELP, "help", &pager_ops, "static", sizeof(char)),
VIEW_(PAGER, "pager", &pager_ops, "static", sizeof(char)),
};
#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 void
redraw_view_from(struct view *view, int lineno)
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) {
+ wprintw(view->title, " - %s %d of %d (%d%%)",
+ view->ops->type,
+ view->lineno + 1,
+ view->lines,
+ (view->lineno + 1) * 100 / view->lines);
+ }
+
+ wrefresh(view->title);
+}
+
static void
resize_display(void)
{
offset = 0;
foreach_view (view, i) {
- /* Keep the size of the all view windows one lager than is
- * required. This makes current line management easier when the
- * cursor will go outside the window. */
+ /* Keep the height of all view->win windows one larger than is
+ * required so that the cursor can wrap-around on the last line
+ * without scrolling the window. */
if (!view->win) {
view->win = newwin(view->height + 1, 0, offset, 0);
if (!view->win)
}
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);
-
- /* [main] ref: 334b506... - commit 6 of 4383 (0%) */
-
- if (*view->ref)
- wprintw(view->title, "[%s] %s", view->name, view->ref);
- else
- wprintw(view->title, "[%s]", view->name);
+ struct view *view;
+ int i;
- if (view->lines) {
- wprintw(view->title, " - %s %d of %d (%d%%)",
- view->ops->type,
- view->lineno + 1,
- view->lines,
- (view->lineno + 1) * 100 / view->lines);
+ foreach_view (view, i) {
+ redraw_view(view);
+ update_view_title(view);
}
-
- wrefresh(view->title);
}
+
/*
* Navigation
*/
static bool
begin_update(struct view *view)
{
- char *id = view->id;
+ const char *id = view->id;
if (opt_cmd[0]) {
string_copy(view->cmd, opt_cmd);
* 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))
time_t secs = time(NULL) - view->start_time;
if (view == VIEW(REQ_VIEW_HELP)) {
- char *msg = TIG_HELP;
+ const char *msg = TIG_HELP;
if (view->lines == 0) {
/* Slightly ugly, but abusing view->ref keeps
}
case REQ_TOGGLE_LINE_NUMBERS:
opt_line_number = !opt_line_number;
- redraw_view(view);
- update_view_title(view);
+ redraw_display();
break;
case REQ_PROMPT:
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:
{
char *line = view->line[view->lineno];
+ if (view == VIEW(REQ_VIEW_DIFF)) {
+ scroll_view(view, REQ_SCROLL_LINE_DOWN);
+ return TRUE;
+ }
+
if (get_line_type(line) == LINE_COMMIT) {
if (view == VIEW(REQ_VIEW_LOG))
open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT | OPEN_BACKGROUNDED);
int request;
};
-struct keymap keymap[] = {
+static struct keymap keymap[] = {
/**
* View switching
* ~~~~~~~~~~~~~~
* Switch to pager view.
* h::
* Show man page.
- * Return::
- * If on a commit line show the commit diff. Additionally, if in
- * main or log view this will split the view. To open the commit
- * diff in full size view either use 'd' or press Return twice.
+ * 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.
**/
* j::
* Move cursor one line down and enter.
* PgUp::
+ * b::
* Move cursor one page up.
* PgDown::
+ * Space::
* Move cursor one page down.
* Home::
* Jump to first line.
{ 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 },
/**
* Scrolling
* z::
* Stop all background loading. This can be useful if you use
* tig(1) in a repository with a long history without limiting
- * the log output.
+ * the revision log.
* v::
* Show version.
* n::
*/
static struct ref *refs;
-size_t refs_size;
+static size_t refs_size;
static struct ref **
get_refs(char *id)
static int
load_refs(void)
{
- char *cmd_env = getenv("TIG_LS_REMOTE");
- char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
+ const char *cmd_env = getenv("TIG_LS_REMOTE");
+ const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
FILE *pipe = popen(cmd, "r");
char buffer[BUFSIZ];
char *line;
pclose(pipe);
+ if (refs_size == 0)
+ die("Not a git repository");
+
return OK;
}
* 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! */
exit(0);
}
-static void die(const char *err, ...)
+static void __NORETURN
+die(const char *err, ...)
{
va_list args;
}
/**
- * Specifying revisions
- * --------------------
- * This section describes various ways to specify what revisions to
- * display or otherwise limit the view to.
+ * [[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 <<view-commands, "View commands">> 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 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`.
*
- * NOTE: You can tune the interaction with git by making use of the options
- * explained in this section.
+ * If you are only interested in changed that happened between two dates
+ * you can use:
*
- * NOTE: tig(1) does not itself parse the revision options
- * described in this section.
+ * $ tig -- --after="May 5th" --before="2006-05-16 15:44"
*
- * Ranges
- * ~~~~~~
+ * 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:
*
* ~~~~~~~~~~~~~~~~~~~~~~~~
* 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:
*
* 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:
* link:http://www.kernel.org/pub/software/scm/git/docs/[git(7)],
* link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)]
* gitk(1): git repository browser written using tcl/tk,
+ * qgit(1): git repository browser written using c++/Qt,
* gitview(1): git repository browser written using python/gtk.
**/