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.254 by sf-exg, Tue Mar 17 09:23:08 2015 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"
… …
70terminal is destroyed. 70terminal is destroyed.
71 71
72Argument 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
73hints on what they mean: 73hints on what they mean:
74 74
75=over 4 75=over
76 76
77=item $text 77=item $text
78 78
79Rxvt-unicode's special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
80always 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.
… …
115the C<urxvt::extension> section below. 115the C<urxvt::extension> section below.
116 116
117=head2 META comments 117=head2 META comments
118 118
119Rxvt-unicode recognizes special meta comments in extensions that define 119Rxvt-unicode recognizes special meta comments in extensions that define
120different types of metadata. 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.
121 123
122Currently, it recognises only one such comment: 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.
123 127
124=over 4 128=over
125 129
126=item #:META:RESOURCE:name:type:desc 130=item #:META:RESOURCE:name:type:desc
127 131
128The RESOURCE comment defines a resource used by the extension, where 132The RESOURCE comment defines a resource used by the extension, where
129C<name> is the resource name, C<type> is the resource type, C<boolean> 133C<name> is the resource name, C<type> is the resource type, C<boolean>
130or C<string>, and C<desc> is the resource description. 134or C<string>, and C<desc> is the resource description.
131 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
132=back 184=back
133 185
134=head2 Hooks 186=head2 Hooks
135 187
136The following subroutines can be declared in extension files, and will be 188The following subroutines can be declared in extension files, and will be
… …
143hooks 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
144relevant action might not be carried out by the C++ code. 196relevant action might not be carried out by the C++ code.
145 197
146I<< When in doubt, return a false value (preferably C<()>). >> 198I<< When in doubt, return a false value (preferably C<()>). >>
147 199
148=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.
149 213
150=item on_init $term 214=item on_init $term
151 215
152Called after a new terminal object has been initialized, but before 216Called after a new terminal object has been initialized, but before
153windows 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
… …
235 299
236C<on_osc_seq_perl> should be used for new behaviour. 300C<on_osc_seq_perl> should be used for new behaviour.
237 301
238=item on_osc_seq_perl $term, $args, $resp 302=item on_osc_seq_perl $term, $args, $resp
239 303
240Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 304Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
241operating system command) is processed. Cursor position and other state 305(OSC = operating system command) is processed. Cursor position and other
242information is up-to-date when this happens. For interoperability, the 306state information is up-to-date when this happens. For interoperability,
243string should start with the extension name (sans -osc) and a semicolon, 307the argument should start with the extension name (sans -osc) or some
244to distinguish it from commands for other extensions, and this might be 308other suitable prefix, and a semicolon, to distinguish it from commands
245enforced in the future. 309for other extensions.
246 310
247For example, C<overlay-osc> uses this: 311For example, C<overlay-osc> uses this:
248 312
249 sub on_osc_seq_perl { 313 sub on_osc_seq_perl {
250 my ($self, $osc, $resp) = @_; 314 my ($self, $osc, $resp) = @_;
… …
395=cut 459=cut
396 460
397package urxvt; 461package urxvt;
398 462
399use utf8; 463use utf8;
400use strict 'vars'; 464use strict qw(vars subs);
401use Carp (); 465use Carp ();
402use Scalar::Util (); 466use Scalar::Util ();
403use List::Util (); 467use List::Util ();
404 468
405our $VERSION = 1; 469our $VERSION = 1;
… …
417 481
418our $NOCHAR = chr 0xffff; 482our $NOCHAR = chr 0xffff;
419 483
420=head2 Variables in the C<urxvt> Package 484=head2 Variables in the C<urxvt> Package
421 485
422=over 4 486=over
423 487
424=item $urxvt::LIBDIR 488=item $urxvt::LIBDIR
425 489
426The rxvt-unicode library directory, where, among other things, the perl 490The rxvt-unicode library directory, where, among other things, the perl
427modules and scripts are stored. 491modules and scripts are stored.
… …
457 521
458=back 522=back
459 523
460=head2 Functions in the C<urxvt> Package 524=head2 Functions in the C<urxvt> Package
461 525
462=over 4 526=over
463 527
464=item urxvt::fatal $errormessage 528=item urxvt::fatal $errormessage
465 529
466Fatally aborts execution with the given error message (which should 530Fatally aborts execution with the given error message (which should
467include a trailing newline). Avoid at all costs! The only time this 531include a trailing newline). Avoid at all costs! The only time this
… …
512CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 576CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
513SelectionNotify, ColormapNotify, ClientMessage, MappingNotify 577SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
514 578
515Various constants for use in X calls and event processing. 579Various constants for use in X calls and event processing.
516 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
517=back 593=back
518 594
519=head2 RENDITION 595=head2 RENDITION
520 596
521Rendition bitsets contain information about colour, font, font styles and 597Rendition bitsets contain information about colour, font, font styles and
… …
524The following "macros" deal with changes in rendition sets. You should 600The following "macros" deal with changes in rendition sets. You should
525never just create a bitset, you should always modify an existing one, 601never just create a bitset, you should always modify an existing one,
526as they contain important information required for correct operation of 602as they contain important information required for correct operation of
527rxvt-unicode. 603rxvt-unicode.
528 604
529=over 4 605=over
530 606
531=item $rend = urxvt::DEFAULT_RSTYLE 607=item $rend = urxvt::DEFAULT_RSTYLE
532 608
533Returns 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
534being reset. Useful as a base to start when creating renditions. 610being reset. Useful as a base to start when creating renditions.
… …
588sub parse_resource { 664sub parse_resource {
589 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 665 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
590 666
591 $term->scan_extensions; 667 $term->scan_extensions;
592 668
669 # iterating over all resources has quadratic time overhead
670 # overall, maybe this could be optimised?
593 my $r = $term->{meta}{resource}; 671 my $r = $term->{meta}{resource};
594 keys %$r; # reset iterator 672 keys %$r; # reset iterator
595 while (my ($k, $v) = each %$r) { 673 while (my ($k, $v) = each %$r) {
596 my $pattern = $k; 674 my $pattern = $k;
597 $pattern =~ y/./-/ if $isarg; 675 $pattern =~ y/./-/ if $isarg;
… …
604 if ($pattern eq $prefix) { 682 if ($pattern eq $prefix) {
605 $name = "$urxvt::RESCLASS.$k$suffix"; 683 $name = "$urxvt::RESCLASS.$k$suffix";
606 684
607 push @{ $term->{perl_ext_3} }, $v->[0]; 685 push @{ $term->{perl_ext_3} }, $v->[0];
608 686
687 return 1 unless $isarg;
688
609 if ($v->[1] eq "boolean") { 689 if ($v->[1] eq "boolean") {
610 $term->put_option_db ($name, $flag ? "true" : "false"); 690 $term->put_option_db ($name, $flag ? "true" : "false");
611 return 1; 691 return 1;
612 } else { 692 } else {
613 $term->put_option_db ($name, $value); 693 $term->put_option_db ($name, $value);
… …
645 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; 725 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
646 } 726 }
647 } 727 }
648} 728}
649 729
650my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 730my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
651 731
652sub verbose { 732sub verbose {
653 my ($level, $msg) = @_; 733 my ($level, $msg) = @_;
654 warn "$msg\n" if $level <= $verbosity; 734 warn "$msg\n" if $level <= $verbosity;
655} 735}
… …
672 752
673 open my $fh, "<:raw", $path 753 open my $fh, "<:raw", $path
674 or die "$path: $!"; 754 or die "$path: $!";
675 755
676 my $source = 756 my $source =
677 "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"
678 . "#line 1 \"$path\"\n{\n" 758 . "#line 1 \"$path\"\n{\n"
679 . (do { local $/; <$fh> }) 759 . (do { local $/; <$fh> })
680 . "\n};\n1"; 760 . "\n};\n1";
681 761
682 eval $source 762 eval $source
… …
692sub invoke { 772sub invoke {
693 local $TERM = shift; 773 local $TERM = shift;
694 my $htype = shift; 774 my $htype = shift;
695 775
696 if ($htype == HOOK_INIT) { 776 if ($htype == HOOK_INIT) {
697 my @dirs = $TERM->perl_libdirs;
698
699 $TERM->scan_extensions; 777 $TERM->scan_extensions;
700 778
701 my %ext_arg; 779 my %ext_arg;
702 780
703 { 781 {
… …
708 @TERM_EXT = (); 786 @TERM_EXT = ();
709 $TERM->register_package ($_) for @pkg; 787 $TERM->register_package ($_) for @pkg;
710 } 788 }
711 789
712 for ( 790 for (
791 @{ delete $TERM->{perl_ext_3} },
713 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), 792 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
714 @{ delete $TERM->{perl_ext_3} }
715 ) { 793 ) {
716 if ($_ eq "default") { 794 if ($_ eq "default") {
717 795
718 $ext_arg{$_} = [] 796 $ext_arg{$_} = []
719 for qw(selection option-popup selection-popup readline searchable-scrollback); 797 for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
720 798
721 for ($TERM->_keysym_resources) { 799 for ($TERM->_keysym_resources) {
722 next if /^(?:string|command|builtin|builtin-string|perl)/; 800 next if /^(?:string|command|builtin|builtin-string|perl)/;
723 next unless /^([A-Za-z0-9_\-]+):/; 801 next unless /^([A-Za-z0-9_\-]+):/;
724 802
725 my $ext = $1; 803 my $ext = $1;
726 804
727 $ext_arg{$ext} = []; 805 $ext_arg{$ext} = [];
728 } 806 }
729 807
730 } elsif (/^-(.*)$/) { 808 } elsif (/^-(.*)$/) { # remove from set
731 delete $ext_arg{$1}; 809 delete $ext_arg{$1};
732 810
733 } elsif (/^([^<]+)<(.*)>$/) { 811 } elsif (/^\/(.*)$/) { # prohibit loading
812 undef $TERM->{ext_prohibit}{$1};
813
814 } elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
815 delete $TERM->{ext_prohibit}{$1};
734 push @{ $ext_arg{$1} }, $2; 816 push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
735 817
736 } else { 818 } else {
737 $ext_arg{$_} ||= []; 819 verbose 2, "cannot parse extension specification '$_', ignoring.";
738 } 820 }
739 } 821 }
740 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
741 for my $ext (sort keys %ext_arg) { 826 for my $ext (sort keys %ext_arg) {
742 my @files = grep -f $_, map "$_/$ext", @dirs; 827 my $path = $TERM->extension_path ($ext);
743 828
744 if (@files) { 829 if (defined $path) {
745 $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); 830 $TERM->autoload_extension ($ext, $ext_arg{$ext});
746 } else { 831 } else {
747 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";
748 } 833 }
749 } 834 }
750 835
751 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");
752 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 }
753 } 848 }
754 849
755 $retval = undef; 850 $retval = undef;
756 851
757 if (my $cb = $TERM->{_hook}[$htype]) { 852 if (my $cb = $TERM->{_hook}[$htype]) {
… …
837 932
838The methods (And data members) documented below can be called on extension 933The methods (And data members) documented below can be called on extension
839objects, in addition to call methods documented for the <urxvt::term> 934objects, in addition to call methods documented for the <urxvt::term>
840class. 935class.
841 936
842=over 4 937=over
843 938
844=item $urxvt_term = $self->{term} 939=item $urxvt_term = $self->{term}
845 940
846Returns the C<urxvt::term> object associated with this instance of the 941Returns the C<urxvt::term> object associated with this instance of the
847extension. This member I<must not> be changed in any way. 942extension. This member I<must not> be changed in any way.
… …
1088 1183
1089package urxvt::term; 1184package urxvt::term;
1090 1185
1091=head2 The C<urxvt::term> Class 1186=head2 The C<urxvt::term> Class
1092 1187
1093=over 4 1188=over
1094 1189
1095=cut 1190=cut
1096 1191
1097# find on_xxx subs in the package and register them 1192# find on_xxx subs in the package and register them
1098# as hooks 1193# as hooks
1099sub register_package { 1194sub register_package {
1100 my ($self, $pkg, $argv) = @_; 1195 my ($self, $pkg, $argv) = @_;
1196
1197 return if $self->{_pkg}{$pkg};
1101 1198
1102 no strict 'refs'; 1199 no strict 'refs';
1103 1200
1104 urxvt::verbose 6, "register package $pkg to $self"; 1201 urxvt::verbose 6, "register package $pkg to $self";
1105 1202
… …
1117 for my $name (@HOOKNAME) { 1214 for my $name (@HOOKNAME) {
1118 if (my $ref = $pkg->can ("on_" . lc $name)) { 1215 if (my $ref = $pkg->can ("on_" . lc $name)) {
1119 $proxy->enable ($name => $ref); 1216 $proxy->enable ($name => $ref);
1120 } 1217 }
1121 } 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);
1122} 1248}
1123 1249
1124sub perl_libdirs { 1250sub perl_libdirs {
1125 map { split /:/ } 1251 map { split /:/ }
1126 $_[0]->resource ("perl_lib"), 1252 $_[0]->resource ("perl_lib"),
… …
1136 return if exists $self->{meta}; 1262 return if exists $self->{meta};
1137 1263
1138 my @urxvtdirs = perl_libdirs $self; 1264 my @urxvtdirs = perl_libdirs $self;
1139# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; 1265# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1140 1266
1141 $self->{meta} = \my %meta; 1267 $self->{meta} = \my %allmeta;
1142 1268
1143 # first gather extensions 1269 # first gather extensions
1144 1270
1145 my $gather = sub { 1271 my $gather = sub {
1146 my ($dir, $core) = @_; 1272 my ($dir, $core) = @_;
… …
1159 or next; 1285 or next;
1160 1286
1161 $ext =~ s/\.uext$// or $core 1287 $ext =~ s/\.uext$// or $core
1162 or next; 1288 or next;
1163 1289
1164 my %ext = (dir => $dir); 1290 my %meta = (dir => $dir);
1165 1291
1166 while (<$fh>) { 1292 while (<$fh>) {
1167 if (/^#:META:(?:X_)?RESOURCE:(.*)/) { 1293 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1168 my ($pattern, $type, $desc) = split /:/, $1; 1294 my ($pattern, $type, $desc) = split /:/, $1;
1169 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1295 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1170 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1296 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1171 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";
1172 } else { 1298 } else {
1173 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1299 $meta{resource}{$pattern} = [$ext, $type, $desc];
1174 } 1300 }
1301
1302 } elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1303 push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1304
1305 } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
1306 push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
1307
1175 } elsif (/^\s*(?:#|$)/) { 1308 } elsif (/^\s*(?:#|$)/) {
1176 # skip other comments and empty lines 1309 # skip other comments and empty lines
1310
1177 } else { 1311 } else {
1178 last; # stop parsing on first non-empty non-comment line 1312 last; # stop parsing on first non-empty non-comment line
1179 } 1313 }
1180 } 1314 }
1181 1315
1182 $meta{ext}{$ext} = \%ext; 1316 $allmeta{ext}{$ext} = \%meta;
1183 } 1317 }
1184 }; 1318 };
1185 1319
1186# $gather->($_, 0) for @cpandirs; 1320# $gather->($_, 0) for @cpandirs;
1187 $gather->($_, 1) for @urxvtdirs; 1321 $gather->($_, 1) for @urxvtdirs;
1188 1322
1189 # and now merge resources 1323 # and now merge resources
1190 1324
1191 $meta{resource} = \my %resource; 1325 $allmeta{resource} = \my %resource;
1192 1326
1193 while (my ($k, $v) = each %{ $meta{ext} }) { 1327 while (my ($k, $v) = each %{ $allmeta{ext} }) {
1194 #TODO: should check for extensions overriding each other 1328 #TODO: should check for extensions overriding each other
1195 %resource = (%resource, %{ $v->{resource} }); 1329 %resource = (%resource, %{ $v->{resource} });
1196 } 1330 }
1197} 1331}
1198 1332
… …
1263 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1397 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs 1398 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1265 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1399 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1400 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1401 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1268 urgentOnBell utmpInhibit visualBell 1402 urgentOnBell utmpInhibit visualBell disablePasteBrackets
1269 1403
1270=item $value = $term->resource ($name[, $newval]) 1404=item $value = $term->resource ($name[, $newval])
1271 1405
1272Returns the current resource value associated with a given name and 1406Returns the current resource value associated with a given name and
1273optionally 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>
… …
1299 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1433 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1300 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1434 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1301 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1435 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1302 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll 1436 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1303 term_name title transient_for transparent tripleclickwords urgentOnBell 1437 term_name title transient_for transparent tripleclickwords urgentOnBell
1304 utmpInhibit visualBell 1438 utmpInhibit visualBell rewrapMode disablePasteBrackets
1305 1439
1306=cut 1440=cut
1307 1441
1308sub resource($$;$) { 1442sub resource($$;$) {
1309 my ($self, $name) = (shift, shift); 1443 my ($self, $name) = (shift, shift);
… …
1456This method returns an urxvt::overlay object. The overlay will be visible 1590This method returns an urxvt::overlay object. The overlay will be visible
1457as long as the perl object is referenced. 1591as long as the perl object is referenced.
1458 1592
1459The methods currently supported on C<urxvt::overlay> objects are: 1593The methods currently supported on C<urxvt::overlay> objects are:
1460 1594
1461=over 4 1595=over
1462 1596
1463=item $overlay->set ($x, $y, $text[, $rend]) 1597=item $overlay->set ($x, $y, $text[, $rend])
1464 1598
1465Similar 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
1466text 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
… …
1510Returns the number of screen-cells this string would need. Correctly 1644Returns the number of screen-cells this string would need. Correctly
1511accounts for wide and combining characters. 1645accounts for wide and combining characters.
1512 1646
1513=item $octets = $term->locale_encode ($string) 1647=item $octets = $term->locale_encode ($string)
1514 1648
1515Convert 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>.
1516 1651
1517=item $string = $term->locale_decode ($octets) 1652=item $string = $term->locale_decode ($octets)
1518 1653
1519Convert 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>.
1520 1656
1521=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])
1522 1658
1523XORs the rendition values in the given span with the provided value 1659XORs the rendition values in the given span with the provided value
1524(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
… …
1617 1753
1618=item $term->key_release ($state, $keycode[, $time]) 1754=item $term->key_release ($state, $keycode[, $time])
1619 1755
1620Deliver various fake events to to terminal. 1756Deliver various fake events to to terminal.
1621 1757
1622=item $window_width = $term->width 1758=item $window_width = $term->width ([$new_value])
1623 1759
1624=item $window_height = $term->height 1760=item $window_height = $term->height ([$new_value])
1625 1761
1626=item $font_width = $term->fwidth 1762=item $font_width = $term->fwidth ([$new_value])
1627 1763
1628=item $font_height = $term->fheight 1764=item $font_height = $term->fheight ([$new_value])
1629 1765
1630=item $font_ascent = $term->fbase 1766=item $font_ascent = $term->fbase ([$new_value])
1631 1767
1632=item $terminal_rows = $term->nrow 1768=item $terminal_rows = $term->nrow ([$new_value])
1633 1769
1634=item $terminal_columns = $term->ncol 1770=item $terminal_columns = $term->ncol ([$new_value])
1635 1771
1636=item $has_focus = $term->focus 1772=item $has_focus = $term->focus ([$new_value])
1637 1773
1638=item $is_mapped = $term->mapped 1774=item $is_mapped = $term->mapped ([$new_value])
1639 1775
1640=item $max_scrollback = $term->saveLines 1776=item $max_scrollback = $term->saveLines ([$new_value])
1641 1777
1642=item $nrow_plus_saveLines = $term->total_rows 1778=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1643 1779
1644=item $topmost_scrollback_row = $term->top_row 1780=item $topmost_scrollback_row = $term->top_row ([$new_value])
1645 1781
1646Return various integers describing terminal characteristics. 1782Return various integers describing terminal characteristics. If an
1783argument is given, changes the value and returns the previous one.
1647 1784
1648=item $x_display = $term->display_id 1785=item $x_display = $term->display_id
1649 1786
1650Return the DISPLAY used by rxvt-unicode. 1787Return the DISPLAY used by rxvt-unicode.
1651 1788
… …
1688 1825
1689=item $cursor_is_hidden = $term->hidden_cursor 1826=item $cursor_is_hidden = $term->hidden_cursor
1690 1827
1691Returns whether the cursor is currently hidden or not. 1828Returns whether the cursor is currently hidden or not.
1692 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
1693=item $view_start = $term->view_start ([$newvalue]) 1840=item $view_start = $term->view_start ([$newvalue])
1694 1841
1695Returns the row number of the topmost displayed line. Maximum value is 1842Returns the row number of the topmost displayed line and changes it,
1696C<0>, which displays the normal terminal contents. Lower values scroll 1843if an argument is given. Values greater than or equal to C<0> display
1697this many lines into the scrollback buffer. 1844the terminal contents. Lower values scroll this many lines into the
1845scrollback buffer.
1698 1846
1699=item $term->want_refresh 1847=item $term->want_refresh
1700 1848
1701Requests a screen refresh. At the next opportunity, rxvt-unicode will 1849Requests a screen refresh. At the next opportunity, rxvt-unicode will
1702compare the on-screen display with its stored representation. If they 1850compare the on-screen display with its stored representation. If they
… …
1760 1908
1761Create and return a new C<urxvt::line> object that stores information 1909Create and return a new C<urxvt::line> object that stores information
1762about 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
1763following methods: 1911following methods:
1764 1912
1765=over 4 1913=over
1766 1914
1767=item $text = $line->t ([$new_text]) 1915=item $text = $line->t ([$new_text])
1768 1916
1769Returns 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>
1770 1918
… …
1874where one character corresponds to one screen cell. See 2022where one character corresponds to one screen cell. See
1875C<< $term->ROW_t >> for details. 2023C<< $term->ROW_t >> for details.
1876 2024
1877=item $string = $term->special_decode $text 2025=item $string = $term->special_decode $text
1878 2026
1879Converts rxvt-unicodes text representation into a perl string. See 2027Converts rxvt-unicode's text representation into a perl string. See
1880C<< $term->ROW_t >> for details. 2028C<< $term->ROW_t >> for details.
1881 2029
1882=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 2030=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1883 2031
1884=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 2032=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
… …
1950 2098
1951package urxvt::popup; 2099package urxvt::popup;
1952 2100
1953=head2 The C<urxvt::popup> Class 2101=head2 The C<urxvt::popup> Class
1954 2102
1955=over 4 2103=over
1956 2104
1957=cut 2105=cut
1958 2106
1959sub add_item { 2107sub add_item {
1960 my ($self, $item) = @_; 2108 my ($self, $item) = @_;
… …
2096 ->cb (sub { 2244 ->cb (sub {
2097 $term->{overlay}->set (0, 0, 2245 $term->{overlay}->set (0, 0,
2098 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2246 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2099 }); 2247 });
2100 2248
2101=over 4 2249=over
2102 2250
2103=item $timer = new urxvt::timer 2251=item $timer = new urxvt::timer
2104 2252
2105Create 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
2106immediately. 2254immediately.
… …
2155 sysread $term->{socket}, my $buf, 8192 2303 sysread $term->{socket}, my $buf, 8192
2156 or end-of-file; 2304 or end-of-file;
2157 }); 2305 });
2158 2306
2159 2307
2160=over 4 2308=over
2161 2309
2162=item $iow = new urxvt::iow 2310=item $iow = new urxvt::iow
2163 2311
2164Create a new io watcher object in stopped state. 2312Create a new io watcher object in stopped state.
2165 2313
… …
2192 2340
2193This class implements idle watchers, that get called automatically when 2341This class implements idle watchers, that get called automatically when
2194the 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
2195some useful work. 2343some useful work.
2196 2344
2197=over 4 2345=over
2198 2346
2199=item $iw = new urxvt::iw 2347=item $iw = new urxvt::iw
2200 2348
2201Create a new idle watcher object in stopped state. 2349Create a new idle watcher object in stopped state.
2202 2350
… …
2227 ->cb (sub { 2375 ->cb (sub {
2228 my ($pw, $exit_status) = @_; 2376 my ($pw, $exit_status) = @_;
2229 ... 2377 ...
2230 }); 2378 });
2231 2379
2232=over 4 2380=over
2233 2381
2234=item $pw = new urxvt::pw 2382=item $pw = new urxvt::pw
2235 2383
2236Create a new process watcher in stopped state. 2384Create a new process watcher in stopped state.
2237 2385
… …
2254=head2 URXVT_PERL_VERBOSITY 2402=head2 URXVT_PERL_VERBOSITY
2255 2403
2256This variable controls the verbosity level of the perl extension. Higher 2404This variable controls the verbosity level of the perl extension. Higher
2257numbers indicate more verbose output. 2405numbers indicate more verbose output.
2258 2406
2259=over 4 2407=over
2260 2408
2261=item == 0 - fatal messages 2409=item == 0 - fatal messages only
2410
2411=item >= 2 - general warnings (default level)
2262 2412
2263=item >= 3 - script loading and management 2413=item >= 3 - script loading and management
2264 2414
2265=item >=10 - all called hooks 2415=item >=10 - all called hooks
2266 2416

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines