| … | |
… | |
| 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 may add resources on their own. Similarly to builtin |
48 | Extensions may add additional resources and C<actions>, i.e., methods |
| 49 | resources, these resources can also be specified on the command line |
49 | which can be bound to a key and invoked by the user. An extension can |
| 50 | as long options (with '.' replaced by '-'), in which case the |
50 | define the resources it support using so called META comments, |
| 51 | corresponding extension is loaded automatically. |
51 | described below. Similarly to builtin resources, extension resources |
|
|
52 | can also be specified on the command line as long options (with C<.> |
|
|
53 | replaced by C<->), in which case the corresponding extension is loaded |
|
|
54 | automatically. For this to work the extension B<must> define META |
|
|
55 | comments for its resources. |
| 52 | |
56 | |
| 53 | =head1 API DOCUMENTATION |
57 | =head1 API DOCUMENTATION |
| 54 | |
58 | |
| 55 | =head2 General API Considerations |
59 | =head2 General API Considerations |
| 56 | |
60 | |
| … | |
… | |
| 108 | C<urxvt::term> class on this object. |
112 | C<urxvt::term> class on this object. |
| 109 | |
113 | |
| 110 | Additional methods only supported for extension objects are described in |
114 | Additional methods only supported for extension objects are described in |
| 111 | the C<urxvt::extension> section below. |
115 | the C<urxvt::extension> section below. |
| 112 | |
116 | |
|
|
117 | =head2 META comments |
|
|
118 | |
|
|
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
|
|
120 | different types of metadata. |
|
|
121 | |
|
|
122 | Currently, it recognises only one such comment: |
|
|
123 | |
|
|
124 | =over 4 |
|
|
125 | |
|
|
126 | =item #:META:RESOURCE:name:type:desc |
|
|
127 | |
|
|
128 | The RESOURCE comment defines a resource used by the extension, where |
|
|
129 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
|
|
130 | or C<string>, and C<desc> is the resource description. |
|
|
131 | |
|
|
132 | =back |
|
|
133 | |
| 113 | =head2 Hooks |
134 | =head2 Hooks |
| 114 | |
135 | |
| 115 | The following subroutines can be declared in extension files, and will be |
136 | The following subroutines can be declared in extension files, and will be |
| 116 | called whenever the relevant event happens. |
137 | called whenever the relevant event happens. |
| 117 | |
138 | |
| … | |
… | |
| 282 | code is run after this hook, and takes precedence. |
303 | code is run after this hook, and takes precedence. |
| 283 | |
304 | |
| 284 | =item on_refresh_end $term |
305 | =item on_refresh_end $term |
| 285 | |
306 | |
| 286 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
307 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
|
|
308 | |
|
|
309 | =item on_action $term, $string |
|
|
310 | |
|
|
311 | Called whenever an action is invoked for the corresponding extension |
|
|
312 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
313 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
314 | event is simply the action string. Note that an action event is always |
|
|
315 | associated to a single extension. |
| 287 | |
316 | |
| 288 | =item on_user_command $term, $string *DEPRECATED* |
317 | =item on_user_command $term, $string *DEPRECATED* |
| 289 | |
318 | |
| 290 | Called whenever a user-configured event is being activated (e.g. via |
319 | Called whenever a user-configured event is being activated (e.g. via |
| 291 | a C<perl:string> action bound to a key, see description of the B<keysym> |
320 | a C<perl:string> action bound to a key, see description of the B<keysym> |
| … | |
… | |
| 575 | if ($pattern eq $prefix) { |
604 | if ($pattern eq $prefix) { |
| 576 | $name = "$urxvt::RESCLASS.$k$suffix"; |
605 | $name = "$urxvt::RESCLASS.$k$suffix"; |
| 577 | |
606 | |
| 578 | push @{ $term->{perl_ext_3} }, $v->[0]; |
607 | push @{ $term->{perl_ext_3} }, $v->[0]; |
| 579 | |
608 | |
|
|
609 | return 1 unless $isarg; |
|
|
610 | |
| 580 | if ($v->[1] eq "boolean") { |
611 | if ($v->[1] eq "boolean") { |
| 581 | $term->put_option_db ($name, $flag ? "true" : "false"); |
612 | $term->put_option_db ($name, $flag ? "true" : "false"); |
| 582 | return 1; |
613 | return 1; |
| 583 | } else { |
614 | } else { |
| 584 | $term->put_option_db ($name, $value); |
615 | $term->put_option_db ($name, $value); |
| … | |
… | |
| 685 | @{ delete $TERM->{perl_ext_3} } |
716 | @{ delete $TERM->{perl_ext_3} } |
| 686 | ) { |
717 | ) { |
| 687 | if ($_ eq "default") { |
718 | if ($_ eq "default") { |
| 688 | |
719 | |
| 689 | $ext_arg{$_} = [] |
720 | $ext_arg{$_} = [] |
| 690 | for |
|
|
| 691 | qw(selection option-popup selection-popup readline), |
721 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
| 692 | map $_->[0], values %{ $TERM->{meta}{binding} }; |
|
|
| 693 | |
722 | |
| 694 | for ($TERM->_keysym_resources) { |
723 | for ($TERM->_keysym_resources) { |
| 695 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
724 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
| 696 | next unless /^([A-Za-z0-9_\-]+):/; |
725 | next unless /^([A-Za-z0-9_\-]+):/; |
| 697 | |
726 | |
| … | |
… | |
| 706 | } elsif (/^([^<]+)<(.*)>$/) { |
735 | } elsif (/^([^<]+)<(.*)>$/) { |
| 707 | push @{ $ext_arg{$1} }, $2; |
736 | push @{ $ext_arg{$1} }, $2; |
| 708 | |
737 | |
| 709 | } else { |
738 | } else { |
| 710 | $ext_arg{$_} ||= []; |
739 | $ext_arg{$_} ||= []; |
| 711 | } |
|
|
| 712 | } |
|
|
| 713 | |
|
|
| 714 | # now register default key bindings |
|
|
| 715 | for my $ext (sort keys %ext_arg) { |
|
|
| 716 | while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { |
|
|
| 717 | $TERM->bind_action ($k, "$v->[0]:$v->[1]"); |
|
|
| 718 | } |
740 | } |
| 719 | } |
741 | } |
| 720 | |
742 | |
| 721 | for my $ext (sort keys %ext_arg) { |
743 | for my $ext (sort keys %ext_arg) { |
| 722 | my @files = grep -f $_, map "$_/$ext", @dirs; |
744 | my @files = grep -f $_, map "$_/$ext", @dirs; |
| … | |
… | |
| 945 | } |
967 | } |
| 946 | |
968 | |
| 947 | bless \%disable, "urxvt::extension::on_disable" |
969 | bless \%disable, "urxvt::extension::on_disable" |
| 948 | } |
970 | } |
| 949 | |
971 | |
|
|
972 | =item $self->bind_action ($hotkey, $action) |
|
|
973 | |
| 950 | =item $self->x_resource ($pattern) |
974 | =item $self->x_resource ($pattern) |
| 951 | |
975 | |
| 952 | =item $self->x_resource_boolean ($pattern) |
976 | =item $self->x_resource_boolean ($pattern) |
| 953 | |
977 | |
| 954 | These methods support an additional C<%> prefix when called on an |
978 | These methods support an additional C<%> prefix for C<$action> or |
| 955 | extension object - see the description of these methods in the |
979 | C<$pattern> when called on an extension object, compared to the |
|
|
980 | C<urxvt::term> methods of the same name - see the description of these |
| 956 | C<urxvt::term> class for details. |
981 | methods in the C<urxvt::term> class for details. |
| 957 | |
982 | |
| 958 | =cut |
983 | =cut |
|
|
984 | |
|
|
985 | sub bind_action { |
|
|
986 | my ($self, $hotkey, $action) = @_; |
|
|
987 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
988 | $self->{term}->bind_action ($hotkey, $action) |
|
|
989 | } |
| 959 | |
990 | |
| 960 | sub x_resource { |
991 | sub x_resource { |
| 961 | my ($self, $name) = @_; |
992 | my ($self, $name) = @_; |
| 962 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
993 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
| 963 | $self->{term}->x_resource ($name) |
994 | $self->{term}->x_resource ($name) |
| … | |
… | |
| 1104 | sub scan_extensions { |
1135 | sub scan_extensions { |
| 1105 | my ($self) = @_; |
1136 | my ($self) = @_; |
| 1106 | |
1137 | |
| 1107 | return if exists $self->{meta}; |
1138 | return if exists $self->{meta}; |
| 1108 | |
1139 | |
| 1109 | my @libdirs = perl_libdirs $self; |
1140 | my @urxvtdirs = perl_libdirs $self; |
|
|
1141 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
| 1110 | |
1142 | |
| 1111 | # return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d# |
|
|
| 1112 | |
|
|
| 1113 | # $self->{meta_libdirs} = join "\x00", @libdirs;#d# |
|
|
| 1114 | $self->{meta} = \my %meta; |
1143 | $self->{meta} = \my %meta; |
| 1115 | |
1144 | |
| 1116 | # first gather extensions |
1145 | # first gather extensions |
| 1117 | for my $dir (reverse @libdirs) { |
1146 | |
|
|
1147 | my $gather = sub { |
|
|
1148 | my ($dir, $core) = @_; |
|
|
1149 | |
| 1118 | opendir my $fh, $dir |
1150 | opendir my $fh, $dir |
| 1119 | or next; |
1151 | or return; |
|
|
1152 | |
| 1120 | for my $ext (readdir $fh) { |
1153 | for my $ext (readdir $fh) { |
| 1121 | $ext !~ /^\./ |
1154 | $ext !~ /^\./ |
|
|
1155 | or next; |
|
|
1156 | |
| 1122 | and open my $fh, "<", "$dir/$ext" |
1157 | open my $fh, "<", "$dir/$ext" |
|
|
1158 | or next; |
|
|
1159 | |
|
|
1160 | -f $fh |
|
|
1161 | or next; |
|
|
1162 | |
|
|
1163 | $ext =~ s/\.uext$// or $core |
| 1123 | or next; |
1164 | or next; |
| 1124 | |
1165 | |
| 1125 | my %ext = (dir => $dir); |
1166 | my %ext = (dir => $dir); |
| 1126 | |
1167 | |
| 1127 | while (<$fh>) { |
1168 | while (<$fh>) { |
| … | |
… | |
| 1131 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1172 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
| 1132 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1173 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
| 1133 | } else { |
1174 | } else { |
| 1134 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1175 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
| 1135 | } |
1176 | } |
| 1136 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
| 1137 | my ($keysym, $action) = split /:/, $1; |
|
|
| 1138 | $ext{binding}{$keysym} = [$ext, $action]; |
|
|
| 1139 | } elsif (/^\s*(?:#|$)/) { |
1177 | } elsif (/^\s*(?:#|$)/) { |
| 1140 | # skip other comments and empty lines |
1178 | # skip other comments and empty lines |
| 1141 | } else { |
1179 | } else { |
| 1142 | last; # stop parsing on first non-empty non-comment line |
1180 | last; # stop parsing on first non-empty non-comment line |
| 1143 | } |
1181 | } |
| 1144 | } |
1182 | } |
| 1145 | |
1183 | |
| 1146 | $meta{ext}{$ext} = \%ext; |
1184 | $meta{ext}{$ext} = \%ext; |
| 1147 | } |
1185 | } |
| 1148 | } |
1186 | }; |
| 1149 | |
1187 | |
|
|
1188 | # $gather->($_, 0) for @cpandirs; |
|
|
1189 | $gather->($_, 1) for @urxvtdirs; |
|
|
1190 | |
| 1150 | # and now merge resources and bindings |
1191 | # and now merge resources |
|
|
1192 | |
|
|
1193 | $meta{resource} = \my %resource; |
|
|
1194 | |
| 1151 | while (my ($k, $v) = each %{ $meta{ext} }) { |
1195 | while (my ($k, $v) = each %{ $meta{ext} }) { |
| 1152 | #TODO: should check for extensions overriding each other |
1196 | #TODO: should check for extensions overriding each other |
| 1153 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
1197 | %resource = (%resource, %{ $v->{resource} }); |
| 1154 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
|
|
| 1155 | } |
1198 | } |
| 1156 | } |
1199 | } |
| 1157 | |
1200 | |
| 1158 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1201 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
| 1159 | |
1202 | |
| … | |
… | |
| 1282 | |
1325 | |
| 1283 | If the method is called on an extension object (basically, from an |
1326 | If the method is called on an extension object (basically, from an |
| 1284 | extension), then the special prefix C<%.> will be replaced by the name of |
1327 | extension), then the special prefix C<%.> will be replaced by the name of |
| 1285 | the extension and a dot, and the lone string C<%> will be replaced by the |
1328 | the extension and a dot, and the lone string C<%> will be replaced by the |
| 1286 | extension name itself. This makes it possible to code extensions so you |
1329 | extension name itself. This makes it possible to code extensions so you |
| 1287 | can rename them and get a new set of commandline switches and resources |
1330 | can rename them and get a new set of resources without having to change |
| 1288 | without having to change the actual code. |
1331 | the actual code. |
| 1289 | |
1332 | |
| 1290 | This method should only be called during the C<on_start> hook, as there is |
1333 | This method should only be called during the C<on_start> hook, as there is |
| 1291 | only one resource database per display, and later invocations might return |
1334 | only one resource database per display, and later invocations might return |
| 1292 | the wrong resources. |
1335 | the wrong resources. |
| 1293 | |
1336 | |
| … | |
… | |
| 1305 | my $res = &x_resource; |
1348 | my $res = &x_resource; |
| 1306 | |
1349 | |
| 1307 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1350 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
| 1308 | } |
1351 | } |
| 1309 | |
1352 | |
|
|
1353 | =item $action = $term->lookup_keysym ($keysym, $state) |
|
|
1354 | |
|
|
1355 | Returns the action bound to key combination C<($keysym, $state)>, |
|
|
1356 | if a binding for it exists, and C<undef> otherwise. |
|
|
1357 | |
| 1310 | =item $success = $term->bind_action ($key, $octets) |
1358 | =item $success = $term->bind_action ($key, $action) |
| 1311 | |
1359 | |
| 1312 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1360 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
| 1313 | C<keysym> resource in the urxvt(1) manpage. |
1361 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1362 | |
|
|
1363 | To add default bindings for actions, an extension should call C<< |
|
|
1364 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1365 | in the C<init> hook allows users to override or remove the binding |
|
|
1366 | again. |
|
|
1367 | |
|
|
1368 | Example: the C<searchable-scrollback> by default binds itself |
|
|
1369 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
|
|
1370 | $term->bind_action >>. |
|
|
1371 | |
|
|
1372 | sub init { |
|
|
1373 | my ($self) = @_; |
|
|
1374 | |
|
|
1375 | $self->bind_action ("M-s" => "%:start"); |
|
|
1376 | } |
| 1314 | |
1377 | |
| 1315 | =item $rend = $term->rstyle ([$new_rstyle]) |
1378 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 1316 | |
1379 | |
| 1317 | Return and optionally change the current rendition. Text that is output by |
1380 | Return and optionally change the current rendition. Text that is output by |
| 1318 | the terminal application will use this style. |
1381 | the terminal application will use this style. |
| … | |
… | |
| 1476 | |
1539 | |
| 1477 | =item $term->scr_add_lines ($string) |
1540 | =item $term->scr_add_lines ($string) |
| 1478 | |
1541 | |
| 1479 | Write the given text string to the screen, as if output by the application |
1542 | Write the given text string to the screen, as if output by the application |
| 1480 | running inside the terminal. It may not contain command sequences (escape |
1543 | running inside the terminal. It may not contain command sequences (escape |
| 1481 | codes), but is free to use line feeds, carriage returns and tabs. The |
1544 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
| 1482 | string is a normal text string, not in locale-dependent encoding. |
1545 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1546 | locale-dependent encoding. |
| 1483 | |
1547 | |
| 1484 | Normally its not a good idea to use this function, as programs might be |
1548 | Normally its not a good idea to use this function, as programs might be |
| 1485 | confused by changes in cursor position or scrolling. Its useful inside a |
1549 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1486 | C<on_add_lines> hook, though. |
1550 | C<on_add_lines> hook, though. |
| 1487 | |
1551 | |
| … | |
… | |
| 1495 | locale-specific encoding of the terminal and can contain command sequences |
1559 | locale-specific encoding of the terminal and can contain command sequences |
| 1496 | (escape codes) that will be interpreted. |
1560 | (escape codes) that will be interpreted. |
| 1497 | |
1561 | |
| 1498 | =item $term->tt_write ($octets) |
1562 | =item $term->tt_write ($octets) |
| 1499 | |
1563 | |
| 1500 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1564 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1565 | to the program, see C<cmd_parse> for the opposite direction). To pass |
| 1501 | pass characters instead of octets, you should convert your strings first |
1566 | characters instead of octets, you should convert your strings first to the |
| 1502 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1567 | locale-specific encoding using C<< $term->locale_encode >>. |
| 1503 | |
1568 | |
| 1504 | =item $term->tt_write_user_input ($octets) |
1569 | =item $term->tt_write_user_input ($octets) |
| 1505 | |
1570 | |
| 1506 | Like C<tt_write>, but should be used when writing strings in response to |
1571 | Like C<tt_write>, but should be used when writing strings in response to |
| 1507 | the user pressing a key, to invoke the additional actions requested by |
1572 | the user pressing a key, to invoke the additional actions requested by |
| … | |
… | |
| 1554 | |
1619 | |
| 1555 | =item $term->key_release ($state, $keycode[, $time]) |
1620 | =item $term->key_release ($state, $keycode[, $time]) |
| 1556 | |
1621 | |
| 1557 | Deliver various fake events to to terminal. |
1622 | Deliver various fake events to to terminal. |
| 1558 | |
1623 | |
| 1559 | =item $window_width = $term->width |
1624 | =item $window_width = $term->width ([$new_value]) |
| 1560 | |
1625 | |
| 1561 | =item $window_height = $term->height |
1626 | =item $window_height = $term->height ([$new_value]) |
| 1562 | |
1627 | |
| 1563 | =item $font_width = $term->fwidth |
1628 | =item $font_width = $term->fwidth ([$new_value]) |
| 1564 | |
1629 | |
| 1565 | =item $font_height = $term->fheight |
1630 | =item $font_height = $term->fheight ([$new_value]) |
| 1566 | |
1631 | |
| 1567 | =item $font_ascent = $term->fbase |
1632 | =item $font_ascent = $term->fbase ([$new_value]) |
| 1568 | |
1633 | |
| 1569 | =item $terminal_rows = $term->nrow |
1634 | =item $terminal_rows = $term->nrow ([$new_value]) |
| 1570 | |
1635 | |
| 1571 | =item $terminal_columns = $term->ncol |
1636 | =item $terminal_columns = $term->ncol ([$new_value]) |
| 1572 | |
1637 | |
| 1573 | =item $has_focus = $term->focus |
1638 | =item $has_focus = $term->focus ([$new_value]) |
| 1574 | |
1639 | |
| 1575 | =item $is_mapped = $term->mapped |
1640 | =item $is_mapped = $term->mapped ([$new_value]) |
| 1576 | |
1641 | |
| 1577 | =item $max_scrollback = $term->saveLines |
1642 | =item $max_scrollback = $term->saveLines ([$new_value]) |
| 1578 | |
1643 | |
| 1579 | =item $nrow_plus_saveLines = $term->total_rows |
1644 | =item $nrow_plus_saveLines = $term->total_rows ([$new_value]) |
| 1580 | |
1645 | |
| 1581 | =item $topmost_scrollback_row = $term->top_row |
1646 | =item $topmost_scrollback_row = $term->top_row ([$new_value]) |
| 1582 | |
1647 | |
| 1583 | Return various integers describing terminal characteristics. |
1648 | Return various integers describing terminal characteristics. If an |
|
|
1649 | argument is given, changes the value and returns the previous one. |
| 1584 | |
1650 | |
| 1585 | =item $x_display = $term->display_id |
1651 | =item $x_display = $term->display_id |
| 1586 | |
1652 | |
| 1587 | Return the DISPLAY used by rxvt-unicode. |
1653 | Return the DISPLAY used by rxvt-unicode. |
| 1588 | |
1654 | |
| … | |
… | |
| 1638 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1704 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
| 1639 | compare the on-screen display with its stored representation. If they |
1705 | compare the on-screen display with its stored representation. If they |
| 1640 | differ, it redraws the differences. |
1706 | differ, it redraws the differences. |
| 1641 | |
1707 | |
| 1642 | Used after changing terminal contents to display them. |
1708 | Used after changing terminal contents to display them. |
|
|
1709 | |
|
|
1710 | =item $term->refresh_check |
|
|
1711 | |
|
|
1712 | Checks if a refresh has been requested and, if so, schedules one. |
| 1643 | |
1713 | |
| 1644 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1714 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
| 1645 | |
1715 | |
| 1646 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1716 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
| 1647 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1717 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
