… | |
… | |
4 | |
4 | |
5 | urxvtperl - 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 urxvt using it: |
16 | # start a urxvt instance using it: |
17 | |
17 | |
18 | urxvt --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 urxvtd, 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" |
… | |
… | |
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. |
… | |
… | |
106 | C<urxvt::term> class on this object. |
112 | C<urxvt::term> class on this object. |
107 | |
113 | |
108 | Additional methods only supported for extension objects are described in |
114 | Additional methods only supported for extension objects are described in |
109 | the C<urxvt::extension> section below. |
115 | the C<urxvt::extension> section below. |
110 | |
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 | |
|
|
128 | =over |
|
|
129 | |
|
|
130 | =item #:META:RESOURCE:name:type:desc |
|
|
131 | |
|
|
132 | The RESOURCE comment defines a resource used by the extension, where |
|
|
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. |
|
|
135 | |
|
|
136 | The extension will be autoloaded when this resource is specified or used |
|
|
137 | as a command line parameter. |
|
|
138 | |
|
|
139 | Example: matcher provides the C<matcher.launcher> resource by having this |
|
|
140 | comment: |
|
|
141 | |
|
|
142 | #:META:RESOURCE:%.launcher:string:default launcher command |
|
|
143 | |
|
|
144 | Example: load this extension when the C<-tr> command line option or |
|
|
145 | resource name is used. |
|
|
146 | |
|
|
147 | #:META:RESOURCE:tr:boolean:set root pixmap as background |
|
|
148 | |
|
|
149 | =item #:META:OSC:number:desc |
|
|
150 | |
|
|
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. |
|
|
154 | |
|
|
155 | This will cause the extension to be autoloaded when the OSC sequence is |
|
|
156 | used for the first time. |
|
|
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 |
|
|
183 | |
|
|
184 | =back |
|
|
185 | |
111 | =head2 Hooks |
186 | =head2 Hooks |
112 | |
187 | |
113 | The following subroutines can be declared in extension files, and will be |
188 | The following subroutines can be declared in extension files, and will be |
114 | called whenever the relevant event happens. |
189 | called whenever the relevant event happens. |
115 | |
190 | |
… | |
… | |
120 | 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 |
121 | relevant action might not be carried out by the C++ code. |
196 | relevant action might not be carried out by the C++ code. |
122 | |
197 | |
123 | I<< When in doubt, return a false value (preferably C<()>). >> |
198 | I<< When in doubt, return a false value (preferably C<()>). >> |
124 | |
199 | |
125 | =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. |
126 | |
213 | |
127 | =item on_init $term |
214 | =item on_init $term |
128 | |
215 | |
129 | Called after a new terminal object has been initialized, but before |
216 | Called after a new terminal object has been initialized, but before |
130 | 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 |
… | |
… | |
212 | |
299 | |
213 | C<on_osc_seq_perl> should be used for new behaviour. |
300 | C<on_osc_seq_perl> should be used for new behaviour. |
214 | |
301 | |
215 | =item on_osc_seq_perl $term, $args, $resp |
302 | =item on_osc_seq_perl $term, $args, $resp |
216 | |
303 | |
217 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
304 | Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence |
218 | operating system command) is processed. Cursor position and other state |
305 | (OSC = operating system command) is processed. Cursor position and other |
219 | information is up-to-date when this happens. For interoperability, the |
306 | state information is up-to-date when this happens. For interoperability, |
220 | 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 |
221 | to distinguish it from commands for other extensions, and this might be |
308 | other suitable prefix, and a semicolon, to distinguish it from commands |
222 | enforced in the future. |
309 | for other extensions. |
223 | |
310 | |
224 | For example, C<overlay-osc> uses this: |
311 | For example, C<overlay-osc> uses this: |
225 | |
312 | |
226 | sub on_osc_seq_perl { |
313 | sub on_osc_seq_perl { |
227 | my ($self, $osc, $resp) = @_; |
314 | my ($self, $osc, $resp) = @_; |
… | |
… | |
281 | |
368 | |
282 | =item on_refresh_end $term |
369 | =item on_refresh_end $term |
283 | |
370 | |
284 | 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>. |
285 | |
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 | |
286 | =item on_user_command $term, $string *DEPRECATED* |
381 | =item on_user_command $term, $string *DEPRECATED* |
287 | |
382 | |
288 | 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 |
289 | 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> |
290 | resource in the urxvt(1) manpage). |
385 | resource in the urxvt(1) manpage). |
… | |
… | |
364 | =cut |
459 | =cut |
365 | |
460 | |
366 | package urxvt; |
461 | package urxvt; |
367 | |
462 | |
368 | use utf8; |
463 | use utf8; |
369 | use strict 'vars'; |
464 | use strict qw(vars subs); |
370 | use Carp (); |
465 | use Carp (); |
371 | use Scalar::Util (); |
466 | use Scalar::Util (); |
372 | use List::Util (); |
467 | use List::Util (); |
373 | |
468 | |
374 | our $VERSION = 1; |
469 | our $VERSION = 1; |
… | |
… | |
386 | |
481 | |
387 | our $NOCHAR = chr 0xffff; |
482 | our $NOCHAR = chr 0xffff; |
388 | |
483 | |
389 | =head2 Variables in the C<urxvt> Package |
484 | =head2 Variables in the C<urxvt> Package |
390 | |
485 | |
391 | =over 4 |
486 | =over |
392 | |
487 | |
393 | =item $urxvt::LIBDIR |
488 | =item $urxvt::LIBDIR |
394 | |
489 | |
395 | The rxvt-unicode library directory, where, among other things, the perl |
490 | The rxvt-unicode library directory, where, among other things, the perl |
396 | modules and scripts are stored. |
491 | modules and scripts are stored. |
… | |
… | |
426 | |
521 | |
427 | =back |
522 | =back |
428 | |
523 | |
429 | =head2 Functions in the C<urxvt> Package |
524 | =head2 Functions in the C<urxvt> Package |
430 | |
525 | |
431 | =over 4 |
526 | =over |
432 | |
527 | |
433 | =item urxvt::fatal $errormessage |
528 | =item urxvt::fatal $errormessage |
434 | |
529 | |
435 | Fatally aborts execution with the given error message (which should |
530 | Fatally aborts execution with the given error message (which should |
436 | 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 |
… | |
… | |
481 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
576 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
482 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
577 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
483 | |
578 | |
484 | Various constants for use in X calls and event processing. |
579 | Various constants for use in X calls and event processing. |
485 | |
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 | |
486 | =back |
593 | =back |
487 | |
594 | |
488 | =head2 RENDITION |
595 | =head2 RENDITION |
489 | |
596 | |
490 | Rendition bitsets contain information about colour, font, font styles and |
597 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
493 | The following "macros" deal with changes in rendition sets. You should |
600 | The following "macros" deal with changes in rendition sets. You should |
494 | 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, |
495 | as they contain important information required for correct operation of |
602 | as they contain important information required for correct operation of |
496 | rxvt-unicode. |
603 | rxvt-unicode. |
497 | |
604 | |
498 | =over 4 |
605 | =over |
499 | |
606 | |
500 | =item $rend = urxvt::DEFAULT_RSTYLE |
607 | =item $rend = urxvt::DEFAULT_RSTYLE |
501 | |
608 | |
502 | 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 |
503 | being reset. Useful as a base to start when creating renditions. |
610 | being reset. Useful as a base to start when creating renditions. |
… | |
… | |
555 | no warnings 'utf8'; |
662 | no warnings 'utf8'; |
556 | |
663 | |
557 | sub parse_resource { |
664 | sub parse_resource { |
558 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
665 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
559 | |
666 | |
560 | $name =~ y/-/./ if $isarg; |
|
|
561 | |
|
|
562 | $term->scan_extensions; |
667 | $term->scan_extensions; |
563 | |
668 | |
|
|
669 | # iterating over all resources has quadratic time overhead |
|
|
670 | # overall, maybe this could be optimised? |
564 | my $r = $term->{meta}{resource}; |
671 | my $r = $term->{meta}{resource}; |
565 | keys %$r; # reset iterator |
672 | keys %$r; # reset iterator |
566 | while (my ($pattern, $v) = each %$r) { |
673 | while (my ($k, $v) = each %$r) { |
567 | if ( |
674 | my $pattern = $k; |
|
|
675 | $pattern =~ y/./-/ if $isarg; |
|
|
676 | my $prefix = $name; |
|
|
677 | my $suffix; |
568 | $pattern =~ /\.$/ |
678 | if ($pattern =~ /\-$/) { |
569 | ? $pattern eq substr $name, 0, length $pattern |
679 | $prefix = substr $name, 0, length $pattern; |
570 | : $pattern eq $name |
680 | $suffix = substr $name, length $pattern; |
571 | ) { |
681 | } |
|
|
682 | if ($pattern eq $prefix) { |
572 | $name = "$urxvt::RESCLASS.$name"; |
683 | $name = "$urxvt::RESCLASS.$k$suffix"; |
573 | |
684 | |
574 | push @{ $term->{perl_ext_3} }, $v->[0]; |
685 | push @{ $term->{perl_ext_3} }, $v->[0]; |
|
|
686 | |
|
|
687 | return 1 unless $isarg; |
575 | |
688 | |
576 | if ($v->[1] eq "boolean") { |
689 | if ($v->[1] eq "boolean") { |
577 | $term->put_option_db ($name, $flag ? "true" : "false"); |
690 | $term->put_option_db ($name, $flag ? "true" : "false"); |
578 | return 1; |
691 | return 1; |
579 | } else { |
692 | } else { |
… | |
… | |
612 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
725 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
613 | } |
726 | } |
614 | } |
727 | } |
615 | } |
728 | } |
616 | |
729 | |
617 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
730 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2; |
618 | |
731 | |
619 | sub verbose { |
732 | sub verbose { |
620 | my ($level, $msg) = @_; |
733 | my ($level, $msg) = @_; |
621 | warn "$msg\n" if $level <= $verbosity; |
734 | warn "$msg\n" if $level <= $verbosity; |
622 | } |
735 | } |
… | |
… | |
639 | |
752 | |
640 | open my $fh, "<:raw", $path |
753 | open my $fh, "<:raw", $path |
641 | or die "$path: $!"; |
754 | or die "$path: $!"; |
642 | |
755 | |
643 | my $source = |
756 | my $source = |
644 | "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" |
645 | . "#line 1 \"$path\"\n{\n" |
758 | . "#line 1 \"$path\"\n{\n" |
646 | . (do { local $/; <$fh> }) |
759 | . (do { local $/; <$fh> }) |
647 | . "\n};\n1"; |
760 | . "\n};\n1"; |
648 | |
761 | |
649 | eval $source |
762 | eval $source |
… | |
… | |
659 | sub invoke { |
772 | sub invoke { |
660 | local $TERM = shift; |
773 | local $TERM = shift; |
661 | my $htype = shift; |
774 | my $htype = shift; |
662 | |
775 | |
663 | if ($htype == HOOK_INIT) { |
776 | if ($htype == HOOK_INIT) { |
664 | my @dirs = $TERM->perl_libdirs; |
|
|
665 | |
|
|
666 | $TERM->scan_extensions; |
777 | $TERM->scan_extensions; |
667 | |
778 | |
668 | my %ext_arg; |
779 | my %ext_arg; |
669 | |
780 | |
670 | { |
781 | { |
… | |
… | |
675 | @TERM_EXT = (); |
786 | @TERM_EXT = (); |
676 | $TERM->register_package ($_) for @pkg; |
787 | $TERM->register_package ($_) for @pkg; |
677 | } |
788 | } |
678 | |
789 | |
679 | for ( |
790 | for ( |
|
|
791 | @{ delete $TERM->{perl_ext_3} }, |
680 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
792 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
681 | ) { |
793 | ) { |
682 | if ($_ eq "default") { |
794 | if ($_ eq "default") { |
683 | |
795 | |
684 | $ext_arg{$_} = [] |
796 | $ext_arg{$_} = [] |
685 | for |
|
|
686 | qw(selection option-popup selection-popup readline), |
797 | for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste); |
687 | map $_->[0], values %{ $TERM->{meta}{binding} }, |
|
|
688 | @{ delete $TERM->{perl_ext_3} }; |
|
|
689 | |
798 | |
690 | for ($TERM->_keysym_resources) { |
799 | for ($TERM->_keysym_resources) { |
691 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
800 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
692 | next unless /^([A-Za-z0-9_\-]+):/; |
801 | next unless /^([A-Za-z0-9_\-]+):/; |
693 | |
802 | |
694 | my $ext = $1; |
803 | my $ext = $1; |
695 | $ext =~ y/-/_/; |
|
|
696 | |
804 | |
697 | $ext_arg{$ext} = []; |
805 | $ext_arg{$ext} = []; |
698 | } |
806 | } |
699 | |
807 | |
700 | } elsif (/^-(.*)$/) { |
808 | } elsif (/^-(.*)$/) { # remove from set |
701 | delete $ext_arg{$1}; |
809 | delete $ext_arg{$1}; |
702 | |
810 | |
703 | } elsif (/^([^<]+)<(.*)>$/) { |
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}; |
704 | push @{ $ext_arg{$1} }, $2; |
816 | push @{ $ext_arg{$1} }, defined $2 ? $2 : (); |
705 | |
817 | |
706 | } else { |
818 | } else { |
707 | $ext_arg{$_} ||= []; |
819 | verbose 2, "cannot parse extension specification '$_', ignoring."; |
708 | } |
820 | } |
709 | } |
821 | } |
710 | |
822 | |
711 | # now register default key bindings |
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 | |
712 | for my $ext (sort keys %ext_arg) { |
826 | for my $ext (sort keys %ext_arg) { |
713 | while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { |
827 | my $path = $TERM->extension_path ($ext); |
714 | $TERM->bind_action ($k, "$v->[0]:$v->[1]"); |
828 | |
|
|
829 | if (defined $path) { |
|
|
830 | $TERM->autoload_extension ($ext, $ext_arg{$ext}); |
|
|
831 | } else { |
|
|
832 | verbose 2, "perl extension '$ext' not found in perl library search path"; |
715 | } |
833 | } |
716 | } |
834 | } |
717 | |
835 | |
718 | for my $ext (sort keys %ext_arg) { |
|
|
719 | my @files = grep -f $_, map "$_/$ext", @dirs; |
|
|
720 | |
|
|
721 | if (@files) { |
|
|
722 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
|
|
723 | } else { |
|
|
724 | warn "perl extension '$ext' not found in perl library search path\n"; |
|
|
725 | } |
|
|
726 | } |
|
|
727 | |
|
|
728 | 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"); |
729 | warn $@ if $@; |
837 | warn $@ if $@; |
|
|
838 | } |
|
|
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 | } |
730 | } |
848 | } |
731 | |
849 | |
732 | $retval = undef; |
850 | $retval = undef; |
733 | |
851 | |
734 | if (my $cb = $TERM->{_hook}[$htype]) { |
852 | if (my $cb = $TERM->{_hook}[$htype]) { |
… | |
… | |
814 | |
932 | |
815 | The methods (And data members) documented below can be called on extension |
933 | The methods (And data members) documented below can be called on extension |
816 | objects, in addition to call methods documented for the <urxvt::term> |
934 | objects, in addition to call methods documented for the <urxvt::term> |
817 | class. |
935 | class. |
818 | |
936 | |
819 | =over 4 |
937 | =over |
820 | |
938 | |
821 | =item $urxvt_term = $self->{term} |
939 | =item $urxvt_term = $self->{term} |
822 | |
940 | |
823 | Returns the C<urxvt::term> object associated with this instance of the |
941 | Returns the C<urxvt::term> object associated with this instance of the |
824 | extension. This member I<must not> be changed in any way. |
942 | extension. This member I<must not> be changed in any way. |
… | |
… | |
942 | } |
1060 | } |
943 | |
1061 | |
944 | bless \%disable, "urxvt::extension::on_disable" |
1062 | bless \%disable, "urxvt::extension::on_disable" |
945 | } |
1063 | } |
946 | |
1064 | |
|
|
1065 | =item $self->bind_action ($hotkey, $action) |
|
|
1066 | |
947 | =item $self->x_resource ($pattern) |
1067 | =item $self->x_resource ($pattern) |
948 | |
1068 | |
949 | =item $self->x_resource_boolean ($pattern) |
1069 | =item $self->x_resource_boolean ($pattern) |
950 | |
1070 | |
951 | These methods support an additional C<%> prefix when called on an |
1071 | These methods support an additional C<%> prefix for C<$action> or |
952 | extension object - see the description of these methods in the |
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 |
953 | C<urxvt::term> class for details. |
1074 | methods in the C<urxvt::term> class for details. |
954 | |
1075 | |
955 | =cut |
1076 | =cut |
|
|
1077 | |
|
|
1078 | sub bind_action { |
|
|
1079 | my ($self, $hotkey, $action) = @_; |
|
|
1080 | $action =~ s/^%:/$_[0]{_name}:/; |
|
|
1081 | $self->{term}->bind_action ($hotkey, $action) |
|
|
1082 | } |
956 | |
1083 | |
957 | sub x_resource { |
1084 | sub x_resource { |
958 | my ($self, $name) = @_; |
1085 | my ($self, $name) = @_; |
959 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
1086 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
960 | $self->{term}->x_resource ($name) |
1087 | $self->{term}->x_resource ($name) |
… | |
… | |
1056 | |
1183 | |
1057 | package urxvt::term; |
1184 | package urxvt::term; |
1058 | |
1185 | |
1059 | =head2 The C<urxvt::term> Class |
1186 | =head2 The C<urxvt::term> Class |
1060 | |
1187 | |
1061 | =over 4 |
1188 | =over |
1062 | |
1189 | |
1063 | =cut |
1190 | =cut |
1064 | |
1191 | |
1065 | # find on_xxx subs in the package and register them |
1192 | # find on_xxx subs in the package and register them |
1066 | # as hooks |
1193 | # as hooks |
1067 | sub register_package { |
1194 | sub register_package { |
1068 | my ($self, $pkg, $argv) = @_; |
1195 | my ($self, $pkg, $argv) = @_; |
|
|
1196 | |
|
|
1197 | return if $self->{_pkg}{$pkg}; |
1069 | |
1198 | |
1070 | no strict 'refs'; |
1199 | no strict 'refs'; |
1071 | |
1200 | |
1072 | urxvt::verbose 6, "register package $pkg to $self"; |
1201 | urxvt::verbose 6, "register package $pkg to $self"; |
1073 | |
1202 | |
… | |
… | |
1085 | for my $name (@HOOKNAME) { |
1214 | for my $name (@HOOKNAME) { |
1086 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
1215 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
1087 | $proxy->enable ($name => $ref); |
1216 | $proxy->enable ($name => $ref); |
1088 | } |
1217 | } |
1089 | } |
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); |
1090 | } |
1248 | } |
1091 | |
1249 | |
1092 | sub perl_libdirs { |
1250 | sub perl_libdirs { |
1093 | map { split /:/ } |
1251 | map { split /:/ } |
1094 | $_[0]->resource ("perl_lib"), |
1252 | $_[0]->resource ("perl_lib"), |
… | |
… | |
1101 | sub scan_extensions { |
1259 | sub scan_extensions { |
1102 | my ($self) = @_; |
1260 | my ($self) = @_; |
1103 | |
1261 | |
1104 | return if exists $self->{meta}; |
1262 | return if exists $self->{meta}; |
1105 | |
1263 | |
1106 | my @libdirs = perl_libdirs $self; |
1264 | my @urxvtdirs = perl_libdirs $self; |
|
|
1265 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
1107 | |
1266 | |
1108 | # return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d# |
|
|
1109 | |
|
|
1110 | # $self->{meta_libdirs} = join "\x00", @libdirs;#d# |
|
|
1111 | $self->{meta} = \my %meta; |
1267 | $self->{meta} = \my %allmeta; |
1112 | |
1268 | |
1113 | # first gather extensions |
1269 | # first gather extensions |
1114 | for my $dir (reverse @libdirs) { |
1270 | |
|
|
1271 | my $gather = sub { |
|
|
1272 | my ($dir, $core) = @_; |
|
|
1273 | |
1115 | opendir my $fh, $dir |
1274 | opendir my $fh, $dir |
1116 | or next; |
1275 | or return; |
|
|
1276 | |
1117 | for my $ext (readdir $fh) { |
1277 | for my $ext (readdir $fh) { |
1118 | $ext !~ /^\./ |
1278 | $ext !~ /^\./ |
1119 | and open my $fh, "<", "$dir/$ext" |
|
|
1120 | or next; |
1279 | or next; |
1121 | |
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 | |
1122 | my %ext = (dir => $dir); |
1290 | my %meta = (dir => $dir); |
1123 | |
1291 | |
1124 | while (<$fh>) { |
1292 | while (<$fh>) { |
1125 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1293 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1126 | my ($pattern, $type, $desc) = split /:/, $1; |
1294 | my ($pattern, $type, $desc) = split /:/, $1; |
1127 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1295 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1128 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1296 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1129 | 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"; |
1130 | } else { |
1298 | } else { |
1131 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1299 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1132 | } |
1300 | } |
|
|
1301 | |
1133 | } elsif (/^#:META:BINDING:(.*)/) { |
1302 | } elsif (/^#:META:OSC:([0-9]+):(.*)/) { |
1134 | my ($keysym, $action) = split /:/, $1; |
1303 | push @{$allmeta{autoload_osc}{$1}}, [$ext, $2]; |
1135 | $ext{binding}{$keysym} = [$ext, $action]; |
1304 | |
|
|
1305 | } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) { |
|
|
1306 | push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2]; |
|
|
1307 | |
1136 | } elsif (/^\s*(?:#|$)/) { |
1308 | } elsif (/^\s*(?:#|$)/) { |
1137 | # skip other comments and empty lines |
1309 | # skip other comments and empty lines |
|
|
1310 | |
1138 | } else { |
1311 | } else { |
1139 | last; # stop parsing on first non-empty non-comment line |
1312 | last; # stop parsing on first non-empty non-comment line |
1140 | } |
1313 | } |
1141 | } |
1314 | } |
1142 | |
1315 | |
1143 | $meta{ext}{$ext} = \%ext; |
1316 | $allmeta{ext}{$ext} = \%meta; |
1144 | } |
1317 | } |
1145 | } |
1318 | }; |
1146 | |
1319 | |
|
|
1320 | # $gather->($_, 0) for @cpandirs; |
|
|
1321 | $gather->($_, 1) for @urxvtdirs; |
|
|
1322 | |
1147 | # and now merge resources and bindings |
1323 | # and now merge resources |
|
|
1324 | |
|
|
1325 | $allmeta{resource} = \my %resource; |
|
|
1326 | |
1148 | while (my ($k, $v) = each %{ $meta{ext} }) { |
1327 | while (my ($k, $v) = each %{ $allmeta{ext} }) { |
1149 | #TODO: should check for extensions overriding each other |
1328 | #TODO: should check for extensions overriding each other |
1150 | %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); |
1329 | %resource = (%resource, %{ $v->{resource} }); |
1151 | %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} }); |
|
|
1152 | } |
1330 | } |
1153 | } |
1331 | } |
1154 | |
1332 | |
1155 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1333 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1156 | |
1334 | |
… | |
… | |
1186 | 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 |
1187 | ("starts") programs in the background. This function takes care of setting |
1365 | ("starts") programs in the background. This function takes care of setting |
1188 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
1366 | the user environment before exec'ing the command (e.g. C<PATH>) and should |
1189 | be preferred over explicit calls to C<exec> or C<system>. |
1367 | be preferred over explicit calls to C<exec> or C<system>. |
1190 | |
1368 | |
|
|
1369 | It also sets the C<URXVT_EXT_WINDOWID> environment variable to the window |
|
|
1370 | ID of the terminal (C<< $self->parent >>), similar to the C<WINDOWID> |
|
|
1371 | variable set for the process spawned inside the terminal. |
|
|
1372 | |
1191 | Returns the pid of the subprocess or C<undef> on error. |
1373 | Returns the pid of the subprocess or C<undef> on error. |
1192 | |
1374 | |
1193 | =cut |
1375 | =cut |
1194 | |
1376 | |
1195 | sub exec_async { |
1377 | sub exec_async { |
… | |
… | |
1198 | my $pid = fork; |
1380 | my $pid = fork; |
1199 | |
1381 | |
1200 | return $pid |
1382 | return $pid |
1201 | if !defined $pid or $pid; |
1383 | if !defined $pid or $pid; |
1202 | |
1384 | |
|
|
1385 | %ENV = ( |
1203 | %ENV = %{ $self->env }; |
1386 | %{ $self->env }, |
|
|
1387 | URXVT_EXT_WINDOWID => $self->parent, |
|
|
1388 | ); |
1204 | |
1389 | |
1205 | exec @_; |
1390 | exec @_; |
1206 | urxvt::_exit 255; |
1391 | urxvt::_exit 255; |
1207 | } |
1392 | } |
1208 | |
1393 | |
… | |
… | |
1219 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1404 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1220 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1405 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1221 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1406 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1222 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1407 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1223 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
1408 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
1224 | urgentOnBell utmpInhibit visualBell |
1409 | urgentOnBell utmpInhibit visualBell disablePasteBrackets |
1225 | |
1410 | |
1226 | =item $value = $term->resource ($name[, $newval]) |
1411 | =item $value = $term->resource ($name[, $newval]) |
1227 | |
1412 | |
1228 | Returns the current resource value associated with a given name and |
1413 | Returns the current resource value associated with a given name and |
1229 | optionally sets a new value. Setting values is most useful in the C<init> |
1414 | optionally sets a new value. Setting values is most useful in the C<init> |
… | |
… | |
1255 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1440 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1256 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1441 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1257 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1442 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1258 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1443 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1259 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1444 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1260 | utmpInhibit visualBell |
1445 | utmpInhibit visualBell rewrapMode disablePasteBrackets |
1261 | |
1446 | |
1262 | =cut |
1447 | =cut |
1263 | |
1448 | |
1264 | sub resource($$;$) { |
1449 | sub resource($$;$) { |
1265 | my ($self, $name) = (shift, shift); |
1450 | my ($self, $name) = (shift, shift); |
… | |
… | |
1272 | Returns the X-Resource for the given pattern, excluding the program or |
1457 | Returns the X-Resource for the given pattern, excluding the program or |
1273 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1458 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1274 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1459 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1275 | resource with that pattern exists. |
1460 | resource with that pattern exists. |
1276 | |
1461 | |
1277 | Extensions that define extra resource or command line arguments also need |
1462 | Extensions that define extra resources also need to call this method |
1278 | to call this method to access their values. |
1463 | to access their values. |
1279 | |
1464 | |
1280 | If the method is called on an extension object (basically, from an |
1465 | If the method is called on an extension object (basically, from an |
1281 | extension), then the special prefix C<%.> will be replaced by the name of |
1466 | extension), then the special prefix C<%.> will be replaced by the name of |
1282 | the extension and a dot, and the lone string C<%> will be replaced by the |
1467 | the extension and a dot, and the lone string C<%> will be replaced by the |
1283 | extension name itself. This makes it possible to code extensions so you |
1468 | extension name itself. This makes it possible to code extensions so you |
1284 | can rename them and get a new set of commandline switches and resources |
1469 | can rename them and get a new set of resources without having to change |
1285 | without having to change the actual code. |
1470 | the actual code. |
1286 | |
1471 | |
1287 | This method should only be called during the C<on_start> hook, as there is |
1472 | This method should only be called during the C<on_start> hook, as there is |
1288 | only one resource database per display, and later invocations might return |
1473 | only one resource database per display, and later invocations might return |
1289 | the wrong resources. |
1474 | the wrong resources. |
1290 | |
1475 | |
… | |
… | |
1302 | my $res = &x_resource; |
1487 | my $res = &x_resource; |
1303 | |
1488 | |
1304 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1489 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
1305 | } |
1490 | } |
1306 | |
1491 | |
|
|
1492 | =item $action = $term->lookup_keysym ($keysym, $state) |
|
|
1493 | |
|
|
1494 | Returns the action bound to key combination C<($keysym, $state)>, |
|
|
1495 | if a binding for it exists, and C<undef> otherwise. |
|
|
1496 | |
1307 | =item $success = $term->bind_action ($key, $octets) |
1497 | =item $success = $term->bind_action ($key, $action) |
1308 | |
1498 | |
1309 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1499 | Adds a key binding exactly as specified via a C<keysym> resource. See the |
1310 | C<keysym> resource in the urxvt(1) manpage. |
1500 | C<keysym> resource in the urxvt(1) manpage. |
|
|
1501 | |
|
|
1502 | To add default bindings for actions, an extension should call C<< |
|
|
1503 | ->bind_action >> in its C<init> hook for every such binding. Doing it |
|
|
1504 | in the C<init> hook allows users to override or remove the binding |
|
|
1505 | again. |
|
|
1506 | |
|
|
1507 | Example: the C<searchable-scrollback> by default binds itself |
|
|
1508 | on C<Meta-s>, using C<< $self->bind_action >>, which calls C<< |
|
|
1509 | $term->bind_action >>. |
|
|
1510 | |
|
|
1511 | sub init { |
|
|
1512 | my ($self) = @_; |
|
|
1513 | |
|
|
1514 | $self->bind_action ("M-s" => "%:start"); |
|
|
1515 | } |
1311 | |
1516 | |
1312 | =item $rend = $term->rstyle ([$new_rstyle]) |
1517 | =item $rend = $term->rstyle ([$new_rstyle]) |
1313 | |
1518 | |
1314 | Return and optionally change the current rendition. Text that is output by |
1519 | Return and optionally change the current rendition. Text that is output by |
1315 | the terminal application will use this style. |
1520 | the terminal application will use this style. |
… | |
… | |
1392 | This method returns an urxvt::overlay object. The overlay will be visible |
1597 | This method returns an urxvt::overlay object. The overlay will be visible |
1393 | as long as the perl object is referenced. |
1598 | as long as the perl object is referenced. |
1394 | |
1599 | |
1395 | The methods currently supported on C<urxvt::overlay> objects are: |
1600 | The methods currently supported on C<urxvt::overlay> objects are: |
1396 | |
1601 | |
1397 | =over 4 |
1602 | =over |
1398 | |
1603 | |
1399 | =item $overlay->set ($x, $y, $text[, $rend]) |
1604 | =item $overlay->set ($x, $y, $text[, $rend]) |
1400 | |
1605 | |
1401 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1606 | Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts |
1402 | text in rxvt-unicode's special encoding and an array of rendition values |
1607 | text in rxvt-unicode's special encoding and an array of rendition values |
… | |
… | |
1446 | Returns the number of screen-cells this string would need. Correctly |
1651 | Returns the number of screen-cells this string would need. Correctly |
1447 | accounts for wide and combining characters. |
1652 | accounts for wide and combining characters. |
1448 | |
1653 | |
1449 | =item $octets = $term->locale_encode ($string) |
1654 | =item $octets = $term->locale_encode ($string) |
1450 | |
1655 | |
1451 | Convert the given text string into the corresponding locale encoding. |
1656 | Convert the given text string into the corresponding locale |
|
|
1657 | encoding. Returns C<undef> if C<$string> is C<undef>. |
1452 | |
1658 | |
1453 | =item $string = $term->locale_decode ($octets) |
1659 | =item $string = $term->locale_decode ($octets) |
1454 | |
1660 | |
1455 | Convert the given locale-encoded octets into a perl string. |
1661 | Convert the given locale-encoded octets into a perl string. Returns |
|
|
1662 | C<undef> if C<$octets> is C<undef>. |
1456 | |
1663 | |
1457 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1664 | =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) |
1458 | |
1665 | |
1459 | XORs the rendition values in the given span with the provided value |
1666 | XORs the rendition values in the given span with the provided value |
1460 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
1667 | (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in |
… | |
… | |
1473 | |
1680 | |
1474 | =item $term->scr_add_lines ($string) |
1681 | =item $term->scr_add_lines ($string) |
1475 | |
1682 | |
1476 | Write the given text string to the screen, as if output by the application |
1683 | Write the given text string to the screen, as if output by the application |
1477 | running inside the terminal. It may not contain command sequences (escape |
1684 | running inside the terminal. It may not contain command sequences (escape |
1478 | codes), but is free to use line feeds, carriage returns and tabs. The |
1685 | codes - see C<cmd_parse> for that), but is free to use line feeds, |
1479 | string is a normal text string, not in locale-dependent encoding. |
1686 | carriage returns and tabs. The string is a normal text string, not in |
|
|
1687 | locale-dependent encoding. |
1480 | |
1688 | |
1481 | Normally its not a good idea to use this function, as programs might be |
1689 | Normally its not a good idea to use this function, as programs might be |
1482 | confused by changes in cursor position or scrolling. Its useful inside a |
1690 | confused by changes in cursor position or scrolling. Its useful inside a |
1483 | C<on_add_lines> hook, though. |
1691 | C<on_add_lines> hook, though. |
1484 | |
1692 | |
… | |
… | |
1492 | locale-specific encoding of the terminal and can contain command sequences |
1700 | locale-specific encoding of the terminal and can contain command sequences |
1493 | (escape codes) that will be interpreted. |
1701 | (escape codes) that will be interpreted. |
1494 | |
1702 | |
1495 | =item $term->tt_write ($octets) |
1703 | =item $term->tt_write ($octets) |
1496 | |
1704 | |
1497 | Write the octets given in C<$octets> to the tty (i.e. as program input). To |
1705 | Write the octets given in C<$octets> to the tty (i.e. as user input |
|
|
1706 | to the program, see C<cmd_parse> for the opposite direction). To pass |
1498 | pass characters instead of octets, you should convert your strings first |
1707 | characters instead of octets, you should convert your strings first to the |
1499 | to the locale-specific encoding using C<< $term->locale_encode >>. |
1708 | locale-specific encoding using C<< $term->locale_encode >>. |
1500 | |
1709 | |
1501 | =item $term->tt_write_user_input ($octets) |
1710 | =item $term->tt_write_user_input ($octets) |
1502 | |
1711 | |
1503 | Like C<tt_write>, but should be used when writing strings in response to |
1712 | Like C<tt_write>, but should be used when writing strings in response to |
1504 | the user pressing a key, to invokes the additional actions requested by |
1713 | the user pressing a key, to invoke the additional actions requested by |
1505 | the user for that case (C<tt_write> doesn't do that). |
1714 | the user for that case (C<tt_write> doesn't do that). |
1506 | |
1715 | |
1507 | The typical use case would be inside C<on_action> hooks. |
1716 | The typical use case would be inside C<on_action> hooks. |
1508 | |
1717 | |
1509 | =item $term->tt_paste ($octets) |
1718 | =item $term->tt_paste ($octets) |
… | |
… | |
1551 | |
1760 | |
1552 | =item $term->key_release ($state, $keycode[, $time]) |
1761 | =item $term->key_release ($state, $keycode[, $time]) |
1553 | |
1762 | |
1554 | Deliver various fake events to to terminal. |
1763 | Deliver various fake events to to terminal. |
1555 | |
1764 | |
1556 | =item $window_width = $term->width |
1765 | =item $window_width = $term->width ([$new_value]) |
1557 | |
1766 | |
1558 | =item $window_height = $term->height |
1767 | =item $window_height = $term->height ([$new_value]) |
1559 | |
1768 | |
1560 | =item $font_width = $term->fwidth |
1769 | =item $font_width = $term->fwidth ([$new_value]) |
1561 | |
1770 | |
1562 | =item $font_height = $term->fheight |
1771 | =item $font_height = $term->fheight ([$new_value]) |
1563 | |
1772 | |
1564 | =item $font_ascent = $term->fbase |
1773 | =item $font_ascent = $term->fbase ([$new_value]) |
1565 | |
1774 | |
1566 | =item $terminal_rows = $term->nrow |
1775 | =item $terminal_rows = $term->nrow ([$new_value]) |
1567 | |
1776 | |
1568 | =item $terminal_columns = $term->ncol |
1777 | =item $terminal_columns = $term->ncol ([$new_value]) |
1569 | |
1778 | |
1570 | =item $has_focus = $term->focus |
1779 | =item $has_focus = $term->focus ([$new_value]) |
1571 | |
1780 | |
1572 | =item $is_mapped = $term->mapped |
1781 | =item $is_mapped = $term->mapped ([$new_value]) |
1573 | |
1782 | |
1574 | =item $max_scrollback = $term->saveLines |
1783 | =item $max_scrollback = $term->saveLines ([$new_value]) |
1575 | |
1784 | |
1576 | =item $nrow_plus_saveLines = $term->total_rows |
1785 | =item $nrow_plus_saveLines = $term->total_rows ([$new_value]) |
1577 | |
1786 | |
1578 | =item $topmost_scrollback_row = $term->top_row |
1787 | =item $topmost_scrollback_row = $term->top_row ([$new_value]) |
1579 | |
1788 | |
1580 | Return various integers describing terminal characteristics. |
1789 | Return various integers describing terminal characteristics. If an |
|
|
1790 | argument is given, changes the value and returns the previous one. |
1581 | |
1791 | |
1582 | =item $x_display = $term->display_id |
1792 | =item $x_display = $term->display_id |
1583 | |
1793 | |
1584 | Return the DISPLAY used by rxvt-unicode. |
1794 | Return the DISPLAY used by rxvt-unicode. |
1585 | |
1795 | |
… | |
… | |
1622 | |
1832 | |
1623 | =item $cursor_is_hidden = $term->hidden_cursor |
1833 | =item $cursor_is_hidden = $term->hidden_cursor |
1624 | |
1834 | |
1625 | Returns whether the cursor is currently hidden or not. |
1835 | Returns whether the cursor is currently hidden or not. |
1626 | |
1836 | |
|
|
1837 | =item $priv_modes = $term->priv_modes |
|
|
1838 | |
|
|
1839 | Returns a bitset with the state of DEC private modes. |
|
|
1840 | |
|
|
1841 | Example: |
|
|
1842 | |
|
|
1843 | if ($term->priv_modes & urxvt::PrivMode_mouse_report) { |
|
|
1844 | # mouse reporting is turned on |
|
|
1845 | } |
|
|
1846 | |
1627 | =item $view_start = $term->view_start ([$newvalue]) |
1847 | =item $view_start = $term->view_start ([$newvalue]) |
1628 | |
1848 | |
1629 | Returns the row number of the topmost displayed line. Maximum value is |
1849 | Returns the row number of the topmost displayed line and changes it, |
1630 | C<0>, which displays the normal terminal contents. Lower values scroll |
1850 | if an argument is given. Values greater than or equal to C<0> display |
1631 | this many lines into the scrollback buffer. |
1851 | the terminal contents. Lower values scroll this many lines into the |
|
|
1852 | scrollback buffer. |
1632 | |
1853 | |
1633 | =item $term->want_refresh |
1854 | =item $term->want_refresh |
1634 | |
1855 | |
1635 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1856 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1636 | compare the on-screen display with its stored representation. If they |
1857 | compare the on-screen display with its stored representation. If they |
1637 | differ, it redraws the differences. |
1858 | differ, it redraws the differences. |
1638 | |
1859 | |
1639 | Used after changing terminal contents to display them. |
1860 | Used after changing terminal contents to display them. |
|
|
1861 | |
|
|
1862 | =item $term->refresh_check |
|
|
1863 | |
|
|
1864 | Checks if a refresh has been requested and, if so, schedules one. |
1640 | |
1865 | |
1641 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1866 | =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) |
1642 | |
1867 | |
1643 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1868 | Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> |
1644 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
1869 | is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost |
… | |
… | |
1690 | |
1915 | |
1691 | Create and return a new C<urxvt::line> object that stores information |
1916 | Create and return a new C<urxvt::line> object that stores information |
1692 | about the logical line that row C<$row_number> is part of. It supports the |
1917 | about the logical line that row C<$row_number> is part of. It supports the |
1693 | following methods: |
1918 | following methods: |
1694 | |
1919 | |
1695 | =over 4 |
1920 | =over |
1696 | |
1921 | |
1697 | =item $text = $line->t ([$new_text]) |
1922 | =item $text = $line->t ([$new_text]) |
1698 | |
1923 | |
1699 | Returns or replaces the full text of the line, similar to C<ROW_t> |
1924 | Returns or replaces the full text of the line, similar to C<ROW_t> |
1700 | |
1925 | |
… | |
… | |
1796 | $offset / $self->{ncol} + $self->{beg}, |
2021 | $offset / $self->{ncol} + $self->{beg}, |
1797 | $offset % $self->{ncol} |
2022 | $offset % $self->{ncol} |
1798 | ) |
2023 | ) |
1799 | } |
2024 | } |
1800 | |
2025 | |
1801 | =item $text = $term->special_encode $string |
2026 | =item $text = $term->special_encode ($string) |
1802 | |
2027 | |
1803 | Converts a perl string into the special encoding used by rxvt-unicode, |
2028 | Converts a perl string into the special encoding used by rxvt-unicode, |
1804 | where one character corresponds to one screen cell. See |
2029 | where one character corresponds to one screen cell. See |
1805 | C<< $term->ROW_t >> for details. |
2030 | C<< $term->ROW_t >> for details. |
1806 | |
2031 | |
1807 | =item $string = $term->special_decode $text |
2032 | =item $string = $term->special_decode ($text) |
1808 | |
2033 | |
1809 | Converts rxvt-unicodes text representation into a perl string. See |
2034 | Converts rxvt-unicode's text representation into a perl string. See |
1810 | C<< $term->ROW_t >> for details. |
2035 | C<< $term->ROW_t >> for details. |
1811 | |
2036 | |
1812 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
2037 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1813 | |
2038 | |
1814 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
2039 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1880 | |
2105 | |
1881 | package urxvt::popup; |
2106 | package urxvt::popup; |
1882 | |
2107 | |
1883 | =head2 The C<urxvt::popup> Class |
2108 | =head2 The C<urxvt::popup> Class |
1884 | |
2109 | |
1885 | =over 4 |
2110 | =over |
1886 | |
2111 | |
1887 | =cut |
2112 | =cut |
1888 | |
2113 | |
1889 | sub add_item { |
2114 | sub add_item { |
1890 | my ($self, $item) = @_; |
2115 | my ($self, $item) = @_; |
… | |
… | |
2026 | ->cb (sub { |
2251 | ->cb (sub { |
2027 | $term->{overlay}->set (0, 0, |
2252 | $term->{overlay}->set (0, 0, |
2028 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2253 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2029 | }); |
2254 | }); |
2030 | |
2255 | |
2031 | =over 4 |
2256 | =over |
2032 | |
2257 | |
2033 | =item $timer = new urxvt::timer |
2258 | =item $timer = new urxvt::timer |
2034 | |
2259 | |
2035 | Create a new timer object in started state. It is scheduled to fire |
2260 | Create a new timer object in started state. It is scheduled to fire |
2036 | immediately. |
2261 | immediately. |
… | |
… | |
2085 | sysread $term->{socket}, my $buf, 8192 |
2310 | sysread $term->{socket}, my $buf, 8192 |
2086 | or end-of-file; |
2311 | or end-of-file; |
2087 | }); |
2312 | }); |
2088 | |
2313 | |
2089 | |
2314 | |
2090 | =over 4 |
2315 | =over |
2091 | |
2316 | |
2092 | =item $iow = new urxvt::iow |
2317 | =item $iow = new urxvt::iow |
2093 | |
2318 | |
2094 | Create a new io watcher object in stopped state. |
2319 | Create a new io watcher object in stopped state. |
2095 | |
2320 | |
… | |
… | |
2122 | |
2347 | |
2123 | This class implements idle watchers, that get called automatically when |
2348 | This class implements idle watchers, that get called automatically when |
2124 | the process is idle. They should return as fast as possible, after doing |
2349 | the process is idle. They should return as fast as possible, after doing |
2125 | some useful work. |
2350 | some useful work. |
2126 | |
2351 | |
2127 | =over 4 |
2352 | =over |
2128 | |
2353 | |
2129 | =item $iw = new urxvt::iw |
2354 | =item $iw = new urxvt::iw |
2130 | |
2355 | |
2131 | Create a new idle watcher object in stopped state. |
2356 | Create a new idle watcher object in stopped state. |
2132 | |
2357 | |
… | |
… | |
2157 | ->cb (sub { |
2382 | ->cb (sub { |
2158 | my ($pw, $exit_status) = @_; |
2383 | my ($pw, $exit_status) = @_; |
2159 | ... |
2384 | ... |
2160 | }); |
2385 | }); |
2161 | |
2386 | |
2162 | =over 4 |
2387 | =over |
2163 | |
2388 | |
2164 | =item $pw = new urxvt::pw |
2389 | =item $pw = new urxvt::pw |
2165 | |
2390 | |
2166 | Create a new process watcher in stopped state. |
2391 | Create a new process watcher in stopped state. |
2167 | |
2392 | |
… | |
… | |
2184 | =head2 URXVT_PERL_VERBOSITY |
2409 | =head2 URXVT_PERL_VERBOSITY |
2185 | |
2410 | |
2186 | This variable controls the verbosity level of the perl extension. Higher |
2411 | This variable controls the verbosity level of the perl extension. Higher |
2187 | numbers indicate more verbose output. |
2412 | numbers indicate more verbose output. |
2188 | |
2413 | |
2189 | =over 4 |
2414 | =over |
2190 | |
2415 | |
2191 | =item == 0 - fatal messages |
2416 | =item == 0 - fatal messages only |
|
|
2417 | |
|
|
2418 | =item >= 2 - general warnings (default level) |
2192 | |
2419 | |
2193 | =item >= 3 - script loading and management |
2420 | =item >= 3 - script loading and management |
2194 | |
2421 | |
2195 | =item >=10 - all called hooks |
2422 | =item >=10 - all called hooks |
2196 | |
2423 | |