| … | |
… | |
| 20 | =head1 DESCRIPTION |
20 | =head1 DESCRIPTION |
| 21 | |
21 | |
| 22 | Every time a terminal object gets created, extension scripts specified via |
22 | Every time a terminal object gets created, extension scripts specified via |
| 23 | the C<perl> resource are loaded and associated with it. |
23 | the C<perl> resource are loaded and associated with it. |
| 24 | |
24 | |
| 25 | Scripts are compiled in a 'use strict' and 'use utf8' environment, and |
25 | Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and |
| 26 | thus must be encoded as UTF-8. |
26 | thus must be encoded as UTF-8. |
| 27 | |
27 | |
| 28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
28 | Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where |
| 29 | scripts will be shared (but not enabled) for all terminals. |
29 | scripts will be shared (but not enabled) for all terminals. |
| 30 | |
30 | |
| … | |
… | |
| 755 | =cut |
755 | =cut |
| 756 | |
756 | |
| 757 | package urxvt; |
757 | package urxvt; |
| 758 | |
758 | |
| 759 | use utf8; |
759 | use utf8; |
| 760 | use strict; |
760 | use strict 'vars'; |
| 761 | use Carp (); |
761 | use Carp (); |
| 762 | use Scalar::Util (); |
762 | use Scalar::Util (); |
| 763 | use List::Util (); |
763 | use List::Util (); |
| 764 | |
764 | |
| 765 | our $VERSION = 1; |
765 | our $VERSION = 1; |
| 766 | our $TERM; |
766 | our $TERM; |
| 767 | our @TERM_INIT; |
767 | our @TERM_INIT; # should go, prevents async I/O etc. |
| 768 | our @TERM_EXT; |
768 | our @TERM_EXT; # should go, prevents async I/O etc. |
| 769 | our @HOOKNAME; |
769 | our @HOOKNAME; |
| 770 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
770 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
| 771 | our %OPTION; |
771 | our %OPTION; |
| 772 | |
772 | |
| 773 | our $LIBDIR; |
773 | our $LIBDIR; |
| … | |
… | |
| 943 | }; |
943 | }; |
| 944 | } |
944 | } |
| 945 | |
945 | |
| 946 | no warnings 'utf8'; |
946 | no warnings 'utf8'; |
| 947 | |
947 | |
| 948 | sub resource { |
948 | sub parse_resource { |
| 949 | my ($term, $name, $isarg, $flag, $value) = @_; |
949 | my ($term, $name, $isarg, $longopt, $flag, $value) = @_; |
| 950 | |
950 | |
| 951 | warn "resourece<@_>\n";#d# |
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 | } |
| 952 | |
976 | |
| 953 | 0 |
977 | 0 |
|
|
978 | } |
|
|
979 | |
|
|
980 | sub 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 | } |
| 954 | } |
1006 | } |
| 955 | |
1007 | |
| 956 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
1008 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
| 957 | |
1009 | |
| 958 | sub verbose { |
1010 | sub verbose { |
| … | |
… | |
| 972 | $pkg =~ s/[^[:word:]]/_/g; |
1024 | $pkg =~ s/[^[:word:]]/_/g; |
| 973 | $pkg = "urxvt::ext::$pkg"; |
1025 | $pkg = "urxvt::ext::$pkg"; |
| 974 | |
1026 | |
| 975 | verbose 3, "loading extension '$path' into package '$pkg'"; |
1027 | verbose 3, "loading extension '$path' into package '$pkg'"; |
| 976 | |
1028 | |
|
|
1029 | (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish |
|
|
1030 | |
| 977 | open my $fh, "<:raw", $path |
1031 | open my $fh, "<:raw", $path |
| 978 | or die "$path: $!"; |
1032 | or die "$path: $!"; |
| 979 | |
1033 | |
| 980 | my $source = |
1034 | my $source = |
| 981 | "package $pkg; use strict; use utf8; no warnings 'utf8';\n" |
1035 | "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" |
| 982 | . "#line 1 \"$path\"\n{\n" |
1036 | . "#line 1 \"$path\"\n{\n" |
| 983 | . (do { local $/; <$fh> }) |
1037 | . (do { local $/; <$fh> }) |
| 984 | . "\n};\n1"; |
1038 | . "\n};\n1"; |
| 985 | |
1039 | |
| 986 | eval $source |
1040 | eval $source |
| … | |
… | |
| 996 | sub invoke { |
1050 | sub invoke { |
| 997 | local $TERM = shift; |
1051 | local $TERM = shift; |
| 998 | my $htype = shift; |
1052 | my $htype = shift; |
| 999 | |
1053 | |
| 1000 | if ($htype == 0) { # INIT |
1054 | if ($htype == 0) { # INIT |
| 1001 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); |
1055 | my @dirs = $TERM->perl_libdirs; |
| 1002 | |
1056 | |
| 1003 | my %ext_arg; |
1057 | my %ext_arg; |
| 1004 | |
1058 | |
| 1005 | { |
1059 | { |
| 1006 | my @init = @TERM_INIT; |
1060 | my @init = @TERM_INIT; |
| … | |
… | |
| 1009 | my @pkg = @TERM_EXT; |
1063 | my @pkg = @TERM_EXT; |
| 1010 | @TERM_EXT = (); |
1064 | @TERM_EXT = (); |
| 1011 | $TERM->register_package ($_) for @pkg; |
1065 | $TERM->register_package ($_) for @pkg; |
| 1012 | } |
1066 | } |
| 1013 | |
1067 | |
|
|
1068 | for ( |
|
|
1069 | @{ delete $TERM->{perl_ext_3} }, |
| 1014 | for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { |
1070 | grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 |
|
|
1071 | ) { |
| 1015 | if ($_ eq "default") { |
1072 | if ($_ eq "default") { |
| 1016 | $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); |
| 1017 | } elsif (/^-(.*)$/) { |
1074 | } elsif (/^-(.*)$/) { |
| 1018 | delete $ext_arg{$1}; |
1075 | delete $ext_arg{$1}; |
| 1019 | } elsif (/^([^<]+)<(.*)>$/) { |
1076 | } elsif (/^([^<]+)<(.*)>$/) { |
| … | |
… | |
| 1095 | } |
1152 | } |
| 1096 | } |
1153 | } |
| 1097 | ($mask, @color{qw(fg bg)}, \@failed) |
1154 | ($mask, @color{qw(fg bg)}, \@failed) |
| 1098 | } |
1155 | } |
| 1099 | |
1156 | |
| 1100 | # urxvt::term::extension |
|
|
| 1101 | |
|
|
| 1102 | package urxvt::term::extension; |
1157 | package urxvt::term::extension; |
| 1103 | |
1158 | |
| 1104 | sub enable { |
1159 | sub enable { |
| 1105 | my ($self, %hook) = @_; |
1160 | my ($self, %hook) = @_; |
| 1106 | my $pkg = $self->{_pkg}; |
1161 | my $pkg = $self->{_pkg}; |
| … | |
… | |
| 1160 | |
1215 | |
| 1161 | sub urxvt::destroy_hook(&) { |
1216 | sub urxvt::destroy_hook(&) { |
| 1162 | bless \shift, urxvt::destroy_hook:: |
1217 | bless \shift, urxvt::destroy_hook:: |
| 1163 | } |
1218 | } |
| 1164 | |
1219 | |
|
|
1220 | sub x_resource { |
|
|
1221 | my ($self, $name) = @_; |
|
|
1222 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
1223 | $self->{term}->x_resource ($name) |
|
|
1224 | } |
|
|
1225 | |
|
|
1226 | sub x_resource_boolean { |
|
|
1227 | my ($self, $name) = @_; |
|
|
1228 | $name =~ s/^%(\.|$)/$_[0]{_name}$1/; |
|
|
1229 | $self->{term}->x_resource_boolean ($name) |
|
|
1230 | } |
|
|
1231 | |
| 1165 | package urxvt::anyevent; |
1232 | package urxvt::anyevent; |
| 1166 | |
1233 | |
| 1167 | =head2 The C<urxvt::anyevent> Class |
1234 | =head2 The C<urxvt::anyevent> Class |
| 1168 | |
1235 | |
| 1169 | The sole purpose of this class is to deliver an interface to the |
1236 | The sole purpose of this class is to deliver an interface to the |
| 1170 | C<AnyEvent> module - any module using it will work inside urxvt without |
1237 | C<AnyEvent> module - any module using it will work inside urxvt without |
| 1171 | further programming. The only exception is that you cannot wait on |
1238 | further programming. The only exception is that you cannot wait on |
| 1172 | condition variables, but non-blocking condvar use is ok. What this means |
1239 | condition variables, but non-blocking condvar use is ok. |
| 1173 | is that you cannot use blocking APIs, but the non-blocking variant should |
1240 | |
| 1174 | work. |
1241 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
1242 | the non-blocking variant should work. |
| 1175 | |
1243 | |
| 1176 | =cut |
1244 | =cut |
| 1177 | |
1245 | |
| 1178 | our $VERSION = '5.23'; |
1246 | our $VERSION = '5.23'; |
| 1179 | |
1247 | |
| … | |
… | |
| 1263 | urxvt::verbose 6, "register package $pkg to $self"; |
1331 | urxvt::verbose 6, "register package $pkg to $self"; |
| 1264 | |
1332 | |
| 1265 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
1333 | @{"$pkg\::ISA"} = urxvt::term::extension::; |
| 1266 | |
1334 | |
| 1267 | my $proxy = bless { |
1335 | my $proxy = bless { |
| 1268 | _pkg => $pkg, |
1336 | _pkg => $pkg, |
|
|
1337 | _name => ${"$pkg\::_NAME"}, # hackish |
| 1269 | argv => $argv, |
1338 | argv => $argv, |
| 1270 | }, $pkg; |
1339 | }, $pkg; |
| 1271 | Scalar::Util::weaken ($proxy->{term} = $self); |
1340 | Scalar::Util::weaken ($proxy->{term} = $self); |
| 1272 | |
1341 | |
| 1273 | $self->{_pkg}{$pkg} = $proxy; |
1342 | $self->{_pkg}{$pkg} = $proxy; |
| 1274 | |
1343 | |
| 1275 | for my $name (@HOOKNAME) { |
1344 | for my $name (@HOOKNAME) { |
| 1276 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
1345 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
| 1277 | $proxy->enable ($name => $ref); |
1346 | $proxy->enable ($name => $ref); |
|
|
1347 | } |
|
|
1348 | } |
|
|
1349 | } |
|
|
1350 | |
|
|
1351 | sub 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 | |
|
|
1359 | sub 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 | } |
| 1278 | } |
1394 | } |
| 1279 | } |
1395 | } |
| 1280 | } |
1396 | } |
| 1281 | |
1397 | |
| 1282 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1398 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
| … | |
… | |
| 1399 | Returns the X-Resource for the given pattern, excluding the program or |
1515 | Returns the X-Resource for the given pattern, excluding the program or |
| 1400 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
1516 | class name, i.e. C<< $term->x_resource ("boldFont") >> should return the |
| 1401 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
1517 | same value as used by this instance of rxvt-unicode. Returns C<undef> if no |
| 1402 | resource with that pattern exists. |
1518 | resource with that pattern exists. |
| 1403 | |
1519 | |
|
|
1520 | Extensions that define extra resource or command line arguments also need |
|
|
1521 | to call this method to access their values. |
|
|
1522 | |
|
|
1523 | If the method is called on an extension object (basically, from an |
|
|
1524 | extension), then the special prefix C<%.> will be replaced by the name of |
|
|
1525 | the extension and a dot, and the lone string C<%> will be replcaed by the |
|
|
1526 | extension name itself. This makes it possible to code extensions so you |
|
|
1527 | can rename them and get a new set of commandline switches and resources |
|
|
1528 | without having to change the actual code. |
|
|
1529 | |
| 1404 | This method should only be called during the C<on_start> hook, as there is |
1530 | This method should only be called during the C<on_start> hook, as there is |
| 1405 | only one resource database per display, and later invocations might return |
1531 | only one resource database per display, and later invocations might return |
| 1406 | the wrong resources. |
1532 | the wrong resources. |
|
|
1533 | |
|
|
1534 | =item $value = $term->x_resource_boolean ($pattern) |
|
|
1535 | |
|
|
1536 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1537 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1538 | the resource or option isn't specified. |
|
|
1539 | |
|
|
1540 | You should always use this method to parse boolean resources. |
|
|
1541 | |
|
|
1542 | =cut |
|
|
1543 | |
|
|
1544 | sub x_resource_boolean { |
|
|
1545 | my $res = &x_resource; |
|
|
1546 | |
|
|
1547 | $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 |
|
|
1548 | } |
| 1407 | |
1549 | |
| 1408 | =item $success = $term->parse_keysym ($key, $octets) |
1550 | =item $success = $term->parse_keysym ($key, $octets) |
| 1409 | |
1551 | |
| 1410 | Adds a key binding exactly as specified via a resource. See the |
1552 | Adds a key binding exactly as specified via a resource. See the |
| 1411 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1553 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
