| … | |
… | |
| 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 additional resources and C<actions>, i.e., methods |
| 49 | loaded automatically when used. |
49 | which can be bound to a key and invoked by the user. An extension can |
|
|
50 | define the resources it support and also default bindings for one or |
|
|
51 | more actions it provides using so called META comments, described |
|
|
52 | below. Similarly to builtin resources, extension resources can also be |
|
|
53 | specified on the command line as long options (with C<.> replaced by |
|
|
54 | C<->), in which case the corresponding extension is loaded |
|
|
55 | automatically. For this to work the extension B<must> define META |
|
|
56 | comments 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 | |
| … | |
… | |
| 106 | C<urxvt::term> class on this object. |
113 | C<urxvt::term> class on this object. |
| 107 | |
114 | |
| 108 | Additional methods only supported for extension objects are described in |
115 | Additional methods only supported for extension objects are described in |
| 109 | the C<urxvt::extension> section below. |
116 | the C<urxvt::extension> section below. |
| 110 | |
117 | |
|
|
118 | =head2 META comments |
|
|
119 | |
|
|
120 | Rxvt-unicode recognizes special meta comments in extensions that define |
|
|
121 | different types of metadata. |
|
|
122 | |
|
|
123 | Currently, it recxognises only one such comment: |
|
|
124 | |
|
|
125 | =over 4 |
|
|
126 | |
|
|
127 | =item #:META:RESOURCE:name:type:desc |
|
|
128 | |
|
|
129 | The RESOURCE comment defines a resource used by the extension, where |
|
|
130 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
|
|
131 | or C<string>, and C<desc> is the resource description. |
|
|
132 | |
|
|
133 | =back |
|
|
134 | |
| 111 | =head2 Hooks |
135 | =head2 Hooks |
| 112 | |
136 | |
| 113 | The following subroutines can be declared in extension files, and will be |
137 | The following subroutines can be declared in extension files, and will be |
| 114 | called whenever the relevant event happens. |
138 | called whenever the relevant event happens. |
| 115 | |
139 | |
| … | |
… | |
| 281 | |
305 | |
| 282 | =item on_refresh_end $term |
306 | =item on_refresh_end $term |
| 283 | |
307 | |
| 284 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
308 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
| 285 | |
309 | |
|
|
310 | =item on_action $term, $string |
|
|
311 | |
|
|
312 | Called whenever an action is invoked for the corresponding extension |
|
|
313 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
314 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
315 | event is simply the action string. Note that an action event is always |
|
|
316 | associated to a single extension. |
|
|
317 | |
| 286 | =item on_user_command $term, $string *DEPRECATED* |
318 | =item on_user_command $term, $string *DEPRECATED* |
| 287 | |
319 | |
| 288 | Called whenever a user-configured event is being activated (e.g. via |
320 | 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> |
321 | a C<perl:string> action bound to a key, see description of the B<keysym> |
| 290 | resource in the urxvt(1) manpage). |
322 | resource in the urxvt(1) manpage). |
| 291 | |
323 | |
| 292 | The event is simply the action string. This interface is going away in |
324 | The event is simply the action string. This interface is going away in |
| 293 | preference to the C<< ->register_keysym_action >> method. |
325 | preference to the C<on_action> hook. |
| 294 | |
326 | |
| 295 | =item on_resize_all_windows $term, $new_width, $new_height |
327 | =item on_resize_all_windows $term, $new_width, $new_height |
| 296 | |
328 | |
| 297 | Called just after the new window size has been calculated, but before |
329 | Called just after the new window size has been calculated, but before |
| 298 | windows are actually being resized or hints are being set. If this hook |
330 | windows are actually being resized or hints are being set. If this hook |
| … | |
… | |
| 555 | no warnings 'utf8'; |
587 | no warnings 'utf8'; |
| 556 | |
588 | |
| 557 | sub parse_resource { |
589 | sub parse_resource { |
| 558 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
590 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
| 559 | |
591 | |
| 560 | $name =~ y/-/./ if $isarg; |
|
|
| 561 | |
|
|
| 562 | $term->scan_extensions; |
592 | $term->scan_extensions; |
| 563 | |
593 | |
| 564 | my $r = $term->{meta}{resource}; |
594 | my $r = $term->{meta}{resource}; |
| 565 | keys %$r; # reset iterator |
595 | keys %$r; # reset iterator |
| 566 | while (my ($pattern, $v) = each %$r) { |
596 | while (my ($k, $v) = each %$r) { |
| 567 | if ( |
597 | my $pattern = $k; |
|
|
598 | $pattern =~ y/./-/ if $isarg; |
|
|
599 | my $prefix = $name; |
|
|
600 | my $suffix; |
| 568 | $pattern =~ /\.$/ |
601 | if ($pattern =~ /\-$/) { |
| 569 | ? $pattern eq substr $name, 0, length $pattern |
602 | $prefix = substr $name, 0, length $pattern; |
| 570 | : $pattern eq $name |
603 | $suffix = substr $name, length $pattern; |
| 571 | ) { |
604 | } |
|
|
605 | if ($pattern eq $prefix) { |
| 572 | $name = "$urxvt::RESCLASS.$name"; |
606 | $name = "$urxvt::RESCLASS.$k$suffix"; |
| 573 | |
607 | |
| 574 | push @{ $term->{perl_ext_3} }, $v->[0]; |
608 | push @{ $term->{perl_ext_3} }, $v->[0]; |
| 575 | |
609 | |
| 576 | if ($v->[1] eq "boolean") { |
610 | if ($v->[1] eq "boolean") { |
| 577 | $term->put_option_db ($name, $flag ? "true" : "false"); |
611 | $term->put_option_db ($name, $flag ? "true" : "false"); |
| … | |
… | |
| 675 | @TERM_EXT = (); |
709 | @TERM_EXT = (); |
| 676 | $TERM->register_package ($_) for @pkg; |
710 | $TERM->register_package ($_) for @pkg; |
| 677 | } |
711 | } |
| 678 | |
712 | |
| 679 | for ( |
713 | for ( |
|
|
714 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
| 680 | @{ delete $TERM->{perl_ext_3} }, |
715 | @{ delete $TERM->{perl_ext_3} } |
| 681 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
| 682 | ) { |
716 | ) { |
| 683 | if ($_ eq "default") { |
717 | if ($_ eq "default") { |
|
|
718 | |
|
|
719 | $ext_arg{$_} = [] |
| 684 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
720 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
|
|
721 | |
|
|
722 | for ($TERM->_keysym_resources) { |
|
|
723 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
724 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
725 | |
|
|
726 | my $ext = $1; |
|
|
727 | |
|
|
728 | $ext_arg{$ext} = []; |
|
|
729 | } |
|
|
730 | |
| 685 | } elsif (/^-(.*)$/) { |
731 | } elsif (/^-(.*)$/) { |
| 686 | delete $ext_arg{$1}; |
732 | delete $ext_arg{$1}; |
|
|
733 | |
| 687 | } elsif (/^([^<]+)<(.*)>$/) { |
734 | } elsif (/^([^<]+)<(.*)>$/) { |
| 688 | push @{ $ext_arg{$1} }, $2; |
735 | push @{ $ext_arg{$1} }, $2; |
|
|
736 | |
| 689 | } else { |
737 | } else { |
| 690 | $ext_arg{$_} ||= []; |
738 | $ext_arg{$_} ||= []; |
| 691 | } |
739 | } |
| 692 | } |
740 | } |
| 693 | |
741 | |
| … | |
… | |
| 918 | } |
966 | } |
| 919 | |
967 | |
| 920 | bless \%disable, "urxvt::extension::on_disable" |
968 | bless \%disable, "urxvt::extension::on_disable" |
| 921 | } |
969 | } |
| 922 | |
970 | |
|
|
971 | =item $self->bind_action ($hotkey, $action) |
|
|
972 | |
| 923 | =item $self->x_resource ($pattern) |
973 | =item $self->x_resource ($pattern) |
| 924 | |
974 | |
| 925 | =item $self->x_resource_boolean ($pattern) |
975 | =item $self->x_resource_boolean ($pattern) |
| 926 | |
976 | |
| 927 | These methods support an additional C<%> prefix when called on an |
977 | These methods support an additional C<%> prefix for C<$action> or |
| 928 | 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 |
| 929 | C<urxvt::term> class for details. |
980 | methods in the C<urxvt::term> class for details. |
| 930 | |
981 | |
| 931 | =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 | } |
| 932 | |
989 | |
| 933 | sub x_resource { |
990 | sub x_resource { |
| 934 | my ($self, $name) = @_; |
991 | my ($self, $name) = @_; |
| 935 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
992 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
| 936 | $self->{term}->x_resource ($name) |
993 | $self->{term}->x_resource ($name) |
| … | |
… | |
| 1077 | sub scan_extensions { |
1134 | sub scan_extensions { |
| 1078 | my ($self) = @_; |
1135 | my ($self) = @_; |
| 1079 | |
1136 | |
| 1080 | return if exists $self->{meta}; |
1137 | return if exists $self->{meta}; |
| 1081 | |
1138 | |
| 1082 | my @libdirs = perl_libdirs $self; |
1139 | my @urxvtdirs = perl_libdirs $self; |
|
|
1140 | my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
| 1083 | |
1141 | |
| 1084 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
| 1085 | |
|
|
| 1086 | my %meta; |
|
|
| 1087 | |
|
|
| 1088 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
| 1089 | $self->{meta} = \%meta; |
1142 | $self->{meta} = \my %meta; |
| 1090 | |
|
|
| 1091 | my %ext; |
|
|
| 1092 | |
1143 | |
| 1093 | # first gather extensions |
1144 | # first gather extensions |
| 1094 | for my $dir (reverse @libdirs) { |
1145 | |
|
|
1146 | my $gather = sub { |
|
|
1147 | my ($dir, $core) = @_; |
|
|
1148 | |
| 1095 | opendir my $fh, $dir |
1149 | opendir my $fh, $dir |
| 1096 | or next; |
1150 | or return; |
|
|
1151 | |
| 1097 | for my $ext (readdir $fh) { |
1152 | for my $ext (readdir $fh) { |
| 1098 | $ext !~ /^\./ |
1153 | $ext !~ /^\./ |
|
|
1154 | or next; |
|
|
1155 | |
| 1099 | and open my $fh, "<", "$dir/$ext" |
1156 | open my $fh, "<", "$dir/$ext" |
|
|
1157 | or next; |
|
|
1158 | |
|
|
1159 | -f $fh |
|
|
1160 | or next; |
|
|
1161 | |
|
|
1162 | $ext =~ s/\.uext$// or $core |
| 1100 | or next; |
1163 | or next; |
| 1101 | |
1164 | |
| 1102 | my %ext = (dir => $dir); |
1165 | my %ext = (dir => $dir); |
| 1103 | |
1166 | |
| 1104 | while (<$fh>) { |
1167 | while (<$fh>) { |
| … | |
… | |
| 1108 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1171 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
| 1109 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1172 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
| 1110 | } else { |
1173 | } else { |
| 1111 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1174 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
| 1112 | } |
1175 | } |
| 1113 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
| 1114 | my ($keysym, $action) = split /:/, $1; |
|
|
| 1115 | $ext{binding}{$keysym} = $action; |
|
|
| 1116 | } elsif (/^\s*(?:#|$)/) { |
1176 | } elsif (/^\s*(?:#|$)/) { |
| 1117 | # skip other comments and empty lines |
1177 | # skip other comments and empty lines |
| 1118 | } else { |
1178 | } else { |
| 1119 | last; # stop parsing on first non-empty non-comment line |
1179 | last; # stop parsing on first non-empty non-comment line |
| 1120 | } |
1180 | } |
| 1121 | } |
1181 | } |
| 1122 | |
1182 | |
| 1123 | $meta{$ext} = \%ext; |
1183 | $meta{ext}{$ext} = \%ext; |
| 1124 | } |
1184 | } |
| 1125 | } |
1185 | }; |
| 1126 | |
1186 | |
|
|
1187 | $gather->($_, 0) for @cpandirs; |
|
|
1188 | $gather->($_, 1) for @urxvtdirs; |
|
|
1189 | |
| 1127 | # and now merge resources and bindings |
1190 | # and now merge resources |
| 1128 | while (my ($k, $v) = each %ext) { |
1191 | while (my ($k, $v) = each %{ $meta{ext} }) { |
| 1129 | #TODO: should check for extensions overriding each other |
1192 | #TODO: should check for extensions overriding each other |
| 1130 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
1193 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
| 1131 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
|
|
| 1132 | } |
1194 | } |
| 1133 | } |
1195 | } |
| 1134 | |
1196 | |
| 1135 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1197 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
| 1136 | |
1198 | |
| … | |
… | |
| 1252 | Returns the X-Resource for the given pattern, excluding the program or |
1314 | Returns the X-Resource for the given pattern, excluding the program or |
| 1253 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1315 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
| 1254 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1316 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
| 1255 | resource with that pattern exists. |
1317 | resource with that pattern exists. |
| 1256 | |
1318 | |
| 1257 | Extensions that define extra resource or command line arguments also need |
1319 | Extensions that define extra resources also need to call this method |
| 1258 | to call this method to access their values. |
1320 | to access their values. |
| 1259 | |
1321 | |
| 1260 | If the method is called on an extension object (basically, from an |
1322 | If the method is called on an extension object (basically, from an |
| 1261 | extension), then the special prefix C<%.> will be replaced by the name of |
1323 | extension), then the special prefix C<%.> will be replaced by the name of |
| 1262 | the extension and a dot, and the lone string C<%> will be replaced by the |
1324 | the extension and a dot, and the lone string C<%> will be replaced by the |
| 1263 | extension name itself. This makes it possible to code extensions so you |
1325 | extension name itself. This makes it possible to code extensions so you |
| 1264 | can rename them and get a new set of commandline switches and resources |
1326 | can rename them and get a new set of resources without having to change |
| 1265 | without having to change the actual code. |
1327 | the actual code. |
| 1266 | |
1328 | |
| 1267 | This method should only be called during the C<on_start> hook, as there is |
1329 | This method should only be called during the C<on_start> hook, as there is |
| 1268 | only one resource database per display, and later invocations might return |
1330 | only one resource database per display, and later invocations might return |
| 1269 | the wrong resources. |
1331 | the wrong resources. |
| 1270 | |
1332 | |
| … | |
… | |
| 1282 | my $res = &x_resource; |
1344 | my $res = &x_resource; |
| 1283 | |
1345 | |
| 1284 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1346 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
| 1285 | } |
1347 | } |
| 1286 | |
1348 | |
| 1287 | =item $success = $term->bind_action ($key, $octets) |
1349 | =item $success = $term->bind_action ($key, $action) |
| 1288 | |
1350 | |
| 1289 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1351 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
| 1290 | C<keysym> resource in the urxvt(1) manpage. |
1352 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1353 | |
|
|
1354 | To add default bindings for an extension, the extension should call C<< |
|
|
1355 | ->bind_action >> on it's C<init> hook for every such binding. Doing it |
|
|
1356 | in the C<init> hook allows users the override or remove the the binding |
|
|
1357 | again. |
|
|
1358 | |
|
|
1359 | Example: the C<searchable-scrollback> by default binds itself |
|
|
1360 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
|
|
1361 | $term->bind_action >>. |
|
|
1362 | |
|
|
1363 | sub init { |
|
|
1364 | my ($self) = @_; |
|
|
1365 | |
|
|
1366 | $self->bind_action ("M-s" => "%:start"); |
|
|
1367 | } |
| 1291 | |
1368 | |
| 1292 | =item $rend = $term->rstyle ([$new_rstyle]) |
1369 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 1293 | |
1370 | |
| 1294 | Return and optionally change the current rendition. Text that is output by |
1371 | Return and optionally change the current rendition. Text that is output by |
| 1295 | the terminal application will use this style. |
1372 | the terminal application will use this style. |
| … | |
… | |
| 1453 | |
1530 | |
| 1454 | =item $term->scr_add_lines ($string) |
1531 | =item $term->scr_add_lines ($string) |
| 1455 | |
1532 | |
| 1456 | Write the given text string to the screen, as if output by the application |
1533 | Write the given text string to the screen, as if output by the application |
| 1457 | running inside the terminal. It may not contain command sequences (escape |
1534 | running inside the terminal. It may not contain command sequences (escape |
| 1458 | codes), but is free to use line feeds, carriage returns and tabs. The |
1535 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
| 1459 | string is a normal text string, not in locale-dependent encoding. |
1536 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1537 | locale-dependent encoding. |
| 1460 | |
1538 | |
| 1461 | Normally its not a good idea to use this function, as programs might be |
1539 | Normally its not a good idea to use this function, as programs might be |
| 1462 | confused by changes in cursor position or scrolling. Its useful inside a |
1540 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1463 | C<on_add_lines> hook, though. |
1541 | C<on_add_lines> hook, though. |
| 1464 | |
1542 | |
| … | |
… | |
| 1472 | locale-specific encoding of the terminal and can contain command sequences |
1550 | locale-specific encoding of the terminal and can contain command sequences |
| 1473 | (escape codes) that will be interpreted. |
1551 | (escape codes) that will be interpreted. |
| 1474 | |
1552 | |
| 1475 | =item $term->tt_write ($octets) |
1553 | =item $term->tt_write ($octets) |
| 1476 | |
1554 | |
| 1477 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1555 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1556 | to the program, see C<cmd_parse> for the opposite direction). To pass |
| 1478 | pass characters instead of octets, you should convert your strings first |
1557 | characters instead of octets, you should convert your strings first to the |
| 1479 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1558 | locale-specific encoding using C<< $term->locale_encode >>. |
| 1480 | |
1559 | |
| 1481 | =item $term->tt_write_user_input ($octets) |
1560 | =item $term->tt_write_user_input ($octets) |
| 1482 | |
1561 | |
| 1483 | Like C<tt_write>, but should be used when writing strings in response to |
1562 | Like C<tt_write>, but should be used when writing strings in response to |
| 1484 | the user pressing a key, to invokes the additional actions requested by |
1563 | the user pressing a key, to invoke the additional actions requested by |
| 1485 | the user for that case (C<tt_write> doesn't do that). |
1564 | the user for that case (C<tt_write> doesn't do that). |
| 1486 | |
1565 | |
| 1487 | The typical use case would be inside C<on_action> hooks. |
1566 | The typical use case would be inside C<on_action> hooks. |
| 1488 | |
1567 | |
| 1489 | =item $term->tt_paste ($octets) |
1568 | =item $term->tt_paste ($octets) |
