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.202 by sf-exg, Wed Nov 30 10:29:51 2011 UTC vs.
Revision 1.216 by root, Sun Jun 10 13:32:55 2012 UTC

… …
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' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
… …
672resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
673 673
674The event is simply the action string. This interface is assumed to change 674The event is simply the action string. This interface is assumed to change
675slightly in the future. 675slightly in the future.
676 676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
677=item on_resize_all_windows $term, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
678 685
679Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
680windows are actually being resized or hints are being set. If this hook 687windows are actually being resized or hints are being set. If this hook
681returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
… …
748=cut 755=cut
749 756
750package urxvt; 757package urxvt;
751 758
752use utf8; 759use utf8;
753use strict; 760use strict 'vars';
754use Carp (); 761use Carp ();
755use Scalar::Util (); 762use Scalar::Util ();
756use List::Util (); 763use List::Util ();
757 764
758our $VERSION = 1; 765our $VERSION = 1;
759our $TERM; 766our $TERM;
760our @TERM_INIT; 767our @TERM_INIT; # should go, prevents async I/O etc.
761our @TERM_EXT; 768our @TERM_EXT; # should go, prevents async I/O etc.
762our @HOOKNAME; 769our @HOOKNAME;
763our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
764our %OPTION; 771our %OPTION;
765 772
766our $LIBDIR; 773our $LIBDIR;
… …
936 }; 943 };
937} 944}
938 945
939no warnings 'utf8'; 946no warnings 'utf8';
940 947
948sub parse_resource {
949 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950
951 $name =~ y/-/./ if $isarg;
952
953 $term->scan_meta;
954
955 my $r = $term->{meta}{resource};
956 keys %$r; # reste iterator
957 while (my ($pattern, $v) = each %$r) {
958 if (
959 $pattern =~ /\.$/
960 ? $pattern eq substr $name, 0, length $pattern
961 : $pattern eq $name
962 ) {
963 $name = "$urxvt::RESCLASS.$name";
964
965 push @{ $term->{perl_ext_3} }, $v->[0];
966
967 if ($v->[1] eq "boolean") {
968 $term->put_option_db ($name, $flag ? "true" : "false");
969 return 1;
970 } else {
971 $term->put_option_db ($name, $value);
972 return 1 + 2;
973 }
974 }
975 }
976
977 0
978}
979
980sub usage {
981 my ($term, $usage_type) = @_;
982
983 $term->scan_meta;
984
985 my $r = $term->{meta}{resource};
986
987 for my $pattern (sort keys %$r) {
988 my ($ext, $type, $desc) = @{ $r->{$pattern} };
989
990 $desc .= " (-pe $ext)";
991
992 if ($usage_type == 1) {
993 $pattern =~ y/./-/;
994 $pattern =~ s/-$/-.../g;
995
996 if ($type eq "boolean") {
997 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
998 } else {
999 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
1000 }
1001 } else {
1002 $pattern =~ s/\.$/.*/g;
1003 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1004 }
1005 }
1006}
1007
941my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1008my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
942 1009
943sub verbose { 1010sub verbose {
944 my ($level, $msg) = @_; 1011 my ($level, $msg) = @_;
945 warn "$msg\n" if $level <= $verbosity; 1012 warn "$msg\n" if $level <= $verbosity;
… …
961 1028
962 open my $fh, "<:raw", $path 1029 open my $fh, "<:raw", $path
963 or die "$path: $!"; 1030 or die "$path: $!";
964 1031
965 my $source = 1032 my $source =
966 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 1033 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
967 . "#line 1 \"$path\"\n{\n" 1034 . "#line 1 \"$path\"\n{\n"
968 . (do { local $/; <$fh> }) 1035 . (do { local $/; <$fh> })
969 . "\n};\n1"; 1036 . "\n};\n1";
970 1037
971 eval $source 1038 eval $source
… …
981sub invoke { 1048sub invoke {
982 local $TERM = shift; 1049 local $TERM = shift;
983 my $htype = shift; 1050 my $htype = shift;
984 1051
985 if ($htype == 0) { # INIT 1052 if ($htype == 0) { # INIT
986 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); 1053 my @dirs = $TERM->perl_libdirs;
987 1054
988 my %ext_arg; 1055 my %ext_arg;
989 1056
990 { 1057 {
991 my @init = @TERM_INIT; 1058 my @init = @TERM_INIT;
… …
994 my @pkg = @TERM_EXT; 1061 my @pkg = @TERM_EXT;
995 @TERM_EXT = (); 1062 @TERM_EXT = ();
996 $TERM->register_package ($_) for @pkg; 1063 $TERM->register_package ($_) for @pkg;
997 } 1064 }
998 1065
1066 for (
1067 @{ delete $TERM->{perl_ext_3} },
999 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1068 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
1069 ) {
1000 if ($_ eq "default") { 1070 if ($_ eq "default") {
1001 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 1071 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
1002 } elsif (/^-(.*)$/) { 1072 } elsif (/^-(.*)$/) {
1003 delete $ext_arg{$1}; 1073 delete $ext_arg{$1};
1004 } elsif (/^([^<]+)<(.*)>$/) { 1074 } elsif (/^([^<]+)<(.*)>$/) {
… …
1152=head2 The C<urxvt::anyevent> Class 1222=head2 The C<urxvt::anyevent> Class
1153 1223
1154The sole purpose of this class is to deliver an interface to the 1224The sole purpose of this class is to deliver an interface to the
1155C<AnyEvent> module - any module using it will work inside urxvt without 1225C<AnyEvent> module - any module using it will work inside urxvt without
1156further programming. The only exception is that you cannot wait on 1226further programming. The only exception is that you cannot wait on
1157condition variables, but non-blocking condvar use is ok. What this means 1227condition variables, but non-blocking condvar use is ok.
1158is that you cannot use blocking APIs, but the non-blocking variant should 1228
1159work. 1229In practical terms this means is that you cannot use blocking APIs, but
1230the non-blocking variant should work.
1160 1231
1161=cut 1232=cut
1162 1233
1163our $VERSION = '5.23'; 1234our $VERSION = '5.23';
1164 1235
… …
1258 $self->{_pkg}{$pkg} = $proxy; 1329 $self->{_pkg}{$pkg} = $proxy;
1259 1330
1260 for my $name (@HOOKNAME) { 1331 for my $name (@HOOKNAME) {
1261 if (my $ref = $pkg->can ("on_" . lc $name)) { 1332 if (my $ref = $pkg->can ("on_" . lc $name)) {
1262 $proxy->enable ($name => $ref); 1333 $proxy->enable ($name => $ref);
1334 }
1335 }
1336}
1337
1338sub perl_libdirs {
1339 map { split /:/ }
1340 $_[0]->resource ("perl_lib"),
1341 $ENV{URXVT_PERL_LIB},
1342 "$ENV{HOME}/.urxvt/ext",
1343 "$LIBDIR/perl"
1344}
1345
1346sub scan_meta {
1347 my ($self) = @_;
1348 my @libdirs = perl_libdirs $self;
1349
1350 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1351
1352 my %meta;
1353
1354 $self->{meta_libdirs} = join "\x00", @libdirs;
1355 $self->{meta} = \%meta;
1356
1357 for my $dir (reverse @libdirs) {
1358 opendir my $fh, $dir
1359 or next;
1360 for my $ext (readdir $fh) {
1361 $ext ne "."
1362 and $ext ne ".."
1363 and open my $fh, "<", "$dir/$ext"
1364 or next;
1365
1366 while (<$fh>) {
1367 if (/^#:META:X_RESOURCE:(.*)/) {
1368 my ($pattern, $type, $desc) = split /:/, $1;
1369 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1370 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1371 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1372 } else {
1373 $meta{resource}{$pattern} = [$ext, $type, $desc];
1374 }
1375 } elsif (/^\s*(?:#|$)/) {
1376 # skip other comments and empty lines
1377 } else {
1378 last; # stop parsing on first non-empty non-comment line
1379 }
1380 }
1263 } 1381 }
1264 } 1382 }
1265} 1383}
1266 1384
1267=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1385=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
… …
1388 1506
1389This method should only be called during the C<on_start> hook, as there is 1507This method should only be called during the C<on_start> hook, as there is
1390only one resource database per display, and later invocations might return 1508only one resource database per display, and later invocations might return
1391the wrong resources. 1509the wrong resources.
1392 1510
1511=item $value = $term->x_resource_boolean ($pattern)
1512
1513Like C<x_resource>, above, but interprets the string value as a boolean
1514and returns C<1> for true values, C<0> for false values and C<undef> if
1515the resource or option isn't specified.
1516
1517You should always use this method to parse boolean resources.
1518
1519=cut
1520
1521sub x_resource_boolean {
1522 my $res = &x_resource;
1523
1524 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1525}
1526
1393=item $success = $term->parse_keysym ($key, $octets) 1527=item $success = $term->parse_keysym ($key, $octets)
1394 1528
1395Adds a key binding exactly as specified via a resource. See the 1529Adds a key binding exactly as specified via a resource. See the
1396C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1530C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1531
1532=item $term->register_command ($keysym, $modifiermask, $string)
1533
1534Adds a key binding. This is a lower level api compared to
1535C<parse_keysym>, as it expects a parsed key description, and can be
1536used only inside either the C<on_init> hook, to add a binding, or the
1537C<on_register_command> hook, to modify a parsed binding.
1397 1538
1398=item $rend = $term->rstyle ([$new_rstyle]) 1539=item $rend = $term->rstyle ([$new_rstyle])
1399 1540
1400Return and optionally change the current rendition. Text that is output by 1541Return and optionally change the current rendition. Text that is output by
1401the terminal application will use this style. 1542the terminal application will use this style.
… …
1614 1755
1615Adds the specified events to the vt event mask. Useful e.g. when you want 1756Adds the specified events to the vt event mask. Useful e.g. when you want
1616to receive pointer events all the times: 1757to receive pointer events all the times:
1617 1758
1618 $term->vt_emask_add (urxvt::PointerMotionMask); 1759 $term->vt_emask_add (urxvt::PointerMotionMask);
1760
1761=item $term->set_urgency ($set)
1762
1763Enable/disable the urgency hint on the toplevel window.
1619 1764
1620=item $term->focus_in 1765=item $term->focus_in
1621 1766
1622=item $term->focus_out 1767=item $term->focus_out
1623 1768

Diff Legend

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