… | |
… | |
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" |
… | |
… | |
70 | terminal is destroyed. |
70 | terminal is destroyed. |
71 | |
71 | |
72 | 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 |
73 | hints on what they mean: |
73 | hints on what they mean: |
74 | |
74 | |
75 | =over 4 |
75 | =over |
76 | |
76 | |
77 | =item $text |
77 | =item $text |
78 | |
78 | |
79 | 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 |
80 | 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. |
… | |
… | |
115 | the C<urxvt::extension> section below. |
115 | the C<urxvt::extension> section below. |
116 | |
116 | |
117 | =head2 META comments |
117 | =head2 META comments |
118 | |
118 | |
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
119 | Rxvt-unicode recognizes special meta comments in extensions that define |
120 | different types of metadata. |
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. |
121 | |
123 | |
122 | Currently, it recognises only one such comment: |
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. |
123 | |
127 | |
124 | =over 4 |
128 | =over |
125 | |
129 | |
126 | =item #:META:RESOURCE:name:type:desc |
130 | =item #:META:RESOURCE:name:type:desc |
127 | |
131 | |
128 | The RESOURCE comment defines a resource used by the extension, where |
132 | The RESOURCE comment defines a resource used by the extension, where |
129 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
133 | C<name> is the resource name, C<type> is the resource type, C<boolean> |
130 | or C<string>, and C<desc> is the resource description. |
134 | or C<string>, and C<desc> is the resource description. |
131 | |
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 | |
132 | =back |
184 | =back |
133 | |
185 | |
134 | =head2 Hooks |
186 | =head2 Hooks |
135 | |
187 | |
136 | 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 |
… | |
… | |
143 | 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 |
144 | relevant action might not be carried out by the C++ code. |
196 | relevant action might not be carried out by the C++ code. |
145 | |
197 | |
146 | I<< When in doubt, return a false value (preferably C<()>). >> |
198 | I<< When in doubt, return a false value (preferably C<()>). >> |
147 | |
199 | |
148 | =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. |
149 | |
213 | |
150 | =item on_init $term |
214 | =item on_init $term |
151 | |
215 | |
152 | Called after a new terminal object has been initialized, but before |
216 | Called after a new terminal object has been initialized, but before |
153 | 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 |
… | |
… | |
235 | |
299 | |
236 | C<on_osc_seq_perl> should be used for new behaviour. |
300 | C<on_osc_seq_perl> should be used for new behaviour. |
237 | |
301 | |
238 | =item on_osc_seq_perl $term, $args, $resp |
302 | =item on_osc_seq_perl $term, $args, $resp |
239 | |
303 | |
240 | Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = |
304 | Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence |
241 | operating system command) is processed. Cursor position and other state |
305 | (OSC = operating system command) is processed. Cursor position and other |
242 | information is up-to-date when this happens. For interoperability, the |
306 | state information is up-to-date when this happens. For interoperability, |
243 | 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 |
244 | to distinguish it from commands for other extensions, and this might be |
308 | other suitable prefix, and a semicolon, to distinguish it from commands |
245 | enforced in the future. |
309 | for other extensions. |
246 | |
310 | |
247 | For example, C<overlay-osc> uses this: |
311 | For example, C<overlay-osc> uses this: |
248 | |
312 | |
249 | sub on_osc_seq_perl { |
313 | sub on_osc_seq_perl { |
250 | my ($self, $osc, $resp) = @_; |
314 | my ($self, $osc, $resp) = @_; |
… | |
… | |
395 | =cut |
459 | =cut |
396 | |
460 | |
397 | package urxvt; |
461 | package urxvt; |
398 | |
462 | |
399 | use utf8; |
463 | use utf8; |
400 | use strict 'vars'; |
464 | use strict qw(vars subs); |
401 | use Carp (); |
465 | use Carp (); |
402 | use Scalar::Util (); |
466 | use Scalar::Util (); |
403 | use List::Util (); |
467 | use List::Util (); |
404 | |
468 | |
405 | our $VERSION = 1; |
469 | our $VERSION = 1; |
… | |
… | |
417 | |
481 | |
418 | our $NOCHAR = chr 0xffff; |
482 | our $NOCHAR = chr 0xffff; |
419 | |
483 | |
420 | =head2 Variables in the C<urxvt> Package |
484 | =head2 Variables in the C<urxvt> Package |
421 | |
485 | |
422 | =over 4 |
486 | =over |
423 | |
487 | |
424 | =item $urxvt::LIBDIR |
488 | =item $urxvt::LIBDIR |
425 | |
489 | |
426 | The rxvt-unicode library directory, where, among other things, the perl |
490 | The rxvt-unicode library directory, where, among other things, the perl |
427 | modules and scripts are stored. |
491 | modules and scripts are stored. |
… | |
… | |
457 | |
521 | |
458 | =back |
522 | =back |
459 | |
523 | |
460 | =head2 Functions in the C<urxvt> Package |
524 | =head2 Functions in the C<urxvt> Package |
461 | |
525 | |
462 | =over 4 |
526 | =over |
463 | |
527 | |
464 | =item urxvt::fatal $errormessage |
528 | =item urxvt::fatal $errormessage |
465 | |
529 | |
466 | Fatally aborts execution with the given error message (which should |
530 | Fatally aborts execution with the given error message (which should |
467 | 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 |
… | |
… | |
512 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
576 | CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, |
513 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
577 | SelectionNotify, ColormapNotify, ClientMessage, MappingNotify |
514 | |
578 | |
515 | Various constants for use in X calls and event processing. |
579 | Various constants for use in X calls and event processing. |
516 | |
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 | |
517 | =back |
593 | =back |
518 | |
594 | |
519 | =head2 RENDITION |
595 | =head2 RENDITION |
520 | |
596 | |
521 | Rendition bitsets contain information about colour, font, font styles and |
597 | Rendition bitsets contain information about colour, font, font styles and |
… | |
… | |
524 | The following "macros" deal with changes in rendition sets. You should |
600 | The following "macros" deal with changes in rendition sets. You should |
525 | 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, |
526 | as they contain important information required for correct operation of |
602 | as they contain important information required for correct operation of |
527 | rxvt-unicode. |
603 | rxvt-unicode. |
528 | |
604 | |
529 | =over 4 |
605 | =over |
530 | |
606 | |
531 | =item $rend = urxvt::DEFAULT_RSTYLE |
607 | =item $rend = urxvt::DEFAULT_RSTYLE |
532 | |
608 | |
533 | 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 |
534 | being reset. Useful as a base to start when creating renditions. |
610 | being reset. Useful as a base to start when creating renditions. |
… | |
… | |
588 | sub parse_resource { |
664 | sub parse_resource { |
589 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
665 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
590 | |
666 | |
591 | $term->scan_extensions; |
667 | $term->scan_extensions; |
592 | |
668 | |
|
|
669 | # iterating over all resources has quadratic time overhead |
|
|
670 | # overall, maybe this could be optimised? |
593 | my $r = $term->{meta}{resource}; |
671 | my $r = $term->{meta}{resource}; |
594 | keys %$r; # reset iterator |
672 | keys %$r; # reset iterator |
595 | while (my ($k, $v) = each %$r) { |
673 | while (my ($k, $v) = each %$r) { |
596 | my $pattern = $k; |
674 | my $pattern = $k; |
597 | $pattern =~ y/./-/ if $isarg; |
675 | $pattern =~ y/./-/ if $isarg; |
… | |
… | |
647 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
725 | urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; |
648 | } |
726 | } |
649 | } |
727 | } |
650 | } |
728 | } |
651 | |
729 | |
652 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
730 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2; |
653 | |
731 | |
654 | sub verbose { |
732 | sub verbose { |
655 | my ($level, $msg) = @_; |
733 | my ($level, $msg) = @_; |
656 | warn "$msg\n" if $level <= $verbosity; |
734 | warn "$msg\n" if $level <= $verbosity; |
657 | } |
735 | } |
… | |
… | |
674 | |
752 | |
675 | open my $fh, "<:raw", $path |
753 | open my $fh, "<:raw", $path |
676 | or die "$path: $!"; |
754 | or die "$path: $!"; |
677 | |
755 | |
678 | my $source = |
756 | my $source = |
679 | "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" |
680 | . "#line 1 \"$path\"\n{\n" |
758 | . "#line 1 \"$path\"\n{\n" |
681 | . (do { local $/; <$fh> }) |
759 | . (do { local $/; <$fh> }) |
682 | . "\n};\n1"; |
760 | . "\n};\n1"; |
683 | |
761 | |
684 | eval $source |
762 | eval $source |
… | |
… | |
694 | sub invoke { |
772 | sub invoke { |
695 | local $TERM = shift; |
773 | local $TERM = shift; |
696 | my $htype = shift; |
774 | my $htype = shift; |
697 | |
775 | |
698 | if ($htype == HOOK_INIT) { |
776 | if ($htype == HOOK_INIT) { |
699 | my @dirs = $TERM->perl_libdirs; |
|
|
700 | |
|
|
701 | $TERM->scan_extensions; |
777 | $TERM->scan_extensions; |
702 | |
778 | |
703 | my %ext_arg; |
779 | my %ext_arg; |
704 | |
780 | |
705 | { |
781 | { |
… | |
… | |
710 | @TERM_EXT = (); |
786 | @TERM_EXT = (); |
711 | $TERM->register_package ($_) for @pkg; |
787 | $TERM->register_package ($_) for @pkg; |
712 | } |
788 | } |
713 | |
789 | |
714 | for ( |
790 | for ( |
|
|
791 | @{ delete $TERM->{perl_ext_3} }, |
715 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
792 | (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), |
716 | @{ delete $TERM->{perl_ext_3} } |
|
|
717 | ) { |
793 | ) { |
718 | if ($_ eq "default") { |
794 | if ($_ eq "default") { |
719 | |
795 | |
720 | $ext_arg{$_} = [] |
796 | $ext_arg{$_} = [] |
721 | for qw(selection option-popup selection-popup readline searchable-scrollback); |
797 | for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste); |
722 | |
798 | |
723 | for ($TERM->_keysym_resources) { |
799 | for ($TERM->_keysym_resources) { |
724 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
800 | next if /^(?:string|command|builtin|builtin-string|perl)/; |
725 | next unless /^([A-Za-z0-9_\-]+):/; |
801 | next unless /^([A-Za-z0-9_\-]+):/; |
726 | |
802 | |
727 | my $ext = $1; |
803 | my $ext = $1; |
728 | |
804 | |
729 | $ext_arg{$ext} = []; |
805 | $ext_arg{$ext} = []; |
730 | } |
806 | } |
731 | |
807 | |
732 | } elsif (/^-(.*)$/) { |
808 | } elsif (/^-(.*)$/) { # remove from set |
733 | delete $ext_arg{$1}; |
809 | delete $ext_arg{$1}; |
734 | |
810 | |
735 | } 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}; |
736 | push @{ $ext_arg{$1} }, $2; |
816 | push @{ $ext_arg{$1} }, defined $2 ? $2 : (); |
737 | |
817 | |
738 | } else { |
818 | } else { |
739 | $ext_arg{$_} ||= []; |
819 | verbose 2, "cannot parse extension specification '$_', ignoring."; |
740 | } |
820 | } |
741 | } |
821 | } |
742 | |
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 | |
743 | for my $ext (sort keys %ext_arg) { |
826 | for my $ext (sort keys %ext_arg) { |
744 | my @files = grep -f $_, map "$_/$ext", @dirs; |
827 | my $path = $TERM->extension_path ($ext); |
745 | |
828 | |
746 | if (@files) { |
829 | if (defined $path) { |
747 | $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); |
830 | $TERM->autoload_extension ($ext, $ext_arg{$ext}); |
748 | } else { |
831 | } else { |
749 | 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"; |
750 | } |
833 | } |
751 | } |
834 | } |
752 | |
835 | |
753 | 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"); |
754 | 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 | } |
755 | } |
848 | } |
756 | |
849 | |
757 | $retval = undef; |
850 | $retval = undef; |
758 | |
851 | |
759 | if (my $cb = $TERM->{_hook}[$htype]) { |
852 | if (my $cb = $TERM->{_hook}[$htype]) { |
… | |
… | |
839 | |
932 | |
840 | 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 |
841 | objects, in addition to call methods documented for the <urxvt::term> |
934 | objects, in addition to call methods documented for the <urxvt::term> |
842 | class. |
935 | class. |
843 | |
936 | |
844 | =over 4 |
937 | =over |
845 | |
938 | |
846 | =item $urxvt_term = $self->{term} |
939 | =item $urxvt_term = $self->{term} |
847 | |
940 | |
848 | 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 |
849 | extension. This member I<must not> be changed in any way. |
942 | extension. This member I<must not> be changed in any way. |
… | |
… | |
1090 | |
1183 | |
1091 | package urxvt::term; |
1184 | package urxvt::term; |
1092 | |
1185 | |
1093 | =head2 The C<urxvt::term> Class |
1186 | =head2 The C<urxvt::term> Class |
1094 | |
1187 | |
1095 | =over 4 |
1188 | =over |
1096 | |
1189 | |
1097 | =cut |
1190 | =cut |
1098 | |
1191 | |
1099 | # find on_xxx subs in the package and register them |
1192 | # find on_xxx subs in the package and register them |
1100 | # as hooks |
1193 | # as hooks |
1101 | sub register_package { |
1194 | sub register_package { |
1102 | my ($self, $pkg, $argv) = @_; |
1195 | my ($self, $pkg, $argv) = @_; |
|
|
1196 | |
|
|
1197 | return if $self->{_pkg}{$pkg}; |
1103 | |
1198 | |
1104 | no strict 'refs'; |
1199 | no strict 'refs'; |
1105 | |
1200 | |
1106 | urxvt::verbose 6, "register package $pkg to $self"; |
1201 | urxvt::verbose 6, "register package $pkg to $self"; |
1107 | |
1202 | |
… | |
… | |
1119 | for my $name (@HOOKNAME) { |
1214 | for my $name (@HOOKNAME) { |
1120 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
1215 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
1121 | $proxy->enable ($name => $ref); |
1216 | $proxy->enable ($name => $ref); |
1122 | } |
1217 | } |
1123 | } |
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); |
1124 | } |
1248 | } |
1125 | |
1249 | |
1126 | sub perl_libdirs { |
1250 | sub perl_libdirs { |
1127 | map { split /:/ } |
1251 | map { split /:/ } |
1128 | $_[0]->resource ("perl_lib"), |
1252 | $_[0]->resource ("perl_lib"), |
… | |
… | |
1138 | return if exists $self->{meta}; |
1262 | return if exists $self->{meta}; |
1139 | |
1263 | |
1140 | my @urxvtdirs = perl_libdirs $self; |
1264 | my @urxvtdirs = perl_libdirs $self; |
1141 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
1265 | # my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; |
1142 | |
1266 | |
1143 | $self->{meta} = \my %meta; |
1267 | $self->{meta} = \my %allmeta; |
1144 | |
1268 | |
1145 | # first gather extensions |
1269 | # first gather extensions |
1146 | |
1270 | |
1147 | my $gather = sub { |
1271 | my $gather = sub { |
1148 | my ($dir, $core) = @_; |
1272 | my ($dir, $core) = @_; |
… | |
… | |
1161 | or next; |
1285 | or next; |
1162 | |
1286 | |
1163 | $ext =~ s/\.uext$// or $core |
1287 | $ext =~ s/\.uext$// or $core |
1164 | or next; |
1288 | or next; |
1165 | |
1289 | |
1166 | my %ext = (dir => $dir); |
1290 | my %meta = (dir => $dir); |
1167 | |
1291 | |
1168 | while (<$fh>) { |
1292 | while (<$fh>) { |
1169 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1293 | if (/^#:META:(?:X_)?RESOURCE:(.*)/) { |
1170 | my ($pattern, $type, $desc) = split /:/, $1; |
1294 | my ($pattern, $type, $desc) = split /:/, $1; |
1171 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1295 | $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name |
1172 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1296 | if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { |
1173 | 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"; |
1174 | } else { |
1298 | } else { |
1175 | $ext{resource}{$pattern} = [$ext, $type, $desc]; |
1299 | $meta{resource}{$pattern} = [$ext, $type, $desc]; |
1176 | } |
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 | |
1177 | } elsif (/^\s*(?:#|$)/) { |
1308 | } elsif (/^\s*(?:#|$)/) { |
1178 | # skip other comments and empty lines |
1309 | # skip other comments and empty lines |
|
|
1310 | |
1179 | } else { |
1311 | } else { |
1180 | last; # stop parsing on first non-empty non-comment line |
1312 | last; # stop parsing on first non-empty non-comment line |
1181 | } |
1313 | } |
1182 | } |
1314 | } |
1183 | |
1315 | |
1184 | $meta{ext}{$ext} = \%ext; |
1316 | $allmeta{ext}{$ext} = \%meta; |
1185 | } |
1317 | } |
1186 | }; |
1318 | }; |
1187 | |
1319 | |
1188 | # $gather->($_, 0) for @cpandirs; |
1320 | # $gather->($_, 0) for @cpandirs; |
1189 | $gather->($_, 1) for @urxvtdirs; |
1321 | $gather->($_, 1) for @urxvtdirs; |
1190 | |
1322 | |
1191 | # and now merge resources |
1323 | # and now merge resources |
1192 | |
1324 | |
1193 | $meta{resource} = \my %resource; |
1325 | $allmeta{resource} = \my %resource; |
1194 | |
1326 | |
1195 | while (my ($k, $v) = each %{ $meta{ext} }) { |
1327 | while (my ($k, $v) = each %{ $allmeta{ext} }) { |
1196 | #TODO: should check for extensions overriding each other |
1328 | #TODO: should check for extensions overriding each other |
1197 | %resource = (%resource, %{ $v->{resource} }); |
1329 | %resource = (%resource, %{ $v->{resource} }); |
1198 | } |
1330 | } |
1199 | } |
1331 | } |
1200 | |
1332 | |
… | |
… | |
1232 | 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 |
1233 | ("starts") programs in the background. This function takes care of setting |
1365 | ("starts") programs in the background. This function takes care of setting |
1234 | 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 |
1235 | be preferred over explicit calls to C<exec> or C<system>. |
1367 | be preferred over explicit calls to C<exec> or C<system>. |
1236 | |
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 | |
1237 | Returns the pid of the subprocess or C<undef> on error. |
1373 | Returns the pid of the subprocess or C<undef> on error. |
1238 | |
1374 | |
1239 | =cut |
1375 | =cut |
1240 | |
1376 | |
1241 | sub exec_async { |
1377 | sub exec_async { |
… | |
… | |
1244 | my $pid = fork; |
1380 | my $pid = fork; |
1245 | |
1381 | |
1246 | return $pid |
1382 | return $pid |
1247 | if !defined $pid or $pid; |
1383 | if !defined $pid or $pid; |
1248 | |
1384 | |
|
|
1385 | %ENV = ( |
1249 | %ENV = %{ $self->env }; |
1386 | %{ $self->env }, |
|
|
1387 | URXVT_EXT_WINDOWID => $self->parent, |
|
|
1388 | ); |
1250 | |
1389 | |
1251 | exec @_; |
1390 | exec @_; |
1252 | urxvt::_exit 255; |
1391 | urxvt::_exit 255; |
1253 | } |
1392 | } |
1254 | |
1393 | |
… | |
… | |
1265 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1404 | insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell |
1266 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1405 | mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs |
1267 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1406 | pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right |
1268 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1407 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen |
1269 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
1408 | secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords |
1270 | urgentOnBell utmpInhibit visualBell |
1409 | urgentOnBell utmpInhibit visualBell disablePasteBrackets |
1271 | |
1410 | |
1272 | =item $value = $term->resource ($name[, $newval]) |
1411 | =item $value = $term->resource ($name[, $newval]) |
1273 | |
1412 | |
1274 | Returns the current resource value associated with a given name and |
1413 | Returns the current resource value associated with a given name and |
1275 | 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> |
… | |
… | |
1301 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1440 | preeditType print_pipe pty_fd reverseVideo saveLines scrollBar |
1302 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1441 | scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness |
1303 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1442 | scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle |
1304 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1443 | secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll |
1305 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1444 | term_name title transient_for transparent tripleclickwords urgentOnBell |
1306 | utmpInhibit visualBell |
1445 | utmpInhibit visualBell rewrapMode disablePasteBrackets |
1307 | |
1446 | |
1308 | =cut |
1447 | =cut |
1309 | |
1448 | |
1310 | sub resource($$;$) { |
1449 | sub resource($$;$) { |
1311 | my ($self, $name) = (shift, shift); |
1450 | my ($self, $name) = (shift, shift); |
… | |
… | |
1458 | 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 |
1459 | as long as the perl object is referenced. |
1598 | as long as the perl object is referenced. |
1460 | |
1599 | |
1461 | The methods currently supported on C<urxvt::overlay> objects are: |
1600 | The methods currently supported on C<urxvt::overlay> objects are: |
1462 | |
1601 | |
1463 | =over 4 |
1602 | =over |
1464 | |
1603 | |
1465 | =item $overlay->set ($x, $y, $text[, $rend]) |
1604 | =item $overlay->set ($x, $y, $text[, $rend]) |
1466 | |
1605 | |
1467 | 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 |
1468 | 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 |
… | |
… | |
1512 | Returns the number of screen-cells this string would need. Correctly |
1651 | Returns the number of screen-cells this string would need. Correctly |
1513 | accounts for wide and combining characters. |
1652 | accounts for wide and combining characters. |
1514 | |
1653 | |
1515 | =item $octets = $term->locale_encode ($string) |
1654 | =item $octets = $term->locale_encode ($string) |
1516 | |
1655 | |
1517 | 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>. |
1518 | |
1658 | |
1519 | =item $string = $term->locale_decode ($octets) |
1659 | =item $string = $term->locale_decode ($octets) |
1520 | |
1660 | |
1521 | 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>. |
1522 | |
1663 | |
1523 | =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]) |
1524 | |
1665 | |
1525 | 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 |
1526 | (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 |
… | |
… | |
1691 | |
1832 | |
1692 | =item $cursor_is_hidden = $term->hidden_cursor |
1833 | =item $cursor_is_hidden = $term->hidden_cursor |
1693 | |
1834 | |
1694 | Returns whether the cursor is currently hidden or not. |
1835 | Returns whether the cursor is currently hidden or not. |
1695 | |
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 | |
1696 | =item $view_start = $term->view_start ([$newvalue]) |
1847 | =item $view_start = $term->view_start ([$newvalue]) |
1697 | |
1848 | |
1698 | 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, |
1699 | 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 |
1700 | this many lines into the scrollback buffer. |
1851 | the terminal contents. Lower values scroll this many lines into the |
|
|
1852 | scrollback buffer. |
1701 | |
1853 | |
1702 | =item $term->want_refresh |
1854 | =item $term->want_refresh |
1703 | |
1855 | |
1704 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1856 | Requests a screen refresh. At the next opportunity, rxvt-unicode will |
1705 | compare the on-screen display with its stored representation. If they |
1857 | compare the on-screen display with its stored representation. If they |
… | |
… | |
1763 | |
1915 | |
1764 | 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 |
1765 | 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 |
1766 | following methods: |
1918 | following methods: |
1767 | |
1919 | |
1768 | =over 4 |
1920 | =over |
1769 | |
1921 | |
1770 | =item $text = $line->t ([$new_text]) |
1922 | =item $text = $line->t ([$new_text]) |
1771 | |
1923 | |
1772 | 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> |
1773 | |
1925 | |
… | |
… | |
1869 | $offset / $self->{ncol} + $self->{beg}, |
2021 | $offset / $self->{ncol} + $self->{beg}, |
1870 | $offset % $self->{ncol} |
2022 | $offset % $self->{ncol} |
1871 | ) |
2023 | ) |
1872 | } |
2024 | } |
1873 | |
2025 | |
1874 | =item $text = $term->special_encode $string |
2026 | =item $text = $term->special_encode ($string) |
1875 | |
2027 | |
1876 | 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, |
1877 | where one character corresponds to one screen cell. See |
2029 | where one character corresponds to one screen cell. See |
1878 | C<< $term->ROW_t >> for details. |
2030 | C<< $term->ROW_t >> for details. |
1879 | |
2031 | |
1880 | =item $string = $term->special_decode $text |
2032 | =item $string = $term->special_decode ($text) |
1881 | |
2033 | |
1882 | Converts rxvt-unicodes text representation into a perl string. See |
2034 | Converts rxvt-unicode's text representation into a perl string. See |
1883 | C<< $term->ROW_t >> for details. |
2035 | C<< $term->ROW_t >> for details. |
1884 | |
2036 | |
1885 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
2037 | =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) |
1886 | |
2038 | |
1887 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
2039 | =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) |
… | |
… | |
1953 | |
2105 | |
1954 | package urxvt::popup; |
2106 | package urxvt::popup; |
1955 | |
2107 | |
1956 | =head2 The C<urxvt::popup> Class |
2108 | =head2 The C<urxvt::popup> Class |
1957 | |
2109 | |
1958 | =over 4 |
2110 | =over |
1959 | |
2111 | |
1960 | =cut |
2112 | =cut |
1961 | |
2113 | |
1962 | sub add_item { |
2114 | sub add_item { |
1963 | my ($self, $item) = @_; |
2115 | my ($self, $item) = @_; |
… | |
… | |
2099 | ->cb (sub { |
2251 | ->cb (sub { |
2100 | $term->{overlay}->set (0, 0, |
2252 | $term->{overlay}->set (0, 0, |
2101 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2253 | sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); |
2102 | }); |
2254 | }); |
2103 | |
2255 | |
2104 | =over 4 |
2256 | =over |
2105 | |
2257 | |
2106 | =item $timer = new urxvt::timer |
2258 | =item $timer = new urxvt::timer |
2107 | |
2259 | |
2108 | 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 |
2109 | immediately. |
2261 | immediately. |
… | |
… | |
2158 | sysread $term->{socket}, my $buf, 8192 |
2310 | sysread $term->{socket}, my $buf, 8192 |
2159 | or end-of-file; |
2311 | or end-of-file; |
2160 | }); |
2312 | }); |
2161 | |
2313 | |
2162 | |
2314 | |
2163 | =over 4 |
2315 | =over |
2164 | |
2316 | |
2165 | =item $iow = new urxvt::iow |
2317 | =item $iow = new urxvt::iow |
2166 | |
2318 | |
2167 | Create a new io watcher object in stopped state. |
2319 | Create a new io watcher object in stopped state. |
2168 | |
2320 | |
… | |
… | |
2195 | |
2347 | |
2196 | This class implements idle watchers, that get called automatically when |
2348 | This class implements idle watchers, that get called automatically when |
2197 | 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 |
2198 | some useful work. |
2350 | some useful work. |
2199 | |
2351 | |
2200 | =over 4 |
2352 | =over |
2201 | |
2353 | |
2202 | =item $iw = new urxvt::iw |
2354 | =item $iw = new urxvt::iw |
2203 | |
2355 | |
2204 | Create a new idle watcher object in stopped state. |
2356 | Create a new idle watcher object in stopped state. |
2205 | |
2357 | |
… | |
… | |
2230 | ->cb (sub { |
2382 | ->cb (sub { |
2231 | my ($pw, $exit_status) = @_; |
2383 | my ($pw, $exit_status) = @_; |
2232 | ... |
2384 | ... |
2233 | }); |
2385 | }); |
2234 | |
2386 | |
2235 | =over 4 |
2387 | =over |
2236 | |
2388 | |
2237 | =item $pw = new urxvt::pw |
2389 | =item $pw = new urxvt::pw |
2238 | |
2390 | |
2239 | Create a new process watcher in stopped state. |
2391 | Create a new process watcher in stopped state. |
2240 | |
2392 | |
… | |
… | |
2257 | =head2 URXVT_PERL_VERBOSITY |
2409 | =head2 URXVT_PERL_VERBOSITY |
2258 | |
2410 | |
2259 | This variable controls the verbosity level of the perl extension. Higher |
2411 | This variable controls the verbosity level of the perl extension. Higher |
2260 | numbers indicate more verbose output. |
2412 | numbers indicate more verbose output. |
2261 | |
2413 | |
2262 | =over 4 |
2414 | =over |
2263 | |
2415 | |
2264 | =item == 0 - fatal messages |
2416 | =item == 0 - fatal messages only |
|
|
2417 | |
|
|
2418 | =item >= 2 - general warnings (default level) |
2265 | |
2419 | |
2266 | =item >= 3 - script loading and management |
2420 | =item >= 3 - script loading and management |
2267 | |
2421 | |
2268 | =item >=10 - all called hooks |
2422 | =item >=10 - all called hooks |
2269 | |
2423 | |