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.203 by sf-exg, Fri Dec 2 09:03:43 2011 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 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
… …
755=cut 755=cut
756 756
757package urxvt; 757package urxvt;
758 758
759use utf8; 759use utf8;
760use strict; 760use strict 'vars';
761use Carp (); 761use Carp ();
762use Scalar::Util (); 762use Scalar::Util ();
763use List::Util (); 763use List::Util ();
764 764
765our $VERSION = 1; 765our $VERSION = 1;
766our $TERM; 766our $TERM;
767our @TERM_INIT; 767our @TERM_INIT; # should go, prevents async I/O etc.
768our @TERM_EXT; 768our @TERM_EXT; # should go, prevents async I/O etc.
769our @HOOKNAME; 769our @HOOKNAME;
770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
771our %OPTION; 771our %OPTION;
772 772
773our $LIBDIR; 773our $LIBDIR;
… …
943 }; 943 };
944} 944}
945 945
946no warnings 'utf8'; 946no warnings 'utf8';
947 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
948my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1008my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
949 1009
950sub verbose { 1010sub verbose {
951 my ($level, $msg) = @_; 1011 my ($level, $msg) = @_;
952 warn "$msg\n" if $level <= $verbosity; 1012 warn "$msg\n" if $level <= $verbosity;
… …
964 $pkg =~ s/[^[:word:]]/_/g; 1024 $pkg =~ s/[^[:word:]]/_/g;
965 $pkg = "urxvt::ext::$pkg"; 1025 $pkg = "urxvt::ext::$pkg";
966 1026
967 verbose 3, "loading extension '$path' into package '$pkg'"; 1027 verbose 3, "loading extension '$path' into package '$pkg'";
968 1028
1029 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
1030
969 open my $fh, "<:raw", $path 1031 open my $fh, "<:raw", $path
970 or die "$path: $!"; 1032 or die "$path: $!";
971 1033
972 my $source = 1034 my $source =
973 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 1035 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
974 . "#line 1 \"$path\"\n{\n" 1036 . "#line 1 \"$path\"\n{\n"
975 . (do { local $/; <$fh> }) 1037 . (do { local $/; <$fh> })
976 . "\n};\n1"; 1038 . "\n};\n1";
977 1039
978 eval $source 1040 eval $source
… …
988sub invoke { 1050sub invoke {
989 local $TERM = shift; 1051 local $TERM = shift;
990 my $htype = shift; 1052 my $htype = shift;
991 1053
992 if ($htype == 0) { # INIT 1054 if ($htype == 0) { # INIT
993 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); 1055 my @dirs = $TERM->perl_libdirs;
994 1056
995 my %ext_arg; 1057 my %ext_arg;
996 1058
997 { 1059 {
998 my @init = @TERM_INIT; 1060 my @init = @TERM_INIT;
… …
1001 my @pkg = @TERM_EXT; 1063 my @pkg = @TERM_EXT;
1002 @TERM_EXT = (); 1064 @TERM_EXT = ();
1003 $TERM->register_package ($_) for @pkg; 1065 $TERM->register_package ($_) for @pkg;
1004 } 1066 }
1005 1067
1068 for (
1069 @{ delete $TERM->{perl_ext_3} },
1006 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1070 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
1071 ) {
1007 if ($_ eq "default") { 1072 if ($_ eq "default") {
1008 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 1073 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
1009 } elsif (/^-(.*)$/) { 1074 } elsif (/^-(.*)$/) {
1010 delete $ext_arg{$1}; 1075 delete $ext_arg{$1};
1011 } elsif (/^([^<]+)<(.*)>$/) { 1076 } elsif (/^([^<]+)<(.*)>$/) {
… …
1087 } 1152 }
1088 } 1153 }
1089 ($mask, @color{qw(fg bg)}, \@failed) 1154 ($mask, @color{qw(fg bg)}, \@failed)
1090} 1155}
1091 1156
1092# urxvt::term::extension
1093
1094package urxvt::term::extension; 1157package urxvt::term::extension;
1095 1158
1096sub enable { 1159sub enable {
1097 my ($self, %hook) = @_; 1160 my ($self, %hook) = @_;
1098 my $pkg = $self->{_pkg}; 1161 my $pkg = $self->{_pkg};
… …
1152 1215
1153sub urxvt::destroy_hook(&) { 1216sub urxvt::destroy_hook(&) {
1154 bless \shift, urxvt::destroy_hook:: 1217 bless \shift, urxvt::destroy_hook::
1155} 1218}
1156 1219
1220sub x_resource {
1221 my ($self, $name) = @_;
1222 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1223 $self->{term}->x_resource ($name)
1224}
1225
1226sub x_resource_boolean {
1227 my ($self, $name) = @_;
1228 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1229 $self->{term}->x_resource_boolean ($name)
1230}
1231
1157package urxvt::anyevent; 1232package urxvt::anyevent;
1158 1233
1159=head2 The C<urxvt::anyevent> Class 1234=head2 The C<urxvt::anyevent> Class
1160 1235
1161The sole purpose of this class is to deliver an interface to the 1236The sole purpose of this class is to deliver an interface to the
1162C<AnyEvent> module - any module using it will work inside urxvt without 1237C<AnyEvent> module - any module using it will work inside urxvt without
1163further programming. The only exception is that you cannot wait on 1238further programming. The only exception is that you cannot wait on
1164condition variables, but non-blocking condvar use is ok. What this means 1239condition variables, but non-blocking condvar use is ok.
1165is that you cannot use blocking APIs, but the non-blocking variant should 1240
1166work. 1241In practical terms this means is that you cannot use blocking APIs, but
1242the non-blocking variant should work.
1167 1243
1168=cut 1244=cut
1169 1245
1170our $VERSION = '5.23'; 1246our $VERSION = '5.23';
1171 1247
… …
1255 urxvt::verbose 6, "register package $pkg to $self"; 1331 urxvt::verbose 6, "register package $pkg to $self";
1256 1332
1257 @{"$pkg\::ISA"} = urxvt::term::extension::; 1333 @{"$pkg\::ISA"} = urxvt::term::extension::;
1258 1334
1259 my $proxy = bless { 1335 my $proxy = bless {
1260 _pkg => $pkg, 1336 _pkg => $pkg,
1337 _name => ${"$pkg\::_NAME"}, # hackish
1261 argv => $argv, 1338 argv => $argv,
1262 }, $pkg; 1339 }, $pkg;
1263 Scalar::Util::weaken ($proxy->{term} = $self); 1340 Scalar::Util::weaken ($proxy->{term} = $self);
1264 1341
1265 $self->{_pkg}{$pkg} = $proxy; 1342 $self->{_pkg}{$pkg} = $proxy;
1266 1343
1267 for my $name (@HOOKNAME) { 1344 for my $name (@HOOKNAME) {
1268 if (my $ref = $pkg->can ("on_" . lc $name)) { 1345 if (my $ref = $pkg->can ("on_" . lc $name)) {
1269 $proxy->enable ($name => $ref); 1346 $proxy->enable ($name => $ref);
1347 }
1348 }
1349}
1350
1351sub perl_libdirs {
1352 map { split /:/ }
1353 $_[0]->resource ("perl_lib"),
1354 $ENV{URXVT_PERL_LIB},
1355 "$ENV{HOME}/.urxvt/ext",
1356 "$LIBDIR/perl"
1357}
1358
1359sub scan_meta {
1360 my ($self) = @_;
1361 my @libdirs = perl_libdirs $self;
1362
1363 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1364
1365 my %meta;
1366
1367 $self->{meta_libdirs} = join "\x00", @libdirs;
1368 $self->{meta} = \%meta;
1369
1370 for my $dir (reverse @libdirs) {
1371 opendir my $fh, $dir
1372 or next;
1373 for my $ext (readdir $fh) {
1374 $ext ne "."
1375 and $ext ne ".."
1376 and open my $fh, "<", "$dir/$ext"
1377 or next;
1378
1379 while (<$fh>) {
1380 if (/^#:META:X_RESOURCE:(.*)/) {
1381 my ($pattern, $type, $desc) = split /:/, $1;
1382 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1383 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1384 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1385 } else {
1386 $meta{resource}{$pattern} = [$ext, $type, $desc];
1387 }
1388 } elsif (/^\s*(?:#|$)/) {
1389 # skip other comments and empty lines
1390 } else {
1391 last; # stop parsing on first non-empty non-comment line
1392 }
1393 }
1270 } 1394 }
1271 } 1395 }
1272} 1396}
1273 1397
1274=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1398=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
… …
1391Returns the X-Resource for the given pattern, excluding the program or 1515Returns the X-Resource for the given pattern, excluding the program or
1392class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1516class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1393same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1517same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1394resource with that pattern exists. 1518resource with that pattern exists.
1395 1519
1520Extensions that define extra resource or command line arguments also need
1521to call this method to access their values.
1522
1523If the method is called on an extension object (basically, from an
1524extension), then the special prefix C<%.> will be replaced by the name of
1525the extension and a dot, and the lone string C<%> will be replcaed by the
1526extension name itself. This makes it possible to code extensions so you
1527can rename them and get a new set of commandline switches and resources
1528without having to change the actual code.
1529
1396This method should only be called during the C<on_start> hook, as there is 1530This method should only be called during the C<on_start> hook, as there is
1397only one resource database per display, and later invocations might return 1531only one resource database per display, and later invocations might return
1398the wrong resources. 1532the wrong resources.
1533
1534=item $value = $term->x_resource_boolean ($pattern)
1535
1536Like C<x_resource>, above, but interprets the string value as a boolean
1537and returns C<1> for true values, C<0> for false values and C<undef> if
1538the resource or option isn't specified.
1539
1540You should always use this method to parse boolean resources.
1541
1542=cut
1543
1544sub x_resource_boolean {
1545 my $res = &x_resource;
1546
1547 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1548}
1399 1549
1400=item $success = $term->parse_keysym ($key, $octets) 1550=item $success = $term->parse_keysym ($key, $octets)
1401 1551
1402Adds a key binding exactly as specified via a resource. See the 1552Adds a key binding exactly as specified via a resource. See the
1403C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1553C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
… …
1628 1778
1629Adds the specified events to the vt event mask. Useful e.g. when you want 1779Adds the specified events to the vt event mask. Useful e.g. when you want
1630to receive pointer events all the times: 1780to receive pointer events all the times:
1631 1781
1632 $term->vt_emask_add (urxvt::PointerMotionMask); 1782 $term->vt_emask_add (urxvt::PointerMotionMask);
1783
1784=item $term->set_urgency ($set)
1785
1786Enable/disable the urgency hint on the toplevel window.
1633 1787
1634=item $term->focus_in 1788=item $term->focus_in
1635 1789
1636=item $term->focus_out 1790=item $term->focus_out
1637 1791

Diff Legend

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