| … | |
… | |
| 43 | |
43 | |
| 44 | Or by adding them to the resource for extensions loaded by default: |
44 | Or by adding them to the resource for extensions loaded by default: |
| 45 | |
45 | |
| 46 | URxvt.perl-ext-common: default,selection-autotransform |
46 | URxvt.perl-ext-common: default,selection-autotransform |
| 47 | |
47 | |
| 48 | Extensions that add command line parameters or resources on their own are |
48 | Extensions may add resources on their own. Similarly to builtin |
| 49 | loaded automatically when used. |
49 | resources, these resources can also be specified on the command line |
|
|
50 | as long options (with '.' replaced by '-'), in which case the |
|
|
51 | corresponding extension is loaded automatically. |
| 50 | |
52 | |
| 51 | =head1 API DOCUMENTATION |
53 | =head1 API DOCUMENTATION |
| 52 | |
54 | |
| 53 | =head2 General API Considerations |
55 | =head2 General API Considerations |
| 54 | |
56 | |
| … | |
… | |
| 281 | |
283 | |
| 282 | =item on_refresh_end $term |
284 | =item on_refresh_end $term |
| 283 | |
285 | |
| 284 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
286 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
| 285 | |
287 | |
| 286 | =item on_user_command $term, $string |
288 | =item on_user_command $term, $string *DEPRECATED* |
| 287 | |
289 | |
| 288 | Called whenever a user-configured event is being activated (e.g. via |
290 | Called whenever a user-configured event is being activated (e.g. via |
| 289 | a C<perl:string> action bound to a key, see description of the B<keysym> |
291 | a C<perl:string> action bound to a key, see description of the B<keysym> |
| 290 | resource in the urxvt(1) manpage). |
292 | resource in the urxvt(1) manpage). |
| 291 | |
293 | |
| 292 | The event is simply the action string. This interface is assumed to change |
294 | The event is simply the action string. This interface is going away in |
| 293 | slightly in the future. |
295 | preference to the C<on_action> hook. |
| 294 | |
|
|
| 295 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
| 296 | |
|
|
| 297 | Called after parsing a keysym resource but before registering the |
|
|
| 298 | associated binding. If this hook returns TRUE the binding is not |
|
|
| 299 | registered. It can be used to modify a binding by calling |
|
|
| 300 | C<register_command>. |
|
|
| 301 | |
296 | |
| 302 | =item on_resize_all_windows $term, $new_width, $new_height |
297 | =item on_resize_all_windows $term, $new_width, $new_height |
| 303 | |
298 | |
| 304 | Called just after the new window size has been calculated, but before |
299 | Called just after the new window size has been calculated, but before |
| 305 | windows are actually being resized or hints are being set. If this hook |
300 | windows are actually being resized or hints are being set. If this hook |
| 306 | returns TRUE, setting of the window hints is being skipped. |
301 | returns a true value, setting of the window hints is being skipped. |
| 307 | |
302 | |
| 308 | =item on_x_event $term, $event |
303 | =item on_x_event $term, $event |
| 309 | |
304 | |
| 310 | Called on every X event received on the vt window (and possibly other |
305 | Called on every X event received on the vt window (and possibly other |
| 311 | windows). Should only be used as a last resort. Most event structure |
306 | windows). Should only be used as a last resort. Most event structure |
| … | |
… | |
| 350 | manpage), with the additional members C<row> and C<col>, which are the |
345 | manpage), with the additional members C<row> and C<col>, which are the |
| 351 | (real, not screen-based) row and column under the mouse cursor. |
346 | (real, not screen-based) row and column under the mouse cursor. |
| 352 | |
347 | |
| 353 | C<on_key_press> additionally receives the string rxvt-unicode would |
348 | C<on_key_press> additionally receives the string rxvt-unicode would |
| 354 | output, if any, in locale-specific encoding. |
349 | output, if any, in locale-specific encoding. |
| 355 | |
|
|
| 356 | subwindow. |
|
|
| 357 | |
350 | |
| 358 | =item on_client_message $term, $event |
351 | =item on_client_message $term, $event |
| 359 | |
352 | |
| 360 | =item on_wm_protocols $term, $event |
353 | =item on_wm_protocols $term, $event |
| 361 | |
354 | |
| … | |
… | |
| 564 | no warnings 'utf8'; |
557 | no warnings 'utf8'; |
| 565 | |
558 | |
| 566 | sub parse_resource { |
559 | sub parse_resource { |
| 567 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
560 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
| 568 | |
561 | |
| 569 | $name =~ y/-/./ if $isarg; |
|
|
| 570 | |
|
|
| 571 | $term->scan_meta; |
562 | $term->scan_extensions; |
| 572 | |
563 | |
| 573 | my $r = $term->{meta}{resource}; |
564 | my $r = $term->{meta}{resource}; |
| 574 | keys %$r; # reste iterator |
565 | keys %$r; # reset iterator |
| 575 | while (my ($pattern, $v) = each %$r) { |
566 | while (my ($k, $v) = each %$r) { |
| 576 | if ( |
567 | my $pattern = $k; |
|
|
568 | $pattern =~ y/./-/ if $isarg; |
|
|
569 | my $prefix = $name; |
|
|
570 | my $suffix; |
| 577 | $pattern =~ /\.$/ |
571 | if ($pattern =~ /\-$/) { |
| 578 | ? $pattern eq substr $name, 0, length $pattern |
572 | $prefix = substr $name, 0, length $pattern; |
| 579 | : $pattern eq $name |
573 | $suffix = substr $name, length $pattern; |
| 580 | ) { |
574 | } |
|
|
575 | if ($pattern eq $prefix) { |
| 581 | $name = "$urxvt::RESCLASS.$name"; |
576 | $name = "$urxvt::RESCLASS.$k$suffix"; |
| 582 | |
577 | |
| 583 | push @{ $term->{perl_ext_3} }, $v->[0]; |
578 | push @{ $term->{perl_ext_3} }, $v->[0]; |
| 584 | |
579 | |
| 585 | if ($v->[1] eq "boolean") { |
580 | if ($v->[1] eq "boolean") { |
| 586 | $term->put_option_db ($name, $flag ? "true" : "false"); |
581 | $term->put_option_db ($name, $flag ? "true" : "false"); |
| … | |
… | |
| 596 | } |
591 | } |
| 597 | |
592 | |
| 598 | sub usage { |
593 | sub usage { |
| 599 | my ($term, $usage_type) = @_; |
594 | my ($term, $usage_type) = @_; |
| 600 | |
595 | |
| 601 | $term->scan_meta; |
596 | $term->scan_extensions; |
| 602 | |
597 | |
| 603 | my $r = $term->{meta}{resource}; |
598 | my $r = $term->{meta}{resource}; |
| 604 | |
599 | |
| 605 | for my $pattern (sort keys %$r) { |
600 | for my $pattern (sort keys %$r) { |
| 606 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
601 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
| … | |
… | |
| 667 | # called by the rxvt core |
662 | # called by the rxvt core |
| 668 | sub invoke { |
663 | sub invoke { |
| 669 | local $TERM = shift; |
664 | local $TERM = shift; |
| 670 | my $htype = shift; |
665 | my $htype = shift; |
| 671 | |
666 | |
| 672 | if ($htype == 0) { # INIT |
667 | if ($htype == HOOK_INIT) { |
| 673 | my @dirs = $TERM->perl_libdirs; |
668 | my @dirs = $TERM->perl_libdirs; |
|
|
669 | |
|
|
670 | $TERM->scan_extensions; |
| 674 | |
671 | |
| 675 | my %ext_arg; |
672 | my %ext_arg; |
| 676 | |
673 | |
| 677 | { |
674 | { |
| 678 | my @init = @TERM_INIT; |
675 | my @init = @TERM_INIT; |
| … | |
… | |
| 682 | @TERM_EXT = (); |
679 | @TERM_EXT = (); |
| 683 | $TERM->register_package ($_) for @pkg; |
680 | $TERM->register_package ($_) for @pkg; |
| 684 | } |
681 | } |
| 685 | |
682 | |
| 686 | for ( |
683 | for ( |
| 687 | @{ delete $TERM->{perl_ext_3} }, |
|
|
| 688 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
684 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
| 689 | ) { |
685 | ) { |
| 690 | if ($_ eq "default") { |
686 | if ($_ eq "default") { |
| 691 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
687 | |
|
|
688 | $ext_arg{$_} = [] |
|
|
689 | for |
|
|
690 | qw(selection option-popup selection-popup readline), |
|
|
691 | @{ delete $TERM->{perl_ext_3} }, |
|
|
692 | map $_->[0], values %{ $TERM->{meta}{binding} }; |
|
|
693 | |
|
|
694 | for ($TERM->_keysym_resources) { |
|
|
695 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
696 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
697 | |
|
|
698 | my $ext = $1; |
|
|
699 | |
|
|
700 | $ext_arg{$ext} = []; |
|
|
701 | } |
|
|
702 | |
| 692 | } elsif (/^-(.*)$/) { |
703 | } elsif (/^-(.*)$/) { |
| 693 | delete $ext_arg{$1}; |
704 | delete $ext_arg{$1}; |
|
|
705 | |
| 694 | } elsif (/^([^<]+)<(.*)>$/) { |
706 | } elsif (/^([^<]+)<(.*)>$/) { |
| 695 | push @{ $ext_arg{$1} }, $2; |
707 | push @{ $ext_arg{$1} }, $2; |
|
|
708 | |
| 696 | } else { |
709 | } else { |
| 697 | $ext_arg{$_} ||= []; |
710 | $ext_arg{$_} ||= []; |
|
|
711 | } |
|
|
712 | } |
|
|
713 | |
|
|
714 | # now register default key bindings |
|
|
715 | for my $ext (sort keys %ext_arg) { |
|
|
716 | while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { |
|
|
717 | $TERM->bind_action ($k, "$v->[0]:$v->[1]"); |
| 698 | } |
718 | } |
| 699 | } |
719 | } |
| 700 | |
720 | |
| 701 | for my $ext (sort keys %ext_arg) { |
721 | for my $ext (sort keys %ext_arg) { |
| 702 | my @files = grep -f $_, map "$_/$ext", @dirs; |
722 | my @files = grep -f $_, map "$_/$ext", @dirs; |
| … | |
… | |
| 716 | |
736 | |
| 717 | if (my $cb = $TERM->{_hook}[$htype]) { |
737 | if (my $cb = $TERM->{_hook}[$htype]) { |
| 718 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
738 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
| 719 | if $verbosity >= 10; |
739 | if $verbosity >= 10; |
| 720 | |
740 | |
|
|
741 | if ($htype == HOOK_ACTION) { |
|
|
742 | # this hook is only sent to the extension with the name |
|
|
743 | # matching the first arg |
|
|
744 | my $pkg = shift; |
|
|
745 | $pkg =~ y/-/_/; |
|
|
746 | $pkg = "urxvt::ext::$pkg"; |
|
|
747 | |
|
|
748 | $cb = $cb->{$pkg} |
|
|
749 | or return undef; #TODO: maybe warn user? |
|
|
750 | |
|
|
751 | $cb = { $pkg => $cb }; |
|
|
752 | } |
|
|
753 | |
| 721 | for my $pkg (keys %$cb) { |
754 | for my $pkg (keys %$cb) { |
| 722 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
755 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
| 723 | $retval ||= $retval_; |
756 | $retval ||= $retval_; |
| 724 | |
757 | |
| 725 | if ($@) { |
758 | if ($@) { |
| … | |
… | |
| 730 | |
763 | |
| 731 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
764 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
| 732 | if $verbosity >= 11; |
765 | if $verbosity >= 11; |
| 733 | } |
766 | } |
| 734 | |
767 | |
| 735 | if ($htype == 1) { # DESTROY |
768 | if ($htype == HOOK_DESTROY) { |
| 736 | # clear package objects |
769 | # clear package objects |
| 737 | %$_ = () for values %{ $TERM->{_pkg} }; |
770 | %$_ = () for values %{ $TERM->{_pkg} }; |
| 738 | |
771 | |
| 739 | # clear package |
772 | # clear package |
| 740 | %$TERM = (); |
773 | %$TERM = (); |
| … | |
… | |
| 827 | } |
860 | } |
| 828 | |
861 | |
| 829 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
862 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
| 830 | |
863 | |
| 831 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
864 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
| 832 | this extension, replacing any previous hook. This is useful when you want |
865 | this extension, replacing any hook previously installed via C<enable> in |
| 833 | to overwrite time-critical hooks only temporarily. |
866 | this extension. |
|
|
867 | |
|
|
868 | This is useful when you want to overwrite time-critical hooks only |
|
|
869 | temporarily. |
| 834 | |
870 | |
| 835 | To install additional callbacks for the same hook, you can use the C<on> |
871 | To install additional callbacks for the same hook, you can use the C<on> |
| 836 | method of the C<urxvt::term> class. |
872 | method of the C<urxvt::term> class. |
| 837 | |
873 | |
| 838 | =item $self->disable ($hook_name[, $hook_name..]) |
874 | =item $self->disable ($hook_name[, $hook_name..]) |
| … | |
… | |
| 1062 | $ENV{URXVT_PERL_LIB}, |
1098 | $ENV{URXVT_PERL_LIB}, |
| 1063 | "$ENV{HOME}/.urxvt/ext", |
1099 | "$ENV{HOME}/.urxvt/ext", |
| 1064 | "$LIBDIR/perl" |
1100 | "$LIBDIR/perl" |
| 1065 | } |
1101 | } |
| 1066 | |
1102 | |
| 1067 | sub scan_meta { |
1103 | # scan for available extensions and collect their metadata |
|
|
1104 | sub scan_extensions { |
| 1068 | my ($self) = @_; |
1105 | my ($self) = @_; |
|
|
1106 | |
|
|
1107 | return if exists $self->{meta}; |
|
|
1108 | |
| 1069 | my @libdirs = perl_libdirs $self; |
1109 | my @libdirs = perl_libdirs $self; |
| 1070 | |
1110 | |
| 1071 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
1111 | # return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d# |
| 1072 | |
1112 | |
| 1073 | my %meta; |
|
|
| 1074 | |
|
|
| 1075 | $self->{meta_libdirs} = join "\x00", @libdirs; |
1113 | # $self->{meta_libdirs} = join "\x00", @libdirs;#d# |
| 1076 | $self->{meta} = \%meta; |
1114 | $self->{meta} = \my %meta; |
| 1077 | |
1115 | |
|
|
1116 | # first gather extensions |
| 1078 | for my $dir (reverse @libdirs) { |
1117 | for my $dir (reverse @libdirs) { |
| 1079 | opendir my $fh, $dir |
1118 | opendir my $fh, $dir |
| 1080 | or next; |
1119 | or next; |
| 1081 | for my $ext (readdir $fh) { |
1120 | for my $ext (readdir $fh) { |
| 1082 | $ext !~ /^\./ |
1121 | $ext !~ /^\./ |
| 1083 | and open my $fh, "<", "$dir/$ext" |
1122 | and open my $fh, "<", "$dir/$ext" |
| 1084 | or next; |
1123 | or next; |
| 1085 | |
1124 | |
|
|
1125 | my %ext = (dir => $dir); |
|
|
1126 | |
| 1086 | while (<$fh>) { |
1127 | while (<$fh>) { |
| 1087 | if (/^#:META:X_RESOURCE:(.*)/) { |
1128 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
| 1088 | my ($pattern, $type, $desc) = split /:/, $1; |
1129 | my ($pattern, $type, $desc) = split /:/, $1; |
| 1089 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1130 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
| 1090 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1131 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
| 1091 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1132 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
| 1092 | } else { |
1133 | } else { |
| 1093 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1134 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
| 1094 | } |
1135 | } |
|
|
1136 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
1137 | my ($keysym, $action) = split /:/, $1; |
|
|
1138 | $ext{binding}{$keysym} = [$ext, $action]; |
| 1095 | } elsif (/^\s*(?:#|$)/) { |
1139 | } elsif (/^\s*(?:#|$)/) { |
| 1096 | # skip other comments and empty lines |
1140 | # skip other comments and empty lines |
| 1097 | } else { |
1141 | } else { |
| 1098 | last; # stop parsing on first non-empty non-comment line |
1142 | last; # stop parsing on first non-empty non-comment line |
| 1099 | } |
1143 | } |
| 1100 | } |
1144 | } |
|
|
1145 | |
|
|
1146 | $meta{ext}{$ext} = \%ext; |
| 1101 | } |
1147 | } |
|
|
1148 | } |
|
|
1149 | |
|
|
1150 | # and now merge resources and bindings |
|
|
1151 | while (my ($k, $v) = each %{ $meta{ext} }) { |
|
|
1152 | #TODO: should check for extensions overriding each other |
|
|
1153 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
|
|
1154 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
| 1102 | } |
1155 | } |
| 1103 | } |
1156 | } |
| 1104 | |
1157 | |
| 1105 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1158 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
| 1106 | |
1159 | |
| … | |
… | |
| 1222 | Returns the X-Resource for the given pattern, excluding the program or |
1275 | Returns the X-Resource for the given pattern, excluding the program or |
| 1223 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1276 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
| 1224 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1277 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
| 1225 | resource with that pattern exists. |
1278 | resource with that pattern exists. |
| 1226 | |
1279 | |
| 1227 | Extensions that define extra resource or command line arguments also need |
1280 | Extensions that define extra resources also need to call this method |
| 1228 | to call this method to access their values. |
1281 | to access their values. |
| 1229 | |
1282 | |
| 1230 | If the method is called on an extension object (basically, from an |
1283 | If the method is called on an extension object (basically, from an |
| 1231 | extension), then the special prefix C<%.> will be replaced by the name of |
1284 | extension), then the special prefix C<%.> will be replaced by the name of |
| 1232 | the extension and a dot, and the lone string C<%> will be replaced by the |
1285 | the extension and a dot, and the lone string C<%> will be replaced by the |
| 1233 | extension name itself. This makes it possible to code extensions so you |
1286 | extension name itself. This makes it possible to code extensions so you |
| … | |
… | |
| 1252 | my $res = &x_resource; |
1305 | my $res = &x_resource; |
| 1253 | |
1306 | |
| 1254 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1307 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
| 1255 | } |
1308 | } |
| 1256 | |
1309 | |
| 1257 | =item $success = $term->parse_keysym ($key, $octets) |
1310 | =item $success = $term->bind_action ($key, $octets) |
| 1258 | |
1311 | |
| 1259 | Adds a key binding exactly as specified via a resource. See the |
1312 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
| 1260 | C<keysym> resource in the urxvt(1) manpage. |
1313 | C<keysym> resource in the urxvt(1) manpage. |
| 1261 | |
|
|
| 1262 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
| 1263 | |
|
|
| 1264 | Adds a key binding. This is a lower level api compared to |
|
|
| 1265 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
| 1266 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
| 1267 | C<on_register_command> hook, to modify a parsed binding. |
|
|
| 1268 | |
1314 | |
| 1269 | =item $rend = $term->rstyle ([$new_rstyle]) |
1315 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 1270 | |
1316 | |
| 1271 | Return and optionally change the current rendition. Text that is output by |
1317 | Return and optionally change the current rendition. Text that is output by |
| 1272 | the terminal application will use this style. |
1318 | the terminal application will use this style. |
| … | |
… | |
| 1452 | =item $term->tt_write ($octets) |
1498 | =item $term->tt_write ($octets) |
| 1453 | |
1499 | |
| 1454 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1500 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
| 1455 | pass characters instead of octets, you should convert your strings first |
1501 | pass characters instead of octets, you should convert your strings first |
| 1456 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1502 | to the locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1503 | |
|
|
1504 | =item $term->tt_write_user_input ($octets) |
|
|
1505 | |
|
|
1506 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1507 | the user pressing a key, to invoke the additional actions requested by |
|
|
1508 | the user for that case (C<tt_write> doesn't do that). |
|
|
1509 | |
|
|
1510 | The typical use case would be inside C<on_action> hooks. |
| 1457 | |
1511 | |
| 1458 | =item $term->tt_paste ($octets) |
1512 | =item $term->tt_paste ($octets) |
| 1459 | |
1513 | |
| 1460 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1514 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
| 1461 | CR and bracketing the data with control sequences if bracketed paste mode |
1515 | CR and bracketing the data with control sequences if bracketed paste mode |
