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:
27 // alias h='./selector -i -b -v -f <(history)'
29 // This software is highly Linux-specific, but I would be glad to get
30 // patches to make it work on other OS
40 #include <sys/ioctl.h>
47 const int buffer_size = 1024;
49 // Yeah, global variables!
51 int nb_lines_max = 1000;
52 char pattern_separator = ';';
53 int output_to_vt_buffer = 0;
55 int zsh_history = 0, bash_history = 0;
56 int inverse_order = 0;
57 int remove_duplicates = 0;
59 //////////////////////////////////////////////////////////////////////
61 // This looks severely Linux-only ...
63 void inject_into_tty_buffer(char *line) {
64 struct termios oldtio, newtio;
65 tcgetattr(STDIN_FILENO,&oldtio);
66 memset(&newtio, 0, sizeof(newtio));
67 // Set input mode (non-canonical, *no echo*,...)
68 tcsetattr(STDIN_FILENO, TCSANOW, &newtio);
69 // Put the selected line in the tty input buffer
70 for(char *k = line; *k; k++) {
71 ioctl(STDIN_FILENO, TIOCSTI, k);
73 // Restore the old settings
74 tcsetattr(STDIN_FILENO, TCSANOW, &oldtio);
77 //////////////////////////////////////////////////////////////////////
79 int match(char *string, int nb_patterns, char **patterns) {
80 for(int n = 0; n < nb_patterns; n++) {
81 if(strstr(string, patterns[n]) == 0) return 0;
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 //////////////////////////////////////////////////////////////////////
99 // A quick and dirty hash table
101 int *new_hash_table(int hash_table_size) {
103 result = new int[hash_table_size];
104 for(int k = 0; k < hash_table_size; k++) {
110 int test_and_add(char *new_string, int new_index,
111 char **strings, int *hash_table, int hash_table_size) {
112 unsigned int code = 0;
114 for(int k = 0; new_string[k]; k++) {
115 code += int(new_string[k]) << (8 * k%4);
118 code = code % hash_table_size;
120 while(hash_table[code] >= 0) {
121 if(strcmp(new_string, strings[hash_table[code]]) == 0) return 1;
122 code = (code + 1) % hash_table_size;
125 hash_table[code] = new_index;
130 //////////////////////////////////////////////////////////////////////
132 int previous_visible(int current_line, int nb_lines, char **lines, int nb_patterns, char **patterns) {
133 int line = current_line - 1;
134 while(line >= 0 && !match(lines[line], nb_patterns, patterns)) line--;
138 int next_visible(int current_line, int nb_lines, char **lines, int nb_patterns, char **patterns) {
139 int line = current_line + 1;
140 while(line < nb_lines && !match(lines[line], nb_patterns, patterns)) line++;
148 void update_screen(int *current_line, int *temporary_line, int motion,
149 int nb_lines, char **lines,
150 char *pattern_list) {
152 char buffer[buffer_size];
154 // We split the pattern list into individual patterns
158 for(char *s = pattern_list; *s; s++) {
159 if(*s == pattern_separator) {
164 char splitted_patterns[strlen(pattern_list) + 1];
165 char *patterns[nb_patterns];
167 strcpy(splitted_patterns, pattern_list);
170 char *last_pattern_start = splitted_patterns;
171 for(char *s = splitted_patterns; n < nb_patterns; s++) {
172 if(*s == pattern_separator || *s == '\0') {
174 patterns[n++] = last_pattern_start;
175 last_pattern_start = s + 1;
179 // We now take care of printing the lines per se
181 int console_width = getmaxx(stdscr);
182 int console_height = getmaxy(stdscr);
184 // First, we find a visible line. In priority: The current, or the
185 // first visible after it, or the first visible before it.
188 if(match(lines[*current_line], nb_patterns, patterns)) {
189 new_line = *current_line;
191 new_line = next_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
193 new_line = previous_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
197 // If we found a visible line and we should move, let's move
199 if(new_line >= 0 && motion != 0) {
202 // We want to go down, let's find the first visible line below
203 for(int m = 0; l >= 0 && m < motion; m++) {
204 l = next_visible(l, nb_lines, lines, nb_patterns, patterns);
210 // We want to go up, let's find the first visible line above
211 for(int m = 0; l >= 0 && m < -motion; m++) {
212 l = previous_visible(l, nb_lines, lines, nb_patterns, patterns);
222 use_default_colors();
226 int nb_printed_lines = 0;
228 // Here new_line is either a line number matching the patterns, or -1
232 int first_line = new_line, last_line = new_line, nb_match = 1;
234 // We find the first and last line to show, so that the total of
235 // visible lines between them (them include) is console_height - 1
237 while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
241 while(first_line > 0 && !match(lines[first_line], nb_patterns, patterns)) {
244 if(match(lines[first_line], nb_patterns, patterns)) {
249 if(nb_match < console_height - 1 && last_line < nb_lines - 1) {
251 while(last_line < nb_lines - 1 && !match(lines[last_line], nb_patterns, patterns)) {
255 if(match(lines[last_line], nb_patterns, patterns)) {
261 // Now we display them
263 for(int l = first_line; l <= last_line; l++) {
264 if(match(lines[l], nb_patterns, patterns)) {
267 while(lines[l][k] && k < buffer_size - 2 && k < console_width - 2) {
268 buffer[k] = lines[l][k];
272 // We fill the rest of the line with blanks if either we did
273 // not clear() or if this is the highlighted line
276 while(k < console_width) {
284 // Highlight the highlighted line ...
288 attron(COLOR_PAIR(2));
289 addnstr(buffer, console_width);
290 attroff(COLOR_PAIR(2));
293 addnstr(buffer, console_width);
297 addnstr(buffer, console_width);
305 *current_line = new_line;
309 *temporary_line = new_line;
311 if(nb_printed_lines == 0) {
312 addnstr("[no selection]\n", console_width);
317 sprintf(buffer, "%d/%d pattern: %s",
322 for(int k = strlen(buffer); k < console_width; k++) buffer[k] = ' ';
323 buffer[console_width] = '\0';
327 attron(COLOR_PAIR(1));
328 addnstr(buffer, console_width);
329 attroff(COLOR_PAIR(1));
332 addnstr(buffer, console_width);
341 //////////////////////////////////////////////////////////////////////
343 int main(int argc, char **argv) {
344 char buffer[buffer_size];
345 int color_fg_modeline, color_bg_modeline;
346 int color_fg_highlight, color_bg_highlight;
348 color_fg_modeline = COLOR_WHITE;
349 color_bg_modeline = COLOR_BLACK;
350 color_fg_highlight = COLOR_BLACK;
351 color_bg_highlight = COLOR_YELLOW;
353 setlocale(LC_ALL, "");
355 char input_filename[buffer_size], output_filename[buffer_size];
357 strcpy(input_filename, "");
358 strcpy(output_filename, "");
363 if(strcmp(argv[i], "-o") == 0) {
364 check_opt(argc, argv, i, 1, "<output filename>");
365 strncpy(output_filename, argv[i+1], buffer_size);
369 else if(strcmp(argv[i], "-s") == 0) {
370 check_opt(argc, argv, i, 1, "<pattern separator>");
371 pattern_separator = argv[i+1][0];
375 else if(strcmp(argv[i], "-v") == 0) {
376 output_to_vt_buffer = 1;
380 else if(strcmp(argv[i], "-m") == 0) {
385 else if(strcmp(argv[i], "-f") == 0) {
386 check_opt(argc, argv, i, 1, "<input filename>");
387 strncpy(input_filename, argv[i+1], buffer_size);
391 else if(strcmp(argv[i], "-i") == 0) {
396 else if(strcmp(argv[i], "-z") == 0) {
401 else if(strcmp(argv[i], "-b") == 0) {
406 else if(strcmp(argv[i], "-d") == 0) {
407 remove_duplicates = 1;
411 else if(strcmp(argv[i], "-l") == 0) {
412 check_opt(argc, argv, i, 1, "<maximum number of lines>");
413 nb_lines_max = atoi(argv[i+1]);
417 else if(strcmp(argv[i], "-c") == 0) {
418 check_opt(argc, argv, i, 4, "<fg modeline> <bg modeline> <fg highlight> <bg highlight>");
419 color_fg_modeline = atoi(argv[i+1]);
420 color_bg_modeline = atoi(argv[i+2]);
421 color_fg_highlight = atoi(argv[i+3]);
422 color_bg_highlight = atoi(argv[i+4]);
427 cerr << "Selector version " << VERSION
429 << "Written by Francois Fleuret <francois@fleuret.org>"
438 << " [-c <fg modeline> <bg modeline> <fg highlight> <bg highlight>]"
439 << " [-o <output filename>]"
440 << " [-s <pattern separator>]"
441 << " [-l <max number of lines>]"
442 << " -f <input filename>"
444 if(strcmp(argv[i], "-h") == 0) {
452 char **lines = new char *[nb_lines_max];
454 if(!input_filename[0]) {
455 cerr << "You must specify a input file with -f." << endl;
461 ifstream file(input_filename);
464 cerr << "Can not open " << input_filename << endl;
468 int hash_table_size = nb_lines_max * 10;
471 if(remove_duplicates) {
472 hash_table = new_hash_table(hash_table_size);
475 while(nb_lines < nb_lines_max && !file.eof()) {
476 file.getline(buffer, buffer_size);
477 if(strcmp(buffer, "") != 0) {
480 if(zsh_history && *s == ':') {
481 while(*s && *s != ';') s++;
485 if(bash_history && (*s == ' ' || (*s >= '0' && *s <= '9'))) {
486 while(*s == ' ' || (*s >= '0' && *s <= '9')) s++;
489 if(!hash_table || !test_and_add(s, nb_lines, lines, hash_table, hash_table_size)) {
490 lines[nb_lines] = new char[strlen(s) + 1];
491 strcpy(lines[nb_lines], s);
500 for(int i = 0; i < nb_lines/2; i++) {
501 char *s = lines[nb_lines - 1 - i];
502 lines[nb_lines - 1 - i] = lines[i];
507 char patterns[buffer_size];
517 if(color_fg_modeline < 0 || color_fg_modeline >= COLORS ||
518 color_bg_modeline < 0 || color_bg_modeline >= COLORS ||
519 color_fg_highlight < 0 || color_bg_highlight >= COLORS ||
520 color_bg_highlight < 0 || color_bg_highlight >= COLORS) {
524 cerr << "Color numbers have to be between 0 and " << COLORS - 1 << "." << endl;
527 init_pair(1, color_fg_modeline, color_bg_modeline);
528 init_pair(2, color_fg_highlight, color_bg_highlight);
535 curs_set(0); // Hide the cursor
536 keypad(stdscr, TRUE); // So that the arrow keys work
539 int current_line = 0, temporary_line = 0;
541 update_screen(¤t_line, &temporary_line, 0, nb_lines, lines, patterns);
549 if(key >= ' ' && key <= '~') {
550 patterns[patterns_point++] = key;
551 patterns[patterns_point] = '\0';
554 else if(key == KEY_BACKSPACE || key == '
\b' || key == '
\7f' ||
555 key == KEY_DC || key == '
\ 4') {
556 if(patterns_point > 0) {
558 patterns[patterns_point] = '\0';
562 else if(key == KEY_HOME) {
566 else if(key == KEY_END) {
567 current_line = nb_lines - 1;
570 else if(key == KEY_NPAGE) {
574 else if(key == KEY_PPAGE) {
578 else if(key == KEY_UP || key == '
\10') {
582 else if(key == KEY_DOWN || key == '
\ e') {
586 update_screen(¤t_line, &temporary_line, motion,
587 nb_lines, lines, patterns);
589 } while(key != '\n' && key != KEY_ENTER && key != '
\a');
595 if((key == KEY_ENTER || key == '\n')) {
597 if(output_to_vt_buffer) {
598 if(temporary_line >= 0 && temporary_line < nb_lines) {
599 inject_into_tty_buffer(lines[temporary_line]);
603 if(output_filename[0]) {
604 ofstream out(output_filename);
606 cerr << "Can not open " << output_filename << " for writing." << endl;
609 if(temporary_line >= 0 && temporary_line < nb_lines) {
610 out << lines[temporary_line] << endl;
620 for(int l = 0; l < nb_lines; l++) {