/* Copyright (c) 2006 Jonas Fonseca <fonseca@diku.dk>
- * 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)
* ======
**/
#ifndef VERSION
-#define VERSION "tig-0.1"
+#define VERSION "tig-0.3"
#endif
#ifndef DEBUG
static void die(const char *err, ...);
static void report(const char *msg, ...);
+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);
#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, (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"
#define DATE_COLS STRING_SIZE("2006-04-29 14:21 ")
+#define AUTHOR_COLS 20
+
/* The default interval between line numbers. */
#define NUMBER_INTERVAL 1
REQ_STOP_LOADING,
REQ_TOGGLE_LINE_NUMBERS,
REQ_VIEW_NEXT,
+ REQ_VIEW_CLOSE,
+ REQ_NEXT,
+ REQ_PREVIOUS,
REQ_MOVE_UP,
- REQ_MOVE_UP_ENTER,
REQ_MOVE_DOWN,
- REQ_MOVE_DOWN_ENTER,
REQ_MOVE_PAGE_UP,
REQ_MOVE_PAGE_DOWN,
REQ_MOVE_FIRST_LINE,
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);
+
+struct int_map {
+ const char *name;
+ int namelen;
+ int value;
};
+static int
+set_from_int_map(struct int_map *map, size_t map_size,
+ int *value, const char *name, int namelen)
+{
+
+ int i;
+
+ for (i = 0; i < map_size; i++)
+ if (namelen == map[i].namelen &&
+ !strncasecmp(name, map[i].name, namelen)) {
+ *value = map[i].value;
+ return OK;
+ }
+
+ return ERR;
+}
+
/*
* 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;
#define string_copy(dst, src) \
string_ncopy(dst, src, sizeof(dst))
+static char *
+chomp_string(char *name)
+{
+ int namelen;
+
+ while (isspace(*name))
+ name++;
+
+ namelen = strlen(name) - 1;
+ while (namelen > 0 && isspace(name[namelen]))
+ name[namelen--] = 0;
+
+ return name;
+}
+
/* Shell quoting
*
{
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++)) {
* -------
**/
+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"
+" -b[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. */
}
/**
- * -t[NSPACES], --tab-size[=NSPACES]::
+ * -b[NSPACES], --tab-size[=NSPACES]::
* Set the number of spaces tabs should be expanded to.
**/
- if (!strncmp(opt, "-t", 2) ||
+ if (!strncmp(opt, "-b", 2) ||
!strncmp(opt, "--tab-size", 10)) {
char *num = opt;
- if (opt[1] == 't') {
+ if (opt[1] == 'b') {
num = opt + 2;
} else if (opt[STRING_SIZE("--tab-size")] == '=') {
}
/**
+ * -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:
}
+ if (*opt_encoding && strcasecmp(opt_encoding, "UTF-8"))
+ opt_utf8 = FALSE;
+
return TRUE;
}
-/*
- * Line-oriented content detection.
- */
+/**
+ * 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
+ * -----
+ * '~/.tigrc'::
+ * User configuration file. See tigrc(5) for examples.
+ *
+ * '.git/config'::
+ * Repository config file. Read on startup with the help of
+ * git-repo-config(1).
+ **/
+
+static struct int_map color_map[] = {
+#define COLOR_MAP(name) { #name, STRING_SIZE(#name), COLOR_##name }
+ COLOR_MAP(DEFAULT),
+ COLOR_MAP(BLACK),
+ COLOR_MAP(BLUE),
+ COLOR_MAP(CYAN),
+ COLOR_MAP(GREEN),
+ COLOR_MAP(MAGENTA),
+ COLOR_MAP(RED),
+ COLOR_MAP(WHITE),
+ COLOR_MAP(YELLOW),
+};
+
+static struct int_map attr_map[] = {
+#define ATTR_MAP(name) { #name, STRING_SIZE(#name), A_##name }
+ ATTR_MAP(NORMAL),
+ ATTR_MAP(BLINK),
+ ATTR_MAP(BOLD),
+ ATTR_MAP(DIM),
+ ATTR_MAP(REVERSE),
+ ATTR_MAP(STANDOUT),
+ ATTR_MAP(UNDERLINE),
+};
#define LINE_INFO \
-/* Line type String to match Foreground Background Attributes
- * --------- --------------- ---------- ---------- ---------- */ \
-/* Diff markup */ \
-LINE(DIFF, "diff --git ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-LINE(DIFF_INDEX, "index ", COLOR_BLUE, COLOR_DEFAULT, 0), \
+LINE(DIFF_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), \
-LINE(DIFF_OLDMODE, "old file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-LINE(DIFF_NEWMODE, "new file mode ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-LINE(DIFF_COPY, "copy ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-LINE(DIFF_RENAME, "rename ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-LINE(DIFF_SIM, "similarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-LINE(DIFF_DISSIM, "dissimilarity ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-/* Pretty print commit header */ \
+LINE(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_COPY_FROM, "copy from", COLOR_YELLOW, COLOR_DEFAULT, 0), \
+LINE(DIFF_COPY_TO, "copy to", COLOR_YELLOW, COLOR_DEFAULT, 0), \
+LINE(DIFF_RENAME_FROM, "rename from", COLOR_YELLOW, COLOR_DEFAULT, 0), \
+LINE(DIFF_RENAME_TO, "rename to", 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), \
LINE(PP_AUTHOR, "Author: ", COLOR_CYAN, COLOR_DEFAULT, 0), \
LINE(PP_COMMIT, "Commit: ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
LINE(PP_MERGE, "Merge: ", COLOR_BLUE, COLOR_DEFAULT, 0), \
LINE(PP_DATE, "Date: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(PP_ADATE, "AuthorDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
LINE(PP_CDATE, "CommitDate: ", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-/* Raw commit header */ \
LINE(COMMIT, "commit ", COLOR_GREEN, COLOR_DEFAULT, 0), \
LINE(PARENT, "parent ", COLOR_BLUE, COLOR_DEFAULT, 0), \
LINE(TREE, "tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
LINE(AUTHOR, "author ", COLOR_CYAN, COLOR_DEFAULT, 0), \
LINE(COMMITTER, "committer ", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
-/* Misc */ \
-LINE(DIFF_TREE, "diff-tree ", COLOR_BLUE, COLOR_DEFAULT, 0), \
LINE(SIGNOFF, " Signed-off-by", COLOR_YELLOW, COLOR_DEFAULT, 0), \
-/* UI colors */ \
LINE(DEFAULT, "", COLOR_DEFAULT, COLOR_DEFAULT, A_NORMAL), \
LINE(CURSOR, "", COLOR_WHITE, COLOR_GREEN, A_BOLD), \
LINE(STATUS, "", COLOR_GREEN, COLOR_DEFAULT, 0), \
LINE(MAIN_COMMIT, "", COLOR_DEFAULT, COLOR_DEFAULT, 0), \
LINE(MAIN_DELIM, "", COLOR_MAGENTA, COLOR_DEFAULT, 0), \
LINE(MAIN_TAG, "", COLOR_MAGENTA, COLOR_DEFAULT, A_BOLD), \
-LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD),
+LINE(MAIN_REF, "", COLOR_CYAN, COLOR_DEFAULT, A_BOLD), \
+
+
+/*
+ * Line-oriented content detection.
+ */
enum line_type {
#define LINE(type, line, fg, bg, attr) \
};
struct line_info {
- char *line; /* The start of line to match. */
+ const char *name; /* Option name. */
+ int namelen; /* Size of option name. */
+ 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. */
};
static struct line_info line_info[] = {
#define LINE(type, line, fg, bg, attr) \
- { (line), STRING_SIZE(line), (fg), (bg), (attr) }
+ { #type, STRING_SIZE(#type), (line), STRING_SIZE(line), (fg), (bg), (attr) }
LINE_INFO
#undef LINE
};
return COLOR_PAIR(type) | line_info[type].attr;
}
+static struct line_info *
+get_line_info(char *name, int namelen)
+{
+ enum line_type type;
+ int i;
+
+ /* Diff-Header -> DIFF_HEADER */
+ for (i = 0; i < namelen; i++) {
+ if (name[i] == '-')
+ name[i] = '_';
+ else if (name[i] == '.')
+ name[i] = '_';
+ }
+
+ for (type = 0; type < ARRAY_SIZE(line_info); type++)
+ if (namelen == line_info[type].namelen &&
+ !strncasecmp(line_info[type].name, name, namelen))
+ return &line_info[type];
+
+ return NULL;
+}
+
static void
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-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 ."
+/*
+ * User config file handling.
+ */
-/**
- * [[view-commands]]
- * View 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 set_color(color, name, namelen) \
+ set_from_int_map(color_map, ARRAY_SIZE(color_map), color, name, namelen)
-#define TIG_DIFF_CMD \
- "git show --patch-with-stat --find-copies-harder -B -C %s"
+#define set_attribute(attr, name, namelen) \
+ set_from_int_map(attr_map, ARRAY_SIZE(attr_map), attr, name, namelen)
-#define TIG_LOG_CMD \
- "git log --cc --stat -n100 %s"
+static int config_lineno;
+static bool config_errors;
+static char *config_msg;
-#define TIG_MAIN_CMD \
- "git log --topo-order --stat --pretty=raw %s"
+static int
+set_option(char *opt, int optlen, char *value, int valuelen)
+{
+ /* Reads: "color" object fgcolor bgcolor [attr] */
+ if (!strcmp(opt, "color")) {
+ struct line_info *info;
+
+ value = chomp_string(value);
+ valuelen = strcspn(value, " \t");
+ info = get_line_info(value, valuelen);
+ if (!info) {
+ config_msg = "Unknown color name";
+ return ERR;
+ }
-/* ... silently ignore that the following are also exported. */
+ value = chomp_string(value + valuelen);
+ valuelen = strcspn(value, " \t");
+ if (set_color(&info->fg, value, valuelen) == ERR) {
+ config_msg = "Unknown color";
+ return ERR;
+ }
-#define TIG_HELP_CMD \
- "man tig 2> /dev/null"
+ value = chomp_string(value + valuelen);
+ valuelen = strcspn(value, " \t");
+ if (set_color(&info->bg, value, valuelen) == ERR) {
+ config_msg = "Unknown color";
+ return ERR;
+ }
+
+ value = chomp_string(value + valuelen);
+ if (*value &&
+ set_attribute(&info->attr, value, strlen(value)) == ERR) {
+ config_msg = "Unknown attribute";
+ return ERR;
+ }
+
+ return OK;
+ }
+
+ return ERR;
+}
+
+static int
+read_option(char *opt, int optlen, char *value, int valuelen)
+{
+ config_lineno++;
+ config_msg = "Internal error";
+
+ optlen = strcspn(opt, "#;");
+ if (optlen == 0) {
+ /* The whole line is a commend or empty. */
+ return OK;
+
+ } else if (opt[optlen] != 0) {
+ /* Part of the option name is a comment, so the value part
+ * should be ignored. */
+ valuelen = 0;
+ opt[optlen] = value[valuelen] = 0;
+ } else {
+ /* Else look for comment endings in the value. */
+ valuelen = strcspn(value, "#;");
+ value[valuelen] = 0;
+ }
+
+ if (set_option(opt, optlen, value, valuelen) == ERR) {
+ fprintf(stderr, "Error on line %d, near '%.*s' option: %s\n",
+ config_lineno, optlen, opt, config_msg);
+ config_errors = TRUE;
+ }
+
+ /* Always keep going if errors are encountered. */
+ return OK;
+}
+
+static int
+load_options(void)
+{
+ char *home = getenv("HOME");
+ char buf[1024];
+ FILE *file;
+
+ config_lineno = 0;
+ config_errors = FALSE;
+
+ if (!home ||
+ snprintf(buf, sizeof(buf), "%s/.tigrc", home) >= sizeof(buf))
+ return ERR;
+
+ /* It's ok that the file doesn't exist. */
+ file = fopen(buf, "r");
+ if (!file)
+ return OK;
+
+ if (read_properties(file, " \t", read_option) == ERR ||
+ config_errors == TRUE)
+ fprintf(stderr, "Errors while loading %s.\n", buf);
+
+ return OK;
+}
-#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'.
+ * If you are in the log view and press 'Enter' when the current line is a
+ * commit line, such as:
*
- * 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.
+ * commit 4d55caff4cc89335192f3e566004b4ceef572521
*
- * 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.
+ * 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;
+
+/* 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++)
+
+#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 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} */
- 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;
- /* 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 */
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 */
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;
-static char ref_head[SIZEOF_REF] = "HEAD";
-static 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)
assert(0 <= lineno && lineno < view->height);
for (; lineno < view->height; lineno++) {
- if (!view->ops->draw(view, lineno))
+ if (!draw_view_line(view, lineno))
break;
}
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.
+ * 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)
+{
+ 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)
{
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. */
if (!view->win) {
- view->win = newwin(view->height + 1, 0, offset, 0);
+ view->win = newwin(view->height, 0, offset, 0);
if (!view->win)
die("Failed to create %s view", view->name);
die("Failed to create title window");
} else {
- wresize(view->win, view->height + 1, view->width);
+ 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;
}
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] %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) {
- wprintw(view->title, " - %s %d of %d (%d%%)",
- view->ops->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);
}
/*
/* 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;
wscrl(view->win, lines);
for (; line < end; line++) {
- if (!view->ops->draw(view, line))
+ if (!draw_view_line(view, line))
break;
}
}
/* 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) {
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("");
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;
break;
case REQ_MOVE_UP:
- case REQ_MOVE_UP_ENTER:
steps = -1;
break;
case REQ_MOVE_DOWN:
- case REQ_MOVE_DOWN_ENTER:
steps = 1;
break;
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 */
}
}
- 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);
* 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);
* 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))
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;
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. */
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)
goto end;
} else if (feof(view->pipe)) {
- 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
goto end;
}
- report("Loaded %d lines in %ld second%s", view->lines, secs,
- secs == 1 ? "" : "s");
+ report("");
goto end;
}
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("");
- return;
- }
- }
+ int nviews = displayed_views();
+ struct view *base_view = display[0];
if (view == prev && nviews == 1 && !reload) {
report("Already in %s view", view->name);
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. */
/* 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. */
- if (!backgrounded)
+ 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);
if (view == VIEW(REQ_VIEW_HELP))
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:
open_view(view, request, OPEN_DEFAULT);
break;
- case REQ_MOVE_UP_ENTER:
- case REQ_MOVE_DOWN_ENTER:
- move_view(view, request);
+ 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:
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) {
}
case REQ_TOGGLE_LINE_NUMBERS:
opt_line_number = !opt_line_number;
- redraw_view(view);
- update_view_title(view);
+ redraw_display();
break;
case REQ_PROMPT:
break;
case REQ_STOP_LOADING:
- foreach_view (view, i) {
+ for (i = 0; i < ARRAY_SIZE(views); i++) {
+ view = &views[i];
if (view->pipe)
- report("Stopped loaded the %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;
/*
- * 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);
}
attr = get_line_attr(type);
wattrset(view->win, attr);
- linelen = strlen(line);
-
if (opt_line_number || opt_tab_size < TABSIZE) {
static char spaces[] = " ";
int col_offset = 0, col = 0;
col_offset = view->digits + 2;
}
- while (line && col_offset + col < view->width) {
+ while (text && col_offset + col < view->width) {
int cols_max = view->width - col_offset - col;
- char *text = line;
+ char *pos = text;
int cols;
- if (*line == '\t') {
+ if (*text == '\t') {
+ text++;
assert(sizeof(spaces) > TABSIZE);
- line++;
- text = spaces;
+ pos = spaces;
cols = opt_tab_size - (col % opt_tab_size);
} else {
- line = strchr(line, '\t');
- cols = line ? line - text : strlen(text);
+ text = strchr(text, '\t');
+ cols = line ? text - pos : strlen(pos);
}
- waddnstr(view->win, text, MIN(cols, cols_max));
+ waddnstr(view->win, pos, MIN(cols, cols_max));
col += cols;
}
} else {
int col = 0, pos = 0;
- for (; pos < linelen && col < view->width; pos++, col++)
- if (line[pos] == '\t')
+ for (; pos < textlen && col < view->width; pos++, col++)
+ if (text[pos] == '\t')
col += TABSIZE - (col % TABSIZE) - 1;
- waddnstr(view->win, line, pos);
+ 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)
{
/* Compress empty lines in the help view. */
if (view == VIEW(REQ_VIEW_HELP) &&
- !*line &&
- view->lines &&
- !*((char *) view->line[view->lines - 1]))
+ !*line && prev && !*((char *) prev->data))
return TRUE;
- view->line[view->lines] = strdup(line);
- if (!view->line[view->lines])
+ 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) {
- if (view == VIEW(REQ_VIEW_LOG))
- open_view(view, REQ_VIEW_DIFF, OPEN_SPLIT | OPEN_BACKGROUNDED);
- else
- 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 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 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;
if (type != LINE_CURSOR)
wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR));
- if (strlen(commit->author) > 19) {
- waddnstr(view->win, commit->author, 18);
+ 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, '~');
waddstr(view->win, commit->author);
}
- col += 20;
+ col += AUTHOR_COLS;
if (type != LINE_CURSOR)
wattrset(view->win, A_NORMAL);
/* 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;
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;
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 */
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;
}
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;
}
* 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.
- * Tab::
- * Switch to next view.
**/
{ 'm', REQ_VIEW_MAIN },
{ 'd', REQ_VIEW_DIFF },
{ '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
* ~~~~~~~~~~~~~~~~~
- * Up::
+ * j::
* Move cursor one line up.
- * Down::
- * Move cursor one line down.
* k::
- * Move cursor one line up and enter. When used in the main view
- * this will always show the diff of the current commit in the
- * split diff view.
- * j::
- * Move cursor one line down and enter.
+ * 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.
**/
- { KEY_UP, REQ_MOVE_UP },
- { KEY_DOWN, REQ_MOVE_DOWN },
- { 'k', REQ_MOVE_UP_ENTER },
- { 'j', REQ_MOVE_DOWN_ENTER },
+ { '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
/**
* Misc
* ~~~~
- * q::
- * Quit
+ * Q::
+ * Quit.
* r::
* Redraw screen.
* z::
*
* :log -p
**/
- { 'q', REQ_QUIT },
+ { 'Q', REQ_QUIT },
{ 'z', REQ_STOP_LOADING },
{ 'v', REQ_SHOW_VERSION },
{ 'r', REQ_SCREEN_REDRAW },
/*
+ * Unicode / UTF-8 handling
+ *
+ * NOTE: Much of the following code for dealing with unicode is derived from
+ * ELinks' UTF-8 code developed by Scrool <scroolik@gmail.com>. 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;
}
update_view_title(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) {
- wmove(view->win, view->lineno - view->offset, view->width - 1);
- wrefresh(view->win);
- }
+ update_display_cursor();
}
/* Controls when nodelay should be in effect when polling user input. */
static struct ref *refs;
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++;
+ }
+
+ if (ref_list)
+ id_refs[id_refs_size++] = ref_list;
+
+ return ref_list;
+}
+
+static int
+read_ref(char *id, int idlen, char *name, int namelen)
+{
+ 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 (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
+ if (!tag_commit)
+ return OK;
+ name += STRING_SIZE("refs/tags/");
+ tag = TRUE;
+
+ } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
+ name += STRING_SIZE("refs/heads/");
+
+ } else if (!strcmp(name, "HEAD")) {
+ return OK;
}
- return id_refs;
+ refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
+ if (!refs)
+ return ERR;
+
+ ref = &refs[refs_size++];
+ ref->name = strdup(name);
+ if (!ref->name)
+ return ERR;
+
+ ref->tag = tag;
+ string_copy(ref->id, id);
+
+ return OK;
}
static int
load_refs(void)
{
- char *cmd_env = getenv("TIG_LS_REMOTE");
- char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
- FILE *pipe = popen(cmd, "r");
- char buffer[BUFSIZ];
- char *line;
+ const char *cmd_env = getenv("TIG_LS_REMOTE");
+ const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE;
- if (!pipe)
- return ERR;
+ return read_properties(popen(cmd, "r"), "\t", read_ref);
+}
- while ((line = fgets(buffer, sizeof(buffer), pipe))) {
- char *name = strchr(line, '\t');
- struct ref *ref;
- int namelen;
- bool tag = FALSE;
- bool tag_commit = FALSE;
+static int
+read_repo_config_option(char *name, int namelen, char *value, int valuelen)
+{
+ if (!strcmp(name, "i18n.commitencoding")) {
+ string_copy(opt_encoding, value);
+ }
- if (!name)
- continue;
+ return OK;
+}
- *name++ = 0;
- namelen = strlen(name) - 1;
+static int
+load_repo_config(void)
+{
+ return read_properties(popen("git repo-config --list", "r"),
+ "=", read_repo_config_option);
+}
- /* 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;
+static int
+read_properties(FILE *pipe, const char *separators,
+ int (*read_property)(char *, int, char *, int))
+{
+ char buffer[BUFSIZ];
+ char *name;
+ int state = OK;
- if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) {
- if (!tag_commit)
- continue;
- name += STRING_SIZE("refs/tags/");
- tag = TRUE;
+ if (!pipe)
+ return ERR;
- } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) {
- name += STRING_SIZE("refs/heads/");
+ while (state == OK && (name = fgets(buffer, sizeof(buffer), pipe))) {
+ char *value;
+ size_t namelen;
+ size_t valuelen;
- } else if (!strcmp(name, "HEAD")) {
- continue;
- }
+ name = chomp_string(name);
+ namelen = strcspn(name, separators);
- refs = realloc(refs, sizeof(*refs) * (refs_size + 1));
- if (!refs)
- return ERR;
+ if (name[namelen]) {
+ name[namelen] = 0;
+ value = chomp_string(name + namelen + 1);
+ valuelen = strlen(value);
- ref = &refs[refs_size++];
- ref->tag = tag;
- ref->name = strdup(name);
- if (!ref->name)
- return ERR;
+ } else {
+ value = "";
+ valuelen = 0;
+ }
- string_copy(ref->id, line);
+ state = read_property(name, namelen, value, valuelen);
}
- if (ferror(pipe))
- return ERR;
+ 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! */
exit(0);
}
-static void die(const char *err, ...)
+static void __NORETURN
+die(const char *err, ...)
{
va_list args;
signal(SIGINT, quit);
+ if (load_options() == ERR)
+ die("Failed to load user config.");
+
+ /* Load the repo config file so options can be overwritten from
+ * the command line. */
+ if (load_repo_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);
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();
/**
* [[refspec]]
- * Specifying revisions
- * --------------------
+ * Revision specification
+ * ----------------------
* This section describes various ways to specify what revisions to display
- * or otherwise limit the view to. Note, that tig(1) does not itself parse
- * the described revision options.
+ * 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.
*
- * File history
- * ~~~~~~~~~~~~
+ * 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
+ * $ 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:
*
- * $ tag log -- master
+ * $ 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
* 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. For example, by configuring the environment
- * variables described in the <<view-commands, "View commands">> section.
+ * If you are only interested in changed that happened between two dates
+ * you can use:
*
- * Ranges
- * ~~~~~~
+ * $ 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:
*
* ~~~~~~~~~~~~~~~~~~~~~~~~
* 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.
*
- * BUGS
- * ----
- * Known bugs and problems:
+ * 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."
*
- * - 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.
+ * $ tig -- --since=1.month -n20 -- Documentation/
*
- * TODO
- * ----
- * Features that should be explored.
+ * 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:
*
- * - Searching.
+ * $ tig -- --all --since=1.week -- Makefile
*
- * - Locale support.
+ * include::BUGS[]
*
* COPYRIGHT
* ---------
- * Copyright (c) Jonas Fonseca <fonseca@diku.dk>, 2006
+ * 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
*
* 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)
**/
~mdw / tig / blobdiff