Correct error checking
[tig] / tig.c
diff --git a/tig.c b/tig.c
index e7deb2e..851503f 100644 (file)
--- a/tig.c
+++ b/tig.c
@@ -67,6 +67,7 @@ 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);
+static void load_help_page(void);
 
 #define ABS(x)         ((x) >= 0  ? (x) : -(x))
 #define MIN(x, y)      ((x) < (y) ? (x) :  (y))
@@ -80,8 +81,6 @@ static size_t utf8_length(const char *string, size_t max_width, int *coloffset,
 /* 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 ")
@@ -101,45 +100,6 @@ static size_t utf8_length(const char *string, size_t max_width, int *coloffset,
 #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 */
@@ -204,6 +164,27 @@ chomp_string(char *name)
        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
  *
@@ -246,6 +227,77 @@ sq_quote(char buf[SIZEOF_CMD], size_t bufsize, const char *src)
 }
 
 
+/*
+ * 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
  * -------
@@ -489,7 +541,7 @@ parse_options(int argc, char *argv[])
 /* ... silently ignore that the following are also exported. */
 
 #define TIG_HELP_CMD \
-       "man tig 2>/dev/null"
+       ""
 
 #define TIG_PAGER_CMD \
        ""
@@ -551,6 +603,7 @@ 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), \
+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), \
@@ -767,8 +820,7 @@ load_options(void)
        config_lineno = 0;
        config_errors = FALSE;
 
-       if (!home ||
-           snprintf(buf, sizeof(buf), "%s/.tigrc", home) >= sizeof(buf))
+       if (!home || !string_format(buf, "%s/.tigrc", home))
                return ERR;
 
        /* It's ok that the file doesn't exist. */
@@ -831,6 +883,7 @@ struct view {
        /* 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 */
@@ -844,7 +897,7 @@ struct view_ops {
        /* 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);
 };
@@ -1239,8 +1292,7 @@ begin_update(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;
        }
 
@@ -1278,12 +1330,24 @@ begin_update(struct view *view)
        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. */
@@ -1297,23 +1361,16 @@ update_view(struct view *view)
        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)
@@ -1354,20 +1411,6 @@ update_view(struct view *view)
                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;
        }
@@ -1411,9 +1454,9 @@ open_view(struct view *prev, enum request request, enum open_flags flags)
        }
 
        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));
@@ -1445,6 +1488,9 @@ open_view(struct view *prev, enum request request, enum open_flags flags)
                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. */
@@ -1452,10 +1498,7 @@ open_view(struct view *prev, enum request request, enum open_flags flags)
                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()
@@ -1540,7 +1583,7 @@ view_driver(struct view *view, enum request request)
                report("");
                break;
        }
-       case REQ_TOGGLE_LINE_NUMBERS:
+       case REQ_TOGGLE_LINENO:
                opt_line_number = !opt_line_number;
                redraw_display();
                break;
@@ -1681,21 +1724,59 @@ pager_draw(struct view *view, struct line *line, unsigned int lineno)
        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;
 }
 
@@ -1846,10 +1927,11 @@ main_draw(struct view *view, struct line *line, unsigned int lineno)
 
 /* 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:
@@ -1869,11 +1951,9 @@ main_read(struct view *view, struct line *prev, char *line)
                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;
@@ -1912,11 +1992,9 @@ main_read(struct view *view, struct line *prev, char *line)
                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;
@@ -1968,6 +2046,7 @@ static struct keymap keymap[] = {
        { 'l',          REQ_VIEW_LOG },
        { 'p',          REQ_VIEW_PAGER },
        { 'h',          REQ_VIEW_HELP },
+       { '?',          REQ_VIEW_HELP },
 
        /* View manipulation */
        { 'q',          REQ_VIEW_CLOSE },
@@ -1998,7 +2077,7 @@ static struct keymap keymap[] = {
        { '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. */
@@ -2020,6 +2099,120 @@ get_request(int key)
        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