diff --git a/API.md b/API.md new file mode 100644 index 0000000..df4da71 --- /dev/null +++ b/API.md @@ -0,0 +1,69 @@ +# BB's API +In `bb`, all interaction (more or less) occurs through binding keypresses +(and mouse events) to shell scripts. These shell scripts can perform external +actions (like moving files around) or internal actions (like changing the +directory `bb` is displaying). When a shell script runs, `bb` creates a +temporary file, and scripts may write commands to this file to modify `bb`'s +internal state. + +## Helper Functions +- `bb`: used for modifying `bb`'s internal state (see BB Commands). +- `ask`: get user input in a standardized and customizable way. The first + argument is a variable where the value is stored. The second argument is + a prompt. A third optional argument can provide a default value (may be + ignored). +- `ask1`: get a single character of user input. The first argument is a variable + where the input will be stored and the second argument is a prompt. +- `pause`: Display a "press any key to continue" message and wait for a keypress. +- `confirm`: Display a "Is this okay? [y/N]" prompt and exit with failure if + the user does not press 'y'. +- `spin`: Display a spinning icon while a slow command executes in the background. + (e.g. `spin sleep 5`). + +## Environment Variables +For startup commands and key bindings, the following values are provided as +environment variables: + +- `$@` (the list of arguments): the full paths of the selected files +- `$BBCURSOR`: the full path of the file under the cursor +- `$BBDOTFILES`: "1" if files beginning with "." are visible in bb, otherwise "" +- `$BB_DEPTH`: the number of `bb` instances deep (in case you want to run a + shell and have that shell print something special in the prompt) +- `$BBCMD`: a file to which `bb` commands can be written (used internally) + +## BB Internal State Commands +In order to modify bb's internal state, you can call `bb +cmd`, where "cmd" +is one of the following commands (or a unique prefix of one): + +- `.:[01]` Whether to show "." in each directory +- `..:[01]` Whether to show ".." in each directory +- `cd:` Navigate to +- `columns:` Change which columns are visible, and in what order +- `deselect:` Deselect +- `dotfiles:[01]` Whether dotfiles are visible +- `goto:` Move the cursor to (changing directory if needed) +- `interleave:[01]` Whether or not directories should be interleaved with files in the display +- `move:` Move the cursor a numeric amount +- `quit` Quit bb +- `refresh` Refresh the file listing +- `scroll:` Scroll the view a numeric amount +- `select:` Select +- `sort:([+-]method)+` Set sorting method (+: normal, -: reverse), additional methods act as tiebreaker +- `spread:` Spread the selection state at the cursor +- `toggle:` Toggle the selection status of + +For any of these commands (e.g. `+select`), an empty parameter followed by +additional arguments (e.g. `bb +select: ...`) is equivalent to +repeating the command with each argument (e.g. `bb +select: ++select: ...`). + +Note: for numeric-based commands (like scroll), the number can be either an +absolute value or a relative value (starting with `+` or `-`), and/or a percent +(ending with `%`). Scrolling and moving, `%` means percent of screen height, +and `%n` means percent of number of files (e.g. `+50%` means half a screen +height down, and `100%n` means the last file) + +Internally, `bb` will write the commands (NUL terminated) to a file whose path +is in`$BBCMD` and read the file when `bb` resumes. These commands can also be +passed to bb at startup, and will run immediately. E.g. `bb '+col:n' +'+sort:+r' .` will launch `bb` only showing the name column, randomly sorted. diff --git a/Makefile b/Makefile index e3ce213..2d46459 100644 --- a/Makefile +++ b/Makefile @@ -22,21 +22,21 @@ ifeq (, $(PICKER)) PICKER=$(shell sh -c "(which fzy >/dev/null 2>/dev/null && echo 'fzy') || (which fzf >/dev/null 2>/dev/null && echo 'fzf') || (which pick >/dev/null 2>/dev/null && echo 'pick') || (which ask >/dev/null 2>/dev/null && echo 'ask')") endif ifneq (, $(PICKER)) - PICKER_FLAG=-D"PICK(prompt)=\"$(PICKER)\"" + PICKER_FLAG=-D"PICK=\"$(PICKER) --prompt=\\\"$$1\\\"\"" ifeq ($(shell which $(PICKER)),$(shell which fzy 2>/dev/null || echo '')) - PICKER_FLAG=-D'PICK(prompt)="{ printf \"\\033[3A\" >/dev/tty; fzy --lines=3 --prompt=\"\033[1m" prompt "\033[0m\"; }"' + PICKER_FLAG=-D'PICK="printf \"\\033[3A\" >/dev/tty; fzy --lines=3 --prompt=\"\033[1m$$1\033[0m\""' endif ifeq ($(shell which $(PICKER)),$(shell which fzf 2>/dev/null || echo '')) - PICKER_FLAG=-D'PICK(prompt)="{ printf \"\\033[3A\" >/dev/tty; fzf --height=4 --prompt=\"" prompt "\"; }"' + PICKER_FLAG=-D'PICK="printf \"\\033[3A\" >/dev/tty; fzf --height=4 --prompt=\"$$1\""' endif ifeq ($(shell which $(PICKER)),$(shell which ask 2>/dev/null || echo '')) - PICKER_FLAG=-D'PICK(prompt)="ask --prompt=\"" prompt "\""' + PICKER_FLAG=-D'PICK="/usr/bin/env ask --prompt=\"$$1\""' endif ifeq ($(shell which $(PICKER)),$(shell which pick 2>/dev/null || echo '')) - PICKER_FLAG=-D'PICK(prompt)="pick"' + PICKER_FLAG=-D'PICK="pick"' endif ifeq ($(shell which $(PICKER)),$(shell which dmenu 2>/dev/null || echo '')) - PICKER_FLAG=-D'PICK(prompt)="dmenu -i -l 10 -p \"" prompt "\""' + PICKER_FLAG=-D'PICK="dmenu -i -l 10 -p \"$$1\""' endif endif CFLAGS += $(PICKER_FLAG) @@ -44,11 +44,11 @@ CFLAGS += $(PICKER_FLAG) ifneq (, $(ASKER)) PERCENT := % ifeq ($(shell which $(ASKER)),$(shell which ask 2>/dev/null || echo '')) - CFLAGS += -D'ASK(var, prompt, initial)=var "=\"$$(ask --history=bb."STRINGIFY(__COUNTER__)".hist --prompt=\"" prompt "\" --query=\"" initial "\")\""' - CFLAGS += -D'CONFIRM(action, files)=" { printf \"$(PERCENT)s\\n\" \""B(action)"\" \""files"\" | more; ask -n \"Is that okay?\"; } "' + CFLAGS += -D'ASK="eval \"$$1=\\$$(/usr/bin/env ask --history=bb.hist --prompt=\\\"$$2\\\" --query=\\\"$$3\\\")\""' + CFLAGS += -D'CONFIRM="/usr/bin/env ask -n \"Is that okay?\""' endif ifeq ($(shell which $(ASKER)),$(shell which dmenu 2>/dev/null || echo '')) - CFLAGS += -D'ASK(var, prompt, initial)=var "=\"$$(printf \"" initial "\" | dmenu -p \"" prompt "\")\""' + CFLAGS += -D'ASK="eval \"$$1=\\$$(echo \"$$3\" | dmenu -p \"$$2\")\""' endif endif @@ -65,24 +65,27 @@ $(NAME): $(NAME).c bterm.h config.h install: $(NAME) @prefix="$(PREFIX)"; \ - if test -z $$prefix; then \ - read -p $$'\033[1mWhere do you want to install? (default: /usr/local) \033[0m' prefix; \ + if [ ! "$$prefix" ]; then \ + printf '\033[1mWhere do you want to install? (default: /usr/local) \033[0m'; \ + read prefix; \ fi; \ - if test -z $$prefix; then \ - prefix="/usr/local"; \ - fi; \ - mkdir -pv $$prefix/bin $$prefix/share/man/man1 \ - && cp -v $(NAME) $$prefix/bin/ \ - && cp -v $(NAME).1 $$prefix/share/man/man1/ + [ ! "$$prefix" ] && prefix="/usr/local"; \ + [ ! "$$sysconfdir" ] && sysconfdir=/etc; \ + mkdir -m 700 -pv "$$prefix/bin" "$$prefix/share/man/man1" "$$sysconfdir/bb" \ + && cp -v $(NAME) "$$prefix/bin/" \ + && cp -v $(NAME).1 "$$prefix/share/man/man1/" \ + && cp -v bbstartup.sh bindings.bb "$$sysconfdir/bb/" uninstall: @prefix="$(PREFIX)"; \ - if test -z $$prefix; then \ - read -p $$'\033[1mWhere do you want to uninstall from? (default: /usr/local) \033[0m' prefix; \ - fi; \ - if test -z $$prefix; then \ - prefix="/usr/local"; \ + if [ ! "$$prefix" ]; then \ + printf '\033[1mWhere do you want to uninstall from? (default: /usr/local) \033[0m'; \ + read prefix; \ fi; \ + [ ! "$$prefix" ] && prefix="/usr/local"; \ + [ ! "$$sysconfdir" ] && sysconfdir=/etc; \ + [ ! "$$XDG_CONFIG_HOME" ] && XDG_CONFIG_HOME=~/.config; \ echo "Deleting..."; \ - rm -rvf $$prefix/bin/$(NAME) $$prefix/share/man/man1/$(NAME).1 + rm -rvf "$$prefix/bin/$(NAME)" "$$prefix/share/man/man1/$(NAME).1" "$$sysconfdir/bb"; \ + printf '\033[1mIf you created any config files in $$XDG_CONFIG_HOME/bb, you may want to delete them manually.\033[0m' diff --git a/README.md b/README.md index d509b42..9cb9e5a 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,10 @@ No dependencies besides `make` and a C compiler, just: make sudo make install +To run `bb`, it's expected that you have some basic unix tools: +`basename`, `cat`, `cp`, `echo`, `find`, `grep`, `mkdir`, `more`, `mv`, +`printf`, `read`, `rm`, `sed`, `sh`, `sleep`, `touch`, `tput`, `tr`, `wait`. + ## Usage Run `bb` to launch the file browser. `bb` also has the flags: @@ -25,6 +29,8 @@ Run `bb` to launch the file browser. `bb` also has the flags: - `-s`: when `bb` exits successfully, print the files that were selected. - `-0`: use NULL-terminated strings instead of newline-separated strings with the `-s` flag. +- `-h`: print usage +- `-v`: print version Within `bb`, press `?` for a full list of available key bindings. In short: `h`/`j`/`k`/`l` or arrow keys for navigation, `q` to quit, `` to toggle diff --git a/bb.c b/bb.c index 32f3706..ad7777a 100644 --- a/bb.c +++ b/bb.c @@ -24,7 +24,7 @@ #include "config.h" #include "bterm.h" -#define BB_VERSION "0.15.2" +#define BB_VERSION "0.16.0" #ifndef PATH_MAX #define PATH_MAX 4096 @@ -134,6 +134,8 @@ static void init_term(void); static entry_t* load_entry(bb_t *bb, const char *path, int clear_dots); static void* memcheck(void *p); static void normalize_path(const char *root, const char *path, char *pbuf, int clear_dots); +static int is_simple_bbcmd(const char *s); +static char *trim(char *s); static void populate_files(bb_t *bb, int samedir); static void print_bindings(int fd); static bb_result_t process_cmd(bb_t *bb, const char *cmd); @@ -149,7 +151,6 @@ static void update_term_size(int sig); // Config options extern binding_t bindings[]; -extern const char *startupcmds[]; extern const column_t columns[128]; // Constants @@ -162,13 +163,75 @@ static const char *bbcmdfn = "bb() {\n" " for arg; do\n" " shift;\n" " if echo \"$arg\" | grep \"^+[^:]*:$\" >/dev/null 2>/dev/null; then\n" -" if test $# -gt 0; then printf \"$arg%s\\0\" \"$@\" >> $BBCMD\n" +" if test $# -gt 0; then printf \"%s\\0\" \"$arg\" \"$@\" >> $BBCMD\n" " else sed \"s/\\([^\\x00]\\+\\)/$arg\\1/g\" >> $BBCMD; fi\n" " return\n" " fi\n" -" printf \"$arg\\0\" >> $BBCMD\n" +" printf \"%s\\0\" \"$arg\" >> $BBCMD\n" " done\n" -"}\n"; +"}\n" +"ask() {\n" +#ifdef ASK +ASK ";\n" +#else +" printf \"\033[1m%s\033[0m\" \"$2\" >/dev/tty;\n" +" read $1 /dev/tty\n" +#endif +"}\n" +"ask1() {\n" +#ifdef ASK1 +ASK1 ";\n" +#else +" printf \"\033[?25l\" >/dev/tty;\n" +" printf \"\033[1m%s\033[0m\" \"$2\" >/dev/tty;\n" +" stty -icanon -echo >/dev/tty;\n" +" eval \"$1=\\$(dd bs=1 count=1 2>/dev/null /dev/tty;\n" +" printf \"\033[?25h\" >/dev/tty;\n" +#endif +"}\n" +"confirm() {\n" +#ifdef CONFIRM +CONFIRM ";\n" +#else +" ask1 REPLY \"\033[1mIs that okay? [y/N] \" && [ \"$REPLY\" = 'y' ];\n" +#endif +"}\n" +"pause() {\n" +#ifdef PAUSE +PAUSE ";\n" +#else +" ask1 REPLY \"\033[2mPress any key to continue...\033[0m\";" +#endif +"}\n" +"pick() {\n" +#ifdef PICK +PICK ";\n" +#else +" ask query \"$1\" && awk '{print length, $1}' | sort -n | cut -d' ' -f2- |\n" +" grep -i -m1 \"$(echo \"$query\" | sed 's;.;[^/&]*[&];g')\";\n" +#endif +"}\n" +"spin() {\n" +#ifdef SPIN +SPIN ";\n" +#else +" eval \"$@\" &\n" +" pid=$!;\n" +" spinner='-\\|/';\n" +" sleep 0.01;\n" +" while kill -0 $pid 2>/dev/null; do\n" +" printf '%c\\033[D' \"$spinner\" >/dev/tty;\n" +" spinner=\"$(echo $spinner | sed 's/\\(.\\)\\(.*\\)/\\2\\1/')\";\n" +" sleep 0.1;\n" +" done;\n" +" wait $pid;\n" +#endif +"}\n" +#ifdef SH +"alias sh=" SH";\n" +#endif +; // Global variables static struct termios orig_termios, bb_termios; @@ -299,6 +362,10 @@ void* memcheck(void *p) */ int run_script(bb_t *bb, const char *cmd) { + char *fullcmd = calloc(strlen(cmd) + strlen(bbcmdfn) + 1, sizeof(char)); + strcpy(fullcmd, bbcmdfn); + strcat(fullcmd, cmd); + pid_t child; void (*old_handler)(int) = signal(SIGINT, SIG_IGN); if ((child = fork()) == 0) { @@ -309,9 +376,6 @@ int run_script(bb_t *bb, const char *cmd) size_t i = 0; args[i++] = SH; args[i++] = "-c"; - char *fullcmd = calloc(strlen(cmd) + strlen(bbcmdfn) + 1, sizeof(char)); - strcpy(fullcmd, bbcmdfn); - strcat(fullcmd, cmd); args[i++] = fullcmd; args[i++] = "--"; // ensure files like "-i" are not interpreted as flags for sh for (entry_t *e = bb->firstselected; e; e = e->selected.next) { @@ -874,6 +938,38 @@ void normalize_path(const char *root, const char *path, char *normalized, int cl } } +/* + * Return whether or not 's' is a simple bb command that doesn't need + * a full shell instance (e.g. "bb +cd:.." or "bb +move:+1"). + */ +static int is_simple_bbcmd(const char *s) +{ + if (!s) return 0; + while (*s == ' ') ++s; + if (s[0] != '+' && strncmp(s, "bb +", 4) != 0) + return 0; + const char *special = ";$&<>|\n*?\\\"'"; + for (const char *p = special; *p; ++p) { + if (strchr(s, *p)) + return 0; + } + return 1; +} + +/* + * Trim trailing whitespace by inserting '\0' and return a pointer to after the + * first non-whitespace char + */ +static char *trim(char *s) +{ + if (!s) return NULL; + while (*s == ' ' || *s == '\n') ++s; + char *end; + for (end = &s[strlen(s)-1]; end >= s && (*end == ' ' || *end == '\n'); end--) + *end = '\0'; + return s; +} + int cd_to(bb_t *bb, const char *path) { char pbuf[PATH_MAX], prev[PATH_MAX] = {0}; @@ -986,10 +1082,11 @@ void populate_files(bb_t *bb, int samedir) */ bb_result_t process_cmd(bb_t *bb, const char *cmd) { - char *value = strchr(cmd, ':'); + if (cmd[0] == '+') ++cmd; + else if (strncmp(cmd, "bb +", 4) == 0) cmd = &cmd[4]; + const char *value = strchr(cmd, ':'); if (value) ++value; #define set_bool(target) do { if (!value) { target = !target; } else { target = value[0] == '1'; } } while (0) - if (cmd[0] == '+') ++cmd; switch (cmd[0]) { case '.': { // +..:, +.: if (cmd[1] == '.') // +..: @@ -999,6 +1096,44 @@ bb_result_t process_cmd(bb_t *bb, const char *cmd) populate_files(bb, 1); return BB_OK; } + case 'b': { // +bind::