minor documentation improvements

[fcscs/fcscs.git] / bin / fcscs

diff --git a/bin/fcscs b/bin/fcscs
index 9c33fe95ca06d3c9f7bcc05e261d620af02923d4..b2bef5d38dc0ae6d372fdc28bbabdd4c14b6d7d1 100755 (executable)
--- a/bin/fcscs
+++ b/bin/fcscs
@@ -54,6 +54,28 @@ None so far.
 
 =head1 USAGE
 
 
 =head1 USAGE
 

+Short overview of the general usage, details below:
+
+    - start fcscs
+    - configure actions (optional)
+        - enable pasting
+        - ...
+    - select mode (optional, URL mode is used on startup):
+        - f: file paths
+        - u: URLs
+        - ...
+        - /: search mode
+    - for `normal' modes:
+        - select match by displayed number or <return> for lowest numbered
+          match
+        - configured action is run, e.g. URL is opened with browser
+    - for `search' mode:
+        - perform incremental search
+        - on <return> go to `normal' mode to select a match
+        - after the match is selected wait for confirmation or extension
+        - confirmation: <return> run previously selected action
+        - extension: change match, e.g. select complete word or line
+

 GNU Screen setup (add to F<~/.screenrc>):
 
     bind ^B eval "hardcopy $HOME/.tmp/screen-fcscs" "screen fcscs $HOME/.tmp/screen-fcscs"
 GNU Screen setup (add to F<~/.screenrc>):
 
     bind ^B eval "hardcopy $HOME/.tmp/screen-fcscs" "screen fcscs $HOME/.tmp/screen-fcscs"


@@ -87,16 +109,18 @@ explained below. Per default URLs are selected, see options for a way to
 change this.
 
 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to
 change this.
 
 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to

-GNU screen/Tmux without exposing it to C<ps ux> or C<top>. However this may
+GNU screen/Tmux without exposing it to C<ps aux> or C<top>. However this may

 leak data if those temporary files are written to disk. To prevent this change
 leak data if those temporary files are written to disk. To prevent this change

-your C<$TMP> accordingly to point to a memory-only location or encrypted
-storage.
+your C<$TMP> to point to a memory-only location or encrypted storage.

 
 If no window appears, try running B<fcscs> manually to catch the error message
 and please report the bug:
 
     fcscs /path/to/screen-or-tmux-fcscs-file
 
 
 If no window appears, try running B<fcscs> manually to catch the error message
 and please report the bug:
 
     fcscs /path/to/screen-or-tmux-fcscs-file
 

+
+=head1 MODES
+

 =cut
 
 
 =cut
 
 


@@ -344,7 +368,18 @@ package Screen {
 sub debug {
     my ($config, $module, @args) = @_;
 
 sub debug {
     my ($config, $module, @args) = @_;
 

-    say STDERR "$module: @args" if $config->{setting}{debug};
+    return if not $config->{setting}{debug};
+
+    state $fh; # only open the file once per run
+    if (not defined $fh) {
+        # Ignore errors if the directory doesn't exist.
+        if (not open $fh, '>', "$ENV{HOME}/.config/fcscs/log") {
+            $fh = undef; # a failed open still writes a value to $fh
+            return;
+        }
+    }
+
+    say $fh "$module: @args";

     return;
 }
 
     return;
 }
 


@@ -390,7 +425,7 @@ sub get_regex_matches {
 
         my ($x, $y) = input_match_offset_to_coordinates($input->{width},
                                                         $offset);
 
         my ($x, $y) = input_match_offset_to_coordinates($input->{width},
                                                         $offset);

-        push @matches, { x => $x, y => $y, string => $1 };
+        push @matches, { x => $x, y => $y, offset => $offset, string => $1 };

     }
     return @matches;
 }
     }
     return @matches;
 }


@@ -461,9 +496,6 @@ sub run_in_background {
         my $pid = fork;
         defined $pid or die $!;
         if ($pid == 0) { # child
         my $pid = fork;
         defined $pid or die $!;
         if ($pid == 0) { # child

-            # Disable debug mode as writing will fail with closed STDERR.
-            $config->{setting}{debug} = 0;
-

             $sub->();
         }
         exit;
             $sub->();
         }
         exit;


@@ -535,6 +567,8 @@ sub select_match {
         $screen->refresh;
     }
 
         $screen->refresh;
     }
 

+    $screen->draw_matches($config, $matches, []); # remove matches
+

     foreach (@{$matches}) {
         return { match => $_ } if $_->{id} == $number;
     }
     foreach (@{$matches}) {
         return { match => $_ } if $_->{id} == $number;
     }


@@ -542,6 +576,86 @@ sub select_match {
     return { match => undef };
 }
 
     return { match => undef };
 }
 

+sub extend_match_regex_left {
+    my ($line, $match, $regex) = @_;
+
+    my $s = reverse substr $line, 0, $match->{x};
+    if ($s =~ /^($regex)/) {
+        $match->{string}  = reverse($1) . $match->{string};
+        $match->{x}      -= length $1;
+        $match->{offset} -= length $1;
+    }
+    return;
+}
+sub extend_match_regex_right {
+    my ($line, $match, $regex) = @_;
+
+    my $s = substr $line, $match->{x} + length $match->{string};
+    if ($s =~ /^($regex)/) {
+        $match->{string} .= $1;
+    }
+    return;
+}
+sub extend_match {
+    my ($screen, $config, $input, $match) = @_;
+
+    debug $config, 'extend_match', 'started';
+
+    $screen->prompt(name => 'extend', value => undef);
+    $screen->draw_prompt($config);
+
+    delete $match->{id}; # don't draw any match ids
+    $screen->draw_matches($config, [], [$match]);
+    $screen->refresh;
+
+    my $line = $input->{lines}[$match->{y}];
+
+    while (1) {
+        my $match_old = \%{$match};
+
+        my $char = $screen->getch;
+        if ($char eq "\n") { # accept match
+            last;
+
+        } elsif ($char eq 'w') { # select current word (both directions)
+            extend_match_regex_left($line,  $match, qr/\w+/);
+            extend_match_regex_right($line, $match, qr/\w+/);
+        } elsif ($char eq 'b') { # select current word (only left)
+            extend_match_regex_left($line,  $match, qr/\w+/);
+        } elsif ($char eq 'e') { # select current word (only right)
+            extend_match_regex_right($line, $match, qr/\w+/);
+
+        } elsif ($char eq 'W') { # select current WORD (both directions)
+            extend_match_regex_left($line,  $match, qr/\S+/);
+            extend_match_regex_right($line, $match, qr/\S+/);
+        } elsif ($char eq 'B') { # select current WORD (only left)
+            extend_match_regex_left($line,  $match, qr/\S+/);
+        } elsif ($char eq 'E') { # select current WORD (only right)
+            extend_match_regex_right($line, $match, qr/\S+/);
+
+        } elsif ($char eq '^') { # select to beginning of line
+            extend_match_regex_left($line, $match, qr/.+/);
+        } elsif ($char eq '$') { # select to end of line
+            extend_match_regex_right($line, $match, qr/.+/);
+
+        # Allow mode changes if not overwritten by local mappings.
+        } elsif (defined $config->{mapping}{mode}{$char}) {
+            $screen->draw_matches($config, [$match_old], []); # clear match
+            return { key => $char };
+
+        } else {
+            next; # ignore unknown mappings
+        }
+
+        $screen->draw_matches($config, [$match_old], [$match]);
+        $screen->refresh;
+    }
+
+    debug $config, 'extend_match', 'done';
+
+    return { match => $match };
+}
+

 
 sub mapping_paste {
     my ($key, $screen, $config, $input) = @_;
 
 sub mapping_paste {
     my ($key, $screen, $config, $input) = @_;


@@ -571,6 +685,22 @@ sub mapping_yank {
 }
 
 
 }
 
 

+=head2 NORMAL MODES
+
+Normal modes select matches by calling a function which returns them, e.g. by
+using a regex.
+
+The following normal modes are available:
+
+=over 4
+
+=item B<path mode> select relative/absolute paths
+
+=item B<url mode>  select URLs
+
+=back
+
+=cut

 sub mapping_mode_path {
     my ($key, $screen, $config, $input) = @_;
 
 sub mapping_mode_path {
     my ($key, $screen, $config, $input) = @_;
 


@@ -596,6 +726,40 @@ sub mapping_mode_url {
     };
 }
 
     };
 }
 

+=head2 SEARCH MODE (AND EXTEND MODE)
+
+Search mode is a special mode which lets you type a search string (a Perl
+regex) and then select one of the matches. Afterwards you can extend the
+match. For example select the complete word or to the end of the line. This
+allows quick selection of arbitrary text.
+
+The following mappings are available during the extension mode (not
+configurable at the moment):
+
+=over 4
+
+=item B<w> select current word
+
+=item B<b> extend word to the left
+
+=item B<e> extend word to the right
+
+=item B<W> select current WORD
+
+=item B<B> extend WORD to the left
+
+=item B<E> extend WORD to the right
+
+=item B<^> extend to beginning of line
+
+=item B<$> extend to end of line
+
+=back
+
+C<word> includes any characters matching C<\w+>, C<WORD> any non-whitespace
+characters (C<\S+>), just like in Vim.
+
+=cut

 sub mapping_mode_search {
     my ($key, $screen, $config, $input) = @_;
 
 sub mapping_mode_search {
     my ($key, $screen, $config, $input) = @_;
 


@@ -651,6 +815,7 @@ sub mapping_mode_search {
     return {
         select  => 'search',
         matches => \@last_matches,
     return {
         select  => 'search',
         matches => \@last_matches,

+        extend  => 1,

         handler => $config->{handler}{yank},
     };
 }
         handler => $config->{handler}{yank},
     };
 }


@@ -904,7 +1069,7 @@ Defaults in parentheses.
 
 =over
 
 
 =over
 

-=item B<debug>          enable debug mode (redirect stderr when enabling) (C<0>)
+=item B<debug>          enable debug mode, writes to I<~/.config/fcscs/log> (C<0>)

 
 =item B<initial_mode>   start in this mode, must be a valid mode mapping (C<\&mapping_mode_url>)
 
 
 =item B<initial_mode>   start in this mode, must be a valid mode mapping (C<\&mapping_mode_url>)
 


@@ -945,7 +1110,7 @@ my %setting = (
 
 =over
 
 
 =over
 

-=item B<url> used by C<\&mapping_mode_url()>
+=item B<url>  used by C<\&mapping_mode_url()>

 
 =item B<path> used by C<\&mapping_mode_path()>
 
 
 =item B<path> used by C<\&mapping_mode_path()>
 


@@ -1034,6 +1199,7 @@ Used as mappings, see L</MAPPINGS> above.
 
 Used as handler to yank, paste selection or open URL in browser.
 
 
 Used as handler to yank, paste selection or open URL in browser.
 

+    debug()

     get_regex_matches()
     select_match()
     run_command()
     get_regex_matches()
     select_match()
     run_command()


@@ -1066,6 +1232,8 @@ package Fcscs {
     sub handler_paste { return main::handler_paste(@_); }
     sub handler_url { return main::handler_url(@_); }
 
     sub handler_paste { return main::handler_paste(@_); }
     sub handler_url { return main::handler_url(@_); }
 

+    sub debug { return main::debug(@_); }
+

     sub get_regex_matches { return main::get_regex_matches(@_); }
     sub select_match { return main::select_match(@_); }
 
     sub get_regex_matches { return main::get_regex_matches(@_); }
     sub select_match { return main::select_match(@_); }
 


@@ -1203,6 +1371,13 @@ RESULT:
                                 $screen, \%config, $input,
                                 $result->{matches});
             $result->{handler} = $tmp->{handler};
                                 $screen, \%config, $input,
                                 $result->{matches});
             $result->{handler} = $tmp->{handler};

+            $result->{extend}  = $tmp->{extend};
+            goto RESULT; # reprocess special entries in result
+        }
+        if (defined $result->{extend}) {
+            debug \%config, 'input', 'extending match';
+            $result = extend_match($screen, \%config, $input,
+                                   $result->{match});

             goto RESULT; # reprocess special entries in result
         }
         if (defined $result->{match}) {
             goto RESULT; # reprocess special entries in result
         }
         if (defined $result->{match}) {


@@ -1211,11 +1386,20 @@ RESULT:
             }
 
             debug \%config, 'input', 'running handler';
             }
 
             debug \%config, 'input', 'running handler';

-            my $handler = $config{state}{handler};                 # set by user
-            $handler = $result->{match}->{handler} unless defined $handler; # set by match
-            $handler = $result->{handler} unless defined $handler; # set by mapping
-            $handler = $config{handler}{yank} unless defined $handler; # fallback
-            $handler->($screen, \%config, $result->{match});
+
+            # Choose handler with falling priority.
+            my @handlers = (
+                $config{state}{handler},     # set by user
+                $result->{match}->{handler}, # set by match
+                $result->{handler},          # set by mapping
+                $config{handler}{yank},      # fallback
+            );
+            foreach my $handler (@handlers) {
+                next unless defined $handler;
+
+                $handler->($screen, \%config, $result->{match});
+                last;
+            }

             last;
         }
 
             last;
         }