1 | =encoding utf8 |
1 | =encoding utf8 |
2 | |
2 | |
3 | =head1 NAME |
3 | =head1 NAME |
4 | |
4 | |
5 | @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter |
5 | urxvtperl - rxvt-unicode's embedded perl interpreter |
6 | |
6 | |
7 | =head1 SYNOPSIS |
7 | =head1 SYNOPSIS |
8 | |
8 | |
9 | # create a file grab_test in $HOME: |
9 | # create a file grab_test in some directory: |
10 | |
10 | |
11 | sub on_sel_grab { |
11 | sub on_sel_grab { |
12 | warn "you selected ", $_[0]->selection; |
12 | warn "you selected ", $_[0]->selection; |
13 | () |
13 | () |
14 | } |
14 | } |
15 | |
15 | |
16 | # start a @@RXVT_NAME@@ using it: |
16 | # start a urxvt instance using it: |
17 | |
17 | |
18 | @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test |
18 | urxvt --perl-lib path/to/somedirectory -pe grab_test |
19 | |
19 | |
20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
21 | |
21 | |
22 | Every time a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
24 | |
24 | |
25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict qw(vars subs)' and 'use utf8' |
26 | thus must be encoded as UTF-8. |
26 | environment, and thus must be encoded as UTF-8. |
27 | |
27 | |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in urxvtd, where |
29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
30 | |
30 | |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
31 | You can disable the embedded perl interpreter by setting both "perl-ext" |
32 | and "perl-ext-common" resources to the empty string. |
32 | and "perl-ext-common" resources to the empty string. |
33 | |
33 | |
34 | =head1 PREPACKAGED EXTENSIONS |
34 | =head1 PREPACKAGED EXTENSIONS |
35 | |
35 | |
36 | A number of extensions are delivered with this release. You can find them |
36 | A number of extensions are delivered with this release. You can find them |
37 | in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed |
37 | in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using |
38 | using F<< man urxvt-<EXTENSIONNAME> >>. |
38 | F<< man urxvt-<EXTENSIONNAME> >>. |
39 | |
39 | |
40 | You can activate them like this: |
40 | You can activate them like this: |
41 | |
41 | |
42 | @@RXVT_NAME@@ -pe <extensionname> |
42 | urxvt -pe <extensionname> |
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 using so called META comments, |
|
|
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. |
50 | |
56 | |
51 | =head1 API DOCUMENTATION |
57 | =head1 API DOCUMENTATION |
52 | |
58 | |
53 | =head2 General API Considerations |
59 | =head2 General API Considerations |
54 | |
60 | |
… | |
… | |
64 | terminal is destroyed. |
70 | terminal is destroyed. |
65 | |
71 | |
66 | Argument names also often indicate the type of a parameter. Here are some |
72 | Argument names also often indicate the type of a parameter. Here are some |
67 | hints on what they mean: |
73 | hints on what they mean: |
68 | |
74 | |
69 | =over 4 |
75 | =over |
70 | |
76 | |
71 | =item $text |
77 | =item $text |
72 | |
78 | |
73 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
79 | Rxvt-unicode's special way of encoding text, where one "unicode" character |
74 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
80 | always represents one screen cell. See L<ROW_t> for a discussion of this format. |
… | |
… | |
103 | internal use. |
109 | internal use. |
104 | |
110 | |
105 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
111 | Although it isn't a C<urxvt::term> object, you can call all methods of the |
106 | C<urxvt::term> class on this object. |
112 | C<urxvt::term> class on this object. |
107 | |
113 | |
108 | It has the following methods and data members: |
114 | Additional methods only supported for extension objects are described in |
|
|
115 | the C<urxvt::extension> section below. |
109 | |
116 | |
|
|
117 | =head2 META comments |
|
|
118 | |
|
|
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
|
|
120 | different types of metadata. These comments are scanned whenever a |
|
|
121 | terminal is created and are typically used to autoload extensions when |
|
|
122 | their resources or command line parameters are used. |
|
|
123 | |
|
|
124 | Currently, it recognises these comments below. Individual components are |
|
|
125 | separated by colons (C<:>), and should not contain colons themselves - |
|
|
126 | there is also currently no escaping mechanism provided for this. |
|
|
127 | |
110 | =over 4 |
128 | =over |
111 | |
129 | |
112 | =item $urxvt_term = $self->{term} |
130 | =item #:META:RESOURCE:name:type:desc |
113 | |
131 | |
114 | Returns the C<urxvt::term> object associated with this instance of the |
132 | The RESOURCE comment defines a resource used by the extension, where |
115 | extension. This member I<must not> be changed in any way. |
133 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
|
|
134 | or C<string>, and C<desc> is the resource description. |
116 | |
135 | |
117 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
136 | The extension will be autoloaded when this resource is specified or used |
|
|
137 | as a command line parameter. |
118 | |
138 | |
119 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
139 | Example: matcher provides the C<matcher.launcher> resource by having this |
120 | this extension, replacing any previous hook. This is useful when you want |
140 | comment: |
121 | to overwrite time-critical hooks only temporarily. |
|
|
122 | |
141 | |
123 | To install additional callbacks for the same hook, you cna use the C<on> |
142 | #:META:RESOURCE:%.launcher:string:default launcher command |
124 | method of the C<urxvt::term> class. |
|
|
125 | |
143 | |
126 | =item $self->disable ($hook_name[, $hook_name..]) |
144 | Example: load this extension when the C<-tr> command line option or |
|
|
145 | resource name is used. |
127 | |
146 | |
128 | Dynamically disable the given hooks. |
147 | #:META:RESOURCE:tr:boolean:set root pixmap as background |
129 | |
148 | |
130 | =item $self->x_resource ($pattern) |
149 | =item #:META:OSC:number:desc |
131 | |
150 | |
132 | =item $self->x_resource_boolean ($pattern) |
151 | The OSC comment specifies an OSC sequence, where C<number> is the |
|
|
152 | numerical OSC code and C<desc> is a short description that is currently |
|
|
153 | unused. |
133 | |
154 | |
134 | These methods support an additional C<%> prefix when called on an |
155 | This will cause the extension to be autoloaded when the OSC sequence is |
135 | extension object - see the description of these methods in the |
156 | used for the first time. |
136 | C<urxvt::term> class for details. |
157 | |
|
|
158 | Note that autoloading carries some extra responsibilities with it: |
|
|
159 | although the terminal cannot really protect itself against malicious |
|
|
160 | sources of command sequences, therefore relying on the programs running |
|
|
161 | I<inside> to sanitize data that they output, it is very common for |
|
|
162 | programs to emit command sequences from untrusted sources. |
|
|
163 | |
|
|
164 | While this means that extensions should, as a defense-in-depth mechanism, |
|
|
165 | always consider whether OSC sequences are safe, autoloading automatically |
|
|
166 | exposes any autoloaded extension in all terminal windows, so extra care |
|
|
167 | should be taken. |
|
|
168 | |
|
|
169 | Example: the background extension registers OSC C<20> like this: |
|
|
170 | |
|
|
171 | #:META:OSC:20:change/query background image |
|
|
172 | |
|
|
173 | =item #:META:OSC_PERL:prefix:desc |
|
|
174 | |
|
|
175 | The same as the OSC comment, but for the Perl OSC sequence (C<777>). The |
|
|
176 | C<prefix> should be unique among extensions, of course, which is most |
|
|
177 | easily arranged by using the extension name, although this is not |
|
|
178 | required. |
|
|
179 | |
|
|
180 | Example: the overlay-osc extension registers its Perl OSC like this: |
|
|
181 | |
|
|
182 | #:META:OSC_PERL:overlay:man overlay-osc |
137 | |
183 | |
138 | =back |
184 | =back |
139 | |
185 | |
140 | =head2 Hooks |
186 | =head2 Hooks |
141 | |
187 | |
… | |
… | |
149 | hooks returns true, then the event counts as being I<consumed>, and the |
195 | hooks returns true, then the event counts as being I<consumed>, and the |
150 | relevant action might not be carried out by the C++ code. |
196 | relevant action might not be carried out by the C++ code. |
151 | |
197 | |
152 | I<< When in doubt, return a false value (preferably C<()>). >> |
198 | I<< When in doubt, return a false value (preferably C<()>). >> |
153 | |
199 | |
154 | =over 4 |
200 | =over |
|
|
201 | |
|
|
202 | =item on_attach $term |
|
|
203 | |
|
|
204 | Called when an extension package is attached to a running terminal |
|
|
205 | instance. Must return true in all cases, and runs with the same |
|
|
206 | limitations as C<on_init>. |
|
|
207 | |
|
|
208 | Unlike C<on_init> or C<on_start>, this is called when the extension is |
|
|
209 | attached to a terminal, regardless of whether the extension is loaded |
|
|
210 | before or after the terminal is started. Extensions that need to do |
|
|
211 | something before they work can do it in this callback, as opposed to e.g. |
|
|
212 | C<on_init>, which might not be called. |
155 | |
213 | |
156 | =item on_init $term |
214 | =item on_init $term |
157 | |
215 | |
158 | Called after a new terminal object has been initialized, but before |
216 | Called after a new terminal object has been initialized, but before |
159 | windows are created or the command gets run. Most methods are unsafe to |
217 | windows are created or the command gets run. Most methods are unsafe to |
… | |
… | |
241 | |
299 | |
242 | C<on_osc_seq_perl> should be used for new behaviour. |
300 | C<on_osc_seq_perl> should be used for new behaviour. |
243 | |
301 | |
244 | =item on_osc_seq_perl $term, $args, $resp |
302 | =item on_osc_seq_perl $term, $args, $resp |
245 | |
303 | |
246 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
304 | Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence |
247 | operating system command) is processed. Cursor position and other state |
305 | (OSC = operating system command) is processed. Cursor position and other |
248 | information is up-to-date when this happens. For interoperability, the |
306 | state information is up-to-date when this happens. For interoperability, |
249 | string should start with the extension name (sans -osc) and a semicolon, |
307 | the argument should start with the extension name (sans -osc) or some |
250 | to distinguish it from commands for other extensions, and this might be |
308 | other suitable prefix, and a semicolon, to distinguish it from commands |
251 | enforced in the future. |
309 | for other extensions. |
252 | |
310 | |
253 | For example, C<overlay-osc> uses this: |
311 | For example, C<overlay-osc> uses this: |
254 | |
312 | |
255 | sub on_osc_seq_perl { |
313 | sub on_osc_seq_perl { |
256 | my ($self, $osc, $resp) = @_; |
314 | my ($self, $osc, $resp) = @_; |
… | |
… | |
310 | |
368 | |
311 | =item on_refresh_end $term |
369 | =item on_refresh_end $term |
312 | |
370 | |
313 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
371 | Called just after the screen gets redrawn. See C<on_refresh_begin>. |
314 | |
372 | |
|
|
373 | =item on_action $term, $string |
|
|
374 | |
|
|
375 | Called whenever an action is invoked for the corresponding extension |
|
|
376 | (e.g. via a C<extension:string> builtin action bound to a key, see |
|
|
377 | description of the B<keysym> resource in the urxvt(1) manpage). The |
|
|
378 | event is simply the action string. Note that an action event is always |
|
|
379 | associated to a single extension. |
|
|
380 | |
315 | =item on_user_command $term, $string |
381 | =item on_user_command $term, $string *DEPRECATED* |
316 | |
382 | |
317 | Called whenever a user-configured event is being activated (e.g. via |
383 | Called whenever a user-configured event is being activated (e.g. via |
318 | a C<perl:string> action bound to a key, see description of the B<keysym> |
384 | a C<perl:string> action bound to a key, see description of the B<keysym> |
319 | resource in the @@RXVT_NAME@@(1) manpage). |
385 | resource in the urxvt(1) manpage). |
320 | |
386 | |
321 | The event is simply the action string. This interface is assumed to change |
387 | The event is simply the action string. This interface is going away in |
322 | slightly in the future. |
388 | preference to the C<on_action> hook. |
323 | |
|
|
324 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
325 | |
|
|
326 | Called after parsing a keysym resource but before registering the |
|
|
327 | associated binding. If this hook returns TRUE the binding is not |
|
|
328 | registered. It can be used to modify a binding by calling |
|
|
329 | C<register_command>. |
|
|
330 | |
389 | |
331 | =item on_resize_all_windows $term, $new_width, $new_height |
390 | =item on_resize_all_windows $term, $new_width, $new_height |
332 | |
391 | |
333 | Called just after the new window size has been calculated, but before |
392 | Called just after the new window size has been calculated, but before |
334 | windows are actually being resized or hints are being set. If this hook |
393 | windows are actually being resized or hints are being set. If this hook |
335 | returns TRUE, setting of the window hints is being skipped. |
394 | returns a true value, setting of the window hints is being skipped. |
336 | |
395 | |
337 | =item on_x_event $term, $event |
396 | =item on_x_event $term, $event |
338 | |
397 | |
339 | Called on every X event received on the vt window (and possibly other |
398 | Called on every X event received on the vt window (and possibly other |
340 | windows). Should only be used as a last resort. Most event structure |
399 | windows). Should only be used as a last resort. Most event structure |
… | |
… | |
380 | (real, not screen-based) row and column under the mouse cursor. |
439 | (real, not screen-based) row and column under the mouse cursor. |
381 | |
440 | |
382 | C<on_key_press> additionally receives the string rxvt-unicode would |
441 | C<on_key_press> additionally receives the string rxvt-unicode would |
383 | output, if any, in locale-specific encoding. |
442 | output, if any, in locale-specific encoding. |
384 | |
443 | |
385 | subwindow. |
|
|
386 | |
|
|
387 | =item on_client_message $term, $event |
444 | =item on_client_message $term, $event |
388 | |
445 | |
389 | =item on_wm_protocols $term, $event |
446 | =item on_wm_protocols $term, $event |
390 | |
447 | |
391 | =item on_wm_delete_window $term, $event |
448 | =item on_wm_delete_window $term, $event |
… | |
… | |
402 | =cut |
459 | =cut |
403 | |
460 | |
404 | package urxvt; |
461 | package urxvt; |
405 | |
462 | |
406 | use utf8; |
463 | use utf8; |
407 | use strict 'vars'; |
464 | use strict qw(vars subs); |
408 | use Carp (); |
465 | use Carp (); |
409 | use Scalar::Util (); |
466 | use Scalar::Util (); |
410 | use List::Util (); |
467 | use List::Util (); |
411 | |
468 | |
412 | our $VERSION = 1; |
469 | our $VERSION = 1; |
… | |
… | |
424 | |
481 | |
425 | our $NOCHAR = chr 0xffff; |
482 | our $NOCHAR = chr 0xffff; |
426 | |
483 | |
427 | =head2 Variables in the C<urxvt> Package |
484 | =head2 Variables in the C<urxvt> Package |
428 | |
485 | |
429 | =over 4 |
486 | =over |
430 | |
487 | |
431 | =item $urxvt::LIBDIR |
488 | =item $urxvt::LIBDIR |
432 | |
489 | |
433 | The rxvt-unicode library directory, where, among other things, the perl |
490 | The rxvt-unicode library directory, where, among other things, the perl |
434 | modules and scripts are stored. |
491 | modules and scripts are stored. |
… | |
… | |
464 | |
521 | |
465 | =back |
522 | =back |
466 | |
523 | |
467 | =head2 Functions in the C<urxvt> Package |
524 | =head2 Functions in the C<urxvt> Package |
468 | |
525 | |
469 | =over 4 |
526 | =over |
470 | |
527 | |
471 | =item urxvt::fatal $errormessage |
528 | =item urxvt::fatal $errormessage |
472 | |
529 | |
473 | Fatally aborts execution with the given error message (which should |
530 | Fatally aborts execution with the given error message (which should |
474 | include a trailing newline). Avoid at all costs! The only time this |
531 | include a trailing newline). Avoid at all costs! The only time this |
… | |
… | |
519 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
576 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
520 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
577 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
521 | |
578 | |
522 | Various constants for use in X calls and event processing. |
579 | Various constants for use in X calls and event processing. |
523 | |
580 | |
|
|
581 | =item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin, |
|
|
582 | PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP, |
|
|
583 | PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys, |
|
|
584 | PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11, |
|
|
585 | PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress, |
|
|
586 | PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent, |
|
|
587 | PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8, |
|
|
588 | PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report, |
|
|
589 | PrivMode_Default |
|
|
590 | |
|
|
591 | Constants for checking DEC private modes. |
|
|
592 | |
524 | =back |
593 | =back |
525 | |
594 | |
526 | =head2 RENDITION |
595 | =head2 RENDITION |
527 | |
596 | |
528 | Rendition bitsets contain information about colour, font, font styles and |
597 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
531 | The following "macros" deal with changes in rendition sets. You should |
600 | The following "macros" deal with changes in rendition sets. You should |
532 | never just create a bitset, you should always modify an existing one, |
601 | never just create a bitset, you should always modify an existing one, |
533 | as they contain important information required for correct operation of |
602 | as they contain important information required for correct operation of |
534 | rxvt-unicode. |
603 | rxvt-unicode. |
535 | |
604 | |
536 | =over 4 |
605 | =over |
537 | |
606 | |
538 | =item $rend = urxvt::DEFAULT_RSTYLE |
607 | =item $rend = urxvt::DEFAULT_RSTYLE |
539 | |
608 | |
540 | Returns the default rendition, as used when the terminal is starting up or |
609 | Returns the default rendition, as used when the terminal is starting up or |
541 | being reset. Useful as a base to start when creating renditions. |
610 | being reset. Useful as a base to start when creating renditions. |
… | |
… | |
593 | no warnings 'utf8'; |
662 | no warnings 'utf8'; |
594 | |
663 | |
595 | sub parse_resource { |
664 | sub parse_resource { |
596 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
665 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
597 | |
666 | |
598 | $name =~ y/-/./ if $isarg; |
|
|
599 | |
|
|
600 | $term->scan_meta; |
667 | $term->scan_extensions; |
601 | |
668 | |
|
|
669 | # iterating over all resources has quadratic time overhead |
|
|
670 | # overall, maybe this could be optimised? |
602 | my $r = $term->{meta}{resource}; |
671 | my $r = $term->{meta}{resource}; |
603 | keys %$r; # reste iterator |
672 | keys %$r; # reset iterator |
604 | while (my ($pattern, $v) = each %$r) { |
673 | while (my ($k, $v) = each %$r) { |
605 | if ( |
674 | my $pattern = $k; |
|
|
675 | $pattern =~ y/./-/ if $isarg; |
|
|
676 | my $prefix = $name; |
|
|
677 | my $suffix; |
606 | $pattern =~ /\.$/ |
678 | if ($pattern =~ /\-$/) { |
607 | ? $pattern eq substr $name, 0, length $pattern |
679 | $prefix = substr $name, 0, length $pattern; |
608 | : $pattern eq $name |
680 | $suffix = substr $name, length $pattern; |
609 | ) { |
681 | } |
|
|
682 | if ($pattern eq $prefix) { |
610 | $name = "$urxvt::RESCLASS.$name"; |
683 | $name = "$urxvt::RESCLASS.$k$suffix"; |
611 | |
684 | |
612 | push @{ $term->{perl_ext_3} }, $v->[0]; |
685 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
686 | |
|
|
687 | return 1 unless $isarg; |
613 | |
688 | |
614 | if ($v->[1] eq "boolean") { |
689 | if ($v->[1] eq "boolean") { |
615 | $term->put_option_db ($name, $flag ? "true" : "false"); |
690 | $term->put_option_db ($name, $flag ? "true" : "false"); |
616 | return 1; |
691 | return 1; |
617 | } else { |
692 | } else { |
… | |
… | |
625 | } |
700 | } |
626 | |
701 | |
627 | sub usage { |
702 | sub usage { |
628 | my ($term, $usage_type) = @_; |
703 | my ($term, $usage_type) = @_; |
629 | |
704 | |
630 | $term->scan_meta; |
705 | $term->scan_extensions; |
631 | |
706 | |
632 | my $r = $term->{meta}{resource}; |
707 | my $r = $term->{meta}{resource}; |
633 | |
708 | |
634 | for my $pattern (sort keys %$r) { |
709 | for my $pattern (sort keys %$r) { |
635 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
710 | my ($ext, $type, $desc) = @{ $r->{$pattern} }; |
… | |
… | |
650 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
725 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
651 | } |
726 | } |
652 | } |
727 | } |
653 | } |
728 | } |
654 | |
729 | |
655 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
730 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2; |
656 | |
731 | |
657 | sub verbose { |
732 | sub verbose { |
658 | my ($level, $msg) = @_; |
733 | my ($level, $msg) = @_; |
659 | warn "$msg\n" if $level <= $verbosity; |
734 | warn "$msg\n" if $level <= $verbosity; |
660 | } |
735 | } |
… | |
… | |
677 | |
752 | |
678 | open my $fh, "<:raw", $path |
753 | open my $fh, "<:raw", $path |
679 | or die "$path: $!"; |
754 | or die "$path: $!"; |
680 | |
755 | |
681 | my $source = |
756 | my $source = |
682 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
757 | "package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n" |
683 | . "#line 1 \"$path\"\n{\n" |
758 | . "#line 1 \"$path\"\n{\n" |
684 | . (do { local $/; <$fh> }) |
759 | . (do { local $/; <$fh> }) |
685 | . "\n};\n1"; |
760 | . "\n};\n1"; |
686 | |
761 | |
687 | eval $source |
762 | eval $source |
… | |
… | |
696 | # called by the rxvt core |
771 | # called by the rxvt core |
697 | sub invoke { |
772 | sub invoke { |
698 | local $TERM = shift; |
773 | local $TERM = shift; |
699 | my $htype = shift; |
774 | my $htype = shift; |
700 | |
775 | |
701 | if ($htype == 0) { # INIT |
776 | if ($htype == HOOK_INIT) { |
702 | my @dirs = $TERM->perl_libdirs; |
777 | $TERM->scan_extensions; |
703 | |
778 | |
704 | my %ext_arg; |
779 | my %ext_arg; |
705 | |
780 | |
706 | { |
781 | { |
707 | my @init = @TERM_INIT; |
782 | my @init = @TERM_INIT; |
… | |
… | |
712 | $TERM->register_package ($_) for @pkg; |
787 | $TERM->register_package ($_) for @pkg; |
713 | } |
788 | } |
714 | |
789 | |
715 | for ( |
790 | for ( |
716 | @{ delete $TERM->{perl_ext_3} }, |
791 | @{ delete $TERM->{perl_ext_3} }, |
717 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
792 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
718 | ) { |
793 | ) { |
719 | if ($_ eq "default") { |
794 | if ($_ eq "default") { |
|
|
795 | |
|
|
796 | $ext_arg{$_} = [] |
720 | $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); |
797 | for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste); |
|
|
798 | |
|
|
799 | for ($TERM->_keysym_resources) { |
|
|
800 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
|
|
801 | next unless /^([A-Za-z0-9_\-]+):/; |
|
|
802 | |
|
|
803 | my $ext = $1; |
|
|
804 | |
|
|
805 | $ext_arg{$ext} = []; |
|
|
806 | } |
|
|
807 | |
721 | } elsif (/^-(.*)$/) { |
808 | } elsif (/^-(.*)$/) { # remove from set |
722 | delete $ext_arg{$1}; |
809 | delete $ext_arg{$1}; |
723 | } elsif (/^([^<]+)<(.*)>$/) { |
810 | |
|
|
811 | } elsif (/^\/(.*)$/) { # prohibit loading |
|
|
812 | undef $TERM->{ext_prohibit}{$1}; |
|
|
813 | |
|
|
814 | } elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status |
|
|
815 | delete $TERM->{ext_prohibit}{$1}; |
724 | push @{ $ext_arg{$1} }, $2; |
816 | push @{ $ext_arg{$1} }, defined $2 ? $2 : (); |
|
|
817 | |
725 | } else { |
818 | } else { |
726 | $ext_arg{$_} ||= []; |
819 | verbose 2, "cannot parse extension specification '$_', ignoring."; |
727 | } |
820 | } |
728 | } |
821 | } |
729 | |
822 | |
|
|
823 | $TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc}; |
|
|
824 | $TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl}; |
|
|
825 | |
730 | for my $ext (sort keys %ext_arg) { |
826 | for my $ext (sort keys %ext_arg) { |
731 | my @files = grep -f $_, map "$_/$ext", @dirs; |
827 | my $path = $TERM->extension_path ($ext); |
732 | |
828 | |
733 | if (@files) { |
829 | if (defined $path) { |
734 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
830 | $TERM->autoload_extension ($ext, $ext_arg{$ext}); |
735 | } else { |
831 | } else { |
736 | warn "perl extension '$ext' not found in perl library search path\n"; |
832 | verbose 2, "perl extension '$ext' not found in perl library search path"; |
737 | } |
833 | } |
738 | } |
834 | } |
739 | |
835 | |
740 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
836 | eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); |
741 | warn $@ if $@; |
837 | warn $@ if $@; |
742 | } |
838 | } |
743 | |
839 | |
|
|
840 | if ($htype == HOOK_OSC_SEQ) { |
|
|
841 | if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) { |
|
|
842 | $TERM->autoload_extension ($_->[0]) for @$exts; |
|
|
843 | } |
|
|
844 | } elsif ($htype == HOOK_OSC_SEQ_PERL) { |
|
|
845 | if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) { |
|
|
846 | $TERM->autoload_extension ($_->[0]) for @$exts; |
|
|
847 | } |
|
|
848 | } |
|
|
849 | |
744 | $retval = undef; |
850 | $retval = undef; |
745 | |
851 | |
746 | if (my $cb = $TERM->{_hook}[$htype]) { |
852 | if (my $cb = $TERM->{_hook}[$htype]) { |
747 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
853 | verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" |
748 | if $verbosity >= 10; |
854 | if $verbosity >= 10; |
|
|
855 | |
|
|
856 | if ($htype == HOOK_ACTION) { |
|
|
857 | # this hook is only sent to the extension with the name |
|
|
858 | # matching the first arg |
|
|
859 | my $pkg = shift; |
|
|
860 | $pkg =~ y/-/_/; |
|
|
861 | $pkg = "urxvt::ext::$pkg"; |
|
|
862 | |
|
|
863 | $cb = $cb->{$pkg} |
|
|
864 | or return undef; #TODO: maybe warn user? |
|
|
865 | |
|
|
866 | $cb = { $pkg => $cb }; |
|
|
867 | } |
749 | |
868 | |
750 | for my $pkg (keys %$cb) { |
869 | for my $pkg (keys %$cb) { |
751 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
870 | my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) }; |
752 | $retval ||= $retval_; |
871 | $retval ||= $retval_; |
753 | |
872 | |
… | |
… | |
759 | |
878 | |
760 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
879 | verbose 11, "$HOOKNAME[$htype] returning <$retval>" |
761 | if $verbosity >= 11; |
880 | if $verbosity >= 11; |
762 | } |
881 | } |
763 | |
882 | |
764 | if ($htype == 1) { # DESTROY |
883 | if ($htype == HOOK_DESTROY) { |
765 | # clear package objects |
884 | # clear package objects |
766 | %$_ = () for values %{ $TERM->{_pkg} }; |
885 | %$_ = () for values %{ $TERM->{_pkg} }; |
767 | |
886 | |
768 | # clear package |
887 | # clear package |
769 | %$TERM = (); |
888 | %$TERM = (); |
… | |
… | |
801 | ($mask, @color{qw(fg bg)}, \@failed) |
920 | ($mask, @color{qw(fg bg)}, \@failed) |
802 | } |
921 | } |
803 | |
922 | |
804 | package urxvt::term::extension; |
923 | package urxvt::term::extension; |
805 | |
924 | |
806 | sub enable { |
925 | =head2 The C<urxvt::term::extension> class |
807 | my ($self, %hook) = @_; |
|
|
808 | my $pkg = $self->{_pkg}; |
|
|
809 | |
926 | |
810 | while (my ($name, $cb) = each %hook) { |
927 | Each extension attached to a terminal object is represented by |
811 | my $htype = $HOOKTYPE{uc $name}; |
928 | a C<urxvt::term::extension> object. |
812 | defined $htype |
|
|
813 | or Carp::croak "unsupported hook type '$name'"; |
|
|
814 | |
929 | |
815 | $self->set_should_invoke ($htype, +1) |
930 | You can use these objects, which are passed to all callbacks to store any |
816 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
931 | state related to the terminal and extension instance. |
817 | |
932 | |
818 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
933 | The methods (And data members) documented below can be called on extension |
819 | } |
934 | objects, in addition to call methods documented for the <urxvt::term> |
820 | } |
935 | class. |
821 | |
936 | |
822 | sub disable { |
937 | =over |
823 | my ($self, @hook) = @_; |
|
|
824 | my $pkg = $self->{_pkg}; |
|
|
825 | |
938 | |
826 | for my $name (@hook) { |
939 | =item $urxvt_term = $self->{term} |
827 | my $htype = $HOOKTYPE{uc $name}; |
|
|
828 | defined $htype |
|
|
829 | or Carp::croak "unsupported hook type '$name'"; |
|
|
830 | |
940 | |
831 | $self->set_should_invoke ($htype, -1) |
941 | Returns the C<urxvt::term> object associated with this instance of the |
832 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
942 | extension. This member I<must not> be changed in any way. |
833 | } |
943 | |
834 | } |
944 | =cut |
835 | |
945 | |
836 | our $AUTOLOAD; |
946 | our $AUTOLOAD; |
837 | |
947 | |
838 | sub AUTOLOAD { |
948 | sub AUTOLOAD { |
839 | $AUTOLOAD =~ /:([^:]+)$/ |
949 | $AUTOLOAD =~ /:([^:]+)$/ |
… | |
… | |
852 | |
962 | |
853 | sub DESTROY { |
963 | sub DESTROY { |
854 | # nop |
964 | # nop |
855 | } |
965 | } |
856 | |
966 | |
857 | # urxvt::destroy_hook |
967 | # urxvt::destroy_hook (basically a cheap Guard:: implementation) |
858 | |
968 | |
859 | sub urxvt::destroy_hook::DESTROY { |
969 | sub urxvt::destroy_hook::DESTROY { |
860 | ${$_[0]}->(); |
970 | ${$_[0]}->(); |
861 | } |
971 | } |
862 | |
972 | |
863 | sub urxvt::destroy_hook(&) { |
973 | sub urxvt::destroy_hook(&) { |
864 | bless \shift, urxvt::destroy_hook:: |
974 | bless \shift, urxvt::destroy_hook:: |
|
|
975 | } |
|
|
976 | |
|
|
977 | =item $self->enable ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
978 | |
|
|
979 | Dynamically enable the given hooks (named without the C<on_> prefix) for |
|
|
980 | this extension, replacing any hook previously installed via C<enable> in |
|
|
981 | this extension. |
|
|
982 | |
|
|
983 | This is useful when you want to overwrite time-critical hooks only |
|
|
984 | temporarily. |
|
|
985 | |
|
|
986 | To install additional callbacks for the same hook, you can use the C<on> |
|
|
987 | method of the C<urxvt::term> class. |
|
|
988 | |
|
|
989 | =item $self->disable ($hook_name[, $hook_name..]) |
|
|
990 | |
|
|
991 | Dynamically disable the given hooks. |
|
|
992 | |
|
|
993 | =cut |
|
|
994 | |
|
|
995 | sub enable { |
|
|
996 | my ($self, %hook) = @_; |
|
|
997 | my $pkg = $self->{_pkg}; |
|
|
998 | |
|
|
999 | while (my ($name, $cb) = each %hook) { |
|
|
1000 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1001 | defined $htype |
|
|
1002 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1003 | |
|
|
1004 | $self->set_should_invoke ($htype, +1) |
|
|
1005 | unless exists $self->{term}{_hook}[$htype]{$pkg}; |
|
|
1006 | |
|
|
1007 | $self->{term}{_hook}[$htype]{$pkg} = $cb; |
|
|
1008 | } |
|
|
1009 | } |
|
|
1010 | |
|
|
1011 | sub disable { |
|
|
1012 | my ($self, @hook) = @_; |
|
|
1013 | my $pkg = $self->{_pkg}; |
|
|
1014 | |
|
|
1015 | for my $name (@hook) { |
|
|
1016 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1017 | defined $htype |
|
|
1018 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1019 | |
|
|
1020 | $self->set_should_invoke ($htype, -1) |
|
|
1021 | if delete $self->{term}{_hook}[$htype]{$pkg}; |
|
|
1022 | } |
|
|
1023 | } |
|
|
1024 | |
|
|
1025 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
1026 | |
|
|
1027 | Similar to the C<enable> enable, but installs additional callbacks for |
|
|
1028 | the given hook(s) (that is, it doesn't replace existing callbacks), and |
|
|
1029 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
1030 | are disabled again. |
|
|
1031 | |
|
|
1032 | =cut |
|
|
1033 | |
|
|
1034 | sub urxvt::extension::on_disable::DESTROY { |
|
|
1035 | my $disable = shift; |
|
|
1036 | |
|
|
1037 | my $term = delete $disable->{""}; |
|
|
1038 | |
|
|
1039 | while (my ($htype, $id) = each %$disable) { |
|
|
1040 | delete $term->{_hook}[$htype]{$id}; |
|
|
1041 | $term->set_should_invoke ($htype, -1); |
|
|
1042 | } |
|
|
1043 | } |
|
|
1044 | |
|
|
1045 | sub on { |
|
|
1046 | my ($self, %hook) = @_; |
|
|
1047 | |
|
|
1048 | my $term = $self->{term}; |
|
|
1049 | |
|
|
1050 | my %disable = ( "" => $term ); |
|
|
1051 | |
|
|
1052 | while (my ($name, $cb) = each %hook) { |
|
|
1053 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1054 | defined $htype |
|
|
1055 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1056 | |
|
|
1057 | $term->set_should_invoke ($htype, +1); |
|
|
1058 | $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 } |
|
|
1059 | = sub { shift; $cb->($self, @_) }; # very ugly indeed |
|
|
1060 | } |
|
|
1061 | |
|
|
1062 | bless \%disable, "urxvt::extension::on_disable" |
|
|
1063 | } |
|
|
1064 | |
|
|
1065 | =item $self->bind_action ($hotkey, $action) |
|
|
1066 | |
|
|
1067 | =item $self->x_resource ($pattern) |
|
|
1068 | |
|
|
1069 | =item $self->x_resource_boolean ($pattern) |
|
|
1070 | |
|
|
1071 | These methods support an additional C<%> prefix for C<$action> or |
|
|
1072 | C<$pattern> when called on an extension object, compared to the |
|
|
1073 | C<urxvt::term> methods of the same name - see the description of these |
|
|
1074 | methods in the C<urxvt::term> class for details. |
|
|
1075 | |
|
|
1076 | =cut |
|
|
1077 | |
|
|
1078 | sub bind_action { |
|
|
1079 | my ($self, $hotkey, $action) = @_; |
|
|
1080 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
1081 | $self->{term}->bind_action ($hotkey, $action) |
865 | } |
1082 | } |
866 | |
1083 | |
867 | sub x_resource { |
1084 | sub x_resource { |
868 | my ($self, $name) = @_; |
1085 | my ($self, $name) = @_; |
869 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
1086 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
… | |
… | |
873 | sub x_resource_boolean { |
1090 | sub x_resource_boolean { |
874 | my ($self, $name) = @_; |
1091 | my ($self, $name) = @_; |
875 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
1092 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
876 | $self->{term}->x_resource_boolean ($name) |
1093 | $self->{term}->x_resource_boolean ($name) |
877 | } |
1094 | } |
|
|
1095 | |
|
|
1096 | =back |
|
|
1097 | |
|
|
1098 | =cut |
878 | |
1099 | |
879 | package urxvt::anyevent; |
1100 | package urxvt::anyevent; |
880 | |
1101 | |
881 | =head2 The C<urxvt::anyevent> Class |
1102 | =head2 The C<urxvt::anyevent> Class |
882 | |
1103 | |
… | |
… | |
962 | |
1183 | |
963 | package urxvt::term; |
1184 | package urxvt::term; |
964 | |
1185 | |
965 | =head2 The C<urxvt::term> Class |
1186 | =head2 The C<urxvt::term> Class |
966 | |
1187 | |
967 | =over 4 |
1188 | =over |
968 | |
1189 | |
969 | =cut |
1190 | =cut |
970 | |
1191 | |
971 | # find on_xxx subs in the package and register them |
1192 | # find on_xxx subs in the package and register them |
972 | # as hooks |
1193 | # as hooks |
973 | sub register_package { |
1194 | sub register_package { |
974 | my ($self, $pkg, $argv) = @_; |
1195 | my ($self, $pkg, $argv) = @_; |
|
|
1196 | |
|
|
1197 | return if $self->{_pkg}{$pkg}; |
975 | |
1198 | |
976 | no strict 'refs'; |
1199 | no strict 'refs'; |
977 | |
1200 | |
978 | urxvt::verbose 6, "register package $pkg to $self"; |
1201 | urxvt::verbose 6, "register package $pkg to $self"; |
979 | |
1202 | |
… | |
… | |
991 | for my $name (@HOOKNAME) { |
1214 | for my $name (@HOOKNAME) { |
992 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
1215 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
993 | $proxy->enable ($name => $ref); |
1216 | $proxy->enable ($name => $ref); |
994 | } |
1217 | } |
995 | } |
1218 | } |
|
|
1219 | |
|
|
1220 | if (my $attach_hook = $pkg->can ("on_attach")) { |
|
|
1221 | $attach_hook->($proxy) |
|
|
1222 | or urxvt::verbose 1, "$pkg->on_attach returned false, extension failed to attach"; |
|
|
1223 | } |
|
|
1224 | } |
|
|
1225 | |
|
|
1226 | # map extension name to filesystem path |
|
|
1227 | sub extension_path { |
|
|
1228 | (grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0] |
|
|
1229 | } |
|
|
1230 | |
|
|
1231 | # load an extension by name |
|
|
1232 | sub load_extension_file { |
|
|
1233 | my ($self, $path, $argv) = @_; |
|
|
1234 | |
|
|
1235 | $self->register_package (urxvt::extension_package $path, $argv); |
|
|
1236 | } |
|
|
1237 | |
|
|
1238 | # autoload an extension unless loading it is prohibited |
|
|
1239 | sub autoload_extension { |
|
|
1240 | my ($self, $name, $argv) = @_; |
|
|
1241 | |
|
|
1242 | return if exists $self->{ext_prohibit}{$name}; |
|
|
1243 | |
|
|
1244 | my $path = $self->extension_path ($name) |
|
|
1245 | // return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)"; |
|
|
1246 | |
|
|
1247 | $self->load_extension_file ($path, $argv); |
996 | } |
1248 | } |
997 | |
1249 | |
998 | sub perl_libdirs { |
1250 | sub perl_libdirs { |
999 | map { split /:/ } |
1251 | map { split /:/ } |
1000 | $_[0]->resource ("perl_lib"), |
1252 | $_[0]->resource ("perl_lib"), |
1001 | $ENV{URXVT_PERL_LIB}, |
1253 | $ENV{URXVT_PERL_LIB}, |
1002 | "$ENV{HOME}/.urxvt/ext", |
1254 | "$ENV{HOME}/.urxvt/ext", |
1003 | "$LIBDIR/perl" |
1255 | "$LIBDIR/perl" |
1004 | } |
1256 | } |
1005 | |
1257 | |
1006 | sub scan_meta { |
1258 | # scan for available extensions and collect their metadata |
|
|
1259 | sub scan_extensions { |
1007 | my ($self) = @_; |
1260 | my ($self) = @_; |
|
|
1261 | |
|
|
1262 | return if exists $self->{meta}; |
|
|
1263 | |
1008 | my @libdirs = perl_libdirs $self; |
1264 | my @urxvtdirs = perl_libdirs $self; |
|
|
1265 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
1009 | |
1266 | |
1010 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
1011 | |
|
|
1012 | my %meta; |
|
|
1013 | |
|
|
1014 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
1015 | $self->{meta} = \%meta; |
1267 | $self->{meta} = \my %allmeta; |
1016 | |
1268 | |
1017 | for my $dir (reverse @libdirs) { |
1269 | # first gather extensions |
|
|
1270 | |
|
|
1271 | my $gather = sub { |
|
|
1272 | my ($dir, $core) = @_; |
|
|
1273 | |
1018 | opendir my $fh, $dir |
1274 | opendir my $fh, $dir |
1019 | or next; |
1275 | or return; |
|
|
1276 | |
1020 | for my $ext (readdir $fh) { |
1277 | for my $ext (readdir $fh) { |
1021 | $ext ne "." |
1278 | $ext !~ /^\./ |
1022 | and $ext ne ".." |
|
|
1023 | and open my $fh, "<", "$dir/$ext" |
|
|
1024 | or next; |
1279 | or next; |
1025 | |
1280 | |
|
|
1281 | open my $fh, "<", "$dir/$ext" |
|
|
1282 | or next; |
|
|
1283 | |
|
|
1284 | -f $fh |
|
|
1285 | or next; |
|
|
1286 | |
|
|
1287 | $ext =~ s/\.uext$// or $core |
|
|
1288 | or next; |
|
|
1289 | |
|
|
1290 | my %meta = (dir => $dir); |
|
|
1291 | |
1026 | while (<$fh>) { |
1292 | while (<$fh>) { |
1027 | if (/^#:META:X_RESOURCE:(.*)/) { |
1293 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1028 | my ($pattern, $type, $desc) = split /:/, $1; |
1294 | my ($pattern, $type, $desc) = split /:/, $1; |
1029 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1295 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1030 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1296 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1031 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1297 | warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; |
1032 | } else { |
1298 | } else { |
1033 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1299 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1034 | } |
1300 | } |
|
|
1301 | |
|
|
1302 | } elsif (/^#:META:OSC:([0-9]+):(.*)/) { |
|
|
1303 | push @{$allmeta{autoload_osc}{$1}}, [$ext, $2]; |
|
|
1304 | |
|
|
1305 | } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) { |
|
|
1306 | push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2]; |
|
|
1307 | |
1035 | } elsif (/^\s*(?:#|$)/) { |
1308 | } elsif (/^\s*(?:#|$)/) { |
1036 | # skip other comments and empty lines |
1309 | # skip other comments and empty lines |
|
|
1310 | |
1037 | } else { |
1311 | } else { |
1038 | last; # stop parsing on first non-empty non-comment line |
1312 | last; # stop parsing on first non-empty non-comment line |
1039 | } |
1313 | } |
1040 | } |
1314 | } |
|
|
1315 | |
|
|
1316 | $allmeta{ext}{$ext} = \%meta; |
1041 | } |
1317 | } |
|
|
1318 | }; |
|
|
1319 | |
|
|
1320 | # $gather->($_, 0) for @cpandirs; |
|
|
1321 | $gather->($_, 1) for @urxvtdirs; |
|
|
1322 | |
|
|
1323 | # and now merge resources |
|
|
1324 | |
|
|
1325 | $allmeta{resource} = \my %resource; |
|
|
1326 | |
|
|
1327 | while (my ($k, $v) = each %{ $allmeta{ext} }) { |
|
|
1328 | #TODO: should check for extensions overriding each other |
|
|
1329 | %resource = (%resource, %{ $v->{resource} }); |
1042 | } |
1330 | } |
1043 | } |
1331 | } |
1044 | |
1332 | |
1045 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1333 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1046 | |
1334 | |
… | |
… | |
1066 | } |
1354 | } |
1067 | |
1355 | |
1068 | =item $term->destroy |
1356 | =item $term->destroy |
1069 | |
1357 | |
1070 | Destroy the terminal object (close the window, free resources |
1358 | Destroy the terminal object (close the window, free resources |
1071 | etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event |
1359 | etc.). Please note that urxvt will not exit as long as any event |
1072 | watchers (timers, io watchers) are still active. |
1360 | watchers (timers, io watchers) are still active. |
1073 | |
|
|
1074 | =item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..]) |
|
|
1075 | |
|
|
1076 | Similar to the extension method C<enable>, but installs additional |
|
|
1077 | callbacks for the givne hook(s) (existing ones are not replaced), and |
|
|
1078 | returns a guard object. When the guard object is destroyed the callbacks |
|
|
1079 | are disabled again. |
|
|
1080 | |
|
|
1081 | Note that these callbacks receive the normal paramaters, but the first |
|
|
1082 | argument (normally the extension) is currently undefined. |
|
|
1083 | |
|
|
1084 | =cut |
|
|
1085 | |
|
|
1086 | sub urxvt::term::on_disable::DESTROY { |
|
|
1087 | my $disable = shift; |
|
|
1088 | |
|
|
1089 | my $self = delete $disable->{""}; |
|
|
1090 | |
|
|
1091 | while (my ($htype, $id) = each %$disable) { |
|
|
1092 | delete $self->{_hook}[$htype]{$id}; |
|
|
1093 | $self->set_should_invoke ($htype, -1); |
|
|
1094 | } |
|
|
1095 | } |
|
|
1096 | |
|
|
1097 | sub on { |
|
|
1098 | my ($self, %hook) = @_; |
|
|
1099 | |
|
|
1100 | my %disable = ( "" => $self ); |
|
|
1101 | |
|
|
1102 | while (my ($name, $cb) = each %hook) { |
|
|
1103 | my $htype = $HOOKTYPE{uc $name}; |
|
|
1104 | defined $htype |
|
|
1105 | or Carp::croak "unsupported hook type '$name'"; |
|
|
1106 | |
|
|
1107 | my $id = $cb+0; |
|
|
1108 | |
|
|
1109 | $self->set_should_invoke ($htype, +1); |
|
|
1110 | $disable{$htype} = $id; |
|
|
1111 | $self->{_hook}[$htype]{$id} = $cb; |
|
|
1112 | } |
|
|
1113 | |
|
|
1114 | bless \%disable, "urxvt::term::on_disable" |
|
|
1115 | } |
|
|
1116 | |
1361 | |
1117 | =item $term->exec_async ($cmd[, @args]) |
1362 | =item $term->exec_async ($cmd[, @args]) |
1118 | |
1363 | |
1119 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1364 | Works like the combination of the C<fork>/C<exec> builtins, which executes |
1120 | ("starts") programs in the background. This function takes care of setting |
1365 | ("starts") programs in the background. This function takes care of setting |
… | |
… | |
1152 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1397 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1153 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1398 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1154 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1399 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1155 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1400 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1156 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
1401 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
1157 | urgentOnBell utmpInhibit visualBell |
1402 | urgentOnBell utmpInhibit visualBell disablePasteBrackets |
1158 | |
1403 | |
1159 | =item $value = $term->resource ($name[, $newval]) |
1404 | =item $value = $term->resource ($name[, $newval]) |
1160 | |
1405 | |
1161 | Returns the current resource value associated with a given name and |
1406 | Returns the current resource value associated with a given name and |
1162 | optionally sets a new value. Setting values is most useful in the C<init> |
1407 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1188 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1433 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1189 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1434 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1190 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1435 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1191 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1436 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1192 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1437 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1193 | utmpInhibit visualBell |
1438 | utmpInhibit visualBell rewrapMode disablePasteBrackets |
1194 | |
1439 | |
1195 | =cut |
1440 | =cut |
1196 | |
1441 | |
1197 | sub resource($$;$) { |
1442 | sub resource($$;$) { |
1198 | my ($self, $name) = (shift, shift); |
1443 | my ($self, $name) = (shift, shift); |
… | |
… | |
1205 | Returns the X-Resource for the given pattern, excluding the program or |
1450 | Returns the X-Resource for the given pattern, excluding the program or |
1206 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1451 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1207 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1452 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1208 | resource with that pattern exists. |
1453 | resource with that pattern exists. |
1209 | |
1454 | |
1210 | Extensions that define extra resource or command line arguments also need |
1455 | Extensions that define extra resources also need to call this method |
1211 | to call this method to access their values. |
1456 | to access their values. |
1212 | |
1457 | |
1213 | If the method is called on an extension object (basically, from an |
1458 | If the method is called on an extension object (basically, from an |
1214 | extension), then the special prefix C<%.> will be replaced by the name of |
1459 | extension), then the special prefix C<%.> will be replaced by the name of |
1215 | the extension and a dot, and the lone string C<%> will be replaced by the |
1460 | the extension and a dot, and the lone string C<%> will be replaced by the |
1216 | extension name itself. This makes it possible to code extensions so you |
1461 | extension name itself. This makes it possible to code extensions so you |
1217 | can rename them and get a new set of commandline switches and resources |
1462 | can rename them and get a new set of resources without having to change |
1218 | without having to change the actual code. |
1463 | the actual code. |
1219 | |
1464 | |
1220 | This method should only be called during the C<on_start> hook, as there is |
1465 | This method should only be called during the C<on_start> hook, as there is |
1221 | only one resource database per display, and later invocations might return |
1466 | only one resource database per display, and later invocations might return |
1222 | the wrong resources. |
1467 | the wrong resources. |
1223 | |
1468 | |
… | |
… | |
1235 | my $res = &x_resource; |
1480 | my $res = &x_resource; |
1236 | |
1481 | |
1237 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1482 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1238 | } |
1483 | } |
1239 | |
1484 | |
1240 | =item $success = $term->parse_keysym ($key, $octets) |
1485 | =item $action = $term->lookup_keysym ($keysym, $state) |
1241 | |
1486 | |
|
|
1487 | Returns the action bound to key combination C<($keysym, $state)>, |
|
|
1488 | if a binding for it exists, and C<undef> otherwise. |
|
|
1489 | |
|
|
1490 | =item $success = $term->bind_action ($key, $action) |
|
|
1491 | |
1242 | Adds a key binding exactly as specified via a resource. See the |
1492 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1243 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1493 | C<keysym> resource in the urxvt(1) manpage. |
1244 | |
1494 | |
1245 | =item $term->register_command ($keysym, $modifiermask, $string) |
1495 | To add default bindings for actions, an extension should call C<< |
|
|
1496 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1497 | in the C<init> hook allows users to override or remove the binding |
|
|
1498 | again. |
1246 | |
1499 | |
1247 | Adds a key binding. This is a lower level api compared to |
1500 | Example: the C<searchable-scrollback> by default binds itself |
1248 | C<parse_keysym>, as it expects a parsed key description, and can be |
1501 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
1249 | used only inside either the C<on_init> hook, to add a binding, or the |
1502 | $term->bind_action >>. |
1250 | C<on_register_command> hook, to modify a parsed binding. |
1503 | |
|
|
1504 | sub init { |
|
|
1505 | my ($self) = @_; |
|
|
1506 | |
|
|
1507 | $self->bind_action ("M-s" => "%:start"); |
|
|
1508 | } |
1251 | |
1509 | |
1252 | =item $rend = $term->rstyle ([$new_rstyle]) |
1510 | =item $rend = $term->rstyle ([$new_rstyle]) |
1253 | |
1511 | |
1254 | Return and optionally change the current rendition. Text that is output by |
1512 | Return and optionally change the current rendition. Text that is output by |
1255 | the terminal application will use this style. |
1513 | the terminal application will use this style. |
… | |
… | |
1332 | This method returns an urxvt::overlay object. The overlay will be visible |
1590 | This method returns an urxvt::overlay object. The overlay will be visible |
1333 | as long as the perl object is referenced. |
1591 | as long as the perl object is referenced. |
1334 | |
1592 | |
1335 | The methods currently supported on C<urxvt::overlay> objects are: |
1593 | The methods currently supported on C<urxvt::overlay> objects are: |
1336 | |
1594 | |
1337 | =over 4 |
1595 | =over |
1338 | |
1596 | |
1339 | =item $overlay->set ($x, $y, $text[, $rend]) |
1597 | =item $overlay->set ($x, $y, $text[, $rend]) |
1340 | |
1598 | |
1341 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1599 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1342 | text in rxvt-unicode's special encoding and an array of rendition values |
1600 | text in rxvt-unicode's special encoding and an array of rendition values |
… | |
… | |
1386 | Returns the number of screen-cells this string would need. Correctly |
1644 | Returns the number of screen-cells this string would need. Correctly |
1387 | accounts for wide and combining characters. |
1645 | accounts for wide and combining characters. |
1388 | |
1646 | |
1389 | =item $octets = $term->locale_encode ($string) |
1647 | =item $octets = $term->locale_encode ($string) |
1390 | |
1648 | |
1391 | Convert the given text string into the corresponding locale encoding. |
1649 | Convert the given text string into the corresponding locale |
|
|
1650 | encoding. Returns C<undef> if C<$string> is C<undef>. |
1392 | |
1651 | |
1393 | =item $string = $term->locale_decode ($octets) |
1652 | =item $string = $term->locale_decode ($octets) |
1394 | |
1653 | |
1395 | Convert the given locale-encoded octets into a perl string. |
1654 | Convert the given locale-encoded octets into a perl string. Returns |
|
|
1655 | C<undef> if C<$octets> is C<undef>. |
1396 | |
1656 | |
1397 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1657 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1398 | |
1658 | |
1399 | XORs the rendition values in the given span with the provided value |
1659 | XORs the rendition values in the given span with the provided value |
1400 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
1660 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
… | |
… | |
1413 | |
1673 | |
1414 | =item $term->scr_add_lines ($string) |
1674 | =item $term->scr_add_lines ($string) |
1415 | |
1675 | |
1416 | Write the given text string to the screen, as if output by the application |
1676 | Write the given text string to the screen, as if output by the application |
1417 | running inside the terminal. It may not contain command sequences (escape |
1677 | running inside the terminal. It may not contain command sequences (escape |
1418 | codes), but is free to use line feeds, carriage returns and tabs. The |
1678 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
1419 | string is a normal text string, not in locale-dependent encoding. |
1679 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1680 | locale-dependent encoding. |
1420 | |
1681 | |
1421 | Normally its not a good idea to use this function, as programs might be |
1682 | Normally its not a good idea to use this function, as programs might be |
1422 | confused by changes in cursor position or scrolling. Its useful inside a |
1683 | confused by changes in cursor position or scrolling. Its useful inside a |
1423 | C<on_add_lines> hook, though. |
1684 | C<on_add_lines> hook, though. |
1424 | |
1685 | |
… | |
… | |
1432 | locale-specific encoding of the terminal and can contain command sequences |
1693 | locale-specific encoding of the terminal and can contain command sequences |
1433 | (escape codes) that will be interpreted. |
1694 | (escape codes) that will be interpreted. |
1434 | |
1695 | |
1435 | =item $term->tt_write ($octets) |
1696 | =item $term->tt_write ($octets) |
1436 | |
1697 | |
1437 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1698 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1699 | to the program, see C<cmd_parse> for the opposite direction). To pass |
1438 | pass characters instead of octets, you should convert your strings first |
1700 | characters instead of octets, you should convert your strings first to the |
1439 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1701 | locale-specific encoding using C<< $term->locale_encode >>. |
|
|
1702 | |
|
|
1703 | =item $term->tt_write_user_input ($octets) |
|
|
1704 | |
|
|
1705 | Like C<tt_write>, but should be used when writing strings in response to |
|
|
1706 | the user pressing a key, to invoke the additional actions requested by |
|
|
1707 | the user for that case (C<tt_write> doesn't do that). |
|
|
1708 | |
|
|
1709 | The typical use case would be inside C<on_action> hooks. |
1440 | |
1710 | |
1441 | =item $term->tt_paste ($octets) |
1711 | =item $term->tt_paste ($octets) |
1442 | |
1712 | |
1443 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1713 | Write the octets given in C<$octets> to the tty as a paste, converting NL to |
1444 | CR and bracketing the data with control sequences if bracketed paste mode |
1714 | CR and bracketing the data with control sequences if bracketed paste mode |
… | |
… | |
1483 | |
1753 | |
1484 | =item $term->key_release ($state, $keycode[, $time]) |
1754 | =item $term->key_release ($state, $keycode[, $time]) |
1485 | |
1755 | |
1486 | Deliver various fake events to to terminal. |
1756 | Deliver various fake events to to terminal. |
1487 | |
1757 | |
1488 | =item $window_width = $term->width |
1758 | =item $window_width = $term->width ([$new_value]) |
1489 | |
1759 | |
1490 | =item $window_height = $term->height |
1760 | =item $window_height = $term->height ([$new_value]) |
1491 | |
1761 | |
1492 | =item $font_width = $term->fwidth |
1762 | =item $font_width = $term->fwidth ([$new_value]) |
1493 | |
1763 | |
1494 | =item $font_height = $term->fheight |
1764 | =item $font_height = $term->fheight ([$new_value]) |
1495 | |
1765 | |
1496 | =item $font_ascent = $term->fbase |
1766 | =item $font_ascent = $term->fbase ([$new_value]) |
1497 | |
1767 | |
1498 | =item $terminal_rows = $term->nrow |
1768 | =item $terminal_rows = $term->nrow ([$new_value]) |
1499 | |
1769 | |
1500 | =item $terminal_columns = $term->ncol |
1770 | =item $terminal_columns = $term->ncol ([$new_value]) |
1501 | |
1771 | |
1502 | =item $has_focus = $term->focus |
1772 | =item $has_focus = $term->focus ([$new_value]) |
1503 | |
1773 | |
1504 | =item $is_mapped = $term->mapped |
1774 | =item $is_mapped = $term->mapped ([$new_value]) |
1505 | |
1775 | |
1506 | =item $max_scrollback = $term->saveLines |
1776 | =item $max_scrollback = $term->saveLines ([$new_value]) |
1507 | |
1777 | |
1508 | =item $nrow_plus_saveLines = $term->total_rows |
1778 | =item $nrow_plus_saveLines = $term->total_rows ([$new_value]) |
1509 | |
1779 | |
1510 | =item $topmost_scrollback_row = $term->top_row |
1780 | =item $topmost_scrollback_row = $term->top_row ([$new_value]) |
1511 | |
1781 | |
1512 | Return various integers describing terminal characteristics. |
1782 | Return various integers describing terminal characteristics. If an |
|
|
1783 | argument is given, changes the value and returns the previous one. |
1513 | |
1784 | |
1514 | =item $x_display = $term->display_id |
1785 | =item $x_display = $term->display_id |
1515 | |
1786 | |
1516 | Return the DISPLAY used by rxvt-unicode. |
1787 | Return the DISPLAY used by rxvt-unicode. |
1517 | |
1788 | |
… | |
… | |
1554 | |
1825 | |
1555 | =item $cursor_is_hidden = $term->hidden_cursor |
1826 | =item $cursor_is_hidden = $term->hidden_cursor |
1556 | |
1827 | |
1557 | Returns whether the cursor is currently hidden or not. |
1828 | Returns whether the cursor is currently hidden or not. |
1558 | |
1829 | |
|
|
1830 | =item $priv_modes = $term->priv_modes |
|
|
1831 | |
|
|
1832 | Returns a bitset with the state of DEC private modes. |
|
|
1833 | |
|
|
1834 | Example: |
|
|
1835 | |
|
|
1836 | if ($term->priv_modes & urxvt::PrivMode_mouse_report) { |
|
|
1837 | # mouse reporting is turned on |
|
|
1838 | } |
|
|
1839 | |
1559 | =item $view_start = $term->view_start ([$newvalue]) |
1840 | =item $view_start = $term->view_start ([$newvalue]) |
1560 | |
1841 | |
1561 | Returns the row number of the topmost displayed line. Maximum value is |
1842 | Returns the row number of the topmost displayed line and changes it, |
1562 | C<0>, which displays the normal terminal contents. Lower values scroll |
1843 | if an argument is given. Values greater than or equal to C<0> display |
1563 | this many lines into the scrollback buffer. |
1844 | the terminal contents. Lower values scroll this many lines into the |
|
|
1845 | scrollback buffer. |
1564 | |
1846 | |
1565 | =item $term->want_refresh |
1847 | =item $term->want_refresh |
1566 | |
1848 | |
1567 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1849 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1568 | compare the on-screen display with its stored representation. If they |
1850 | compare the on-screen display with its stored representation. If they |
1569 | differ, it redraws the differences. |
1851 | differ, it redraws the differences. |
1570 | |
1852 | |
1571 | Used after changing terminal contents to display them. |
1853 | Used after changing terminal contents to display them. |
|
|
1854 | |
|
|
1855 | =item $term->refresh_check |
|
|
1856 | |
|
|
1857 | Checks if a refresh has been requested and, if so, schedules one. |
1572 | |
1858 | |
1573 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1859 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1574 | |
1860 | |
1575 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1861 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1576 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1862 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
… | |
… | |
1622 | |
1908 | |
1623 | Create and return a new C<urxvt::line> object that stores information |
1909 | Create and return a new C<urxvt::line> object that stores information |
1624 | about the logical line that row C<$row_number> is part of. It supports the |
1910 | about the logical line that row C<$row_number> is part of. It supports the |
1625 | following methods: |
1911 | following methods: |
1626 | |
1912 | |
1627 | =over 4 |
1913 | =over |
1628 | |
1914 | |
1629 | =item $text = $line->t ([$new_text]) |
1915 | =item $text = $line->t ([$new_text]) |
1630 | |
1916 | |
1631 | Returns or replaces the full text of the line, similar to C<ROW_t> |
1917 | Returns or replaces the full text of the line, similar to C<ROW_t> |
1632 | |
1918 | |
… | |
… | |
1678 | } |
1964 | } |
1679 | |
1965 | |
1680 | sub urxvt::line::t { |
1966 | sub urxvt::line::t { |
1681 | my ($self) = @_; |
1967 | my ($self) = @_; |
1682 | |
1968 | |
1683 | if (@_ > 1) |
1969 | if (@_ > 1) { |
1684 | { |
|
|
1685 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1970 | $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1686 | for $self->{beg} .. $self->{end}; |
1971 | for $self->{beg} .. $self->{end}; |
1687 | } |
1972 | } |
1688 | |
1973 | |
1689 | defined wantarray && |
1974 | defined wantarray && |
1690 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1975 | substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), |
1691 | 0, $self->{len} |
1976 | 0, $self->{len} |
1692 | } |
1977 | } |
1693 | |
1978 | |
1694 | sub urxvt::line::r { |
1979 | sub urxvt::line::r { |
1695 | my ($self) = @_; |
1980 | my ($self) = @_; |
1696 | |
1981 | |
1697 | if (@_ > 1) |
1982 | if (@_ > 1) { |
1698 | { |
|
|
1699 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1983 | $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) |
1700 | for $self->{beg} .. $self->{end}; |
1984 | for $self->{beg} .. $self->{end}; |
1701 | } |
1985 | } |
1702 | |
1986 | |
1703 | if (defined wantarray) { |
1987 | if (defined wantarray) { |
1704 | my $rend = [ |
1988 | my $rend = [ |
1705 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1989 | map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} |
1706 | ]; |
1990 | ]; |
… | |
… | |
1738 | where one character corresponds to one screen cell. See |
2022 | where one character corresponds to one screen cell. See |
1739 | C<< $term->ROW_t >> for details. |
2023 | C<< $term->ROW_t >> for details. |
1740 | |
2024 | |
1741 | =item $string = $term->special_decode $text |
2025 | =item $string = $term->special_decode $text |
1742 | |
2026 | |
1743 | Converts rxvt-unicodes text representation into a perl string. See |
2027 | Converts rxvt-unicode's text representation into a perl string. See |
1744 | C<< $term->ROW_t >> for details. |
2028 | C<< $term->ROW_t >> for details. |
1745 | |
2029 | |
1746 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
2030 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1747 | |
2031 | |
1748 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
2032 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1814 | |
2098 | |
1815 | package urxvt::popup; |
2099 | package urxvt::popup; |
1816 | |
2100 | |
1817 | =head2 The C<urxvt::popup> Class |
2101 | =head2 The C<urxvt::popup> Class |
1818 | |
2102 | |
1819 | =over 4 |
2103 | =over |
1820 | |
2104 | |
1821 | =cut |
2105 | =cut |
1822 | |
2106 | |
1823 | sub add_item { |
2107 | sub add_item { |
1824 | my ($self, $item) = @_; |
2108 | my ($self, $item) = @_; |
… | |
… | |
1960 | ->cb (sub { |
2244 | ->cb (sub { |
1961 | $term->{overlay}->set (0, 0, |
2245 | $term->{overlay}->set (0, 0, |
1962 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2246 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
1963 | }); |
2247 | }); |
1964 | |
2248 | |
1965 | =over 4 |
2249 | =over |
1966 | |
2250 | |
1967 | =item $timer = new urxvt::timer |
2251 | =item $timer = new urxvt::timer |
1968 | |
2252 | |
1969 | Create a new timer object in started state. It is scheduled to fire |
2253 | Create a new timer object in started state. It is scheduled to fire |
1970 | immediately. |
2254 | immediately. |
… | |
… | |
2019 | sysread $term->{socket}, my $buf, 8192 |
2303 | sysread $term->{socket}, my $buf, 8192 |
2020 | or end-of-file; |
2304 | or end-of-file; |
2021 | }); |
2305 | }); |
2022 | |
2306 | |
2023 | |
2307 | |
2024 | =over 4 |
2308 | =over |
2025 | |
2309 | |
2026 | =item $iow = new urxvt::iow |
2310 | =item $iow = new urxvt::iow |
2027 | |
2311 | |
2028 | Create a new io watcher object in stopped state. |
2312 | Create a new io watcher object in stopped state. |
2029 | |
2313 | |
… | |
… | |
2056 | |
2340 | |
2057 | This class implements idle watchers, that get called automatically when |
2341 | This class implements idle watchers, that get called automatically when |
2058 | the process is idle. They should return as fast as possible, after doing |
2342 | the process is idle. They should return as fast as possible, after doing |
2059 | some useful work. |
2343 | some useful work. |
2060 | |
2344 | |
2061 | =over 4 |
2345 | =over |
2062 | |
2346 | |
2063 | =item $iw = new urxvt::iw |
2347 | =item $iw = new urxvt::iw |
2064 | |
2348 | |
2065 | Create a new idle watcher object in stopped state. |
2349 | Create a new idle watcher object in stopped state. |
2066 | |
2350 | |
… | |
… | |
2091 | ->cb (sub { |
2375 | ->cb (sub { |
2092 | my ($pw, $exit_status) = @_; |
2376 | my ($pw, $exit_status) = @_; |
2093 | ... |
2377 | ... |
2094 | }); |
2378 | }); |
2095 | |
2379 | |
2096 | =over 4 |
2380 | =over |
2097 | |
2381 | |
2098 | =item $pw = new urxvt::pw |
2382 | =item $pw = new urxvt::pw |
2099 | |
2383 | |
2100 | Create a new process watcher in stopped state. |
2384 | Create a new process watcher in stopped state. |
2101 | |
2385 | |
… | |
… | |
2118 | =head2 URXVT_PERL_VERBOSITY |
2402 | =head2 URXVT_PERL_VERBOSITY |
2119 | |
2403 | |
2120 | This variable controls the verbosity level of the perl extension. Higher |
2404 | This variable controls the verbosity level of the perl extension. Higher |
2121 | numbers indicate more verbose output. |
2405 | numbers indicate more verbose output. |
2122 | |
2406 | |
2123 | =over 4 |
2407 | =over |
2124 | |
2408 | |
2125 | =item == 0 - fatal messages |
2409 | =item == 0 - fatal messages only |
|
|
2410 | |
|
|
2411 | =item >= 2 - general warnings (default level) |
2126 | |
2412 | |
2127 | =item >= 3 - script loading and management |
2413 | =item >= 3 - script loading and management |
2128 | |
2414 | |
2129 | =item >=10 - all called hooks |
2415 | =item >=10 - all called hooks |
2130 | |
2416 | |