| … | |
… | |
| 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> |
| … | |
… | |
| 685 | @{ delete $TERM->{perl_ext_3} } |
714 | @{ delete $TERM->{perl_ext_3} } |
| 686 | ) { |
715 | ) { |
| 687 | if ($_ eq "default") { |
716 | if ($_ eq "default") { |
| 688 | |
717 | |
| 689 | $ext_arg{$_} = [] |
718 | $ext_arg{$_} = [] |
| 690 | for |
|
|
| 691 | qw(selection option-popup selection-popup readline), |
719 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
| 692 | map $_->[0], values %{ $TERM->{meta}{binding} }; |
|
|
| 693 | |
720 | |
| 694 | for ($TERM->_keysym_resources) { |
721 | for ($TERM->_keysym_resources) { |
| 695 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
722 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
| 696 | next unless /^([A-Za-z0-9_\-]+):/; |
723 | next unless /^([A-Za-z0-9_\-]+):/; |
| 697 | |
724 | |
| … | |
… | |
| 706 | } elsif (/^([^<]+)<(.*)>$/) { |
733 | } elsif (/^([^<]+)<(.*)>$/) { |
| 707 | push @{ $ext_arg{$1} }, $2; |
734 | push @{ $ext_arg{$1} }, $2; |
| 708 | |
735 | |
| 709 | } else { |
736 | } else { |
| 710 | $ext_arg{$_} ||= []; |
737 | $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 | } |
738 | } |
| 719 | } |
739 | } |
| 720 | |
740 | |
| 721 | for my $ext (sort keys %ext_arg) { |
741 | for my $ext (sort keys %ext_arg) { |
| 722 | my @files = grep -f $_, map "$_/$ext", @dirs; |
742 | my @files = grep -f $_, map "$_/$ext", @dirs; |
| … | |
… | |
| 945 | } |
965 | } |
| 946 | |
966 | |
| 947 | bless \%disable, "urxvt::extension::on_disable" |
967 | bless \%disable, "urxvt::extension::on_disable" |
| 948 | } |
968 | } |
| 949 | |
969 | |
|
|
970 | =item $self->bind_action ($hotkey, $action) |
|
|
971 | |
| 950 | =item $self->x_resource ($pattern) |
972 | =item $self->x_resource ($pattern) |
| 951 | |
973 | |
| 952 | =item $self->x_resource_boolean ($pattern) |
974 | =item $self->x_resource_boolean ($pattern) |
| 953 | |
975 | |
| 954 | These methods support an additional C<%> prefix when called on an |
976 | These methods support an additional C<%> prefix for C<$action> or |
| 955 | extension object - see the description of these methods in the |
977 | C<$pattern> when called on an extension object, compared to the |
|
|
978 | C<urxvt::term> methods of the same name - see the description of these |
| 956 | C<urxvt::term> class for details. |
979 | methods in the C<urxvt::term> class for details. |
| 957 | |
980 | |
| 958 | =cut |
981 | =cut |
|
|
982 | |
|
|
983 | sub bind_action { |
|
|
984 | my ($self, $hotkey, $action) = @_; |
|
|
985 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
986 | $self->{term}->bind_action ($hotkey, $action) |
|
|
987 | } |
| 959 | |
988 | |
| 960 | sub x_resource { |
989 | sub x_resource { |
| 961 | my ($self, $name) = @_; |
990 | my ($self, $name) = @_; |
| 962 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
991 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
| 963 | $self->{term}->x_resource ($name) |
992 | $self->{term}->x_resource ($name) |
| … | |
… | |
| 1104 | sub scan_extensions { |
1133 | sub scan_extensions { |
| 1105 | my ($self) = @_; |
1134 | my ($self) = @_; |
| 1106 | |
1135 | |
| 1107 | return if exists $self->{meta}; |
1136 | return if exists $self->{meta}; |
| 1108 | |
1137 | |
| 1109 | my @libdirs = perl_libdirs $self; |
1138 | my @urxvtdirs = perl_libdirs $self; |
|
|
1139 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
| 1110 | |
1140 | |
| 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; |
1141 | $self->{meta} = \my %meta; |
| 1115 | |
1142 | |
| 1116 | # first gather extensions |
1143 | # first gather extensions |
| 1117 | for my $dir (reverse @libdirs) { |
1144 | |
|
|
1145 | my $gather = sub { |
|
|
1146 | my ($dir, $core) = @_; |
|
|
1147 | |
| 1118 | opendir my $fh, $dir |
1148 | opendir my $fh, $dir |
| 1119 | or next; |
1149 | or return; |
|
|
1150 | |
| 1120 | for my $ext (readdir $fh) { |
1151 | for my $ext (readdir $fh) { |
| 1121 | $ext !~ /^\./ |
1152 | $ext !~ /^\./ |
|
|
1153 | or next; |
|
|
1154 | |
| 1122 | and open my $fh, "<", "$dir/$ext" |
1155 | open my $fh, "<", "$dir/$ext" |
|
|
1156 | or next; |
|
|
1157 | |
|
|
1158 | -f $fh |
|
|
1159 | or next; |
|
|
1160 | |
|
|
1161 | $ext =~ s/\.uext$// or $core |
| 1123 | or next; |
1162 | or next; |
| 1124 | |
1163 | |
| 1125 | my %ext = (dir => $dir); |
1164 | my %ext = (dir => $dir); |
| 1126 | |
1165 | |
| 1127 | while (<$fh>) { |
1166 | while (<$fh>) { |
| … | |
… | |
| 1131 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1170 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
| 1132 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1171 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
| 1133 | } else { |
1172 | } else { |
| 1134 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1173 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
| 1135 | } |
1174 | } |
| 1136 | } elsif (/^#:META:BINDING:(.*)/) { |
|
|
| 1137 | my ($keysym, $action) = split /:/, $1; |
|
|
| 1138 | $ext{binding}{$keysym} = [$ext, $action]; |
|
|
| 1139 | } elsif (/^\s*(?:#|$)/) { |
1175 | } elsif (/^\s*(?:#|$)/) { |
| 1140 | # skip other comments and empty lines |
1176 | # skip other comments and empty lines |
| 1141 | } else { |
1177 | } else { |
| 1142 | last; # stop parsing on first non-empty non-comment line |
1178 | last; # stop parsing on first non-empty non-comment line |
| 1143 | } |
1179 | } |
| 1144 | } |
1180 | } |
| 1145 | |
1181 | |
| 1146 | $meta{ext}{$ext} = \%ext; |
1182 | $meta{ext}{$ext} = \%ext; |
| 1147 | } |
1183 | } |
| 1148 | } |
1184 | }; |
| 1149 | |
1185 | |
|
|
1186 | # $gather->($_, 0) for @cpandirs; |
|
|
1187 | $gather->($_, 1) for @urxvtdirs; |
|
|
1188 | |
| 1150 | # and now merge resources and bindings |
1189 | # and now merge resources |
|
|
1190 | |
|
|
1191 | $meta{resource} = \my %resource; |
|
|
1192 | |
| 1151 | while (my ($k, $v) = each %{ $meta{ext} }) { |
1193 | while (my ($k, $v) = each %{ $meta{ext} }) { |
| 1152 | #TODO: should check for extensions overriding each other |
1194 | #TODO: should check for extensions overriding each other |
| 1153 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
1195 | %resource = (%resource, %{ $v->{resource} }); |
| 1154 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
|
|
| 1155 | } |
1196 | } |
| 1156 | } |
1197 | } |
| 1157 | |
1198 | |
| 1158 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1199 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
| 1159 | |
1200 | |
| … | |
… | |
| 1282 | |
1323 | |
| 1283 | If the method is called on an extension object (basically, from an |
1324 | 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 |
1325 | 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 |
1326 | 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 |
1327 | 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 |
1328 | can rename them and get a new set of resources without having to change |
| 1288 | without having to change the actual code. |
1329 | the actual code. |
| 1289 | |
1330 | |
| 1290 | This method should only be called during the C<on_start> hook, as there is |
1331 | 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 |
1332 | only one resource database per display, and later invocations might return |
| 1292 | the wrong resources. |
1333 | the wrong resources. |
| 1293 | |
1334 | |
| … | |
… | |
| 1305 | my $res = &x_resource; |
1346 | my $res = &x_resource; |
| 1306 | |
1347 | |
| 1307 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1348 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
| 1308 | } |
1349 | } |
| 1309 | |
1350 | |
|
|
1351 | =item $action = $term->lookup_keysym ($keysym, $state) |
|
|
1352 | |
|
|
1353 | Returns the action bound to key combination C<($keysym, $state)>, |
|
|
1354 | if a binding for it exists, and C<undef> otherwise. |
|
|
1355 | |
| 1310 | =item $success = $term->bind_action ($key, $octets) |
1356 | =item $success = $term->bind_action ($key, $action) |
| 1311 | |
1357 | |
| 1312 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1358 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
| 1313 | C<keysym> resource in the urxvt(1) manpage. |
1359 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1360 | |
|
|
1361 | To add default bindings for actions, an extension should call C<< |
|
|
1362 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1363 | in the C<init> hook allows users to override or remove the binding |
|
|
1364 | again. |
|
|
1365 | |
|
|
1366 | Example: the C<searchable-scrollback> by default binds itself |
|
|
1367 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
|
|
1368 | $term->bind_action >>. |
|
|
1369 | |
|
|
1370 | sub init { |
|
|
1371 | my ($self) = @_; |
|
|
1372 | |
|
|
1373 | $self->bind_action ("M-s" => "%:start"); |
|
|
1374 | } |
| 1314 | |
1375 | |
| 1315 | =item $rend = $term->rstyle ([$new_rstyle]) |
1376 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 1316 | |
1377 | |
| 1317 | Return and optionally change the current rendition. Text that is output by |
1378 | Return and optionally change the current rendition. Text that is output by |
| 1318 | the terminal application will use this style. |
1379 | the terminal application will use this style. |
| … | |
… | |
| 1476 | |
1537 | |
| 1477 | =item $term->scr_add_lines ($string) |
1538 | =item $term->scr_add_lines ($string) |
| 1478 | |
1539 | |
| 1479 | Write the given text string to the screen, as if output by the application |
1540 | 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 |
1541 | 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 |
1542 | 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. |
1543 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1544 | locale-dependent encoding. |
| 1483 | |
1545 | |
| 1484 | Normally its not a good idea to use this function, as programs might be |
1546 | 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 |
1547 | confused by changes in cursor position or scrolling. Its useful inside a |
| 1486 | C<on_add_lines> hook, though. |
1548 | C<on_add_lines> hook, though. |
| 1487 | |
1549 | |
| … | |
… | |
| 1495 | locale-specific encoding of the terminal and can contain command sequences |
1557 | locale-specific encoding of the terminal and can contain command sequences |
| 1496 | (escape codes) that will be interpreted. |
1558 | (escape codes) that will be interpreted. |
| 1497 | |
1559 | |
| 1498 | =item $term->tt_write ($octets) |
1560 | =item $term->tt_write ($octets) |
| 1499 | |
1561 | |
| 1500 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1562 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1563 | 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 |
1564 | characters instead of octets, you should convert your strings first to the |
| 1502 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1565 | locale-specific encoding using C<< $term->locale_encode >>. |
| 1503 | |
1566 | |
| 1504 | =item $term->tt_write_user_input ($octets) |
1567 | =item $term->tt_write_user_input ($octets) |
| 1505 | |
1568 | |
| 1506 | Like C<tt_write>, but should be used when writing strings in response to |
1569 | 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 |
1570 | the user pressing a key, to invoke the additional actions requested by |
| … | |
… | |
| 1638 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1701 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
| 1639 | compare the on-screen display with its stored representation. If they |
1702 | compare the on-screen display with its stored representation. If they |
| 1640 | differ, it redraws the differences. |
1703 | differ, it redraws the differences. |
| 1641 | |
1704 | |
| 1642 | Used after changing terminal contents to display them. |
1705 | Used after changing terminal contents to display them. |
|
|
1706 | |
|
|
1707 | =item $term->refresh_check |
|
|
1708 | |
|
|
1709 | Checks if a refresh has been requested and, if so, schedules one. |
| 1643 | |
1710 | |
| 1644 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1711 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
| 1645 | |
1712 | |
| 1646 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1713 | 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 |
1714 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
