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) {
388 my ($x, $y) = input_match_offset_to_coordinates($input->{width},
390 push @matches, { x => $x, y => $y, string => $1 };
397 my ($config, $cmd) = @_;
399 debug $config, 'run_command', "running @{$cmd}";
402 # Perl's system() combined with a $SIG{__WARN__} which die()s has
403 # issues due to the fork. The die() in the __WARN__ handler doesn't
404 # die but the program continues after the system().
406 # If the forked process fails to exec (e.g. program not found) then
407 # the __WARN__ handler is called (because a warning is about to be
408 # displayed) and the die() should display a message and terminate the
409 # process. But due to the fork it doesn't terminate the parent process
410 # and instead changes the return value of system(); it's no longer -1
411 # which makes it impossible to detect that case.
413 # Perl < 5.18 (found in 5.14) doesn't setup $$ during system() which
414 # makes it impossible to detect if the handler was called from inside
417 # Instead, just ignore any warnings during the system(). Thanks to
418 # mauke in #perl on Freenode (2013-10-29 23:30 CET) for the idea to
419 # use no warnings and anno for testing a more recent Perl version with
423 system { $cmd->[0] } @{$cmd};
428 $msg = 'failed to execute: ' . $!;
430 $msg = 'killed by signal ' . ($? & 127);
432 $msg = 'exited with code ' . ($? >> 8);
434 die "system(@{$cmd}) $msg.";
438 sub run_in_background {
439 my ($config, $sub) = @_;
441 debug $config, 'run_in_background', "running $sub";
444 defined $pid or die $!;
447 # The terminal multiplexer sends a SIGHUP to the process when it
448 # closes the window (because the parent process has exited).
449 local $SIG{HUP} = 'IGNORE';
451 # Necessary for GNU screen or it'll keep the window open until the
452 # paste command has run.
453 close STDIN or die $!;
454 close STDOUT or die $!;
455 close STDERR or die $!;
457 # Double-fork to prevent zombies.
459 defined $pid or die $!;
460 if ($pid == 0) { # child
465 waitpid $pid, 0 or die $!;
471 my ($name, $screen, $config, $input, $matches) = @_;
473 debug $config, 'select_match', 'started';
475 return if @{$matches} == 0;
476 # Don't return on initial run to give the user a chance to select another
477 # mode, e.g. to switch from URL selection to search selection.
478 if (@{$matches} == 1 and not $config->{state}->{initial}) {
479 return { match => $matches->[0] };
481 $config->{state}{initial} = 0;
483 my @sorted = sort { $b->{y} <=> $a->{y} or $b->{x} <=> $a->{x} } @{$matches};
490 $screen->prompt(name => $name, value => undef);
491 $screen->draw_prompt($config);
493 $screen->draw_matches($config, [], $matches);
498 my $char = $screen->getch;
499 if ($char =~ /^\d$/) {
500 $number = $number * 10 + $char;
501 } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
502 $number = int($number / 10);
503 } elsif ($char eq "\n") {
504 if ($number == 0) { # number without selection matches last entry
509 # Selecting a new mode requires falling through into the main input
510 # loop and then starting the new mode.
511 } elsif (defined $config->{mapping}{mode}{$char}) {
512 $screen->draw_matches($config, $matches, []); # clear matches
513 return { key => $char };
514 # All other mappings stay in the current mode.
515 } elsif (defined (my $m = $config->{mapping}{simple}{$char})) {
516 $m->($char, $screen, $config, $input);
520 next; # ignore unknown mappings
523 last if $number > 0 and $number * 10 > @{$matches}; # unique match
525 my @remaining = $number == 0
527 : grep { $_->{id} =~ /^$number/ } @{$matches};
528 $screen->draw_matches($config, $matches, \@remaining);
532 foreach (@{$matches}) {
533 return { match => $_ } if $_->{id} == $number;
535 debug $config, 'select_match', 'no match selected';
536 return { match => undef };
541 my ($key, $screen, $config, $input) = @_;
543 debug $config, 'mapping_paste', 'started';
545 $config->{state}{handler} = \&handler_paste;
547 $screen->prompt(flags => 'P'); # paste
548 $screen->draw_prompt($config);
554 my ($key, $screen, $config, $input) = @_;
556 debug $config, 'mapping_yank', 'started';
558 $config->{state}{handler} = \&handler_yank;
560 $screen->prompt(flags => 'Y'); # yank
561 $screen->draw_prompt($config);
568 sub mapping_mode_path {
569 my ($key, $screen, $config, $input) = @_;
571 debug $config, 'mapping_mode_path', 'started';
573 my @matches = get_regex_matches($input, $config->{regex}{path});
575 select => 'path select',
576 matches => \@matches,
577 handler => \&handler_yank,
580 sub mapping_mode_url {
581 my ($key, $screen, $config, $input) = @_;
583 debug $config, 'mapping_mode_url', 'started';
585 my @matches = get_regex_matches($input, $config->{regex}{url});
587 select => 'url select',
588 matches => \@matches,
589 handler => \&handler_url,
593 sub mapping_mode_search {
594 my ($key, $screen, $config, $input) = @_;
596 debug $config, 'mapping_mode_search', 'started';
600 my $search = ''; # encoded
603 # getch doesn't return decoded characters but raw input bytes. Wait
604 # until the input character is complete.
605 my $value = $screen->decode($search);
606 $value = '' unless defined $value; # undef on decode failure
608 $screen->prompt(name => 'search', value => $value);
609 $screen->draw_prompt($config);
612 my $char = $screen->getch;
613 # TODO: readline editing support
616 } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
617 # Remove a character, not a byte.
618 $search = $screen->decode($search);
620 $search = $screen->encode($search);
623 next unless defined $screen->decode($search);
629 if (($config->{setting}{smartcase} and $search eq lc $search)
630 or $config->{setting}{ignorecase}) {
633 # Ignore invalid regexps.
634 # TODO: display warning on error?
636 @matches = get_regex_matches($input, qr/($case$search)/);
639 $screen->draw_matches($config, \@last_matches, \@matches);
640 @last_matches = @matches;
647 matches => \@last_matches,
648 handler => \&handler_yank,
653 my ($key, $screen, $config, $input) = @_;
655 # Key is necessary to fall through to main event loop which then quits.
656 return { key => $key, quit => 1 };
661 my ($screen, $config, $match) = @_;
663 debug $config, 'handler_yank', 'started';
667 # Use a temporary file to prevent leaking the yanked data to other users
668 # with the command line, e.g. ps aux or top.
669 my ($fh, $tmp) = File::Temp::tempfile(); # dies on its own
670 print $fh $screen->encode($match->{string});
673 if ($config->{setting}{multiplexer} eq 'screen') {
674 debug $config, 'handler_yank', 'using screen';
676 # GNU screen displays an annoying "Slurping X characters into buffer".
677 # Use 'msgwait 0' as a hack to disable it.
678 my $msgwait = $config->{setting}{screen_msgwait};
679 run_command($config, ['screen', '-X', 'msgwait', 0]);
680 run_command($config, ['screen', '-X', 'readbuf', $tmp]);
681 run_command($config, ['screen', '-X', 'msgwait', $msgwait]);
682 } elsif ($config->{setting}{multiplexer} eq 'tmux') {
683 debug $config, 'handler_yank', 'using tmux';
685 run_command($config, ['tmux', 'load-buffer', $tmp]);
687 die 'unsupported multiplexer';
690 unlink $tmp or die $!;
694 my ($screen, $config, $match) = @_;
696 debug $config, 'handler_paste', 'started';
701 if ($config->{setting}{multiplexer} eq 'screen') {
702 debug $config, 'handler_paste', 'using screen';
703 @cmd = qw( screen -X paste . );
704 } elsif ($config->{setting}{multiplexer} eq 'tmux') {
705 debug $config, 'handler_paste', 'using tmux';
706 @cmd = qw( tmux paste-buffer );
708 die 'unsupported multiplexer';
711 run_in_background($config, sub {
712 # We need to get the data in the paste buffer before we can paste
714 handler_yank($screen, $config, $match);
716 # Sleep until we switch back to the current window.
717 Time::HiRes::usleep($config->{setting}{paste_sleep});
719 run_command($config, \@cmd);
724 my ($screen, $config, $match) = @_;
726 debug $config, 'handler_url', 'started';
728 run_in_background($config, sub {
729 my $url = defined $match->{url}
733 my @cmd = map { $screen->encode($_) } (
734 @{$config->{setting}{browser}},
737 run_command($config, \@cmd);
744 # CONFIGURATION DEFAULTS
748 fcscs is configured through F<~/.fcscsrc> or F<~/.config/fcscs/fcscsrc> which
749 is a normal Perl script with all of Perl's usual features.
751 All configuration values are stored in the hash C<%config>. All manually
752 defined keys overwrite the default settings.
754 A simple F<~/.fcscsrc> could look like this (for details about the used
760 use Curses; # for COLOR_* and A_* constants
764 # Draw matches in blue.
765 $config{attribute}{match_string} = color_pair(COLOR_BLUE, -1);
766 # Enable Vim-like 'smartcase', ignore case until an upper character is
768 $config{setting}{smartcase} = 1;
770 # Use chromium to open URLs if running under X, elinks otherwise.
771 if (defined $ENV{DISPLAY}) {
772 $config{setting}{browser} = ['chromium'];
774 $config{setting}{browser} = ['elinks'];
777 # Let fcscs know the file was loaded successfully.
785 Pod::Usage::pod2usage(2);
789 # Determine terminal encoding from the environment ($ENV{LANG} or similar).
790 my $encoding = I18N::Langinfo::langinfo(I18N::Langinfo::CODESET);
792 my $screen = Screen->init($encoding);
794 # We must restore the screen before exiting.
795 local $SIG{INT} = sub {
799 # Make all warnings fatal to make sure they don't get lost (stderr is normally
801 local $SIG{__WARN__} = sub {
802 $screen->die('warning', @_);
809 I<NOTE>: Mappings are split in two categories: Mode mappings which change the
810 selection and may receive additional input (e.g. a search string) and simple
811 mappings which only change some value. Mode mappings are configured via
812 C<$config{mapping}{mode}>, simple mappings via C<$config{mapping}{simple}>.
814 The following mode mappings are available by default (the function to remap
815 them in parentheses):
819 =item B<f> select absolute/relative paths (C<\&mapping_mode_path>)
821 =item B<u> select URLs (C<\&mapping_mode_url>)
823 =item B</> search for regex to get selection (C<\&mapping_mode_search>)
825 =item B<q> quit fcscs (C<\&mapping_quit>)
829 The following simple mappings are available by default:
833 =item B<p> enable pasting (C<\&mapping_paste>)
835 =item B<y> enable yanking (copying) (C<\&mapping_yank>)
839 All (single-byte) keys except numbers, backspace and return can be mapped.
841 Unknown mappings are ignored when pressing keys.
843 To remove a default mapping, delete it from the mapping hash.
847 # Map 'p' to select paths, 'P' to enable pasting.
848 $config{mapping}{mode}{p} = \&mapping_mode_path;
849 $config{mapping}{simple}{P} = \&mapping_paste;
851 # Disable 'f' mapping.
852 delete $config{mapping}{mode}{f};
856 f => \&mapping_mode_path,
857 u => \&mapping_mode_url,
858 '/' => \&mapping_mode_search,
861 my %mapping_simple = (
862 p => \&mapping_paste,
868 Attributes are used to style the output. They must be Curses attributes.
869 Defaults in parentheses (foreground, background, attribute).
873 =item B<match_id> attribute for match numbers (red, default, bold)
875 =item B<match_string> attribute for matches (yellow, default, normal)
877 =item B<prompt_name> attribute for prompt name (standout)
879 =item B<prompt_flags> attribute for prompt flags (standout)
885 # Draw prompt flags in bold red with default background color.
886 $config{attribute}{prompt_flags}
888 | color_pair(Curses::COLOR_RED, -1);
892 match_id => $screen->color_pair(Curses::COLOR_RED, -1)
894 match_string => $screen->color_pair(Curses::COLOR_YELLOW, -1),
895 prompt_name => Curses::A_STANDOUT,
896 prompt_flags => Curses::A_STANDOUT,
901 Defaults in parentheses.
905 =item B<debug> enable debug mode (redirect stderr when enabling) (C<0>)
907 =item B<initial_mode> start in this mode, must be a valid mode mapping (C<\&mapping_mode_url>)
909 =item B<multiplexer> set multiplexer ("screen" or "tmux") if not autodetected (C<undef>)
911 =item B<ignorecase> ignore case when searching (C<0>)
913 =item B<smartcase> ignore case unless one uppercase character is searched (C<1>)
915 =item B<paste_sleep> sleep x us before running paste command (C<100_000>)
917 =item B<screen_msgwait> GNU Screen's msgwait variable, used when yanking (C<5>)
919 =item B<browser> browser command as array reference (C<['x-www-browser']>)
925 # Select paths on startup instead of URLs.
926 $config{setting}{initial_mode} = \&mapping_mode_path;
932 initial_mode => \&mapping_mode_url,
933 multiplexer => undef,
936 paste_sleep => 100_000,
939 browser => ['x-www-browser'],
946 =item B<url> used by C<\&mapping_mode_url()>
948 =item B<path> used by C<\&mapping_mode_path()>
954 # Select all non-whitespace characters when searching for paths.
955 $config{regex}{path} = qr{\S+};
959 # Taken from urlview's default configuration file, thanks.
960 url => qr{((?:(?:(?:http|https|ftp|gopher)|mailto):(?://)?[^ <>"\t]*|(?:www|ftp)[0-9]?\.[-a-z0-9.]+)[^ .,;\t\n\r<">\):]?[^, <>"\t]*[^ .,;\t\n\r<">\):])},
961 path => qr{(~?[a-zA-Z0-9_./-]*/[a-zA-Z0-9_./-]+)},
965 initial => 1, # used by select_match() for 'initial_mode'
971 # CONFIGURATION "API"
975 The following functions are available:
979 Create a new Curses attribute with the given fore- and background color.
983 mapping_mode_search()
989 Used as mappings, see L</MAPPINGS> above.
995 Used as handler to yank, paste selection or open URL in browser. They are
996 either set by the matching mapping function (C<mapping_paste()>, etc.) or
997 configured by the current mode.
1004 Helper functions when writing custom mappings, see the source for details.
1012 # All variables and functions which are usable by ~/.fcscsrc.
1014 our $screen; # "private"
1017 sub color_pair { return $screen->color_pair(@_); }
1019 sub mapping_mode_path { return main::mapping_mode_path(@_); }
1020 sub mapping_mode_url { return main::mapping_mode_url(@_); }
1021 sub mapping_mode_search { return main::mapping_mode_search(@_); }
1023 sub mapping_paste { return main::mapping_paste(@_); }
1024 sub mapping_yank { return main::mapping_yank(@_); }
1025 sub mapping_quit { return main::mapping_quit(@_); }
1027 sub handler_yank { return main::handler_yank(@_); }
1028 sub handler_paste { return main::handler_paste(@_); }
1029 sub handler_url { return main::handler_url(@_); }
1031 sub get_regex_matches { return main::get_regex_matches(@_); }
1032 sub select_match { return main::select_match(@_); }
1034 sub run_command { return main::run_command(@_); }
1035 sub run_in_background { return main::run_in_background(@_); }
1037 $Fcscs::screen = $screen;
1043 # Alias %config and %Fcscs::config. %config is less to type.
1045 local *config = \%Fcscs::config;
1047 $config{mapping}{mode} = \%mapping_mode;
1048 $config{mapping}{simple} = \%mapping_simple;
1049 $config{attribute} = \%attribute;
1050 $config{setting} = \%setting;
1051 $config{regex} = \%regex;
1052 $config{state} = \%state;
1055 my @configs = ("$ENV{HOME}/.fcscsrc",
1056 "$ENV{HOME}/.config/fcscs/fcscsrc");
1057 foreach my $path (@configs) {
1058 my $decoded = $screen->decode($path);
1060 # Load configuration file. Checks have a race condition if the home
1061 # directory is writable by an attacker (but then the user is screwed
1063 next unless -e $path;
1065 $screen->die("Config '$decoded' not owned by current user!");
1067 # Make sure the file is not writable by other users. Doesn't handle
1068 # ACLs and see comment above about race conditions.
1069 my @stat = stat $path or die $!;
1070 my $mode = $stat[2];
1071 if (($mode & Fcntl::S_IWGRP) or ($mode & Fcntl::S_IWOTH)) {
1072 die "Config '$decoded' must not be writable by other users.";
1075 my $result = do $path;
1077 $screen->die("Failed to parse '$decoded': $@") if $@;
1078 $screen->die("Failed to do '$decoded': $!") unless defined $result;
1079 $screen->die("Failed to run '$decoded'.");
1082 last; # success, don't load more files
1085 $screen->{debug} = $config{setting}{debug};
1091 # Auto-detect current multiplexer.
1092 if (not defined $config{setting}{multiplexer}) {
1093 if (defined $ENV{STY} and defined $ENV{TMUX}) {
1094 die 'Found both $STY and $TMUX, set $config{setting}{multiplexer}.';
1095 } elsif (defined $ENV{STY}) {
1096 $config{setting}{multiplexer} = 'screen';
1097 } elsif (defined $ENV{TMUX}) {
1098 $config{setting}{multiplexer} = 'tmux';
1100 die 'No multiplexer found.';
1104 my $binmode = $encoding;
1105 # GNU screen stores the screen dump for unknown reasons as ISO-8859-1
1106 # instead of the currently active encoding.
1107 if ($config{setting}{multiplexer} eq 'screen') {
1108 $binmode = 'ISO-8859-1';
1112 open my $fh, '<', $ARGV[0] or die $!;
1113 binmode $fh, ":encoding($binmode)" or die $!;
1116 push @input_lines, $_;
1118 close $fh or die $!;
1120 my $input = prepare_input($screen, \@input_lines);
1122 # Display original screen content.
1124 foreach (@{$input->{lines}}) {
1125 $screen->draw_simple($y++, 0, undef, $_);
1130 my $mapping = $config{setting}{initial_mode};
1134 if (not defined $mapping) {
1135 $key = $screen->getch unless defined $key;
1136 debug \%config, 'input', "got key '$key'";
1138 $mapping = $config{mapping}{mode}{$key};
1139 $mapping = $config{mapping}{simple}{$key} unless defined $mapping;
1140 if (not defined $mapping) { # ignore unknown mappings
1146 debug \%config, 'input', 'running mapping';
1147 my $result = $mapping->($key, $screen, \%config, $input);
1151 if (defined $result->{quit}) {
1152 debug \%config, 'input', 'quitting';
1155 if (defined $result->{key}) {
1156 $key = $result->{key}; # lookup another mapping
1157 debug \%config, 'input', "processing new key: '$key'";
1160 if (defined $result->{select}) {
1161 debug \%config, 'input', 'selecting match';
1163 $result = select_match($result->{select},
1164 $screen, \%config, $input,
1165 $result->{matches});
1166 $result->{handler} = $tmp->{handler};
1167 goto RESULT; # reprocess special entries in result
1169 if (defined $result->{match}) {
1170 debug \%config, 'input', 'running handler';
1171 my $handler = $config{state}{handler}; # set by user
1172 $handler = $result->{handler} unless defined $handler; # set by mapping
1173 $handler = \&handler_yank unless defined $handler; # fallback
1174 $handler->($screen, \%config, $result->{match});
1178 $key = undef; # get next key from user
1203 Invalid arguments/options.
1209 Simon Ruderich E<lt>simon@ruderich.orgE<gt>
1211 =head1 LICENSE AND COPYRIGHT
1213 Copyright (C) 2013-2016 by Simon Ruderich
1215 This program is free software: you can redistribute it and/or modify
1216 it under the terms of the GNU General Public License as published by
1217 the Free Software Foundation, either version 3 of the License, or
1218 (at your option) any later version.
1220 This program is distributed in the hope that it will be useful,
1221 but WITHOUT ANY WARRANTY; without even the implied warranty of
1222 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1223 GNU General Public License for more details.
1225 You should have received a copy of the GNU General Public License
1226 along with this program. If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
1230 L<screen(1)>, L<tmux(1)>, L<urlview(1)>