… | |
… | |
115 | Additional methods only supported for extension objects are described in |
115 | Additional methods only supported for extension objects are described in |
116 | the C<urxvt::extension> section below. |
116 | the C<urxvt::extension> section below. |
117 | |
117 | |
118 | =head2 META comments |
118 | =head2 META comments |
119 | |
119 | |
120 | rxvt-unicode recognizes special comments in extensions that define |
120 | Rxvt-unicode recognizes special meta comments in extensions that define |
121 | different types of metadata: |
121 | different types of metadata. |
|
|
122 | |
|
|
123 | Currently, 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 | |
127 | The RESOURCE comment defines a resource used by the extension, where |
129 | The RESOURCE comment defines a resource used by the extension, where |
128 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
130 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
129 | or C<string>, and C<desc> is the resource description. |
131 | or C<string>, and C<desc> is the resource description. |
130 | |
|
|
131 | =item #:META:BINDING:sym:action |
|
|
132 | |
|
|
133 | The BINDING comment defines a default binding for an action provided |
|
|
134 | by the extension, where C<sym> is the key combination that triggers |
|
|
135 | the action, whose format is defined in the description of the |
|
|
136 | B<keysym> resource in the urxvt(1) manpage, and C<action> is the name |
|
|
137 | of 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 searchable-scrollback), |
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 | |
990 | These methods support an additional C<%> prefix when called on an |
977 | These methods support an additional C<%> prefix for C<$action> or |
991 | extension object - see the description of these methods in the |
978 | C<$pattern> when called on an extension object, compared to the |
|
|
979 | C<urxvt::term> methods of the same name - see the description of these |
992 | C<urxvt::term> class for details. |
980 | methods in the C<urxvt::term> class for details. |
993 | |
981 | |
994 | =cut |
982 | =cut |
|
|
983 | |
|
|
984 | sub bind_action { |
|
|
985 | my ($self, $hotkey, $action) = @_; |
|
|
986 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
987 | $self->{term}->bind_action ($hotkey, $action) |
|
|
988 | } |
995 | |
989 | |
996 | sub x_resource { |
990 | sub 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 | |
1348 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1338 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1349 | C<keysym> resource in the urxvt(1) manpage. |
1339 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1340 | |
|
|
1341 | To 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 |
|
|
1343 | in the C<init> hook allows users the override or remove the the binding |
|
|
1344 | again. |
|
|
1345 | |
|
|
1346 | Example: the C<searchable-scrollback> by default binds itself |
|
|
1347 | on 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 | |
1353 | Return and optionally change the current rendition. Text that is output by |
1358 | Return and optionally change the current rendition. Text that is output by |
1354 | the terminal application will use this style. |
1359 | the terminal application will use this style. |