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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.238 by root, Sun May 18 18:15:04 2014 UTC vs.
Revision 1.245 by root, Mon Dec 22 09:10:12 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 comments in extensions that define
+different types of metadata:
+=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.
+=item #:META:BINDING:sym:action
+The BINDING comment defines a default binding for an action provided
+by the extension, where C<sym> is the key combination that triggers
+the action, whose format is defined in the description of the
+B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
+of the action method.
+=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>
 no warnings 'utf8';
 sub parse_resource {
    my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
-   $name =~ y/-/./ if $isarg;
    $term->scan_extensions;
    my $r = $term->{meta}{resource};
    keys %$r; # reset iterator
-   while (my ($pattern, $v) = each %$r) {
+   while (my ($k, $v) = each %$r) {
-      if (
+      my $pattern = $k;
+      $pattern =~ y/./-/ if $isarg;
+      my $prefix = $name;
+      my $suffix;
-         $pattern =~ /\.$/
+      if ($pattern =~ /\-$/) {
-         ? $pattern eq substr $name, 0, length $pattern
+         $prefix = substr $name, 0, length $pattern;
-         : $pattern eq $name
+         $suffix = substr $name, length $pattern;
-      ) {
+      }
+      if ($pattern eq $prefix) {
-         $name = "$urxvt::RESCLASS.$name";
+         $name = "$urxvt::RESCLASS.$k$suffix";
          push @{ $term->{perl_ext_3} }, $v->[0];
          if ($v->[1] eq "boolean") {
             $term->put_option_db ($name, $flag ? "true" : "false");
          @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),
-                  map $_->[0], values %{ $TERM->{meta}{binding} },
+                  map $_->[0], values %{ $TERM->{meta}{binding} };
-                  @{ delete $TERM->{perl_ext_3} };
             for ($TERM->_keysym_resources) {
                next if /^(?:string|command|builtin|builtin-string|perl)/;
                next unless /^([A-Za-z0-9_\-]+):/;
                my $ext = $1;
-               $ext =~ y/-/_/;
                $ext_arg{$ext} = [];
             }
          } elsif (/^-(.*)$/) {
 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.
 =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 invokes the additional actions requested by
+the user pressing a key, to invoke the additional actions requested by
 the user for that case (C<tt_write> doesn't do that).
 The typical use case would be inside C<on_action> hooks.
 =item $term->tt_paste ($octets)

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.238 by root, Sun May 18 18:15:04 2014 UTC vs. Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.238 by root, Sun May 18 18:15:04 2014 UTC vs.
Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC