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.241 by sf-exg, Fri Oct 10 14:38:02 2014 UTC vs.
Revision 1.269 by root, Sun Nov 21 15:15:02 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.
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 $term->scan_extensions; 655 $term->scan_extensions;
561 656
657 # iterating over all resources has quadratic time overhead
658 # overall, maybe this could be optimised?
562 my $r = $term->{meta}{resource}; 659 my $r = $term->{meta}{resource};
563 keys %$r; # reset iterator 660 keys %$r; # reset iterator
564 while (my ($k, $v) = each %$r) { 661 while (my ($k, $v) = each %$r) {
565 my $pattern = $k; 662 my $pattern = $k;
566 $pattern =~ y/./-/ if $isarg; 663 $pattern =~ y/./-/ if $isarg;
573 if ($pattern eq $prefix) { 670 if ($pattern eq $prefix) {
574 $name = "$urxvt::RESCLASS.$k$suffix"; 671 $name = "$urxvt::RESCLASS.$k$suffix";
575 672
576 push @{ $term->{perl_ext_3} }, $v->[0]; 673 push @{ $term->{perl_ext_3} }, $v->[0];
577 674
675 return 1 unless $isarg;
676
578 if ($v->[1] eq "boolean") { 677 if ($v->[1] eq "boolean") {
579 $term->put_option_db ($name, $flag ? "true" : "false"); 678 $term->put_option_db ($name, $flag ? "true" : "false");
580 return 1; 679 return 1;
581 } else { 680 } else {
582 $term->put_option_db ($name, $value); 681 $term->put_option_db ($name, $value);
614 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; 713 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
615 } 714 }
616 } 715 }
617} 716}
618 717
619my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 718my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
620 719
621sub verbose { 720sub verbose {
622 my ($level, $msg) = @_; 721 my ($level, $msg) = @_;
623 warn "$msg\n" if $level <= $verbosity; 722 warn "$msg\n" if $level <= $verbosity;
624} 723}
641 740
642 open my $fh, "<:raw", $path 741 open my $fh, "<:raw", $path
643 or die "$path: $!"; 742 or die "$path: $!";
644 743
645 my $source = 744 my $source =
646 "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"
647 . "#line 1 \"$path\"\n{\n" 746 . "#line 1 \"$path\"\n{\n"
648 . (do { local $/; <$fh> }) 747 . (do { local $/; <$fh> })
649 . "\n};\n1"; 748 . "\n};\n1";
650 749
651 eval $source 750 eval $source
661sub invoke { 760sub invoke {
662 local $TERM = shift; 761 local $TERM = shift;
663 my $htype = shift; 762 my $htype = shift;
664 763
665 if ($htype == HOOK_INIT) { 764 if ($htype == HOOK_INIT) {
666 my @dirs = $TERM->perl_libdirs;
667
668 $TERM->scan_extensions; 765 $TERM->scan_extensions;
669 766
670 my %ext_arg; 767 my %ext_arg;
671 768
672 { 769 {
677 @TERM_EXT = (); 774 @TERM_EXT = ();
678 $TERM->register_package ($_) for @pkg; 775 $TERM->register_package ($_) for @pkg;
679 } 776 }
680 777
681 for ( 778 for (
779 @{ delete $TERM->{perl_ext_3} },
682 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 780 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
683 ) { 781 ) {
684 if ($_ eq "default") { 782 if ($_ eq "default") {
685 783
686 $ext_arg{$_} = [] 784 $ext_arg{$_} = []
687 for
688 qw(selection option-popup selection-popup readline), 785 for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
689 @{ delete $TERM->{perl_ext_3} },
690 map $_->[0], values %{ $TERM->{meta}{binding} };
691 786
692 for ($TERM->_keysym_resources) { 787 for ($TERM->_keysym_resources) {
693 next if /^(?:string|command|builtin|builtin-string|perl)/; 788 next if /^(?:string|command|builtin|builtin-string|perl)/;
694 next unless /^([A-Za-z0-9_\-]+):/; 789 next unless /^([A-Za-z0-9_\-]+):/;
695 790
696 my $ext = $1; 791 my $ext = $1;
697 792
698 $ext_arg{$ext} = []; 793 $ext_arg{$ext} = [];
699 } 794 }
700 795
701 } elsif (/^-(.*)$/) { 796 } elsif (/^-(.*)$/) { # remove from set
702 delete $ext_arg{$1}; 797 delete $ext_arg{$1};
703 798
704 } 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};
705 push @{ $ext_arg{$1} }, $2; 804 push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
706 805
707 } else { 806 } else {
708 $ext_arg{$_} ||= []; 807 verbose 2, "cannot parse extension specification '$_', ignoring.";
709 } 808 }
710 } 809 }
711 810
712 # 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
713 for my $ext (sort keys %ext_arg) { 814 for my $ext (sort keys %ext_arg) {
714 while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) { 815 my $path = $TERM->extension_path ($ext);
715 $TERM->bind_action ($k, "$v->[0]:$v->[1]"); 816
817 if (defined $path) {
818 $TERM->autoload_extension ($ext, $ext_arg{$ext});
819 } else {
820 verbose 2, "perl extension '$ext' not found in perl library search path";
716 } 821 }
717 } 822 }
718 823
719 for my $ext (sort keys %ext_arg) {
720 my @files = grep -f $_, map "$_/$ext", @dirs;
721
722 if (@files) {
723 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
724 } else {
725 warn "perl extension '$ext' not found in perl library search path\n";
726 }
727 }
728
729 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");
730 warn $@ if $@; 825 warn $@ if $@;
826 }
827
828 if ($htype == HOOK_OSC_SEQ) {
829 if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
830 $TERM->autoload_extension ($_->[0]) for @$exts;
831 }
832 } elsif ($htype == HOOK_OSC_SEQ_PERL) {
833 if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
834 $TERM->autoload_extension ($_->[0]) for @$exts;
835 }
731 } 836 }
732 837
733 $retval = undef; 838 $retval = undef;
734 839
735 if (my $cb = $TERM->{_hook}[$htype]) { 840 if (my $cb = $TERM->{_hook}[$htype]) {
815 920
816The methods (And data members) documented below can be called on extension 921The methods (And data members) documented below can be called on extension
817objects, in addition to call methods documented for the <urxvt::term> 922objects, in addition to call methods documented for the <urxvt::term>
818class. 923class.
819 924
820=over 4 925=over
821 926
822=item $urxvt_term = $self->{term} 927=item $urxvt_term = $self->{term}
823 928
824Returns the C<urxvt::term> object associated with this instance of the 929Returns the C<urxvt::term> object associated with this instance of the
825extension. This member I<must not> be changed in any way. 930extension. This member I<must not> be changed in any way.
943 } 1048 }
944 1049
945 bless \%disable, "urxvt::extension::on_disable" 1050 bless \%disable, "urxvt::extension::on_disable"
946} 1051}
947 1052
1053=item $self->bind_action ($hotkey, $action)
1054
948=item $self->x_resource ($pattern) 1055=item $self->x_resource ($pattern)
949 1056
950=item $self->x_resource_boolean ($pattern) 1057=item $self->x_resource_boolean ($pattern)
951 1058
952These methods support an additional C<%> prefix when called on an 1059These methods support an additional C<%> prefix for C<$action> or
953extension 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
954C<urxvt::term> class for details. 1062methods in the C<urxvt::term> class for details.
955 1063
956=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}
957 1071
958sub x_resource { 1072sub x_resource {
959 my ($self, $name) = @_; 1073 my ($self, $name) = @_;
960 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 1074 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
961 $self->{term}->x_resource ($name) 1075 $self->{term}->x_resource ($name)
1057 1171
1058package urxvt::term; 1172package urxvt::term;
1059 1173
1060=head2 The C<urxvt::term> Class 1174=head2 The C<urxvt::term> Class
1061 1175
1062=over 4 1176=over
1063 1177
1064=cut 1178=cut
1065 1179
1066# find on_xxx subs in the package and register them 1180# find on_xxx subs in the package and register them
1067# as hooks 1181# as hooks
1088 $proxy->enable ($name => $ref); 1202 $proxy->enable ($name => $ref);
1089 } 1203 }
1090 } 1204 }
1091} 1205}
1092 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
1093sub perl_libdirs { 1231sub perl_libdirs {
1094 map { split /:/ } 1232 map { split /:/ }
1095 $_[0]->resource ("perl_lib"), 1233 $_[0]->resource ("perl_lib"),
1096 $ENV{URXVT_PERL_LIB}, 1234 $ENV{URXVT_PERL_LIB},
1097 "$ENV{HOME}/.urxvt/ext", 1235 "$ENV{HOME}/.urxvt/ext",
1102sub scan_extensions { 1240sub scan_extensions {
1103 my ($self) = @_; 1241 my ($self) = @_;
1104 1242
1105 return if exists $self->{meta}; 1243 return if exists $self->{meta};
1106 1244
1107 my @libdirs = perl_libdirs $self; 1245 my @urxvtdirs = perl_libdirs $self;
1246# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1108 1247
1109# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1110
1111# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1112 $self->{meta} = \my %meta; 1248 $self->{meta} = \my %allmeta;
1113 1249
1114 # first gather extensions 1250 # first gather extensions
1115 for my $dir (reverse @libdirs) { 1251
1252 my $gather = sub {
1253 my ($dir, $core) = @_;
1254
1116 opendir my $fh, $dir 1255 opendir my $fh, $dir
1117 or next; 1256 or return;
1257
1118 for my $ext (readdir $fh) { 1258 for my $ext (readdir $fh) {
1119 $ext !~ /^\./ 1259 $ext !~ /^\./
1120 and open my $fh, "<", "$dir/$ext"
1121 or next; 1260 or next;
1122 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
1123 my %ext = (dir => $dir); 1271 my %meta = (dir => $dir);
1124 1272
1125 while (<$fh>) { 1273 while (<$fh>) {
1126 if (/^#:META:(?:X_)?RESOURCE:(.*)/) { 1274 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1127 my ($pattern, $type, $desc) = split /:/, $1; 1275 my ($pattern, $type, $desc) = split /:/, $1;
1128 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1276 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1129 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1277 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1130 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";
1131 } else { 1279 } else {
1132 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1280 $meta{resource}{$pattern} = [$ext, $type, $desc];
1133 } 1281 }
1282
1134 } elsif (/^#:META:BINDING:(.*)/) { 1283 } elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1135 my ($keysym, $action) = split /:/, $1; 1284 push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1136 $ext{binding}{$keysym} = [$ext, $action]; 1285
1286 } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
1287 push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
1288
1137 } elsif (/^\s*(?:#|$)/) { 1289 } elsif (/^\s*(?:#|$)/) {
1138 # skip other comments and empty lines 1290 # skip other comments and empty lines
1291
1139 } else { 1292 } else {
1140 last; # stop parsing on first non-empty non-comment line 1293 last; # stop parsing on first non-empty non-comment line
1141 } 1294 }
1142 } 1295 }
1143 1296
1144 $meta{ext}{$ext} = \%ext; 1297 $allmeta{ext}{$ext} = \%meta;
1145 } 1298 }
1146 } 1299 };
1147 1300
1301# $gather->($_, 0) for @cpandirs;
1302 $gather->($_, 1) for @urxvtdirs;
1303
1148 # and now merge resources and bindings 1304 # and now merge resources
1305
1306 $allmeta{resource} = \my %resource;
1307
1149 while (my ($k, $v) = each %{ $meta{ext} }) { 1308 while (my ($k, $v) = each %{ $allmeta{ext} }) {
1150 #TODO: should check for extensions overriding each other 1309 #TODO: should check for extensions overriding each other
1151 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); 1310 %resource = (%resource, %{ $v->{resource} });
1152 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1153 } 1311 }
1154} 1312}
1155 1313
1156=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1314=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1157 1315
1220 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1378 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1221 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs 1379 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1222 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1380 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1223 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1381 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1224 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1382 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1225 urgentOnBell utmpInhibit visualBell 1383 urgentOnBell utmpInhibit visualBell disablePasteBrackets
1226 1384
1227=item $value = $term->resource ($name[, $newval]) 1385=item $value = $term->resource ($name[, $newval])
1228 1386
1229Returns the current resource value associated with a given name and 1387Returns the current resource value associated with a given name and
1230optionally 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>
1256 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1414 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1257 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1415 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1258 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1416 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1259 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll 1417 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1260 term_name title transient_for transparent tripleclickwords urgentOnBell 1418 term_name title transient_for transparent tripleclickwords urgentOnBell
1261 utmpInhibit visualBell 1419 utmpInhibit visualBell rewrapMode disablePasteBrackets
1262 1420
1263=cut 1421=cut
1264 1422
1265sub resource($$;$) { 1423sub resource($$;$) {
1266 my ($self, $name) = (shift, shift); 1424 my ($self, $name) = (shift, shift);
1273Returns the X-Resource for the given pattern, excluding the program or 1431Returns the X-Resource for the given pattern, excluding the program or
1274class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1432class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1275same 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
1276resource with that pattern exists. 1434resource with that pattern exists.
1277 1435
1278Extensions that define extra resource or command line arguments also need 1436Extensions that define extra resources also need to call this method
1279to call this method to access their values. 1437to access their values.
1280 1438
1281If the method is called on an extension object (basically, from an 1439If the method is called on an extension object (basically, from an
1282extension), 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
1283the 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
1284extension name itself. This makes it possible to code extensions so you 1442extension name itself. This makes it possible to code extensions so you
1285can 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
1286without having to change the actual code. 1444the actual code.
1287 1445
1288This 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
1289only one resource database per display, and later invocations might return 1447only one resource database per display, and later invocations might return
1290the wrong resources. 1448the wrong resources.
1291 1449
1303 my $res = &x_resource; 1461 my $res = &x_resource;
1304 1462
1305 $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
1306} 1464}
1307 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
1308=item $success = $term->bind_action ($key, $octets) 1471=item $success = $term->bind_action ($key, $action)
1309 1472
1310Adds 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
1311C<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 }
1312 1490
1313=item $rend = $term->rstyle ([$new_rstyle]) 1491=item $rend = $term->rstyle ([$new_rstyle])
1314 1492
1315Return and optionally change the current rendition. Text that is output by 1493Return and optionally change the current rendition. Text that is output by
1316the terminal application will use this style. 1494the terminal application will use this style.
1393This method returns an urxvt::overlay object. The overlay will be visible 1571This method returns an urxvt::overlay object. The overlay will be visible
1394as long as the perl object is referenced. 1572as long as the perl object is referenced.
1395 1573
1396The methods currently supported on C<urxvt::overlay> objects are: 1574The methods currently supported on C<urxvt::overlay> objects are:
1397 1575
1398=over 4 1576=over
1399 1577
1400=item $overlay->set ($x, $y, $text[, $rend]) 1578=item $overlay->set ($x, $y, $text[, $rend])
1401 1579
1402Similar 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
1403text 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
1447Returns the number of screen-cells this string would need. Correctly 1625Returns the number of screen-cells this string would need. Correctly
1448accounts for wide and combining characters. 1626accounts for wide and combining characters.
1449 1627
1450=item $octets = $term->locale_encode ($string) 1628=item $octets = $term->locale_encode ($string)
1451 1629
1452Convert the given text string into the corresponding locale encoding. 1630Convert the given text string into the corresponding locale
1631encoding. Returns C<undef> if C<$string> is C<undef>.
1453 1632
1454=item $string = $term->locale_decode ($octets) 1633=item $string = $term->locale_decode ($octets)
1455 1634
1456Convert the given locale-encoded octets into a perl string. 1635Convert the given locale-encoded octets into a perl string. Returns
1636C<undef> if C<$octets> is C<undef>.
1457 1637
1458=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1638=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1459 1639
1460XORs the rendition values in the given span with the provided value 1640XORs the rendition values in the given span with the provided value
1461(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in 1641(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1474 1654
1475=item $term->scr_add_lines ($string) 1655=item $term->scr_add_lines ($string)
1476 1656
1477Write the given text string to the screen, as if output by the application 1657Write the given text string to the screen, as if output by the application
1478running inside the terminal. It may not contain command sequences (escape 1658running inside the terminal. It may not contain command sequences (escape
1479codes), but is free to use line feeds, carriage returns and tabs. The 1659codes - see C<cmd_parse> for that), but is free to use line feeds,
1480string is a normal text string, not in locale-dependent encoding. 1660carriage returns and tabs. The string is a normal text string, not in
1661locale-dependent encoding.
1481 1662
1482Normally its not a good idea to use this function, as programs might be 1663Normally its not a good idea to use this function, as programs might be
1483confused by changes in cursor position or scrolling. Its useful inside a 1664confused by changes in cursor position or scrolling. Its useful inside a
1484C<on_add_lines> hook, though. 1665C<on_add_lines> hook, though.
1485 1666
1493locale-specific encoding of the terminal and can contain command sequences 1674locale-specific encoding of the terminal and can contain command sequences
1494(escape codes) that will be interpreted. 1675(escape codes) that will be interpreted.
1495 1676
1496=item $term->tt_write ($octets) 1677=item $term->tt_write ($octets)
1497 1678
1498Write the octets given in C<$octets> to the tty (i.e. as program input). To 1679Write the octets given in C<$octets> to the tty (i.e. as user input
1680to the program, see C<cmd_parse> for the opposite direction). To pass
1499pass characters instead of octets, you should convert your strings first 1681characters instead of octets, you should convert your strings first to the
1500to the locale-specific encoding using C<< $term->locale_encode >>. 1682locale-specific encoding using C<< $term->locale_encode >>.
1501 1683
1502=item $term->tt_write_user_input ($octets) 1684=item $term->tt_write_user_input ($octets)
1503 1685
1504Like C<tt_write>, but should be used when writing strings in response to 1686Like C<tt_write>, but should be used when writing strings in response to
1505the user pressing a key, to invoke the additional actions requested by 1687the user pressing a key, to invoke the additional actions requested by
1552 1734
1553=item $term->key_release ($state, $keycode[, $time]) 1735=item $term->key_release ($state, $keycode[, $time])
1554 1736
1555Deliver various fake events to to terminal. 1737Deliver various fake events to to terminal.
1556 1738
1557=item $window_width = $term->width 1739=item $window_width = $term->width ([$new_value])
1558 1740
1559=item $window_height = $term->height 1741=item $window_height = $term->height ([$new_value])
1560 1742
1561=item $font_width = $term->fwidth 1743=item $font_width = $term->fwidth ([$new_value])
1562 1744
1563=item $font_height = $term->fheight 1745=item $font_height = $term->fheight ([$new_value])
1564 1746
1565=item $font_ascent = $term->fbase 1747=item $font_ascent = $term->fbase ([$new_value])
1566 1748
1567=item $terminal_rows = $term->nrow 1749=item $terminal_rows = $term->nrow ([$new_value])
1568 1750
1569=item $terminal_columns = $term->ncol 1751=item $terminal_columns = $term->ncol ([$new_value])
1570 1752
1571=item $has_focus = $term->focus 1753=item $has_focus = $term->focus ([$new_value])
1572 1754
1573=item $is_mapped = $term->mapped 1755=item $is_mapped = $term->mapped ([$new_value])
1574 1756
1575=item $max_scrollback = $term->saveLines 1757=item $max_scrollback = $term->saveLines ([$new_value])
1576 1758
1577=item $nrow_plus_saveLines = $term->total_rows 1759=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1578 1760
1579=item $topmost_scrollback_row = $term->top_row 1761=item $topmost_scrollback_row = $term->top_row ([$new_value])
1580 1762
1581Return various integers describing terminal characteristics. 1763Return various integers describing terminal characteristics. If an
1764argument is given, changes the value and returns the previous one.
1582 1765
1583=item $x_display = $term->display_id 1766=item $x_display = $term->display_id
1584 1767
1585Return the DISPLAY used by rxvt-unicode. 1768Return the DISPLAY used by rxvt-unicode.
1586 1769
1623 1806
1624=item $cursor_is_hidden = $term->hidden_cursor 1807=item $cursor_is_hidden = $term->hidden_cursor
1625 1808
1626Returns whether the cursor is currently hidden or not. 1809Returns whether the cursor is currently hidden or not.
1627 1810
1811=item $priv_modes = $term->priv_modes
1812
1813Returns a bitset with the state of DEC private modes.
1814
1815Example:
1816
1817 if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
1818 # mouse reporting is turned on
1819 }
1820
1628=item $view_start = $term->view_start ([$newvalue]) 1821=item $view_start = $term->view_start ([$newvalue])
1629 1822
1630Returns the row number of the topmost displayed line. Maximum value is 1823Returns the row number of the topmost displayed line and changes it,
1631C<0>, which displays the normal terminal contents. Lower values scroll 1824if an argument is given. Values greater than or equal to C<0> display
1632this many lines into the scrollback buffer. 1825the terminal contents. Lower values scroll this many lines into the
1826scrollback buffer.
1633 1827
1634=item $term->want_refresh 1828=item $term->want_refresh
1635 1829
1636Requests a screen refresh. At the next opportunity, rxvt-unicode will 1830Requests a screen refresh. At the next opportunity, rxvt-unicode will
1637compare the on-screen display with its stored representation. If they 1831compare the on-screen display with its stored representation. If they
1638differ, it redraws the differences. 1832differ, it redraws the differences.
1639 1833
1640Used after changing terminal contents to display them. 1834Used after changing terminal contents to display them.
1835
1836=item $term->refresh_check
1837
1838Checks if a refresh has been requested and, if so, schedules one.
1641 1839
1642=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1840=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1643 1841
1644Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> 1842Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1645is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost 1843is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1691 1889
1692Create and return a new C<urxvt::line> object that stores information 1890Create and return a new C<urxvt::line> object that stores information
1693about the logical line that row C<$row_number> is part of. It supports the 1891about the logical line that row C<$row_number> is part of. It supports the
1694following methods: 1892following methods:
1695 1893
1696=over 4 1894=over
1697 1895
1698=item $text = $line->t ([$new_text]) 1896=item $text = $line->t ([$new_text])
1699 1897
1700Returns or replaces the full text of the line, similar to C<ROW_t> 1898Returns or replaces the full text of the line, similar to C<ROW_t>
1701 1899
1805where one character corresponds to one screen cell. See 2003where one character corresponds to one screen cell. See
1806C<< $term->ROW_t >> for details. 2004C<< $term->ROW_t >> for details.
1807 2005
1808=item $string = $term->special_decode $text 2006=item $string = $term->special_decode $text
1809 2007
1810Converts rxvt-unicodes text representation into a perl string. See 2008Converts rxvt-unicode's text representation into a perl string. See
1811C<< $term->ROW_t >> for details. 2009C<< $term->ROW_t >> for details.
1812 2010
1813=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 2011=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1814 2012
1815=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 2013=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1881 2079
1882package urxvt::popup; 2080package urxvt::popup;
1883 2081
1884=head2 The C<urxvt::popup> Class 2082=head2 The C<urxvt::popup> Class
1885 2083
1886=over 4 2084=over
1887 2085
1888=cut 2086=cut
1889 2087
1890sub add_item { 2088sub add_item {
1891 my ($self, $item) = @_; 2089 my ($self, $item) = @_;
2027 ->cb (sub { 2225 ->cb (sub {
2028 $term->{overlay}->set (0, 0, 2226 $term->{overlay}->set (0, 0,
2029 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2227 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2030 }); 2228 });
2031 2229
2032=over 4 2230=over
2033 2231
2034=item $timer = new urxvt::timer 2232=item $timer = new urxvt::timer
2035 2233
2036Create a new timer object in started state. It is scheduled to fire 2234Create a new timer object in started state. It is scheduled to fire
2037immediately. 2235immediately.
2086 sysread $term->{socket}, my $buf, 8192 2284 sysread $term->{socket}, my $buf, 8192
2087 or end-of-file; 2285 or end-of-file;
2088 }); 2286 });
2089 2287
2090 2288
2091=over 4 2289=over
2092 2290
2093=item $iow = new urxvt::iow 2291=item $iow = new urxvt::iow
2094 2292
2095Create a new io watcher object in stopped state. 2293Create a new io watcher object in stopped state.
2096 2294
2123 2321
2124This class implements idle watchers, that get called automatically when 2322This class implements idle watchers, that get called automatically when
2125the process is idle. They should return as fast as possible, after doing 2323the process is idle. They should return as fast as possible, after doing
2126some useful work. 2324some useful work.
2127 2325
2128=over 4 2326=over
2129 2327
2130=item $iw = new urxvt::iw 2328=item $iw = new urxvt::iw
2131 2329
2132Create a new idle watcher object in stopped state. 2330Create a new idle watcher object in stopped state.
2133 2331
2158 ->cb (sub { 2356 ->cb (sub {
2159 my ($pw, $exit_status) = @_; 2357 my ($pw, $exit_status) = @_;
2160 ... 2358 ...
2161 }); 2359 });
2162 2360
2163=over 4 2361=over
2164 2362
2165=item $pw = new urxvt::pw 2363=item $pw = new urxvt::pw
2166 2364
2167Create a new process watcher in stopped state. 2365Create a new process watcher in stopped state.
2168 2366
2185=head2 URXVT_PERL_VERBOSITY 2383=head2 URXVT_PERL_VERBOSITY
2186 2384
2187This variable controls the verbosity level of the perl extension. Higher 2385This variable controls the verbosity level of the perl extension. Higher
2188numbers indicate more verbose output. 2386numbers indicate more verbose output.
2189 2387
2190=over 4 2388=over
2191 2389
2192=item == 0 - fatal messages 2390=item == 0 - fatal messages only
2391
2392=item >= 2 - general warnings (default level)
2193 2393
2194=item >= 3 - script loading and management 2394=item >= 3 - script loading and management
2195 2395
2196=item >=10 - all called hooks 2396=item >=10 - all called hooks
2197 2397

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines