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.252 by root, Sat Dec 27 19:27:42 2014 UTC vs.
Revision 1.266 by root, Sat Jul 24 11:58:27 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 cololns (C<:>), and shoudl 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> ressource 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 cnanot 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
149 201
150=item on_init $term 202=item on_init $term
151 203
152Called after a new terminal object has been initialized, but before 204Called after a new terminal object has been initialized, but before
153windows 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
… …
235 287
236C<on_osc_seq_perl> should be used for new behaviour. 288C<on_osc_seq_perl> should be used for new behaviour.
237 289
238=item on_osc_seq_perl $term, $args, $resp 290=item on_osc_seq_perl $term, $args, $resp
239 291
240Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 292Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
241operating system command) is processed. Cursor position and other state 293(OSC = operating system command) is processed. Cursor position and other
242information is up-to-date when this happens. For interoperability, the 294state information is up-to-date when this happens. For interoperability,
243string should start with the extension name (sans -osc) and a semicolon, 295the argument should start with the extension name (sans -osc) or some
244to distinguish it from commands for other extensions, and this might be 296other suitable prefix, and a semicolon, to distinguish it from commands
245enforced in the future. 297for other extensions.
246 298
247For example, C<overlay-osc> uses this: 299For example, C<overlay-osc> uses this:
248 300
249 sub on_osc_seq_perl { 301 sub on_osc_seq_perl {
250 my ($self, $osc, $resp) = @_; 302 my ($self, $osc, $resp) = @_;
… …
395=cut 447=cut
396 448
397package urxvt; 449package urxvt;
398 450
399use utf8; 451use utf8;
400use strict 'vars'; 452use strict qw(vars subs);
401use Carp (); 453use Carp ();
402use Scalar::Util (); 454use Scalar::Util ();
403use List::Util (); 455use List::Util ();
404 456
405our $VERSION = 1; 457our $VERSION = 1;
… …
417 469
418our $NOCHAR = chr 0xffff; 470our $NOCHAR = chr 0xffff;
419 471
420=head2 Variables in the C<urxvt> Package 472=head2 Variables in the C<urxvt> Package
421 473
422=over 4 474=over
423 475
424=item $urxvt::LIBDIR 476=item $urxvt::LIBDIR
425 477
426The rxvt-unicode library directory, where, among other things, the perl 478The rxvt-unicode library directory, where, among other things, the perl
427modules and scripts are stored. 479modules and scripts are stored.
… …
457 509
458=back 510=back
459 511
460=head2 Functions in the C<urxvt> Package 512=head2 Functions in the C<urxvt> Package
461 513
462=over 4 514=over
463 515
464=item urxvt::fatal $errormessage 516=item urxvt::fatal $errormessage
465 517
466Fatally aborts execution with the given error message (which should 518Fatally aborts execution with the given error message (which should
467include a trailing newline). Avoid at all costs! The only time this 519include a trailing newline). Avoid at all costs! The only time this
… …
512CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 564CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
513SelectionNotify, ColormapNotify, ClientMessage, MappingNotify 565SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
514 566
515Various constants for use in X calls and event processing. 567Various constants for use in X calls and event processing.
516 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
517=back 581=back
518 582
519=head2 RENDITION 583=head2 RENDITION
520 584
521Rendition bitsets contain information about colour, font, font styles and 585Rendition bitsets contain information about colour, font, font styles and
… …
524The following "macros" deal with changes in rendition sets. You should 588The following "macros" deal with changes in rendition sets. You should
525never just create a bitset, you should always modify an existing one, 589never just create a bitset, you should always modify an existing one,
526as they contain important information required for correct operation of 590as they contain important information required for correct operation of
527rxvt-unicode. 591rxvt-unicode.
528 592
529=over 4 593=over
530 594
531=item $rend = urxvt::DEFAULT_RSTYLE 595=item $rend = urxvt::DEFAULT_RSTYLE
532 596
533Returns 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
534being reset. Useful as a base to start when creating renditions. 598being reset. Useful as a base to start when creating renditions.
… …
588sub parse_resource { 652sub parse_resource {
589 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 653 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
590 654
591 $term->scan_extensions; 655 $term->scan_extensions;
592 656
657 # iterating over all resources has quadratic time overhead
658 # overall, maybe this could be optimised?
593 my $r = $term->{meta}{resource}; 659 my $r = $term->{meta}{resource};
594 keys %$r; # reset iterator 660 keys %$r; # reset iterator
595 while (my ($k, $v) = each %$r) { 661 while (my ($k, $v) = each %$r) {
596 my $pattern = $k; 662 my $pattern = $k;
597 $pattern =~ y/./-/ if $isarg; 663 $pattern =~ y/./-/ if $isarg;
… …
604 if ($pattern eq $prefix) { 670 if ($pattern eq $prefix) {
605 $name = "$urxvt::RESCLASS.$k$suffix"; 671 $name = "$urxvt::RESCLASS.$k$suffix";
606 672
607 push @{ $term->{perl_ext_3} }, $v->[0]; 673 push @{ $term->{perl_ext_3} }, $v->[0];
608 674
675 return 1 unless $isarg;
676
609 if ($v->[1] eq "boolean") { 677 if ($v->[1] eq "boolean") {
610 $term->put_option_db ($name, $flag ? "true" : "false"); 678 $term->put_option_db ($name, $flag ? "true" : "false");
611 return 1; 679 return 1;
612 } else { 680 } else {
613 $term->put_option_db ($name, $value); 681 $term->put_option_db ($name, $value);
… …
645 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; 713 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
646 } 714 }
647 } 715 }
648} 716}
649 717
650my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 718my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
651 719
652sub verbose { 720sub verbose {
653 my ($level, $msg) = @_; 721 my ($level, $msg) = @_;
654 warn "$msg\n" if $level <= $verbosity; 722 warn "$msg\n" if $level <= $verbosity;
655} 723}
… …
672 740
673 open my $fh, "<:raw", $path 741 open my $fh, "<:raw", $path
674 or die "$path: $!"; 742 or die "$path: $!";
675 743
676 my $source = 744 my $source =
677 "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"
678 . "#line 1 \"$path\"\n{\n" 746 . "#line 1 \"$path\"\n{\n"
679 . (do { local $/; <$fh> }) 747 . (do { local $/; <$fh> })
680 . "\n};\n1"; 748 . "\n};\n1";
681 749
682 eval $source 750 eval $source
… …
692sub invoke { 760sub invoke {
693 local $TERM = shift; 761 local $TERM = shift;
694 my $htype = shift; 762 my $htype = shift;
695 763
696 if ($htype == HOOK_INIT) { 764 if ($htype == HOOK_INIT) {
697 my @dirs = $TERM->perl_libdirs;
698
699 $TERM->scan_extensions; 765 $TERM->scan_extensions;
700 766
701 my %ext_arg; 767 my %ext_arg;
702 768
703 { 769 {
… …
708 @TERM_EXT = (); 774 @TERM_EXT = ();
709 $TERM->register_package ($_) for @pkg; 775 $TERM->register_package ($_) for @pkg;
710 } 776 }
711 777
712 for ( 778 for (
779 @{ delete $TERM->{perl_ext_3} },
713 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2), 780 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
714 @{ delete $TERM->{perl_ext_3} }
715 ) { 781 ) {
716 if ($_ eq "default") { 782 if ($_ eq "default") {
717 783
718 $ext_arg{$_} = [] 784 $ext_arg{$_} = []
719 for qw(selection option-popup selection-popup readline searchable-scrollback); 785 for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
720 786
721 for ($TERM->_keysym_resources) { 787 for ($TERM->_keysym_resources) {
722 next if /^(?:string|command|builtin|builtin-string|perl)/; 788 next if /^(?:string|command|builtin|builtin-string|perl)/;
723 next unless /^([A-Za-z0-9_\-]+):/; 789 next unless /^([A-Za-z0-9_\-]+):/;
724 790
725 my $ext = $1; 791 my $ext = $1;
726 792
727 $ext_arg{$ext} = []; 793 $ext_arg{$ext} = [];
728 } 794 }
729 795
730 } elsif (/^-(.*)$/) { 796 } elsif (/^-(.*)$/) { # remove from set
731 delete $ext_arg{$1}; 797 delete $ext_arg{$1};
732 798
733 } 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};
734 push @{ $ext_arg{$1} }, $2; 804 push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
735 805
736 } else { 806 } else {
737 $ext_arg{$_} ||= []; 807 verbose 2, "cannot parse extension specification '$_', ignoring.";
738 } 808 }
739 } 809 }
740 810
811 $TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
812 $TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
813
741 for my $ext (sort keys %ext_arg) { 814 for my $ext (sort keys %ext_arg) {
742 my @files = grep -f $_, map "$_/$ext", @dirs; 815 my $path = $TERM->extension_path ($ext);
743 816
744 if (@files) { 817 if (defined $path) {
745 $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); 818 $TERM->autoload_extension ($ext, $ext_arg{$ext});
746 } else { 819 } else {
747 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";
748 } 821 }
749 } 822 }
750 823
751 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");
752 warn $@ if $@; 825 warn $@ if $@;
753 } 826 }
754 827
755 $retval = undef; 828 $retval = undef;
829
830 if ($htype == HOOK_OSC_SEQ) {
831 if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
832 $TERM->autoload_extension ($_->[0]) for @$exts;
833 }
834 } elsif ($htype == HOOK_OSC_SEQ_PERL) {
835 if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
836 $TERM->autoload_extension ($_->[0]) for @$exts;
837 }
838 }
756 839
757 if (my $cb = $TERM->{_hook}[$htype]) { 840 if (my $cb = $TERM->{_hook}[$htype]) {
758 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 841 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
759 if $verbosity >= 10; 842 if $verbosity >= 10;
760 843
… …
837 920
838The methods (And data members) documented below can be called on extension 921The methods (And data members) documented below can be called on extension
839objects, in addition to call methods documented for the <urxvt::term> 922objects, in addition to call methods documented for the <urxvt::term>
840class. 923class.
841 924
842=over 4 925=over
843 926
844=item $urxvt_term = $self->{term} 927=item $urxvt_term = $self->{term}
845 928
846Returns the C<urxvt::term> object associated with this instance of the 929Returns the C<urxvt::term> object associated with this instance of the
847extension. This member I<must not> be changed in any way. 930extension. This member I<must not> be changed in any way.
… …
1088 1171
1089package urxvt::term; 1172package urxvt::term;
1090 1173
1091=head2 The C<urxvt::term> Class 1174=head2 The C<urxvt::term> Class
1092 1175
1093=over 4 1176=over
1094 1177
1095=cut 1178=cut
1096 1179
1097# find on_xxx subs in the package and register them 1180# find on_xxx subs in the package and register them
1098# as hooks 1181# as hooks
… …
1119 $proxy->enable ($name => $ref); 1202 $proxy->enable ($name => $ref);
1120 } 1203 }
1121 } 1204 }
1122} 1205}
1123 1206
1207# map extension name to filesyystem 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
1124sub perl_libdirs { 1231sub perl_libdirs {
1125 map { split /:/ } 1232 map { split /:/ }
1126 $_[0]->resource ("perl_lib"), 1233 $_[0]->resource ("perl_lib"),
1127 $ENV{URXVT_PERL_LIB}, 1234 $ENV{URXVT_PERL_LIB},
1128 "$ENV{HOME}/.urxvt/ext", 1235 "$ENV{HOME}/.urxvt/ext",
… …
1136 return if exists $self->{meta}; 1243 return if exists $self->{meta};
1137 1244
1138 my @urxvtdirs = perl_libdirs $self; 1245 my @urxvtdirs = perl_libdirs $self;
1139# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC; 1246# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1140 1247
1141 $self->{meta} = \my %meta; 1248 $self->{meta} = \my %allmeta;
1142 1249
1143 # first gather extensions 1250 # first gather extensions
1144 1251
1145 my $gather = sub { 1252 my $gather = sub {
1146 my ($dir, $core) = @_; 1253 my ($dir, $core) = @_;
… …
1159 or next; 1266 or next;
1160 1267
1161 $ext =~ s/\.uext$// or $core 1268 $ext =~ s/\.uext$// or $core
1162 or next; 1269 or next;
1163 1270
1164 my %ext = (dir => $dir); 1271 my %meta = (dir => $dir);
1165 1272
1166 while (<$fh>) { 1273 while (<$fh>) {
1167 if (/^#:META:(?:X_)?RESOURCE:(.*)/) { 1274 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1168 my ($pattern, $type, $desc) = split /:/, $1; 1275 my ($pattern, $type, $desc) = split /:/, $1;
1169 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1276 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1170 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1277 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1171 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";
1172 } else { 1279 } else {
1173 $ext{resource}{$pattern} = [$ext, $type, $desc]; 1280 $meta{resource}{$pattern} = [$ext, $type, $desc];
1174 } 1281 }
1282
1283 } elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1284 push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1285
1286 } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
1287 push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
1288
1175 } elsif (/^\s*(?:#|$)/) { 1289 } elsif (/^\s*(?:#|$)/) {
1176 # skip other comments and empty lines 1290 # skip other comments and empty lines
1291
1177 } else { 1292 } else {
1178 last; # stop parsing on first non-empty non-comment line 1293 last; # stop parsing on first non-empty non-comment line
1179 } 1294 }
1180 } 1295 }
1181 1296
1182 $meta{ext}{$ext} = \%ext; 1297 $allmeta{ext}{$ext} = \%meta;
1183 } 1298 }
1184 }; 1299 };
1185 1300
1186# $gather->($_, 0) for @cpandirs; 1301# $gather->($_, 0) for @cpandirs;
1187 $gather->($_, 1) for @urxvtdirs; 1302 $gather->($_, 1) for @urxvtdirs;
1188 1303
1189 # and now merge resources 1304 # and now merge resources
1190 1305
1191 $meta{resource} = \my %resource; 1306 $allmeta{resource} = \my %resource;
1192 1307
1193 while (my ($k, $v) = each %{ $meta{ext} }) { 1308 while (my ($k, $v) = each %{ $allmeta{ext} }) {
1194 #TODO: should check for extensions overriding each other 1309 #TODO: should check for extensions overriding each other
1195 %resource = (%resource, %{ $v->{resource} }); 1310 %resource = (%resource, %{ $v->{resource} });
1196 } 1311 }
1197} 1312}
1198 1313
… …
1263 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1378 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs 1379 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1265 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1380 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1381 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1382 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1268 urgentOnBell utmpInhibit visualBell 1383 urgentOnBell utmpInhibit visualBell disablePasteBrackets
1269 1384
1270=item $value = $term->resource ($name[, $newval]) 1385=item $value = $term->resource ($name[, $newval])
1271 1386
1272Returns the current resource value associated with a given name and 1387Returns the current resource value associated with a given name and
1273optionally 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>
… …
1299 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1414 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1300 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1415 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1301 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1416 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1302 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll 1417 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1303 term_name title transient_for transparent tripleclickwords urgentOnBell 1418 term_name title transient_for transparent tripleclickwords urgentOnBell
1304 utmpInhibit visualBell 1419 utmpInhibit visualBell rewrapMode disablePasteBrackets
1305 1420
1306=cut 1421=cut
1307 1422
1308sub resource($$;$) { 1423sub resource($$;$) {
1309 my ($self, $name) = (shift, shift); 1424 my ($self, $name) = (shift, shift);
… …
1346 my $res = &x_resource; 1461 my $res = &x_resource;
1347 1462
1348 $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
1349} 1464}
1350 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
1351=item $success = $term->bind_action ($key, $action) 1471=item $success = $term->bind_action ($key, $action)
1352 1472
1353Adds 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
1354C<keysym> resource in the urxvt(1) manpage. 1474C<keysym> resource in the urxvt(1) manpage.
1355 1475
… …
1451This method returns an urxvt::overlay object. The overlay will be visible 1571This method returns an urxvt::overlay object. The overlay will be visible
1452as long as the perl object is referenced. 1572as long as the perl object is referenced.
1453 1573
1454The methods currently supported on C<urxvt::overlay> objects are: 1574The methods currently supported on C<urxvt::overlay> objects are:
1455 1575
1456=over 4 1576=over
1457 1577
1458=item $overlay->set ($x, $y, $text[, $rend]) 1578=item $overlay->set ($x, $y, $text[, $rend])
1459 1579
1460Similar 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
1461text 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
… …
1612 1732
1613=item $term->key_release ($state, $keycode[, $time]) 1733=item $term->key_release ($state, $keycode[, $time])
1614 1734
1615Deliver various fake events to to terminal. 1735Deliver various fake events to to terminal.
1616 1736
1617=item $window_width = $term->width 1737=item $window_width = $term->width ([$new_value])
1618 1738
1619=item $window_height = $term->height 1739=item $window_height = $term->height ([$new_value])
1620 1740
1621=item $font_width = $term->fwidth 1741=item $font_width = $term->fwidth ([$new_value])
1622 1742
1623=item $font_height = $term->fheight 1743=item $font_height = $term->fheight ([$new_value])
1624 1744
1625=item $font_ascent = $term->fbase 1745=item $font_ascent = $term->fbase ([$new_value])
1626 1746
1627=item $terminal_rows = $term->nrow 1747=item $terminal_rows = $term->nrow ([$new_value])
1628 1748
1629=item $terminal_columns = $term->ncol 1749=item $terminal_columns = $term->ncol ([$new_value])
1630 1750
1631=item $has_focus = $term->focus 1751=item $has_focus = $term->focus ([$new_value])
1632 1752
1633=item $is_mapped = $term->mapped 1753=item $is_mapped = $term->mapped ([$new_value])
1634 1754
1635=item $max_scrollback = $term->saveLines 1755=item $max_scrollback = $term->saveLines ([$new_value])
1636 1756
1637=item $nrow_plus_saveLines = $term->total_rows 1757=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1638 1758
1639=item $topmost_scrollback_row = $term->top_row 1759=item $topmost_scrollback_row = $term->top_row ([$new_value])
1640 1760
1641Return various integers describing terminal characteristics. 1761Return various integers describing terminal characteristics. If an
1762argument is given, changes the value and returns the previous one.
1642 1763
1643=item $x_display = $term->display_id 1764=item $x_display = $term->display_id
1644 1765
1645Return the DISPLAY used by rxvt-unicode. 1766Return the DISPLAY used by rxvt-unicode.
1646 1767
… …
1683 1804
1684=item $cursor_is_hidden = $term->hidden_cursor 1805=item $cursor_is_hidden = $term->hidden_cursor
1685 1806
1686Returns whether the cursor is currently hidden or not. 1807Returns whether the cursor is currently hidden or not.
1687 1808
1809=item $priv_modes = $term->priv_modes
1810
1811Returns a bitset with the state of DEC private modes.
1812
1813Example:
1814
1815 if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
1816 # mouse reporting is turned on
1817 }
1818
1688=item $view_start = $term->view_start ([$newvalue]) 1819=item $view_start = $term->view_start ([$newvalue])
1689 1820
1690Returns the row number of the topmost displayed line. Maximum value is 1821Returns the row number of the topmost displayed line and changes it,
1691C<0>, which displays the normal terminal contents. Lower values scroll 1822if an argument is given. Values greater than or equal to C<0> display
1692this many lines into the scrollback buffer. 1823the terminal contents. Lower values scroll this many lines into the
1824scrollback buffer.
1693 1825
1694=item $term->want_refresh 1826=item $term->want_refresh
1695 1827
1696Requests a screen refresh. At the next opportunity, rxvt-unicode will 1828Requests a screen refresh. At the next opportunity, rxvt-unicode will
1697compare the on-screen display with its stored representation. If they 1829compare the on-screen display with its stored representation. If they
1698differ, it redraws the differences. 1830differ, it redraws the differences.
1699 1831
1700Used after changing terminal contents to display them. 1832Used after changing terminal contents to display them.
1833
1834=item $term->refresh_check
1835
1836Checks if a refresh has been requested and, if so, schedules one.
1701 1837
1702=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1838=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1703 1839
1704Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> 1840Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1705is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost 1841is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
… …
1751 1887
1752Create and return a new C<urxvt::line> object that stores information 1888Create and return a new C<urxvt::line> object that stores information
1753about the logical line that row C<$row_number> is part of. It supports the 1889about the logical line that row C<$row_number> is part of. It supports the
1754following methods: 1890following methods:
1755 1891
1756=over 4 1892=over
1757 1893
1758=item $text = $line->t ([$new_text]) 1894=item $text = $line->t ([$new_text])
1759 1895
1760Returns or replaces the full text of the line, similar to C<ROW_t> 1896Returns or replaces the full text of the line, similar to C<ROW_t>
1761 1897
… …
1941 2077
1942package urxvt::popup; 2078package urxvt::popup;
1943 2079
1944=head2 The C<urxvt::popup> Class 2080=head2 The C<urxvt::popup> Class
1945 2081
1946=over 4 2082=over
1947 2083
1948=cut 2084=cut
1949 2085
1950sub add_item { 2086sub add_item {
1951 my ($self, $item) = @_; 2087 my ($self, $item) = @_;
… …
2087 ->cb (sub { 2223 ->cb (sub {
2088 $term->{overlay}->set (0, 0, 2224 $term->{overlay}->set (0, 0,
2089 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2225 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2090 }); 2226 });
2091 2227
2092=over 4 2228=over
2093 2229
2094=item $timer = new urxvt::timer 2230=item $timer = new urxvt::timer
2095 2231
2096Create a new timer object in started state. It is scheduled to fire 2232Create a new timer object in started state. It is scheduled to fire
2097immediately. 2233immediately.
… …
2146 sysread $term->{socket}, my $buf, 8192 2282 sysread $term->{socket}, my $buf, 8192
2147 or end-of-file; 2283 or end-of-file;
2148 }); 2284 });
2149 2285
2150 2286
2151=over 4 2287=over
2152 2288
2153=item $iow = new urxvt::iow 2289=item $iow = new urxvt::iow
2154 2290
2155Create a new io watcher object in stopped state. 2291Create a new io watcher object in stopped state.
2156 2292
… …
2183 2319
2184This class implements idle watchers, that get called automatically when 2320This class implements idle watchers, that get called automatically when
2185the process is idle. They should return as fast as possible, after doing 2321the process is idle. They should return as fast as possible, after doing
2186some useful work. 2322some useful work.
2187 2323
2188=over 4 2324=over
2189 2325
2190=item $iw = new urxvt::iw 2326=item $iw = new urxvt::iw
2191 2327
2192Create a new idle watcher object in stopped state. 2328Create a new idle watcher object in stopped state.
2193 2329
… …
2218 ->cb (sub { 2354 ->cb (sub {
2219 my ($pw, $exit_status) = @_; 2355 my ($pw, $exit_status) = @_;
2220 ... 2356 ...
2221 }); 2357 });
2222 2358
2223=over 4 2359=over
2224 2360
2225=item $pw = new urxvt::pw 2361=item $pw = new urxvt::pw
2226 2362
2227Create a new process watcher in stopped state. 2363Create a new process watcher in stopped state.
2228 2364
… …
2245=head2 URXVT_PERL_VERBOSITY 2381=head2 URXVT_PERL_VERBOSITY
2246 2382
2247This variable controls the verbosity level of the perl extension. Higher 2383This variable controls the verbosity level of the perl extension. Higher
2248numbers indicate more verbose output. 2384numbers indicate more verbose output.
2249 2385
2250=over 4 2386=over
2251 2387
2252=item == 0 - fatal messages 2388=item == 0 - fatal messages only
2389
2390=item >= 2 - general warnings (default level)
2253 2391
2254=item >= 3 - script loading and management 2392=item >= 3 - script loading and management
2255 2393
2256=item >=10 - all called hooks 2394=item >=10 - all called hooks
2257 2395

Diff Legend

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