* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*/
-/**
- * TIG(1)
- * ======
- *
- * NAME
- * ----
- * tig - text-mode interface for git
- *
- * SYNOPSIS
- * --------
- * [verse]
- * tig [options]
- * tig [options] [--] [git log options]
- * tig [options] log [git log options]
- * tig [options] diff [git diff options]
- * tig [options] show [git show options]
- * tig [options] < [git command output]
- *
- * DESCRIPTION
- * -----------
- * Browse changes in a git repository. Additionally, tig(1) can also act
- * as a pager for output of various git commands.
- *
- * When browsing repositories, tig(1) uses the underlying git commands
- * to present the user with various views, such as summarized commit log
- * and showing the commit with the log message, diffstat, and the diff.
- *
- * Using tig(1) as a pager, it will display input from stdin and try
- * to colorize it.
- **/
#ifndef VERSION
#define VERSION "tig-0.3"
static int read_properties(FILE *pipe, const char *separators, int (*read)(char *, int, char *, int));
static void set_nonblocking_input(bool loading);
static size_t utf8_length(const char *string, size_t max_width, int *coloffset, int *trimmed);
+static void load_help_page(void);
#define ABS(x) ((x) >= 0 ? (x) : -(x))
#define MIN(x, y) ((x) < (y) ? (x) : (y))
/* 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 SCALE_SPLIT_VIEW(height) ((height) * 2 / 3)
+#define TIG_LS_REMOTE \
+ "git ls-remote . 2>/dev/null"
+
+#define TIG_DIFF_CMD \
+ "git show --patch-with-stat --find-copies-harder -B -C %s"
+
+#define TIG_LOG_CMD \
+ "git log --cc --stat -n100 %s"
+
+#define TIG_MAIN_CMD \
+ "git log --topo-order --stat --pretty=raw %s"
+
+/* XXX: Needs to be defined to the empty string. */
+#define TIG_HELP_CMD ""
+#define TIG_PAGER_CMD ""
+
/* Some ascii-shorthands fitted into the ncurses namespace. */
#define KEY_TAB '\t'
#define KEY_RETURN '\r'
#define KEY_ESC 27
-/* User action requests. */
-enum request {
- /* Offset all requests to avoid conflicts with ncurses getch values. */
- REQ_OFFSET = KEY_MAX + 1,
-
- /* XXX: Keep the view request first and in sync with views[]. */
- REQ_VIEW_MAIN,
- REQ_VIEW_DIFF,
- REQ_VIEW_LOG,
- REQ_VIEW_HELP,
- REQ_VIEW_PAGER,
-
- REQ_ENTER,
- REQ_QUIT,
- REQ_PROMPT,
- REQ_SCREEN_REDRAW,
- REQ_SCREEN_RESIZE,
- REQ_SCREEN_UPDATE,
- REQ_SHOW_VERSION,
- REQ_STOP_LOADING,
- REQ_TOGGLE_LINE_NUMBERS,
- REQ_VIEW_NEXT,
- REQ_VIEW_CLOSE,
- REQ_NEXT,
- REQ_PREVIOUS,
-
- REQ_MOVE_UP,
- REQ_MOVE_DOWN,
- REQ_MOVE_PAGE_UP,
- REQ_MOVE_PAGE_DOWN,
- REQ_MOVE_FIRST_LINE,
- REQ_MOVE_LAST_LINE,
-
- REQ_SCROLL_LINE_UP,
- REQ_SCROLL_LINE_DOWN,
- REQ_SCROLL_PAGE_UP,
- REQ_SCROLL_PAGE_DOWN,
-};
-
struct ref {
char *name; /* Ref name; tag or head names are shortened. */
char id[41]; /* Commit SHA1 ID */
return name;
}
+static bool
+string_nformat(char *buf, size_t bufsize, int *bufpos, const char *fmt, ...)
+{
+ va_list args;
+ int pos = bufpos ? *bufpos : 0;
+
+ va_start(args, fmt);
+ pos += vsnprintf(buf + pos, bufsize - pos, fmt, args);
+ va_end(args);
+
+ if (bufpos)
+ *bufpos = pos;
+
+ return pos >= bufsize ? FALSE : TRUE;
+}
+
+#define string_format(buf, fmt, args...) \
+ string_nformat(buf, sizeof(buf), NULL, fmt, args)
+
+#define string_format_from(buf, from, fmt, args...) \
+ string_nformat(buf, sizeof(buf), from, fmt, args)
/* Shell quoting
*
}
-/**
- * OPTIONS
- * -------
- **/
+/*
+ * User requests
+ */
+
+#define REQ_INFO \
+ /* XXX: Keep the view request first and in sync with views[]. */ \
+ REQ_GROUP("View switching") \
+ REQ_(VIEW_MAIN, "Show main view"), \
+ REQ_(VIEW_DIFF, "Show diff view"), \
+ REQ_(VIEW_LOG, "Show log view"), \
+ REQ_(VIEW_HELP, "Show help page"), \
+ REQ_(VIEW_PAGER, "Show pager view"), \
+ \
+ REQ_GROUP("View manipulation") \
+ REQ_(ENTER, "Enter current line and scroll"), \
+ REQ_(NEXT, "Move to next"), \
+ REQ_(PREVIOUS, "Move to previous"), \
+ REQ_(VIEW_NEXT, "Move focus to next view"), \
+ REQ_(VIEW_CLOSE, "Close the current view"), \
+ REQ_(QUIT, "Close all views and quit"), \
+ \
+ REQ_GROUP("Cursor navigation") \
+ REQ_(MOVE_UP, "Move cursor one line up"), \
+ REQ_(MOVE_DOWN, "Move cursor one line down"), \
+ REQ_(MOVE_PAGE_DOWN, "Move cursor one page down"), \
+ REQ_(MOVE_PAGE_UP, "Move cursor one page up"), \
+ REQ_(MOVE_FIRST_LINE, "Move cursor to first line"), \
+ REQ_(MOVE_LAST_LINE, "Move cursor to last line"), \
+ \
+ REQ_GROUP("Scrolling") \
+ REQ_(SCROLL_LINE_UP, "Scroll one line up"), \
+ REQ_(SCROLL_LINE_DOWN, "Scroll one line down"), \
+ REQ_(SCROLL_PAGE_UP, "Scroll one page up"), \
+ REQ_(SCROLL_PAGE_DOWN, "Scroll one page down"), \
+ \
+ REQ_GROUP("Misc") \
+ REQ_(PROMPT, "Bring up the prompt"), \
+ REQ_(SCREEN_UPDATE, "Update the screen"), \
+ REQ_(SCREEN_REDRAW, "Redraw the screen"), \
+ REQ_(SCREEN_RESIZE, "Resize the screen"), \
+ REQ_(SHOW_VERSION, "Show version information"), \
+ REQ_(STOP_LOADING, "Stop all loading views"), \
+ REQ_(TOGGLE_LINENO, "Toggle line numbers"),
+
+
+/* User action requests. */
+enum request {
+#define REQ_GROUP(help)
+#define REQ_(req, help) REQ_##req
+
+ /* Offset all requests to avoid conflicts with ncurses getch values. */
+ REQ_OFFSET = KEY_MAX + 1,
+ REQ_INFO
+
+#undef REQ_GROUP
+#undef REQ_
+};
+
+struct request_info {
+ enum request request;
+ char *help;
+};
+
+static struct request_info req_info[] = {
+#define REQ_GROUP(help) { 0, (help) },
+#define REQ_(req, help) { REQ_##req, (help) }
+ REQ_INFO
+#undef REQ_GROUP
+#undef REQ_
+};
+
+/*
+ * Options
+ */
static const char usage[] =
VERSION " (" __DATE__ ")\n"
for (i = 1; i < argc; i++) {
char *opt = argv[i];
- /**
- * -l::
- * Start up in log view using the internal log command.
- **/
if (!strcmp(opt, "-l")) {
opt_request = REQ_VIEW_LOG;
continue;
}
- /**
- * -d::
- * Start up in diff view using the internal diff command.
- **/
if (!strcmp(opt, "-d")) {
opt_request = REQ_VIEW_DIFF;
continue;
}
- /**
- * -n[INTERVAL], --line-number[=INTERVAL]::
- * Prefix line numbers in log and diff view.
- * Optionally, with interval different than each line.
- **/
if (!strncmp(opt, "-n", 2) ||
!strncmp(opt, "--line-number", 13)) {
char *num = opt;
continue;
}
- /**
- * -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;
continue;
}
- /**
- * -v, --version::
- * Show version and exit.
- **/
if (!strcmp(opt, "-v") ||
!strcmp(opt, "--version")) {
printf("tig version %s\n", VERSION);
return FALSE;
}
- /**
- * -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 command
- * options for the main view. Example:
- *
- * $ tig -- --since=1.month
- **/
if (!strcmp(opt, "--")) {
i++;
break;
}
- /**
- * log [git log options]::
- * Open log view using the given git log options.
- *
- * diff [git diff options]::
- * Open diff view using the given git diff options.
- *
- * show [git show options]::
- * Open diff view using the given git show options.
- **/
if (!strcmp(opt, "log") ||
!strcmp(opt, "diff") ||
!strcmp(opt, "show")) {
break;
}
- /**
- * [git log options]::
- * tig(1) will stop the option parsing when the first
- * command line parameter not starting with "-" is
- * encountered. All options including this one will be
- * passed to git log when loading the main view.
- * This makes it possible to say:
- *
- * $ tig tag-1.0..HEAD
- **/
if (opt[0] && opt[0] != '-')
break;
}
if (!isatty(STDIN_FILENO)) {
- /**
- * Pager mode
- * ~~~~~~~~~~
- * If stdin is a pipe, any log or diff options will be ignored and the
- * pager view will be opened loading data from stdin. The pager mode
- * can be used for colorizing output from various git commands.
- *
- * Example on how to colorize the output of git-show(1):
- *
- * $ git show | tig
- **/
opt_request = REQ_VIEW_PAGER;
opt_pipe = stdin;
} else if (i < argc) {
size_t buf_size;
- /**
- * Git command options
- * ~~~~~~~~~~~~~~~~~~~
- * All git command options specified on the command line will
- * be passed to the given command and all will be shell quoted
- * before they are passed to the shell.
- *
- * NOTE: If you specify options for the main view, you should
- * not use the `--pretty` option as this option will be set
- * automatically to the format expected by the main view.
- *
- * Example on how to open the log view and show both author and
- * committer information:
- *
- * $ tig log --pretty=fuller
- *
- * See the <<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)
/* XXX: This is vulnerable to the user overriding
* options required for the main view parser. */
}
-/**
- * ENVIRONMENT VARIABLES
- * ---------------------
- * Several options related to the interface with git can be configured
- * via environment options.
- *
- * Repository references
- * ~~~~~~~~~~~~~~~~~~~~~
- * Commits that are referenced by tags and branch heads will be marked
- * by the reference name surrounded by '[' and ']':
- *
- * 2006-03-26 19:42 Petr Baudis | [cogito-0.17.1] Cogito 0.17.1
- *
- * If you want to filter out certain directories under `.git/refs/`, say
- * `tmp` you can do it by setting the following variable:
- *
- * $ TIG_LS_REMOTE="git ls-remote . | sed /\/tmp\//d" tig
- *
- * Or set the variable permanently in your environment.
- *
- * TIG_LS_REMOTE::
- * Set command for retrieving all repository references. The command
- * should output data in the same format as git-ls-remote(1).
- **/
-
-#define TIG_LS_REMOTE \
- "git ls-remote . 2>/dev/null"
-
-/**
- * [[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.
- **/
-
-#define TIG_DIFF_CMD \
- "git show --patch-with-stat --find-copies-harder -B -C %s"
-
-#define TIG_LOG_CMD \
- "git log --cc --stat -n100 %s"
-
-#define TIG_MAIN_CMD \
- "git log --topo-order --stat --pretty=raw %s"
-
-/* ... silently ignore that the following are also exported. */
-
-#define TIG_HELP_CMD \
- "man tig 2>/dev/null"
-
-#define TIG_PAGER_CMD \
- ""
-
-
-/**
- * FILES
- * -----
- * '~/.tig'::
- * User configuration file. See "<<config-options, Configuration options>>"
- * section for examples.
- *
- * '.git/config'::
- * Repository config file. Read on startup with the help of
- * git-repo-config(1).
- **/
-/**
- * [[config-options]]
- * User Configuration file
- * -----------------------
- * You can permanently set an option by putting it in the `~/.tig` file.
- * The file consists of a series of 'commands'. Each
- * line of the file may contain only one command.
- *
- * The hash mark ('#'), or semi-colon (';') is used as a 'comment' character.
- * All text after the comment character to the end of the line is ignored.
- * You can use comments to annotate your initialization file.
- *
- * Some sample options:
- *
- * ==========================================================================
- * # Diff colors
- * color diff-header yellow default
- * color diff-index blue default
- * color diff-chunk magenta default
- * # UI colors
- * color title-blur white blue
- * color title-focus white blue bold
- * ==========================================================================
- *
- * [[color-options]]
- * Color options
- * ~~~~~~~~~~~~~
- * Color options control highlighting and the user interface styles.
- * If your terminal supports color, these commands can be used to assign
- * foreground/backgound combinations to certain areas. Optionally, an
- * attribute can be given as the last parameter. The syntax is:
- *
- * [verse]
- * ..........................................................................
- * *color* 'area' 'fgcolor' 'bgcolor' '[attributes]'
- * ..........................................................................
- *
- * Valid colors include: *white*, *black*, *green*, *magenta*, *blue*, *cyan*,
- * *yellow*, *red*, *default*. Use *default* to refer to the default terminal
- * colors.
- **/
-
static struct int_map color_map[] = {
#define COLOR_MAP(name) { #name, STRING_SIZE(#name), COLOR_##name }
COLOR_MAP(DEFAULT),
COLOR_MAP(YELLOW),
};
-/**
- * Valid attributes include: *normal*, *blink*, *bold*, *dim*, *reverse*, *standout*,
- * and *underline*. Note, not all attributes may be supported by the terminal.
- **/
-
static struct int_map attr_map[] = {
#define ATTR_MAP(name) { #name, STRING_SIZE(#name), A_##name }
ATTR_MAP(NORMAL),
ATTR_MAP(UNDERLINE),
};
-/**
- * Valid area names are described below. Note, all names are case-insensitive,
- * and you may use '-', '_', and '.' interchangeably. So "Diff-Header",
- * "DIFF_HEADER", and "diff.header" are the same.
- *
- * --
- **/
#define LINE_INFO \
-/**
- * Diff markup::
- *
- * Options concerning diff start, chunks and lines added and deleted.
- *
- * *diff-header*, *diff-chunk*, *diff-add*, *diff-del*
- **/ \
LINE(DIFF_HEADER, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(DIFF_CHUNK, "@@", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
LINE(DIFF_ADD, "+", COLOR_GREEN, COLOR_DEFAULT, 0), \
LINE(DIFF_DEL, "-", COLOR_RED, COLOR_DEFAULT, 0), \
-/**
- * Enhanced git diff markup::
- *
- * Extra diff information emitted by the git diff machinery, such as mode
- * changes, rename detection, and similarity.
- *
- * *diff-oldmode*, *diff-newmode*, *diff-copy-from*, *diff-copy-to*,
- * *diff-rename-from*, *diff-rename-to*, *diff-similarity* *diff-dissimilarity*
- * *diff-tree*, *diff-index*
- **/ \
LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(DIFF_SIMILARITY, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(DIFF_DISSIMILARITY,"dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
-/**
- * Pretty print commit headers::
- *
- * Commit diffs and the revision logs are usually formatted using pretty
- * printed headers , unless `--pretty=raw` was given. This includes lines,
- * such as merge info, commit ID, and author and comitter date.
- *
- * *pp-author*, *pp-commit*, *pp-merge*, *pp-date*, *pp-adate*, *pp-cdate*
- **/ \
LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-/**
- * Raw commit header::
- *
- * Usually shown when `--pretty=raw` is given, however 'commit' is pretty
- * much omnipresent.
- *
- * *commit*, *parent*, *tree*, *author*, *committer*
- **/ \
+LINE(PP_REFS, "Refs: ", COLOR_RED, COLOR_DEFAULT, 0), \
LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
-/**
- * Commit message::
- *
- * For now only `Signed-off-by lines` are colorized.
- *
- * *signoff*
- **/ \
LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-/**
- * UI colors::
- *
- * Colors for text not matching any of the above: *default*
- *
- * Status window colors: *status*
- *
- * Title window colors: *title-blur*, *title-focus*
- *
- * Cursor line colors: *cursor*
- *
- * Main view specific: *main-date*, *main-author*, *main-commit*, *main-delim*,
- * *main-tag*, *main-ref*
- **/ \
LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD), \
-/**
- * --
- **/
/*
config_lineno = 0;
config_errors = FALSE;
- if (!home ||
- snprintf(buf, sizeof(buf), "%s/.tig", home) >= sizeof(buf))
+ if (!home || !string_format(buf, "%s/.tigrc", home))
return ERR;
/* It's ok that the file doesn't exist. */
}
-/**
+/*
* The viewer
- * ----------
- * The display consists of a status window on the last line of the screen and
- * one or more views. The default is to only show one view at the time but it
- * is possible to split both the main and log view to also show the commit
- * diff.
- *
- * If you are in the log view and press 'Enter' when the current line is a
- * commit line, such as:
- *
- * commit 4d55caff4cc89335192f3e566004b4ceef572521
- *
- * You will split the view so that the log view is displayed in the top window
- * and the diff view in the bottom window. You can switch between the two
- * views by pressing 'Tab'. To maximize the log view again, simply press 'l'.
- **/
+ */
struct view;
struct view_ops;
#define displayed_views() (display[1] != NULL ? 2 : 1)
-/**
- * Current head and commit ID
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~
- * The viewer keeps track of both what head and commit ID you are currently
- * viewing. The commit ID will follow the cursor line and change everytime time
- * you highlight a different commit. Whenever you reopen the diff view it
- * will be reloaded, if the commit ID changed.
- *
- * The head ID is used when opening the main and log view to indicate from
- * what revision to show history.
- **/
-
+/* Current head and commit ID */
static char ref_commit[SIZEOF_REF] = "HEAD";
static char ref_head[SIZEOF_REF] = "HEAD";
/* Buffering */
unsigned long lines; /* Total number of lines */
struct line *line; /* Line index */
+ unsigned long line_size;/* Total number of allocated lines */
unsigned int digits; /* Number of digits in the lines member. */
/* Loading */
/* Draw one line; @lineno must be < view->height. */
bool (*draw)(struct view *view, struct line *line, unsigned int lineno);
/* Read one line; updates view->line. */
- bool (*read)(struct view *view, struct line *prev, char *data);
+ bool (*read)(struct view *view, char *data);
/* Depending on view, change display based on current line. */
bool (*enter)(struct view *view, struct line *line);
};
#define VIEW_(id, name, ops, ref) \
VIEW_STR(name, TIG_##id##_CMD, TIG_##id##_CMD, ref, 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),
}
-/**
- * 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.
- * For long loading views (taking over 3 seconds) the time since loading
- * started will be appended:
- *
- * [main] 77d9e40fbcea3238015aea403e06f61542df9a31 - commit 1 of 779 (0%) 5s
- **/
-
static void
update_view_title(struct view *view)
{
} else {
const char *format = view->cmd_env ? view->cmd_env : view->cmd_fmt;
- if (snprintf(view->cmd, sizeof(view->cmd), format,
- id, id, id, id, id) >= sizeof(view->cmd))
+ if (!string_format(view->cmd, format, id, id, id, id, id))
return FALSE;
}
return TRUE;
}
+static struct line *
+realloc_lines(struct view *view, size_t line_size)
+{
+ struct line *tmp = realloc(view->line, sizeof(*view->line) * line_size);
+
+ if (!tmp)
+ return NULL;
+
+ view->line = tmp;
+ view->line_size = line_size;
+ return view->line;
+}
+
static bool
update_view(struct view *view)
{
char buffer[BUFSIZ];
char *line;
- struct line *tmp;
/* The number of lines to read. If too low it will cause too much
* redrawing (and possible flickering), if too high responsiveness
* will suffer. */
if (view->offset + view->height >= view->lines)
redraw_from = view->lines - view->offset;
- tmp = realloc(view->line, sizeof(*view->line) * (view->lines + lines));
- if (!tmp)
+ if (!realloc_lines(view, view->lines + lines))
goto alloc_error;
- view->line = tmp;
-
while ((line = fgets(buffer, sizeof(buffer), view->pipe))) {
int linelen = strlen(line);
- struct line *prev = view->lines
- ? &view->line[view->lines - 1]
- : NULL;
-
if (linelen)
line[linelen - 1] = 0;
- if (!view->ops->read(view, prev, line))
+ if (!view->ops->read(view, line))
goto alloc_error;
if (lines-- == 1)
goto end;
} else if (feof(view->pipe)) {
- if (view == VIEW(REQ_VIEW_HELP)) {
- const char *msg = TIG_HELP;
-
- if (view->lines == 0) {
- /* Slightly ugly, but abusing view->ref keeps
- * the error message. */
- string_copy(view->ref, "No help available");
- msg = "The tig(1) manpage is not installed";
- }
-
- report("%s", msg);
- goto end;
- }
-
report("");
goto end;
}
}
if (split) {
- display[current_view + 1] = view;
+ display[1] = view;
if (!backgrounded)
- current_view++;
+ current_view = 1;
} else {
/* Maximize the current view. */
memset(display, 0, sizeof(display));
view->parent = prev;
}
+ if (view == VIEW(REQ_VIEW_HELP))
+ load_help_page();
+
if (view->pipe && view->lines == 0) {
/* Clear the old view and let the incremental updating refill
* the screen. */
report("");
} else {
redraw_view(view);
- if (view == VIEW(REQ_VIEW_HELP))
- report("%s", TIG_HELP);
- else
- report("");
+ report("");
}
/* If the view is backgrounded the above calls to report()
report("");
break;
}
- case REQ_TOGGLE_LINE_NUMBERS:
+ case REQ_TOGGLE_LINENO:
opt_line_number = !opt_line_number;
redraw_display();
break;
return TRUE;
}
+static void
+add_pager_refs(struct view *view, struct line *line)
+{
+ char buf[1024];
+ char *data = line->data;
+ struct ref **refs;
+ int bufpos = 0, refpos = 0;
+ const char *sep = "Refs: ";
+
+ assert(line->type == LINE_COMMIT);
+
+ refs = get_refs(data + STRING_SIZE("commit "));
+ if (!refs)
+ return;
+
+ do {
+ struct ref *ref = refs[refpos];
+ char *fmt = ref->tag ? "%s[%s]" : "%s%s";
+
+ if (!string_format_from(buf, &bufpos, fmt, sep, ref->name))
+ return;
+ sep = ", ";
+ } while (refs[refpos++]->next);
+
+ if (!realloc_lines(view, view->line_size + 1))
+ return;
+
+ line = &view->line[view->lines];
+ line->data = strdup(buf);
+ if (!line->data)
+ return;
+
+ line->type = LINE_PP_REFS;
+ view->lines++;
+}
+
static bool
-pager_read(struct view *view, struct line *prev, char *line)
+pager_read(struct view *view, char *data)
{
- /* Compress empty lines in the help view. */
- if (view == VIEW(REQ_VIEW_HELP) &&
- !*line && prev && !*((char *) prev->data))
- return TRUE;
+ struct line *line = &view->line[view->lines];
- view->line[view->lines].data = strdup(line);
- if (!view->line[view->lines].data)
+ line->data = strdup(data);
+ if (!line->data)
return FALSE;
- view->line[view->lines].type = get_line_type(line);
-
+ line->type = get_line_type(line->data);
view->lines++;
+
+ if (line->type == LINE_COMMIT &&
+ (view == VIEW(REQ_VIEW_DIFF) ||
+ view == VIEW(REQ_VIEW_LOG)))
+ add_pager_refs(view, line);
+
return TRUE;
}
/* Reads git log --pretty=raw output and parses it into the commit struct. */
static bool
-main_read(struct view *view, struct line *prev, char *line)
+main_read(struct view *view, char *line)
{
enum line_type type = get_line_type(line);
- struct commit *commit;
+ struct commit *commit = view->lines
+ ? view->line[view->lines - 1].data : NULL;
switch (type) {
case LINE_COMMIT:
char *ident = line + STRING_SIZE("author ");
char *end = strchr(ident, '<');
- if (!prev)
+ if (!commit)
break;
- commit = prev->data;
-
if (end) {
for (; end > ident && isspace(end[-1]); end--) ;
*end = 0;
break;
}
default:
- if (!prev)
+ if (!commit)
break;
- commit = prev->data;
-
/* Fill in the commit title if it has not already been set. */
if (commit->title[0])
break;
};
-/**
- * KEYS
- * ----
- * Below the default key bindings are shown.
- **/
+/*
+ * Keys
+ */
struct keymap {
int alias;
};
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.
- **/
+ /* View switching */
{ 'm', REQ_VIEW_MAIN },
{ 'd', REQ_VIEW_DIFF },
{ 'l', REQ_VIEW_LOG },
{ 'p', REQ_VIEW_PAGER },
{ 'h', REQ_VIEW_HELP },
+ { '?', REQ_VIEW_HELP },
- /**
- * View manipulation
- * ~~~~~~~~~~~~~~~~~
- * q::
- * 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.
- **/
+ /* View manipulation */
{ 'q', REQ_VIEW_CLOSE },
{ KEY_TAB, REQ_VIEW_NEXT },
{ KEY_RETURN, REQ_ENTER },
{ KEY_UP, REQ_PREVIOUS },
{ KEY_DOWN, REQ_NEXT },
- /**
- * Cursor navigation
- * ~~~~~~~~~~~~~~~~~
- * 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.
- **/
+ /* Cursor navigation */
{ 'k', REQ_MOVE_UP },
{ 'j', REQ_MOVE_DOWN },
{ KEY_HOME, REQ_MOVE_FIRST_LINE },
{ '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.
- **/
+ /* Scrolling */
{ KEY_IC, REQ_SCROLL_LINE_UP },
{ KEY_DC, REQ_SCROLL_LINE_DOWN },
{ 'w', REQ_SCROLL_PAGE_UP },
{ 's', REQ_SCROLL_PAGE_DOWN },
- /**
- * Misc
- * ~~~~
- * Q::
- * 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
- **/
+ /* Misc */
{ 'Q', REQ_QUIT },
{ 'z', REQ_STOP_LOADING },
{ 'v', REQ_SHOW_VERSION },
{ 'r', REQ_SCREEN_REDRAW },
- { 'n', REQ_TOGGLE_LINE_NUMBERS },
+ { 'n', REQ_TOGGLE_LINENO },
{ ':', REQ_PROMPT },
/* wgetch() with nodelay() enabled returns ERR when there's no input. */
return (enum request) key;
}
+struct key {
+ char *name;
+ int value;
+};
+
+static struct key key_table[] = {
+ { "Enter", KEY_RETURN },
+ { "Space", ' ' },
+ { "Backspace", KEY_BACKSPACE },
+ { "Tab", KEY_TAB },
+ { "Escape", KEY_ESC },
+ { "Left", KEY_LEFT },
+ { "Right", KEY_RIGHT },
+ { "Up", KEY_UP },
+ { "Down", KEY_DOWN },
+ { "Insert", KEY_IC },
+ { "Delete", KEY_DC },
+ { "Home", KEY_HOME },
+ { "End", KEY_END },
+ { "PageUp", KEY_PPAGE },
+ { "PageDown", KEY_NPAGE },
+ { "F1", KEY_F(1) },
+ { "F2", KEY_F(2) },
+ { "F3", KEY_F(3) },
+ { "F4", KEY_F(4) },
+ { "F5", KEY_F(5) },
+ { "F6", KEY_F(6) },
+ { "F7", KEY_F(7) },
+ { "F8", KEY_F(8) },
+ { "F9", KEY_F(9) },
+ { "F10", KEY_F(10) },
+ { "F11", KEY_F(11) },
+ { "F12", KEY_F(12) },
+};
+
+static char *
+get_key(enum request request)
+{
+ static char buf[BUFSIZ];
+ static char key_char[] = "'X'";
+ int pos = 0;
+ char *sep = " ";
+ int i;
+
+ buf[pos] = 0;
+
+ for (i = 0; i < ARRAY_SIZE(keymap); i++) {
+ char *seq = NULL;
+ int key;
+
+ if (keymap[i].request != request)
+ continue;
+
+ for (key = 0; key < ARRAY_SIZE(key_table); key++)
+ if (key_table[key].value == keymap[i].alias)
+ seq = key_table[key].name;
+
+ if (seq == NULL &&
+ keymap[i].alias < 127 &&
+ isprint(keymap[i].alias)) {
+ key_char[1] = (char) keymap[i].alias;
+ seq = key_char;
+ }
+
+ if (!seq)
+ seq = "'?'";
+
+ if (!string_format_from(buf, &pos, "%s%s", sep, seq))
+ return "Too many keybindings!";
+ sep = ", ";
+ }
+
+ return buf;
+}
+
+static void load_help_page(void)
+{
+ char buf[BUFSIZ];
+ struct view *view = VIEW(REQ_VIEW_HELP);
+ int lines = ARRAY_SIZE(req_info) + 2;
+ int i;
+
+ if (view->lines > 0)
+ return;
+
+ for (i = 0; i < ARRAY_SIZE(req_info); i++)
+ if (!req_info[i].request)
+ lines++;
+
+ view->line = calloc(lines, sizeof(*view->line));
+ if (!view->line) {
+ report("Allocation failure");
+ return;
+ }
+
+ pager_read(view, "Quick reference for tig keybindings:");
+
+ for (i = 0; i < ARRAY_SIZE(req_info); i++) {
+ char *key;
+
+ if (!req_info[i].request) {
+ pager_read(view, "");
+ pager_read(view, req_info[i].help);
+ continue;
+ }
+
+ key = get_key(req_info[i].request);
+ if (!string_format(buf, "%-25s %s", key, req_info[i].help))
+ continue;
+
+ pager_read(view, buf);
+ }
+}
+
/*
* Unicode / UTF-8 handling
return 0;
}
-
-/**
- * [[refspec]]
- * Revision specification
- * ----------------------
- * This section describes various ways to specify what revisions to display
- * or otherwise limit the view to. tig(1) does not itself parse the described
- * revision options so refer to the relevant git man pages for futher
- * information. Relevant man pages besides git-log(1) are git-diff(1) and
- * git-rev-list(1).
- *
- * You can tune the interaction with git by making use of the options
- * explained in this section. For example, by configuring the environment
- * variables described in the <<history-commands, "History 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 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.
- *
- * - Searching.
- *
- * - Locale support.
- *
- * - Make '?' show a one page keybinding cheat sheet.
- *
- * COPYRIGHT
- * ---------
- * Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * SEE ALSO
- * --------
- * - 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)
- **/
~mdw / tig / blobdiff