selector.cc

   1
   2 /*
   3  *  selector is a simple shell command for selection of strings with a
   4  *  dynamic pattern-matching.
   5  *
   6  *  Copyright (c) 2009 Francois Fleuret
   7  *  Written by Francois Fleuret <francois@fleuret.org>
   8  *
   9  *  This file is part of selector.
  10  *
  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.
  14  *
  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.
  19  *
  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/>.
  22  *
  23  */
  24
  25 // Here is how to use it as a super-history-search
  26 // ./selector -v -f ${HISTFILE}
  27
  28 // This software is highly Linux-specific, but I would be glad to get
  29 // patches to make it work on other OS
  30
  31 #include <fstream>
  32 #include <iostream>
  33
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <ncurses.h>
  38 #include <fcntl.h>
  39 #include <sys/ioctl.h>
  40 #include <termios.h>
  41
  42 using namespace std;
  43
  44 #define VERSION "1.0"
  45
  46 // Yeah, global variables!
  47
  48 int buffer_size = 1024;
  49 int nb_lines_max = 1000;
  50 char pattern_separator = ';';
  51 int output_to_vt_buffer = 0;
  52
  53 //////////////////////////////////////////////////////////////////////
  54
  55 int match(char *string, int nb_patterns, char **patterns) {
  56   for(int n = 0; n < nb_patterns; n++) {
  57     if(strstr(string, patterns[n]) == 0) return 0;
  58   }
  59   return 1;
  60 }
  61
  62 //////////////////////////////////////////////////////////////////////
  63
  64 void check_opt(int argc, char **argv, int n_opt, int n, const char *help) {
  65   if(n_opt + n >= argc) {
  66     cerr << "Missing argument for " << argv[n_opt] << "."
  67          << " "
  68          << "Expecting " << help << "."
  69          << endl;
  70     exit(1);
  71   }
  72 }
  73
  74 //////////////////////////////////////////////////////////////////////
  75
  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--;
  79   return line;
  80 }
  81
  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++;
  85
  86   if(line < nb_lines)
  87     return line;
  88   else
  89     return -1;
  90 }
  91
  92 void update_screen(int *current_line, int *temporary_line, int motion,
  93                    int nb_lines, char **lines,
  94                    char *pattern_list,
  95                    int no_blink) {
  96
  97   char buffer[buffer_size];
  98
  99   // We split the pattern list into individual patterns
 100
 101   int nb_patterns = 1;
 102
 103   for(char *s = pattern_list; *s; s++) {
 104     if(*s == pattern_separator) {
 105       nb_patterns++;
 106     }
 107   }
 108
 109   char splitted_patterns[strlen(pattern_list) + 1];
 110   char *patterns[nb_patterns];
 111
 112   strcpy(splitted_patterns, pattern_list);
 113
 114   int n = 0;
 115   char *last_pattern_start = splitted_patterns;
 116   for(char *s = splitted_patterns; n < nb_patterns; s++) {
 117     if(*s == pattern_separator || *s == '\0') {
 118       *s = '\0';
 119       patterns[n++] = last_pattern_start;
 120       last_pattern_start = s + 1;
 121     }
 122   }
 123
 124   // We now take care of printing the lines per se
 125
 126   int console_width = getmaxx(stdscr);
 127   int console_height = getmaxy(stdscr);
 128
 129   int nb_printed_lines = 1;
 130
 131   // First, we find a visible line. In priority: The current, or the
 132   // first visible after it, or the first visible before it.
 133
 134   int new_line;
 135   if(match(lines[*current_line], nb_patterns, patterns)) {
 136     new_line = *current_line;
 137   } else {
 138     new_line = next_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
 139     if(new_line < 0) {
 140       new_line = previous_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
 141     }
 142   }
 143
 144   // If we found a visible line and we should move, let's move
 145
 146   if(new_line >= 0 && motion != 0) {
 147     int l = new_line;
 148     if(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);
 152         if(l >= 0) {
 153           new_line = l;
 154         }
 155       }
 156     } else {
 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);
 160         if(l >= 0) {
 161           new_line = l;
 162         }
 163       }
 164     }
 165   }
 166
 167   if(!no_blink) {
 168     clear();
 169   }
 170
 171   use_default_colors();
 172
 173   addstr("\n");
 174
 175   // Here new_line is either a line number matching the patterns, or -1
 176
 177   if(new_line >= 0) {
 178
 179     int first_line = new_line, last_line = new_line, nb_match = 1;
 180
 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
 183
 184     while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
 185
 186       if(first_line > 0) {
 187         first_line--;
 188         while(first_line > 0 && !match(lines[first_line], nb_patterns, patterns)) {
 189           first_line--;
 190         }
 191         if(match(lines[first_line], nb_patterns, patterns)) {
 192           nb_match++;
 193         }
 194       }
 195
 196       if(last_line < nb_lines - 1) {
 197         last_line++;
 198         while(last_line < nb_lines - 1 && !match(lines[last_line], nb_patterns, patterns)) {
 199           last_line++;
 200         }
 201
 202         if(match(lines[last_line], nb_patterns, patterns)) {
 203           nb_match++;
 204         }
 205       }
 206     }
 207
 208     // Now we display them
 209
 210     for(int l = first_line; l <= last_line; l++) {
 211       if(match(lines[l], nb_patterns, patterns)) {
 212         int k = 0;
 213
 214         while(lines[l][k] && k < buffer_size - 2 && k < console_width - 2) {
 215           buffer[k] = lines[l][k];
 216           k++;
 217         }
 218
 219         // We fill the rest of the line with blanks if either we did
 220         // not clear() or if this is the highlighted line
 221
 222         if(no_blink || l == new_line) {
 223           while(k < console_width) {
 224             buffer[k++] = ' ';
 225           }
 226         }
 227
 228         buffer[k++] = '\n';
 229         buffer[k++] = '\0';
 230
 231         // Highlight the highlighted line ...
 232
 233         if(l == new_line) {
 234           attron(COLOR_PAIR(2));
 235           addnstr(buffer, console_width);
 236           attroff(COLOR_PAIR(2));
 237         } else {
 238           addnstr(buffer, console_width);
 239         }
 240
 241         nb_printed_lines++;
 242       }
 243     }
 244
 245     *temporary_line = new_line;
 246     if(motion != 0) {
 247       *current_line = new_line;
 248     }
 249   }
 250
 251   if(nb_printed_lines == 1) {
 252     addnstr("[no selection]\n", console_width);
 253     nb_printed_lines++;
 254   }
 255
 256   if(no_blink) { // Erase the rest of the window. That's slightly ugly.
 257     int k = 0;
 258     while(k < console_width) {
 259       buffer[k++] = ' ';
 260     }
 261     buffer[k++] = '\n';
 262     buffer[k++] = '\0';
 263     for(int l = nb_printed_lines; l < console_height; l++) {
 264       addnstr(buffer, console_width);
 265     }
 266   }
 267
 268   // Draw the modeline
 269
 270   sprintf(buffer, "%d/%d pattern: %s",
 271           nb_printed_lines - 1,
 272           nb_lines,
 273           pattern_list);
 274
 275   for(int k = strlen(buffer); k < console_width; k++) buffer[k] = ' ';
 276   buffer[console_width] = '\0';
 277
 278   move(0, 0);
 279   attron(COLOR_PAIR(1));
 280   addnstr(buffer, console_width);
 281   attroff(COLOR_PAIR(1));
 282
 283   // We are done
 284
 285   refresh();
 286 }
 287
 288 //////////////////////////////////////////////////////////////////////
 289
 290 int main(int argc, char **argv) {
 291   char buffer[buffer_size];
 292   char *lines[nb_lines_max];
 293   int no_blink = 0;
 294
 295   char input_filename[buffer_size], output_filename[buffer_size];
 296   strcpy(input_filename, "");
 297   strcpy(output_filename, "/tmp/selector.out");
 298
 299   int i = 1;
 300   while(i < argc) {
 301     if(strcmp(argv[i], "-o") == 0) {
 302       check_opt(argc, argv, i, 1, "<output filename>");
 303       strncpy(output_filename, argv[i+1], buffer_size);
 304       i += 2;
 305     }
 306
 307     else if(strcmp(argv[i], "-s") == 0) {
 308       check_opt(argc, argv, i, 1, "<pattern separator>");
 309       pattern_separator = argv[i+1][0];
 310       i += 2;
 311     }
 312
 313     else if(strcmp(argv[i], "-v") == 0) {
 314       output_to_vt_buffer = 1;
 315       i++;
 316     }
 317
 318     else if(strcmp(argv[i], "-f") == 0) {
 319       check_opt(argc, argv, i, 1, "<input filename>");
 320       strncpy(input_filename, argv[i+1], buffer_size);
 321       i += 2;
 322     }
 323
 324     else if(strcmp(argv[i], "-b") == 0) {
 325       no_blink = 1;
 326       i++;
 327     }
 328
 329     else if(strcmp(argv[i], "-l") == 0) {
 330       check_opt(argc, argv, i, 1, "<maximum number of lines>");
 331       nb_lines_max = atoi(argv[i+1]);
 332       i += 2;
 333     }
 334
 335     else {
 336       cerr << "Selector version " << VERSION
 337            << endl
 338            << "Written by Francois Fleuret <francois@fleuret.org>"
 339            << endl
 340            << argv[0]
 341            << " [-h]"
 342            << " [-b]"
 343            << " [-v]"
 344            << " [-o <output filename>]"
 345            << " [-s <pattern separator>]"
 346            << " [-l <max number of lines>]"
 347            << " -f <input filename>"
 348            << endl;
 349       if(strcmp(argv[i], "-h") == 0) {
 350         exit(0);
 351       } else {
 352         exit(1);
 353       }
 354     }
 355   }
 356
 357   if(!input_filename[0]) {
 358     cerr << "You must specify a input file with -f." << endl;
 359     exit(1);
 360   }
 361
 362   ifstream file(input_filename);
 363
 364   if(file.fail()) {
 365     cerr << "Can not open " << input_filename << endl;
 366     return 1;
 367   }
 368
 369   int nb_lines = 0;
 370   while(nb_lines < nb_lines_max && !file.eof()) {
 371     file.getline(buffer, buffer_size);
 372     lines[nb_lines] = new char[strlen(buffer) + 1];
 373     strcpy(lines[nb_lines], buffer);
 374     nb_lines++;
 375   }
 376
 377   char patterns[buffer_size];
 378   patterns[0] = '\0';
 379   int patterns_point;
 380   patterns_point = 0;
 381
 382   initscr();
 383
 384   if(!has_colors()) {
 385     cerr << "No colors." << endl;
 386     return 1;
 387   }
 388
 389   noecho();
 390   curs_set(0);
 391   keypad(stdscr, TRUE);
 392
 393   start_color();
 394   // init_pair(1, COLOR_WHITE, COLOR_BLACK);
 395   init_pair(1, COLOR_WHITE, COLOR_GREEN);
 396   init_pair(2, COLOR_BLACK, COLOR_YELLOW);
 397
 398   int key;
 399
 400   int current_line = 0, temporary_line = 0;
 401
 402   update_screen(&current_line, &temporary_line, 0, nb_lines, lines, patterns, no_blink);
 403
 404   do {
 405
 406     key = getch();
 407
 408     int motion = 0;
 409
 410     if(key >= ' ' && key <= 'z') {
 411       patterns[patterns_point++] = key;
 412       patterns[patterns_point] = '\0';
 413     }
 414
 415     else if(key == KEY_BACKSPACE || key == KEY_DC || key == '\b') {
 416       if(patterns_point > 0) {
 417         patterns_point--;
 418         patterns[patterns_point] = '\0';
 419       }
 420     }
 421
 422     else if(key == KEY_HOME) {
 423       current_line = 0;
 424     }
 425
 426     else if(key == KEY_END) {
 427       current_line = nb_lines - 1;
 428     }
 429
 430     else if(key == KEY_NPAGE) {
 431       motion = 10;
 432     }
 433
 434     else if(key == KEY_PPAGE) {
 435       motion = -10;
 436     }
 437
 438     else if(key == KEY_UP || key == '\10') {
 439       motion = -1;
 440     }
 441
 442     else if(key == KEY_DOWN || key == '\ e') {
 443       motion = 1;
 444     }
 445
 446     update_screen(&current_line, &temporary_line, motion,
 447                   nb_lines, lines, patterns, no_blink);
 448   } while(key != '\n' && key != KEY_ENTER && key != '\a');
 449
 450   echo();
 451   curs_set(1);
 452   endwin();
 453
 454   if((key == KEY_ENTER || key == '\n') && temporary_line >= 0 && temporary_line < nb_lines) {
 455     if(output_to_vt_buffer) {
 456       char *tty = ttyname (STDIN_FILENO);
 457       int fd = open(tty, O_WRONLY);
 458
 459       struct termios oldtio, newtio;
 460
 461       if (fd >= 0) {
 462         // Save current port settings
 463         tcgetattr(fd,&oldtio);
 464         bzero(&newtio, sizeof(newtio));
 465         // Set input mode (non-canonical, *no echo*,...)
 466         tcflush(fd, TCIFLUSH);
 467         tcsetattr(fd,TCSANOW, &newtio);
 468         // Put the selected line in the tty input buffer
 469         for(char *k = lines[temporary_line]; *k; k++) {
 470           ioctl(fd, TIOCSTI, k);
 471         }
 472         // Restore the old settings
 473         tcsetattr(fd,TCSANOW, &oldtio);
 474         close(fd);
 475       } else {
 476         cerr << "Can not open " << tty << "." << endl;
 477         exit(1);
 478       }
 479     } else {
 480       ofstream out(output_filename);
 481       if(out.fail()) {
 482         cerr << "Can not open " << output_filename << " for writing." << endl;
 483         exit(1);
 484       } else {
 485         out << lines[temporary_line] << endl;
 486       }
 487       out.flush();
 488     }
 489   }
 490
 491   for(int l = 0; l < nb_lines; l++) {
 492     delete[] lines[l];
 493   }
 494
 495   exit(0);
 496 }