3 * selector is a simple command line utility for selection of strings
4 * with a dynamic pattern-matching.
6 * Copyright (c) 2009 Francois Fleuret
7 * Written by Francois Fleuret <francois@fleuret.org>
9 * This file is part of selector.
11 * selector is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 3 as
13 * published by the Free Software Foundation.
15 * selector is distributed in the hope that it will be useful, but
16 * WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with selector. If not, see <http://www.gnu.org/licenses/>.
25 // To use it as a super-history-search for bash:
26 // alias h='selector -d -i -b -v -f <(history)'
36 #include <sys/ioctl.h>
44 const int buffer_size = 4096;
46 // Yeah, global variables!
48 int nb_lines_max = 1000;
49 char pattern_separator = ';';
50 char label_separator = '\0';
51 int output_to_vt_buffer = 0;
52 int add_control_qs = 0;
54 int zsh_history = 0, bash_history = 0;
55 int inverse_order = 0;
56 int remove_duplicates = 0;
58 int case_sensitive = 0;
62 #define COLOR_MODELINE 1
63 #define COLOR_HIGHLIGHTED_LINE 2
65 //////////////////////////////////////////////////////////////////////
67 void inject_into_tty_buffer(char *string) {
68 struct termios oldtio, newtio;
69 tcgetattr(STDIN_FILENO, &oldtio);
70 memset(&newtio, 0, sizeof(newtio));
71 // Set input mode (non-canonical, *no echo*,...)
72 tcsetattr(STDIN_FILENO, TCSANOW, &newtio);
73 char control_q = '\021';
74 // Put the selected string in the tty input buffer
75 for(char *k = string; *k; k++) {
77 // Add ^Q to quote control characters
78 ioctl(STDIN_FILENO, TIOCSTI, &control_q);
80 ioctl(STDIN_FILENO, TIOCSTI, k);
82 // Restore the old settings
83 tcsetattr(STDIN_FILENO, TCSANOW, &oldtio);
86 //////////////////////////////////////////////////////////////////////
88 void check_opt(int argc, char **argv, int n_opt, int n, const char *help) {
89 if(n_opt + n >= argc) {
90 cerr << "Missing argument for " << argv[n_opt] << "."
92 << "Expecting " << help << "."
98 int string_to_positive_integer(char *string) {
103 for(char *s = string; *s; s++) {
104 if(*s >= '0' && *s <= '9') {
105 result = result * 10 + int(*s - '0');
111 cerr << "Value `" << string << "' is not a positive integer." << endl;
118 void error_feedback() {
126 //////////////////////////////////////////////////////////////////////
127 // A quick and dirty hash table
129 // The table itself stores index of the strings in a char
130 // **table. When a string is added, if it was already in the table,
131 // the new index replaces the previous one.
133 int *new_hash_table(int hash_table_size) {
135 result = new int[hash_table_size];
136 for(int k = 0; k < hash_table_size; k++) {
142 // Adds new_string in the table, associated to new_index. If this
143 // string was not already in the table, returns -1. Otherwise, returns
144 // the previous index it had.
146 int test_and_add(char *new_string, int new_index,
147 char **strings, int *hash_table, int hash_table_size) {
149 unsigned int code = 0;
151 // This is my recipe. I checked, it seems to work (as long as
152 // hash_table_size is not a multiple of 387433 that should be okay)
154 for(int k = 0; new_string[k]; k++) {
155 code = code * 387433 + (unsigned int) (new_string[k]);
158 code = code % hash_table_size;
160 while(hash_table[code] >= 0) {
161 // There is a string with that code
162 if(strcmp(new_string, strings[hash_table[code]]) == 0) {
163 // It is the same string, we keep a copy of the stored index
164 int result = hash_table[code];
166 hash_table[code] = new_index;
167 // And return the previous one
170 // This collision was not the same string, let's move to the next
172 code = (code + 1) % hash_table_size;
175 // This string was not already in there, store the index in the
176 // table and return -1
177 hash_table[code] = new_index;
181 //////////////////////////////////////////////////////////////////////
182 // A matcher matches either with a collection of substrings, or with a
190 char *splitted_patterns, **patterns;
193 int match(char *string, matcher_t *matcher) {
194 if(matcher->nb_patterns >= 0) {
195 if(matcher->case_sensitive) {
196 for(int n = 0; n < matcher->nb_patterns; n++) {
197 if(strstr(string, matcher->patterns[n]) == 0) return 0;
200 for(int n = 0; n < matcher->nb_patterns; n++) {
201 if(strcasestr(string, matcher->patterns[n]) == 0) return 0;
206 return regexec(&matcher->preg, string, 0, 0, 0) == 0;
210 void free_matcher(matcher_t *matcher) {
211 if(matcher->nb_patterns < 0) {
212 if(!matcher->regexp_error) regfree(&matcher->preg);
214 delete[] matcher->splitted_patterns;
215 delete[] matcher->patterns;
219 void initialize_matcher(int use_regexp, int case_sensitive,
220 matcher_t *matcher, const char *pattern) {
223 matcher->nb_patterns = -1;
224 matcher->regexp_error = regcomp(&matcher->preg, pattern, case_sensitive ? 0 : REG_ICASE);
226 matcher->regexp_error = 0;
227 matcher->nb_patterns = 1;
228 matcher->case_sensitive = case_sensitive;
230 for(const char *s = pattern; *s; s++) {
231 if(*s == pattern_separator) {
232 matcher->nb_patterns++;
236 matcher->splitted_patterns = new char[strlen(pattern) + 1];
237 matcher->patterns = new char*[matcher->nb_patterns];
239 strcpy(matcher->splitted_patterns, pattern);
242 char *last_pattern_start = matcher->splitted_patterns;
243 for(char *s = matcher->splitted_patterns; n < matcher->nb_patterns; s++) {
244 if(*s == pattern_separator || *s == '\0') {
246 matcher->patterns[n++] = last_pattern_start;
247 last_pattern_start = s + 1;
253 //////////////////////////////////////////////////////////////////////
256 void delete_char(char *buffer, int *position) {
257 if(buffer[*position]) {
259 while(c < buffer_size && buffer[c]) {
260 buffer[c] = buffer[c+1];
263 } else error_feedback();
266 void backspace_char(char *buffer, int *position) {
268 if(buffer[*position]) {
269 int c = *position - 1;
271 buffer[c] = buffer[c+1];
275 buffer[*position - 1] = '\0';
279 } else error_feedback();
282 void insert_char(char *buffer, int *position, char character) {
283 if(strlen(buffer) < buffer_size - 1) {
285 char t = buffer[c], u;
294 buffer[(*position)++] = character;
295 } else error_feedback();
298 void kill_before_cursor(char *buffer, int *position) {
300 while(buffer[*position + s]) {
301 buffer[s] = buffer[*position + s];
308 void kill_after_cursor(char *buffer, int *position) {
309 buffer[*position] = '\0';
312 //////////////////////////////////////////////////////////////////////
314 int previous_visible(int current_line, int nb_lines, char **lines, matcher_t *matcher) {
315 int line = current_line - 1;
316 while(line >= 0 && !match(lines[line], matcher)) line--;
320 int next_visible(int current_line, int nb_lines, char **lines, matcher_t *matcher) {
321 int line = current_line + 1;
322 while(line < nb_lines && !match(lines[line], matcher)) line++;
330 //////////////////////////////////////////////////////////////////////
332 void update_screen(int *current_line, int *temporary_line, int motion,
333 int nb_lines, char **lines,
337 char buffer[buffer_size];
340 initialize_matcher(use_regexp, case_sensitive, &matcher, pattern);
342 // We now take care of printing the lines per se
344 int console_width = getmaxx(stdscr);
345 int console_height = getmaxy(stdscr);
347 // First, we find a visible line. In priority: The current, or the
348 // first visible after it, or the first visible before it.
350 int nb_printed_lines = 0;
353 use_default_colors();
356 if(matcher.regexp_error) {
357 addstr("[regexp error]");
358 } else if(nb_lines > 0) {
360 if(match(lines[*current_line], &matcher)) {
361 new_line = *current_line;
363 new_line = next_visible(*current_line, nb_lines, lines, &matcher);
365 new_line = previous_visible(*current_line, nb_lines, lines, &matcher);
369 // If we found a visible line and we should move, let's move
371 if(new_line >= 0 && motion != 0) {
374 // We want to go down, let's find the first visible line below
375 for(int m = 0; l >= 0 && m < motion; m++) {
376 l = next_visible(l, nb_lines, lines, &matcher);
382 // We want to go up, let's find the first visible line above
383 for(int m = 0; l >= 0 && m < -motion; m++) {
384 l = previous_visible(l, nb_lines, lines, &matcher);
392 // Here new_line is either a line number matching the patterns, or -1
396 int first_line = new_line, last_line = new_line, nb_match = 1;
398 // We find the first and last line to show, so that the total of
399 // visible lines between them (them included) is console_height-1
401 while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
405 while(first_line > 0 && !match(lines[first_line], &matcher)) {
408 if(match(lines[first_line], &matcher)) {
413 if(nb_match < console_height - 1 && last_line < nb_lines - 1) {
415 while(last_line < nb_lines - 1 && !match(lines[last_line], &matcher)) {
419 if(match(lines[last_line], &matcher)) {
425 // Now we display them
427 for(int l = first_line; l <= last_line; l++) {
428 if(match(lines[l], &matcher)) {
431 while(lines[l][k] && k < buffer_size - 2 && k < console_width - 2) {
432 buffer[k] = lines[l][k];
436 // We fill the rest of the line with blanks if this is the
440 while(k < console_width) {
448 // Highlight the highlighted line ...
452 attron(COLOR_PAIR(COLOR_HIGHLIGHTED_LINE));
453 addnstr(buffer, console_width);
454 attroff(COLOR_PAIR(COLOR_HIGHLIGHTED_LINE));
457 addnstr(buffer, console_width);
461 addnstr(buffer, console_width);
469 *current_line = new_line;
473 *temporary_line = new_line;
475 if(nb_printed_lines == 0) {
476 addnstr("[no selection]\n", console_width);
479 addnstr("[empty choice]\n", console_width);
487 attron(COLOR_PAIR(COLOR_MODELINE));
492 for(int k = 0; k < console_width; k++) buffer[k] = ' ';
493 buffer[console_width] = '\0';
494 addnstr(buffer, console_width);
498 // There must be a more elegant way of moving the cursor at a
499 // location met during display
506 cursor_x += strlen(title) + 1;
509 sprintf(buffer, "%d/%d ", nb_printed_lines, nb_lines);
511 cursor_x += strlen(buffer);
513 addnstr(pattern, cursor_position);
514 cursor_x += cursor_position;
516 if(pattern[cursor_position]) {
517 addstr(pattern + cursor_position);
522 if(use_regexp || case_sensitive) {
540 attroff(COLOR_PAIR(COLOR_MODELINE));
548 free_matcher(&matcher);
551 //////////////////////////////////////////////////////////////////////
553 void read_file(const char *input_filename,
554 int nb_lines_max, int *nb_lines, char **lines,
555 int hash_table_size, int *hash_table) {
557 char raw_line[buffer_size];;
559 ifstream file(input_filename);
562 cerr << "Can not open " << input_filename << endl;
566 while(*nb_lines < nb_lines_max && !file.eof()) {
568 file.getline(raw_line, buffer_size);
573 cerr << "Line too long:" << endl;
574 cerr << raw_line << endl;
582 // Remove the zsh history prefix
584 if(zsh_history && *t == ':') {
585 while(*t && *t != ';') t++;
589 // Remove the bash history prefix
592 while(*t == ' ') t++;
593 while(*t >= '0' && *t <= '9') t++;
594 while(*t == ' ') t++;
597 // Check for duplicates with the hash table and insert the line
598 // in the list if necessary
603 dup = test_and_add(t, *nb_lines, lines, hash_table, hash_table_size);
609 lines[*nb_lines] = new char[strlen(t) + 1];
610 strcpy(lines[*nb_lines], t);
612 // The string was already in there, so we do not allocate a
613 // new string but use the pointer to the first occurence of it
614 lines[*nb_lines] = lines[dup];
623 //////////////////////////////////////////////////////////////////////
625 int main(int argc, char **argv) {
627 if(!ttyname(STDIN_FILENO)) {
628 cerr << "The standard input is not a tty." << endl;
632 int color_fg_modeline, color_bg_modeline;
633 int color_fg_highlight, color_bg_highlight;
635 color_fg_modeline = COLOR_WHITE;
636 color_bg_modeline = COLOR_BLACK;
637 color_fg_highlight = COLOR_BLACK;
638 color_bg_highlight = COLOR_YELLOW;
640 setlocale(LC_ALL, "");
642 char input_filename[buffer_size], output_filename[buffer_size];
644 strcpy(input_filename, "");
645 strcpy(output_filename, "");
648 int error = 0, show_help = 0;
649 int rest_are_files = 0;
651 while(!error && !show_help && i < argc && argv[i][0] == '-' && !rest_are_files) {
653 if(strcmp(argv[i], "-o") == 0) {
654 check_opt(argc, argv, i, 1, "<output filename>");
655 strncpy(output_filename, argv[i+1], buffer_size);
659 else if(strcmp(argv[i], "-s") == 0) {
660 check_opt(argc, argv, i, 1, "<pattern separator>");
661 pattern_separator = argv[i+1][0];
665 else if(strcmp(argv[i], "-x") == 0) {
666 check_opt(argc, argv, i, 1, "<label separator>");
667 label_separator = argv[i+1][0];
671 else if(strcmp(argv[i], "-v") == 0) {
672 output_to_vt_buffer = 1;
676 else if(strcmp(argv[i], "-w") == 0) {
681 else if(strcmp(argv[i], "-m") == 0) {
686 else if(strcmp(argv[i], "-q") == 0) {
691 else if(strcmp(argv[i], "-f") == 0) {
692 check_opt(argc, argv, i, 1, "<input filename>");
693 strncpy(input_filename, argv[i+1], buffer_size);
697 else if(strcmp(argv[i], "-i") == 0) {
702 else if(strcmp(argv[i], "-b") == 0) {
707 else if(strcmp(argv[i], "-z") == 0) {
712 else if(strcmp(argv[i], "-d") == 0) {
713 remove_duplicates = 1;
717 else if(strcmp(argv[i], "-e") == 0) {
722 else if(strcmp(argv[i], "-a") == 0) {
727 else if(strcmp(argv[i], "-t") == 0) {
728 check_opt(argc, argv, i, 1, "<title>");
730 title = new char[strlen(argv[i+1]) + 1];
731 strcpy(title, argv[i+1]);
735 else if(strcmp(argv[i], "-l") == 0) {
736 check_opt(argc, argv, i, 1, "<maximum number of lines>");
737 nb_lines_max = string_to_positive_integer(argv[i+1]);
741 else if(strcmp(argv[i], "-c") == 0) {
742 check_opt(argc, argv, i, 4, "<fg modeline> <bg modeline> <fg highlight> <bg highlight>");
743 color_fg_modeline = string_to_positive_integer(argv[i + 1]);
744 color_bg_modeline = string_to_positive_integer(argv[i + 2]);
745 color_fg_highlight = string_to_positive_integer(argv[i + 3]);
746 color_bg_highlight = string_to_positive_integer(argv[i + 4]);
750 else if(strcmp(argv[i], "--") == 0) {
755 else if(strcmp(argv[i], "-h") == 0) {
761 cerr << "Unknown option " << argv[i] << "." << endl;
766 if(show_help || error) {
767 cerr << "Selector version " << VERSION << "-R" << REVISION_NUMBER
769 << "Written by Francois Fleuret <francois@fleuret.org>."
772 << "Usage: " << argv[0] << " [options] [<filename1> [<filename2> ...]]" << endl
774 << " -h show this help" << endl
775 << " -v inject the selected line in the tty" << endl
776 << " -d remove duplicated lines" << endl
777 << " -b remove the bash history line prefix" << endl
778 << " -z remove the zsh history line prefix" << endl
779 << " -i invert the order of lines" << endl
780 << " -e start in regexp mode" << endl
781 << " -a case sensitive" << endl
782 << " -m monochrome mode" << endl
783 << " -q make a flash instead of a beep on an edition error" << endl
784 << " -- rest of the arguments are filenames" << endl
785 << " -t <title>" << endl
786 << " add a title in the modeline" << endl
787 << " -c <fg modeline> <bg modeline> <fg highlight> <bg highlight>" << endl
788 << " set the display colors" << endl
789 << " -o <output filename>" << endl
790 << " set a file to write the selected line to" << endl
791 << " -s <pattern separator>" << endl
792 << " set the symbol to separate substrings in the pattern" << endl
793 << " -x <label separator>" << endl
794 << " set the symbol to terminate the label" << endl
795 << " -l <max number of lines>" << endl
796 << " set the maximum number of lines to take into account" << endl
802 char **lines = new char *[nb_lines_max];
805 int hash_table_size = nb_lines_max * 10;
808 if(remove_duplicates) {
809 hash_table = new_hash_table(hash_table_size);
812 if(input_filename[0]) {
813 read_file(input_filename,
814 nb_lines_max, &nb_lines, lines,
815 hash_table_size, hash_table);
820 nb_lines_max, &nb_lines, lines,
821 hash_table_size, hash_table);
827 // Now remove the null strings
830 for(int k = 0; k < nb_lines; k++) {
832 lines[n++] = lines[k];
839 for(int i = 0; i < nb_lines / 2; i++) {
840 char *s = lines[nb_lines - 1 - i];
841 lines[nb_lines - 1 - i] = lines[i];
846 // Build the labels from the strings, take only the part before the
847 // label_separator and transform control characters to printable
850 char **labels = new char *[nb_lines];
851 for(int l = 0; l < nb_lines; l++) {
856 while(*t && *t != label_separator) {
860 labels[l] = new char[e + 1];
863 while(*t && *t != label_separator) {
865 while(*u) { *s++ = *u++; }
870 char pattern[buffer_size];
876 //////////////////////////////////////////////////////////////////////
877 // Here we start to display with curse
883 // So that the arrow keys work
884 keypad(stdscr, TRUE);
892 if(color_fg_modeline < 0 || color_fg_modeline >= COLORS ||
893 color_bg_modeline < 0 || color_bg_modeline >= COLORS ||
894 color_fg_highlight < 0 || color_bg_highlight >= COLORS ||
895 color_bg_highlight < 0 || color_bg_highlight >= COLORS) {
898 cerr << "Color numbers have to be between 0 and " << COLORS - 1 << "." << endl;
902 init_pair(COLOR_MODELINE, color_fg_modeline, color_bg_modeline);
903 init_pair(COLOR_HIGHLIGHTED_LINE, color_fg_highlight, color_bg_highlight);
911 int current_line = 0, temporary_line = 0;
913 update_screen(¤t_line, &temporary_line, 0,
914 nb_lines, labels, cursor_position, pattern);
922 if(key >= ' ' && key <= '~') { // Insert character
923 insert_char(pattern, &cursor_position, key);
926 else if(key == KEY_BACKSPACE ||
927 key == '\010' || // ^H
928 key == '\177') { // ^?
929 backspace_char(pattern, &cursor_position);
932 else if(key == KEY_DC ||
933 key == '\004') { // ^D
934 delete_char(pattern, &cursor_position);
937 else if(key == KEY_HOME) {
941 else if(key == KEY_END) {
942 current_line = nb_lines - 1;
945 else if(key == KEY_NPAGE) {
949 else if(key == KEY_PPAGE) {
953 else if(key == KEY_DOWN ||
954 key == '\016') { // ^N
958 else if(key == KEY_UP ||
959 key == '\020') { // ^P
963 else if(key == KEY_LEFT ||
964 key == '\002') { // ^B
965 if(cursor_position > 0) cursor_position--;
966 else error_feedback();
969 else if(key == KEY_RIGHT ||
970 key == '\006') { // ^F
971 if(pattern[cursor_position]) cursor_position++;
972 else error_feedback();
975 else if(key == '\001') { // ^A
979 else if(key == '\005') { // ^E
980 cursor_position = strlen(pattern);
983 else if(key == '\022') { // ^R
984 use_regexp = !use_regexp;
987 else if(key == '\011') { // ^I
988 case_sensitive = !case_sensitive;
991 else if(key == '\025') { // ^U
992 kill_before_cursor(pattern, &cursor_position);
995 else if(key == '\013') { // ^K
996 kill_after_cursor(pattern, &cursor_position);
999 update_screen(¤t_line, &temporary_line, motion,
1000 nb_lines, labels, cursor_position, pattern);
1002 } while(key != '\007' && // ^G
1003 key != '\033' && // ^[ (escape)
1010 //////////////////////////////////////////////////////////////////////
1011 // Here we come back to standard display
1013 if((key == KEY_ENTER || key == '\n')) {
1015 if(output_to_vt_buffer) {
1016 if(temporary_line >= 0 && temporary_line < nb_lines) {
1017 inject_into_tty_buffer(lines[temporary_line]);
1021 if(output_filename[0]) {
1022 ofstream out(output_filename);
1024 cerr << "Can not open " << output_filename << " for writing." << endl;
1027 if(temporary_line >= 0 && temporary_line < nb_lines) {
1028 out << lines[temporary_line] << endl;
1036 cout << "Aborted." << endl;
1039 for(int l = 0; l < nb_lines; l++) {