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.236 by root, Sat May 17 17:12:29 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.
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 {
676 $TERM->register_package ($_) for @pkg; 775 $TERM->register_package ($_) for @pkg;
677 } 776 }
678 777
679 for ( 778 for (
680 @{ delete $TERM->{perl_ext_3} }, 779 @{ delete $TERM->{perl_ext_3} },
681 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 780 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
682 ) { 781 ) {
683 if ($_ eq "default") { 782 if ($_ eq "default") {
684 783
685 $ext_arg{$_} ||= [] 784 $ext_arg{$_} = []
785 for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
786
787 for ($TERM->_keysym_resources) {
788 next if /^(?:string|command|builtin|builtin-string|perl)/;
789 next unless /^([A-Za-z0-9_\-]+):/;
790
791 my $ext = $1;
792
793 $ext_arg{$ext} = [];
686 for 794 }
687 qw(selection option-popup selection-popup readline),
688 map $_->[0], values %{ $TERM->{meta}{binding} };
689 795
690 } elsif (/^-(.*)$/) { 796 } elsif (/^-(.*)$/) { # remove from set
691 delete $ext_arg{$1}; 797 delete $ext_arg{$1};
692 798
693 } 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};
694 push @{ $ext_arg{$1} }, $2; 804 push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
695 805
696 } else { 806 } else {
697 $ext_arg{$_} ||= []; 807 verbose 2, "cannot parse extension specification '$_', ignoring.";
698 } 808 }
699 } 809 }
700 810
701 # now register default key bindings 811 $TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
702 while (my ($k, $v) = each %{ $TERM->{meta}{binding} }) { 812 $TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
703 $TERM->bind_action ($k, "$v->[0]:$v->[1]");
704 }
705 813
706 for my $ext (sort keys %ext_arg) { 814 for my $ext (sort keys %ext_arg) {
707 my @files = grep -f $_, map "$_/$ext", @dirs; 815 my $path = $TERM->extension_path ($ext);
708 816
709 if (@files) { 817 if (defined $path) {
710 $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); 818 $TERM->autoload_extension ($ext, $ext_arg{$ext});
711 } else { 819 } else {
712 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";
713 } 821 }
714 } 822 }
715 823
716 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");
717 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 }
718 } 836 }
719 837
720 $retval = undef; 838 $retval = undef;
721 839
722 if (my $cb = $TERM->{_hook}[$htype]) { 840 if (my $cb = $TERM->{_hook}[$htype]) {
802 920
803The methods (And data members) documented below can be called on extension 921The methods (And data members) documented below can be called on extension
804objects, in addition to call methods documented for the <urxvt::term> 922objects, in addition to call methods documented for the <urxvt::term>
805class. 923class.
806 924
807=over 4 925=over
808 926
809=item $urxvt_term = $self->{term} 927=item $urxvt_term = $self->{term}
810 928
811Returns the C<urxvt::term> object associated with this instance of the 929Returns the C<urxvt::term> object associated with this instance of the
812extension. This member I<must not> be changed in any way. 930extension. This member I<must not> be changed in any way.
930 } 1048 }
931 1049
932 bless \%disable, "urxvt::extension::on_disable" 1050 bless \%disable, "urxvt::extension::on_disable"
933} 1051}
934 1052
1053=item $self->bind_action ($hotkey, $action)
1054
935=item $self->x_resource ($pattern) 1055=item $self->x_resource ($pattern)
936 1056
937=item $self->x_resource_boolean ($pattern) 1057=item $self->x_resource_boolean ($pattern)
938 1058
939These methods support an additional C<%> prefix when called on an 1059These methods support an additional C<%> prefix for C<$action> or
940extension 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
941C<urxvt::term> class for details. 1062methods in the C<urxvt::term> class for details.
942 1063
943=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}
944 1071
945sub x_resource { 1072sub x_resource {
946 my ($self, $name) = @_; 1073 my ($self, $name) = @_;
947 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 1074 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
948 $self->{term}->x_resource ($name) 1075 $self->{term}->x_resource ($name)
1044 1171
1045package urxvt::term; 1172package urxvt::term;
1046 1173
1047=head2 The C<urxvt::term> Class 1174=head2 The C<urxvt::term> Class
1048 1175
1049=over 4 1176=over
1050 1177
1051=cut 1178=cut
1052 1179
1053# find on_xxx subs in the package and register them 1180# find on_xxx subs in the package and register them
1054# as hooks 1181# as hooks
1075 $proxy->enable ($name => $ref); 1202 $proxy->enable ($name => $ref);
1076 } 1203 }
1077 } 1204 }
1078} 1205}
1079 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
1080sub perl_libdirs { 1231sub perl_libdirs {
1081 map { split /:/ } 1232 map { split /:/ }
1082 $_[0]->resource ("perl_lib"), 1233 $_[0]->resource ("perl_lib"),
1083 $ENV{URXVT_PERL_LIB}, 1234 $ENV{URXVT_PERL_LIB},
1084 "$ENV{HOME}/.urxvt/ext", 1235 "$ENV{HOME}/.urxvt/ext",
1089sub scan_extensions { 1240sub scan_extensions {
1090 my ($self) = @_; 1241 my ($self) = @_;
1091 1242
1092 return if exists $self->{meta}; 1243 return if exists $self->{meta};
1093 1244
1094 my @libdirs = perl_libdirs $self; 1245 my @urxvtdirs = perl_libdirs $self;
1246# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1095 1247
1096# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1097
1098# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1099 $self->{meta} = \my %meta; 1248 $self->{meta} = \my %allmeta;
1100 1249
1101 # first gather extensions 1250 # first gather extensions
1102 for my $dir (reverse @libdirs) { 1251
1252 my $gather = sub {
1253 my ($dir, $core) = @_;
1254
1103 opendir my $fh, $dir 1255 opendir my $fh, $dir
1104 or next; 1256 or return;
1257
1105 for my $ext (readdir $fh) { 1258 for my $ext (readdir $fh) {
1106 $ext !~ /^\./ 1259 $ext !~ /^\./
1107 and open my $fh, "<", "$dir/$ext"
1108 or next; 1260 or next;
1109 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
1110 my %ext = (dir => $dir); 1271 my %meta = (dir => $dir);
1111 1272
1112 while (<$fh>) { 1273 while (<$fh>) {
1113 if (/^#:META:(?:X_)?RESOURCE:(.*)/) { 1274 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1114 my ($pattern, $type, $desc) = split /:/, $1; 1275 my ($pattern, $type, $desc) = split /:/, $1;
1115 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1276 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1116 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1277 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1117 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";
1118 } else { 1279 } else {
1119 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1280 $meta{resource}{$pattern} = [$ext, $type, $desc];
1120 } 1281 }
1282
1121 } elsif (/^#:META:BINDING:(.*)/) { 1283 } elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1122 my ($keysym, $action) = split /:/, $1; 1284 push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1123 $ext{binding}{$keysym} = [$ext, $action]; 1285
1286 } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
1287 push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
1288
1124 } elsif (/^\s*(?:#|$)/) { 1289 } elsif (/^\s*(?:#|$)/) {
1125 # skip other comments and empty lines 1290 # skip other comments and empty lines
1291
1126 } else { 1292 } else {
1127 last; # stop parsing on first non-empty non-comment line 1293 last; # stop parsing on first non-empty non-comment line
1128 } 1294 }
1129 } 1295 }
1130 1296
1131 $meta{ext}{$ext} = \%ext; 1297 $allmeta{ext}{$ext} = \%meta;
1132 } 1298 }
1133 } 1299 };
1134 1300
1301# $gather->($_, 0) for @cpandirs;
1302 $gather->($_, 1) for @urxvtdirs;
1303
1135 # and now merge resources and bindings 1304 # and now merge resources
1305
1306 $allmeta{resource} = \my %resource;
1307
1136 while (my ($k, $v) = each %{ $meta{ext} }) { 1308 while (my ($k, $v) = each %{ $allmeta{ext} }) {
1137 #TODO: should check for extensions overriding each other 1309 #TODO: should check for extensions overriding each other
1138 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); 1310 %resource = (%resource, %{ $v->{resource} });
1139 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1140 } 1311 }
1141} 1312}
1142 1313
1143=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1314=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1144 1315
1207 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1378 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1208 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs 1379 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1209 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1380 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1210 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1381 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1211 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1382 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1212 urgentOnBell utmpInhibit visualBell 1383 urgentOnBell utmpInhibit visualBell disablePasteBrackets
1213 1384
1214=item $value = $term->resource ($name[, $newval]) 1385=item $value = $term->resource ($name[, $newval])
1215 1386
1216Returns the current resource value associated with a given name and 1387Returns the current resource value associated with a given name and
1217optionally 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>
1243 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1414 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1244 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1415 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1245 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1416 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1246 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll 1417 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1247 term_name title transient_for transparent tripleclickwords urgentOnBell 1418 term_name title transient_for transparent tripleclickwords urgentOnBell
1248 utmpInhibit visualBell 1419 utmpInhibit visualBell rewrapMode disablePasteBrackets
1249 1420
1250=cut 1421=cut
1251 1422
1252sub resource($$;$) { 1423sub resource($$;$) {
1253 my ($self, $name) = (shift, shift); 1424 my ($self, $name) = (shift, shift);
1260Returns the X-Resource for the given pattern, excluding the program or 1431Returns the X-Resource for the given pattern, excluding the program or
1261class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1432class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1262same 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
1263resource with that pattern exists. 1434resource with that pattern exists.
1264 1435
1265Extensions that define extra resource or command line arguments also need 1436Extensions that define extra resources also need to call this method
1266to call this method to access their values. 1437to access their values.
1267 1438
1268If the method is called on an extension object (basically, from an 1439If the method is called on an extension object (basically, from an
1269extension), 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
1270the 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
1271extension name itself. This makes it possible to code extensions so you 1442extension name itself. This makes it possible to code extensions so you
1272can 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
1273without having to change the actual code. 1444the actual code.
1274 1445
1275This 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
1276only one resource database per display, and later invocations might return 1447only one resource database per display, and later invocations might return
1277the wrong resources. 1448the wrong resources.
1278 1449
1290 my $res = &x_resource; 1461 my $res = &x_resource;
1291 1462
1292 $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
1293} 1464}
1294 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
1295=item $success = $term->bind_action ($key, $octets) 1471=item $success = $term->bind_action ($key, $action)
1296 1472
1297Adds 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
1298C<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 }
1299 1490
1300=item $rend = $term->rstyle ([$new_rstyle]) 1491=item $rend = $term->rstyle ([$new_rstyle])
1301 1492
1302Return and optionally change the current rendition. Text that is output by 1493Return and optionally change the current rendition. Text that is output by
1303the terminal application will use this style. 1494the terminal application will use this style.
1380This method returns an urxvt::overlay object. The overlay will be visible 1571This method returns an urxvt::overlay object. The overlay will be visible
1381as long as the perl object is referenced. 1572as long as the perl object is referenced.
1382 1573
1383The methods currently supported on C<urxvt::overlay> objects are: 1574The methods currently supported on C<urxvt::overlay> objects are:
1384 1575
1385=over 4 1576=over
1386 1577
1387=item $overlay->set ($x, $y, $text[, $rend]) 1578=item $overlay->set ($x, $y, $text[, $rend])
1388 1579
1389Similar 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
1390text 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
1434Returns the number of screen-cells this string would need. Correctly 1625Returns the number of screen-cells this string would need. Correctly
1435accounts for wide and combining characters. 1626accounts for wide and combining characters.
1436 1627
1437=item $octets = $term->locale_encode ($string) 1628=item $octets = $term->locale_encode ($string)
1438 1629
1439Convert 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>.
1440 1632
1441=item $string = $term->locale_decode ($octets) 1633=item $string = $term->locale_decode ($octets)
1442 1634
1443Convert 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>.
1444 1637
1445=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])
1446 1639
1447XORs the rendition values in the given span with the provided value 1640XORs the rendition values in the given span with the provided value
1448(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
1461 1654
1462=item $term->scr_add_lines ($string) 1655=item $term->scr_add_lines ($string)
1463 1656
1464Write 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
1465running inside the terminal. It may not contain command sequences (escape 1658running inside the terminal. It may not contain command sequences (escape
1466codes), 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,
1467string 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.
1468 1662
1469Normally 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
1470confused by changes in cursor position or scrolling. Its useful inside a 1664confused by changes in cursor position or scrolling. Its useful inside a
1471C<on_add_lines> hook, though. 1665C<on_add_lines> hook, though.
1472 1666
1480locale-specific encoding of the terminal and can contain command sequences 1674locale-specific encoding of the terminal and can contain command sequences
1481(escape codes) that will be interpreted. 1675(escape codes) that will be interpreted.
1482 1676
1483=item $term->tt_write ($octets) 1677=item $term->tt_write ($octets)
1484 1678
1485Write 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
1486pass characters instead of octets, you should convert your strings first 1681characters instead of octets, you should convert your strings first to the
1487to the locale-specific encoding using C<< $term->locale_encode >>. 1682locale-specific encoding using C<< $term->locale_encode >>.
1488 1683
1489=item $term->tt_write_user_input ($octets) 1684=item $term->tt_write_user_input ($octets)
1490 1685
1491Like 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
1492the user pressing a key, to invokes the additional actions requested by 1687the user pressing a key, to invoke the additional actions requested by
1493the user for that case (C<tt_write> doesn't do that). 1688the user for that case (C<tt_write> doesn't do that).
1494 1689
1495The typical use case would be inside C<on_action> hooks. 1690The typical use case would be inside C<on_action> hooks.
1496 1691
1497=item $term->tt_paste ($octets) 1692=item $term->tt_paste ($octets)
1539 1734
1540=item $term->key_release ($state, $keycode[, $time]) 1735=item $term->key_release ($state, $keycode[, $time])
1541 1736
1542Deliver various fake events to to terminal. 1737Deliver various fake events to to terminal.
1543 1738
1544=item $window_width = $term->width 1739=item $window_width = $term->width ([$new_value])
1545 1740
1546=item $window_height = $term->height 1741=item $window_height = $term->height ([$new_value])
1547 1742
1548=item $font_width = $term->fwidth 1743=item $font_width = $term->fwidth ([$new_value])
1549 1744
1550=item $font_height = $term->fheight 1745=item $font_height = $term->fheight ([$new_value])
1551 1746
1552=item $font_ascent = $term->fbase 1747=item $font_ascent = $term->fbase ([$new_value])
1553 1748
1554=item $terminal_rows = $term->nrow 1749=item $terminal_rows = $term->nrow ([$new_value])
1555 1750
1556=item $terminal_columns = $term->ncol 1751=item $terminal_columns = $term->ncol ([$new_value])
1557 1752
1558=item $has_focus = $term->focus 1753=item $has_focus = $term->focus ([$new_value])
1559 1754
1560=item $is_mapped = $term->mapped 1755=item $is_mapped = $term->mapped ([$new_value])
1561 1756
1562=item $max_scrollback = $term->saveLines 1757=item $max_scrollback = $term->saveLines ([$new_value])
1563 1758
1564=item $nrow_plus_saveLines = $term->total_rows 1759=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1565 1760
1566=item $topmost_scrollback_row = $term->top_row 1761=item $topmost_scrollback_row = $term->top_row ([$new_value])
1567 1762
1568Return various integers describing terminal characteristics. 1763Return various integers describing terminal characteristics. If an
1764argument is given, changes the value and returns the previous one.
1569 1765
1570=item $x_display = $term->display_id 1766=item $x_display = $term->display_id
1571 1767
1572Return the DISPLAY used by rxvt-unicode. 1768Return the DISPLAY used by rxvt-unicode.
1573 1769
1610 1806
1611=item $cursor_is_hidden = $term->hidden_cursor 1807=item $cursor_is_hidden = $term->hidden_cursor
1612 1808
1613Returns whether the cursor is currently hidden or not. 1809Returns whether the cursor is currently hidden or not.
1614 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
1615=item $view_start = $term->view_start ([$newvalue]) 1821=item $view_start = $term->view_start ([$newvalue])
1616 1822
1617Returns the row number of the topmost displayed line. Maximum value is 1823Returns the row number of the topmost displayed line and changes it,
1618C<0>, which displays the normal terminal contents. Lower values scroll 1824if an argument is given. Values greater than or equal to C<0> display
1619this many lines into the scrollback buffer. 1825the terminal contents. Lower values scroll this many lines into the
1826scrollback buffer.
1620 1827
1621=item $term->want_refresh 1828=item $term->want_refresh
1622 1829
1623Requests a screen refresh. At the next opportunity, rxvt-unicode will 1830Requests a screen refresh. At the next opportunity, rxvt-unicode will
1624compare the on-screen display with its stored representation. If they 1831compare the on-screen display with its stored representation. If they
1625differ, it redraws the differences. 1832differ, it redraws the differences.
1626 1833
1627Used 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.
1628 1839
1629=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1840=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1630 1841
1631Returns 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 >>
1632is 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
1678 1889
1679Create and return a new C<urxvt::line> object that stores information 1890Create and return a new C<urxvt::line> object that stores information
1680about 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
1681following methods: 1892following methods:
1682 1893
1683=over 4 1894=over
1684 1895
1685=item $text = $line->t ([$new_text]) 1896=item $text = $line->t ([$new_text])
1686 1897
1687Returns 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>
1688 1899
1792where one character corresponds to one screen cell. See 2003where one character corresponds to one screen cell. See
1793C<< $term->ROW_t >> for details. 2004C<< $term->ROW_t >> for details.
1794 2005
1795=item $string = $term->special_decode $text 2006=item $string = $term->special_decode $text
1796 2007
1797Converts rxvt-unicodes text representation into a perl string. See 2008Converts rxvt-unicode's text representation into a perl string. See
1798C<< $term->ROW_t >> for details. 2009C<< $term->ROW_t >> for details.
1799 2010
1800=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 2011=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1801 2012
1802=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 2013=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1868 2079
1869package urxvt::popup; 2080package urxvt::popup;
1870 2081
1871=head2 The C<urxvt::popup> Class 2082=head2 The C<urxvt::popup> Class
1872 2083
1873=over 4 2084=over
1874 2085
1875=cut 2086=cut
1876 2087
1877sub add_item { 2088sub add_item {
1878 my ($self, $item) = @_; 2089 my ($self, $item) = @_;
2014 ->cb (sub { 2225 ->cb (sub {
2015 $term->{overlay}->set (0, 0, 2226 $term->{overlay}->set (0, 0,
2016 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2227 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2017 }); 2228 });
2018 2229
2019=over 4 2230=over
2020 2231
2021=item $timer = new urxvt::timer 2232=item $timer = new urxvt::timer
2022 2233
2023Create 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
2024immediately. 2235immediately.
2073 sysread $term->{socket}, my $buf, 8192 2284 sysread $term->{socket}, my $buf, 8192
2074 or end-of-file; 2285 or end-of-file;
2075 }); 2286 });
2076 2287
2077 2288
2078=over 4 2289=over
2079 2290
2080=item $iow = new urxvt::iow 2291=item $iow = new urxvt::iow
2081 2292
2082Create a new io watcher object in stopped state. 2293Create a new io watcher object in stopped state.
2083 2294
2110 2321
2111This class implements idle watchers, that get called automatically when 2322This class implements idle watchers, that get called automatically when
2112the 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
2113some useful work. 2324some useful work.
2114 2325
2115=over 4 2326=over
2116 2327
2117=item $iw = new urxvt::iw 2328=item $iw = new urxvt::iw
2118 2329
2119Create a new idle watcher object in stopped state. 2330Create a new idle watcher object in stopped state.
2120 2331
2145 ->cb (sub { 2356 ->cb (sub {
2146 my ($pw, $exit_status) = @_; 2357 my ($pw, $exit_status) = @_;
2147 ... 2358 ...
2148 }); 2359 });
2149 2360
2150=over 4 2361=over
2151 2362
2152=item $pw = new urxvt::pw 2363=item $pw = new urxvt::pw
2153 2364
2154Create a new process watcher in stopped state. 2365Create a new process watcher in stopped state.
2155 2366
2172=head2 URXVT_PERL_VERBOSITY 2383=head2 URXVT_PERL_VERBOSITY
2173 2384
2174This variable controls the verbosity level of the perl extension. Higher 2385This variable controls the verbosity level of the perl extension. Higher
2175numbers indicate more verbose output. 2386numbers indicate more verbose output.
2176 2387
2177=over 4 2388=over
2178 2389
2179=item == 0 - fatal messages 2390=item == 0 - fatal messages only
2391
2392=item >= 2 - general warnings (default level)
2180 2393
2181=item >= 3 - script loading and management 2394=item >= 3 - script loading and management
2182 2395
2183=item >=10 - all called hooks 2396=item >=10 - all called hooks
2184 2397

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines