-///////////////////////////////////////////////////////////////////////////
-// START_IP_HEADER //
-// //
-// This program is free software: you can redistribute it and/or modify //
-// it under the terms of the version 3 of the GNU General Public License //
-// as published by the Free Software Foundation. //
-// //
-// This program is distributed in the hope that it will be useful, but //
-// WITHOUT ANY WARRANTY; without even the implied warranty of //
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU //
-// General Public License for more details. //
-// //
-// You should have received a copy of the GNU General Public License //
-// along with this program. If not, see <http://www.gnu.org/licenses/>. //
-// //
-// Written by and Copyright (C) Francois Fleuret //
-// Contact <francois.fleuret@idiap.ch> for comments & bug reports //
-// //
-// END_IP_HEADER //
-///////////////////////////////////////////////////////////////////////////
+/*
+ * selector is a simple shell command for selection of strings with a
+ * dynamic pattern-matching.
+ *
+ * Copyright (c) 2009 Francois Fleuret
+ * Written by Francois Fleuret <francois@fleuret.org>
+ *
+ * This file is part of selector.
+ *
+ * selector is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * selector is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with selector. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+// To use it as a super-history-search:
+// ./selector -v -f ${HISTFILE}
+
+// This software is highly Linux-specific, but I would be glad to get
+// patches to make it work on other OS
-#include <stdio.h>
-#include <ncurses.h>
-#include <iostream>
#include <fstream>
+#include <iostream>
+
+#include <stdio.h>
+#include <stdlib.h>
#include <string.h>
+#include <ncurses.h>
+#include <fcntl.h>
+#include <sys/ioctl.h>
+#include <termios.h>
using namespace std;
-const int buffer_size = 1024;
-const int nb_lines_max = 100000;
+#define VERSION "1.0"
+
+// Yeah, global variables!
+
+int buffer_size = 1024;
+int nb_lines_max = 10000;
+char pattern_separator = ';';
+int output_to_vt_buffer = 0;
+int with_colors = 1;
+int zsh_history = 0;
+
+//////////////////////////////////////////////////////////////////////
+
+// This looks severely Linux-only ...
+
+void inject_into_tty_buffer(char *line) {
+ char *tty = ttyname(STDIN_FILENO);
+ int fd = open(tty, O_WRONLY);
+
+ struct termios oldtio, newtio;
+
+ if (fd >= 0) {
+ // Save current port settings
+ tcgetattr(fd,&oldtio);
+ memset(&newtio, 0, sizeof(newtio));
+ // Set input mode (non-canonical, *no echo*,...)
+ tcflush(fd, TCIFLUSH);
+ tcsetattr(fd,TCSANOW, &newtio);
+ // Put the selected line in the tty input buffer
+ for(char *k = line; *k; k++) {
+ ioctl(fd, TIOCSTI, k);
+ }
+ // Restore the old settings
+ tcsetattr(fd,TCSANOW, &oldtio);
+ close(fd);
+ } else {
+ cerr << "Can not open " << tty << "." << endl;
+ exit(1);
+ }
+}
+
+//////////////////////////////////////////////////////////////////////
+
+int match(char *string, int nb_patterns, char **patterns) {
+ for(int n = 0; n < nb_patterns; n++) {
+ if(strstr(string, patterns[n]) == 0) return 0;
+ }
+ return 1;
+}
+
+//////////////////////////////////////////////////////////////////////
+
+void check_opt(int argc, char **argv, int n_opt, int n, const char *help) {
+ if(n_opt + n >= argc) {
+ cerr << "Missing argument for " << argv[n_opt] << "."
+ << " "
+ << "Expecting " << help << "."
+ << endl;
+ exit(1);
+ }
+}
+
+//////////////////////////////////////////////////////////////////////
+
+int previous_visible(int current_line, int nb_lines, char **lines, int nb_patterns, char **patterns) {
+ int line = current_line - 1;
+ while(line >= 0 && !match(lines[line], nb_patterns, patterns)) line--;
+ return line;
+}
+
+int next_visible(int current_line, int nb_lines, char **lines, int nb_patterns, char **patterns) {
+ int line = current_line + 1;
+ while(line < nb_lines && !match(lines[line], nb_patterns, patterns)) line++;
+
+ if(line < nb_lines)
+ return line;
+ else
+ return -1;
+}
+
+void update_screen(int *current_line, int *temporary_line, int motion,
+ int nb_lines, char **lines,
+ char *pattern_list,
+ int no_blink) {
-void build_display(int line, int nb_lines, char **lines, char *regexp) {
char buffer[buffer_size];
- int maxx = getmaxx(stdscr);
- int maxy = getmaxy(stdscr);
+ // We split the pattern list into individual patterns
+
+ int nb_patterns = 1;
- clear(); // Cleaning the window
- refresh(); // After doing something on the display, we refresh it
+ for(char *s = pattern_list; *s; s++) {
+ if(*s == pattern_separator) {
+ nb_patterns++;
+ }
+ }
+
+ char splitted_patterns[strlen(pattern_list) + 1];
+ char *patterns[nb_patterns];
+
+ strcpy(splitted_patterns, pattern_list);
+
+ int n = 0;
+ char *last_pattern_start = splitted_patterns;
+ for(char *s = splitted_patterns; n < nb_patterns; s++) {
+ if(*s == pattern_separator || *s == '\0') {
+ *s = '\0';
+ patterns[n++] = last_pattern_start;
+ last_pattern_start = s + 1;
+ }
+ }
+
+ // We now take care of printing the lines per se
+
+ int console_width = getmaxx(stdscr);
+ int console_height = getmaxy(stdscr);
+
+ // First, we find a visible line. In priority: The current, or the
+ // first visible after it, or the first visible before it.
+
+ int new_line;
+ if(match(lines[*current_line], nb_patterns, patterns)) {
+ new_line = *current_line;
+ } else {
+ new_line = next_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
+ if(new_line < 0) {
+ new_line = previous_visible(*current_line, nb_lines, lines, nb_patterns, patterns);
+ }
+ }
+
+ // If we found a visible line and we should move, let's move
+
+ if(new_line >= 0 && motion != 0) {
+ int l = new_line;
+ if(motion > 0) {
+ // We want to go down, let's find the first visible line below
+ for(int m = 0; l >= 0 && m < motion; m++) {
+ l = next_visible(l, nb_lines, lines, nb_patterns, patterns);
+ if(l >= 0) {
+ new_line = l;
+ }
+ }
+ } else {
+ // We want to go up, let's find the first visible line above
+ for(int m = 0; l >= 0 && m < -motion; m++) {
+ l = previous_visible(l, nb_lines, lines, nb_patterns, patterns);
+ if(l >= 0) {
+ new_line = l;
+ }
+ }
+ }
+ }
+
+ if(!no_blink) {
+ clear();
+ }
use_default_colors();
- printw("\n");
- printw("\n");
+ addstr("\n");
+
+ int nb_printed_lines = 1;
+
+ // Here new_line is either a line number matching the patterns, or -1
+
+ if(new_line >= 0) {
+
+ int first_line = new_line, last_line = new_line, nb_match = 1;
+
+ // We find the first and last line to show, so that the total of
+ // visible lines between them (them include) is console_height - 1
+
+ while(nb_match < console_height-1 && (first_line > 0 || last_line < nb_lines - 1)) {
+
+ if(first_line > 0) {
+ first_line--;
+ while(first_line > 0 && !match(lines[first_line], nb_patterns, patterns)) {
+ first_line--;
+ }
+ if(match(lines[first_line], nb_patterns, patterns)) {
+ nb_match++;
+ }
+ }
+
+ if(last_line < nb_lines - 1) {
+ last_line++;
+ while(last_line < nb_lines - 1 && !match(lines[last_line], nb_patterns, patterns)) {
+ last_line++;
+ }
- int nb_printed_lines = 2;
- for(int y = 0; nb_printed_lines < maxy && y < nb_lines; y++) {
- if(strstr(lines[y], regexp)) {
- int k = 0;
- while(lines[y][k] && k < buffer_size - 2 && k < maxx) {
- buffer[k] = lines[y][k];
- k++;
+ if(match(lines[last_line], nb_patterns, patterns)) {
+ nb_match++;
+ }
}
- buffer[k++] = '\n';
- buffer[k++] = '\0';
- printw(buffer);
- nb_printed_lines++;
+ }
+
+ // Now we display them
+
+ for(int l = first_line; l <= last_line; l++) {
+ if(match(lines[l], nb_patterns, patterns)) {
+ int k = 0;
+
+ while(lines[l][k] && k < buffer_size - 2 && k < console_width - 2) {
+ buffer[k] = lines[l][k];
+ k++;
+ }
+
+ // We fill the rest of the line with blanks if either we did
+ // not clear() or if this is the highlighted line
+
+ if(no_blink || l == new_line) {
+ while(k < console_width) {
+ buffer[k++] = ' ';
+ }
+ }
+
+ buffer[k++] = '\n';
+ buffer[k++] = '\0';
+
+ // Highlight the highlighted line ...
+
+ if(l == new_line) {
+ if(with_colors) {
+ attron(COLOR_PAIR(2));
+ addnstr(buffer, console_width);
+ attroff(COLOR_PAIR(2));
+ } else {
+ attron(A_STANDOUT);
+ addnstr(buffer, console_width);
+ attroff(A_STANDOUT);
+ }
+ } else {
+ addnstr(buffer, console_width);
+ }
+
+ nb_printed_lines++;
+ }
+ }
+
+ if(motion != 0) {
+ *current_line = new_line;
+ }
+ }
+
+ *temporary_line = new_line;
+
+ if(nb_printed_lines == 1) {
+ addnstr("[no selection]\n", console_width);
+ nb_printed_lines++;
+ }
+
+ if(no_blink) { // Erase the rest of the window. That's slightly ugly.
+ int k = 0;
+ while(k < console_width) {
+ buffer[k++] = ' ';
+ }
+ buffer[k++] = '\n';
+ buffer[k++] = '\0';
+ for(int l = nb_printed_lines; l < console_height; l++) {
+ addnstr(buffer, console_width);
}
}
// Draw the modeline
+ sprintf(buffer, "%d/%d pattern: %s",
+ nb_printed_lines - 1,
+ nb_lines,
+ pattern_list);
+
+ for(int k = strlen(buffer); k < console_width; k++) buffer[k] = ' ';
+ buffer[console_width] = '\0';
+
move(0, 0);
- attron(COLOR_PAIR(1)); // Let's print something in red on black
- printw("%d/%d pattern: %s\n", nb_printed_lines, nb_lines - 2, regexp);
- attroff(COLOR_PAIR(1)); // Let's get back to default colors!
+ if(with_colors) {
+ attron(COLOR_PAIR(1));
+ addnstr(buffer, console_width);
+ attroff(COLOR_PAIR(1));
+ } else {
+ attron(A_REVERSE);
+ addnstr(buffer, console_width);
+ attroff(A_REVERSE);
+ }
+
+ // We are done
+
+ refresh();
}
-int main(int argc, char **argv) {
- int dummy, xpos, ypos;
+//////////////////////////////////////////////////////////////////////
+int main(int argc, char **argv) {
char buffer[buffer_size];
char *lines[nb_lines_max];
+ int no_blink = 0;
+ int color_fg_modeline, color_bg_modeline;
+ int color_fg_highlight, color_bg_highlight;
- ifstream file(argv[1]);
+ color_fg_modeline = COLOR_WHITE;
+ color_bg_modeline = COLOR_BLACK;
+ color_fg_highlight = COLOR_BLACK;
+ color_bg_highlight = COLOR_YELLOW;
- if(argc != 2) {
- cerr << argv[0] << " <file>" << endl;
- return 1;
+ setlocale(LC_ALL, "");
+
+ char input_filename[buffer_size], output_filename[buffer_size];
+ strcpy(input_filename, "");
+ strcpy(output_filename, "/tmp/selector.out");
+
+ int i = 1;
+ while(i < argc) {
+ if(strcmp(argv[i], "-o") == 0) {
+ check_opt(argc, argv, i, 1, "<output filename>");
+ strncpy(output_filename, argv[i+1], buffer_size);
+ i += 2;
+ }
+
+ else if(strcmp(argv[i], "-s") == 0) {
+ check_opt(argc, argv, i, 1, "<pattern separator>");
+ pattern_separator = argv[i+1][0];
+ i += 2;
+ }
+
+ else if(strcmp(argv[i], "-v") == 0) {
+ output_to_vt_buffer = 1;
+ i++;
+ }
+
+ else if(strcmp(argv[i], "-m") == 0) {
+ with_colors = 0;
+ i++;
+ }
+
+ else if(strcmp(argv[i], "-f") == 0) {
+ check_opt(argc, argv, i, 1, "<input filename>");
+ strncpy(input_filename, argv[i+1], buffer_size);
+ i += 2;
+ }
+
+ else if(strcmp(argv[i], "-b") == 0) {
+ no_blink = 1;
+ i++;
+ }
+
+ else if(strcmp(argv[i], "-z") == 0) {
+ zsh_history = 1;
+ i++;
+ }
+
+ else if(strcmp(argv[i], "-l") == 0) {
+ check_opt(argc, argv, i, 1, "<maximum number of lines>");
+ nb_lines_max = atoi(argv[i+1]);
+ i += 2;
+ }
+
+ else if(strcmp(argv[i], "-c") == 0) {
+ check_opt(argc, argv, i, 4, "<fg modeline> <bg modeline> <fg highlight> <bg highlight>");
+ color_fg_modeline = atoi(argv[i+1]);
+ color_bg_modeline = atoi(argv[i+2]);
+ color_fg_highlight = atoi(argv[i+3]);
+ color_bg_highlight = atoi(argv[i+4]);
+ i += 5;
+ }
+
+ else {
+ cerr << "Selector version " << VERSION
+ << endl
+ << "Written by Francois Fleuret <francois@fleuret.org>"
+ << endl
+ << argv[0]
+ << " [-h]"
+ << " [-v]"
+ << " [-m]"
+ << " [-z]"
+ << " [-c <fg modeline> <bg modeline> <fg highlight> <bg highlight>]"
+ << " [-o <output filename>]"
+ << " [-s <pattern separator>]"
+ << " [-l <max number of lines>]"
+ << " -f <input filename>"
+ << endl;
+ if(strcmp(argv[i], "-h") == 0) {
+ exit(0);
+ } else {
+ exit(1);
+ }
+ }
+ }
+
+ if(!input_filename[0]) {
+ cerr << "You must specify a input file with -f." << endl;
+ exit(1);
}
+ ifstream file(input_filename);
+
if(file.fail()) {
- cerr << "Can not open \""
- << argv[1]
- << "\""
- << endl;
+ cerr << "Can not open " << input_filename << endl;
return 1;
}
int nb_lines = 0;
while(nb_lines < nb_lines_max && !file.eof()) {
file.getline(buffer, buffer_size);
- lines[nb_lines] = new char[strlen(buffer) + 1];
- strcpy(lines[nb_lines], buffer);
+ char *s = buffer;
+ if(zsh_history && *s == ':') {
+ s++;
+ while(*s && *s != ';') s++;
+ if(*s == ';') s++;
+ }
+ lines[nb_lines] = new char[strlen(s) + 1];
+ strcpy(lines[nb_lines], s);
nb_lines++;
}
- char regexp[buffer_size]="";
- int regexp_point;
- regexp_point = 0;
+ char patterns[buffer_size];
+ patterns[0] = '\0';
+ int patterns_point;
+ patterns_point = 0;
- initscr(); // Necessary to start a curses session
+ initscr();
- if (has_colors()) {
- cout << "You can use color on this terminal" << endl;
- } else {
- cout << "No colors." << endl;
- return 1;
+ if(with_colors) {
+ if(has_colors()) {
+ start_color();
+ if(color_fg_modeline < 0 || color_fg_modeline >= COLORS ||
+ color_bg_modeline < 0 || color_bg_modeline >= COLORS ||
+ color_fg_highlight < 0 || color_bg_highlight >= COLORS ||
+ color_bg_highlight < 0 || color_bg_highlight >= COLORS) {
+ echo();
+ curs_set(1);
+ endwin();
+ cerr << "Color numbers have to be between 0 and " << COLORS - 1 << "." << endl;
+ exit(1);
+ }
+ init_pair(1, color_fg_modeline, color_bg_modeline);
+ init_pair(2, color_fg_highlight, color_bg_highlight);
+ } else {
+ with_colors = 0;
+ }
}
- noecho(); // I don't want echo when I press a key
- curs_set(0); // I don't want to see the cursor
- keypad(stdscr, TRUE);
+ noecho();
+ curs_set(0); // Hide the cursor
+ keypad(stdscr, TRUE); // So that the arrow keys work
- start_color(); // We will use colors
- init_pair(1, COLOR_WHITE, COLOR_BLACK); // red on black for error messages
-
- printw("Press a key to contine\n");
int key;
+ int current_line = 0, temporary_line = 0;
- build_display(0, nb_lines, lines, regexp);
+ update_screen(¤t_line, &temporary_line, 0, nb_lines, lines, patterns, no_blink);
do {
+
key = getch();
- if(key >= ' ' && key <= 'z') {
- regexp[regexp_point++] = key;
- regexp[regexp_point] = '\0';
- } else if(key == KEY_BACKSPACE || key == KEY_DC) {
- if(regexp_point > 0) {
- regexp_point--;
- regexp[regexp_point] = '\0';
+
+ int motion = 0;
+
+ if(key >= ' ' && key <= '~') {
+ patterns[patterns_point++] = key;
+ patterns[patterns_point] = '\0';
+ }
+
+ else if(key == KEY_BACKSPACE || key == KEY_DC || key == '\b') {
+ if(patterns_point > 0) {
+ patterns_point--;
+ patterns[patterns_point] = '\0';
}
}
- build_display(0, nb_lines, lines, regexp);
- } while(key != '\n' && key != KEY_ENTER);
- echo(); // We want to have echo
- curs_set(1); // We want to see the cursor again
- endwin(); // Back to normal
+ else if(key == KEY_HOME) {
+ current_line = 0;
+ }
+
+ else if(key == KEY_END) {
+ current_line = nb_lines - 1;
+ }
+
+ else if(key == KEY_NPAGE) {
+ motion = 10;
+ }
+
+ else if(key == KEY_PPAGE) {
+ motion = -10;
+ }
+
+ else if(key == KEY_UP || key == '\10') {
+ motion = -1;
+ }
+
+ else if(key == KEY_DOWN || key == '\ e') {
+ motion = 1;
+ }
+
+ update_screen(¤t_line, &temporary_line, motion,
+ nb_lines, lines, patterns, no_blink);
+
+ } while(key != '\n' && key != KEY_ENTER && key != '\a');
+
+ echo();
+ curs_set(1);
+ endwin();
+
+ if((key == KEY_ENTER || key == '\n')) {
+ if(output_to_vt_buffer) {
+ if(temporary_line >= 0 && temporary_line < nb_lines) {
+ inject_into_tty_buffer(lines[temporary_line]);
+ }
+ } else {
+ ofstream out(output_filename);
+ if(out.fail()) {
+ cerr << "Can not open " << output_filename << " for writing." << endl;
+ exit(1);
+ } else {
+ if(temporary_line >= 0 && temporary_line < nb_lines) {
+ out << lines[temporary_line] << endl;
+ } else {
+ out << endl;
+ }
+ }
+ out.flush();
+ }
+ }
for(int l = 0; l < nb_lines; l++) {
delete[] lines[l];
}
- return 0;
+ exit(0);
}