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:
26 // ./selector -v -f ${HISTFILE}
28 // This software is highly Linux-specific, but I would be glad to get
29 // patches to make it work on other OS
39 #include <sys/ioctl.h>
46 // Yeah, global variables!
48 int buffer_size = 1024;
49 int nb_lines_max = 10000;
50 char pattern_separator = ';';
51 int output_to_vt_buffer = 0;
55 //////////////////////////////////////////////////////////////////////
57 // This looks severely Linux-only ...
59 void inject_into_tty_buffer(char *line) {
60 char *tty = ttyname(STDIN_FILENO);
61 int fd = open(tty, O_WRONLY);
63 struct termios oldtio, newtio;
66 // Save current port settings
67 tcgetattr(fd,&oldtio);
68 memset(&newtio, 0, sizeof(newtio));
69 // Set input mode (non-canonical, *no echo*,...)
70 tcflush(fd, TCIFLUSH);
71 tcsetattr(fd,TCSANOW, &newtio);
72 // Put the selected line in the tty input buffer
73 for(char *k = line; *k; k++) {
74 ioctl(fd, TIOCSTI, k);
76 // Restore the old settings
77 tcsetattr(fd,TCSANOW, &oldtio);
80 cerr << "Can not open " << tty << "." << endl;
85 //////////////////////////////////////////////////////////////////////
87 int match(char *string, int nb_patterns, char **patterns) {
88 for(int n = 0; n < nb_patterns; n++) {
89 if(strstr(string, patterns[n]) == 0) return 0;
94 //////////////////////////////////////////////////////////////////////
96 void check_opt(int argc, char **argv, int n_opt, int n, const char *help) {
97 if(n_opt + n >= argc) {
98 cerr << "Missing argument for " << argv[n_opt] << "."
100 << "Expecting " << help << "."
106 //////////////////////////////////////////////////////////////////////
108 int previous_visible(int current_line, int nb_lines, char **lines, int nb_patterns, char **patterns) {
109 int line = current_line - 1;
110 while(line >= 0 && !match(lines[line], nb_patterns, patterns)) line--;
114 int next_visible(int current_line, int nb_lines, char **lines, int nb_patterns, char **patterns) {
115 int line = current_line + 1;
116 while(line < nb_lines && !match(lines[line], nb_patterns, patterns)) line++;
124 void update_screen(int *current_line, int *temporary_line, int motion,
125 int nb_lines, char **lines,
129 char buffer[buffer_size];
131 // We split the pattern list into individual patterns
135 for(char *s = pattern_list; *s; s++) {
136 if(*s == pattern_separator) {
141 char splitted_patterns[strlen(pattern_list) + 1];
142 char *patterns[nb_patterns];
144 strcpy(splitted_patterns, pattern_list);
147 char *last_pattern_start = splitted_patterns;
148 for(char *s = splitted_patterns; n < nb_patterns; s++) {
149 if(*s == pattern_separator || *s == '\0') {
151 patterns[n++] = last_pattern_start;
152 last_pattern_start = s + 1;
156 // We now take care of printing the lines per se
158 int console_width = getmaxx(stdscr);
159 int console_height = getmaxy(stdscr);
161 // First, we find a visible line. In priority: The current, or the
162 // first visible after it, or the first visible before it.
165 if(match(lines[*current_line], nb_patterns, patterns)) {
166 new_line = *current_line;
168 new_line = next_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
170 new_line = previous_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
174 // If we found a visible line and we should move, let's move
176 if(new_line >= 0 && motion != 0) {
179 // We want to go down, let's find the first visible line below
180 for(int m = 0; l >= 0 && m < motion; m++) {
181 l = next_visible(l, nb_lines, lines, nb_patterns, patterns);
187 // We want to go up, let's find the first visible line above
188 for(int m = 0; l >= 0 && m < -motion; m++) {
189 l = previous_visible(l, nb_lines, lines, nb_patterns, patterns);
201 use_default_colors();
205 int nb_printed_lines = 1;
207 // Here new_line is either a line number matching the patterns, or -1
211 int first_line = new_line, last_line = new_line, nb_match = 1;
213 // We find the first and last line to show, so that the total of
214 // visible lines between them (them include) is console_height - 1
216 while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
220 while(first_line > 0 && !match(lines[first_line], nb_patterns, patterns)) {
223 if(match(lines[first_line], nb_patterns, patterns)) {
228 if(last_line < nb_lines - 1) {
230 while(last_line < nb_lines - 1 && !match(lines[last_line], nb_patterns, patterns)) {
234 if(match(lines[last_line], nb_patterns, patterns)) {
240 // Now we display them
242 for(int l = first_line; l <= last_line; l++) {
243 if(match(lines[l], nb_patterns, patterns)) {
246 while(lines[l][k] && k < buffer_size - 2 && k < console_width - 2) {
247 buffer[k] = lines[l][k];
251 // We fill the rest of the line with blanks if either we did
252 // not clear() or if this is the highlighted line
254 if(no_blink || l == new_line) {
255 while(k < console_width) {
263 // Highlight the highlighted line ...
267 attron(COLOR_PAIR(2));
268 addnstr(buffer, console_width);
269 attroff(COLOR_PAIR(2));
272 addnstr(buffer, console_width);
276 addnstr(buffer, console_width);
284 *current_line = new_line;
288 *temporary_line = new_line;
290 if(nb_printed_lines == 1) {
291 addnstr("[no selection]\n", console_width);
295 if(no_blink) { // Erase the rest of the window. That's slightly ugly.
297 while(k < console_width) {
302 for(int l = nb_printed_lines; l < console_height; l++) {
303 addnstr(buffer, console_width);
309 sprintf(buffer, "%d/%d pattern: %s",
310 nb_printed_lines - 1,
314 for(int k = strlen(buffer); k < console_width; k++) buffer[k] = ' ';
315 buffer[console_width] = '\0';
319 attron(COLOR_PAIR(1));
320 addnstr(buffer, console_width);
321 attroff(COLOR_PAIR(1));
324 addnstr(buffer, console_width);
333 //////////////////////////////////////////////////////////////////////
335 int main(int argc, char **argv) {
336 char buffer[buffer_size];
337 char *lines[nb_lines_max];
339 int color_fg_modeline, color_bg_modeline;
340 int color_fg_highlight, color_bg_highlight;
342 color_fg_modeline = COLOR_WHITE;
343 color_bg_modeline = COLOR_BLACK;
344 color_fg_highlight = COLOR_BLACK;
345 color_bg_highlight = COLOR_YELLOW;
347 setlocale(LC_ALL, "");
349 char input_filename[buffer_size], output_filename[buffer_size];
350 strcpy(input_filename, "");
351 strcpy(output_filename, "/tmp/selector.out");
355 if(strcmp(argv[i], "-o") == 0) {
356 check_opt(argc, argv, i, 1, "<output filename>");
357 strncpy(output_filename, argv[i+1], buffer_size);
361 else if(strcmp(argv[i], "-s") == 0) {
362 check_opt(argc, argv, i, 1, "<pattern separator>");
363 pattern_separator = argv[i+1][0];
367 else if(strcmp(argv[i], "-v") == 0) {
368 output_to_vt_buffer = 1;
372 else if(strcmp(argv[i], "-m") == 0) {
377 else if(strcmp(argv[i], "-f") == 0) {
378 check_opt(argc, argv, i, 1, "<input filename>");
379 strncpy(input_filename, argv[i+1], buffer_size);
383 else if(strcmp(argv[i], "-b") == 0) {
388 else if(strcmp(argv[i], "-z") == 0) {
393 else if(strcmp(argv[i], "-l") == 0) {
394 check_opt(argc, argv, i, 1, "<maximum number of lines>");
395 nb_lines_max = atoi(argv[i+1]);
399 else if(strcmp(argv[i], "-c") == 0) {
400 check_opt(argc, argv, i, 4, "<fg modeline> <bg modeline> <fg highlight> <bg highlight>");
401 color_fg_modeline = atoi(argv[i+1]);
402 color_bg_modeline = atoi(argv[i+2]);
403 color_fg_highlight = atoi(argv[i+3]);
404 color_bg_highlight = atoi(argv[i+4]);
409 cerr << "Selector version " << VERSION
411 << "Written by Francois Fleuret <francois@fleuret.org>"
418 << " [-c <fg modeline> <bg modeline> <fg highlight> <bg highlight>]"
419 << " [-o <output filename>]"
420 << " [-s <pattern separator>]"
421 << " [-l <max number of lines>]"
422 << " -f <input filename>"
424 if(strcmp(argv[i], "-h") == 0) {
432 if(!input_filename[0]) {
433 cerr << "You must specify a input file with -f." << endl;
437 ifstream file(input_filename);
440 cerr << "Can not open " << input_filename << endl;
445 while(nb_lines < nb_lines_max && !file.eof()) {
446 file.getline(buffer, buffer_size);
448 if(zsh_history && *s == ':') {
450 while(*s && *s != ':') s++;
452 lines[nb_lines] = new char[strlen(s) + 1];
453 strcpy(lines[nb_lines], s);
457 char patterns[buffer_size];
467 if(color_fg_modeline < 0 || color_fg_modeline >= COLORS ||
468 color_bg_modeline < 0 || color_bg_modeline >= COLORS ||
469 color_fg_highlight < 0 || color_bg_highlight >= COLORS ||
470 color_bg_highlight < 0 || color_bg_highlight >= COLORS) {
474 cerr << "Color numbers have to be between 0 and " << COLORS - 1 << "." << endl;
477 init_pair(1, color_fg_modeline, color_bg_modeline);
478 init_pair(2, color_fg_highlight, color_bg_highlight);
485 curs_set(0); // Hide the cursor
486 keypad(stdscr, TRUE); // So that the arrow keys work
489 int current_line = 0, temporary_line = 0;
491 update_screen(¤t_line, &temporary_line, 0, nb_lines, lines, patterns, no_blink);
499 if(key >= ' ' && key <= '~') {
500 patterns[patterns_point++] = key;
501 patterns[patterns_point] = '\0';
504 else if(key == KEY_BACKSPACE || key == KEY_DC || key == '
\b') {
505 if(patterns_point > 0) {
507 patterns[patterns_point] = '\0';
511 else if(key == KEY_HOME) {
515 else if(key == KEY_END) {
516 current_line = nb_lines - 1;
519 else if(key == KEY_NPAGE) {
523 else if(key == KEY_PPAGE) {
527 else if(key == KEY_UP || key == '
\10') {
531 else if(key == KEY_DOWN || key == '
\ e') {
535 update_screen(¤t_line, &temporary_line, motion,
536 nb_lines, lines, patterns, no_blink);
538 } while(key != '\n' && key != KEY_ENTER && key != '
\a');
544 if((key == KEY_ENTER || key == '\n')) {
545 if(output_to_vt_buffer) {
546 if(temporary_line >= 0 && temporary_line < nb_lines) {
547 inject_into_tty_buffer(lines[temporary_line]);
550 ofstream out(output_filename);
552 cerr << "Can not open " << output_filename << " for writing." << endl;
555 if(temporary_line >= 0 && temporary_line < nb_lines) {
556 out << lines[temporary_line] << endl;
565 for(int l = 0; l < nb_lines; l++) {