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.233 by sf-exg, Fri May 2 20:34:24 2014 UTC vs.
Revision 1.245 by root, Mon Dec 22 09:10:12 2014 UTC

43 43
44Or by adding them to the resource for extensions loaded by default: 44Or 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
48Extensions that add command line parameters or resources on their own are 48Extensions may add additional resources and C<actions>, i.e., methods
49loaded automatically when used. 49which can be bound to a key and invoked by the user. An extension can
50define the resources it support and also default bindings for one or
51more actions it provides using so called META comments, described
52below. Similarly to builtin resources, extension resources can also be
53specified on the command line as long options (with C<.> replaced by
54C<->), in which case the corresponding extension is loaded
55automatically. For this to work the extension B<must> define META
56comments for its resources.
50 57
51=head1 API DOCUMENTATION 58=head1 API DOCUMENTATION
52 59
53=head2 General API Considerations 60=head2 General API Considerations
54 61
106C<urxvt::term> class on this object. 113C<urxvt::term> class on this object.
107 114
108Additional methods only supported for extension objects are described in 115Additional methods only supported for extension objects are described in
109the C<urxvt::extension> section below. 116the C<urxvt::extension> section below.
110 117
118=head2 META comments
119
120rxvt-unicode recognizes special comments in extensions that define
121different types of metadata:
122
123=over 4
124
125=item #:META:RESOURCE:name:type:desc
126
127The RESOURCE comment defines a resource used by the extension, where
128C<name> is the resource name, C<type> is the resource type, C<boolean>
129or C<string>, and C<desc> is the resource description.
130
131=item #:META:BINDING:sym:action
132
133The BINDING comment defines a default binding for an action provided
134by the extension, where C<sym> is the key combination that triggers
135the action, whose format is defined in the description of the
136B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
137of the action method.
138
139=back
140
111=head2 Hooks 141=head2 Hooks
112 142
113The following subroutines can be declared in extension files, and will be 143The following subroutines can be declared in extension files, and will be
114called whenever the relevant event happens. 144called whenever the relevant event happens.
115 145
281 311
282=item on_refresh_end $term 312=item on_refresh_end $term
283 313
284Called just after the screen gets redrawn. See C<on_refresh_begin>. 314Called just after the screen gets redrawn. See C<on_refresh_begin>.
285 315
316=item on_action $term, $string
317
318Called whenever an action is invoked for the corresponding extension
319(e.g. via a C<extension:string> builtin action bound to a key, see
320description of the B<keysym> resource in the urxvt(1) manpage). The
321event is simply the action string. Note that an action event is always
322associated to a single extension.
323
286=item on_user_command $term, $string *DEPRECATED* 324=item on_user_command $term, $string *DEPRECATED*
287 325
288Called whenever a user-configured event is being activated (e.g. via 326Called 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> 327a C<perl:string> action bound to a key, see description of the B<keysym>
290resource in the urxvt(1) manpage). 328resource in the urxvt(1) manpage).
291 329
292The event is simply the action string. This interface is going away in 330The event is simply the action string. This interface is going away in
293preference to the C<< ->register_keysym_action >> method. 331preference to the C<on_action> hook.
294 332
295=item on_resize_all_windows $term, $new_width, $new_height 333=item on_resize_all_windows $term, $new_width, $new_height
296 334
297Called just after the new window size has been calculated, but before 335Called just after the new window size has been calculated, but before
298windows are actually being resized or hints are being set. If this hook 336windows are actually being resized or hints are being set. If this hook
555no warnings 'utf8'; 593no warnings 'utf8';
556 594
557sub parse_resource { 595sub parse_resource {
558 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 596 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
559 597
560 $name =~ y/-/./ if $isarg;
561
562 $term->scan_meta; 598 $term->scan_extensions;
563 599
564 my $r = $term->{meta}{resource}; 600 my $r = $term->{meta}{resource};
565 keys %$r; # reset iterator 601 keys %$r; # reset iterator
566 while (my ($pattern, $v) = each %$r) { 602 while (my ($k, $v) = each %$r) {
567 if ( 603 my $pattern = $k;
604 $pattern =~ y/./-/ if $isarg;
605 my $prefix = $name;
606 my $suffix;
568 $pattern =~ /\.$/ 607 if ($pattern =~ /\-$/) {
569 ? $pattern eq substr $name, 0, length $pattern 608 $prefix = substr $name, 0, length $pattern;
570 : $pattern eq $name 609 $suffix = substr $name, length $pattern;
571 ) { 610 }
611 if ($pattern eq $prefix) {
572 $name = "$urxvt::RESCLASS.$name"; 612 $name = "$urxvt::RESCLASS.$k$suffix";
573 613
574 push @{ $term->{perl_ext_3} }, $v->[0]; 614 push @{ $term->{perl_ext_3} }, $v->[0];
575 615
576 if ($v->[1] eq "boolean") { 616 if ($v->[1] eq "boolean") {
577 $term->put_option_db ($name, $flag ? "true" : "false"); 617 $term->put_option_db ($name, $flag ? "true" : "false");
587} 627}
588 628
589sub usage { 629sub usage {
590 my ($term, $usage_type) = @_; 630 my ($term, $usage_type) = @_;
591 631
592 $term->scan_meta; 632 $term->scan_extensions;
593 633
594 my $r = $term->{meta}{resource}; 634 my $r = $term->{meta}{resource};
595 635
596 for my $pattern (sort keys %$r) { 636 for my $pattern (sort keys %$r) {
597 my ($ext, $type, $desc) = @{ $r->{$pattern} }; 637 my ($ext, $type, $desc) = @{ $r->{$pattern} };
661 my $htype = shift; 701 my $htype = shift;
662 702
663 if ($htype == HOOK_INIT) { 703 if ($htype == HOOK_INIT) {
664 my @dirs = $TERM->perl_libdirs; 704 my @dirs = $TERM->perl_libdirs;
665 705
706 $TERM->scan_extensions;
707
666 my %ext_arg; 708 my %ext_arg;
667 709
668 { 710 {
669 my @init = @TERM_INIT; 711 my @init = @TERM_INIT;
670 @TERM_INIT = (); 712 @TERM_INIT = ();
673 @TERM_EXT = (); 715 @TERM_EXT = ();
674 $TERM->register_package ($_) for @pkg; 716 $TERM->register_package ($_) for @pkg;
675 } 717 }
676 718
677 for ( 719 for (
720 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
678 @{ delete $TERM->{perl_ext_3} }, 721 @{ delete $TERM->{perl_ext_3} }
679 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
680 ) { 722 ) {
681 if ($_ eq "default") { 723 if ($_ eq "default") {
682 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 724
725 $ext_arg{$_} = []
726 for
727 qw(selection option-popup selection-popup readline),
728 map $_->[0], values %{ $TERM->{meta}{binding} };
729
730 for ($TERM->_keysym_resources) {
731 next if /^(?:string|command|builtin|builtin-string|perl)/;
732 next unless /^([A-Za-z0-9_\-]+):/;
733
734 my $ext = $1;
735
736 $ext_arg{$ext} = [];
737 }
738
683 } elsif (/^-(.*)$/) { 739 } elsif (/^-(.*)$/) {
684 delete $ext_arg{$1}; 740 delete $ext_arg{$1};
741
685 } elsif (/^([^<]+)<(.*)>$/) { 742 } elsif (/^([^<]+)<(.*)>$/) {
686 push @{ $ext_arg{$1} }, $2; 743 push @{ $ext_arg{$1} }, $2;
744
687 } else { 745 } else {
688 $ext_arg{$_} ||= []; 746 $ext_arg{$_} ||= [];
747 }
748 }
749
750 # now register default key bindings
751 for my $ext (sort keys %ext_arg) {
752 while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
753 $TERM->bind_action ($k, "$v->[0]:$v->[1]");
689 } 754 }
690 } 755 }
691 756
692 for my $ext (sort keys %ext_arg) { 757 for my $ext (sort keys %ext_arg) {
693 my @files = grep -f $_, map "$_/$ext", @dirs; 758 my @files = grep -f $_, map "$_/$ext", @dirs;
707 772
708 if (my $cb = $TERM->{_hook}[$htype]) { 773 if (my $cb = $TERM->{_hook}[$htype]) {
709 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 774 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
710 if $verbosity >= 10; 775 if $verbosity >= 10;
711 776
712 for my $pkg ( 777 if ($htype == HOOK_ACTION) {
713 # this hook is only sent to the extension with the name 778 # this hook is only sent to the extension with the name
714 # matching the first arg 779 # matching the first arg
715 $htype == HOOK_KEYBOARD_DISPATCH 780 my $pkg = shift;
716 ? exists $cb->{"urxvt::ext::$_[0]"} ? "urxvt::ext::" . shift : return undef 781 $pkg =~ y/-/_/;
717 : keys %$cb 782 $pkg = "urxvt::ext::$pkg";
783
784 $cb = $cb->{$pkg}
785 or return undef; #TODO: maybe warn user?
786
787 $cb = { $pkg => $cb };
718 ) { 788 }
789
790 for my $pkg (keys %$cb) {
719 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; 791 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
720 $retval ||= $retval_; 792 $retval ||= $retval_;
721 793
722 if ($@) { 794 if ($@) {
723 $TERM->ungrab; # better to lose the grab than the session 795 $TERM->ungrab; # better to lose the grab than the session
1062 $ENV{URXVT_PERL_LIB}, 1134 $ENV{URXVT_PERL_LIB},
1063 "$ENV{HOME}/.urxvt/ext", 1135 "$ENV{HOME}/.urxvt/ext",
1064 "$LIBDIR/perl" 1136 "$LIBDIR/perl"
1065} 1137}
1066 1138
1067sub scan_meta { 1139# scan for available extensions and collect their metadata
1140sub scan_extensions {
1068 my ($self) = @_; 1141 my ($self) = @_;
1142
1143 return if exists $self->{meta};
1144
1069 my @libdirs = perl_libdirs $self; 1145 my @libdirs = perl_libdirs $self;
1070 1146
1071 return if $self->{meta_libdirs} eq join "\x00", @libdirs; 1147# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1072 1148
1073 my %meta;
1074
1075 $self->{meta_libdirs} = join "\x00", @libdirs; 1149# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1076 $self->{meta} = \%meta; 1150 $self->{meta} = \my %meta;
1077 1151
1152 # first gather extensions
1078 for my $dir (reverse @libdirs) { 1153 for my $dir (reverse @libdirs) {
1079 opendir my $fh, $dir 1154 opendir my $fh, $dir
1080 or next; 1155 or next;
1081 for my $ext (readdir $fh) { 1156 for my $ext (readdir $fh) {
1082 $ext !~ /^\./ 1157 $ext !~ /^\./
1083 and open my $fh, "<", "$dir/$ext" 1158 and open my $fh, "<", "$dir/$ext"
1084 or next; 1159 or next;
1085 1160
1161 my %ext = (dir => $dir);
1162
1086 while (<$fh>) { 1163 while (<$fh>) {
1087 if (/^#:META:X_RESOURCE:(.*)/) { 1164 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1088 my ($pattern, $type, $desc) = split /:/, $1; 1165 my ($pattern, $type, $desc) = split /:/, $1;
1089 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1166 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1090 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1167 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1091 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1168 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1092 } else { 1169 } else {
1093 $meta{resource}{$pattern} = [$ext, $type, $desc]; 1170 $ext{resource}{$pattern} = [$ext, $type, $desc];
1094 } 1171 }
1172 } elsif (/^#:META:BINDING:(.*)/) {
1173 my ($keysym, $action) = split /:/, $1;
1174 $ext{binding}{$keysym} = [$ext, $action];
1095 } elsif (/^\s*(?:#|$)/) { 1175 } elsif (/^\s*(?:#|$)/) {
1096 # skip other comments and empty lines 1176 # skip other comments and empty lines
1097 } else { 1177 } else {
1098 last; # stop parsing on first non-empty non-comment line 1178 last; # stop parsing on first non-empty non-comment line
1099 } 1179 }
1100 } 1180 }
1181
1182 $meta{ext}{$ext} = \%ext;
1101 } 1183 }
1184 }
1185
1186 # and now merge resources and bindings
1187 while (my ($k, $v) = each %{ $meta{ext} }) {
1188 #TODO: should check for extensions overriding each other
1189 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1190 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1102 } 1191 }
1103} 1192}
1104 1193
1105=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1194=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1106 1195
1222Returns the X-Resource for the given pattern, excluding the program or 1311Returns the X-Resource for the given pattern, excluding the program or
1223class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1312class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1224same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1313same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1225resource with that pattern exists. 1314resource with that pattern exists.
1226 1315
1227Extensions that define extra resource or command line arguments also need 1316Extensions that define extra resources also need to call this method
1228to call this method to access their values. 1317to access their values.
1229 1318
1230If the method is called on an extension object (basically, from an 1319If the method is called on an extension object (basically, from an
1231extension), then the special prefix C<%.> will be replaced by the name of 1320extension), then the special prefix C<%.> will be replaced by the name of
1232the extension and a dot, and the lone string C<%> will be replaced by the 1321the extension and a dot, and the lone string C<%> will be replaced by the
1233extension name itself. This makes it possible to code extensions so you 1322extension name itself. This makes it possible to code extensions so you
1234can rename them and get a new set of commandline switches and resources 1323can rename them and get a new set of resources without having to change
1235without having to change the actual code. 1324the actual code.
1236 1325
1237This method should only be called during the C<on_start> hook, as there is 1326This method should only be called during the C<on_start> hook, as there is
1238only one resource database per display, and later invocations might return 1327only one resource database per display, and later invocations might return
1239the wrong resources. 1328the wrong resources.
1240 1329
1254 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1343 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1255} 1344}
1256 1345
1257=item $success = $term->bind_action ($key, $octets) 1346=item $success = $term->bind_action ($key, $octets)
1258 1347
1259Adds a key binding exactly as specified via a resource. See the 1348Adds a key binding exactly as specified via a C<keysym> resource. See the
1260C<keysym> resource in the urxvt(1) manpage. 1349C<keysym> resource in the urxvt(1) manpage.
1261 1350
1262=item $rend = $term->rstyle ([$new_rstyle]) 1351=item $rend = $term->rstyle ([$new_rstyle])
1263 1352
1264Return and optionally change the current rendition. Text that is output by 1353Return and optionally change the current rendition. Text that is output by
1423 1512
1424=item $term->scr_add_lines ($string) 1513=item $term->scr_add_lines ($string)
1425 1514
1426Write the given text string to the screen, as if output by the application 1515Write the given text string to the screen, as if output by the application
1427running inside the terminal. It may not contain command sequences (escape 1516running inside the terminal. It may not contain command sequences (escape
1428codes), but is free to use line feeds, carriage returns and tabs. The 1517codes - see C<cmd_parse> for that), but is free to use line feeds,
1429string is a normal text string, not in locale-dependent encoding. 1518carriage returns and tabs. The string is a normal text string, not in
1519locale-dependent encoding.
1430 1520
1431Normally its not a good idea to use this function, as programs might be 1521Normally its not a good idea to use this function, as programs might be
1432confused by changes in cursor position or scrolling. Its useful inside a 1522confused by changes in cursor position or scrolling. Its useful inside a
1433C<on_add_lines> hook, though. 1523C<on_add_lines> hook, though.
1434 1524
1442locale-specific encoding of the terminal and can contain command sequences 1532locale-specific encoding of the terminal and can contain command sequences
1443(escape codes) that will be interpreted. 1533(escape codes) that will be interpreted.
1444 1534
1445=item $term->tt_write ($octets) 1535=item $term->tt_write ($octets)
1446 1536
1447Write the octets given in C<$octets> to the tty (i.e. as program input). To 1537Write the octets given in C<$octets> to the tty (i.e. as user input
1538to the program, see C<cmd_parse> for the opposite direction). To pass
1448pass characters instead of octets, you should convert your strings first 1539characters instead of octets, you should convert your strings first to the
1449to the locale-specific encoding using C<< $term->locale_encode >>. 1540locale-specific encoding using C<< $term->locale_encode >>.
1541
1542=item $term->tt_write_user_input ($octets)
1543
1544Like C<tt_write>, but should be used when writing strings in response to
1545the user pressing a key, to invoke the additional actions requested by
1546the user for that case (C<tt_write> doesn't do that).
1547
1548The typical use case would be inside C<on_action> hooks.
1450 1549
1451=item $term->tt_paste ($octets) 1550=item $term->tt_paste ($octets)
1452 1551
1453Write the octets given in C<$octets> to the tty as a paste, converting NL to 1552Write the octets given in C<$octets> to the tty as a paste, converting NL to
1454CR and bracketing the data with control sequences if bracketed paste mode 1553CR and bracketing the data with control sequences if bracketed paste mode

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines