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.240 by sf-exg, Fri Oct 10 14:32:32 2014 UTC vs.
Revision 1.267 by sf-exg, Sat Jul 24 12:17:08 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 that add command line parameters or resources on their own are 48Extensions may add additional resources and C<actions>, i.e., methods
49loaded automatically when used. 49which can be bound to a key and invoked by the user. An extension can
50define the resources it support using so called META comments,
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.
50 56
51=head1 API DOCUMENTATION 57=head1 API DOCUMENTATION
52 58
53=head2 General API Considerations 59=head2 General API Considerations
54 60
64terminal is destroyed. 70terminal is destroyed.
65 71
66Argument 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
67hints on what they mean: 73hints on what they mean:
68 74
69=over 4 75=over
70 76
71=item $text 77=item $text
72 78
73Rxvt-unicode's special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
74always 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.
106C<urxvt::term> class on this object. 112C<urxvt::term> class on this object.
107 113
108Additional methods only supported for extension objects are described in 114Additional methods only supported for extension objects are described in
109the C<urxvt::extension> section below. 115the C<urxvt::extension> section below.
110 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
111=head2 Hooks 186=head2 Hooks
112 187
113The following subroutines can be declared in extension files, and will be 188The following subroutines can be declared in extension files, and will be
114called whenever the relevant event happens. 189called whenever the relevant event happens.
115 190
120hooks 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
121relevant action might not be carried out by the C++ code. 196relevant action might not be carried out by the C++ code.
122 197
123I<< When in doubt, return a false value (preferably C<()>). >> 198I<< When in doubt, return a false value (preferably C<()>). >>
124 199
125=over 4 200=over
126 201
127=item on_init $term 202=item on_init $term
128 203
129Called after a new terminal object has been initialized, but before 204Called after a new terminal object has been initialized, but before
130windows are created or the command gets run. Most methods are unsafe to 205windows are created or the command gets run. Most methods are unsafe to
212 287
213C<on_osc_seq_perl> should be used for new behaviour. 288C<on_osc_seq_perl> should be used for new behaviour.
214 289
215=item on_osc_seq_perl $term, $args, $resp 290=item on_osc_seq_perl $term, $args, $resp
216 291
217Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 292Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
218operating system command) is processed. Cursor position and other state 293(OSC = operating system command) is processed. Cursor position and other
219information is up-to-date when this happens. For interoperability, the 294state information is up-to-date when this happens. For interoperability,
220string should start with the extension name (sans -osc) and a semicolon, 295the argument should start with the extension name (sans -osc) or some
221to distinguish it from commands for other extensions, and this might be 296other suitable prefix, and a semicolon, to distinguish it from commands
222enforced in the future. 297for other extensions.
223 298
224For example, C<overlay-osc> uses this: 299For example, C<overlay-osc> uses this:
225 300
226 sub on_osc_seq_perl { 301 sub on_osc_seq_perl {
227 my ($self, $osc, $resp) = @_; 302 my ($self, $osc, $resp) = @_;
281 356
282=item on_refresh_end $term 357=item on_refresh_end $term
283 358
284Called just after the screen gets redrawn. See C<on_refresh_begin>. 359Called just after the screen gets redrawn. See C<on_refresh_begin>.
285 360
361=item on_action $term, $string
362
363Called whenever an action is invoked for the corresponding extension
364(e.g. via a C<extension:string> builtin action bound to a key, see
365description of the B<keysym> resource in the urxvt(1) manpage). The
366event is simply the action string. Note that an action event is always
367associated to a single extension.
368
286=item on_user_command $term, $string *DEPRECATED* 369=item on_user_command $term, $string *DEPRECATED*
287 370
288Called whenever a user-configured event is being activated (e.g. via 371Called whenever a user-configured event is being activated (e.g. via
289a C<perl:string> action bound to a key, see description of the B<keysym> 372a C<perl:string> action bound to a key, see description of the B<keysym>
290resource in the urxvt(1) manpage). 373resource in the urxvt(1) manpage).
364=cut 447=cut
365 448
366package urxvt; 449package urxvt;
367 450
368use utf8; 451use utf8;
369use strict 'vars'; 452use strict qw(vars subs);
370use Carp (); 453use Carp ();
371use Scalar::Util (); 454use Scalar::Util ();
372use List::Util (); 455use List::Util ();
373 456
374our $VERSION = 1; 457our $VERSION = 1;
386 469
387our $NOCHAR = chr 0xffff; 470our $NOCHAR = chr 0xffff;
388 471
389=head2 Variables in the C<urxvt> Package 472=head2 Variables in the C<urxvt> Package
390 473
391=over 4 474=over
392 475
393=item $urxvt::LIBDIR 476=item $urxvt::LIBDIR
394 477
395The rxvt-unicode library directory, where, among other things, the perl 478The rxvt-unicode library directory, where, among other things, the perl
396modules and scripts are stored. 479modules and scripts are stored.
426 509
427=back 510=back
428 511
429=head2 Functions in the C<urxvt> Package 512=head2 Functions in the C<urxvt> Package
430 513
431=over 4 514=over
432 515
433=item urxvt::fatal $errormessage 516=item urxvt::fatal $errormessage
434 517
435Fatally aborts execution with the given error message (which should 518Fatally aborts execution with the given error message (which should
436include a trailing newline). Avoid at all costs! The only time this 519include a trailing newline). Avoid at all costs! The only time this
481CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 564CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
482SelectionNotify, ColormapNotify, ClientMessage, MappingNotify 565SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483 566
484Various constants for use in X calls and event processing. 567Various constants for use in X calls and event processing.
485 568
569=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
570PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
571PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
572PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
573PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
574PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
575PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
576PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
577PrivMode_Default
578
579Constants for checking DEC private modes.
580
486=back 581=back
487 582
488=head2 RENDITION 583=head2 RENDITION
489 584
490Rendition bitsets contain information about colour, font, font styles and 585Rendition bitsets contain information about colour, font, font styles and
493The following "macros" deal with changes in rendition sets. You should 588The following "macros" deal with changes in rendition sets. You should
494never just create a bitset, you should always modify an existing one, 589never just create a bitset, you should always modify an existing one,
495as they contain important information required for correct operation of 590as they contain important information required for correct operation of
496rxvt-unicode. 591rxvt-unicode.
497 592
498=over 4 593=over
499 594
500=item $rend = urxvt::DEFAULT_RSTYLE 595=item $rend = urxvt::DEFAULT_RSTYLE
501 596
502Returns the default rendition, as used when the terminal is starting up or 597Returns the default rendition, as used when the terminal is starting up or
503being reset. Useful as a base to start when creating renditions. 598being reset. Useful as a base to start when creating renditions.
555no warnings 'utf8'; 650no warnings 'utf8';
556 651
557sub parse_resource { 652sub parse_resource {
558 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 653 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
559 654
560 $name =~ y/-/./ if $isarg;
561
562 $term->scan_extensions; 655 $term->scan_extensions;
563 656
657 # iterating over all resources has quadratic time overhead
658 # overall, maybe this could be optimised?
564 my $r = $term->{meta}{resource}; 659 my $r = $term->{meta}{resource};
565 keys %$r; # reset iterator 660 keys %$r; # reset iterator
566 while (my ($pattern, $v) = each %$r) { 661 while (my ($k, $v) = each %$r) {
567 if ( 662 my $pattern = $k;
663 $pattern =~ y/./-/ if $isarg;
664 my $prefix = $name;
665 my $suffix;
568 $pattern =~ /\.$/ 666 if ($pattern =~ /\-$/) {
569 ? $pattern eq substr $name, 0, length $pattern 667 $prefix = substr $name, 0, length $pattern;
570 : $pattern eq $name 668 $suffix = substr $name, length $pattern;
571 ) { 669 }
670 if ($pattern eq $prefix) {
572 $name = "$urxvt::RESCLASS.$name"; 671 $name = "$urxvt::RESCLASS.$k$suffix";
573 672
574 push @{ $term->{perl_ext_3} }, $v->[0]; 673 push @{ $term->{perl_ext_3} }, $v->[0];
674
675 return 1 unless $isarg;
575 676
576 if ($v->[1] eq "boolean") { 677 if ($v->[1] eq "boolean") {
577 $term->put_option_db ($name, $flag ? "true" : "false"); 678 $term->put_option_db ($name, $flag ? "true" : "false");
578 return 1; 679 return 1;
579 } else { 680 } else {
612 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; 713 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
613 } 714 }
614 } 715 }
615} 716}
616 717
617my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 718my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
618 719
619sub verbose { 720sub verbose {
620 my ($level, $msg) = @_; 721 my ($level, $msg) = @_;
621 warn "$msg\n" if $level <= $verbosity; 722 warn "$msg\n" if $level <= $verbosity;
622} 723}
639 740
640 open my $fh, "<:raw", $path 741 open my $fh, "<:raw", $path
641 or die "$path: $!"; 742 or die "$path: $!";
642 743
643 my $source = 744 my $source =
644 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" 745 "package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
645 . "#line 1 \"$path\"\n{\n" 746 . "#line 1 \"$path\"\n{\n"
646 . (do { local $/; <$fh> }) 747 . (do { local $/; <$fh> })
647 . "\n};\n1"; 748 . "\n};\n1";
648 749
649 eval $source 750 eval $source
659sub invoke { 760sub invoke {
660 local $TERM = shift; 761 local $TERM = shift;
661 my $htype = shift; 762 my $htype = shift;
662 763
663 if ($htype == HOOK_INIT) { 764 if ($htype == HOOK_INIT) {
664 my @dirs = $TERM->perl_libdirs;
665
666 $TERM->scan_extensions; 765 $TERM->scan_extensions;
667 766
668 my %ext_arg; 767 my %ext_arg;
669 768
670 { 769 {
675 @TERM_EXT = (); 774 @TERM_EXT = ();
676 $TERM->register_package ($_) for @pkg; 775 $TERM->register_package ($_) for @pkg;
677 } 776 }
678 777
679 for ( 778 for (
779 @{ delete $TERM->{perl_ext_3} },
680 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 780 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
681 ) { 781 ) {
682 if ($_ eq "default") { 782 if ($_ eq "default") {
683 783
684 $ext_arg{$_} = [] 784 $ext_arg{$_} = []
685 for
686 qw(selection option-popup selection-popup readline), 785 for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
687 @{ delete $TERM->{perl_ext_3} },
688 map $_->[0], values %{ $TERM->{meta}{binding} };
689 786
690 for ($TERM->_keysym_resources) { 787 for ($TERM->_keysym_resources) {
691 next if /^(?:string|command|builtin|builtin-string|perl)/; 788 next if /^(?:string|command|builtin|builtin-string|perl)/;
692 next unless /^([A-Za-z0-9_\-]+):/; 789 next unless /^([A-Za-z0-9_\-]+):/;
693 790
694 my $ext = $1; 791 my $ext = $1;
695 792
696 $ext_arg{$ext} = []; 793 $ext_arg{$ext} = [];
697 } 794 }
698 795
699 } elsif (/^-(.*)$/) { 796 } elsif (/^-(.*)$/) { # remove from set
700 delete $ext_arg{$1}; 797 delete $ext_arg{$1};
701 798
702 } elsif (/^([^<]+)<(.*)>$/) { 799 } elsif (/^\/(.*)$/) { # prohibit loading
800 undef $TERM->{ext_prohibit}{$1};
801
802 } elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
803 delete $TERM->{ext_prohibit}{$1};
703 push @{ $ext_arg{$1} }, $2; 804 push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
704 805
705 } else { 806 } else {
706 $ext_arg{$_} ||= []; 807 verbose 2, "cannot parse extension specification '$_', ignoring.";
707 } 808 }
708 } 809 }
709 810
710 # now register default key bindings 811 $TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
812 $TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
813
711 for my $ext (sort keys %ext_arg) { 814 for my $ext (sort keys %ext_arg) {
712 while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { 815 my $path = $TERM->extension_path ($ext);
713 $TERM->bind_action ($k, "$v->[0]:$v->[1]");
714 }
715 }
716 816
717 for my $ext (sort keys %ext_arg) { 817 if (defined $path) {
718 my @files = grep -f $_, map "$_/$ext", @dirs; 818 $TERM->autoload_extension ($ext, $ext_arg{$ext});
719
720 if (@files) {
721 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
722 } else { 819 } else {
723 warn "perl extension '$ext' not found in perl library search path\n"; 820 verbose 2, "perl extension '$ext' not found in perl library search path";
724 } 821 }
725 } 822 }
726 823
727 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); 824 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
728 warn $@ if $@; 825 warn $@ if $@;
729 } 826 }
730 827
731 $retval = undef; 828 $retval = undef;
829
830 if ($htype == HOOK_OSC_SEQ) {
831 if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
832 $TERM->autoload_extension ($_->[0]) for @$exts;
833 }
834 } elsif ($htype == HOOK_OSC_SEQ_PERL) {
835 if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
836 $TERM->autoload_extension ($_->[0]) for @$exts;
837 }
838 }
732 839
733 if (my $cb = $TERM->{_hook}[$htype]) { 840 if (my $cb = $TERM->{_hook}[$htype]) {
734 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 841 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
735 if $verbosity >= 10; 842 if $verbosity >= 10;
736 843
813 920
814The methods (And data members) documented below can be called on extension 921The methods (And data members) documented below can be called on extension
815objects, in addition to call methods documented for the <urxvt::term> 922objects, in addition to call methods documented for the <urxvt::term>
816class. 923class.
817 924
818=over 4 925=over
819 926
820=item $urxvt_term = $self->{term} 927=item $urxvt_term = $self->{term}
821 928
822Returns the C<urxvt::term> object associated with this instance of the 929Returns the C<urxvt::term> object associated with this instance of the
823extension. This member I<must not> be changed in any way. 930extension. This member I<must not> be changed in any way.
941 } 1048 }
942 1049
943 bless \%disable, "urxvt::extension::on_disable" 1050 bless \%disable, "urxvt::extension::on_disable"
944} 1051}
945 1052
1053=item $self->bind_action ($hotkey, $action)
1054
946=item $self->x_resource ($pattern) 1055=item $self->x_resource ($pattern)
947 1056
948=item $self->x_resource_boolean ($pattern) 1057=item $self->x_resource_boolean ($pattern)
949 1058
950These methods support an additional C<%> prefix when called on an 1059These methods support an additional C<%> prefix for C<$action> or
951extension object - see the description of these methods in the 1060C<$pattern> when called on an extension object, compared to the
1061C<urxvt::term> methods of the same name - see the description of these
952C<urxvt::term> class for details. 1062methods in the C<urxvt::term> class for details.
953 1063
954=cut 1064=cut
1065
1066sub bind_action {
1067 my ($self, $hotkey, $action) = @_;
1068 $action =~ s/^%:/$_[0]{_name}:/;
1069 $self->{term}->bind_action ($hotkey, $action)
1070}
955 1071
956sub x_resource { 1072sub x_resource {
957 my ($self, $name) = @_; 1073 my ($self, $name) = @_;
958 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 1074 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
959 $self->{term}->x_resource ($name) 1075 $self->{term}->x_resource ($name)
1055 1171
1056package urxvt::term; 1172package urxvt::term;
1057 1173
1058=head2 The C<urxvt::term> Class 1174=head2 The C<urxvt::term> Class
1059 1175
1060=over 4 1176=over
1061 1177
1062=cut 1178=cut
1063 1179
1064# find on_xxx subs in the package and register them 1180# find on_xxx subs in the package and register them
1065# as hooks 1181# as hooks
1086 $proxy->enable ($name => $ref); 1202 $proxy->enable ($name => $ref);
1087 } 1203 }
1088 } 1204 }
1089} 1205}
1090 1206
1207# map extension name to filesystem path
1208sub extension_path {
1209 (grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
1210}
1211
1212# load an extension by name
1213sub load_extension_file {
1214 my ($self, $path, $argv) = @_;
1215
1216 $self->register_package (urxvt::extension_package $path, $argv);
1217}
1218
1219# autoload an extension unless loading it is prohibited
1220sub autoload_extension {
1221 my ($self, $name, $argv) = @_;
1222
1223 return if exists $self->{ext_prohibit}{$name};
1224
1225 my $path = $self->extension_path ($name)
1226 // return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
1227
1228 $self->load_extension_file ($path, $argv);
1229}
1230
1091sub perl_libdirs { 1231sub perl_libdirs {
1092 map { split /:/ } 1232 map { split /:/ }
1093 $_[0]->resource ("perl_lib"), 1233 $_[0]->resource ("perl_lib"),
1094 $ENV{URXVT_PERL_LIB}, 1234 $ENV{URXVT_PERL_LIB},
1095 "$ENV{HOME}/.urxvt/ext", 1235 "$ENV{HOME}/.urxvt/ext",
1100sub scan_extensions { 1240sub scan_extensions {
1101 my ($self) = @_; 1241 my ($self) = @_;
1102 1242
1103 return if exists $self->{meta}; 1243 return if exists $self->{meta};
1104 1244
1105 my @libdirs = perl_libdirs $self; 1245 my @urxvtdirs = perl_libdirs $self;
1246# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1106 1247
1107# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1108
1109# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1110 $self->{meta} = \my %meta; 1248 $self->{meta} = \my %allmeta;
1111 1249
1112 # first gather extensions 1250 # first gather extensions
1113 for my $dir (reverse @libdirs) { 1251
1252 my $gather = sub {
1253 my ($dir, $core) = @_;
1254
1114 opendir my $fh, $dir 1255 opendir my $fh, $dir
1115 or next; 1256 or return;
1257
1116 for my $ext (readdir $fh) { 1258 for my $ext (readdir $fh) {
1117 $ext !~ /^\./ 1259 $ext !~ /^\./
1118 and open my $fh, "<", "$dir/$ext"
1119 or next; 1260 or next;
1120 1261
1262 open my $fh, "<", "$dir/$ext"
1263 or next;
1264
1265 -f $fh
1266 or next;
1267
1268 $ext =~ s/\.uext$// or $core
1269 or next;
1270
1121 my %ext = (dir => $dir); 1271 my %meta = (dir => $dir);
1122 1272
1123 while (<$fh>) { 1273 while (<$fh>) {
1124 if (/^#:META:(?:X_)?RESOURCE:(.*)/) { 1274 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1125 my ($pattern, $type, $desc) = split /:/, $1; 1275 my ($pattern, $type, $desc) = split /:/, $1;
1126 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1276 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1127 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1277 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1128 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1278 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1129 } else { 1279 } else {
1130 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1280 $meta{resource}{$pattern} = [$ext, $type, $desc];
1131 } 1281 }
1282
1132 } elsif (/^#:META:BINDING:(.*)/) { 1283 } elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1133 my ($keysym, $action) = split /:/, $1; 1284 push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1134 $ext{binding}{$keysym} = [$ext, $action]; 1285
1286 } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
1287 push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
1288
1135 } elsif (/^\s*(?:#|$)/) { 1289 } elsif (/^\s*(?:#|$)/) {
1136 # skip other comments and empty lines 1290 # skip other comments and empty lines
1291
1137 } else { 1292 } else {
1138 last; # stop parsing on first non-empty non-comment line 1293 last; # stop parsing on first non-empty non-comment line
1139 } 1294 }
1140 } 1295 }
1141 1296
1142 $meta{ext}{$ext} = \%ext; 1297 $allmeta{ext}{$ext} = \%meta;
1143 } 1298 }
1144 } 1299 };
1145 1300
1301# $gather->($_, 0) for @cpandirs;
1302 $gather->($_, 1) for @urxvtdirs;
1303
1146 # and now merge resources and bindings 1304 # and now merge resources
1305
1306 $allmeta{resource} = \my %resource;
1307
1147 while (my ($k, $v) = each %{ $meta{ext} }) { 1308 while (my ($k, $v) = each %{ $allmeta{ext} }) {
1148 #TODO: should check for extensions overriding each other 1309 #TODO: should check for extensions overriding each other
1149 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); 1310 %resource = (%resource, %{ $v->{resource} });
1150 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1151 } 1311 }
1152} 1312}
1153 1313
1154=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1314=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1155 1315
1218 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1378 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1219 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs 1379 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1220 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1380 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1221 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1381 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1222 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1382 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1223 urgentOnBell utmpInhibit visualBell 1383 urgentOnBell utmpInhibit visualBell disablePasteBrackets
1224 1384
1225=item $value = $term->resource ($name[, $newval]) 1385=item $value = $term->resource ($name[, $newval])
1226 1386
1227Returns the current resource value associated with a given name and 1387Returns the current resource value associated with a given name and
1228optionally sets a new value. Setting values is most useful in the C<init> 1388optionally sets a new value. Setting values is most useful in the C<init>
1254 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1414 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1255 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1415 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1256 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1416 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1257 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll 1417 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1258 term_name title transient_for transparent tripleclickwords urgentOnBell 1418 term_name title transient_for transparent tripleclickwords urgentOnBell
1259 utmpInhibit visualBell 1419 utmpInhibit visualBell rewrapMode disablePasteBrackets
1260 1420
1261=cut 1421=cut
1262 1422
1263sub resource($$;$) { 1423sub resource($$;$) {
1264 my ($self, $name) = (shift, shift); 1424 my ($self, $name) = (shift, shift);
1271Returns the X-Resource for the given pattern, excluding the program or 1431Returns the X-Resource for the given pattern, excluding the program or
1272class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1432class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1273same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1433same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1274resource with that pattern exists. 1434resource with that pattern exists.
1275 1435
1276Extensions that define extra resource or command line arguments also need 1436Extensions that define extra resources also need to call this method
1277to call this method to access their values. 1437to access their values.
1278 1438
1279If the method is called on an extension object (basically, from an 1439If the method is called on an extension object (basically, from an
1280extension), then the special prefix C<%.> will be replaced by the name of 1440extension), then the special prefix C<%.> will be replaced by the name of
1281the extension and a dot, and the lone string C<%> will be replaced by the 1441the extension and a dot, and the lone string C<%> will be replaced by the
1282extension name itself. This makes it possible to code extensions so you 1442extension name itself. This makes it possible to code extensions so you
1283can rename them and get a new set of commandline switches and resources 1443can rename them and get a new set of resources without having to change
1284without having to change the actual code. 1444the actual code.
1285 1445
1286This method should only be called during the C<on_start> hook, as there is 1446This method should only be called during the C<on_start> hook, as there is
1287only one resource database per display, and later invocations might return 1447only one resource database per display, and later invocations might return
1288the wrong resources. 1448the wrong resources.
1289 1449
1301 my $res = &x_resource; 1461 my $res = &x_resource;
1302 1462
1303 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1463 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1304} 1464}
1305 1465
1466=item $action = $term->lookup_keysym ($keysym, $state)
1467
1468Returns the action bound to key combination C<($keysym, $state)>,
1469if a binding for it exists, and C<undef> otherwise.
1470
1306=item $success = $term->bind_action ($key, $octets) 1471=item $success = $term->bind_action ($key, $action)
1307 1472
1308Adds a key binding exactly as specified via a C<keysym> resource. See the 1473Adds a key binding exactly as specified via a C<keysym> resource. See the
1309C<keysym> resource in the urxvt(1) manpage. 1474C<keysym> resource in the urxvt(1) manpage.
1475
1476To add default bindings for actions, an extension should call C<<
1477->bind_action >> in its C<init> hook for every such binding. Doing it
1478in the C<init> hook allows users to override or remove the binding
1479again.
1480
1481Example: the C<searchable-scrollback> by default binds itself
1482on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1483$term->bind_action >>.
1484
1485 sub init {
1486 my ($self) = @_;
1487
1488 $self->bind_action ("M-s" => "%:start");
1489 }
1310 1490
1311=item $rend = $term->rstyle ([$new_rstyle]) 1491=item $rend = $term->rstyle ([$new_rstyle])
1312 1492
1313Return and optionally change the current rendition. Text that is output by 1493Return and optionally change the current rendition. Text that is output by
1314the terminal application will use this style. 1494the terminal application will use this style.
1391This method returns an urxvt::overlay object. The overlay will be visible 1571This method returns an urxvt::overlay object. The overlay will be visible
1392as long as the perl object is referenced. 1572as long as the perl object is referenced.
1393 1573
1394The methods currently supported on C<urxvt::overlay> objects are: 1574The methods currently supported on C<urxvt::overlay> objects are:
1395 1575
1396=over 4 1576=over
1397 1577
1398=item $overlay->set ($x, $y, $text[, $rend]) 1578=item $overlay->set ($x, $y, $text[, $rend])
1399 1579
1400Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1580Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1401text in rxvt-unicode's special encoding and an array of rendition values 1581text in rxvt-unicode's special encoding and an array of rendition values
1472 1652
1473=item $term->scr_add_lines ($string) 1653=item $term->scr_add_lines ($string)
1474 1654
1475Write the given text string to the screen, as if output by the application 1655Write the given text string to the screen, as if output by the application
1476running inside the terminal. It may not contain command sequences (escape 1656running inside the terminal. It may not contain command sequences (escape
1477codes), but is free to use line feeds, carriage returns and tabs. The 1657codes - see C<cmd_parse> for that), but is free to use line feeds,
1478string is a normal text string, not in locale-dependent encoding. 1658carriage returns and tabs. The string is a normal text string, not in
1659locale-dependent encoding.
1479 1660
1480Normally its not a good idea to use this function, as programs might be 1661Normally its not a good idea to use this function, as programs might be
1481confused by changes in cursor position or scrolling. Its useful inside a 1662confused by changes in cursor position or scrolling. Its useful inside a
1482C<on_add_lines> hook, though. 1663C<on_add_lines> hook, though.
1483 1664
1491locale-specific encoding of the terminal and can contain command sequences 1672locale-specific encoding of the terminal and can contain command sequences
1492(escape codes) that will be interpreted. 1673(escape codes) that will be interpreted.
1493 1674
1494=item $term->tt_write ($octets) 1675=item $term->tt_write ($octets)
1495 1676
1496Write the octets given in C<$octets> to the tty (i.e. as program input). To 1677Write the octets given in C<$octets> to the tty (i.e. as user input
1678to the program, see C<cmd_parse> for the opposite direction). To pass
1497pass characters instead of octets, you should convert your strings first 1679characters instead of octets, you should convert your strings first to the
1498to the locale-specific encoding using C<< $term->locale_encode >>. 1680locale-specific encoding using C<< $term->locale_encode >>.
1499 1681
1500=item $term->tt_write_user_input ($octets) 1682=item $term->tt_write_user_input ($octets)
1501 1683
1502Like C<tt_write>, but should be used when writing strings in response to 1684Like C<tt_write>, but should be used when writing strings in response to
1503the user pressing a key, to invoke the additional actions requested by 1685the user pressing a key, to invoke the additional actions requested by
1550 1732
1551=item $term->key_release ($state, $keycode[, $time]) 1733=item $term->key_release ($state, $keycode[, $time])
1552 1734
1553Deliver various fake events to to terminal. 1735Deliver various fake events to to terminal.
1554 1736
1555=item $window_width = $term->width 1737=item $window_width = $term->width ([$new_value])
1556 1738
1557=item $window_height = $term->height 1739=item $window_height = $term->height ([$new_value])
1558 1740
1559=item $font_width = $term->fwidth 1741=item $font_width = $term->fwidth ([$new_value])
1560 1742
1561=item $font_height = $term->fheight 1743=item $font_height = $term->fheight ([$new_value])
1562 1744
1563=item $font_ascent = $term->fbase 1745=item $font_ascent = $term->fbase ([$new_value])
1564 1746
1565=item $terminal_rows = $term->nrow 1747=item $terminal_rows = $term->nrow ([$new_value])
1566 1748
1567=item $terminal_columns = $term->ncol 1749=item $terminal_columns = $term->ncol ([$new_value])
1568 1750
1569=item $has_focus = $term->focus 1751=item $has_focus = $term->focus ([$new_value])
1570 1752
1571=item $is_mapped = $term->mapped 1753=item $is_mapped = $term->mapped ([$new_value])
1572 1754
1573=item $max_scrollback = $term->saveLines 1755=item $max_scrollback = $term->saveLines ([$new_value])
1574 1756
1575=item $nrow_plus_saveLines = $term->total_rows 1757=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1576 1758
1577=item $topmost_scrollback_row = $term->top_row 1759=item $topmost_scrollback_row = $term->top_row ([$new_value])
1578 1760
1579Return various integers describing terminal characteristics. 1761Return various integers describing terminal characteristics. If an
1762argument is given, changes the value and returns the previous one.
1580 1763
1581=item $x_display = $term->display_id 1764=item $x_display = $term->display_id
1582 1765
1583Return the DISPLAY used by rxvt-unicode. 1766Return the DISPLAY used by rxvt-unicode.
1584 1767
1621 1804
1622=item $cursor_is_hidden = $term->hidden_cursor 1805=item $cursor_is_hidden = $term->hidden_cursor
1623 1806
1624Returns whether the cursor is currently hidden or not. 1807Returns whether the cursor is currently hidden or not.
1625 1808
1809=item $priv_modes = $term->priv_modes
1810
1811Returns a bitset with the state of DEC private modes.
1812
1813Example:
1814
1815 if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
1816 # mouse reporting is turned on
1817 }
1818
1626=item $view_start = $term->view_start ([$newvalue]) 1819=item $view_start = $term->view_start ([$newvalue])
1627 1820
1628Returns the row number of the topmost displayed line. Maximum value is 1821Returns the row number of the topmost displayed line and changes it,
1629C<0>, which displays the normal terminal contents. Lower values scroll 1822if an argument is given. Values greater than or equal to C<0> display
1630this many lines into the scrollback buffer. 1823the terminal contents. Lower values scroll this many lines into the
1824scrollback buffer.
1631 1825
1632=item $term->want_refresh 1826=item $term->want_refresh
1633 1827
1634Requests a screen refresh. At the next opportunity, rxvt-unicode will 1828Requests a screen refresh. At the next opportunity, rxvt-unicode will
1635compare the on-screen display with its stored representation. If they 1829compare the on-screen display with its stored representation. If they
1636differ, it redraws the differences. 1830differ, it redraws the differences.
1637 1831
1638Used after changing terminal contents to display them. 1832Used after changing terminal contents to display them.
1833
1834=item $term->refresh_check
1835
1836Checks if a refresh has been requested and, if so, schedules one.
1639 1837
1640=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1838=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1641 1839
1642Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> 1840Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1643is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost 1841is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1689 1887
1690Create and return a new C<urxvt::line> object that stores information 1888Create and return a new C<urxvt::line> object that stores information
1691about the logical line that row C<$row_number> is part of. It supports the 1889about the logical line that row C<$row_number> is part of. It supports the
1692following methods: 1890following methods:
1693 1891
1694=over 4 1892=over
1695 1893
1696=item $text = $line->t ([$new_text]) 1894=item $text = $line->t ([$new_text])
1697 1895
1698Returns or replaces the full text of the line, similar to C<ROW_t> 1896Returns or replaces the full text of the line, similar to C<ROW_t>
1699 1897
1803where one character corresponds to one screen cell. See 2001where one character corresponds to one screen cell. See
1804C<< $term->ROW_t >> for details. 2002C<< $term->ROW_t >> for details.
1805 2003
1806=item $string = $term->special_decode $text 2004=item $string = $term->special_decode $text
1807 2005
1808Converts rxvt-unicodes text representation into a perl string. See 2006Converts rxvt-unicode's text representation into a perl string. See
1809C<< $term->ROW_t >> for details. 2007C<< $term->ROW_t >> for details.
1810 2008
1811=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 2009=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1812 2010
1813=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 2011=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1879 2077
1880package urxvt::popup; 2078package urxvt::popup;
1881 2079
1882=head2 The C<urxvt::popup> Class 2080=head2 The C<urxvt::popup> Class
1883 2081
1884=over 4 2082=over
1885 2083
1886=cut 2084=cut
1887 2085
1888sub add_item { 2086sub add_item {
1889 my ($self, $item) = @_; 2087 my ($self, $item) = @_;
2025 ->cb (sub { 2223 ->cb (sub {
2026 $term->{overlay}->set (0, 0, 2224 $term->{overlay}->set (0, 0,
2027 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2225 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2028 }); 2226 });
2029 2227
2030=over 4 2228=over
2031 2229
2032=item $timer = new urxvt::timer 2230=item $timer = new urxvt::timer
2033 2231
2034Create a new timer object in started state. It is scheduled to fire 2232Create a new timer object in started state. It is scheduled to fire
2035immediately. 2233immediately.
2084 sysread $term->{socket}, my $buf, 8192 2282 sysread $term->{socket}, my $buf, 8192
2085 or end-of-file; 2283 or end-of-file;
2086 }); 2284 });
2087 2285
2088 2286
2089=over 4 2287=over
2090 2288
2091=item $iow = new urxvt::iow 2289=item $iow = new urxvt::iow
2092 2290
2093Create a new io watcher object in stopped state. 2291Create a new io watcher object in stopped state.
2094 2292
2121 2319
2122This class implements idle watchers, that get called automatically when 2320This class implements idle watchers, that get called automatically when
2123the process is idle. They should return as fast as possible, after doing 2321the process is idle. They should return as fast as possible, after doing
2124some useful work. 2322some useful work.
2125 2323
2126=over 4 2324=over
2127 2325
2128=item $iw = new urxvt::iw 2326=item $iw = new urxvt::iw
2129 2327
2130Create a new idle watcher object in stopped state. 2328Create a new idle watcher object in stopped state.
2131 2329
2156 ->cb (sub { 2354 ->cb (sub {
2157 my ($pw, $exit_status) = @_; 2355 my ($pw, $exit_status) = @_;
2158 ... 2356 ...
2159 }); 2357 });
2160 2358
2161=over 4 2359=over
2162 2360
2163=item $pw = new urxvt::pw 2361=item $pw = new urxvt::pw
2164 2362
2165Create a new process watcher in stopped state. 2363Create a new process watcher in stopped state.
2166 2364
2183=head2 URXVT_PERL_VERBOSITY 2381=head2 URXVT_PERL_VERBOSITY
2184 2382
2185This variable controls the verbosity level of the perl extension. Higher 2383This variable controls the verbosity level of the perl extension. Higher
2186numbers indicate more verbose output. 2384numbers indicate more verbose output.
2187 2385
2188=over 4 2386=over
2189 2387
2190=item == 0 - fatal messages 2388=item == 0 - fatal messages only
2389
2390=item >= 2 - general warnings (default level)
2191 2391
2192=item >= 3 - script loading and management 2392=item >= 3 - script loading and management
2193 2393
2194=item >=10 - all called hooks 2394=item >=10 - all called hooks
2195 2395

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines