2 * selector is a simple shell command for selection of strings with a
3 * dynamic pattern-matching.
5 * Copyright (c) 2009 Francois Fleuret
6 * Written by Francois Fleuret <francois.fleuret@idiap.ch>
8 * This file is part of selector.
10 * selector is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 3 as
12 * published by the Free Software Foundation.
14 * selector is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with selector. If not, see <http://www.gnu.org/licenses/>.
26 Here is the magical shell script for a smart bash-history. Note that
27 the line remains in /tmp/selector.out, which may be a security
30 ./selector -f ~/.bash_history
31 OLD_SETTINGS=`stty -g`
33 writevt `tty` "`cat /tmp/selector.out`"
44 #include <sys/types.h>
47 #include <sys/ioctl.h>
54 int buffer_size = 1024;
55 int nb_lines_max = 1000;
56 char pattern_separator = ';';
57 int output_to_vt_buffer = 0;
59 int match(char *string, int nb_patterns, char **patterns) {
60 for(int n = 0; n < nb_patterns; n++) {
61 if(strstr(string, patterns[n]) == 0) return 0;
66 void check_opt(int argc, char **argv, int n_opt, int n, const char *help) {
67 if(n_opt + n >= argc) {
68 cerr << "Missing argument for " << argv[n_opt] << "."
70 << "Expecting " << help << "."
76 int previous_visible(int current_line, int nb_lines, char **lines, int nb_patterns, char **patterns) {
77 int line = current_line - 1;
78 while(line >= 0 && !match(lines[line], nb_patterns, patterns)) line--;
82 int next_visible(int current_line, int nb_lines, char **lines, int nb_patterns, char **patterns) {
83 int line = current_line + 1;
84 while(line < nb_lines && !match(lines[line], nb_patterns, patterns)) line++;
92 void update_screen(int *current_line, int *temporary_line, int motion,
93 int nb_lines, char **lines,
97 char buffer[buffer_size];
99 // We split the pattern list into individual patterns
103 for(char *s = pattern_list; *s; s++) {
104 if(*s == pattern_separator) {
109 char splitted_patterns[strlen(pattern_list) + 1];
110 char *patterns[nb_patterns];
112 strcpy(splitted_patterns, pattern_list);
115 char *last_pattern_start = splitted_patterns;
116 for(char *s = splitted_patterns; n < nb_patterns; s++) {
117 if(*s == pattern_separator || *s == '\0') {
119 patterns[n++] = last_pattern_start;
120 last_pattern_start = s + 1;
124 // We now take care of printing the lines per se
126 int console_width = getmaxx(stdscr);
127 int console_height = getmaxy(stdscr);
129 int nb_printed_lines = 1;
131 // First, we find a visible line. In priority: The current, or the
132 // first visible after it, or the first visible before it.
135 if(match(lines[*current_line], nb_patterns, patterns)) {
136 new_line = *current_line;
138 new_line = next_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
140 new_line = previous_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
144 // If we found a visible line and we should move, let's move
146 if(new_line >= 0 && motion != 0) {
149 // We want to go down, let's find the first visible line below
150 for(int m = 0; l >= 0 && m < motion; m++) {
151 l = next_visible(l, nb_lines, lines, nb_patterns, patterns);
157 // We want to go up, let's find the first visible line above
158 for(int m = 0; l >= 0 && m < -motion; m++) {
159 l = previous_visible(l, nb_lines, lines, nb_patterns, patterns);
171 use_default_colors();
175 // Here new_line is either a line number matching the patterns, or -1
179 int first_line = new_line, last_line = new_line, nb_match = 1;
181 // We find the first and last line to show, so that the total of
182 // visible lines between them (them include) is console_height - 1
184 while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
188 while(first_line > 0 && !match(lines[first_line], nb_patterns, patterns)) {
191 if(match(lines[first_line], nb_patterns, patterns)) {
196 if(last_line < nb_lines - 1) {
198 while(last_line < nb_lines - 1 && !match(lines[last_line], nb_patterns, patterns)) {
202 if(match(lines[last_line], nb_patterns, patterns)) {
208 // Now we display them
210 for(int l = first_line; l <= last_line; l++) {
211 if(match(lines[l], nb_patterns, patterns)) {
214 while(lines[l][k] && k < buffer_size - 2 && k < console_width - 2) {
215 buffer[k] = lines[l][k];
219 if(no_blink || l == new_line) {
220 while(k < console_width) {
229 attron(COLOR_PAIR(2));
230 addnstr(buffer, console_width);
231 attroff(COLOR_PAIR(2));
233 addnstr(buffer, console_width);
240 *temporary_line = new_line;
242 *current_line = new_line;
246 // if(nb_printed_lines == 1) {
247 // addnstr("[no selection]\n", console_width);
248 // nb_printed_lines++;
251 if(no_blink) { // Erase the rest of the window. That's slightly ugly.
253 while(k < console_width) {
258 for(int l = nb_printed_lines; l < console_height; l++) {
259 addnstr(buffer, console_width);
265 sprintf(buffer, "%d/%d pattern: %s",
266 nb_printed_lines - 1,
270 for(int k = strlen(buffer); k < console_width; k++) buffer[k] = ' ';
271 buffer[console_width] = '\0';
274 attron(COLOR_PAIR(1));
275 addnstr(buffer, console_width);
276 attroff(COLOR_PAIR(1));
278 refresh(); // After doing something on the display, we refresh it
281 //////////////////////////////////////////////////////////////////////
283 int main(int argc, char **argv) {
284 char buffer[buffer_size];
285 char *lines[nb_lines_max];
288 char input_filename[buffer_size], output_filename[buffer_size];
289 strcpy(input_filename, "/dev/stdin");
290 strcpy(output_filename, "/tmp/selector.out");
294 if(strcmp(argv[i], "-o") == 0) {
295 check_opt(argc, argv, i, 1, "<output filename>");
296 strncpy(output_filename, argv[i+1], buffer_size);
300 else if(strcmp(argv[i], "-s") == 0) {
301 check_opt(argc, argv, i, 1, "<pattern separator>");
302 pattern_separator = argv[i+1][0];
306 else if(strcmp(argv[i], "-v") == 0) {
307 output_to_vt_buffer = 1;
311 else if(strcmp(argv[i], "-f") == 0) {
312 check_opt(argc, argv, i, 1, "<input filename>");
313 strncpy(input_filename, argv[i+1], buffer_size);
317 else if(strcmp(argv[i], "-b") == 0) {
322 else if(strcmp(argv[i], "-l") == 0) {
323 check_opt(argc, argv, i, 1, "<maximum number of lines>");
324 nb_lines_max = atoi(argv[i+1]);
329 cerr << argv[0] << " [-h] [-o <output filename>] [-b] [-l <max number of lines>] [-s <pattern separator>] [-v]" << endl;
330 if(strcmp(argv[i], "-h") == 0) {
338 ifstream file(input_filename);
341 cerr << "Can not open \"" << input_filename << "\"" << endl;
346 while(nb_lines < nb_lines_max && !file.eof()) {
347 file.getline(buffer, buffer_size);
348 lines[nb_lines] = new char[strlen(buffer) + 1];
349 strcpy(lines[nb_lines], buffer);
353 char patterns[buffer_size];
361 cerr << "No colors." << endl;
367 keypad(stdscr, TRUE);
370 // init_pair(1, COLOR_WHITE, COLOR_BLACK);
371 init_pair(1, COLOR_WHITE, COLOR_GREEN);
372 init_pair(2, COLOR_BLACK, COLOR_YELLOW);
376 int current_line = 0, temporary_line = 0;
378 update_screen(¤t_line, &temporary_line, 0, nb_lines, lines, patterns, no_blink);
386 if(key >= ' ' && key <= 'z') {
387 patterns[patterns_point++] = key;
388 patterns[patterns_point] = '\0';
391 else if(key == KEY_BACKSPACE || key == KEY_DC || key == '
\b') {
392 if(patterns_point > 0) {
394 patterns[patterns_point] = '\0';
398 else if(key == KEY_HOME) {
402 else if(key == KEY_END) {
403 current_line = nb_lines - 1;
406 else if(key == KEY_NPAGE) {
410 else if(key == KEY_PPAGE) {
414 else if(key == KEY_UP || key == '
\10') {
418 else if(key == KEY_DOWN || key == '
\ e') {
422 update_screen(¤t_line, &temporary_line, motion,
423 nb_lines, lines, patterns, no_blink);
424 } while(key != '\n' && key != KEY_ENTER && key != '
\a');
430 if(output_to_vt_buffer) {
431 if((key == KEY_ENTER || key == '\n') && temporary_line >= 0 && temporary_line < nb_lines) {
432 char *tty = ttyname (STDIN_FILENO);
433 int fd = open(tty, O_WRONLY);
435 struct termios oldtio, newtio;
438 // Save current port settings
439 tcgetattr(fd,&oldtio);
440 bzero(&newtio, sizeof(newtio));
444 // Set input mode (non-canonical, *no echo*,...)
446 tcflush(fd, TCIFLUSH);
447 tcsetattr(fd,TCSANOW, &newtio);
448 for(char *k = lines[temporary_line]; *k; k++) {
449 ioctl(fd, TIOCSTI, k);
451 // Restore the old settings
452 tcsetattr(fd,TCSANOW, &oldtio);
455 cerr << "Can not open " << tty << endl;
461 ofstream out(output_filename);
463 cerr << "Can not open " << output_filename << " for writing." << endl;
466 if((key == KEY_ENTER || key == '\n') && temporary_line >= 0 && temporary_line < nb_lines) {
467 out << lines[temporary_line] << endl;
475 for(int l = 0; l < nb_lines; l++) {