ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.242 by sf-exg, Sat Oct 11 20:46:36 2014 UTC vs.
Revision 1.270 by root, Fri Nov 26 18:49:47 2021 UTC

4 4
5urxvtperl - rxvt-unicode's embedded perl interpreter 5urxvtperl - 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
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict qw(vars subs)' and 'use utf8'
26thus must be encoded as UTF-8. 26environment, and thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in urxvtd, where 28Each script will only ever be loaded once, even in urxvtd, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext" 31You can disable the embedded perl interpreter by setting both "perl-ext"
43 43
44Or by adding them to the resource for extensions loaded by default: 44Or 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
48Extensions may add resources on their own. Similarly to builtin 48Extensions may add additional resources and C<actions>, i.e., methods
49resources, these resources can also be specified on the command line 49which can be bound to a key and invoked by the user. An extension can
50as long options (with '.' replaced by '-'), in which case the 50define the resources it support using so called META comments,
51corresponding extension is loaded automatically. 51described below. Similarly to builtin resources, extension resources
52can also be specified on the command line as long options (with C<.>
53replaced by C<->), in which case the corresponding extension is loaded
54automatically. For this to work the extension B<must> define META
55comments for its resources.
52 56
53=head1 API DOCUMENTATION 57=head1 API DOCUMENTATION
54 58
55=head2 General API Considerations 59=head2 General API Considerations
56 60
66terminal is destroyed. 70terminal is destroyed.
67 71
68Argument names also often indicate the type of a parameter. Here are some 72Argument names also often indicate the type of a parameter. Here are some
69hints on what they mean: 73hints on what they mean:
70 74
71=over 4 75=over
72 76
73=item $text 77=item $text
74 78
75Rxvt-unicode's special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
76always represents one screen cell. See L<ROW_t> for a discussion of this format. 80always represents one screen cell. See L<ROW_t> for a discussion of this format.
108C<urxvt::term> class on this object. 112C<urxvt::term> class on this object.
109 113
110Additional methods only supported for extension objects are described in 114Additional methods only supported for extension objects are described in
111the C<urxvt::extension> section below. 115the C<urxvt::extension> section below.
112 116
117=head2 META comments
118
119Rxvt-unicode recognizes special meta comments in extensions that define
120different types of metadata. These comments are scanned whenever a
121terminal is created and are typically used to autoload extensions when
122their resources or command line parameters are used.
123
124Currently, it recognises these comments below. Individual components are
125separated by colons (C<:>), and should not contain colons themselves -
126there is also currently no escaping mechanism provided for this.
127
128=over
129
130=item #:META:RESOURCE:name:type:desc
131
132The RESOURCE comment defines a resource used by the extension, where
133C<name> is the resource name, C<type> is the resource type, C<boolean>
134or C<string>, and C<desc> is the resource description.
135
136The extension will be autoloaded when this resource is specified or used
137as a command line parameter.
138
139Example: matcher provides the C<matcher.launcher> resource by having this
140comment:
141
142 #:META:RESOURCE:%.launcher:string:default launcher command
143
144Example: load this extension when the C<-tr> command line option or
145resource name is used.
146
147 #:META:RESOURCE:tr:boolean:set root pixmap as background
148
149=item #:META:OSC:number:desc
150
151The OSC comment specifies an OSC sequence, where C<number> is the
152numerical OSC code and C<desc> is a short description that is currently
153unused.
154
155This will cause the extension to be autoloaded when the OSC sequence is
156used for the first time.
157
158Note that autoloading carries some extra responsibilities with it:
159although the terminal cannot really protect itself against malicious
160sources of command sequences, therefore relying on the programs running
161I<inside> to sanitize data that they output, it is very common for
162programs to emit command sequences from untrusted sources.
163
164While this means that extensions should, as a defense-in-depth mechanism,
165always consider whether OSC sequences are safe, autoloading automatically
166exposes any autoloaded extension in all terminal windows, so extra care
167should be taken.
168
169Example: 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
175The same as the OSC comment, but for the Perl OSC sequence (C<777>). The
176C<prefix> should be unique among extensions, of course, which is most
177easily arranged by using the extension name, although this is not
178required.
179
180Example: the overlay-osc extension registers its Perl OSC like this:
181
182 #:META:OSC_PERL:overlay:man overlay-osc
183
184=back
185
113=head2 Hooks 186=head2 Hooks
114 187
115The following subroutines can be declared in extension files, and will be 188The following subroutines can be declared in extension files, and will be
116called whenever the relevant event happens. 189called whenever the relevant event happens.
117 190
122hooks returns true, then the event counts as being I<consumed>, and the 195hooks returns true, then the event counts as being I<consumed>, and the
123relevant action might not be carried out by the C++ code. 196relevant action might not be carried out by the C++ code.
124 197
125I<< When in doubt, return a false value (preferably C<()>). >> 198I<< When in doubt, return a false value (preferably C<()>). >>
126 199
127=over 4 200=over
201
202=item on_attach $term
203
204Called when an extension package is attached to a running terminal
205instance. Must return true in all cases, and runs with the same
206limitations as C<on_init>.
207
208Unlike C<on_init> or C<on_start>, this is called when the extension is
209attached to a terminal, regardless of whether the extension is loaded
210before or after the terminal is started. Extensions that need to do
211something before they work can do it in this callback, as opposed to e.g.
212C<on_init>, which might not be called.
128 213
129=item on_init $term 214=item on_init $term
130 215
131Called after a new terminal object has been initialized, but before 216Called after a new terminal object has been initialized, but before
132windows are created or the command gets run. Most methods are unsafe to 217windows are created or the command gets run. Most methods are unsafe to
214 299
215C<on_osc_seq_perl> should be used for new behaviour. 300C<on_osc_seq_perl> should be used for new behaviour.
216 301
217=item on_osc_seq_perl $term, $args, $resp 302=item on_osc_seq_perl $term, $args, $resp
218 303
219Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 304Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
220operating system command) is processed. Cursor position and other state 305(OSC = operating system command) is processed. Cursor position and other
221information is up-to-date when this happens. For interoperability, the 306state information is up-to-date when this happens. For interoperability,
222string should start with the extension name (sans -osc) and a semicolon, 307the argument should start with the extension name (sans -osc) or some
223to distinguish it from commands for other extensions, and this might be 308other suitable prefix, and a semicolon, to distinguish it from commands
224enforced in the future. 309for other extensions.
225 310
226For example, C<overlay-osc> uses this: 311For example, C<overlay-osc> uses this:
227 312
228 sub on_osc_seq_perl { 313 sub on_osc_seq_perl {
229 my ($self, $osc, $resp) = @_; 314 my ($self, $osc, $resp) = @_;
283 368
284=item on_refresh_end $term 369=item on_refresh_end $term
285 370
286Called just after the screen gets redrawn. See C<on_refresh_begin>. 371Called just after the screen gets redrawn. See C<on_refresh_begin>.
287 372
373=item on_action $term, $string
374
375Called whenever an action is invoked for the corresponding extension
376(e.g. via a C<extension:string> builtin action bound to a key, see
377description of the B<keysym> resource in the urxvt(1) manpage). The
378event is simply the action string. Note that an action event is always
379associated to a single extension.
380
288=item on_user_command $term, $string *DEPRECATED* 381=item on_user_command $term, $string *DEPRECATED*
289 382
290Called whenever a user-configured event is being activated (e.g. via 383Called whenever a user-configured event is being activated (e.g. via
291a C<perl:string> action bound to a key, see description of the B<keysym> 384a C<perl:string> action bound to a key, see description of the B<keysym>
292resource in the urxvt(1) manpage). 385resource in the urxvt(1) manpage).
366=cut 459=cut
367 460
368package urxvt; 461package urxvt;
369 462
370use utf8; 463use utf8;
371use strict 'vars'; 464use strict qw(vars subs);
372use Carp (); 465use Carp ();
373use Scalar::Util (); 466use Scalar::Util ();
374use List::Util (); 467use List::Util ();
375 468
376our $VERSION = 1; 469our $VERSION = 1;
388 481
389our $NOCHAR = chr 0xffff; 482our $NOCHAR = chr 0xffff;
390 483
391=head2 Variables in the C<urxvt> Package 484=head2 Variables in the C<urxvt> Package
392 485
393=over 4 486=over
394 487
395=item $urxvt::LIBDIR 488=item $urxvt::LIBDIR
396 489
397The rxvt-unicode library directory, where, among other things, the perl 490The rxvt-unicode library directory, where, among other things, the perl
398modules and scripts are stored. 491modules and scripts are stored.
428 521
429=back 522=back
430 523
431=head2 Functions in the C<urxvt> Package 524=head2 Functions in the C<urxvt> Package
432 525
433=over 4 526=over
434 527
435=item urxvt::fatal $errormessage 528=item urxvt::fatal $errormessage
436 529
437Fatally aborts execution with the given error message (which should 530Fatally aborts execution with the given error message (which should
438include a trailing newline). Avoid at all costs! The only time this 531include a trailing newline). Avoid at all costs! The only time this
483CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 576CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
484SelectionNotify, ColormapNotify, ClientMessage, MappingNotify 577SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485 578
486Various constants for use in X calls and event processing. 579Various constants for use in X calls and event processing.
487 580
581=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
582PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
583PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
584PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
585PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
586PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
587PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
588PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
589PrivMode_Default
590
591Constants for checking DEC private modes.
592
488=back 593=back
489 594
490=head2 RENDITION 595=head2 RENDITION
491 596
492Rendition bitsets contain information about colour, font, font styles and 597Rendition bitsets contain information about colour, font, font styles and
495The following "macros" deal with changes in rendition sets. You should 600The following "macros" deal with changes in rendition sets. You should
496never just create a bitset, you should always modify an existing one, 601never just create a bitset, you should always modify an existing one,
497as they contain important information required for correct operation of 602as they contain important information required for correct operation of
498rxvt-unicode. 603rxvt-unicode.
499 604
500=over 4 605=over
501 606
502=item $rend = urxvt::DEFAULT_RSTYLE 607=item $rend = urxvt::DEFAULT_RSTYLE
503 608
504Returns the default rendition, as used when the terminal is starting up or 609Returns the default rendition, as used when the terminal is starting up or
505being reset. Useful as a base to start when creating renditions. 610being reset. Useful as a base to start when creating renditions.
559sub parse_resource { 664sub parse_resource {
560 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 665 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
561 666
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 ($k, $v) = each %$r) { 673 while (my ($k, $v) = each %$r) {
567 my $pattern = $k; 674 my $pattern = $k;
568 $pattern =~ y/./-/ if $isarg; 675 $pattern =~ y/./-/ if $isarg;
575 if ($pattern eq $prefix) { 682 if ($pattern eq $prefix) {
576 $name = "$urxvt::RESCLASS.$k$suffix"; 683 $name = "$urxvt::RESCLASS.$k$suffix";
577 684
578 push @{ $term->{perl_ext_3} }, $v->[0]; 685 push @{ $term->{perl_ext_3} }, $v->[0];
579 686
687 return 1 unless $isarg;
688
580 if ($v->[1] eq "boolean") { 689 if ($v->[1] eq "boolean") {
581 $term->put_option_db ($name, $flag ? "true" : "false"); 690 $term->put_option_db ($name, $flag ? "true" : "false");
582 return 1; 691 return 1;
583 } else { 692 } else {
584 $term->put_option_db ($name, $value); 693 $term->put_option_db ($name, $value);
616 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; 725 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
617 } 726 }
618 } 727 }
619} 728}
620 729
621my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 730my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
622 731
623sub verbose { 732sub verbose {
624 my ($level, $msg) = @_; 733 my ($level, $msg) = @_;
625 warn "$msg\n" if $level <= $verbosity; 734 warn "$msg\n" if $level <= $verbosity;
626} 735}
643 752
644 open my $fh, "<:raw", $path 753 open my $fh, "<:raw", $path
645 or die "$path: $!"; 754 or die "$path: $!";
646 755
647 my $source = 756 my $source =
648 "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"
649 . "#line 1 \"$path\"\n{\n" 758 . "#line 1 \"$path\"\n{\n"
650 . (do { local $/; <$fh> }) 759 . (do { local $/; <$fh> })
651 . "\n};\n1"; 760 . "\n};\n1";
652 761
653 eval $source 762 eval $source
663sub invoke { 772sub invoke {
664 local $TERM = shift; 773 local $TERM = shift;
665 my $htype = shift; 774 my $htype = shift;
666 775
667 if ($htype == HOOK_INIT) { 776 if ($htype == HOOK_INIT) {
668 my @dirs = $TERM->perl_libdirs;
669
670 $TERM->scan_extensions; 777 $TERM->scan_extensions;
671 778
672 my %ext_arg; 779 my %ext_arg;
673 780
674 { 781 {
679 @TERM_EXT = (); 786 @TERM_EXT = ();
680 $TERM->register_package ($_) for @pkg; 787 $TERM->register_package ($_) for @pkg;
681 } 788 }
682 789
683 for ( 790 for (
791 @{ delete $TERM->{perl_ext_3} },
684 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 792 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
685 ) { 793 ) {
686 if ($_ eq "default") { 794 if ($_ eq "default") {
687 795
688 $ext_arg{$_} = [] 796 $ext_arg{$_} = []
689 for
690 qw(selection option-popup selection-popup readline), 797 for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
691 @{ delete $TERM->{perl_ext_3} },
692 map $_->[0], values %{ $TERM->{meta}{binding} };
693 798
694 for ($TERM->_keysym_resources) { 799 for ($TERM->_keysym_resources) {
695 next if /^(?:string|command|builtin|builtin-string|perl)/; 800 next if /^(?:string|command|builtin|builtin-string|perl)/;
696 next unless /^([A-Za-z0-9_\-]+):/; 801 next unless /^([A-Za-z0-9_\-]+):/;
697 802
698 my $ext = $1; 803 my $ext = $1;
699 804
700 $ext_arg{$ext} = []; 805 $ext_arg{$ext} = [];
701 } 806 }
702 807
703 } elsif (/^-(.*)$/) { 808 } elsif (/^-(.*)$/) { # remove from set
704 delete $ext_arg{$1}; 809 delete $ext_arg{$1};
705 810
706 } 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};
707 push @{ $ext_arg{$1} }, $2; 816 push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
708 817
709 } else { 818 } else {
710 $ext_arg{$_} ||= []; 819 verbose 2, "cannot parse extension specification '$_', ignoring.";
711 } 820 }
712 } 821 }
713 822
714 # 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
715 for my $ext (sort keys %ext_arg) { 826 for my $ext (sort keys %ext_arg) {
716 while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { 827 my $path = $TERM->extension_path ($ext);
717 $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";
718 } 833 }
719 } 834 }
720 835
721 for my $ext (sort keys %ext_arg) {
722 my @files = grep -f $_, map "$_/$ext", @dirs;
723
724 if (@files) {
725 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
726 } else {
727 warn "perl extension '$ext' not found in perl library search path\n";
728 }
729 }
730
731 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");
732 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 }
733 } 848 }
734 849
735 $retval = undef; 850 $retval = undef;
736 851
737 if (my $cb = $TERM->{_hook}[$htype]) { 852 if (my $cb = $TERM->{_hook}[$htype]) {
817 932
818The methods (And data members) documented below can be called on extension 933The methods (And data members) documented below can be called on extension
819objects, in addition to call methods documented for the <urxvt::term> 934objects, in addition to call methods documented for the <urxvt::term>
820class. 935class.
821 936
822=over 4 937=over
823 938
824=item $urxvt_term = $self->{term} 939=item $urxvt_term = $self->{term}
825 940
826Returns the C<urxvt::term> object associated with this instance of the 941Returns the C<urxvt::term> object associated with this instance of the
827extension. This member I<must not> be changed in any way. 942extension. This member I<must not> be changed in any way.
945 } 1060 }
946 1061
947 bless \%disable, "urxvt::extension::on_disable" 1062 bless \%disable, "urxvt::extension::on_disable"
948} 1063}
949 1064
1065=item $self->bind_action ($hotkey, $action)
1066
950=item $self->x_resource ($pattern) 1067=item $self->x_resource ($pattern)
951 1068
952=item $self->x_resource_boolean ($pattern) 1069=item $self->x_resource_boolean ($pattern)
953 1070
954These methods support an additional C<%> prefix when called on an 1071These methods support an additional C<%> prefix for C<$action> or
955extension object - see the description of these methods in the 1072C<$pattern> when called on an extension object, compared to the
1073C<urxvt::term> methods of the same name - see the description of these
956C<urxvt::term> class for details. 1074methods in the C<urxvt::term> class for details.
957 1075
958=cut 1076=cut
1077
1078sub bind_action {
1079 my ($self, $hotkey, $action) = @_;
1080 $action =~ s/^%:/$_[0]{_name}:/;
1081 $self->{term}->bind_action ($hotkey, $action)
1082}
959 1083
960sub x_resource { 1084sub x_resource {
961 my ($self, $name) = @_; 1085 my ($self, $name) = @_;
962 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 1086 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
963 $self->{term}->x_resource ($name) 1087 $self->{term}->x_resource ($name)
1059 1183
1060package urxvt::term; 1184package urxvt::term;
1061 1185
1062=head2 The C<urxvt::term> Class 1186=head2 The C<urxvt::term> Class
1063 1187
1064=over 4 1188=over
1065 1189
1066=cut 1190=cut
1067 1191
1068# find on_xxx subs in the package and register them 1192# find on_xxx subs in the package and register them
1069# as hooks 1193# as hooks
1070sub register_package { 1194sub register_package {
1071 my ($self, $pkg, $argv) = @_; 1195 my ($self, $pkg, $argv) = @_;
1196
1197 return if $self->{_pkg}{$pkg};
1072 1198
1073 no strict 'refs'; 1199 no strict 'refs';
1074 1200
1075 urxvt::verbose 6, "register package $pkg to $self"; 1201 urxvt::verbose 6, "register package $pkg to $self";
1076 1202
1088 for my $name (@HOOKNAME) { 1214 for my $name (@HOOKNAME) {
1089 if (my $ref = $pkg->can ("on_" . lc $name)) { 1215 if (my $ref = $pkg->can ("on_" . lc $name)) {
1090 $proxy->enable ($name => $ref); 1216 $proxy->enable ($name => $ref);
1091 } 1217 }
1092 } 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
1227sub extension_path {
1228 (grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
1229}
1230
1231# load an extension by name
1232sub 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
1239sub 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);
1093} 1248}
1094 1249
1095sub perl_libdirs { 1250sub perl_libdirs {
1096 map { split /:/ } 1251 map { split /:/ }
1097 $_[0]->resource ("perl_lib"), 1252 $_[0]->resource ("perl_lib"),
1104sub scan_extensions { 1259sub scan_extensions {
1105 my ($self) = @_; 1260 my ($self) = @_;
1106 1261
1107 return if exists $self->{meta}; 1262 return if exists $self->{meta};
1108 1263
1109 my @libdirs = perl_libdirs $self; 1264 my @urxvtdirs = perl_libdirs $self;
1265# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1110 1266
1111# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1112
1113# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1114 $self->{meta} = \my %meta; 1267 $self->{meta} = \my %allmeta;
1115 1268
1116 # first gather extensions 1269 # first gather extensions
1117 for my $dir (reverse @libdirs) { 1270
1271 my $gather = sub {
1272 my ($dir, $core) = @_;
1273
1118 opendir my $fh, $dir 1274 opendir my $fh, $dir
1119 or next; 1275 or return;
1276
1120 for my $ext (readdir $fh) { 1277 for my $ext (readdir $fh) {
1121 $ext !~ /^\./ 1278 $ext !~ /^\./
1122 and open my $fh, "<", "$dir/$ext"
1123 or next; 1279 or next;
1124 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
1125 my %ext = (dir => $dir); 1290 my %meta = (dir => $dir);
1126 1291
1127 while (<$fh>) { 1292 while (<$fh>) {
1128 if (/^#:META:(?:X_)?RESOURCE:(.*)/) { 1293 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1129 my ($pattern, $type, $desc) = split /:/, $1; 1294 my ($pattern, $type, $desc) = split /:/, $1;
1130 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1295 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1131 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1296 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1132 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";
1133 } else { 1298 } else {
1134 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1299 $meta{resource}{$pattern} = [$ext, $type, $desc];
1135 } 1300 }
1301
1136 } elsif (/^#:META:BINDING:(.*)/) { 1302 } elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1137 my ($keysym, $action) = split /:/, $1; 1303 push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1138 $ext{binding}{$keysym} = [$ext, $action]; 1304
1305 } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
1306 push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
1307
1139 } elsif (/^\s*(?:#|$)/) { 1308 } elsif (/^\s*(?:#|$)/) {
1140 # skip other comments and empty lines 1309 # skip other comments and empty lines
1310
1141 } else { 1311 } else {
1142 last; # stop parsing on first non-empty non-comment line 1312 last; # stop parsing on first non-empty non-comment line
1143 } 1313 }
1144 } 1314 }
1145 1315
1146 $meta{ext}{$ext} = \%ext; 1316 $allmeta{ext}{$ext} = \%meta;
1147 } 1317 }
1148 } 1318 };
1149 1319
1320# $gather->($_, 0) for @cpandirs;
1321 $gather->($_, 1) for @urxvtdirs;
1322
1150 # and now merge resources and bindings 1323 # and now merge resources
1324
1325 $allmeta{resource} = \my %resource;
1326
1151 while (my ($k, $v) = each %{ $meta{ext} }) { 1327 while (my ($k, $v) = each %{ $allmeta{ext} }) {
1152 #TODO: should check for extensions overriding each other 1328 #TODO: should check for extensions overriding each other
1153 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); 1329 %resource = (%resource, %{ $v->{resource} });
1154 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1155 } 1330 }
1156} 1331}
1157 1332
1158=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1333=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1159 1334
1222 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1397 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1223 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs 1398 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1224 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1399 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1225 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1400 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1226 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1401 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1227 urgentOnBell utmpInhibit visualBell 1402 urgentOnBell utmpInhibit visualBell disablePasteBrackets
1228 1403
1229=item $value = $term->resource ($name[, $newval]) 1404=item $value = $term->resource ($name[, $newval])
1230 1405
1231Returns the current resource value associated with a given name and 1406Returns the current resource value associated with a given name and
1232optionally sets a new value. Setting values is most useful in the C<init> 1407optionally sets a new value. Setting values is most useful in the C<init>
1258 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1433 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1259 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1434 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1260 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1435 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1261 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll 1436 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1262 term_name title transient_for transparent tripleclickwords urgentOnBell 1437 term_name title transient_for transparent tripleclickwords urgentOnBell
1263 utmpInhibit visualBell 1438 utmpInhibit visualBell rewrapMode disablePasteBrackets
1264 1439
1265=cut 1440=cut
1266 1441
1267sub resource($$;$) { 1442sub resource($$;$) {
1268 my ($self, $name) = (shift, shift); 1443 my ($self, $name) = (shift, shift);
1282 1457
1283If the method is called on an extension object (basically, from an 1458If the method is called on an extension object (basically, from an
1284extension), then the special prefix C<%.> will be replaced by the name of 1459extension), then the special prefix C<%.> will be replaced by the name of
1285the extension and a dot, and the lone string C<%> will be replaced by the 1460the extension and a dot, and the lone string C<%> will be replaced by the
1286extension name itself. This makes it possible to code extensions so you 1461extension name itself. This makes it possible to code extensions so you
1287can rename them and get a new set of commandline switches and resources 1462can rename them and get a new set of resources without having to change
1288without having to change the actual code. 1463the actual code.
1289 1464
1290This method should only be called during the C<on_start> hook, as there is 1465This method should only be called during the C<on_start> hook, as there is
1291only one resource database per display, and later invocations might return 1466only one resource database per display, and later invocations might return
1292the wrong resources. 1467the wrong resources.
1293 1468
1305 my $res = &x_resource; 1480 my $res = &x_resource;
1306 1481
1307 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1482 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1308} 1483}
1309 1484
1485=item $action = $term->lookup_keysym ($keysym, $state)
1486
1487Returns the action bound to key combination C<($keysym, $state)>,
1488if a binding for it exists, and C<undef> otherwise.
1489
1310=item $success = $term->bind_action ($key, $octets) 1490=item $success = $term->bind_action ($key, $action)
1311 1491
1312Adds a key binding exactly as specified via a C<keysym> resource. See the 1492Adds a key binding exactly as specified via a C<keysym> resource. See the
1313C<keysym> resource in the urxvt(1) manpage. 1493C<keysym> resource in the urxvt(1) manpage.
1494
1495To add default bindings for actions, an extension should call C<<
1496->bind_action >> in its C<init> hook for every such binding. Doing it
1497in the C<init> hook allows users to override or remove the binding
1498again.
1499
1500Example: the C<searchable-scrollback> by default binds itself
1501on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1502$term->bind_action >>.
1503
1504 sub init {
1505 my ($self) = @_;
1506
1507 $self->bind_action ("M-s" => "%:start");
1508 }
1314 1509
1315=item $rend = $term->rstyle ([$new_rstyle]) 1510=item $rend = $term->rstyle ([$new_rstyle])
1316 1511
1317Return and optionally change the current rendition. Text that is output by 1512Return and optionally change the current rendition. Text that is output by
1318the terminal application will use this style. 1513the terminal application will use this style.
1395This method returns an urxvt::overlay object. The overlay will be visible 1590This method returns an urxvt::overlay object. The overlay will be visible
1396as long as the perl object is referenced. 1591as long as the perl object is referenced.
1397 1592
1398The methods currently supported on C<urxvt::overlay> objects are: 1593The methods currently supported on C<urxvt::overlay> objects are:
1399 1594
1400=over 4 1595=over
1401 1596
1402=item $overlay->set ($x, $y, $text[, $rend]) 1597=item $overlay->set ($x, $y, $text[, $rend])
1403 1598
1404Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1599Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1405text in rxvt-unicode's special encoding and an array of rendition values 1600text in rxvt-unicode's special encoding and an array of rendition values
1449Returns the number of screen-cells this string would need. Correctly 1644Returns the number of screen-cells this string would need. Correctly
1450accounts for wide and combining characters. 1645accounts for wide and combining characters.
1451 1646
1452=item $octets = $term->locale_encode ($string) 1647=item $octets = $term->locale_encode ($string)
1453 1648
1454Convert the given text string into the corresponding locale encoding. 1649Convert the given text string into the corresponding locale
1650encoding. Returns C<undef> if C<$string> is C<undef>.
1455 1651
1456=item $string = $term->locale_decode ($octets) 1652=item $string = $term->locale_decode ($octets)
1457 1653
1458Convert the given locale-encoded octets into a perl string. 1654Convert the given locale-encoded octets into a perl string. Returns
1655C<undef> if C<$octets> is C<undef>.
1459 1656
1460=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1657=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1461 1658
1462XORs the rendition values in the given span with the provided value 1659XORs the rendition values in the given span with the provided value
1463(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in 1660(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1476 1673
1477=item $term->scr_add_lines ($string) 1674=item $term->scr_add_lines ($string)
1478 1675
1479Write the given text string to the screen, as if output by the application 1676Write the given text string to the screen, as if output by the application
1480running inside the terminal. It may not contain command sequences (escape 1677running inside the terminal. It may not contain command sequences (escape
1481codes), but is free to use line feeds, carriage returns and tabs. The 1678codes - see C<cmd_parse> for that), but is free to use line feeds,
1482string is a normal text string, not in locale-dependent encoding. 1679carriage returns and tabs. The string is a normal text string, not in
1680locale-dependent encoding.
1483 1681
1484Normally its not a good idea to use this function, as programs might be 1682Normally its not a good idea to use this function, as programs might be
1485confused by changes in cursor position or scrolling. Its useful inside a 1683confused by changes in cursor position or scrolling. Its useful inside a
1486C<on_add_lines> hook, though. 1684C<on_add_lines> hook, though.
1487 1685
1495locale-specific encoding of the terminal and can contain command sequences 1693locale-specific encoding of the terminal and can contain command sequences
1496(escape codes) that will be interpreted. 1694(escape codes) that will be interpreted.
1497 1695
1498=item $term->tt_write ($octets) 1696=item $term->tt_write ($octets)
1499 1697
1500Write the octets given in C<$octets> to the tty (i.e. as program input). To 1698Write the octets given in C<$octets> to the tty (i.e. as user input
1699to the program, see C<cmd_parse> for the opposite direction). To pass
1501pass characters instead of octets, you should convert your strings first 1700characters instead of octets, you should convert your strings first to the
1502to the locale-specific encoding using C<< $term->locale_encode >>. 1701locale-specific encoding using C<< $term->locale_encode >>.
1503 1702
1504=item $term->tt_write_user_input ($octets) 1703=item $term->tt_write_user_input ($octets)
1505 1704
1506Like C<tt_write>, but should be used when writing strings in response to 1705Like C<tt_write>, but should be used when writing strings in response to
1507the user pressing a key, to invoke the additional actions requested by 1706the user pressing a key, to invoke the additional actions requested by
1554 1753
1555=item $term->key_release ($state, $keycode[, $time]) 1754=item $term->key_release ($state, $keycode[, $time])
1556 1755
1557Deliver various fake events to to terminal. 1756Deliver various fake events to to terminal.
1558 1757
1559=item $window_width = $term->width 1758=item $window_width = $term->width ([$new_value])
1560 1759
1561=item $window_height = $term->height 1760=item $window_height = $term->height ([$new_value])
1562 1761
1563=item $font_width = $term->fwidth 1762=item $font_width = $term->fwidth ([$new_value])
1564 1763
1565=item $font_height = $term->fheight 1764=item $font_height = $term->fheight ([$new_value])
1566 1765
1567=item $font_ascent = $term->fbase 1766=item $font_ascent = $term->fbase ([$new_value])
1568 1767
1569=item $terminal_rows = $term->nrow 1768=item $terminal_rows = $term->nrow ([$new_value])
1570 1769
1571=item $terminal_columns = $term->ncol 1770=item $terminal_columns = $term->ncol ([$new_value])
1572 1771
1573=item $has_focus = $term->focus 1772=item $has_focus = $term->focus ([$new_value])
1574 1773
1575=item $is_mapped = $term->mapped 1774=item $is_mapped = $term->mapped ([$new_value])
1576 1775
1577=item $max_scrollback = $term->saveLines 1776=item $max_scrollback = $term->saveLines ([$new_value])
1578 1777
1579=item $nrow_plus_saveLines = $term->total_rows 1778=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1580 1779
1581=item $topmost_scrollback_row = $term->top_row 1780=item $topmost_scrollback_row = $term->top_row ([$new_value])
1582 1781
1583Return various integers describing terminal characteristics. 1782Return various integers describing terminal characteristics. If an
1783argument is given, changes the value and returns the previous one.
1584 1784
1585=item $x_display = $term->display_id 1785=item $x_display = $term->display_id
1586 1786
1587Return the DISPLAY used by rxvt-unicode. 1787Return the DISPLAY used by rxvt-unicode.
1588 1788
1625 1825
1626=item $cursor_is_hidden = $term->hidden_cursor 1826=item $cursor_is_hidden = $term->hidden_cursor
1627 1827
1628Returns whether the cursor is currently hidden or not. 1828Returns whether the cursor is currently hidden or not.
1629 1829
1830=item $priv_modes = $term->priv_modes
1831
1832Returns a bitset with the state of DEC private modes.
1833
1834Example:
1835
1836 if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
1837 # mouse reporting is turned on
1838 }
1839
1630=item $view_start = $term->view_start ([$newvalue]) 1840=item $view_start = $term->view_start ([$newvalue])
1631 1841
1632Returns the row number of the topmost displayed line. Maximum value is 1842Returns the row number of the topmost displayed line and changes it,
1633C<0>, which displays the normal terminal contents. Lower values scroll 1843if an argument is given. Values greater than or equal to C<0> display
1634this many lines into the scrollback buffer. 1844the terminal contents. Lower values scroll this many lines into the
1845scrollback buffer.
1635 1846
1636=item $term->want_refresh 1847=item $term->want_refresh
1637 1848
1638Requests a screen refresh. At the next opportunity, rxvt-unicode will 1849Requests a screen refresh. At the next opportunity, rxvt-unicode will
1639compare the on-screen display with its stored representation. If they 1850compare the on-screen display with its stored representation. If they
1640differ, it redraws the differences. 1851differ, it redraws the differences.
1641 1852
1642Used after changing terminal contents to display them. 1853Used after changing terminal contents to display them.
1854
1855=item $term->refresh_check
1856
1857Checks if a refresh has been requested and, if so, schedules one.
1643 1858
1644=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1859=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1645 1860
1646Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> 1861Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1647is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost 1862is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1693 1908
1694Create and return a new C<urxvt::line> object that stores information 1909Create and return a new C<urxvt::line> object that stores information
1695about the logical line that row C<$row_number> is part of. It supports the 1910about the logical line that row C<$row_number> is part of. It supports the
1696following methods: 1911following methods:
1697 1912
1698=over 4 1913=over
1699 1914
1700=item $text = $line->t ([$new_text]) 1915=item $text = $line->t ([$new_text])
1701 1916
1702Returns or replaces the full text of the line, similar to C<ROW_t> 1917Returns or replaces the full text of the line, similar to C<ROW_t>
1703 1918
1807where one character corresponds to one screen cell. See 2022where one character corresponds to one screen cell. See
1808C<< $term->ROW_t >> for details. 2023C<< $term->ROW_t >> for details.
1809 2024
1810=item $string = $term->special_decode $text 2025=item $string = $term->special_decode $text
1811 2026
1812Converts rxvt-unicodes text representation into a perl string. See 2027Converts rxvt-unicode's text representation into a perl string. See
1813C<< $term->ROW_t >> for details. 2028C<< $term->ROW_t >> for details.
1814 2029
1815=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 2030=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1816 2031
1817=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 2032=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1883 2098
1884package urxvt::popup; 2099package urxvt::popup;
1885 2100
1886=head2 The C<urxvt::popup> Class 2101=head2 The C<urxvt::popup> Class
1887 2102
1888=over 4 2103=over
1889 2104
1890=cut 2105=cut
1891 2106
1892sub add_item { 2107sub add_item {
1893 my ($self, $item) = @_; 2108 my ($self, $item) = @_;
2029 ->cb (sub { 2244 ->cb (sub {
2030 $term->{overlay}->set (0, 0, 2245 $term->{overlay}->set (0, 0,
2031 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2246 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2032 }); 2247 });
2033 2248
2034=over 4 2249=over
2035 2250
2036=item $timer = new urxvt::timer 2251=item $timer = new urxvt::timer
2037 2252
2038Create a new timer object in started state. It is scheduled to fire 2253Create a new timer object in started state. It is scheduled to fire
2039immediately. 2254immediately.
2088 sysread $term->{socket}, my $buf, 8192 2303 sysread $term->{socket}, my $buf, 8192
2089 or end-of-file; 2304 or end-of-file;
2090 }); 2305 });
2091 2306
2092 2307
2093=over 4 2308=over
2094 2309
2095=item $iow = new urxvt::iow 2310=item $iow = new urxvt::iow
2096 2311
2097Create a new io watcher object in stopped state. 2312Create a new io watcher object in stopped state.
2098 2313
2125 2340
2126This class implements idle watchers, that get called automatically when 2341This class implements idle watchers, that get called automatically when
2127the process is idle. They should return as fast as possible, after doing 2342the process is idle. They should return as fast as possible, after doing
2128some useful work. 2343some useful work.
2129 2344
2130=over 4 2345=over
2131 2346
2132=item $iw = new urxvt::iw 2347=item $iw = new urxvt::iw
2133 2348
2134Create a new idle watcher object in stopped state. 2349Create a new idle watcher object in stopped state.
2135 2350
2160 ->cb (sub { 2375 ->cb (sub {
2161 my ($pw, $exit_status) = @_; 2376 my ($pw, $exit_status) = @_;
2162 ... 2377 ...
2163 }); 2378 });
2164 2379
2165=over 4 2380=over
2166 2381
2167=item $pw = new urxvt::pw 2382=item $pw = new urxvt::pw
2168 2383
2169Create a new process watcher in stopped state. 2384Create a new process watcher in stopped state.
2170 2385
2187=head2 URXVT_PERL_VERBOSITY 2402=head2 URXVT_PERL_VERBOSITY
2188 2403
2189This variable controls the verbosity level of the perl extension. Higher 2404This variable controls the verbosity level of the perl extension. Higher
2190numbers indicate more verbose output. 2405numbers indicate more verbose output.
2191 2406
2192=over 4 2407=over
2193 2408
2194=item == 0 - fatal messages 2409=item == 0 - fatal messages only
2410
2411=item >= 2 - general warnings (default level)
2195 2412
2196=item >= 3 - script loading and management 2413=item >= 3 - script loading and management
2197 2414
2198=item >=10 - all called hooks 2415=item >=10 - all called hooks
2199 2416

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines