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 GNU Screen setup (add to F<~/.screenrc>):
59 bind ^B eval "hardcopy $HOME/.tmp/screen-fcscs" "screen fcscs $HOME/.tmp/screen-fcscs"
61 Tmux setup (add to F<~/.tmux.conf>):
63 bind-key C-b capture-pane \; save-buffer ~/.tmp/tmux-fcscs \; delete-buffer \; new-window "fcscs ~/.tmp/tmux-fcscs"
65 This requires a writable ~/.tmp directory. Adapt the mapping according to your
66 preferences. Ensure these files are not readable by others as they can contain
67 private data (umask or protected directory). B<fcscs> must be in your C<$PATH>
68 for the above mappings to work.
70 Pressing the configured mapping (Prefix Ctrl-B in this example) opens B<fcscs>
71 in a new GNU screen/Tmux window. After selection, the content is either passed
72 to external programs (e.g. for URLs) or copied to the paste buffer or directly
73 pasted in your previous window and the new window is closed.
75 To select a match just type its number. If the match is unique, the entry is
76 automatically selected (e.g. you press 2 and there are only 19 matches). If
77 there are multiple matches left (e.g. you press 1 and there are more than ten
78 matches available), press return to select the current match (1 in this case)
79 or another number to select the longer match. Use backspace to remove the last
82 Press return before entering a number to select the last (lowest numbered)
83 match. To abort without selecting any match either use "q".
85 To change the selection mode (e.g. paths, files, etc.) use one of the mappings
86 explained below. Per default URLs are selected, see options for a way to
89 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to
90 GNU screen/Tmux without exposing it to C<ps ux> or C<top>. However this may
91 leak data if those temporary files are written to disk. To prevent this change
92 your C<$TMP> accordingly to point to a memory-only location or encrypted
95 If no window appears, try running B<fcscs> manually to catch the error message
96 and please report the bug:
98 fcscs /path/to/screen-or-tmux-fcscs-file
105 # Helper class for drawing on the screen using Curses.
108 my ($class, $encoding) = @_;
110 # Prefer strict UTF-8 handling (see perldoc Encode); just in case.
111 if (lc $encoding eq 'utf8') {
114 # Get Encode object to speed up decode()/encode().
115 my $encoding_object = Encode::find_encoding($encoding);
116 die "unsupported encoding '$encoding'" unless ref $encoding_object;
118 my $curses = Curses->new or die $!;
121 encoding => $encoding,
122 encoding_object => $encoding_object,
134 # Allow default colors by passing -1 to init_pair. A default color is
135 # not drawn on screen thus allowing terminals with pseudo-transparency
136 # to use the transparent background in place of the default color.
137 Curses::use_default_colors;
156 # Convert between Perl's internal encoding and the terminal's encoding.
158 my ($self, $string) = @_;
159 return $self->{encoding_object}->encode($string);
162 my ($self, $string) = @_;
163 return eval { # returns undef on decode failure
164 $self->{encoding_object}->decode($string, Encode::FB_CROAK);
168 # Create attribute for the given fore-/background colors.
170 my ($self, $fg, $bg) = @_;
172 state $next_color_pair = 1; # must start at 1 for init_pair()
174 Curses::init_pair($next_color_pair, $fg, $bg);
175 return Curses::COLOR_PAIR($next_color_pair++);
178 # Draw a string which must fit in the current line. Wrapping/clipping is
179 # not supported and must be handled by the caller.
181 my ($self, $y, $x, $attributes, $string) = @_;
183 die if $string =~ /\n/;
184 # FIXME: wide characters
185 die if $x + length $string > $self->width;
187 $self->{curses}->attron($attributes) if defined $attributes;
188 $self->{curses}->addstr($y, $x, $self->encode($string));
189 $self->{curses}->attroff($attributes) if defined $attributes;
192 # Like draw_simple(), but the string is automatically clipped.
194 my ($self, $y, $x, $attributes, $string) = @_;
196 # FIXME: wide characters
197 $string = substr $string, 0, $self->width - $x;
198 $self->draw_simple($y, $x, $attributes, $string);
202 my ($self, $y, $x, $attributes, $string) = @_;
204 die unless defined $string;
208 # We must print each line separately. Search for next newline or
209 # line end, whichever is closer.
210 if ($string =~ /\n/) {
213 # FIXME: wide characters
214 if ($x + length $string > $self->width) {
215 my $new_offset = $self->width - $x;
216 if (not defined $offset or $offset > $new_offset) {
217 $offset = $new_offset;
220 last unless defined $offset;
222 # FIXME: wide characters
223 $self->draw_simple($y, $x, $attributes, substr $string, 0, $offset);
225 # Don't draw "\n" itself.
226 if ("\n" eq substr $string, $offset, 1) {
230 $string = substr $string, $offset;
236 $self->draw_simple($y, $x, $attributes, $string);
241 my ($self, $config) = @_;
244 my $y = $self->height - 1;
246 # Clear line for better visibility.
247 $self->draw_simple($y, $x, undef, ' ' x $self->width);
250 if (defined (my $s = $self->{prompt}{flags})) {
252 $self->draw_clipped($y, $x, $config->{attribute}{prompt_flags}, $s);
253 $x += length($s) + 1; # space between next element
256 if (defined (my $s = $self->{prompt}{name})) {
258 $self->draw_clipped($y, $x, $config->{attribute}{prompt_name}, $s);
259 $x += length($s) + 1;
261 # Draw prompt value, e.g. a search field.
262 if (defined (my $s = $self->{prompt}{value})) {
263 $self->draw_clipped($y, $x, undef, $s);
264 $x += length($s) + 1;
270 my ($self, $config, $matches_remove, $matches_add) = @_;
272 foreach (@{$matches_remove}) {
273 $self->draw($_->{y}, $_->{x}, Curses::A_NORMAL, $_->{string});
276 my $attr_id = $config->{attribute}{match_id};
277 my $attr_string = $config->{attribute}{match_string};
279 foreach (@{$matches_add}) {
280 $self->draw($_->{y}, $_->{x}, $attr_string, $_->{string});
281 if (defined $_->{id}) {
282 $self->draw($_->{y}, $_->{x}, $attr_id, $_->{id});
289 my ($self, @args) = @_;
291 my $attr = $self->color_pair(Curses::COLOR_RED, -1) | Curses::A_BOLD;
293 # Clear the screen to improve visibility of the error message.
294 $self->{curses}->clear;
296 my $y = $self->draw(0, 0, $attr, "@args");
298 if ($self->{debug}) {
301 require Devel::StackTrace;
304 $msg = "Devel::StackTrace missing, no stack trace.\n";
306 my $trace = Devel::StackTrace->new;
307 $msg = "Stack trace:\n" . $trace->as_string;
309 $y = $self->draw($y + 1, 0, Curses::A_NORMAL, $msg);
312 $self->draw($y + 1, 0, Curses::A_NORMAL,
313 'Press any key to terminate fcscs.');
323 my ($self, %settings) = @_;
325 foreach (keys %settings) {
326 CORE::die if not exists $self->{prompt}{$_};
327 $self->{prompt}{$_} = $settings{$_};
332 # Wrapper for Curses.
333 sub width { return $Curses::COLS; }
334 sub height { return $Curses::LINES; }
335 sub refresh { return $_[0]->{curses}->refresh; }
336 sub getch { return $_[0]->{curses}->getch; }
337 sub cursor { Curses::curs_set($_[1]); return; }
345 my ($config, $module, @args) = @_;
347 say STDERR "$module: @args" if $config->{setting}{debug};
353 my ($screen, $input_ref) = @_;
355 # Make sure the input fits on the screen by removing the top lines if
357 splice @{$input_ref}, 0, -$screen->height;
359 # Pad each line with spaces to the screen width to correctly handle
360 # multi-line regexes.
361 # FIXME: wide characters
362 my @padded = map { sprintf '%-*s', $screen->width, $_ } @{$input_ref};
364 my $string = join "\n", @padded;
368 width => $screen->width + 1,
369 # + 1 = "\n", used in input_match_offset_to_coordinates
373 sub input_match_offset_to_coordinates {
374 my ($width, $offset) = @_;
376 die unless defined $offset;
378 my $y = int($offset / $width);
379 my $x = $offset - $y * $width;
383 sub get_regex_matches {
384 my ($input, $regex) = @_;
387 while ($input->{string} =~ /$regex/g) {
389 die "Match group required in regex '$regex'" if not defined $offset;
391 my ($x, $y) = input_match_offset_to_coordinates($input->{width},
393 push @matches, { x => $x, y => $y, string => $1 };
400 my ($config, $cmd) = @_;
402 debug $config, 'run_command', "running @{$cmd}";
405 # Perl's system() combined with a $SIG{__WARN__} which die()s has
406 # issues due to the fork. The die() in the __WARN__ handler doesn't
407 # die but the program continues after the system().
409 # If the forked process fails to exec (e.g. program not found) then
410 # the __WARN__ handler is called (because a warning is about to be
411 # displayed) and the die() should display a message and terminate the
412 # process. But due to the fork it doesn't terminate the parent process
413 # and instead changes the return value of system(); it's no longer -1
414 # which makes it impossible to detect that case.
416 # Perl < 5.18 (found in 5.14) doesn't setup $$ during system() which
417 # makes it impossible to detect if the handler was called from inside
420 # Instead, just ignore any warnings during the system(). Thanks to
421 # mauke in #perl on Freenode (2013-10-29 23:30 CET) for the idea to
422 # use no warnings and anno for testing a more recent Perl version with
426 system { $cmd->[0] } @{$cmd};
431 $msg = 'failed to execute: ' . $!;
433 $msg = 'killed by signal ' . ($? & 127);
435 $msg = 'exited with code ' . ($? >> 8);
437 die "system(@{$cmd}) $msg.";
441 sub run_in_background {
442 my ($config, $sub) = @_;
444 debug $config, 'run_in_background', "running $sub";
447 defined $pid or die $!;
450 # The terminal multiplexer sends a SIGHUP to the process when it
451 # closes the window (because the parent process has exited).
452 local $SIG{HUP} = 'IGNORE';
454 # Necessary for GNU screen or it'll keep the window open until the
455 # paste command has run.
456 close STDIN or die $!;
457 close STDOUT or die $!;
458 close STDERR or die $!;
460 # Double-fork to prevent zombies.
462 defined $pid or die $!;
463 if ($pid == 0) { # child
464 # Disable debug mode as writing will fail with closed STDERR.
465 $config->{setting}{debug} = 0;
471 waitpid $pid, 0 or die $!;
477 my ($name, $screen, $config, $input, $matches) = @_;
479 debug $config, 'select_match', 'started';
481 return if @{$matches} == 0;
482 # Don't return on initial run to give the user a chance to select another
483 # mode, e.g. to switch from URL selection to search selection.
484 if (@{$matches} == 1 and not $config->{state}->{initial}) {
485 return { match => $matches->[0] };
487 $config->{state}{initial} = 0;
489 my @sorted = sort { $b->{y} <=> $a->{y} or $b->{x} <=> $a->{x} } @{$matches};
496 $screen->prompt(name => $name, value => undef);
497 $screen->draw_prompt($config);
499 $screen->draw_matches($config, [], $matches);
504 my $char = $screen->getch;
505 if ($char =~ /^\d$/) {
506 $number = $number * 10 + $char;
507 } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
508 $number = int($number / 10);
509 } elsif ($char eq "\n") {
510 if ($number == 0) { # number without selection matches last entry
515 # Selecting a new mode requires falling through into the main input
516 # loop and then starting the new mode.
517 } elsif (defined $config->{mapping}{mode}{$char}) {
518 $screen->draw_matches($config, $matches, []); # clear matches
519 return { key => $char };
520 # All other mappings stay in the current mode.
521 } elsif (defined (my $m = $config->{mapping}{simple}{$char})) {
522 $m->($char, $screen, $config, $input);
526 next; # ignore unknown mappings
529 last if $number > 0 and $number * 10 > @{$matches}; # unique match
531 my @remaining = $number == 0
533 : grep { $_->{id} =~ /^$number/ } @{$matches};
534 $screen->draw_matches($config, $matches, \@remaining);
538 foreach (@{$matches}) {
539 return { match => $_ } if $_->{id} == $number;
541 debug $config, 'select_match', 'no match selected';
542 return { match => undef };
547 my ($key, $screen, $config, $input) = @_;
549 debug $config, 'mapping_paste', 'started';
551 $config->{state}{handler} = $config->{handler}{paste};
553 $screen->prompt(flags => 'P'); # paste
554 $screen->draw_prompt($config);
560 my ($key, $screen, $config, $input) = @_;
562 debug $config, 'mapping_yank', 'started';
564 $config->{state}{handler} = $config->{handler}{yank};
566 $screen->prompt(flags => 'Y'); # yank
567 $screen->draw_prompt($config);
574 sub mapping_mode_path {
575 my ($key, $screen, $config, $input) = @_;
577 debug $config, 'mapping_mode_path', 'started';
579 my @matches = get_regex_matches($input, $config->{regex}{path});
581 select => 'path select',
582 matches => \@matches,
583 handler => $config->{handler}{yank},
586 sub mapping_mode_url {
587 my ($key, $screen, $config, $input) = @_;
589 debug $config, 'mapping_mode_url', 'started';
591 my @matches = get_regex_matches($input, $config->{regex}{url});
593 select => 'url select',
594 matches => \@matches,
595 handler => $config->{handler}{url},
599 sub mapping_mode_search {
600 my ($key, $screen, $config, $input) = @_;
602 debug $config, 'mapping_mode_search', 'started';
606 my $search = ''; # encoded
609 # getch doesn't return decoded characters but raw input bytes. Wait
610 # until the input character is complete.
611 my $value = $screen->decode($search);
612 $value = '' unless defined $value; # undef on decode failure
614 $screen->prompt(name => 'search', value => $value);
615 $screen->draw_prompt($config);
618 my $char = $screen->getch;
619 # TODO: readline editing support
622 } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
623 # Remove a character, not a byte.
624 $search = $screen->decode($search);
626 $search = $screen->encode($search);
629 next unless defined $screen->decode($search);
635 if (($config->{setting}{smartcase} and $search eq lc $search)
636 or $config->{setting}{ignorecase}) {
639 # Ignore invalid regexps.
640 # TODO: display warning on error?
642 @matches = get_regex_matches($input, qr/($case$search)/);
645 $screen->draw_matches($config, \@last_matches, \@matches);
646 @last_matches = @matches;
653 matches => \@last_matches,
654 handler => $config->{handler}{yank},
659 my ($key, $screen, $config, $input) = @_;
661 # Key is necessary to fall through to main event loop which then quits.
662 return { key => $key, quit => 1 };
667 my ($screen, $config, $match) = @_;
669 debug $config, 'handler_yank', 'started';
673 # Use a temporary file to prevent leaking the yanked data to other users
674 # with the command line, e.g. ps aux or top.
675 my ($fh, $tmp) = File::Temp::tempfile(); # dies on its own
676 print $fh $screen->encode($match->{value});
679 if ($config->{setting}{multiplexer} eq 'screen') {
680 debug $config, 'handler_yank', 'using screen';
682 # GNU screen displays an annoying "Slurping X characters into buffer".
683 # Use 'msgwait 0' as a hack to disable it.
684 my $msgwait = $config->{setting}{screen_msgwait};
685 run_command($config, ['screen', '-X', 'msgwait', 0]);
686 run_command($config, ['screen', '-X', 'readbuf', $tmp]);
687 run_command($config, ['screen', '-X', 'msgwait', $msgwait]);
688 } elsif ($config->{setting}{multiplexer} eq 'tmux') {
689 debug $config, 'handler_yank', 'using tmux';
691 run_command($config, ['tmux', 'load-buffer', $tmp]);
693 die 'unsupported multiplexer';
696 unlink $tmp or die $!;
700 my ($screen, $config, $match) = @_;
702 debug $config, 'handler_paste', 'started';
707 if ($config->{setting}{multiplexer} eq 'screen') {
708 debug $config, 'handler_paste', 'using screen';
709 @cmd = qw( screen -X paste . );
710 } elsif ($config->{setting}{multiplexer} eq 'tmux') {
711 debug $config, 'handler_paste', 'using tmux';
712 @cmd = qw( tmux paste-buffer );
714 die 'unsupported multiplexer';
717 run_in_background($config, sub {
718 # We need to get the data in the paste buffer before we can paste
720 handler_yank($screen, $config, $match);
722 # Sleep until we switch back to the current window.
723 Time::HiRes::usleep($config->{setting}{paste_sleep});
725 run_command($config, \@cmd);
730 my ($screen, $config, $match) = @_;
732 debug $config, 'handler_url', 'started';
734 run_in_background($config, sub {
735 my @cmd = map { $screen->encode($_) } (
736 @{$config->{setting}{browser}},
739 run_command($config, \@cmd);
746 # CONFIGURATION DEFAULTS
750 fcscs is configured through F<~/.fcscsrc> or F<~/.config/fcscs/fcscsrc> which
751 is a normal Perl script with all of Perl's usual features.
753 All configuration values are stored in the hash C<%config>. All manually
754 defined keys overwrite the default settings.
756 A simple F<~/.fcscsrc> could look like this (for details about the used
762 use Curses; # for COLOR_* and A_* constants
766 # Draw matches in blue.
767 $config{attribute}{match_string} = color_pair(COLOR_BLUE, -1);
768 # Enable Vim-like 'smartcase', ignore case until an upper character is
770 $config{setting}{smartcase} = 1;
772 # Use chromium to open URLs if running under X, elinks otherwise.
773 if (defined $ENV{DISPLAY}) {
774 $config{setting}{browser} = ['chromium'];
776 $config{setting}{browser} = ['elinks'];
779 # Let fcscs know the file was loaded successfully.
787 Pod::Usage::pod2usage(2);
791 # Determine terminal encoding from the environment ($ENV{LANG} or similar).
792 my $encoding = I18N::Langinfo::langinfo(I18N::Langinfo::CODESET);
794 my $screen = Screen->init($encoding);
796 # We must restore the screen before exiting.
797 local $SIG{INT} = sub {
801 # Make all warnings fatal to make sure they don't get lost (stderr is normally
803 local $SIG{__WARN__} = sub {
804 $screen->die('warning', @_);
811 I<NOTE>: Mappings are split in two categories: Mode mappings which change the
812 selection and may receive additional input (e.g. a search string) and simple
813 mappings which only change some value. Mode mappings are configured via
814 C<$config{mapping}{mode}>, simple mappings via C<$config{mapping}{simple}>.
816 The following mode mappings are available by default (the function to remap
817 them in parentheses):
821 =item B<f> select absolute/relative paths (C<\&mapping_mode_path>)
823 =item B<u> select URLs (C<\&mapping_mode_url>)
825 =item B</> search for regex to get selection (C<\&mapping_mode_search>)
827 =item B<q> quit fcscs (C<\&mapping_quit>)
831 The following simple mappings are available by default:
835 =item B<p> enable pasting (C<\&mapping_paste>)
837 =item B<y> enable yanking (copying) (C<\&mapping_yank>)
841 All (single-byte) keys except numbers, backspace and return can be mapped.
843 Unknown mappings are ignored when pressing keys.
845 To remove a default mapping, delete it from the mapping hash.
849 # Map 'p' to select paths, 'P' to enable pasting.
850 $config{mapping}{mode}{p} = \&mapping_mode_path;
851 $config{mapping}{simple}{P} = \&mapping_paste;
853 # Disable 'f' mapping.
854 delete $config{mapping}{mode}{f};
858 f => \&mapping_mode_path,
859 u => \&mapping_mode_url,
860 '/' => \&mapping_mode_search,
863 my %mapping_simple = (
864 p => \&mapping_paste,
870 Attributes are used to style the output. They must be Curses attributes.
871 Defaults in parentheses (foreground, background, attribute).
875 =item B<match_id> attribute for match numbers (red, default, bold)
877 =item B<match_string> attribute for matches (yellow, default, normal)
879 =item B<prompt_name> attribute for prompt name (standout)
881 =item B<prompt_flags> attribute for prompt flags (standout)
887 # Draw prompt flags in bold red with default background color.
888 $config{attribute}{prompt_flags}
890 | color_pair(Curses::COLOR_RED, -1);
894 match_id => $screen->color_pair(Curses::COLOR_RED, -1)
896 match_string => $screen->color_pair(Curses::COLOR_YELLOW, -1),
897 prompt_name => Curses::A_STANDOUT,
898 prompt_flags => Curses::A_STANDOUT,
903 Defaults in parentheses.
907 =item B<debug> enable debug mode (redirect stderr when enabling) (C<0>)
909 =item B<initial_mode> start in this mode, must be a valid mode mapping (C<\&mapping_mode_url>)
911 =item B<multiplexer> set multiplexer ("screen" or "tmux") if not autodetected (C<undef>)
913 =item B<ignorecase> ignore case when searching (C<0>)
915 =item B<smartcase> ignore case unless one uppercase character is searched (C<1>)
917 =item B<paste_sleep> sleep x us before running paste command (C<100_000>)
919 =item B<screen_msgwait> GNU Screen's msgwait variable, used when yanking (C<5>)
921 =item B<browser> browser command as array reference (C<['x-www-browser']>)
927 # Select paths on startup instead of URLs.
928 $config{setting}{initial_mode} = \&mapping_mode_path;
934 initial_mode => \&mapping_mode_url,
935 multiplexer => undef,
938 paste_sleep => 100_000,
941 browser => ['x-www-browser'],
948 =item B<url> used by C<\&mapping_mode_url()>
950 =item B<path> used by C<\&mapping_mode_path()>
956 # Select all non-whitespace characters when searching for paths.
957 $config{regex}{path} = qr{(\S+)};
961 # Taken from urlview's default configuration file, thanks.
962 url => qr{((?:(?:(?:http|https|ftp|gopher)|mailto):(?://)?[^ <>"\t]*|(?:www|ftp)[0-9]?\.[-a-z0-9.]+)[^ .,;\t\n\r<">\):]?[^, <>"\t]*[^ .,;\t\n\r<">\):])},
963 path => qr{(~?[a-zA-Z0-9_./-]*/[a-zA-Z0-9_./-]+)},
968 Handlers are used to perform actions on the selected string.
970 The following handlers are available, defaults in parentheses.
974 =item B<yank> used to yank (copy) selection to paste buffer (C<\&handler_yank>)
976 =item B<paste> used to paste selection into window (C<\&handler_paste>)
978 =item B<url> used to open URLs (e.g. in a browser) (C<\&handler_url>)
984 # Download YouTube videos with a custom wrapper, handle all other URLs
985 # with the default URL handler.
986 $config{handler}{url} = sub {
987 my ($screen, $config, $match) = @_;
989 if ($match->{value} =~ m{^https://www.youtube.com/}) {
990 return run_in_background($config, sub {
991 run_command($config, ['youtube-dl-wrapper', $match->{value}]);
999 yank => \&handler_yank,
1000 paste => \&handler_paste,
1001 url => \&handler_url,
1005 initial => 1, # used by select_match() for 'initial_mode'
1011 # CONFIGURATION "API"
1015 The following functions are available:
1017 color_pair($fg, $bg)
1019 Create a new Curses attribute with the given fore- and background color.
1023 mapping_mode_search()
1029 Used as mappings, see L</MAPPINGS> above.
1035 Used as handler to yank, paste selection or open URL in browser.
1042 Helper functions when writing custom mappings, see the source for details.
1050 # All variables and functions which are usable by ~/.fcscsrc.
1052 our $screen; # "private"
1055 sub color_pair { return $screen->color_pair(@_); }
1057 sub mapping_mode_path { return main::mapping_mode_path(@_); }
1058 sub mapping_mode_url { return main::mapping_mode_url(@_); }
1059 sub mapping_mode_search { return main::mapping_mode_search(@_); }
1061 sub mapping_paste { return main::mapping_paste(@_); }
1062 sub mapping_yank { return main::mapping_yank(@_); }
1063 sub mapping_quit { return main::mapping_quit(@_); }
1065 sub handler_yank { return main::handler_yank(@_); }
1066 sub handler_paste { return main::handler_paste(@_); }
1067 sub handler_url { return main::handler_url(@_); }
1069 sub get_regex_matches { return main::get_regex_matches(@_); }
1070 sub select_match { return main::select_match(@_); }
1072 sub run_command { return main::run_command(@_); }
1073 sub run_in_background { return main::run_in_background(@_); }
1075 $Fcscs::screen = $screen;
1081 # Alias %config and %Fcscs::config. %config is less to type.
1083 local *config = \%Fcscs::config;
1085 $config{mapping}{mode} = \%mapping_mode;
1086 $config{mapping}{simple} = \%mapping_simple;
1087 $config{attribute} = \%attribute;
1088 $config{setting} = \%setting;
1089 $config{regex} = \%regex;
1090 $config{handler} = \%handler;
1091 $config{state} = \%state;
1094 my @configs = ("$ENV{HOME}/.fcscsrc",
1095 "$ENV{HOME}/.config/fcscs/fcscsrc");
1096 foreach my $path (@configs) {
1097 my $decoded = $screen->decode($path);
1099 # Load configuration file. Checks have a race condition if the home
1100 # directory is writable by an attacker (but then the user is screwed
1102 next unless -e $path;
1104 $screen->die("Config '$decoded' not owned by current user!");
1106 # Make sure the file is not writable by other users. Doesn't handle
1107 # ACLs and see comment above about race conditions.
1108 my @stat = stat $path or die $!;
1109 my $mode = $stat[2];
1110 if (($mode & Fcntl::S_IWGRP) or ($mode & Fcntl::S_IWOTH)) {
1111 die "Config '$decoded' must not be writable by other users.";
1114 my $result = do $path;
1116 $screen->die("Failed to parse '$decoded': $@") if $@;
1117 $screen->die("Failed to do '$decoded': $!") unless defined $result;
1118 $screen->die("Failed to run '$decoded'.");
1121 last; # success, don't load more files
1124 $screen->{debug} = $config{setting}{debug};
1130 # Auto-detect current multiplexer.
1131 if (not defined $config{setting}{multiplexer}) {
1132 if (defined $ENV{STY} and defined $ENV{TMUX}) {
1133 die 'Found both $STY and $TMUX, set $config{setting}{multiplexer}.';
1134 } elsif (defined $ENV{STY}) {
1135 $config{setting}{multiplexer} = 'screen';
1136 } elsif (defined $ENV{TMUX}) {
1137 $config{setting}{multiplexer} = 'tmux';
1139 die 'No multiplexer found.';
1143 my $binmode = $encoding;
1144 # GNU screen stores the screen dump for unknown reasons as ISO-8859-1
1145 # instead of the currently active encoding.
1146 if ($config{setting}{multiplexer} eq 'screen') {
1147 $binmode = 'ISO-8859-1';
1151 open my $fh, '<', $ARGV[0] or die $!;
1152 binmode $fh, ":encoding($binmode)" or die $!;
1155 push @input_lines, $_;
1157 close $fh or die $!;
1159 my $input = prepare_input($screen, \@input_lines);
1161 # Display original screen content.
1163 foreach (@{$input->{lines}}) {
1164 $screen->draw_simple($y++, 0, undef, $_);
1169 my $mapping = $config{setting}{initial_mode};
1173 if (not defined $mapping) {
1174 $key = $screen->getch unless defined $key;
1175 debug \%config, 'input', "got key '$key'";
1177 $mapping = $config{mapping}{mode}{$key};
1178 $mapping = $config{mapping}{simple}{$key} unless defined $mapping;
1179 if (not defined $mapping) { # ignore unknown mappings
1185 debug \%config, 'input', 'running mapping';
1186 my $result = $mapping->($key, $screen, \%config, $input);
1190 if (defined $result->{quit}) {
1191 debug \%config, 'input', 'quitting';
1194 if (defined $result->{key}) {
1195 $key = $result->{key}; # lookup another mapping
1196 debug \%config, 'input', "processing new key: '$key'";
1199 if (defined $result->{select}) {
1200 debug \%config, 'input', 'selecting match';
1202 $result = select_match($result->{select},
1203 $screen, \%config, $input,
1204 $result->{matches});
1205 $result->{handler} = $tmp->{handler};
1206 goto RESULT; # reprocess special entries in result
1208 if (defined $result->{match}) {
1209 if (not defined $result->{match}->{value}) {
1210 $result->{match}->{value} = $result->{match}->{string};
1213 debug \%config, 'input', 'running handler';
1214 my $handler = $config{state}{handler}; # set by user
1215 $handler = $result->{handler} unless defined $handler; # set by mapping
1216 $handler = $config{handler}{yank} unless defined $handler; # fallback
1217 $handler->($screen, \%config, $result->{match});
1221 $key = undef; # get next key from user
1246 Invalid arguments/options.
1252 Simon Ruderich E<lt>simon@ruderich.orgE<gt>
1254 =head1 LICENSE AND COPYRIGHT
1256 Copyright (C) 2013-2016 by Simon Ruderich
1258 This program is free software: you can redistribute it and/or modify
1259 it under the terms of the GNU General Public License as published by
1260 the Free Software Foundation, either version 3 of the License, or
1261 (at your option) any later version.
1263 This program is distributed in the hope that it will be useful,
1264 but WITHOUT ANY WARRANTY; without even the implied warranty of
1265 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1266 GNU General Public License for more details.
1268 You should have received a copy of the GNU General Public License
1269 along with this program. If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
1273 L<screen(1)>, L<tmux(1)>, L<urlview(1)>