help.con commit Merge branch 'bc/maint-diff-hunk-header-fix' into bc/master-diff-hunk-header-fix (4be4680)
   1#include "cache.h"
   2#include "builtin.h"
   3#include "exec_cmd.h"
   4#include "help.h"
   5
   6/* most GUI terminals set COLUMNS (although some don't export it) */
   7static int term_columns(void)
   8{
   9        char *col_string = getenv("COLUMNS");
  10        int n_cols;
  11
  12        if (col_string && (n_cols = atoi(col_string)) > 0)
  13                return n_cols;
  14
  15#ifdef TIOCGWINSZ
  16        {
  17                struct winsize ws;
  18                if (!ioctl(1, TIOCGWINSZ, &ws)) {
  19                        if (ws.ws_col)
  20                                return ws.ws_col;
  21                }
  22        }
  23#endif
  24
  25        return 80;
  26}
  27
  28void add_cmdname(struct cmdnames *cmds, const char *name, int len)
  29{
  30        struct cmdname *ent = xmalloc(sizeof(*ent) + len + 1);
  31
  32        ent->len = len;
  33        memcpy(ent->name, name, len);
  34        ent->name[len] = 0;
  35
  36        ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
  37        cmds->names[cmds->cnt++] = ent;
  38}
  39
  40static int cmdname_compare(const void *a_, const void *b_)
  41{
  42        struct cmdname *a = *(struct cmdname **)a_;
  43        struct cmdname *b = *(struct cmdname **)b_;
  44        return strcmp(a->name, b->name);
  45}
  46
  47static void uniq(struct cmdnames *cmds)
  48{
  49        int i, j;
  50
  51        if (!cmds->cnt)
  52                return;
  53
  54        for (i = j = 1; i < cmds->cnt; i++)
  55                if (strcmp(cmds->names[i]->name, cmds->names[i-1]->name))
  56                        cmds->names[j++] = cmds->names[i];
  57
  58        cmds->cnt = j;
  59}
  60
  61void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
  62{
  63        int ci, cj, ei;
  64        int cmp;
  65
  66        ci = cj = ei = 0;
  67        while (ci < cmds->cnt && ei < excludes->cnt) {
  68                cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
  69                if (cmp < 0)
  70                        cmds->names[cj++] = cmds->names[ci++];
  71                else if (cmp == 0)
  72                        ci++, ei++;
  73                else if (cmp > 0)
  74                        ei++;
  75        }
  76
  77        while (ci < cmds->cnt)
  78                cmds->names[cj++] = cmds->names[ci++];
  79
  80        cmds->cnt = cj;
  81}
  82
  83static void pretty_print_string_list(struct cmdnames *cmds, int longest)
  84{
  85        int cols = 1, rows;
  86        int space = longest + 1; /* min 1 SP between words */
  87        int max_cols = term_columns() - 1; /* don't print *on* the edge */
  88        int i, j;
  89
  90        if (space < max_cols)
  91                cols = max_cols / space;
  92        rows = (cmds->cnt + cols - 1) / cols;
  93
  94        for (i = 0; i < rows; i++) {
  95                printf("  ");
  96
  97                for (j = 0; j < cols; j++) {
  98                        int n = j * rows + i;
  99                        int size = space;
 100                        if (n >= cmds->cnt)
 101                                break;
 102                        if (j == cols-1 || n + rows >= cmds->cnt)
 103                                size = 1;
 104                        printf("%-*s", size, cmds->names[n]->name);
 105                }
 106                putchar('\n');
 107        }
 108}
 109
 110static int is_executable(const char *name)
 111{
 112        struct stat st;
 113
 114        if (stat(name, &st) || /* stat, not lstat */
 115            !S_ISREG(st.st_mode))
 116                return 0;
 117
 118#ifdef __MINGW32__
 119        /* cannot trust the executable bit, peek into the file instead */
 120        char buf[3] = { 0 };
 121        int n;
 122        int fd = open(name, O_RDONLY);
 123        st.st_mode &= ~S_IXUSR;
 124        if (fd >= 0) {
 125                n = read(fd, buf, 2);
 126                if (n == 2)
 127                        /* DOS executables start with "MZ" */
 128                        if (!strcmp(buf, "#!") || !strcmp(buf, "MZ"))
 129                                st.st_mode |= S_IXUSR;
 130                close(fd);
 131        }
 132#endif
 133        return st.st_mode & S_IXUSR;
 134}
 135
 136static void list_commands_in_dir(struct cmdnames *cmds,
 137                                         const char *path,
 138                                         const char *prefix)
 139{
 140        int prefix_len;
 141        DIR *dir = opendir(path);
 142        struct dirent *de;
 143        struct strbuf buf = STRBUF_INIT;
 144        int len;
 145
 146        if (!dir)
 147                return;
 148        if (!prefix)
 149                prefix = "git-";
 150        prefix_len = strlen(prefix);
 151
 152        strbuf_addf(&buf, "%s/", path);
 153        len = buf.len;
 154
 155        while ((de = readdir(dir)) != NULL) {
 156                int entlen;
 157
 158                if (prefixcmp(de->d_name, prefix))
 159                        continue;
 160
 161                strbuf_setlen(&buf, len);
 162                strbuf_addstr(&buf, de->d_name);
 163                if (!is_executable(buf.buf))
 164                        continue;
 165
 166                entlen = strlen(de->d_name) - prefix_len;
 167                if (has_extension(de->d_name, ".exe"))
 168                        entlen -= 4;
 169
 170                add_cmdname(cmds, de->d_name + prefix_len, entlen);
 171        }
 172        closedir(dir);
 173        strbuf_release(&buf);
 174}
 175
 176void load_command_list(const char *prefix,
 177                struct cmdnames *main_cmds,
 178                struct cmdnames *other_cmds)
 179{
 180        const char *env_path = getenv("PATH");
 181        const char *exec_path = git_exec_path();
 182
 183        if (exec_path) {
 184                list_commands_in_dir(main_cmds, exec_path, prefix);
 185                qsort(main_cmds->names, main_cmds->cnt,
 186                      sizeof(*main_cmds->names), cmdname_compare);
 187                uniq(main_cmds);
 188        }
 189
 190        if (env_path) {
 191                char *paths, *path, *colon;
 192                path = paths = xstrdup(env_path);
 193                while (1) {
 194                        if ((colon = strchr(path, PATH_SEP)))
 195                                *colon = 0;
 196
 197                        list_commands_in_dir(other_cmds, path, prefix);
 198
 199                        if (!colon)
 200                                break;
 201                        path = colon + 1;
 202                }
 203                free(paths);
 204
 205                qsort(other_cmds->names, other_cmds->cnt,
 206                      sizeof(*other_cmds->names), cmdname_compare);
 207                uniq(other_cmds);
 208        }
 209        exclude_cmds(other_cmds, main_cmds);
 210}
 211
 212void list_commands(const char *title, struct cmdnames *main_cmds,
 213                   struct cmdnames *other_cmds)
 214{
 215        int i, longest = 0;
 216
 217        for (i = 0; i < main_cmds->cnt; i++)
 218                if (longest < main_cmds->names[i]->len)
 219                        longest = main_cmds->names[i]->len;
 220        for (i = 0; i < other_cmds->cnt; i++)
 221                if (longest < other_cmds->names[i]->len)
 222                        longest = other_cmds->names[i]->len;
 223
 224        if (main_cmds->cnt) {
 225                const char *exec_path = git_exec_path();
 226                printf("available %s in '%s'\n", title, exec_path);
 227                printf("----------------");
 228                mput_char('-', strlen(title) + strlen(exec_path));
 229                putchar('\n');
 230                pretty_print_string_list(main_cmds, longest);
 231                putchar('\n');
 232        }
 233
 234        if (other_cmds->cnt) {
 235                printf("%s available from elsewhere on your $PATH\n", title);
 236                printf("---------------------------------------");
 237                mput_char('-', strlen(title));
 238                putchar('\n');
 239                pretty_print_string_list(other_cmds, longest);
 240                putchar('\n');
 241        }
 242}
 243
 244int is_in_cmdlist(struct cmdnames *c, const char *s)
 245{
 246        int i;
 247        for (i = 0; i < c->cnt; i++)
 248                if (!strcmp(s, c->names[i]->name))
 249                        return 1;
 250        return 0;
 251}
 252
 253void help_unknown_cmd(const char *cmd)
 254{
 255        fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
 256        exit(1);
 257}
 258
 259int cmd_version(int argc, const char **argv, const char *prefix)
 260{
 261        printf("git version %s\n", git_version_string);
 262        return 0;
 263}