X-Git-Url: https://git.distorted.org.uk/~mdw/tig/blobdiff_plain/4670cf89d55d2520d4e66aacbea38e20296e672f..5976048600791033f3f9dc559fc2ee0d4e43bf1e:/tig.c diff --git a/tig.c b/tig.c index cdb20ae..c323cf8 100644 --- a/tig.c +++ b/tig.c @@ -1,8 +1,9 @@ /* Copyright (c) 2006 Jonas Fonseca * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License version 2 as - * published by the Free Software Foundation. + * 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 @@ -63,6 +64,7 @@ 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); @@ -147,6 +149,29 @@ struct ref { 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 @@ -164,6 +189,21 @@ string_ncopy(char *dst, const char *src, int dstlen) #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 * @@ -225,7 +265,7 @@ VERSION " (" __DATE__ ")\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" -" -t[N], --tab-size[=N] Set number of spaces for tab expansion\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"; @@ -236,7 +276,8 @@ 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] = "UTF-8"; +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. */ @@ -290,14 +331,14 @@ parse_options(int argc, char *argv[]) } /** - * -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")] == '=') { @@ -376,45 +417,12 @@ parse_options(int argc, char *argv[]) } 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 <> 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. */ @@ -435,6 +443,9 @@ parse_options(int argc, char *argv[]) } + if (*opt_encoding && strcasecmp(opt_encoding, "UTF-8")) + opt_utf8 = FALSE; + return TRUE; } @@ -442,23 +453,6 @@ parse_options(int argc, char *argv[]) /** * 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). @@ -468,20 +462,6 @@ parse_options(int argc, char *argv[]) "git ls-remote . 2>/dev/null" /** - * [[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. @@ -515,42 +495,68 @@ parse_options(int argc, char *argv[]) "" -/* - * Line-oriented content detection. - */ +/** + * 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), \ @@ -561,7 +567,12 @@ LINE(MAIN_AUTHOR, "", 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) \ @@ -571,6 +582,8 @@ enum line_type { }; struct line_info { + 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. */ @@ -578,7 +591,7 @@ struct line_info { 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 }; @@ -605,6 +618,28 @@ get_line_attr(enum line_type type) 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) { @@ -634,23 +669,124 @@ struct line { }; -/** +/* + * User config file handling. + */ + +#define set_color(color, name, namelen) \ + set_from_int_map(color_map, ARRAY_SIZE(color_map), color, name, namelen) + +#define set_attribute(attr, name, namelen) \ + set_from_int_map(attr_map, ARRAY_SIZE(attr_map), attr, name, namelen) + +static int config_lineno; +static bool config_errors; +static char *config_msg; + +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; + } + + value = chomp_string(value + valuelen); + valuelen = strcspn(value, " \t"); + if (set_color(&info->fg, value, valuelen) == ERR) { + config_msg = "Unknown color"; + return ERR; + } + + 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; +} + + +/* * 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; @@ -664,18 +800,7 @@ static unsigned int current_view; #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"; @@ -733,35 +858,6 @@ static struct view_ops main_ops; #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), @@ -805,17 +901,6 @@ redraw_view(struct view *view) } -/** - * Title windows - * ~~~~~~~~~~~~~ - * Each view has a title window which shows the name of the view, current - * commit ID if available, and where the view is positioned: - * - * [main] c622eefaa485995320bc743431bae0d497b1d875 - commit 1 of 61 (1%) - * - * By default, the title of the current view is highlighted using bold font. - **/ - static void update_view_title(struct view *view) { @@ -852,7 +937,7 @@ update_view_title(struct view *view) wprintw(view->title, " %lds", secs); } - + wmove(view->title, 0, view->width - 1); wrefresh(view->title); } @@ -901,7 +986,6 @@ resize_display(void) 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; @@ -920,6 +1004,20 @@ redraw_display(void) } } +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) { + wmove(view->win, view->lineno - view->offset, view->width - 1); + wrefresh(view->win); + } +} /* * Navigation @@ -1313,9 +1411,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)); @@ -1339,17 +1437,15 @@ open_view(struct view *prev, enum request request, enum open_flags flags) } if (prev && view != prev) { - /* Continue loading split views in the background. */ - if (!split) - end_update(prev); - else if (!backgrounded) + if (split && !backgrounded) { /* "Blur" the previous view. */ update_view_title(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); @@ -1455,9 +1551,10 @@ view_driver(struct view *view, enum request request) 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; @@ -1478,11 +1575,15 @@ view_driver(struct view *view, enum request request) return TRUE; case REQ_VIEW_CLOSE: - if (view->parent) { + /* 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 = NULL; + view->parent = view; resize_display(); redraw_display(); break; @@ -1616,8 +1717,8 @@ pager_enter(struct view *view, struct line *line) scroll_view(view, REQ_SCROLL_LINE_DOWN); /* FIXME: A minor workaround. Scrolling the view will call report("") - * but if we are scolling a non-current view this won't properly update - * the view title. */ + * but if we are scrolling a non-current view this won't properly + * update the view title. */ if (split) update_view_title(view); @@ -1653,7 +1754,7 @@ main_draw(struct view *view, struct line *line, unsigned int lineno) int col = 0; size_t timelen; size_t authorlen; - int trimmed; + int trimmed = 1; if (!*commit->author) return FALSE; @@ -1681,8 +1782,15 @@ main_draw(struct view *view, struct line *line, unsigned int lineno) if (type != LINE_CURSOR) wattrset(view->win, get_line_attr(LINE_MAIN_AUTHOR)); - /* FIXME: Make this optional, and add i18n.commitEncoding support. */ - authorlen = utf8_length(commit->author, AUTHOR_COLS - 2, &col, &trimmed); + 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); @@ -1844,11 +1952,9 @@ static struct view_ops main_ops = { }; -/** - * KEYS - * ---- - * Below the default key bindings are shown. - **/ +/* + * Keys + */ struct keymap { int alias; @@ -1856,74 +1962,21 @@ struct keymap { }; 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 }, - /** - * 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 }, @@ -1934,44 +1987,13 @@ static struct keymap keymap[] = { { '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 }, @@ -2195,15 +2217,7 @@ report(const char *msg, ...) } 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. */ @@ -2315,111 +2329,116 @@ get_refs(char *id) } static int -load_refs(void) +read_ref(char *id, int idlen, char *name, int namelen) { - const char *cmd_env = getenv("TIG_LS_REMOTE"); - const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE; - FILE *pipe = popen(cmd, "r"); - char buffer[BUFSIZ]; - char *line; - - if (!pipe) - return ERR; + 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; + } - while ((line = fgets(buffer, sizeof(buffer), pipe))) { - char *name = strchr(line, '\t'); - struct ref *ref; - int namelen; - bool tag = FALSE; - bool tag_commit = FALSE; + if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) { + if (!tag_commit) + return OK; + name += STRING_SIZE("refs/tags/"); + tag = TRUE; - if (!name) - continue; + } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) { + name += STRING_SIZE("refs/heads/"); - *name++ = 0; - namelen = strlen(name) - 1; + } else if (!strcmp(name, "HEAD")) { + return OK; + } - /* 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; + refs = realloc(refs, sizeof(*refs) * (refs_size + 1)); + if (!refs) + return ERR; - if (!strncmp(name, "refs/tags/", STRING_SIZE("refs/tags/"))) { - if (!tag_commit) - continue; - name += STRING_SIZE("refs/tags/"); - tag = TRUE; + ref = &refs[refs_size++]; + ref->name = strdup(name); + if (!ref->name) + return ERR; - } else if (!strncmp(name, "refs/heads/", STRING_SIZE("refs/heads/"))) { - name += STRING_SIZE("refs/heads/"); + ref->tag = tag; + string_copy(ref->id, id); - } else if (!strcmp(name, "HEAD")) { - continue; - } + return OK; +} - refs = realloc(refs, sizeof(*refs) * (refs_size + 1)); - if (!refs) - return ERR; +static int +load_refs(void) +{ + const char *cmd_env = getenv("TIG_LS_REMOTE"); + const char *cmd = cmd_env && *cmd_env ? cmd_env : TIG_LS_REMOTE; - ref = &refs[refs_size++]; - ref->tag = tag; - ref->name = strdup(name); - if (!ref->name) - return ERR; + return read_properties(popen(cmd, "r"), "\t", read_ref); +} - string_copy(ref->id, line); +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 (ferror(pipe)) - return ERR; - - pclose(pipe); - return OK; } static int -load_config(void) +load_repo_config(void) +{ + return read_properties(popen("git repo-config --list", "r"), + "=", read_repo_config_option); +} + +static int +read_properties(FILE *pipe, const char *separators, + int (*read_property)(char *, int, char *, int)) { - FILE *pipe = popen("git repo-config --list", "r"); char buffer[BUFSIZ]; char *name; + int state = OK; if (!pipe) return ERR; - while ((name = fgets(buffer, sizeof(buffer), pipe))) { - char *value = strchr(name, '='); - int valuelen, namelen; + while (state == OK && (name = fgets(buffer, sizeof(buffer), pipe))) { + char *value; + size_t namelen; + size_t valuelen; - /* No boolean options, yet */ - if (!value) - continue; - - namelen = value - name; + name = chomp_string(name); + namelen = strcspn(name, separators); - *value++ = 0; - valuelen = strlen(value); - if (valuelen > 0) - value[valuelen - 1] = 0; + if (name[namelen]) { + name[namelen] = 0; + value = chomp_string(name + namelen + 1); + valuelen = strlen(value); - if (!strcmp(name, "i18n.commitencoding")) { - string_copy(opt_encoding, value); + } else { + value = ""; + valuelen = 0; } + + 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 */ @@ -2464,6 +2483,14 @@ main(int argc, char *argv[]) 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; @@ -2474,9 +2501,6 @@ main(int argc, char *argv[]) if (refs_size == 0 && opt_request != REQ_VIEW_PAGER) die("Not a git repository"); - if (load_config() == ERR) - die("Failed to load repo config."); - for (i = 0; i < ARRAY_SIZE(views) && (view = &views[i]); i++) view->cmd_env = getenv(view->cmd_env); @@ -2509,7 +2533,9 @@ main(int argc, char *argv[]) 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(); @@ -2540,120 +2566,7 @@ main(int argc, char *argv[]) } /** - * [[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 <> 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. - * - * TODO - * ---- - * Features that should be explored. - * - * - Searching. - * - * - Locale support. + * include::BUGS[] * * COPYRIGHT * --------- @@ -2670,8 +2583,12 @@ main(int argc, char *argv[]) * - link:http://www.kernel.org/pub/software/scm/cogito/docs/[cogito(7)] * * Other git repository browsers: -* + * * - gitk(1) * - qgit(1) * - gitview(1) + * + * Sites: + * + * include::SITES[] **/