3 # fcscs - fast curses screen content select
5 # Copyright (C) 2013-2016 Simon Ruderich
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
24 use v5.10; # say, state
28 use I18N::Langinfo ();
32 our $VERSION = '0.01';
37 fcscs - fast curses screen content select
41 B<fcscs> [I<options>] I<path/to/screen/capture/file>
45 B<fcscs> is a small tool which allows quick selection of terminal screen
46 contents (like URLs, paths, regex matches, etc.) and passes the selection to
47 GNU Screen's or Tmux's buffer or any other program. The selection can then
48 quickly be pasted, e.g. in the shell. Requires GNU Screen or Tmux. It's
49 licensed under the GPL 3 or later.
57 Short overview of the general usage, details below:
60 - configure actions (optional)
63 - select mode (optional, URL mode is used on startup):
69 - select match by displayed number or <return> for lowest numbered
71 - configured action is run, e.g. URL is opened with browser
73 - perform incremental search
74 - on <return> go to `normal' mode to select a match
75 - after the match is selected wait for confirmation or extension
76 - confirmation: <return> run previously selected action
77 - extension: change match, e.g. select complete word or line
79 GNU Screen setup (add to F<~/.screenrc>):
81 bind ^B eval "hardcopy $HOME/.tmp/screen-fcscs" "screen fcscs $HOME/.tmp/screen-fcscs"
83 Tmux setup (add to F<~/.tmux.conf>):
85 bind-key C-b capture-pane \; save-buffer ~/.tmp/tmux-fcscs \; delete-buffer \; new-window "fcscs ~/.tmp/tmux-fcscs"
87 This requires a writable ~/.tmp directory. Adapt the mapping according to your
88 preferences. Ensure these files are not readable by others as they can contain
89 private data (umask or protected directory). B<fcscs> must be in your C<$PATH>
90 for the above mappings to work.
92 Pressing the configured mapping (Prefix Ctrl-B in this example) opens B<fcscs>
93 in a new GNU screen/Tmux window. After selection, the content is either passed
94 to external programs (e.g. for URLs) or copied to the paste buffer or directly
95 pasted in your previous window and the new window is closed.
97 To select a match just type its number. If the match is unique, the entry is
98 automatically selected (e.g. you press 2 and there are only 19 matches). If
99 there are multiple matches left (e.g. you press 1 and there are more than ten
100 matches available), press return to select the current match (1 in this case)
101 or another number to select the longer match. Use backspace to remove the last
104 Press return before entering a number to select the last (lowest numbered)
105 match (underlined by default). To abort without selecting any match use "q".
107 To change the selection mode (e.g. paths, files, etc.) use one of the mappings
108 explained below. Per default URLs are selected, see options for a way to
111 I<NOTE>: Opening URLs in the browser passes the URL via the command line which
112 leaks URLs to other users on the current system via C<ps aux> or C<top>.
114 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to
115 GNU screen/Tmux without exposing it to C<ps aux> or C<top>. However this may
116 leak data if those temporary files are written to disk. To prevent this change
117 your C<$TMP> to point to a memory-only location or encrypted storage.
119 If no window appears, try running B<fcscs> manually to catch the error message
120 and please report the bug:
122 fcscs /path/to/screen-or-tmux-fcscs-file
132 # Helper class for drawing on the screen using Curses.
135 my ($class, $encoding) = @_;
137 # Prefer strict UTF-8 handling (see perldoc Encode); just in case.
138 if (lc $encoding eq 'utf8') {
141 # Get Encode object to speed up decode()/encode().
142 my $encoding_object = Encode::find_encoding($encoding);
143 die "unsupported encoding '$encoding'" unless ref $encoding_object;
145 my $curses = Curses->new or die $!;
148 encoding => $encoding,
149 encoding_object => $encoding_object,
161 # Allow default colors by passing -1 to init_pair. A default color is
162 # not drawn on screen thus allowing terminals with pseudo-transparency
163 # to use the transparent background in place of the default color.
164 Curses::use_default_colors;
183 # Convert between Perl's internal encoding and the terminal's encoding.
185 my ($self, $string) = @_;
186 return $self->{encoding_object}->encode($string);
189 my ($self, $string) = @_;
190 return eval { # returns undef on decode failure
191 $self->{encoding_object}->decode($string, Encode::FB_CROAK);
195 # Create attribute for the given fore-/background colors.
197 my ($self, $fg, $bg) = @_;
199 state $next_color_pair = 1; # must start at 1 for init_pair()
201 Curses::init_pair($next_color_pair, $fg, $bg);
202 return Curses::COLOR_PAIR($next_color_pair++);
205 # Draw a string which must fit in the current line. Wrapping/clipping is
206 # not supported and must be handled by the caller.
208 my ($self, $y, $x, $attributes, $string) = @_;
210 die if $string =~ /\n/;
211 # FIXME: wide characters
212 die if $x + length $string > $self->width;
214 $self->{curses}->attron($attributes) if defined $attributes;
215 $self->{curses}->addstr($y, $x, $self->encode($string));
216 $self->{curses}->attroff($attributes) if defined $attributes;
219 # Like draw_simple(), but the string is automatically clipped.
221 my ($self, $y, $x, $attributes, $string) = @_;
223 # FIXME: wide characters
224 $string = substr $string, 0, $self->width - $x;
225 $self->draw_simple($y, $x, $attributes, $string);
229 my ($self, $y, $x, $attributes, $string) = @_;
231 die unless defined $string;
235 # We must print each line separately. Search for next newline or
236 # line end, whichever is closer.
237 if ($string =~ /\n/) {
240 # FIXME: wide characters
241 if ($x + length $string > $self->width) {
242 my $new_offset = $self->width - $x;
243 if (not defined $offset or $offset > $new_offset) {
244 $offset = $new_offset;
247 last unless defined $offset;
249 # FIXME: wide characters
250 $self->draw_simple($y, $x, $attributes, substr $string, 0, $offset);
252 # Don't draw "\n" itself.
253 if ("\n" eq substr $string, $offset, 1) {
257 $string = substr $string, $offset;
263 $self->draw_simple($y, $x, $attributes, $string);
268 my ($self, $config) = @_;
270 $self->debug('draw_prompt', 'started');
273 my $y = $self->height - 1;
275 # Clear line for better visibility.
276 $self->draw_simple($y, $x, undef, ' ' x $self->width);
279 if (defined (my $s = $self->{prompt}{flags})) {
281 $self->debug('draw_prompt', $s);
282 $self->draw_clipped($y, $x, $config->{attribute}{prompt_flags}, $s);
283 $x += length($s) + 1; # space between next element
286 if (defined (my $s = $self->{prompt}{name})) {
288 $self->debug('draw_prompt', $s);
289 $self->draw_clipped($y, $x, $config->{attribute}{prompt_name}, $s);
290 $x += length($s) + 1;
292 # Draw prompt value, e.g. a search field.
293 if (defined (my $s = $self->{prompt}{value})) {
294 $self->debug('draw_prompt', $s);
295 $self->draw_clipped($y, $x, undef, $s);
296 $x += length($s) + 1;
302 my ($self, $config, $matches_remove, $matches_add) = @_;
304 foreach (@{$matches_remove}) {
305 $self->draw($_->{y}, $_->{x}, Curses::A_NORMAL, $_->{string});
308 my $attr_id = $config->{attribute}{match_id};
309 my $attr_string = $config->{attribute}{match_string};
310 my $attr_last = $config->{attribute}{match_last};
312 foreach (@{$matches_add}) {
313 my $attr = (defined $_->{id} and $_->{id} == 1)
316 $self->draw($_->{y}, $_->{x}, $attr, $_->{string});
317 if (defined $_->{id}) {
318 $self->draw($_->{y}, $_->{x}, $attr_id, $_->{id});
325 my ($self, @args) = @_;
327 my $attr = $self->color_pair(Curses::COLOR_RED, -1) | Curses::A_BOLD;
329 # Clear the screen to improve visibility of the error message.
330 $self->{curses}->clear;
332 my $y = $self->draw(0, 0, $attr, "@args");
334 if ($self->{debug}) {
337 require Devel::StackTrace;
340 $msg = "Devel::StackTrace missing, no stack trace.\n";
342 my $trace = Devel::StackTrace->new;
343 $msg = "Stack trace:\n" . $trace->as_string;
345 $y = $self->draw($y + 1, 0, Curses::A_NORMAL, $msg);
348 $self->draw($y + 1, 0, Curses::A_NORMAL,
349 'Press any key to terminate fcscs.');
357 my ($self, $module, @args) = @_;
359 return if not $self->{debug};
361 state $fh; # only open the file once per run
362 if (not defined $fh) {
363 # Ignore errors if the directory doesn't exist.
364 if (not open $fh, '>', "$ENV{HOME}/.config/fcscs/log") {
365 $fh = undef; # a failed open still writes a value to $fh
371 $_ = $self->encode($_);
373 say $fh "$module: @args";
379 my ($self, %settings) = @_;
381 foreach (keys %settings) {
382 CORE::die if not exists $self->{prompt}{$_};
383 $self->{prompt}{$_} = $settings{$_};
388 # Wrapper for Curses.
389 sub width { return $Curses::COLS; }
390 sub height { return $Curses::LINES; }
391 sub refresh { return $_[0]->{curses}->refresh; }
392 sub getch { return $_[0]->{curses}->getch; }
393 sub cursor { Curses::curs_set($_[1]); return; }
401 my ($screen, $input_ref) = @_;
403 # Make sure the input fits on the screen by removing the top lines if
405 splice @{$input_ref}, 0, -$screen->height;
407 # Pad each line with spaces to the screen width to correctly handle
408 # multi-line regexes.
409 # FIXME: wide characters
410 my @padded = map { sprintf '%-*s', $screen->width, $_ } @{$input_ref};
412 my $string = join "\n", @padded;
416 width => $screen->width + 1,
417 # + 1 = "\n", used in input_match_offset_to_coordinates
421 sub input_match_offset_to_coordinates {
422 my ($width, $offset) = @_;
424 die unless defined $offset;
426 my $y = int($offset / $width);
427 my $x = $offset - $y * $width;
431 sub get_regex_matches {
432 my ($input, $regex) = @_;
435 while ($input->{string} =~ /$regex/g) {
437 die "Match group required in regex '$regex'" if not defined $offset;
439 my ($x, $y) = input_match_offset_to_coordinates($input->{width},
441 push @matches, { x => $x, y => $y, offset => $offset, string => $1 };
448 my ($screen, $config, $cmd) = @_;
450 $screen->debug('run_command', "running @{$cmd}");
453 # Perl's system() combined with a $SIG{__WARN__} which die()s has
454 # issues due to the fork. The die() in the __WARN__ handler doesn't
455 # die but the program continues after the system().
457 # If the forked process fails to exec (e.g. program not found) then
458 # the __WARN__ handler is called (because a warning is about to be
459 # displayed) and the die() should display a message and terminate the
460 # process. But due to the fork it doesn't terminate the parent process
461 # and instead changes the return value of system(); it's no longer -1
462 # which makes it impossible to detect that case.
464 # Perl < 5.18 (found in 5.14) doesn't setup $$ during system() which
465 # makes it impossible to detect if the handler was called from inside
468 # Instead, just ignore any warnings during the system(). Thanks to
469 # mauke in #perl on Freenode (2013-10-29 23:30 CET) for the idea to
470 # use no warnings and anno for testing a more recent Perl version with
474 my @cmd = map { $screen->encode($_) } @{$cmd};
475 system { $cmd[0] } @cmd;
480 $msg = 'failed to execute: ' . $!;
482 $msg = 'killed by signal ' . ($? & 127);
484 $msg = 'exited with code ' . ($? >> 8);
486 die "system(@{$cmd}) $msg.";
490 sub run_in_background {
491 my ($screen, $sub) = @_;
493 $screen->debug('run_in_background', "running $sub");
496 defined $pid or die $!;
499 # The terminal multiplexer sends a SIGHUP to the process when it
500 # closes the window (because the parent process has exited).
501 local $SIG{HUP} = 'IGNORE';
503 # Necessary for GNU screen or it'll keep the window open until an
504 # external command has run.
505 close STDIN or die $!;
506 close STDOUT or die $!;
507 close STDERR or die $!;
509 # Double-fork to prevent zombies.
511 defined $pid or die $!;
512 if ($pid == 0) { # child
517 waitpid $pid, 0 or die $!;
523 my ($name, $screen, $config, $input, $matches) = @_;
525 $screen->debug('select_match', 'started');
527 return if @{$matches} == 0;
528 # Don't return on initial run to give the user a chance to select another
529 # mode, e.g. to switch from URL selection to search selection.
530 if (@{$matches} == 1 and not $config->{state}{initial}) {
531 return { match => $matches->[0] };
533 $config->{state}{initial} = 0;
535 my @sorted = sort { $b->{y} <=> $a->{y} or $b->{x} <=> $a->{x} } @{$matches};
542 $screen->prompt(name => $name, value => undef);
543 $screen->draw_prompt($config);
545 $screen->draw_matches($config, [], $matches);
550 my $char = $screen->getch;
551 if ($char =~ /^\d$/) {
552 $number = $number * 10 + $char;
553 } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
554 $number = int($number / 10);
555 } elsif ($char eq "\n"
556 or $char eq $config->{setting}{alternative_return}) {
557 if ($number == 0) { # number without selection matches last entry
562 # Selecting a new mode requires falling through into the main input
563 # loop and then starting the new mode.
564 } elsif (defined $config->{mapping}{mode}{$char}) {
565 $screen->draw_matches($config, $matches, []); # clear matches
566 return { key => $char };
567 # All other mappings stay in the current mode.
568 } elsif (defined (my $m = $config->{mapping}{simple}{$char})) {
569 $m->($char, $screen, $config, $input);
573 next; # ignore unknown mappings
576 last if $number > 0 and $number * 10 > @{$matches}; # unique match
578 my @remaining = $number == 0
580 : grep { $_->{id} =~ /^$number/ } @{$matches};
581 $screen->draw_matches($config, $matches, \@remaining);
585 $screen->draw_matches($config, $matches, []); # remove matches
587 foreach (@{$matches}) {
588 return { match => $_ } if $_->{id} == $number;
590 $screen->debug('select_match', 'no match selected');
591 return { match => undef };
594 sub extend_match_regex_left {
595 my ($line, $match, $regex) = @_;
597 my $s = reverse substr $line, 0, $match->{x};
598 if ($s =~ /^($regex)/) {
599 $match->{string} = reverse($1) . $match->{string};
600 $match->{x} -= length $1;
601 $match->{offset} -= length $1;
605 sub extend_match_regex_right {
606 my ($line, $match, $regex) = @_;
608 my $s = substr $line, $match->{x} + length $match->{string};
609 if ($s =~ /^($regex)/) {
610 $match->{string} .= $1;
615 my ($screen, $config, $input, $match) = @_;
617 $screen->debug('extend_match', 'started');
619 return if not defined $match;
621 $screen->prompt(name => 'extend', value => undef);
622 $screen->draw_prompt($config);
624 delete $match->{id}; # don't draw any match ids
625 $screen->draw_matches($config, [], [$match]);
628 my $line = $input->{lines}[$match->{y}];
631 my $match_old = \%{$match};
633 my $char = $screen->getch;
635 or $char eq $config->{setting}{alternative_return}) {
638 } elsif ($char eq 'w') { # select current word (both directions)
639 extend_match_regex_left($line, $match, qr/\w+/);
640 extend_match_regex_right($line, $match, qr/\w+/);
641 } elsif ($char eq 'b') { # select current word (only left)
642 extend_match_regex_left($line, $match, qr/\w+/);
643 } elsif ($char eq 'e') { # select current word (only right)
644 extend_match_regex_right($line, $match, qr/\w+/);
646 } elsif ($char eq 'W') { # select current WORD (both directions)
647 extend_match_regex_left($line, $match, qr/\S+/);
648 extend_match_regex_right($line, $match, qr/\S+/);
649 } elsif ($char eq 'B') { # select current WORD (only left)
650 extend_match_regex_left($line, $match, qr/\S+/);
651 } elsif ($char eq 'E') { # select current WORD (only right)
652 extend_match_regex_right($line, $match, qr/\S+/);
654 } elsif ($char eq '0') { # select to beginning of line
655 extend_match_regex_left($line, $match, qr/.+/);
656 } elsif ($char eq '$') { # select to end of line
657 extend_match_regex_right($line, $match, qr/.+/);
659 # Allow mode changes if not overwritten by local mappings.
660 } elsif (defined $config->{mapping}{mode}{$char}) {
661 $screen->draw_matches($config, [$match_old], []); # clear match
662 return { key => $char };
665 next; # ignore unknown mappings
668 $screen->draw_matches($config, [$match_old], [$match]);
672 $screen->debug('extend_match', 'done');
674 return { match => $match };
679 my ($key, $screen, $config, $input) = @_;
681 $screen->debug('mapping_paste', 'started');
683 $config->{state}{handler} = $config->{handler}{paste};
685 $screen->prompt(flags => 'P'); # paste
686 $screen->draw_prompt($config);
692 my ($key, $screen, $config, $input) = @_;
694 $screen->debug('mapping_yank', 'started');
696 $config->{state}{handler} = $config->{handler}{yank};
698 $screen->prompt(flags => 'Y'); # yank
699 $screen->draw_prompt($config);
708 Normal modes select matches by calling a function which returns them, e.g. by
711 The following normal modes are available:
715 =item B<path mode> select relative/absolute paths
717 =item B<url mode> select URLs
719 =item B<ip mode> select IPv4 and IPv6 addresses
724 sub mapping_mode_path {
725 my ($key, $screen, $config, $input) = @_;
727 $screen->debug('mapping_mode_path', 'started');
729 my @matches = get_regex_matches($input, $config->{regex}{path});
731 select => 'path select',
732 matches => \@matches,
733 handler => $config->{handler}{yank},
736 sub mapping_mode_url {
737 my ($key, $screen, $config, $input) = @_;
739 $screen->debug('mapping_mode_url', 'started');
741 my @matches = get_regex_matches($input, $config->{regex}{url});
743 select => 'url select',
744 matches => \@matches,
745 handler => $config->{handler}{url},
748 sub mapping_mode_ip {
749 my ($key, $screen, $config, $input) = @_;
751 $screen->debug('mapping_mode_ip', 'started');
753 my @ipv4 = get_regex_matches($input, $config->{regex}{ipv4});
754 my @ipv6 = get_regex_matches($input, $config->{regex}{ipv6});
756 select => 'ip select',
757 matches => [@ipv4, @ipv6],
758 handler => $config->{handler}{ip},
762 =head2 SEARCH MODE (AND EXTEND MODE)
764 Search mode is a special mode which lets you type a search string (a Perl
765 regex) and then select one of the matches. Afterwards you can extend the
766 match. For example select the complete word or to the end of the line. This
767 allows quick selection of arbitrary text.
769 The following mappings are available during the extension mode (not
770 configurable at the moment):
774 =item B<w> select current word
776 =item B<b> extend word to the left
778 =item B<e> extend word to the right
780 =item B<W> select current WORD
782 =item B<B> extend WORD to the left
784 =item B<E> extend WORD to the right
786 =item B<0> extend to beginning of line
788 =item B<$> extend to end of line
792 C<word> includes any characters matching C<\w+>, C<WORD> any non-whitespace
793 characters (C<\S+>), just like in Vim.
796 sub mapping_mode_search {
797 my ($key, $screen, $config, $input) = @_;
799 $screen->debug('mapping_mode_search', 'started');
803 my $search = ''; # encoded
806 # getch doesn't return decoded characters but raw input bytes. Wait
807 # until the input character is complete.
808 my $value = $screen->decode($search);
809 $value = '' unless defined $value; # undef on decode failure
811 $screen->prompt(name => 'search', value => $value);
812 $screen->draw_prompt($config);
815 my $char = $screen->getch;
816 # TODO: readline editing support
819 } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
820 # Remove a character, not a byte.
821 $search = $screen->decode($search);
823 $search = $screen->encode($search);
826 next unless defined $screen->decode($search);
832 if (($config->{setting}{smartcase} and $search eq lc $search)
833 or $config->{setting}{ignorecase}) {
836 # Ignore invalid regexps.
837 # TODO: display warning on error?
839 @matches = get_regex_matches($input, qr/($case$search)/);
842 $screen->draw_matches($config, \@last_matches, \@matches);
843 @last_matches = @matches;
848 $screen->prompt(name => undef, value => undef); # clear prompt
849 $screen->draw_prompt($config);
851 $screen->debug('mapping_mode_search', 'done');
855 matches => \@last_matches,
857 handler => $config->{handler}{yank},
862 my ($key, $screen, $config, $input) = @_;
864 # Key is necessary to fall through to main event loop which then quits.
865 return { key => $key, quit => 1 };
870 my ($screen, $config, $match) = @_;
872 $screen->debug('handler_yank', 'started');
876 # Use a temporary file to prevent leaking the yanked data to other users
877 # with the command line, e.g. ps aux or top.
878 my ($fh, $tmp) = File::Temp::tempfile(); # dies on its own
879 print $fh $screen->encode($match->{value});
882 if ($config->{setting}{multiplexer} eq 'screen') {
883 $screen->debug('handler_yank', 'using screen');
885 # GNU screen displays an annoying "Slurping X characters into buffer".
886 # Use 'msgwait 0' as a hack to disable it.
887 my $msgwait = $config->{setting}{screen_msgwait};
888 run_command($screen, $config, ['screen', '-X', 'msgwait', 0]);
889 run_command($screen, $config, ['screen', '-X', 'readbuf', $tmp]);
890 run_command($screen, $config, ['screen', '-X', 'msgwait', $msgwait]);
891 } elsif ($config->{setting}{multiplexer} eq 'tmux') {
892 $screen->debug('handler_yank', 'using tmux');
894 run_command($screen, $config, ['tmux', 'load-buffer', $tmp]);
896 die 'unsupported multiplexer';
899 unlink $tmp or die $!;
903 my ($screen, $config, $match) = @_;
905 $screen->debug('handler_paste', 'started');
910 if ($config->{setting}{multiplexer} eq 'screen') {
911 $screen->debug('handler_paste', 'using screen');
912 @cmd = qw( screen -X paste . );
913 } elsif ($config->{setting}{multiplexer} eq 'tmux') {
914 $screen->debug('handler_paste', 'using tmux');
915 @cmd = qw( tmux paste-buffer );
917 die 'unsupported multiplexer';
920 run_in_background($screen, sub {
921 # We need to get the data in the paste buffer before we can paste
923 handler_yank($screen, $config, $match);
925 # Sleep until we switch back to the current window.
926 Time::HiRes::usleep($config->{setting}{paste_sleep});
928 run_command($screen, $config, \@cmd);
933 my ($screen, $config, $match) = @_;
935 $screen->debug('handler_url', "opening $match->{value}");
937 run_in_background($screen, sub {
938 my @cmd = ( @{$config->{setting}{browser}}, $match->{value} );
939 run_command($screen, $config, \@cmd);
946 # CONFIGURATION DEFAULTS
950 fcscs is configured through F<~/.fcscsrc> or F<~/.config/fcscs/fcscsrc> which
951 is a normal Perl script with all of Perl's usual features.
953 All configuration values are stored in the hash C<%config>. All manually
954 defined keys overwrite the default settings.
956 A simple F<~/.fcscsrc> could look like this (for details about the used
962 use Curses; # for COLOR_* and A_* constants
966 # Draw matches in blue.
967 $config{attribute}{match_string} = color_pair(COLOR_BLUE, -1);
968 # Enable Vim-like 'smartcase', ignore case until an upper character is
970 $config{setting}{smartcase} = 1;
972 # Use chromium to open URLs if running under X, elinks otherwise.
973 if (defined $ENV{DISPLAY}) {
974 $config{setting}{browser} = ['chromium'];
976 $config{setting}{browser} = ['elinks'];
979 # Let fcscs know the file was loaded successfully.
987 Pod::Usage::pod2usage(2);
991 # Determine terminal encoding from the environment ($ENV{LANG} or similar).
992 my $encoding = I18N::Langinfo::langinfo(I18N::Langinfo::CODESET);
994 my $screen = Screen->init($encoding);
996 # We must restore the screen before exiting.
997 local $SIG{INT} = sub {
1001 # Make all warnings fatal to make sure they don't get lost (stderr is normally
1003 local $SIG{__WARN__} = sub {
1004 $screen->die('warning', @_);
1011 I<NOTE>: Mappings are split in two categories: Mode mappings which change the
1012 selection and may receive additional input (e.g. a search string) and simple
1013 mappings which only change some value. Mode mappings are configured via
1014 C<$config{mapping}{mode}>, simple mappings via C<$config{mapping}{simple}>.
1016 The following mode mappings are available by default (the function to remap
1017 them in parentheses):
1021 =item B<f> select absolute/relative paths (C<\&mapping_mode_path>)
1023 =item B<u> select URLs (C<\&mapping_mode_url>)
1025 =item B<i> select IPv4 and IPv6 addresses (C<\&mapping_mode_ip>)
1027 =item B</> search for regex to get selection (C<\&mapping_mode_search>)
1029 =item B<q> quit fcscs (C<\&mapping_quit>)
1033 The following simple mappings are available by default:
1037 =item B<p> enable pasting (C<\&mapping_paste>)
1039 =item B<y> enable yanking (copying) (C<\&mapping_yank>)
1043 The following additional mappings are available by default:
1047 =item B<\n> accept current selection (not customizable)
1049 =item B<s> additional key to accept selection (B<alternative_return> option)
1053 All (single-byte) keys except numbers, backspace and return can be mapped.
1055 Unknown mappings are ignored when pressing keys.
1057 To remove a default mapping, delete it from the mapping hash.
1061 # Map 'p' to select paths, 'P' to enable pasting.
1062 $config{mapping}{mode}{p} = \&mapping_mode_path;
1063 $config{mapping}{simple}{P} = \&mapping_paste;
1065 # Disable 'f' mapping.
1066 delete $config{mapping}{mode}{f};
1069 my %mapping_mode = (
1070 f => \&mapping_mode_path,
1071 u => \&mapping_mode_url,
1072 i => \&mapping_mode_ip,
1073 '/' => \&mapping_mode_search,
1074 q => \&mapping_quit,
1076 my %mapping_simple = (
1077 p => \&mapping_paste,
1078 y => \&mapping_yank,
1083 Attributes are used to style the output. They must be Curses attributes.
1084 Defaults in parentheses (foreground, background, attribute).
1088 =item B<match_id> attribute for match numbers (red, default, bold)
1090 =item B<match_string> attribute for matches (yellow, default, normal)
1092 =item B<match_last> attribute for the match selected by return (yellow, default, underline)
1094 =item B<prompt_name> attribute for prompt name (standout)
1096 =item B<prompt_flags> attribute for prompt flags (standout)
1102 # Draw prompt flags in bold red with default background color.
1103 $config{attribute}{prompt_flags}
1105 | color_pair(Curses::COLOR_RED, -1);
1109 match_id => $screen->color_pair(Curses::COLOR_RED, -1)
1111 match_string => $screen->color_pair(Curses::COLOR_YELLOW, -1),
1112 match_last => $screen->color_pair(Curses::COLOR_YELLOW, -1)
1113 | Curses::A_UNDERLINE,
1114 prompt_name => Curses::A_STANDOUT,
1115 prompt_flags => Curses::A_STANDOUT,
1120 Defaults in parentheses.
1124 =item B<debug> enable debug mode, writes to I<~/.config/fcscs/log> (C<0>)
1126 =item B<initial_mode> start in this mode, must be a valid mode mapping (C<\&mapping_mode_url>)
1128 =item B<multiplexer> set multiplexer ("screen" or "tmux") if not autodetected (C<undef>)
1130 =item B<ignorecase> ignore case when searching (C<0>)
1132 =item B<smartcase> ignore case unless one uppercase character is searched (C<1>)
1134 =item B<paste_sleep> sleep x us before running paste command (C<100_000>)
1136 =item B<screen_msgwait> GNU Screen's msgwait variable, used when yanking (C<5>)
1138 =item B<alternative_return> additional accept key like return, set to C<\n> to disable (C<s>)
1140 =item B<browser> browser command as array reference (C<['x-www-browser']>)
1146 # Select paths on startup instead of URLs.
1147 $config{setting}{initial_mode} = \&mapping_mode_path;
1153 initial_mode => \&mapping_mode_url,
1154 multiplexer => undef,
1157 paste_sleep => 100_000,
1158 screen_msgwait => 5,
1160 alternative_return => 's',
1162 browser => ['x-www-browser'],
1169 =item B<url> used by C<\&mapping_mode_url>
1171 =item B<path> used by C<\&mapping_mode_path>
1173 =item B<ipv4> used by C<\&mapping_mode_ip>
1175 =item B<ipv6> used by C<\&mapping_mode_ip>
1181 # Select all non-whitespace characters when searching for paths.
1182 $config{regex}{path} = qr{(\S+)};
1186 # Taken from urlview's default configuration file, thanks.
1187 url => qr{((?:(?:(?:http|https|ftp|gopher)|mailto):(?://)?[^ <>"\t]*|(?:www|ftp)[0-9]?\.[-a-z0-9.]+)[^ .,;\t\n\r<">\):]?[^, <>"\t]*[^ .,;\t\n\r<">\):])},
1188 path => qr{(~?[a-zA-Z0-9_./-]*/[a-zA-Z0-9_./-]+)},
1189 # IP addresses with optional prefix. Not perfectly accurate but good
1191 ipv4 => qr!\b(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}(?:/\d{1,2})?)\b!,
1192 ipv6 => qr!\b((?:[0-9a-fA-F]{1,4})?(?::+[0-9a-fA-F]{1,4})+(?:/\d{1,3})?)\b!,
1197 Handlers are used to perform actions on the selected string.
1199 The following handlers are available, defaults in parentheses.
1203 =item B<yank> used to yank (copy) selection to paste buffer (C<\&handler_yank>)
1205 =item B<paste> used to paste selection into window (C<\&handler_paste>)
1207 =item B<url> used to open URLs (e.g. in a browser) (C<\&handler_url>)
1209 =item B<ip> used to handle IPs (C<\&handler_yank>)
1215 # Download YouTube videos with a custom wrapper, handle all other URLs
1216 # with the default URL handler.
1217 $config{handler}{url} = sub {
1218 my ($screen, $config, $match) = @_;
1220 if ($match->{value} =~ m{^https://www.youtube.com/}) {
1221 return run_in_background($screen, sub {
1222 run_command($screen, $config,
1223 ['youtube-dl-wrapper', $match->{value}]);
1231 yank => \&handler_yank,
1232 paste => \&handler_paste,
1233 url => \&handler_url,
1234 ip => \&handler_yank,
1238 initial => 1, # used by select_match() for 'initial_mode'
1244 # CONFIGURATION "API"
1248 The following functions are available:
1250 color_pair($fg, $bg)
1252 Create a new Curses attribute with the given fore- and background color.
1257 mapping_mode_search()
1263 Used as mappings, see L</MAPPINGS> above.
1269 Used as handler to yank, paste selection or open URL in browser.
1277 Helper functions when writing custom mappings, see the source for details.
1285 # All variables and functions which are usable by ~/.fcscsrc.
1287 our $screen; # "private"
1290 sub color_pair { return $screen->color_pair(@_); }
1292 sub mapping_mode_path { return main::mapping_mode_path(@_); }
1293 sub mapping_mode_url { return main::mapping_mode_url(@_); }
1294 sub mapping_mode_ip { return main::mapping_mode_ip(@_); }
1295 sub mapping_mode_search { return main::mapping_mode_search(@_); }
1297 sub mapping_paste { return main::mapping_paste(@_); }
1298 sub mapping_yank { return main::mapping_yank(@_); }
1299 sub mapping_quit { return main::mapping_quit(@_); }
1301 sub handler_yank { return main::handler_yank(@_); }
1302 sub handler_paste { return main::handler_paste(@_); }
1303 sub handler_url { return main::handler_url(@_); }
1305 sub debug { return main::debug(@_); }
1307 sub get_regex_matches { return main::get_regex_matches(@_); }
1308 sub select_match { return main::select_match(@_); }
1310 sub run_command { return main::run_command(@_); }
1311 sub run_in_background { return main::run_in_background(@_); }
1313 $Fcscs::screen = $screen;
1319 # Alias %config and %Fcscs::config. %config is less to type.
1321 local *config = \%Fcscs::config;
1323 $config{mapping}{mode} = \%mapping_mode;
1324 $config{mapping}{simple} = \%mapping_simple;
1325 $config{attribute} = \%attribute;
1326 $config{setting} = \%setting;
1327 $config{regex} = \%regex;
1328 $config{handler} = \%handler;
1329 $config{state} = \%state;
1332 my @configs = ("$ENV{HOME}/.fcscsrc",
1333 "$ENV{HOME}/.config/fcscs/fcscsrc");
1334 foreach my $path (@configs) {
1335 my $decoded = $screen->decode($path);
1337 # Load configuration file. Checks have a race condition if the home
1338 # directory is writable by an attacker (but then the user is screwed
1340 next unless -e $path;
1342 $screen->die("Config '$decoded' not owned by current user!");
1344 # Make sure the file is not writable by other users. Doesn't handle
1345 # ACLs and see comment above about race conditions.
1346 my @stat = stat $path or die $!;
1347 my $mode = $stat[2];
1348 if (($mode & Fcntl::S_IWGRP) or ($mode & Fcntl::S_IWOTH)) {
1349 die "Config '$decoded' must not be writable by other users.";
1352 my $result = do $path;
1354 $screen->die("Failed to parse '$decoded': $@") if $@;
1355 $screen->die("Failed to do '$decoded': $!") unless defined $result;
1356 $screen->die("Failed to run '$decoded'.");
1359 last; # success, don't load more files
1362 $screen->{debug} = $config{setting}{debug};
1368 # Auto-detect current multiplexer.
1369 if (not defined $config{setting}{multiplexer}) {
1370 if (defined $ENV{STY} and defined $ENV{TMUX}) {
1371 die 'Found both $STY and $TMUX, set $config{setting}{multiplexer}.';
1372 } elsif (defined $ENV{STY}) {
1373 $config{setting}{multiplexer} = 'screen';
1374 } elsif (defined $ENV{TMUX}) {
1375 $config{setting}{multiplexer} = 'tmux';
1377 die 'No multiplexer found.';
1381 my $binmode = $encoding;
1382 # GNU screen stores the screen dump for unknown reasons as ISO-8859-1
1383 # instead of the currently active encoding.
1384 if ($config{setting}{multiplexer} eq 'screen') {
1385 $binmode = 'ISO-8859-1';
1389 open my $fh, '<', $ARGV[0] or die $!;
1390 binmode $fh, ":encoding($binmode)" or die $!;
1393 push @input_lines, $_;
1395 close $fh or die $!;
1397 my $input = prepare_input($screen, \@input_lines);
1399 # Display original screen content.
1401 foreach (@{$input->{lines}}) {
1402 $screen->draw_simple($y++, 0, undef, $_);
1407 my $mapping = $config{setting}{initial_mode};
1411 if (not defined $mapping) {
1412 $key = $screen->getch unless defined $key;
1413 $screen->debug('input', "got key '$key'");
1415 $mapping = $config{mapping}{mode}{$key};
1416 $mapping = $config{mapping}{simple}{$key} unless defined $mapping;
1417 if (not defined $mapping) { # ignore unknown mappings
1423 $screen->debug('input', 'running mapping');
1424 my $result = $mapping->($key, $screen, \%config, $input);
1428 if (defined $result->{quit}) {
1429 $screen->debug('input', 'quitting');
1432 if (defined $result->{key}) {
1433 $key = $result->{key}; # lookup another mapping
1434 $screen->debug('input', "processing new key: '$key'");
1437 if (defined $result->{select}) {
1438 $screen->debug('input', 'selecting match');
1440 $result = select_match($result->{select},
1441 $screen, \%config, $input,
1442 $result->{matches});
1443 $result->{handler} = $tmp->{handler};
1444 $result->{extend} = $tmp->{extend};
1445 goto RESULT; # reprocess special entries in result
1447 if (defined $result->{extend}) {
1448 $screen->debug('input', 'extending match');
1449 $result = extend_match($screen, \%config, $input,
1451 goto RESULT; # reprocess special entries in result
1453 if (defined $result->{match}) {
1454 if (not defined $result->{match}{value}) {
1455 $result->{match}{value} = $result->{match}{string};
1458 $screen->debug('input', 'running handler');
1460 # Choose handler with falling priority.
1462 $config{state}{handler}, # set by user
1463 $result->{match}{handler}, # set by match
1464 $result->{handler}, # set by mapping
1465 $config{handler}{yank}, # fallback
1467 foreach my $handler (@handlers) {
1468 next unless defined $handler;
1470 $handler->($screen, \%config, $result->{match});
1476 $key = undef; # get next key from user
1501 Invalid arguments/options.
1507 Simon Ruderich E<lt>simon@ruderich.orgE<gt>
1509 =head1 LICENSE AND COPYRIGHT
1511 Copyright (C) 2013-2016 by Simon Ruderich
1513 This program is free software: you can redistribute it and/or modify
1514 it under the terms of the GNU General Public License as published by
1515 the Free Software Foundation, either version 3 of the License, or
1516 (at your option) any later version.
1518 This program is distributed in the hope that it will be useful,
1519 but WITHOUT ANY WARRANTY; without even the implied warranty of
1520 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1521 GNU General Public License for more details.
1523 You should have received a copy of the GNU General Public License
1524 along with this program. If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
1528 L<screen(1)>, L<tmux(1)>, L<urlview(1)>