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.244 by sf-exg, Mon Oct 13 12:17:48 2014 UTC vs.
Revision 1.248 by root, Fri Dec 26 21:01:46 2014 UTC

… …
115Additional methods only supported for extension objects are described in 115Additional methods only supported for extension objects are described in
116the C<urxvt::extension> section below. 116the C<urxvt::extension> section below.
117 117
118=head2 META comments 118=head2 META comments
119 119
120rxvt-unicode recognizes special comments in extensions that define 120Rxvt-unicode recognizes special meta comments in extensions that define
121different types of metadata: 121different types of metadata.
122
123Currently, it recxognises only one such comment:
122 124
123=over 4 125=over 4
124 126
125=item #:META:RESOURCE:name:type:desc 127=item #:META:RESOURCE:name:type:desc
126 128
127The RESOURCE comment defines a resource used by the extension, where 129The RESOURCE comment defines a resource used by the extension, where
128C<name> is the resource name, C<type> is the resource type, C<boolean> 130C<name> is the resource name, C<type> is the resource type, C<boolean>
129or C<string>, and C<desc> is the resource description. 131or 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 132
139=back 133=back
140 134
141=head2 Hooks 135=head2 Hooks
142 136
… …
721 @{ delete $TERM->{perl_ext_3} } 715 @{ delete $TERM->{perl_ext_3} }
722 ) { 716 ) {
723 if ($_ eq "default") { 717 if ($_ eq "default") {
724 718
725 $ext_arg{$_} = [] 719 $ext_arg{$_} = []
726 for
727 qw(selection option-popup selection-popup readline), 720 for qw(selection option-popup selection-popup readline searchable-scrollback);
728 map $_->[0], values %{ $TERM->{meta}{binding} };
729 721
730 for ($TERM->_keysym_resources) { 722 for ($TERM->_keysym_resources) {
731 next if /^(?:string|command|builtin|builtin-string|perl)/; 723 next if /^(?:string|command|builtin|builtin-string|perl)/;
732 next unless /^([A-Za-z0-9_\-]+):/; 724 next unless /^([A-Za-z0-9_\-]+):/;
733 725
… …
742 } elsif (/^([^<]+)<(.*)>$/) { 734 } elsif (/^([^<]+)<(.*)>$/) {
743 push @{ $ext_arg{$1} }, $2; 735 push @{ $ext_arg{$1} }, $2;
744 736
745 } else { 737 } else {
746 $ext_arg{$_} ||= []; 738 $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]");
754 } 739 }
755 } 740 }
756 741
757 for my $ext (sort keys %ext_arg) { 742 for my $ext (sort keys %ext_arg) {
758 my @files = grep -f $_, map "$_/$ext", @dirs; 743 my @files = grep -f $_, map "$_/$ext", @dirs;
… …
981 } 966 }
982 967
983 bless \%disable, "urxvt::extension::on_disable" 968 bless \%disable, "urxvt::extension::on_disable"
984} 969}
985 970
971=item $self->bind_action ($hotkey, $action)
972
986=item $self->x_resource ($pattern) 973=item $self->x_resource ($pattern)
987 974
988=item $self->x_resource_boolean ($pattern) 975=item $self->x_resource_boolean ($pattern)
989 976
990These methods support an additional C<%> prefix when called on an 977These methods support an additional C<%> prefix for C<$action> or
991extension object - see the description of these methods in the 978C<$pattern> when called on an extension object, compared to the
979C<urxvt::term> methods of the same name - see the description of these
992C<urxvt::term> class for details. 980methods in the C<urxvt::term> class for details.
993 981
994=cut 982=cut
983
984sub bind_action {
985 my ($self, $hotkey, $action) = @_;
986 $action =~ s/^%:/$_[0]{_name}:/;
987 $self->{term}->bind_action ($hotkey, $action)
988}
995 989
996sub x_resource { 990sub x_resource {
997 my ($self, $name) = @_; 991 my ($self, $name) = @_;
998 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 992 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
999 $self->{term}->x_resource ($name) 993 $self->{term}->x_resource ($name)
… …
1167 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1161 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1168 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1162 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1169 } else { 1163 } else {
1170 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1164 $ext{resource}{$pattern} = [$ext, $type, $desc];
1171 } 1165 }
1172 } elsif (/^#:META:BINDING:(.*)/) {
1173 my ($keysym, $action) = split /:/, $1;
1174 $ext{binding}{$keysym} = [$ext, $action];
1175 } elsif (/^\s*(?:#|$)/) { 1166 } elsif (/^\s*(?:#|$)/) {
1176 # skip other comments and empty lines 1167 # skip other comments and empty lines
1177 } else { 1168 } else {
1178 last; # stop parsing on first non-empty non-comment line 1169 last; # stop parsing on first non-empty non-comment line
1179 } 1170 }
… …
1181 1172
1182 $meta{ext}{$ext} = \%ext; 1173 $meta{ext}{$ext} = \%ext;
1183 } 1174 }
1184 } 1175 }
1185 1176
1186 # and now merge resources and bindings 1177 # and now merge resources
1187 while (my ($k, $v) = each %{ $meta{ext} }) { 1178 while (my ($k, $v) = each %{ $meta{ext} }) {
1188 #TODO: should check for extensions overriding each other 1179 #TODO: should check for extensions overriding each other
1189 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); 1180 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1190 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1191 } 1181 }
1192} 1182}
1193 1183
1194=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1184=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1195 1185
… …
1341 my $res = &x_resource; 1331 my $res = &x_resource;
1342 1332
1343 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1333 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1344} 1334}
1345 1335
1346=item $success = $term->bind_action ($key, $octets) 1336=item $success = $term->bind_action ($key, $action)
1347 1337
1348Adds a key binding exactly as specified via a C<keysym> resource. See the 1338Adds a key binding exactly as specified via a C<keysym> resource. See the
1349C<keysym> resource in the urxvt(1) manpage. 1339C<keysym> resource in the urxvt(1) manpage.
1340
1341To add default bindings for an extension, the extension should call C<<
1342->bind_action >> on it's C<init> hook for every such binding. Doing it
1343in the C<init> hook allows users the override or remove the the binding
1344again.
1345
1346Example: the C<searchable-scrollback> by default binds itself
1347on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1348$term->bind_action >>.
1349
1350 sub init {
1351 my ($self) = @_;
1352
1353 $self->bind_action ("M-s" => "%:start");
1354 }
1350 1355
1351=item $rend = $term->rstyle ([$new_rstyle]) 1356=item $rend = $term->rstyle ([$new_rstyle])
1352 1357
1353Return and optionally change the current rendition. Text that is output by 1358Return and optionally change the current rendition. Text that is output by
1354the terminal application will use this style. 1359the terminal application will use this style.
… …
1512 1517
1513=item $term->scr_add_lines ($string) 1518=item $term->scr_add_lines ($string)
1514 1519
1515Write the given text string to the screen, as if output by the application 1520Write the given text string to the screen, as if output by the application
1516running inside the terminal. It may not contain command sequences (escape 1521running inside the terminal. It may not contain command sequences (escape
1517codes), but is free to use line feeds, carriage returns and tabs. The 1522codes - see C<cmd_parse> for that), but is free to use line feeds,
1518string is a normal text string, not in locale-dependent encoding. 1523carriage returns and tabs. The string is a normal text string, not in
1524locale-dependent encoding.
1519 1525
1520Normally its not a good idea to use this function, as programs might be 1526Normally its not a good idea to use this function, as programs might be
1521confused by changes in cursor position or scrolling. Its useful inside a 1527confused by changes in cursor position or scrolling. Its useful inside a
1522C<on_add_lines> hook, though. 1528C<on_add_lines> hook, though.
1523 1529
… …
1531locale-specific encoding of the terminal and can contain command sequences 1537locale-specific encoding of the terminal and can contain command sequences
1532(escape codes) that will be interpreted. 1538(escape codes) that will be interpreted.
1533 1539
1534=item $term->tt_write ($octets) 1540=item $term->tt_write ($octets)
1535 1541
1536Write the octets given in C<$octets> to the tty (i.e. as program input). To 1542Write the octets given in C<$octets> to the tty (i.e. as user input
1543to the program, see C<cmd_parse> for the opposite direction). To pass
1537pass characters instead of octets, you should convert your strings first 1544characters instead of octets, you should convert your strings first to the
1538to the locale-specific encoding using C<< $term->locale_encode >>. 1545locale-specific encoding using C<< $term->locale_encode >>.
1539 1546
1540=item $term->tt_write_user_input ($octets) 1547=item $term->tt_write_user_input ($octets)
1541 1548
1542Like C<tt_write>, but should be used when writing strings in response to 1549Like C<tt_write>, but should be used when writing strings in response to
1543the user pressing a key, to invoke the additional actions requested by 1550the user pressing a key, to invoke the additional actions requested by

Diff Legend

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