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.235 by sf-exg, Sat May 17 15:33:24 2014 UTC vs.
Revision 1.270 by root, Fri Nov 26 18:49:47 2021 UTC

4 4
5urxvtperl - rxvt-unicode's embedded perl interpreter 5urxvtperl - rxvt-unicode's embedded perl interpreter
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 # create a file grab_test in $HOME: 9 # create a file grab_test in some directory:
10 10
11 sub on_sel_grab { 11 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
13 () 13 ()
14 } 14 }
15 15
16 # start a urxvt using it: 16 # start a urxvt instance using it:
17 17
18 urxvt --perl-lib $HOME -pe grab_test 18 urxvt --perl-lib path/to/somedirectory -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict qw(vars subs)' and 'use utf8'
26thus must be encoded as UTF-8. 26environment, and thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in urxvtd, where 28Each script will only ever be loaded once, even in urxvtd, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext" 31You can disable the embedded perl interpreter by setting both "perl-ext"
43 43
44Or by adding them to the resource for extensions loaded by default: 44Or by adding them to the resource for extensions loaded by default:
45 45
46 URxvt.perl-ext-common: default,selection-autotransform 46 URxvt.perl-ext-common: default,selection-autotransform
47 47
48Extensions 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
201
202=item on_attach $term
203
204Called when an extension package is attached to a running terminal
205instance. Must return true in all cases, and runs with the same
206limitations as C<on_init>.
207
208Unlike C<on_init> or C<on_start>, this is called when the extension is
209attached to a terminal, regardless of whether the extension is loaded
210before or after the terminal is started. Extensions that need to do
211something before they work can do it in this callback, as opposed to e.g.
212C<on_init>, which might not be called.
126 213
127=item on_init $term 214=item on_init $term
128 215
129Called after a new terminal object has been initialized, but before 216Called after a new terminal object has been initialized, but before
130windows are created or the command gets run. Most methods are unsafe to 217windows are created or the command gets run. Most methods are unsafe to
212 299
213C<on_osc_seq_perl> should be used for new behaviour. 300C<on_osc_seq_perl> should be used for new behaviour.
214 301
215=item on_osc_seq_perl $term, $args, $resp 302=item on_osc_seq_perl $term, $args, $resp
216 303
217Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 304Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
218operating system command) is processed. Cursor position and other state 305(OSC = operating system command) is processed. Cursor position and other
219information is up-to-date when this happens. For interoperability, the 306state information is up-to-date when this happens. For interoperability,
220string should start with the extension name (sans -osc) and a semicolon, 307the argument should start with the extension name (sans -osc) or some
221to distinguish it from commands for other extensions, and this might be 308other suitable prefix, and a semicolon, to distinguish it from commands
222enforced in the future. 309for other extensions.
223 310
224For example, C<overlay-osc> uses this: 311For example, C<overlay-osc> uses this:
225 312
226 sub on_osc_seq_perl { 313 sub on_osc_seq_perl {
227 my ($self, $osc, $resp) = @_; 314 my ($self, $osc, $resp) = @_;
281 368
282=item on_refresh_end $term 369=item on_refresh_end $term
283 370
284Called just after the screen gets redrawn. See C<on_refresh_begin>. 371Called just after the screen gets redrawn. See C<on_refresh_begin>.
285 372
373=item on_action $term, $string
374
375Called whenever an action is invoked for the corresponding extension
376(e.g. via a C<extension:string> builtin action bound to a key, see
377description of the B<keysym> resource in the urxvt(1) manpage). The
378event is simply the action string. Note that an action event is always
379associated to a single extension.
380
286=item on_user_command $term, $string *DEPRECATED* 381=item on_user_command $term, $string *DEPRECATED*
287 382
288Called whenever a user-configured event is being activated (e.g. via 383Called 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> 384a C<perl:string> action bound to a key, see description of the B<keysym>
290resource in the urxvt(1) manpage). 385resource in the urxvt(1) manpage).
364=cut 459=cut
365 460
366package urxvt; 461package urxvt;
367 462
368use utf8; 463use utf8;
369use strict 'vars'; 464use strict qw(vars subs);
370use Carp (); 465use Carp ();
371use Scalar::Util (); 466use Scalar::Util ();
372use List::Util (); 467use List::Util ();
373 468
374our $VERSION = 1; 469our $VERSION = 1;
386 481
387our $NOCHAR = chr 0xffff; 482our $NOCHAR = chr 0xffff;
388 483
389=head2 Variables in the C<urxvt> Package 484=head2 Variables in the C<urxvt> Package
390 485
391=over 4 486=over
392 487
393=item $urxvt::LIBDIR 488=item $urxvt::LIBDIR
394 489
395The rxvt-unicode library directory, where, among other things, the perl 490The rxvt-unicode library directory, where, among other things, the perl
396modules and scripts are stored. 491modules and scripts are stored.
426 521
427=back 522=back
428 523
429=head2 Functions in the C<urxvt> Package 524=head2 Functions in the C<urxvt> Package
430 525
431=over 4 526=over
432 527
433=item urxvt::fatal $errormessage 528=item urxvt::fatal $errormessage
434 529
435Fatally aborts execution with the given error message (which should 530Fatally aborts execution with the given error message (which should
436include a trailing newline). Avoid at all costs! The only time this 531include a trailing newline). Avoid at all costs! The only time this
481CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 576CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
482SelectionNotify, ColormapNotify, ClientMessage, MappingNotify 577SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483 578
484Various constants for use in X calls and event processing. 579Various constants for use in X calls and event processing.
485 580
581=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
582PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
583PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
584PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
585PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
586PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
587PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
588PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
589PrivMode_Default
590
591Constants for checking DEC private modes.
592
486=back 593=back
487 594
488=head2 RENDITION 595=head2 RENDITION
489 596
490Rendition bitsets contain information about colour, font, font styles and 597Rendition bitsets contain information about colour, font, font styles and
493The following "macros" deal with changes in rendition sets. You should 600The following "macros" deal with changes in rendition sets. You should
494never just create a bitset, you should always modify an existing one, 601never just create a bitset, you should always modify an existing one,
495as they contain important information required for correct operation of 602as they contain important information required for correct operation of
496rxvt-unicode. 603rxvt-unicode.
497 604
498=over 4 605=over
499 606
500=item $rend = urxvt::DEFAULT_RSTYLE 607=item $rend = urxvt::DEFAULT_RSTYLE
501 608
502Returns the default rendition, as used when the terminal is starting up or 609Returns the default rendition, as used when the terminal is starting up or
503being reset. Useful as a base to start when creating renditions. 610being reset. Useful as a base to start when creating renditions.
555no warnings 'utf8'; 662no warnings 'utf8';
556 663
557sub parse_resource { 664sub parse_resource {
558 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 665 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
559 666
560 $name =~ y/-/./ if $isarg;
561
562 $term->scan_extensions; 667 $term->scan_extensions;
563 668
669 # iterating over all resources has quadratic time overhead
670 # overall, maybe this could be optimised?
564 my $r = $term->{meta}{resource}; 671 my $r = $term->{meta}{resource};
565 keys %$r; # reset iterator 672 keys %$r; # reset iterator
566 while (my ($pattern, $v) = each %$r) { 673 while (my ($k, $v) = each %$r) {
567 if ( 674 my $pattern = $k;
675 $pattern =~ y/./-/ if $isarg;
676 my $prefix = $name;
677 my $suffix;
568 $pattern =~ /\.$/ 678 if ($pattern =~ /\-$/) {
569 ? $pattern eq substr $name, 0, length $pattern 679 $prefix = substr $name, 0, length $pattern;
570 : $pattern eq $name 680 $suffix = substr $name, length $pattern;
571 ) { 681 }
682 if ($pattern eq $prefix) {
572 $name = "$urxvt::RESCLASS.$name"; 683 $name = "$urxvt::RESCLASS.$k$suffix";
573 684
574 push @{ $term->{perl_ext_3} }, $v->[0]; 685 push @{ $term->{perl_ext_3} }, $v->[0];
686
687 return 1 unless $isarg;
575 688
576 if ($v->[1] eq "boolean") { 689 if ($v->[1] eq "boolean") {
577 $term->put_option_db ($name, $flag ? "true" : "false"); 690 $term->put_option_db ($name, $flag ? "true" : "false");
578 return 1; 691 return 1;
579 } else { 692 } else {
612 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; 725 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
613 } 726 }
614 } 727 }
615} 728}
616 729
617my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 730my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
618 731
619sub verbose { 732sub verbose {
620 my ($level, $msg) = @_; 733 my ($level, $msg) = @_;
621 warn "$msg\n" if $level <= $verbosity; 734 warn "$msg\n" if $level <= $verbosity;
622} 735}
639 752
640 open my $fh, "<:raw", $path 753 open my $fh, "<:raw", $path
641 or die "$path: $!"; 754 or die "$path: $!";
642 755
643 my $source = 756 my $source =
644 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" 757 "package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
645 . "#line 1 \"$path\"\n{\n" 758 . "#line 1 \"$path\"\n{\n"
646 . (do { local $/; <$fh> }) 759 . (do { local $/; <$fh> })
647 . "\n};\n1"; 760 . "\n};\n1";
648 761
649 eval $source 762 eval $source
659sub invoke { 772sub invoke {
660 local $TERM = shift; 773 local $TERM = shift;
661 my $htype = shift; 774 my $htype = shift;
662 775
663 if ($htype == HOOK_INIT) { 776 if ($htype == HOOK_INIT) {
664 my @dirs = $TERM->perl_libdirs;
665
666 $TERM->scan_extensions; 777 $TERM->scan_extensions;
667 778
668 my %ext_arg; 779 my %ext_arg;
669 780
670 { 781 {
676 $TERM->register_package ($_) for @pkg; 787 $TERM->register_package ($_) for @pkg;
677 } 788 }
678 789
679 for ( 790 for (
680 @{ delete $TERM->{perl_ext_3} }, 791 @{ delete $TERM->{perl_ext_3} },
681 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 792 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
682 ) { 793 ) {
683 if ($_ eq "default") { 794 if ($_ eq "default") {
795
796 $ext_arg{$_} = []
684 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 797 for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
798
799 for ($TERM->_keysym_resources) {
800 next if /^(?:string|command|builtin|builtin-string|perl)/;
801 next unless /^([A-Za-z0-9_\-]+):/;
802
803 my $ext = $1;
804
805 $ext_arg{$ext} = [];
806 }
807
685 } elsif (/^-(.*)$/) { 808 } elsif (/^-(.*)$/) { # remove from set
686 delete $ext_arg{$1}; 809 delete $ext_arg{$1};
687 } elsif (/^([^<]+)<(.*)>$/) { 810
811 } elsif (/^\/(.*)$/) { # prohibit loading
812 undef $TERM->{ext_prohibit}{$1};
813
814 } elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
815 delete $TERM->{ext_prohibit}{$1};
688 push @{ $ext_arg{$1} }, $2; 816 push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
817
689 } else { 818 } else {
690 $ext_arg{$_} ||= []; 819 verbose 2, "cannot parse extension specification '$_', ignoring.";
691 } 820 }
692 } 821 }
693 822
823 $TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
824 $TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
825
694 for my $ext (sort keys %ext_arg) { 826 for my $ext (sort keys %ext_arg) {
695 my @files = grep -f $_, map "$_/$ext", @dirs; 827 my $path = $TERM->extension_path ($ext);
696 828
697 if (@files) { 829 if (defined $path) {
698 $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); 830 $TERM->autoload_extension ($ext, $ext_arg{$ext});
699 } else { 831 } else {
700 warn "perl extension '$ext' not found in perl library search path\n"; 832 verbose 2, "perl extension '$ext' not found in perl library search path";
701 } 833 }
702 } 834 }
703 835
704 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); 836 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
705 warn $@ if $@; 837 warn $@ if $@;
838 }
839
840 if ($htype == HOOK_OSC_SEQ) {
841 if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
842 $TERM->autoload_extension ($_->[0]) for @$exts;
843 }
844 } elsif ($htype == HOOK_OSC_SEQ_PERL) {
845 if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
846 $TERM->autoload_extension ($_->[0]) for @$exts;
847 }
706 } 848 }
707 849
708 $retval = undef; 850 $retval = undef;
709 851
710 if (my $cb = $TERM->{_hook}[$htype]) { 852 if (my $cb = $TERM->{_hook}[$htype]) {
790 932
791The methods (And data members) documented below can be called on extension 933The methods (And data members) documented below can be called on extension
792objects, in addition to call methods documented for the <urxvt::term> 934objects, in addition to call methods documented for the <urxvt::term>
793class. 935class.
794 936
795=over 4 937=over
796 938
797=item $urxvt_term = $self->{term} 939=item $urxvt_term = $self->{term}
798 940
799Returns the C<urxvt::term> object associated with this instance of the 941Returns the C<urxvt::term> object associated with this instance of the
800extension. This member I<must not> be changed in any way. 942extension. This member I<must not> be changed in any way.
918 } 1060 }
919 1061
920 bless \%disable, "urxvt::extension::on_disable" 1062 bless \%disable, "urxvt::extension::on_disable"
921} 1063}
922 1064
1065=item $self->bind_action ($hotkey, $action)
1066
923=item $self->x_resource ($pattern) 1067=item $self->x_resource ($pattern)
924 1068
925=item $self->x_resource_boolean ($pattern) 1069=item $self->x_resource_boolean ($pattern)
926 1070
927These methods support an additional C<%> prefix when called on an 1071These methods support an additional C<%> prefix for C<$action> or
928extension object - see the description of these methods in the 1072C<$pattern> when called on an extension object, compared to the
1073C<urxvt::term> methods of the same name - see the description of these
929C<urxvt::term> class for details. 1074methods in the C<urxvt::term> class for details.
930 1075
931=cut 1076=cut
1077
1078sub bind_action {
1079 my ($self, $hotkey, $action) = @_;
1080 $action =~ s/^%:/$_[0]{_name}:/;
1081 $self->{term}->bind_action ($hotkey, $action)
1082}
932 1083
933sub x_resource { 1084sub x_resource {
934 my ($self, $name) = @_; 1085 my ($self, $name) = @_;
935 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 1086 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
936 $self->{term}->x_resource ($name) 1087 $self->{term}->x_resource ($name)
1032 1183
1033package urxvt::term; 1184package urxvt::term;
1034 1185
1035=head2 The C<urxvt::term> Class 1186=head2 The C<urxvt::term> Class
1036 1187
1037=over 4 1188=over
1038 1189
1039=cut 1190=cut
1040 1191
1041# find on_xxx subs in the package and register them 1192# find on_xxx subs in the package and register them
1042# as hooks 1193# as hooks
1043sub register_package { 1194sub register_package {
1044 my ($self, $pkg, $argv) = @_; 1195 my ($self, $pkg, $argv) = @_;
1196
1197 return if $self->{_pkg}{$pkg};
1045 1198
1046 no strict 'refs'; 1199 no strict 'refs';
1047 1200
1048 urxvt::verbose 6, "register package $pkg to $self"; 1201 urxvt::verbose 6, "register package $pkg to $self";
1049 1202
1061 for my $name (@HOOKNAME) { 1214 for my $name (@HOOKNAME) {
1062 if (my $ref = $pkg->can ("on_" . lc $name)) { 1215 if (my $ref = $pkg->can ("on_" . lc $name)) {
1063 $proxy->enable ($name => $ref); 1216 $proxy->enable ($name => $ref);
1064 } 1217 }
1065 } 1218 }
1219
1220 if (my $attach_hook = $pkg->can ("on_attach")) {
1221 $attach_hook->($proxy)
1222 or urxvt::verbose 1, "$pkg->on_attach returned false, extension failed to attach";
1223 }
1224}
1225
1226# map extension name to filesystem path
1227sub extension_path {
1228 (grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
1229}
1230
1231# load an extension by name
1232sub load_extension_file {
1233 my ($self, $path, $argv) = @_;
1234
1235 $self->register_package (urxvt::extension_package $path, $argv);
1236}
1237
1238# autoload an extension unless loading it is prohibited
1239sub autoload_extension {
1240 my ($self, $name, $argv) = @_;
1241
1242 return if exists $self->{ext_prohibit}{$name};
1243
1244 my $path = $self->extension_path ($name)
1245 // return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
1246
1247 $self->load_extension_file ($path, $argv);
1066} 1248}
1067 1249
1068sub perl_libdirs { 1250sub perl_libdirs {
1069 map { split /:/ } 1251 map { split /:/ }
1070 $_[0]->resource ("perl_lib"), 1252 $_[0]->resource ("perl_lib"),
1077sub scan_extensions { 1259sub scan_extensions {
1078 my ($self) = @_; 1260 my ($self) = @_;
1079 1261
1080 return if exists $self->{meta}; 1262 return if exists $self->{meta};
1081 1263
1082 my @libdirs = perl_libdirs $self; 1264 my @urxvtdirs = perl_libdirs $self;
1265# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1083 1266
1084 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1085
1086 my %meta;
1087
1088 $self->{meta_libdirs} = join "\x00", @libdirs;
1089 $self->{meta} = \%meta; 1267 $self->{meta} = \my %allmeta;
1090
1091 my %ext;
1092 1268
1093 # first gather extensions 1269 # first gather extensions
1094 for my $dir (reverse @libdirs) { 1270
1271 my $gather = sub {
1272 my ($dir, $core) = @_;
1273
1095 opendir my $fh, $dir 1274 opendir my $fh, $dir
1096 or next; 1275 or return;
1276
1097 for my $ext (readdir $fh) { 1277 for my $ext (readdir $fh) {
1098 $ext !~ /^\./ 1278 $ext !~ /^\./
1099 and open my $fh, "<", "$dir/$ext"
1100 or next; 1279 or next;
1101 1280
1281 open my $fh, "<", "$dir/$ext"
1282 or next;
1283
1284 -f $fh
1285 or next;
1286
1287 $ext =~ s/\.uext$// or $core
1288 or next;
1289
1102 my %ext = (dir => $dir); 1290 my %meta = (dir => $dir);
1103 1291
1104 while (<$fh>) { 1292 while (<$fh>) {
1105 if (/^#:META:(?:X_)?RESOURCE:(.*)/) { 1293 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1106 my ($pattern, $type, $desc) = split /:/, $1; 1294 my ($pattern, $type, $desc) = split /:/, $1;
1107 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1295 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1108 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1296 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1109 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1297 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1110 } else { 1298 } else {
1111 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1299 $meta{resource}{$pattern} = [$ext, $type, $desc];
1112 } 1300 }
1301
1113 } elsif (/^#:META:BINDING:(.*)/) { 1302 } elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1114 my ($keysym, $action) = split /:/, $1; 1303 push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1115 $ext{binding}{$keysym} = $action; 1304
1305 } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
1306 push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
1307
1116 } elsif (/^\s*(?:#|$)/) { 1308 } elsif (/^\s*(?:#|$)/) {
1117 # skip other comments and empty lines 1309 # skip other comments and empty lines
1310
1118 } else { 1311 } else {
1119 last; # stop parsing on first non-empty non-comment line 1312 last; # stop parsing on first non-empty non-comment line
1120 } 1313 }
1121 } 1314 }
1122 1315
1123 $meta{$ext} = \%ext; 1316 $allmeta{ext}{$ext} = \%meta;
1124 } 1317 }
1125 } 1318 };
1126 1319
1320# $gather->($_, 0) for @cpandirs;
1321 $gather->($_, 1) for @urxvtdirs;
1322
1127 # and now merge resources and bindings 1323 # and now merge resources
1324
1325 $allmeta{resource} = \my %resource;
1326
1128 while (my ($k, $v) = each %ext) { 1327 while (my ($k, $v) = each %{ $allmeta{ext} }) {
1129 #TODO: should check for extensions overriding each other 1328 #TODO: should check for extensions overriding each other
1130 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} }); 1329 %resource = (%resource, %{ $v->{resource} });
1131 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1132 } 1330 }
1133} 1331}
1134 1332
1135=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1333=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1136 1334
1199 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1397 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1200 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs 1398 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1201 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1399 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1202 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1400 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1203 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1401 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1204 urgentOnBell utmpInhibit visualBell 1402 urgentOnBell utmpInhibit visualBell disablePasteBrackets
1205 1403
1206=item $value = $term->resource ($name[, $newval]) 1404=item $value = $term->resource ($name[, $newval])
1207 1405
1208Returns the current resource value associated with a given name and 1406Returns the current resource value associated with a given name and
1209optionally sets a new value. Setting values is most useful in the C<init> 1407optionally sets a new value. Setting values is most useful in the C<init>
1235 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1433 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1236 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1434 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1237 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1435 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1238 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll 1436 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1239 term_name title transient_for transparent tripleclickwords urgentOnBell 1437 term_name title transient_for transparent tripleclickwords urgentOnBell
1240 utmpInhibit visualBell 1438 utmpInhibit visualBell rewrapMode disablePasteBrackets
1241 1439
1242=cut 1440=cut
1243 1441
1244sub resource($$;$) { 1442sub resource($$;$) {
1245 my ($self, $name) = (shift, shift); 1443 my ($self, $name) = (shift, shift);
1252Returns the X-Resource for the given pattern, excluding the program or 1450Returns the X-Resource for the given pattern, excluding the program or
1253class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1451class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1254same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1452same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1255resource with that pattern exists. 1453resource with that pattern exists.
1256 1454
1257Extensions that define extra resource or command line arguments also need 1455Extensions that define extra resources also need to call this method
1258to call this method to access their values. 1456to access their values.
1259 1457
1260If the method is called on an extension object (basically, from an 1458If the method is called on an extension object (basically, from an
1261extension), then the special prefix C<%.> will be replaced by the name of 1459extension), then the special prefix C<%.> will be replaced by the name of
1262the extension and a dot, and the lone string C<%> will be replaced by the 1460the extension and a dot, and the lone string C<%> will be replaced by the
1263extension name itself. This makes it possible to code extensions so you 1461extension name itself. This makes it possible to code extensions so you
1264can rename them and get a new set of commandline switches and resources 1462can rename them and get a new set of resources without having to change
1265without having to change the actual code. 1463the actual code.
1266 1464
1267This method should only be called during the C<on_start> hook, as there is 1465This method should only be called during the C<on_start> hook, as there is
1268only one resource database per display, and later invocations might return 1466only one resource database per display, and later invocations might return
1269the wrong resources. 1467the wrong resources.
1270 1468
1282 my $res = &x_resource; 1480 my $res = &x_resource;
1283 1481
1284 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1482 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1285} 1483}
1286 1484
1485=item $action = $term->lookup_keysym ($keysym, $state)
1486
1487Returns the action bound to key combination C<($keysym, $state)>,
1488if a binding for it exists, and C<undef> otherwise.
1489
1287=item $success = $term->bind_action ($key, $octets) 1490=item $success = $term->bind_action ($key, $action)
1288 1491
1289Adds a key binding exactly as specified via a C<keysym> resource. See the 1492Adds a key binding exactly as specified via a C<keysym> resource. See the
1290C<keysym> resource in the urxvt(1) manpage. 1493C<keysym> resource in the urxvt(1) manpage.
1494
1495To add default bindings for actions, an extension should call C<<
1496->bind_action >> in its C<init> hook for every such binding. Doing it
1497in the C<init> hook allows users to override or remove the binding
1498again.
1499
1500Example: the C<searchable-scrollback> by default binds itself
1501on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1502$term->bind_action >>.
1503
1504 sub init {
1505 my ($self) = @_;
1506
1507 $self->bind_action ("M-s" => "%:start");
1508 }
1291 1509
1292=item $rend = $term->rstyle ([$new_rstyle]) 1510=item $rend = $term->rstyle ([$new_rstyle])
1293 1511
1294Return and optionally change the current rendition. Text that is output by 1512Return and optionally change the current rendition. Text that is output by
1295the terminal application will use this style. 1513the terminal application will use this style.
1372This method returns an urxvt::overlay object. The overlay will be visible 1590This method returns an urxvt::overlay object. The overlay will be visible
1373as long as the perl object is referenced. 1591as long as the perl object is referenced.
1374 1592
1375The methods currently supported on C<urxvt::overlay> objects are: 1593The methods currently supported on C<urxvt::overlay> objects are:
1376 1594
1377=over 4 1595=over
1378 1596
1379=item $overlay->set ($x, $y, $text[, $rend]) 1597=item $overlay->set ($x, $y, $text[, $rend])
1380 1598
1381Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1599Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1382text in rxvt-unicode's special encoding and an array of rendition values 1600text in rxvt-unicode's special encoding and an array of rendition values
1426Returns the number of screen-cells this string would need. Correctly 1644Returns the number of screen-cells this string would need. Correctly
1427accounts for wide and combining characters. 1645accounts for wide and combining characters.
1428 1646
1429=item $octets = $term->locale_encode ($string) 1647=item $octets = $term->locale_encode ($string)
1430 1648
1431Convert the given text string into the corresponding locale encoding. 1649Convert the given text string into the corresponding locale
1650encoding. Returns C<undef> if C<$string> is C<undef>.
1432 1651
1433=item $string = $term->locale_decode ($octets) 1652=item $string = $term->locale_decode ($octets)
1434 1653
1435Convert the given locale-encoded octets into a perl string. 1654Convert the given locale-encoded octets into a perl string. Returns
1655C<undef> if C<$octets> is C<undef>.
1436 1656
1437=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1657=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1438 1658
1439XORs the rendition values in the given span with the provided value 1659XORs the rendition values in the given span with the provided value
1440(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in 1660(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1453 1673
1454=item $term->scr_add_lines ($string) 1674=item $term->scr_add_lines ($string)
1455 1675
1456Write the given text string to the screen, as if output by the application 1676Write the given text string to the screen, as if output by the application
1457running inside the terminal. It may not contain command sequences (escape 1677running inside the terminal. It may not contain command sequences (escape
1458codes), but is free to use line feeds, carriage returns and tabs. The 1678codes - see C<cmd_parse> for that), but is free to use line feeds,
1459string is a normal text string, not in locale-dependent encoding. 1679carriage returns and tabs. The string is a normal text string, not in
1680locale-dependent encoding.
1460 1681
1461Normally its not a good idea to use this function, as programs might be 1682Normally its not a good idea to use this function, as programs might be
1462confused by changes in cursor position or scrolling. Its useful inside a 1683confused by changes in cursor position or scrolling. Its useful inside a
1463C<on_add_lines> hook, though. 1684C<on_add_lines> hook, though.
1464 1685
1472locale-specific encoding of the terminal and can contain command sequences 1693locale-specific encoding of the terminal and can contain command sequences
1473(escape codes) that will be interpreted. 1694(escape codes) that will be interpreted.
1474 1695
1475=item $term->tt_write ($octets) 1696=item $term->tt_write ($octets)
1476 1697
1477Write the octets given in C<$octets> to the tty (i.e. as program input). To 1698Write the octets given in C<$octets> to the tty (i.e. as user input
1699to the program, see C<cmd_parse> for the opposite direction). To pass
1478pass characters instead of octets, you should convert your strings first 1700characters instead of octets, you should convert your strings first to the
1479to the locale-specific encoding using C<< $term->locale_encode >>. 1701locale-specific encoding using C<< $term->locale_encode >>.
1480 1702
1481=item $term->tt_write_user_input ($octets) 1703=item $term->tt_write_user_input ($octets)
1482 1704
1483Like C<tt_write>, but should be used when writing strings in response to 1705Like C<tt_write>, but should be used when writing strings in response to
1484the user pressing a key, to invokes the additional actions requested by 1706the user pressing a key, to invoke the additional actions requested by
1485the user for that case (C<tt_write> doesn't do that). 1707the user for that case (C<tt_write> doesn't do that).
1486 1708
1487The typical use case would be inside C<on_action> hooks. 1709The typical use case would be inside C<on_action> hooks.
1488 1710
1489=item $term->tt_paste ($octets) 1711=item $term->tt_paste ($octets)
1531 1753
1532=item $term->key_release ($state, $keycode[, $time]) 1754=item $term->key_release ($state, $keycode[, $time])
1533 1755
1534Deliver various fake events to to terminal. 1756Deliver various fake events to to terminal.
1535 1757
1536=item $window_width = $term->width 1758=item $window_width = $term->width ([$new_value])
1537 1759
1538=item $window_height = $term->height 1760=item $window_height = $term->height ([$new_value])
1539 1761
1540=item $font_width = $term->fwidth 1762=item $font_width = $term->fwidth ([$new_value])
1541 1763
1542=item $font_height = $term->fheight 1764=item $font_height = $term->fheight ([$new_value])
1543 1765
1544=item $font_ascent = $term->fbase 1766=item $font_ascent = $term->fbase ([$new_value])
1545 1767
1546=item $terminal_rows = $term->nrow 1768=item $terminal_rows = $term->nrow ([$new_value])
1547 1769
1548=item $terminal_columns = $term->ncol 1770=item $terminal_columns = $term->ncol ([$new_value])
1549 1771
1550=item $has_focus = $term->focus 1772=item $has_focus = $term->focus ([$new_value])
1551 1773
1552=item $is_mapped = $term->mapped 1774=item $is_mapped = $term->mapped ([$new_value])
1553 1775
1554=item $max_scrollback = $term->saveLines 1776=item $max_scrollback = $term->saveLines ([$new_value])
1555 1777
1556=item $nrow_plus_saveLines = $term->total_rows 1778=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1557 1779
1558=item $topmost_scrollback_row = $term->top_row 1780=item $topmost_scrollback_row = $term->top_row ([$new_value])
1559 1781
1560Return various integers describing terminal characteristics. 1782Return various integers describing terminal characteristics. If an
1783argument is given, changes the value and returns the previous one.
1561 1784
1562=item $x_display = $term->display_id 1785=item $x_display = $term->display_id
1563 1786
1564Return the DISPLAY used by rxvt-unicode. 1787Return the DISPLAY used by rxvt-unicode.
1565 1788
1602 1825
1603=item $cursor_is_hidden = $term->hidden_cursor 1826=item $cursor_is_hidden = $term->hidden_cursor
1604 1827
1605Returns whether the cursor is currently hidden or not. 1828Returns whether the cursor is currently hidden or not.
1606 1829
1830=item $priv_modes = $term->priv_modes
1831
1832Returns a bitset with the state of DEC private modes.
1833
1834Example:
1835
1836 if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
1837 # mouse reporting is turned on
1838 }
1839
1607=item $view_start = $term->view_start ([$newvalue]) 1840=item $view_start = $term->view_start ([$newvalue])
1608 1841
1609Returns the row number of the topmost displayed line. Maximum value is 1842Returns the row number of the topmost displayed line and changes it,
1610C<0>, which displays the normal terminal contents. Lower values scroll 1843if an argument is given. Values greater than or equal to C<0> display
1611this many lines into the scrollback buffer. 1844the terminal contents. Lower values scroll this many lines into the
1845scrollback buffer.
1612 1846
1613=item $term->want_refresh 1847=item $term->want_refresh
1614 1848
1615Requests a screen refresh. At the next opportunity, rxvt-unicode will 1849Requests a screen refresh. At the next opportunity, rxvt-unicode will
1616compare the on-screen display with its stored representation. If they 1850compare the on-screen display with its stored representation. If they
1617differ, it redraws the differences. 1851differ, it redraws the differences.
1618 1852
1619Used after changing terminal contents to display them. 1853Used after changing terminal contents to display them.
1854
1855=item $term->refresh_check
1856
1857Checks if a refresh has been requested and, if so, schedules one.
1620 1858
1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1859=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622 1860
1623Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> 1861Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1624is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost 1862is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1670 1908
1671Create and return a new C<urxvt::line> object that stores information 1909Create and return a new C<urxvt::line> object that stores information
1672about the logical line that row C<$row_number> is part of. It supports the 1910about the logical line that row C<$row_number> is part of. It supports the
1673following methods: 1911following methods:
1674 1912
1675=over 4 1913=over
1676 1914
1677=item $text = $line->t ([$new_text]) 1915=item $text = $line->t ([$new_text])
1678 1916
1679Returns or replaces the full text of the line, similar to C<ROW_t> 1917Returns or replaces the full text of the line, similar to C<ROW_t>
1680 1918
1784where one character corresponds to one screen cell. See 2022where one character corresponds to one screen cell. See
1785C<< $term->ROW_t >> for details. 2023C<< $term->ROW_t >> for details.
1786 2024
1787=item $string = $term->special_decode $text 2025=item $string = $term->special_decode $text
1788 2026
1789Converts rxvt-unicodes text representation into a perl string. See 2027Converts rxvt-unicode's text representation into a perl string. See
1790C<< $term->ROW_t >> for details. 2028C<< $term->ROW_t >> for details.
1791 2029
1792=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 2030=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1793 2031
1794=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 2032=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1860 2098
1861package urxvt::popup; 2099package urxvt::popup;
1862 2100
1863=head2 The C<urxvt::popup> Class 2101=head2 The C<urxvt::popup> Class
1864 2102
1865=over 4 2103=over
1866 2104
1867=cut 2105=cut
1868 2106
1869sub add_item { 2107sub add_item {
1870 my ($self, $item) = @_; 2108 my ($self, $item) = @_;
2006 ->cb (sub { 2244 ->cb (sub {
2007 $term->{overlay}->set (0, 0, 2245 $term->{overlay}->set (0, 0,
2008 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2246 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2009 }); 2247 });
2010 2248
2011=over 4 2249=over
2012 2250
2013=item $timer = new urxvt::timer 2251=item $timer = new urxvt::timer
2014 2252
2015Create a new timer object in started state. It is scheduled to fire 2253Create a new timer object in started state. It is scheduled to fire
2016immediately. 2254immediately.
2065 sysread $term->{socket}, my $buf, 8192 2303 sysread $term->{socket}, my $buf, 8192
2066 or end-of-file; 2304 or end-of-file;
2067 }); 2305 });
2068 2306
2069 2307
2070=over 4 2308=over
2071 2309
2072=item $iow = new urxvt::iow 2310=item $iow = new urxvt::iow
2073 2311
2074Create a new io watcher object in stopped state. 2312Create a new io watcher object in stopped state.
2075 2313
2102 2340
2103This class implements idle watchers, that get called automatically when 2341This class implements idle watchers, that get called automatically when
2104the process is idle. They should return as fast as possible, after doing 2342the process is idle. They should return as fast as possible, after doing
2105some useful work. 2343some useful work.
2106 2344
2107=over 4 2345=over
2108 2346
2109=item $iw = new urxvt::iw 2347=item $iw = new urxvt::iw
2110 2348
2111Create a new idle watcher object in stopped state. 2349Create a new idle watcher object in stopped state.
2112 2350
2137 ->cb (sub { 2375 ->cb (sub {
2138 my ($pw, $exit_status) = @_; 2376 my ($pw, $exit_status) = @_;
2139 ... 2377 ...
2140 }); 2378 });
2141 2379
2142=over 4 2380=over
2143 2381
2144=item $pw = new urxvt::pw 2382=item $pw = new urxvt::pw
2145 2383
2146Create a new process watcher in stopped state. 2384Create a new process watcher in stopped state.
2147 2385
2164=head2 URXVT_PERL_VERBOSITY 2402=head2 URXVT_PERL_VERBOSITY
2165 2403
2166This variable controls the verbosity level of the perl extension. Higher 2404This variable controls the verbosity level of the perl extension. Higher
2167numbers indicate more verbose output. 2405numbers indicate more verbose output.
2168 2406
2169=over 4 2407=over
2170 2408
2171=item == 0 - fatal messages 2409=item == 0 - fatal messages only
2410
2411=item >= 2 - general warnings (default level)
2172 2412
2173=item >= 3 - script loading and management 2413=item >= 3 - script loading and management
2174 2414
2175=item >=10 - all called hooks 2415=item >=10 - all called hooks
2176 2416

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines