/*
- * selector is a simple shell command for selection of strings with a
- * dynamic pattern-matching.
+ * selector is a simple command line utility for selection of strings
+ * with a dynamic pattern-matching.
*
* Copyright (c) 2009 Francois Fleuret
* Written by Francois Fleuret <francois@fleuret.org>
*/
// To use it as a super-history-search for bash:
-// alias h='selector -d -i -b -v -f <(history)'
+// selector -q -b -i -d -v -w -l ${HISTSIZE} <(history)
#include <fstream>
#include <iostream>
#include <stdio.h>
#include <stdlib.h>
+#include <unistd.h>
#include <string.h>
#include <ncurses.h>
#include <fcntl.h>
int nb_lines_max = 1000;
char pattern_separator = ';';
+char label_separator = '\0';
int output_to_vt_buffer = 0;
+int add_control_qs = 0;
int with_colors = 1;
-int zsh_history = 0, bash_history = 0;
+int zsh_history = 0;
+int bash_history = 0;
int inverse_order = 0;
int remove_duplicates = 0;
int use_regexp = 0;
int case_sensitive = 0;
char *title = 0;
+int error_flash = 0;
+
+int attr_modeline, attr_focus_line, attr_error;
//////////////////////////////////////////////////////////////////////
memset(&newtio, 0, sizeof(newtio));
// Set input mode (non-canonical, *no echo*,...)
tcsetattr(STDIN_FILENO, TCSANOW, &newtio);
+ const char control_q = '\021';
// Put the selected string in the tty input buffer
- for(char *k = string; *k; k++) {
+ for(const char *k = string; *k; k++) {
+ if(add_control_qs && !(*k >= ' ' && *k <= '~')) {
+ // Add ^Q to quote control characters
+ ioctl(STDIN_FILENO, TIOCSTI, &control_q);
+ }
ioctl(STDIN_FILENO, TIOCSTI, k);
}
// Restore the old settings
}
}
+int string_to_positive_integer(char *string) {
+ int error = 0;
+ int result = 0;
+
+ if(*string) {
+ for(char *s = string; *s; s++) {
+ if(*s >= '0' && *s <= '9') {
+ result = result * 10 + int(*s - '0');
+ } else error = 1;
+ }
+ } else error = 1;
+
+ if(error) {
+ cerr << "Value `" << string << "' is not a positive integer." << endl;
+ exit(1);
+ }
+
+ return result;
+}
+
+void error_feedback() {
+ if(error_flash) {
+ flash();
+ } else {
+ beep();
+ }
+}
+
//////////////////////////////////////////////////////////////////////
// A quick and dirty hash table
-// The table itself stores index of the strings in a char
+// The table itself stores indexes of the strings taken in a char
// **table. When a string is added, if it was already in the table,
// the new index replaces the previous one.
// the previous index it had.
int test_and_add(char *new_string, int new_index,
- char **strings, int *hash_table, int hash_table_size) {
+ char **strings,
+ int *hash_table, int hash_table_size) {
+
unsigned int code = 0;
// This is my recipe. I checked, it seems to work (as long as
}
void free_matcher(matcher_t *matcher) {
- if(matcher->nb_patterns >= 0) {
+ if(matcher->nb_patterns < 0) {
+ if(!matcher->regexp_error) regfree(&matcher->preg);
+ } else {
delete[] matcher->splitted_patterns;
delete[] matcher->patterns;
- } else {
- if(!matcher->regexp_error) regfree(&matcher->preg);
}
}
buffer[c] = buffer[c+1];
c++;
}
- }
+ } else error_feedback();
}
void backspace_char(char *buffer, int *position) {
}
(*position)--;
- }
+ } else error_feedback();
}
void insert_char(char *buffer, int *position, char character) {
c++;
buffer[c] = '\0';
buffer[(*position)++] = character;
- }
+ } else error_feedback();
}
void kill_before_cursor(char *buffer, int *position) {
//////////////////////////////////////////////////////////////////////
-void update_screen(int *current_line, int *temporary_line, int motion,
+// The value passed to this routine in current_focus_line is the index
+// of the line we should have highlited if there was no motion and if
+// it matched the matcher. So, the line actually highlighted is the
+// first one matching the matcher in that order: (1)
+// current_focus_line after motion, (2) the first with a greater
+// index, (3) the first with a lesser index.
+
+// The index of the line actually shown highlighted is written in
+// displayed_focus_line (it can be -1)
+
+// If there is a motion and a line is actually shown highlighted, its
+// value is written in current_focus_line.
+
+void update_screen(int *current_focus_line, int *displayed_focus_line,
+ int motion,
int nb_lines, char **lines,
int cursor_position,
char *pattern) {
initialize_matcher(use_regexp, case_sensitive, &matcher, pattern);
- // We now take care of printing the lines per se
-
int console_width = getmaxx(stdscr);
int console_height = getmaxy(stdscr);
- // First, we find a visible line. In priority: The current, or the
- // first visible after it, or the first visible before it.
+ // First, we find a visible line.
int nb_printed_lines = 0;
- clear();
use_default_colors();
+
addstr("\n");
if(matcher.regexp_error) {
- addstr("[regexp error]");
+ attron(attr_error);
+ addnstr("Regexp syntax error", console_width);
+ attroff(attr_error);
} else if(nb_lines > 0) {
- int new_line;
- if(match(lines[*current_line], &matcher)) {
- new_line = *current_line;
+ int new_focus_line;
+ if(match(lines[*current_focus_line], &matcher)) {
+ new_focus_line = *current_focus_line;
} else {
- new_line = next_visible(*current_line, nb_lines, lines, &matcher);
- if(new_line < 0) {
- new_line = previous_visible(*current_line, nb_lines, lines, &matcher);
+ new_focus_line = next_visible(*current_focus_line, nb_lines, lines, &matcher);
+ if(new_focus_line < 0) {
+ new_focus_line = previous_visible(*current_focus_line, nb_lines, lines, &matcher);
}
}
// If we found a visible line and we should move, let's move
- if(new_line >= 0 && motion != 0) {
- int l = new_line;
+ if(new_focus_line >= 0 && motion != 0) {
+ int l = new_focus_line;
if(motion > 0) {
// We want to go down, let's find the first visible line below
for(int m = 0; l >= 0 && m < motion; m++) {
l = next_visible(l, nb_lines, lines, &matcher);
if(l >= 0) {
- new_line = l;
+ new_focus_line = l;
}
}
} else {
for(int m = 0; l >= 0 && m < -motion; m++) {
l = previous_visible(l, nb_lines, lines, &matcher);
if(l >= 0) {
- new_line = l;
+ new_focus_line = l;
}
}
}
}
- // Here new_line is either a line number matching the patterns, or -1
+ // Here new_focus_line is either a line number matching the pattern, or -1
- if(new_line >= 0) {
+ if(new_focus_line >= 0) {
- int first_line = new_line, last_line = new_line, nb_match = 1;
+ int first_line = new_focus_line, last_line = new_focus_line, nb_match = 1;
// We find the first and last line to show, so that the total of
- // visible lines between them (them include) is console_height - 1
+ // visible lines between them (them included) is console_height-1
while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
k++;
}
- // We fill the rest of the line with blanks if either we did
- // not clear() or if this is the highlighted line
+ // We fill the rest of the line with blanks if this is the
+ // highlighted line
- if(l == new_line) {
+ if(l == new_focus_line) {
while(k < console_width) {
buffer[k++] = ' ';
}
buffer[k++] = '\n';
buffer[k++] = '\0';
+ clrtoeol();
+
// Highlight the highlighted line ...
- if(l == new_line) {
- if(with_colors) {
- attron(COLOR_PAIR(2));
- addnstr(buffer, console_width);
- attroff(COLOR_PAIR(2));
- } else {
- attron(A_STANDOUT);
- addnstr(buffer, console_width);
- attroff(A_STANDOUT);
- }
+ if(l == new_focus_line) {
+ attron(attr_focus_line);
+ addnstr(buffer, console_width);
+ attroff(attr_focus_line);
} else {
addnstr(buffer, console_width);
}
}
}
+ // If we are on a focused line and we moved, this become the new
+ // focus line
+
if(motion != 0) {
- *current_line = new_line;
+ *current_focus_line = new_focus_line;
}
}
- *temporary_line = new_line;
+ *displayed_focus_line = new_focus_line;
if(nb_printed_lines == 0) {
- addnstr("[no selection]\n", console_width);
+ attron(attr_error);
+ addnstr("No selection", console_width);
+ attroff(attr_error);
}
} else {
- addnstr("[empty choice]\n", console_width);
+ attron(attr_error);
+ addnstr("Empty choice", console_width);
+ attroff(attr_error);
}
+ clrtobot();
+
// Draw the modeline
move(0, 0);
- if(with_colors) {
- attron(COLOR_PAIR(1));
- } else {
- attron(A_REVERSE);
- }
+ attron(attr_modeline);
for(int k = 0; k < console_width; k++) buffer[k] = ' ';
buffer[console_width] = '\0';
addstr(" ");
}
- if(use_regexp) {
- addstr(" [regexp]");
+ if(use_regexp || case_sensitive) {
+ addstr(" [");
+ if(use_regexp) {
+ addstr("regexp");
+ }
+
+ if(case_sensitive) {
+ if(use_regexp) {
+ addstr(",");
+ }
+ addstr("case");
+ }
+ addstr("]");
}
move(0, cursor_x);
- if(with_colors) {
- attroff(COLOR_PAIR(1));
- } else {
- attroff(A_REVERSE);
- }
+ attroff(attr_modeline);
// We are done
int nb_lines_max, int *nb_lines, char **lines,
int hash_table_size, int *hash_table) {
- char buffer[buffer_size], raw_line[buffer_size];;
+ char raw_line[buffer_size];;
ifstream file(input_filename);
exit(1);
}
- char *s, *t;
- const char *u;
+ char *t;
- s = buffer;
t = raw_line;
- while(*t) {
- u = unctrl(*t++);
- while(*u) { *s++ = *u++; }
- }
- *s = '\0';
- s = buffer;
+ // Remove the zsh history prefix
- if(zsh_history && *s == ':') {
- while(*s && *s != ';') s++;
- if(*s == ';') s++;
+ if(zsh_history && *t == ':') {
+ while(*t && *t != ';') t++;
+ if(*t == ';') t++;
}
- if(bash_history && (*s == ' ' || (*s >= '0' && *s <= '9'))) {
- while(*s == ' ' || (*s >= '0' && *s <= '9')) s++;
+ // Remove the bash history prefix
+
+ if(bash_history) {
+ while(*t == ' ') t++;
+ while(*t >= '0' && *t <= '9') t++;
+ while(*t == ' ') t++;
}
+ // Check for duplicates with the hash table and insert the line
+ // in the list if necessary
+
int dup;
if(hash_table) {
- dup = test_and_add(s, *nb_lines, lines, hash_table, hash_table_size);
+ dup = test_and_add(t, *nb_lines, lines, hash_table, hash_table_size);
} else {
dup = -1;
}
if(dup < 0) {
- lines[*nb_lines] = new char[strlen(s) + 1];
- strcpy(lines[*nb_lines], s);
+ lines[*nb_lines] = new char[strlen(t) + 1];
+ strcpy(lines[*nb_lines], t);
} else {
// The string was already in there, so we do not allocate a
// new string but use the pointer to the first occurence of it
i += 2;
}
+ else if(strcmp(argv[i], "-x") == 0) {
+ check_opt(argc, argv, i, 1, "<label separator>");
+ label_separator = argv[i+1][0];
+ i += 2;
+ }
+
else if(strcmp(argv[i], "-v") == 0) {
output_to_vt_buffer = 1;
i++;
}
+ else if(strcmp(argv[i], "-w") == 0) {
+ add_control_qs = 1;
+ i++;
+ }
+
else if(strcmp(argv[i], "-m") == 0) {
with_colors = 0;
i++;
}
+ else if(strcmp(argv[i], "-q") == 0) {
+ error_flash = 1;
+ i++;
+ }
+
else if(strcmp(argv[i], "-f") == 0) {
check_opt(argc, argv, i, 1, "<input filename>");
strncpy(input_filename, argv[i+1], buffer_size);
else if(strcmp(argv[i], "-l") == 0) {
check_opt(argc, argv, i, 1, "<maximum number of lines>");
- nb_lines_max = atoi(argv[i+1]);
+ nb_lines_max = string_to_positive_integer(argv[i+1]);
i += 2;
}
else if(strcmp(argv[i], "-c") == 0) {
check_opt(argc, argv, i, 4, "<fg modeline> <bg modeline> <fg highlight> <bg highlight>");
- color_fg_modeline = atoi(argv[i+1]);
- color_bg_modeline = atoi(argv[i+2]);
- color_fg_highlight = atoi(argv[i+3]);
- color_bg_highlight = atoi(argv[i+4]);
+ color_fg_modeline = string_to_positive_integer(argv[i + 1]);
+ color_bg_modeline = string_to_positive_integer(argv[i + 2]);
+ color_fg_highlight = string_to_positive_integer(argv[i + 3]);
+ color_bg_highlight = string_to_positive_integer(argv[i + 4]);
i += 5;
}
<< endl
<< " -h show this help" << endl
<< " -v inject the selected line in the tty" << endl
+ << " -w quote control characters with ^Qs when using -v" << endl
<< " -d remove duplicated lines" << endl
<< " -b remove the bash history line prefix" << endl
<< " -z remove the zsh history line prefix" << endl
<< " -e start in regexp mode" << endl
<< " -a case sensitive" << endl
<< " -m monochrome mode" << endl
- << " -- rest of the arguments are filenames" << endl
+ << " -q make a flash instead of a beep on an edition error" << endl
+ << " -- all following arguments are filenames" << endl
<< " -t <title>" << endl
<< " add a title in the modeline" << endl
<< " -c <fg modeline> <bg modeline> <fg highlight> <bg highlight>" << endl
<< " set a file to write the selected line to" << endl
<< " -s <pattern separator>" << endl
<< " set the symbol to separate substrings in the pattern" << endl
+ << " -x <label separator>" << endl
+ << " set the symbol to terminate the label" << endl
<< " -l <max number of lines>" << endl
<< " set the maximum number of lines to take into account" << endl
<< endl;
hash_table = new_hash_table(hash_table_size);
}
- // if(i == argc && !input_filename[0]) {
- // cerr << "You must provide a filename." << endl;
- // exit(1);
- // }
-
if(input_filename[0]) {
read_file(input_filename,
nb_lines_max, &nb_lines, lines,
}
}
+ // Build the labels from the strings, take only the part before the
+ // label_separator and transform control characters to printable
+ // ones
+
+ char **labels = new char *[nb_lines];
+ for(int l = 0; l < nb_lines; l++) {
+ char *s, *t;
+ const char *u;
+ t = lines[l];
+ int e = 0;
+ while(*t && *t != label_separator) {
+ u = unctrl(*t++);
+ e += strlen(u);
+ }
+ labels[l] = new char[e + 1];
+ t = lines[l];
+ s = labels[l];
+ while(*t && *t != label_separator) {
+ u = unctrl(*t++);
+ while(*u) { *s++ = *u++; }
+ }
+ *s = '\0';
+ }
+
char pattern[buffer_size];
pattern[0] = '\0';
+
int cursor_position;
cursor_position = 0;
// Here we start to display with curse
initscr();
-
+ cbreak();
noecho();
-
- // Hide the cursor
- // curs_set(0);
+ // nonl();
+ intrflush(stdscr, FALSE);
// So that the arrow keys work
keypad(stdscr, TRUE);
- if(with_colors) {
- if(has_colors()) {
- start_color();
- if(color_fg_modeline < 0 || color_fg_modeline >= COLORS ||
- color_bg_modeline < 0 || color_bg_modeline >= COLORS ||
- color_fg_highlight < 0 || color_bg_highlight >= COLORS ||
- color_bg_highlight < 0 || color_bg_highlight >= COLORS) {
- echo();
- // curs_set(1);
- endwin();
- cerr << "Color numbers have to be between 0 and " << COLORS - 1 << "." << endl;
- exit(1);
- }
- init_pair(1, color_fg_modeline, color_bg_modeline);
- init_pair(2, color_fg_highlight, color_bg_highlight);
- init_pair(3, color_bg_modeline, color_fg_modeline);
- } else {
- with_colors = 0;
+ attr_error = A_STANDOUT;
+ attr_modeline = A_REVERSE;
+ attr_focus_line = A_STANDOUT;
+
+ if(with_colors && has_colors()) {
+
+ start_color();
+
+ if(color_fg_modeline < 0 || color_fg_modeline >= COLORS ||
+ color_bg_modeline < 0 || color_bg_modeline >= COLORS ||
+ color_fg_highlight < 0 || color_bg_highlight >= COLORS ||
+ color_bg_highlight < 0 || color_bg_highlight >= COLORS) {
+ echo();
+ endwin();
+ cerr << "Color numbers have to be between 0 and " << COLORS - 1 << "." << endl;
+ exit(1);
}
+
+ init_pair(1, color_fg_modeline, color_bg_modeline);
+ attr_modeline = COLOR_PAIR(1);
+
+ init_pair(2, color_fg_highlight, color_bg_highlight);
+ attr_focus_line = COLOR_PAIR(2);
+
+ init_pair(3, COLOR_WHITE, COLOR_RED);
+ attr_error = COLOR_PAIR(3);
+
}
int key;
- int current_line = 0, temporary_line = 0;
+ int current_focus_line = 0, displayed_focus_line = 0;
- update_screen(¤t_line, &temporary_line, 0, nb_lines, lines, cursor_position, pattern);
+ update_screen(¤t_focus_line, &displayed_focus_line,
+ 0,
+ nb_lines, labels, cursor_position, pattern);
do {
}
else if(key == KEY_HOME) {
- current_line = 0;
+ current_focus_line = 0;
}
else if(key == KEY_END) {
- current_line = nb_lines - 1;
+ current_focus_line = nb_lines - 1;
}
else if(key == KEY_NPAGE) {
else if(key == KEY_LEFT ||
key == '\002') { // ^B
if(cursor_position > 0) cursor_position--;
+ else error_feedback();
}
else if(key == KEY_RIGHT ||
key == '\006') { // ^F
if(pattern[cursor_position]) cursor_position++;
+ else error_feedback();
}
else if(key == '\001') { // ^A
use_regexp = !use_regexp;
}
+ else if(key == '\011') { // ^I
+ case_sensitive = !case_sensitive;
+ }
+
else if(key == '\025') { // ^U
kill_before_cursor(pattern, &cursor_position);
}
kill_after_cursor(pattern, &cursor_position);
}
- update_screen(¤t_line, &temporary_line, motion,
- nb_lines, lines, cursor_position, pattern);
+ else if(key == '\014') { // ^L
+ // I suspect that we may sometime mess up the display
+ clear();
+ }
+
+ update_screen(¤t_focus_line, &displayed_focus_line,
+ motion,
+ nb_lines, labels, cursor_position, pattern);
- } while(key != '\n' && key != KEY_ENTER && key != '\007'); // ^G
+ } while(key != '\007' && // ^G
+ key != '\033' && // ^[ (escape)
+ key != '\n' &&
+ key != KEY_ENTER);
echo();
- // curs_set(1);
endwin();
//////////////////////////////////////////////////////////////////////
if((key == KEY_ENTER || key == '\n')) {
- if(output_to_vt_buffer) {
- if(temporary_line >= 0 && temporary_line < nb_lines) {
- inject_into_tty_buffer(lines[temporary_line]);
+ char *t;
+
+ if(displayed_focus_line >= 0 && displayed_focus_line < nb_lines) {
+ t = lines[displayed_focus_line];
+ if(label_separator) {
+ while(*t && *t != label_separator) t++;
+ if(*t) t++;
}
+ } else {
+ t = 0;
+ }
+
+ if(output_to_vt_buffer && t) {
+ inject_into_tty_buffer(t);
}
if(output_filename[0]) {
cerr << "Can not open " << output_filename << " for writing." << endl;
exit(1);
} else {
- if(temporary_line >= 0 && temporary_line < nb_lines) {
- out << lines[temporary_line] << endl;
+ if(t) {
+ out << t << endl;
} else {
out << endl;
}
out.flush();
}
+ } else {
+ cout << "Aborted." << endl;
}
for(int l = 0; l < nb_lines; l++) {
delete[] lines[l];
+ delete[] labels[l];
}
+ delete[] labels;
delete[] lines;
delete[] title;