ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.230 by root, Sat Apr 26 20:51:12 2014 UTC vs.
Revision 1.235 by sf-exg, Sat May 17 15:33:24 2014 UTC

288Called whenever a user-configured event is being activated (e.g. via 288Called whenever a user-configured event is being activated (e.g. via
289a C<perl:string> action bound to a key, see description of the B<keysym> 289a C<perl:string> action bound to a key, see description of the B<keysym>
290resource in the urxvt(1) manpage). 290resource in the urxvt(1) manpage).
291 291
292The event is simply the action string. This interface is going away in 292The event is simply the action string. This interface is going away in
293preference to the C<< ->register_keysym_action >> method. 293preference to the C<on_action> hook.
294
295=item on_register_command $term, $keysym, $modifiermask, $string
296
297Called after parsing a keysym resource but before registering the
298associated binding. If this hook returns a true value the binding
299is not registered. It can be used to modify a binding by calling
300C<register_command>.
301 294
302=item on_resize_all_windows $term, $new_width, $new_height 295=item on_resize_all_windows $term, $new_width, $new_height
303 296
304Called just after the new window size has been calculated, but before 297Called just after the new window size has been calculated, but before
305windows are actually being resized or hints are being set. If this hook 298windows are actually being resized or hints are being set. If this hook
350manpage), with the additional members C<row> and C<col>, which are the 343manpage), with the additional members C<row> and C<col>, which are the
351(real, not screen-based) row and column under the mouse cursor. 344(real, not screen-based) row and column under the mouse cursor.
352 345
353C<on_key_press> additionally receives the string rxvt-unicode would 346C<on_key_press> additionally receives the string rxvt-unicode would
354output, if any, in locale-specific encoding. 347output, if any, in locale-specific encoding.
355
356subwindow.
357 348
358=item on_client_message $term, $event 349=item on_client_message $term, $event
359 350
360=item on_wm_protocols $term, $event 351=item on_wm_protocols $term, $event
361 352
566sub parse_resource { 557sub parse_resource {
567 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 558 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568 559
569 $name =~ y/-/./ if $isarg; 560 $name =~ y/-/./ if $isarg;
570 561
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; # reset iterator 565 keys %$r; # reset iterator
575 while (my ($pattern, $v) = each %$r) { 566 while (my ($pattern, $v) = each %$r) {
576 if ( 567 if (
596} 587}
597 588
598sub usage { 589sub usage {
599 my ($term, $usage_type) = @_; 590 my ($term, $usage_type) = @_;
600 591
601 $term->scan_meta; 592 $term->scan_extensions;
602 593
603 my $r = $term->{meta}{resource}; 594 my $r = $term->{meta}{resource};
604 595
605 for my $pattern (sort keys %$r) { 596 for my $pattern (sort keys %$r) {
606 my ($ext, $type, $desc) = @{ $r->{$pattern} }; 597 my ($ext, $type, $desc) = @{ $r->{$pattern} };
669 local $TERM = shift; 660 local $TERM = shift;
670 my $htype = shift; 661 my $htype = shift;
671 662
672 if ($htype == HOOK_INIT) { 663 if ($htype == HOOK_INIT) {
673 my @dirs = $TERM->perl_libdirs; 664 my @dirs = $TERM->perl_libdirs;
665
666 $TERM->scan_extensions;
674 667
675 my %ext_arg; 668 my %ext_arg;
676 669
677 { 670 {
678 my @init = @TERM_INIT; 671 my @init = @TERM_INIT;
716 709
717 if (my $cb = $TERM->{_hook}[$htype]) { 710 if (my $cb = $TERM->{_hook}[$htype]) {
718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 711 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
719 if $verbosity >= 10; 712 if $verbosity >= 10;
720 713
721 for my $pkg ( 714 if ($htype == HOOK_ACTION) {
722 # this hook is only sent to the extension with the name 715 # this hook is only sent to the extension with the name
723 # matching the first arg 716 # matching the first arg
724 $htype == HOOK_KEYBOARD_DISPATCH 717 my $pkg = shift;
725 ? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef 718 $pkg =~ y/-/_/;
726 : keys %$cb 719 $pkg = "urxvt::ext::$pkg";
720
721 $cb = $cb->{$pkg}
722 or return undef; #TODO: maybe warn user?
723
724 $cb = { $pkg => $cb };
727 ) { 725 }
726
727 for my $pkg (keys %$cb) {
728 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; 728 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
729 $retval ||= $retval_; 729 $retval ||= $retval_;
730 730
731 if ($@) { 731 if ($@) {
732 $TERM->ungrab; # better to lose the grab than the session 732 $TERM->ungrab; # better to lose the grab than the session
1071 $ENV{URXVT_PERL_LIB}, 1071 $ENV{URXVT_PERL_LIB},
1072 "$ENV{HOME}/.urxvt/ext", 1072 "$ENV{HOME}/.urxvt/ext",
1073 "$LIBDIR/perl" 1073 "$LIBDIR/perl"
1074} 1074}
1075 1075
1076sub scan_meta { 1076# scan for available extensions and collect their metadata
1077sub scan_extensions {
1077 my ($self) = @_; 1078 my ($self) = @_;
1079
1080 return if exists $self->{meta};
1081
1078 my @libdirs = perl_libdirs $self; 1082 my @libdirs = perl_libdirs $self;
1079 1083
1080 return if $self->{meta_libdirs} eq join "\x00", @libdirs; 1084 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1081 1085
1082 my %meta; 1086 my %meta;
1083 1087
1084 $self->{meta_libdirs} = join "\x00", @libdirs; 1088 $self->{meta_libdirs} = join "\x00", @libdirs;
1085 $self->{meta} = \%meta; 1089 $self->{meta} = \%meta;
1086 1090
1091 my %ext;
1092
1093 # first gather extensions
1087 for my $dir (reverse @libdirs) { 1094 for my $dir (reverse @libdirs) {
1088 opendir my $fh, $dir 1095 opendir my $fh, $dir
1089 or next; 1096 or next;
1090 for my $ext (readdir $fh) { 1097 for my $ext (readdir $fh) {
1091 $ext !~ /^\./ 1098 $ext !~ /^\./
1092 and open my $fh, "<", "$dir/$ext" 1099 and open my $fh, "<", "$dir/$ext"
1093 or next; 1100 or next;
1094 1101
1102 my %ext = (dir => $dir);
1103
1095 while (<$fh>) { 1104 while (<$fh>) {
1096 if (/^#:META:X_RESOURCE:(.*)/) { 1105 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1097 my ($pattern, $type, $desc) = split /:/, $1; 1106 my ($pattern, $type, $desc) = split /:/, $1;
1098 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1107 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1099 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1108 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1100 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1109 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1101 } else { 1110 } else {
1102 $meta{resource}{$pattern} = [$ext, $type, $desc]; 1111 $ext{resource}{$pattern} = [$ext, $type, $desc];
1103 } 1112 }
1113 } elsif (/^#:META:BINDING:(.*)/) {
1114 my ($keysym, $action) = split /:/, $1;
1115 $ext{binding}{$keysym} = $action;
1104 } elsif (/^\s*(?:#|$)/) { 1116 } elsif (/^\s*(?:#|$)/) {
1105 # skip other comments and empty lines 1117 # skip other comments and empty lines
1106 } else { 1118 } else {
1107 last; # stop parsing on first non-empty non-comment line 1119 last; # stop parsing on first non-empty non-comment line
1108 } 1120 }
1109 } 1121 }
1122
1123 $meta{$ext} = \%ext;
1110 } 1124 }
1125 }
1126
1127 # and now merge resources and bindings
1128 while (my ($k, $v) = each %ext) {
1129 #TODO: should check for extensions overriding each other
1130 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1131 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1111 } 1132 }
1112} 1133}
1113 1134
1114=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1135=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1115 1136
1261 my $res = &x_resource; 1282 my $res = &x_resource;
1262 1283
1263 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1284 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1264} 1285}
1265 1286
1266=item $success = $term->parse_keysym ($key, $octets) 1287=item $success = $term->bind_action ($key, $octets)
1267 1288
1268Adds a key binding exactly as specified via a resource. See the 1289Adds a key binding exactly as specified via a C<keysym> resource. See the
1269C<keysym> resource in the urxvt(1) manpage. 1290C<keysym> resource in the urxvt(1) manpage.
1270
1271=item $term->register_command ($keysym, $modifiermask, $string)
1272
1273Adds a key binding. This is a lower level api compared to
1274C<parse_keysym>, as it expects a parsed key description, and can be
1275used only inside either the C<on_init> hook, to add a binding, or the
1276C<on_register_command> hook, to modify a parsed binding.
1277 1291
1278=item $rend = $term->rstyle ([$new_rstyle]) 1292=item $rend = $term->rstyle ([$new_rstyle])
1279 1293
1280Return and optionally change the current rendition. Text that is output by 1294Return and optionally change the current rendition. Text that is output by
1281the terminal application will use this style. 1295the terminal application will use this style.
1461=item $term->tt_write ($octets) 1475=item $term->tt_write ($octets)
1462 1476
1463Write the octets given in C<$octets> to the tty (i.e. as program input). To 1477Write the octets given in C<$octets> to the tty (i.e. as program input). To
1464pass characters instead of octets, you should convert your strings first 1478pass characters instead of octets, you should convert your strings first
1465to the locale-specific encoding using C<< $term->locale_encode >>. 1479to the locale-specific encoding using C<< $term->locale_encode >>.
1480
1481=item $term->tt_write_user_input ($octets)
1482
1483Like C<tt_write>, but should be used when writing strings in response to
1484the user pressing a key, to invokes the additional actions requested by
1485the user for that case (C<tt_write> doesn't do that).
1486
1487The typical use case would be inside C<on_action> hooks.
1466 1488
1467=item $term->tt_paste ($octets) 1489=item $term->tt_paste ($octets)
1468 1490
1469Write the octets given in C<$octets> to the tty as a paste, converting NL to 1491Write the octets given in C<$octets> to the tty as a paste, converting NL to
1470CR and bracketing the data with control sequences if bracketed paste mode 1492CR and bracketing the data with control sequences if bracketed paste mode

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines