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.205 by root, Tue Jun 5 19:32:29 2012 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
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;
968 1028
969 open my $fh, "<:raw", $path 1029 open my $fh, "<:raw", $path
970 or die "$path: $!"; 1030 or die "$path: $!";
971 1031
972 my $source = 1032 my $source =
973 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 1033 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
974 . "#line 1 \"$path\"\n{\n" 1034 . "#line 1 \"$path\"\n{\n"
975 . (do { local $/; <$fh> }) 1035 . (do { local $/; <$fh> })
976 . "\n};\n1"; 1036 . "\n};\n1";
977 1037
978 eval $source 1038 eval $source
988sub invoke { 1048sub invoke {
989 local $TERM = shift; 1049 local $TERM = shift;
990 my $htype = shift; 1050 my $htype = shift;
991 1051
992 if ($htype == 0) { # INIT 1052 if ($htype == 0) { # INIT
993 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); 1053 my @dirs = $TERM->perl_libdirs;
994 1054
995 my %ext_arg; 1055 my %ext_arg;
996 1056
997 { 1057 {
998 my @init = @TERM_INIT; 1058 my @init = @TERM_INIT;
1001 my @pkg = @TERM_EXT; 1061 my @pkg = @TERM_EXT;
1002 @TERM_EXT = (); 1062 @TERM_EXT = ();
1003 $TERM->register_package ($_) for @pkg; 1063 $TERM->register_package ($_) for @pkg;
1004 } 1064 }
1005 1065
1066 for (
1067 @{ delete $TERM->{perl_ext_3} },
1006 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1068 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
1069 ) {
1007 if ($_ eq "default") { 1070 if ($_ eq "default") {
1008 $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);
1009 } elsif (/^-(.*)$/) { 1072 } elsif (/^-(.*)$/) {
1010 delete $ext_arg{$1}; 1073 delete $ext_arg{$1};
1011 } elsif (/^([^<]+)<(.*)>$/) { 1074 } elsif (/^([^<]+)<(.*)>$/) {
1100 while (my ($name, $cb) = each %hook) { 1163 while (my ($name, $cb) = each %hook) {
1101 my $htype = $HOOKTYPE{uc $name}; 1164 my $htype = $HOOKTYPE{uc $name};
1102 defined $htype 1165 defined $htype
1103 or Carp::croak "unsupported hook type '$name'"; 1166 or Carp::croak "unsupported hook type '$name'";
1104 1167
1105 $self->modify_should_invoke_count ($htype, +1) 1168 $self->set_should_invoke ($htype, +1)
1106 unless exists $self->{term}{_hook}[$htype]{$pkg}; 1169 unless exists $self->{term}{_hook}[$htype]{$pkg};
1107 1170
1108 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1171 $self->{term}{_hook}[$htype]{$pkg} = $cb;
1109 } 1172 }
1110} 1173}
1116 for my $name (@hook) { 1179 for my $name (@hook) {
1117 my $htype = $HOOKTYPE{uc $name}; 1180 my $htype = $HOOKTYPE{uc $name};
1118 defined $htype 1181 defined $htype
1119 or Carp::croak "unsupported hook type '$name'"; 1182 or Carp::croak "unsupported hook type '$name'";
1120 1183
1121 $self->modify_should_invoke_count ($htype, -1) 1184 $self->set_should_invoke ($htype, -1)
1122 if delete $self->{term}{_hook}[$htype]{$pkg}; 1185 if delete $self->{term}{_hook}[$htype]{$pkg};
1123 } 1186 }
1124} 1187}
1125 1188
1126our $AUTOLOAD; 1189our $AUTOLOAD;
1159=head2 The C<urxvt::anyevent> Class 1222=head2 The C<urxvt::anyevent> Class
1160 1223
1161The 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
1162C<AnyEvent> module - any module using it will work inside urxvt without 1225C<AnyEvent> module - any module using it will work inside urxvt without
1163further programming. The only exception is that you cannot wait on 1226further programming. The only exception is that you cannot wait on
1164condition variables, but non-blocking condvar use is ok. What this means 1227condition variables, but non-blocking condvar use is ok.
1165is that you cannot use blocking APIs, but the non-blocking variant should 1228
1166work. 1229In practical terms this means is that you cannot use blocking APIs, but
1230the non-blocking variant should work.
1167 1231
1168=cut 1232=cut
1169 1233
1170our $VERSION = '5.23'; 1234our $VERSION = '5.23';
1171 1235
1265 $self->{_pkg}{$pkg} = $proxy; 1329 $self->{_pkg}{$pkg} = $proxy;
1266 1330
1267 for my $name (@HOOKNAME) { 1331 for my $name (@HOOKNAME) {
1268 if (my $ref = $pkg->can ("on_" . lc $name)) { 1332 if (my $ref = $pkg->can ("on_" . lc $name)) {
1269 $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 }
1270 } 1381 }
1271 } 1382 }
1272} 1383}
1273 1384
1274=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1385=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1395 1506
1396This 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
1397only one resource database per display, and later invocations might return 1508only one resource database per display, and later invocations might return
1398the wrong resources. 1509the wrong resources.
1399 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
1400=item $success = $term->parse_keysym ($key, $octets) 1527=item $success = $term->parse_keysym ($key, $octets)
1401 1528
1402Adds a key binding exactly as specified via a resource. See the 1529Adds a key binding exactly as specified via a resource. See the
1403C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1530C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1404 1531

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines