3 * selector is a simple shell command for selection of strings with a
4 * 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 int output_to_vt_buffer = 0;
52 int zsh_history = 0, bash_history = 0;
53 int inverse_order = 0;
54 int remove_duplicates = 0;
56 int case_sensitive = 0;
59 //////////////////////////////////////////////////////////////////////
61 void inject_into_tty_buffer(char *string) {
62 struct termios oldtio, newtio;
63 tcgetattr(STDIN_FILENO, &oldtio);
64 memset(&newtio, 0, sizeof(newtio));
65 // Set input mode (non-canonical, *no echo*,...)
66 tcsetattr(STDIN_FILENO, TCSANOW, &newtio);
67 // Put the selected string in the tty input buffer
68 for(char *k = string; *k; k++) {
69 ioctl(STDIN_FILENO, TIOCSTI, k);
71 // Restore the old settings
72 tcsetattr(STDIN_FILENO, TCSANOW, &oldtio);
75 //////////////////////////////////////////////////////////////////////
77 void check_opt(int argc, char **argv, int n_opt, int n, const char *help) {
78 if(n_opt + n >= argc) {
79 cerr << "Missing argument for " << argv[n_opt] << "."
81 << "Expecting " << help << "."
87 //////////////////////////////////////////////////////////////////////
88 // A quick and dirty hash table
90 // The table itself stores index of the strings in a char
91 // **table. When a string is added, if it was already in the table,
92 // the new index replaces the previous one.
94 int *new_hash_table(int hash_table_size) {
96 result = new int[hash_table_size];
97 for(int k = 0; k < hash_table_size; k++) {
103 // Adds new_string in the table, associated to new_index. If this
104 // string was not already in the table, returns -1. Otherwise, returns
105 // the previous index it had.
107 int test_and_add(char *new_string, int new_index,
108 char **strings, int *hash_table, int hash_table_size) {
109 unsigned int code = 0;
111 // This is my recipe. I checked, it seems to work (as long as
112 // hash_table_size is not a multiple of 387433 that should be okay)
114 for(int k = 0; new_string[k]; k++) {
115 code = code * 387433 + (unsigned int) (new_string[k]);
118 code = code % hash_table_size;
120 while(hash_table[code] >= 0) {
121 // There is a string with that code
122 if(strcmp(new_string, strings[hash_table[code]]) == 0) {
123 // It is the same string, we keep a copy of the stored index
124 int result = hash_table[code];
126 hash_table[code] = new_index;
127 // And return the previous one
130 // This collision was not the same string, let's move to the next
132 code = (code + 1) % hash_table_size;
135 // This string was not already in there, store the index in the
136 // table and return -1
137 hash_table[code] = new_index;
141 //////////////////////////////////////////////////////////////////////
142 // A matcher matches either with a collection of substrings, or with a
150 char *splitted_patterns, **patterns;
153 int match(char *string, matcher_t *matcher) {
154 if(matcher->nb_patterns >= 0) {
155 if(matcher->case_sensitive) {
156 for(int n = 0; n < matcher->nb_patterns; n++) {
157 if(strstr(string, matcher->patterns[n]) == 0) return 0;
160 for(int n = 0; n < matcher->nb_patterns; n++) {
161 if(strcasestr(string, matcher->patterns[n]) == 0) return 0;
166 return regexec(&matcher->preg, string, 0, 0, 0) == 0;
170 void free_matcher(matcher_t *matcher) {
171 if(matcher->nb_patterns >= 0) {
172 delete[] matcher->splitted_patterns;
173 delete[] matcher->patterns;
175 if(!matcher->regexp_error) regfree(&matcher->preg);
179 void initialize_matcher(int use_regexp, int case_sensitive,
180 matcher_t *matcher, const char *pattern) {
183 matcher->nb_patterns = -1;
184 matcher->regexp_error = regcomp(&matcher->preg, pattern, case_sensitive ? 0 : REG_ICASE);
186 matcher->regexp_error = 0;
187 matcher->nb_patterns = 1;
188 matcher->case_sensitive = case_sensitive;
190 for(const char *s = pattern; *s; s++) {
191 if(*s == pattern_separator) {
192 matcher->nb_patterns++;
196 matcher->splitted_patterns = new char[strlen(pattern) + 1];
197 matcher->patterns = new char*[matcher->nb_patterns];
199 strcpy(matcher->splitted_patterns, pattern);
202 char *last_pattern_start = matcher->splitted_patterns;
203 for(char *s = matcher->splitted_patterns; n < matcher->nb_patterns; s++) {
204 if(*s == pattern_separator || *s == '\0') {
206 matcher->patterns[n++] = last_pattern_start;
207 last_pattern_start = s + 1;
213 //////////////////////////////////////////////////////////////////////
215 int previous_visible(int current_line, int nb_lines, char **lines, matcher_t *matcher) {
216 int line = current_line - 1;
217 while(line >= 0 && !match(lines[line], matcher)) line--;
221 int next_visible(int current_line, int nb_lines, char **lines, matcher_t *matcher) {
222 int line = current_line + 1;
223 while(line < nb_lines && !match(lines[line], matcher)) line++;
231 //////////////////////////////////////////////////////////////////////
233 void update_screen(int *current_line, int *temporary_line, int motion,
234 int nb_lines, char **lines,
238 char buffer[buffer_size];
241 initialize_matcher(use_regexp, case_sensitive, &matcher, pattern);
243 // We now take care of printing the lines per se
245 int console_width = getmaxx(stdscr);
246 int console_height = getmaxy(stdscr);
248 // First, we find a visible line. In priority: The current, or the
249 // first visible after it, or the first visible before it.
251 int nb_printed_lines = 0;
254 use_default_colors();
257 if(matcher.regexp_error) {
258 addstr("[regexp error]");
259 } else if(nb_lines > 0) {
261 if(match(lines[*current_line], &matcher)) {
262 new_line = *current_line;
264 new_line = next_visible(*current_line, nb_lines, lines, &matcher);
266 new_line = previous_visible(*current_line, nb_lines, lines, &matcher);
270 // If we found a visible line and we should move, let's move
272 if(new_line >= 0 && motion != 0) {
275 // We want to go down, let's find the first visible line below
276 for(int m = 0; l >= 0 && m < motion; m++) {
277 l = next_visible(l, nb_lines, lines, &matcher);
283 // We want to go up, let's find the first visible line above
284 for(int m = 0; l >= 0 && m < -motion; m++) {
285 l = previous_visible(l, nb_lines, lines, &matcher);
293 // Here new_line is either a line number matching the patterns, or -1
297 int first_line = new_line, last_line = new_line, nb_match = 1;
299 // We find the first and last line to show, so that the total of
300 // visible lines between them (them include) is console_height - 1
302 while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
306 while(first_line > 0 && !match(lines[first_line], &matcher)) {
309 if(match(lines[first_line], &matcher)) {
314 if(nb_match < console_height - 1 && last_line < nb_lines - 1) {
316 while(last_line < nb_lines - 1 && !match(lines[last_line], &matcher)) {
320 if(match(lines[last_line], &matcher)) {
326 // Now we display them
328 for(int l = first_line; l <= last_line; l++) {
329 if(match(lines[l], &matcher)) {
332 while(lines[l][k] && k < buffer_size - 2 && k < console_width - 2) {
333 buffer[k] = lines[l][k];
337 // We fill the rest of the line with blanks if either we did
338 // not clear() or if this is the highlighted line
341 while(k < console_width) {
349 // Highlight the highlighted line ...
353 attron(COLOR_PAIR(2));
354 addnstr(buffer, console_width);
355 attroff(COLOR_PAIR(2));
358 addnstr(buffer, console_width);
362 addnstr(buffer, console_width);
370 *current_line = new_line;
374 *temporary_line = new_line;
376 if(nb_printed_lines == 0) {
377 addnstr("[no selection]\n", console_width);
380 addnstr("[empty choice]\n", console_width);
387 attron(COLOR_PAIR(1));
392 for(int k = 0; k < console_width; k++) buffer[k] = ' ';
393 buffer[console_width] = '\0';
394 addnstr(buffer, console_width);
403 printw("%d/%d ", nb_printed_lines, nb_lines);
405 addnstr(pattern, cursor_position);
407 // Now we print the cursor. All that mess to have reverse video with
408 // and without color.
411 attroff(COLOR_PAIR(1));
412 attron(COLOR_PAIR(3));
417 if(pattern[cursor_position]) {
418 addnstr(&pattern[cursor_position], 1);
424 attroff(COLOR_PAIR(3));
425 attron(COLOR_PAIR(1));
430 if(pattern[cursor_position]) {
431 addstr(pattern + cursor_position + 1);
434 // Finished printing the cursor
441 attroff(COLOR_PAIR(1));
449 free_matcher(&matcher);
452 //////////////////////////////////////////////////////////////////////
454 int main(int argc, char **argv) {
456 if(!ttyname(STDIN_FILENO)) {
457 cerr << "The standard input is not a tty." << endl;
461 char buffer[buffer_size], raw_line[buffer_size];;
462 int color_fg_modeline, color_bg_modeline;
463 int color_fg_highlight, color_bg_highlight;
465 color_fg_modeline = COLOR_WHITE;
466 color_bg_modeline = COLOR_BLACK;
467 color_fg_highlight = COLOR_BLACK;
468 color_bg_highlight = COLOR_YELLOW;
470 setlocale(LC_ALL, "");
472 char input_filename[buffer_size], output_filename[buffer_size];
474 strcpy(input_filename, "");
475 strcpy(output_filename, "");
478 int error = 0, show_help = 0;
480 while(!error && !show_help && i < argc) {
482 if(strcmp(argv[i], "-o") == 0) {
483 check_opt(argc, argv, i, 1, "<output filename>");
484 strncpy(output_filename, argv[i+1], buffer_size);
488 else if(strcmp(argv[i], "-s") == 0) {
489 check_opt(argc, argv, i, 1, "<pattern separator>");
490 pattern_separator = argv[i+1][0];
494 else if(strcmp(argv[i], "-v") == 0) {
495 output_to_vt_buffer = 1;
499 else if(strcmp(argv[i], "-m") == 0) {
504 else if(strcmp(argv[i], "-f") == 0) {
505 check_opt(argc, argv, i, 1, "<input filename>");
506 strncpy(input_filename, argv[i+1], buffer_size);
510 else if(strcmp(argv[i], "-i") == 0) {
515 else if(strcmp(argv[i], "-b") == 0) {
520 else if(strcmp(argv[i], "-z") == 0) {
525 else if(strcmp(argv[i], "-d") == 0) {
526 remove_duplicates = 1;
530 else if(strcmp(argv[i], "-e") == 0) {
535 else if(strcmp(argv[i], "-a") == 0) {
540 else if(strcmp(argv[i], "-t") == 0) {
541 check_opt(argc, argv, i, 1, "<title>");
543 title = new char[strlen(argv[i+1]) + 1];
544 strcpy(title, argv[i+1]);
548 else if(strcmp(argv[i], "-l") == 0) {
549 check_opt(argc, argv, i, 1, "<maximum number of lines>");
550 nb_lines_max = atoi(argv[i+1]);
554 else if(strcmp(argv[i], "-c") == 0) {
555 check_opt(argc, argv, i, 4, "<fg modeline> <bg modeline> <fg highlight> <bg highlight>");
556 color_fg_modeline = atoi(argv[i+1]);
557 color_bg_modeline = atoi(argv[i+2]);
558 color_fg_highlight = atoi(argv[i+3]);
559 color_bg_highlight = atoi(argv[i+4]);
563 else if(strcmp(argv[i], "-h") == 0) {
569 cerr << "Unknown argument " << argv[i] << "." << endl;
574 if(show_help || error) {
575 cerr << "Selector version " << VERSION << "-R" << REVISION_NUMBER
577 << "Written by Francois Fleuret <francois@fleuret.org>."
580 << "Usage: " << argv[0] << " [options] -f <file>" << endl
582 << " -h show this help" << endl
583 << " -v inject the selected line in the tty" << endl
584 << " -d remove duplicated lines" << endl
585 << " -b remove the bash history line prefix" << endl
586 << " -z remove the zsh history line prefix" << endl
587 << " -i invert the order of lines" << endl
588 << " -e start in regexp mode" << endl
589 << " -a case sensitive" << endl
590 << " -m monochrome mode" << endl
591 << " -t <title>" << endl
592 << " add a title in the modeline" << endl
593 << " -c <fg modeline> <bg modeline> <fg highlight> <bg highlight>" << endl
594 << " set the display colors" << endl
595 << " -o <output filename>" << endl
596 << " set a file to write the selected line to" << endl
597 << " -s <pattern separator>" << endl
598 << " set the symbol to separate substrings in the pattern" << endl
599 << " -l <max number of lines>" << endl
600 << " set the maximum number of lines to take into account" << endl
606 char **lines = new char *[nb_lines_max];
608 if(!input_filename[0]) {
609 cerr << "You must specify a input file with -f." << endl;
615 ifstream file(input_filename);
618 cerr << "Can not open " << input_filename << endl;
622 int hash_table_size = nb_lines_max * 10;
625 if(remove_duplicates) {
626 hash_table = new_hash_table(hash_table_size);
629 while(nb_lines < nb_lines_max && !file.eof()) {
631 file.getline(raw_line, buffer_size);
636 cerr << "Line too long:" << endl;
637 cerr << raw_line << endl;
648 while(*u) { *s++ = *u++; }
654 if(zsh_history && *s == ':') {
655 while(*s && *s != ';') s++;
659 if(bash_history && (*s == ' ' || (*s >= '0' && *s <= '9'))) {
660 while(*s == ' ' || (*s >= '0' && *s <= '9')) s++;
666 dup = test_and_add(s, nb_lines, lines, hash_table, hash_table_size);
672 lines[nb_lines] = new char[strlen(s) + 1];
673 strcpy(lines[nb_lines], s);
675 // The string was already in there, so we do not allocate a
676 // new string but use the pointer to the first occurence of it
677 lines[nb_lines] = lines[dup];
687 // Now remove the null strings
690 for(int k = 0; k < nb_lines; k++) {
692 lines[n++] = lines[k];
698 for(int i = 0; i < nb_lines/2; i++) {
699 char *s = lines[nb_lines - 1 - i];
700 lines[nb_lines - 1 - i] = lines[i];
705 char pattern[buffer_size];
710 //////////////////////////////////////////////////////////////////////
711 // Here we start to display with curse
720 // So that the arrow keys work
721 keypad(stdscr, TRUE);
726 if(color_fg_modeline < 0 || color_fg_modeline >= COLORS ||
727 color_bg_modeline < 0 || color_bg_modeline >= COLORS ||
728 color_fg_highlight < 0 || color_bg_highlight >= COLORS ||
729 color_bg_highlight < 0 || color_bg_highlight >= COLORS) {
733 cerr << "Color numbers have to be between 0 and " << COLORS - 1 << "." << endl;
736 init_pair(1, color_fg_modeline, color_bg_modeline);
737 init_pair(2, color_fg_highlight, color_bg_highlight);
738 init_pair(3, color_bg_modeline, color_fg_modeline);
745 int current_line = 0, temporary_line = 0;
747 update_screen(¤t_line, &temporary_line, 0, nb_lines, lines, cursor_position, pattern);
766 if(key >= ' ' && key <= '~') { // Insert character
767 int c = cursor_position;
768 char t = pattern[c], u;
777 pattern[cursor_position++] = key;
780 else if(key == KEY_BACKSPACE || key == '\010' || key == '\177') {
781 if(cursor_position > 0) {
782 if(pattern[cursor_position]) {
783 int c = cursor_position-1;
785 pattern[c] = pattern[c+1];
789 pattern[cursor_position - 1] = '\0';
795 else if(key == KEY_DC || key == '\004') {
796 if(pattern[cursor_position]) {
797 int c = cursor_position;
799 pattern[c] = pattern[c+1];
805 else if(key == KEY_HOME) {
809 else if(key == KEY_END) {
810 current_line = nb_lines - 1;
813 else if(key == KEY_NPAGE) {
817 else if(key == KEY_PPAGE) {
821 else if(key == KEY_DOWN || key == '\014') {
825 else if(key == KEY_UP || key == '\016') {
829 else if(key == KEY_LEFT || key == '\002') {
830 if(cursor_position > 0) cursor_position--;
833 else if(key == KEY_RIGHT || key == '\006') {
834 if(pattern[cursor_position]) cursor_position++;
837 else if(key == '\001') {
841 else if(key == '\005') {
842 cursor_position = strlen(pattern);
845 else if(key == '\022') {
846 use_regexp = !use_regexp;
849 else if(key == '\025') {
851 while(pattern[cursor_position + s]) {
852 pattern[s] = pattern[cursor_position + s];
859 else if(key == '\013') {
860 pattern[cursor_position] = '\0';
863 update_screen(¤t_line, &temporary_line, motion,
864 nb_lines, lines, cursor_position, pattern);
866 } while(key != '\n' && key != KEY_ENTER && key != '\007');
872 //////////////////////////////////////////////////////////////////////
873 // Here we come back to standard display
875 if((key == KEY_ENTER || key == '\n')) {
877 if(output_to_vt_buffer) {
878 if(temporary_line >= 0 && temporary_line < nb_lines) {
879 inject_into_tty_buffer(lines[temporary_line]);
883 if(output_filename[0]) {
884 ofstream out(output_filename);
886 cerr << "Can not open " << output_filename << " for writing." << endl;
889 if(temporary_line >= 0 && temporary_line < nb_lines) {
890 out << lines[temporary_line] << endl;
900 for(int l = 0; l < nb_lines; l++) {