[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC vs.
Revision 1.248 by root, Fri Dec 26 21:01:46 2014 UTC

 Or by adding them to the resource for extensions loaded by default:
   URxvt.perl-ext-common: default,selection-autotransform
-Extensions that add command line parameters or resources on their own are
+Extensions may add additional resources and C<actions>, i.e., methods
-loaded automatically when used.
+which can be bound to a key and invoked by the user. An extension can
+define the resources it support and also default bindings for one or
+more actions it provides using so called META comments, described
+below. Similarly to builtin resources, extension resources can also be
+specified on the command line as long options (with C<.> replaced by
+C<->), in which case the corresponding extension is loaded
+automatically. For this to work the extension B<must> define META
+comments for its resources.
 =head1 API DOCUMENTATION
 =head2 General API Considerations
 C<urxvt::term> class on this object.
 Additional methods only supported for extension objects are described in
 the C<urxvt::extension> section below.
+=head2 META comments
+Rxvt-unicode recognizes special meta comments in extensions that define
+different types of metadata.
+Currently, it recxognises only one such comment:
+=over 4
+=item #:META:RESOURCE:name:type:desc
+The RESOURCE comment defines a resource used by the extension, where
+C<name> is the resource name, C<type> is the resource type, C<boolean>
+or C<string>, and C<desc> is the resource description.
+=back
 =head2 Hooks
 The following subroutines can be declared in extension files, and will be
 called whenever the relevant event happens.
 code is run after this hook, and takes precedence.
 =item on_refresh_end $term
 Called just after the screen gets redrawn. See C<on_refresh_begin>.
+=item on_action $term, $string
+Called whenever an action is invoked for the corresponding extension
+(e.g. via a C<extension:string> builtin action bound to a key, see
+description of the B<keysym> resource in the urxvt(1) manpage). The
+event is simply the action string. Note that an action event is always
+associated to a single extension.
 =item on_user_command $term, $string *DEPRECATED*
 Called whenever a user-configured event is being activated (e.g. via
 a C<perl:string> action bound to a key, see description of the B<keysym>
          @TERM_EXT = ();
          $TERM->register_package ($_) for @pkg;
       }
       for (
-         grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
+         (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
+         @{ delete $TERM->{perl_ext_3} }
       ) {
          if ($_ eq "default") {
             $ext_arg{$_} = []
-               for
-                  qw(selection option-popup selection-popup readline),
+               for qw(selection option-popup selection-popup readline searchable-scrollback);
-                  @{ delete $TERM->{perl_ext_3} },
-                  map $_->[0], values %{ $TERM->{meta}{binding} };
             for ($TERM->_keysym_resources) {
                next if /^(?:string|command|builtin|builtin-string|perl)/;
                next unless /^([A-Za-z0-9_\-]+):/;
          } elsif (/^([^<]+)<(.*)>$/) {
             push @{ $ext_arg{$1} }, $2;
          } else {
             $ext_arg{$_} ||= [];
-         }
-      }
-      # now register default key bindings
-      for my $ext (sort keys %ext_arg) {
-         while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
-            $TERM->bind_action ($k, "$v->[0]:$v->[1]");
          }
       }
       for my $ext (sort keys %ext_arg) {
          my @files = grep -f $_, map "$_/$ext", @dirs;
    }
    bless \%disable, "urxvt::extension::on_disable"
 }
+=item $self->bind_action ($hotkey, $action)
 =item $self->x_resource ($pattern)
 =item $self->x_resource_boolean ($pattern)
-These methods support an additional C<%> prefix when called on an
+These methods support an additional C<%> prefix for C<$action> or
-extension object - see the description of these methods in the
+C<$pattern> when called on an extension object, compared to the
+C<urxvt::term> methods of the same name - see the description of these
-C<urxvt::term> class for details.
+methods in the C<urxvt::term> class for details.
 =cut
+sub bind_action {
+   my ($self, $hotkey, $action) = @_;
+   $action =~ s/^%:/$_[0]{_name}:/;
+   $self->{term}->bind_action ($hotkey, $action)
+}
 sub x_resource {
    my ($self, $name) = @_;
    $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
    $self->{term}->x_resource ($name)
                if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
                   warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
                } else {
                   $ext{resource}{$pattern} = [$ext, $type, $desc];
                }
-            } elsif (/^#:META:BINDING:(.*)/) {
-               my ($keysym, $action) = split /:/, $1;
-               $ext{binding}{$keysym} = [$ext, $action];
             } elsif (/^\s*(?:#|$)/) {
                # skip other comments and empty lines
             } else {
                last; # stop parsing on first non-empty non-comment line
             }
          $meta{ext}{$ext} = \%ext;
       }
    }
-   # and now merge resources and bindings
+   # and now merge resources
    while (my ($k, $v) = each %{ $meta{ext} }) {
       #TODO: should check for extensions overriding each other
       %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
-      %{ $meta{binding}  } = (%{ $meta{binding}  }, %{ $v->{binding}  });
    }
 }
 =item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
 Returns the X-Resource for the given pattern, excluding the program or
 class name, i.e.  C<< $term->x_resource ("boldFont") >> should return the
 same value as used by this instance of rxvt-unicode. Returns C<undef> if no
 resource with that pattern exists.
-Extensions that define extra resource or command line arguments also need
+Extensions that define extra resources also need to call this method
-to call this method to access their values.
+to access their values.
 If the method is called on an extension object (basically, from an
 extension), then the special prefix C<%.> will be replaced by the name of
 the extension and a dot, and the lone string C<%> will be replaced by the
 extension name itself. This makes it possible to code extensions so you
-can rename them and get a new set of commandline switches and resources
+can rename them and get a new set of resources without having to change
-without having to change the actual code.
+the actual code.
 This method should only be called during the C<on_start> hook, as there is
 only one resource database per display, and later invocations might return
 the wrong resources.
    my $res = &x_resource;
    $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
 }
-=item $success = $term->bind_action ($key, $octets)
+=item $success = $term->bind_action ($key, $action)
 Adds a key binding exactly as specified via a C<keysym> resource. See the
 C<keysym> resource in the urxvt(1) manpage.
+To add default bindings for an extension, the extension should call C<<
+->bind_action >> on it's C<init> hook for every such binding. Doing it
+in the C<init> hook allows users the override or remove the the binding
+again.
+Example: the C<searchable-scrollback> by default binds itself
+on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
+$term->bind_action >>.
+   sub init {
+      my ($self) = @_;
+      $self->bind_action ("M-s" => "%:start");
+   }
 =item $rend = $term->rstyle ([$new_rstyle])
 Return and optionally change the current rendition. Text that is output by
 the terminal application will use this style.
 =item $term->scr_add_lines ($string)
 Write the given text string to the screen, as if output by the application
 running inside the terminal. It may not contain command sequences (escape
-codes), but is free to use line feeds, carriage returns and tabs. The
+codes - see C<cmd_parse> for that), but is free to use line feeds,
-string is a normal text string, not in locale-dependent encoding.
+carriage returns and tabs. The string is a normal text string, not in
+locale-dependent encoding.
 Normally its not a good idea to use this function, as programs might be
 confused by changes in cursor position or scrolling. Its useful inside a
 C<on_add_lines> hook, though.
 locale-specific encoding of the terminal and can contain command sequences
 (escape codes) that will be interpreted.
 =item $term->tt_write ($octets)
-Write the octets given in C<$octets> to the tty (i.e. as program input). To
+Write the octets given in C<$octets> to the tty (i.e. as user input
+to the program, see C<cmd_parse> for the opposite direction). To pass
-pass characters instead of octets, you should convert your strings first
+characters instead of octets, you should convert your strings first to the
-to the locale-specific encoding using C<< $term->locale_encode >>.
+locale-specific encoding using C<< $term->locale_encode >>.
 =item $term->tt_write_user_input ($octets)
 Like C<tt_write>, but should be used when writing strings in response to
 the user pressing a key, to invoke the additional actions requested by

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC vs. Revision 1.248 by root, Fri Dec 26 21:01:46 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC vs.
Revision 1.248 by root, Fri Dec 26 21:01:46 2014 UTC