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 //////////////////////////////////////////////////////////////////////
216 void delete_char(char *buffer, int *position) {
217 if(buffer[*position]) {
219 while(c < buffer_size && buffer[c]) {
220 buffer[c] = buffer[c+1];
226 void backspace_char(char *buffer, int *position) {
228 if(buffer[*position]) {
229 int c = *position - 1;
231 buffer[c] = buffer[c+1];
235 buffer[*position - 1] = '\0';
242 void insert_char(char *buffer, int *position, char character) {
243 if(strlen(buffer) < buffer_size - 1) {
245 char t = buffer[c], u;
254 buffer[(*position)++] = character;
258 void kill_before_cursor(char *buffer, int *position) {
260 while(buffer[*position + s]) {
261 buffer[s] = buffer[*position + s];
268 void kill_after_cursor(char *buffer, int *position) {
269 buffer[*position] = '\0';
272 //////////////////////////////////////////////////////////////////////
274 int previous_visible(int current_line, int nb_lines, char **lines, matcher_t *matcher) {
275 int line = current_line - 1;
276 while(line >= 0 && !match(lines[line], matcher)) line--;
280 int next_visible(int current_line, int nb_lines, char **lines, matcher_t *matcher) {
281 int line = current_line + 1;
282 while(line < nb_lines && !match(lines[line], matcher)) line++;
290 //////////////////////////////////////////////////////////////////////
292 void update_screen(int *current_line, int *temporary_line, int motion,
293 int nb_lines, char **lines,
297 char buffer[buffer_size];
300 initialize_matcher(use_regexp, case_sensitive, &matcher, pattern);
302 // We now take care of printing the lines per se
304 int console_width = getmaxx(stdscr);
305 int console_height = getmaxy(stdscr);
307 // First, we find a visible line. In priority: The current, or the
308 // first visible after it, or the first visible before it.
310 int nb_printed_lines = 0;
313 use_default_colors();
316 if(matcher.regexp_error) {
317 addstr("[regexp error]");
318 } else if(nb_lines > 0) {
320 if(match(lines[*current_line], &matcher)) {
321 new_line = *current_line;
323 new_line = next_visible(*current_line, nb_lines, lines, &matcher);
325 new_line = previous_visible(*current_line, nb_lines, lines, &matcher);
329 // If we found a visible line and we should move, let's move
331 if(new_line >= 0 && motion != 0) {
334 // We want to go down, let's find the first visible line below
335 for(int m = 0; l >= 0 && m < motion; m++) {
336 l = next_visible(l, nb_lines, lines, &matcher);
342 // We want to go up, let's find the first visible line above
343 for(int m = 0; l >= 0 && m < -motion; m++) {
344 l = previous_visible(l, nb_lines, lines, &matcher);
352 // Here new_line is either a line number matching the patterns, or -1
356 int first_line = new_line, last_line = new_line, nb_match = 1;
358 // We find the first and last line to show, so that the total of
359 // visible lines between them (them include) is console_height - 1
361 while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
365 while(first_line > 0 && !match(lines[first_line], &matcher)) {
368 if(match(lines[first_line], &matcher)) {
373 if(nb_match < console_height - 1 && last_line < nb_lines - 1) {
375 while(last_line < nb_lines - 1 && !match(lines[last_line], &matcher)) {
379 if(match(lines[last_line], &matcher)) {
385 // Now we display them
387 for(int l = first_line; l <= last_line; l++) {
388 if(match(lines[l], &matcher)) {
391 while(lines[l][k] && k < buffer_size - 2 && k < console_width - 2) {
392 buffer[k] = lines[l][k];
396 // We fill the rest of the line with blanks if either we did
397 // not clear() or if this is the highlighted line
400 while(k < console_width) {
408 // Highlight the highlighted line ...
412 attron(COLOR_PAIR(2));
413 addnstr(buffer, console_width);
414 attroff(COLOR_PAIR(2));
417 addnstr(buffer, console_width);
421 addnstr(buffer, console_width);
429 *current_line = new_line;
433 *temporary_line = new_line;
435 if(nb_printed_lines == 0) {
436 addnstr("[no selection]\n", console_width);
439 addnstr("[empty choice]\n", console_width);
447 attron(COLOR_PAIR(1));
452 for(int k = 0; k < console_width; k++) buffer[k] = ' ';
453 buffer[console_width] = '\0';
454 addnstr(buffer, console_width);
458 // There must be a more elegant way of moving the cursor at a
459 // location met during display
466 cursor_x += strlen(title) + 1;
469 sprintf(buffer, "%d/%d ", nb_printed_lines, nb_lines);
471 cursor_x += strlen(buffer);
473 addnstr(pattern, cursor_position);
474 cursor_x += cursor_position;
476 if(pattern[cursor_position]) {
477 addstr(pattern + cursor_position);
489 attroff(COLOR_PAIR(1));
497 free_matcher(&matcher);
500 //////////////////////////////////////////////////////////////////////
502 void read_file(const char *input_filename,
503 int nb_lines_max, int *nb_lines, char **lines,
504 int hash_table_size, int *hash_table) {
506 char buffer[buffer_size], raw_line[buffer_size];;
508 ifstream file(input_filename);
511 cerr << "Can not open " << input_filename << endl;
515 while(*nb_lines < nb_lines_max && !file.eof()) {
517 file.getline(raw_line, buffer_size);
522 cerr << "Line too long:" << endl;
523 cerr << raw_line << endl;
534 while(*u) { *s++ = *u++; }
540 if(zsh_history && *s == ':') {
541 while(*s && *s != ';') s++;
545 if(bash_history && (*s == ' ' || (*s >= '0' && *s <= '9'))) {
546 while(*s == ' ' || (*s >= '0' && *s <= '9')) s++;
552 dup = test_and_add(s, *nb_lines, lines, hash_table, hash_table_size);
558 lines[*nb_lines] = new char[strlen(s) + 1];
559 strcpy(lines[*nb_lines], s);
561 // The string was already in there, so we do not allocate a
562 // new string but use the pointer to the first occurence of it
563 lines[*nb_lines] = lines[dup];
572 //////////////////////////////////////////////////////////////////////
574 int main(int argc, char **argv) {
576 if(!ttyname(STDIN_FILENO)) {
577 cerr << "The standard input is not a tty." << endl;
581 int color_fg_modeline, color_bg_modeline;
582 int color_fg_highlight, color_bg_highlight;
584 color_fg_modeline = COLOR_WHITE;
585 color_bg_modeline = COLOR_BLACK;
586 color_fg_highlight = COLOR_BLACK;
587 color_bg_highlight = COLOR_YELLOW;
589 setlocale(LC_ALL, "");
591 char input_filename[buffer_size], output_filename[buffer_size];
593 strcpy(input_filename, "");
594 strcpy(output_filename, "");
597 int error = 0, show_help = 0;
598 int rest_are_files = 0;
600 while(!error && !show_help && i < argc && argv[i][0] == '-' && !rest_are_files) {
602 if(strcmp(argv[i], "-o") == 0) {
603 check_opt(argc, argv, i, 1, "<output filename>");
604 strncpy(output_filename, argv[i+1], buffer_size);
608 else if(strcmp(argv[i], "-s") == 0) {
609 check_opt(argc, argv, i, 1, "<pattern separator>");
610 pattern_separator = argv[i+1][0];
614 else if(strcmp(argv[i], "-v") == 0) {
615 output_to_vt_buffer = 1;
619 else if(strcmp(argv[i], "-m") == 0) {
624 else if(strcmp(argv[i], "-f") == 0) {
625 check_opt(argc, argv, i, 1, "<input filename>");
626 strncpy(input_filename, argv[i+1], buffer_size);
630 else if(strcmp(argv[i], "-i") == 0) {
635 else if(strcmp(argv[i], "-b") == 0) {
640 else if(strcmp(argv[i], "-z") == 0) {
645 else if(strcmp(argv[i], "-d") == 0) {
646 remove_duplicates = 1;
650 else if(strcmp(argv[i], "-e") == 0) {
655 else if(strcmp(argv[i], "-a") == 0) {
660 else if(strcmp(argv[i], "-t") == 0) {
661 check_opt(argc, argv, i, 1, "<title>");
663 title = new char[strlen(argv[i+1]) + 1];
664 strcpy(title, argv[i+1]);
668 else if(strcmp(argv[i], "-l") == 0) {
669 check_opt(argc, argv, i, 1, "<maximum number of lines>");
670 nb_lines_max = atoi(argv[i+1]);
674 else if(strcmp(argv[i], "-c") == 0) {
675 check_opt(argc, argv, i, 4, "<fg modeline> <bg modeline> <fg highlight> <bg highlight>");
676 color_fg_modeline = atoi(argv[i+1]);
677 color_bg_modeline = atoi(argv[i+2]);
678 color_fg_highlight = atoi(argv[i+3]);
679 color_bg_highlight = atoi(argv[i+4]);
683 else if(strcmp(argv[i], "--") == 0) {
688 else if(strcmp(argv[i], "-h") == 0) {
694 cerr << "Unknown option " << argv[i] << "." << endl;
699 if(show_help || error) {
700 cerr << "Selector version " << VERSION << "-R" << REVISION_NUMBER
702 << "Written by Francois Fleuret <francois@fleuret.org>."
705 << "Usage: " << argv[0] << " [options] [<filename1> [<filename2> ...]]" << endl
707 << " -h show this help" << endl
708 << " -v inject the selected line in the tty" << endl
709 << " -d remove duplicated lines" << endl
710 << " -b remove the bash history line prefix" << endl
711 << " -z remove the zsh history line prefix" << endl
712 << " -i invert the order of lines" << endl
713 << " -e start in regexp mode" << endl
714 << " -a case sensitive" << endl
715 << " -m monochrome mode" << endl
716 << " -- rest of the arguments are filenames" << endl
717 << " -t <title>" << endl
718 << " add a title in the modeline" << endl
719 << " -c <fg modeline> <bg modeline> <fg highlight> <bg highlight>" << endl
720 << " set the display colors" << endl
721 << " -o <output filename>" << endl
722 << " set a file to write the selected line to" << endl
723 << " -s <pattern separator>" << endl
724 << " set the symbol to separate substrings in the pattern" << endl
725 << " -l <max number of lines>" << endl
726 << " set the maximum number of lines to take into account" << endl
732 char **lines = new char *[nb_lines_max];
735 int hash_table_size = nb_lines_max * 10;
738 if(remove_duplicates) {
739 hash_table = new_hash_table(hash_table_size);
742 // if(i == argc && !input_filename[0]) {
743 // cerr << "You must provide a filename." << endl;
747 if(input_filename[0]) {
748 read_file(input_filename,
749 nb_lines_max, &nb_lines, lines,
750 hash_table_size, hash_table);
755 nb_lines_max, &nb_lines, lines,
756 hash_table_size, hash_table);
762 // Now remove the null strings
765 for(int k = 0; k < nb_lines; k++) {
767 lines[n++] = lines[k];
774 for(int i = 0; i < nb_lines / 2; i++) {
775 char *s = lines[nb_lines - 1 - i];
776 lines[nb_lines - 1 - i] = lines[i];
781 char pattern[buffer_size];
786 //////////////////////////////////////////////////////////////////////
787 // Here we start to display with curse
796 // So that the arrow keys work
797 keypad(stdscr, TRUE);
802 if(color_fg_modeline < 0 || color_fg_modeline >= COLORS ||
803 color_bg_modeline < 0 || color_bg_modeline >= COLORS ||
804 color_fg_highlight < 0 || color_bg_highlight >= COLORS ||
805 color_bg_highlight < 0 || color_bg_highlight >= COLORS) {
809 cerr << "Color numbers have to be between 0 and " << COLORS - 1 << "." << endl;
812 init_pair(1, color_fg_modeline, color_bg_modeline);
813 init_pair(2, color_fg_highlight, color_bg_highlight);
814 init_pair(3, color_bg_modeline, color_fg_modeline);
821 int current_line = 0, temporary_line = 0;
823 update_screen(¤t_line, &temporary_line, 0, nb_lines, lines, cursor_position, pattern);
831 if(key >= ' ' && key <= '~') { // Insert character
832 insert_char(pattern, &cursor_position, key);
835 else if(key == KEY_BACKSPACE ||
836 key == '\010' || // ^H
837 key == '\177') { // ^?
838 backspace_char(pattern, &cursor_position);
841 else if(key == KEY_DC ||
842 key == '\004') { // ^D
843 delete_char(pattern, &cursor_position);
846 else if(key == KEY_HOME) {
850 else if(key == KEY_END) {
851 current_line = nb_lines - 1;
854 else if(key == KEY_NPAGE) {
858 else if(key == KEY_PPAGE) {
862 else if(key == KEY_DOWN ||
863 key == '\016') { // ^N
867 else if(key == KEY_UP ||
868 key == '\020') { // ^P
872 else if(key == KEY_LEFT ||
873 key == '\002') { // ^B
874 if(cursor_position > 0) cursor_position--;
877 else if(key == KEY_RIGHT ||
878 key == '\006') { // ^F
879 if(pattern[cursor_position]) cursor_position++;
882 else if(key == '\001') { // ^A
886 else if(key == '\005') { // ^E
887 cursor_position = strlen(pattern);
890 else if(key == '\022') { // ^R
891 use_regexp = !use_regexp;
894 else if(key == '\025') { // ^U
895 kill_before_cursor(pattern, &cursor_position);
898 else if(key == '\013') { // ^K
899 kill_after_cursor(pattern, &cursor_position);
902 update_screen(¤t_line, &temporary_line, motion,
903 nb_lines, lines, cursor_position, pattern);
905 } while(key != '\n' && key != KEY_ENTER && key != '\007'); // ^G
911 //////////////////////////////////////////////////////////////////////
912 // Here we come back to standard display
914 if((key == KEY_ENTER || key == '\n')) {
916 if(output_to_vt_buffer) {
917 if(temporary_line >= 0 && temporary_line < nb_lines) {
918 inject_into_tty_buffer(lines[temporary_line]);
922 if(output_filename[0]) {
923 ofstream out(output_filename);
925 cerr << "Can not open " << output_filename << " for writing." << endl;
928 if(temporary_line >= 0 && temporary_line < nb_lines) {
929 out << lines[temporary_line] << endl;
939 for(int l = 0; l < nb_lines; l++) {