… | |
… | |
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 and also default bindings for one or |
51 | corresponding extension is loaded automatically. |
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. |
52 | |
57 | |
53 | =head1 API DOCUMENTATION |
58 | =head1 API DOCUMENTATION |
54 | |
59 | |
55 | =head2 General API Considerations |
60 | =head2 General API Considerations |
56 | |
61 | |
… | |
… | |
108 | C<urxvt::term> class on this object. |
113 | C<urxvt::term> class on this object. |
109 | |
114 | |
110 | Additional methods only supported for extension objects are described in |
115 | Additional methods only supported for extension objects are described in |
111 | the C<urxvt::extension> section below. |
116 | the C<urxvt::extension> section below. |
112 | |
117 | |
|
|
118 | =head2 META comments |
|
|
119 | |
|
|
120 | rxvt-unicode recognizes special comments in extensions that define |
|
|
121 | different types of metadata: |
|
|
122 | |
|
|
123 | =over 4 |
|
|
124 | |
|
|
125 | =item #:META:RESOURCE:name:type:desc |
|
|
126 | |
|
|
127 | 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> |
|
|
129 | 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 | |
|
|
139 | =back |
|
|
140 | |
113 | =head2 Hooks |
141 | =head2 Hooks |
114 | |
142 | |
115 | The following subroutines can be declared in extension files, and will be |
143 | The following subroutines can be declared in extension files, and will be |
116 | called whenever the relevant event happens. |
144 | called whenever the relevant event happens. |
117 | |
145 | |
… | |
… | |
282 | code is run after this hook, and takes precedence. |
310 | code is run after this hook, and takes precedence. |
283 | |
311 | |
284 | =item on_refresh_end $term |
312 | =item on_refresh_end $term |
285 | |
313 | |
286 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
314 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
|
|
315 | |
|
|
316 | =item on_action $term, $string |
|
|
317 | |
|
|
318 | Called whenever an action is invoked for the corresponding extension |
|
|
319 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
320 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
321 | event is simply the action string. Note that an action event is always |
|
|
322 | associated to a single extension. |
287 | |
323 | |
288 | =item on_user_command $term, $string *DEPRECATED* |
324 | =item on_user_command $term, $string *DEPRECATED* |
289 | |
325 | |
290 | Called whenever a user-configured event is being activated (e.g. via |
326 | 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> |
327 | a C<perl:string> action bound to a key, see description of the B<keysym> |
… | |
… | |
686 | ) { |
722 | ) { |
687 | if ($_ eq "default") { |
723 | if ($_ eq "default") { |
688 | |
724 | |
689 | $ext_arg{$_} = [] |
725 | $ext_arg{$_} = [] |
690 | for |
726 | for |
691 | qw(selection option-popup selection-popup readline), |
727 | qw(selection option-popup selection-popup readline searchable-scrollback), |
692 | map $_->[0], values %{ $TERM->{meta}{binding} }; |
728 | map $_->[0], values %{ $TERM->{meta}{binding} }; |
693 | |
729 | |
694 | for ($TERM->_keysym_resources) { |
730 | for ($TERM->_keysym_resources) { |
695 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
731 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
696 | next unless /^([A-Za-z0-9_\-]+):/; |
732 | next unless /^([A-Za-z0-9_\-]+):/; |
… | |
… | |
1282 | |
1318 | |
1283 | If the method is called on an extension object (basically, from an |
1319 | 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 |
1320 | 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 |
1321 | 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 |
1322 | 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 |
1323 | can rename them and get a new set of resources without having to change |
1288 | without having to change the actual code. |
1324 | the actual code. |
1289 | |
1325 | |
1290 | This method should only be called during the C<on_start> hook, as there is |
1326 | 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 |
1327 | only one resource database per display, and later invocations might return |
1292 | the wrong resources. |
1328 | the wrong resources. |
1293 | |
1329 | |
… | |
… | |
1476 | |
1512 | |
1477 | =item $term->scr_add_lines ($string) |
1513 | =item $term->scr_add_lines ($string) |
1478 | |
1514 | |
1479 | Write the given text string to the screen, as if output by the application |
1515 | 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 |
1516 | 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 |
1517 | 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. |
1518 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1519 | locale-dependent encoding. |
1483 | |
1520 | |
1484 | Normally its not a good idea to use this function, as programs might be |
1521 | 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 |
1522 | confused by changes in cursor position or scrolling. Its useful inside a |
1486 | C<on_add_lines> hook, though. |
1523 | C<on_add_lines> hook, though. |
1487 | |
1524 | |
… | |
… | |
1495 | locale-specific encoding of the terminal and can contain command sequences |
1532 | locale-specific encoding of the terminal and can contain command sequences |
1496 | (escape codes) that will be interpreted. |
1533 | (escape codes) that will be interpreted. |
1497 | |
1534 | |
1498 | =item $term->tt_write ($octets) |
1535 | =item $term->tt_write ($octets) |
1499 | |
1536 | |
1500 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1537 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1538 | 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 |
1539 | characters instead of octets, you should convert your strings first to the |
1502 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1540 | locale-specific encoding using C<< $term->locale_encode >>. |
1503 | |
1541 | |
1504 | =item $term->tt_write_user_input ($octets) |
1542 | =item $term->tt_write_user_input ($octets) |
1505 | |
1543 | |
1506 | Like C<tt_write>, but should be used when writing strings in response to |
1544 | 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 |
1545 | the user pressing a key, to invoke the additional actions requested by |