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.200 by sf-exg, Sun Nov 20 10:58:58 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
… …
446=item $octets 446=item $octets
447 447
448Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
449locale-specific way. 449locale-specific way.
450 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
451=back 457=back
452 458
453=head2 Extension Objects 459=head2 Extension Objects
454 460
455Every perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
… …
666resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
667 673
668The 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
669slightly in the future. 675slightly in the future.
670 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
671=item on_resize_all_windows $term, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
672 685
673Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
674windows 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
675returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
… …
742=cut 755=cut
743 756
744package urxvt; 757package urxvt;
745 758
746use utf8; 759use utf8;
747use strict; 760use strict 'vars';
748use Carp (); 761use Carp ();
749use Scalar::Util (); 762use Scalar::Util ();
750use List::Util (); 763use List::Util ();
751 764
752our $VERSION = 1; 765our $VERSION = 1;
753our $TERM; 766our $TERM;
754our @TERM_INIT; 767our @TERM_INIT; # should go, prevents async I/O etc.
755our @TERM_EXT; 768our @TERM_EXT; # should go, prevents async I/O etc.
756our @HOOKNAME; 769our @HOOKNAME;
757our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
758our %OPTION; 771our %OPTION;
759 772
760our $LIBDIR; 773our $LIBDIR;
… …
930 }; 943 };
931} 944}
932 945
933no warnings 'utf8'; 946no warnings 'utf8';
934 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
935my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1008my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
936 1009
937sub verbose { 1010sub verbose {
938 my ($level, $msg) = @_; 1011 my ($level, $msg) = @_;
939 warn "$msg\n" if $level <= $verbosity; 1012 warn "$msg\n" if $level <= $verbosity;
… …
951 $pkg =~ s/[^[:word:]]/_/g; 1024 $pkg =~ s/[^[:word:]]/_/g;
952 $pkg = "urxvt::ext::$pkg"; 1025 $pkg = "urxvt::ext::$pkg";
953 1026
954 verbose 3, "loading extension '$path' into package '$pkg'"; 1027 verbose 3, "loading extension '$path' into package '$pkg'";
955 1028
1029 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
1030
956 open my $fh, "<:raw", $path 1031 open my $fh, "<:raw", $path
957 or die "$path: $!"; 1032 or die "$path: $!";
958 1033
959 my $source = 1034 my $source =
960 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 1035 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
961 . "#line 1 \"$path\"\n{\n" 1036 . "#line 1 \"$path\"\n{\n"
962 . (do { local $/; <$fh> }) 1037 . (do { local $/; <$fh> })
963 . "\n};\n1"; 1038 . "\n};\n1";
964 1039
965 eval $source 1040 eval $source
… …
975sub invoke { 1050sub invoke {
976 local $TERM = shift; 1051 local $TERM = shift;
977 my $htype = shift; 1052 my $htype = shift;
978 1053
979 if ($htype == 0) { # INIT 1054 if ($htype == 0) { # INIT
980 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); 1055 my @dirs = $TERM->perl_libdirs;
981 1056
982 my %ext_arg; 1057 my %ext_arg;
983 1058
984 { 1059 {
985 my @init = @TERM_INIT; 1060 my @init = @TERM_INIT;
… …
988 my @pkg = @TERM_EXT; 1063 my @pkg = @TERM_EXT;
989 @TERM_EXT = (); 1064 @TERM_EXT = ();
990 $TERM->register_package ($_) for @pkg; 1065 $TERM->register_package ($_) for @pkg;
991 } 1066 }
992 1067
1068 for (
1069 @{ delete $TERM->{perl_ext_3} },
993 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1070 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
1071 ) {
994 if ($_ eq "default") { 1072 if ($_ eq "default") {
995 $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);
996 } elsif (/^-(.*)$/) { 1074 } elsif (/^-(.*)$/) {
997 delete $ext_arg{$1}; 1075 delete $ext_arg{$1};
998 } elsif (/^([^<]+)<(.*)>$/) { 1076 } elsif (/^([^<]+)<(.*)>$/) {
… …
1074 } 1152 }
1075 } 1153 }
1076 ($mask, @color{qw(fg bg)}, \@failed) 1154 ($mask, @color{qw(fg bg)}, \@failed)
1077} 1155}
1078 1156
1079# urxvt::term::extension
1080
1081package urxvt::term::extension; 1157package urxvt::term::extension;
1082 1158
1083sub enable { 1159sub enable {
1084 my ($self, %hook) = @_; 1160 my ($self, %hook) = @_;
1085 my $pkg = $self->{_pkg}; 1161 my $pkg = $self->{_pkg};
… …
1139 1215
1140sub urxvt::destroy_hook(&) { 1216sub urxvt::destroy_hook(&) {
1141 bless \shift, urxvt::destroy_hook:: 1217 bless \shift, urxvt::destroy_hook::
1142} 1218}
1143 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
1144package urxvt::anyevent; 1232package urxvt::anyevent;
1145 1233
1146=head2 The C<urxvt::anyevent> Class 1234=head2 The C<urxvt::anyevent> Class
1147 1235
1148The 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
1149C<AnyEvent> module - any module using it will work inside urxvt without 1237C<AnyEvent> module - any module using it will work inside urxvt without
1150further programming. The only exception is that you cannot wait on 1238further programming. The only exception is that you cannot wait on
1151condition variables, but non-blocking condvar use is ok. What this means 1239condition variables, but non-blocking condvar use is ok.
1152is that you cannot use blocking APIs, but the non-blocking variant should 1240
1153work. 1241In practical terms this means is that you cannot use blocking APIs, but
1242the non-blocking variant should work.
1154 1243
1155=cut 1244=cut
1156 1245
1157our $VERSION = '5.23'; 1246our $VERSION = '5.23';
1158 1247
… …
1242 urxvt::verbose 6, "register package $pkg to $self"; 1331 urxvt::verbose 6, "register package $pkg to $self";
1243 1332
1244 @{"$pkg\::ISA"} = urxvt::term::extension::; 1333 @{"$pkg\::ISA"} = urxvt::term::extension::;
1245 1334
1246 my $proxy = bless { 1335 my $proxy = bless {
1247 _pkg => $pkg, 1336 _pkg => $pkg,
1337 _name => ${"$pkg\::_NAME"}, # hackish
1248 argv => $argv, 1338 argv => $argv,
1249 }, $pkg; 1339 }, $pkg;
1250 Scalar::Util::weaken ($proxy->{term} = $self); 1340 Scalar::Util::weaken ($proxy->{term} = $self);
1251 1341
1252 $self->{_pkg}{$pkg} = $proxy; 1342 $self->{_pkg}{$pkg} = $proxy;
1253 1343
1254 for my $name (@HOOKNAME) { 1344 for my $name (@HOOKNAME) {
1255 if (my $ref = $pkg->can ("on_" . lc $name)) { 1345 if (my $ref = $pkg->can ("on_" . lc $name)) {
1256 $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 }
1257 } 1394 }
1258 } 1395 }
1259} 1396}
1260 1397
1261=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1398=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
… …
1378Returns the X-Resource for the given pattern, excluding the program or 1515Returns the X-Resource for the given pattern, excluding the program or
1379class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1516class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1380same 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
1381resource with that pattern exists. 1518resource with that pattern exists.
1382 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
1383This 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
1384only one resource database per display, and later invocations might return 1531only one resource database per display, and later invocations might return
1385the wrong resources. 1532the wrong resources.
1386 1533
1387=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1534=item $value = $term->x_resource_boolean ($pattern)
1388 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}
1549
1550=item $success = $term->parse_keysym ($key, $octets)
1551
1389Adds a keymap translation exactly as specified via a resource. See the 1552Adds a key binding exactly as specified via a resource. See the
1390C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1553C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1554
1555=item $term->register_command ($keysym, $modifiermask, $string)
1556
1557Adds a key binding. This is a lower level api compared to
1558C<parse_keysym>, as it expects a parsed key description, and can be
1559used only inside either the C<on_init> hook, to add a binding, or the
1560C<on_register_command> hook, to modify a parsed binding.
1391 1561
1392=item $rend = $term->rstyle ([$new_rstyle]) 1562=item $rend = $term->rstyle ([$new_rstyle])
1393 1563
1394Return and optionally change the current rendition. Text that is output by 1564Return and optionally change the current rendition. Text that is output by
1395the terminal application will use this style. 1565the terminal application will use this style.
… …
1608 1778
1609Adds 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
1610to receive pointer events all the times: 1780to receive pointer events all the times:
1611 1781
1612 $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.
1613 1787
1614=item $term->focus_in 1788=item $term->focus_in
1615 1789
1616=item $term->focus_out 1790=item $term->focus_out
1617 1791
… …
1933=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2107=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1934 2108
1935=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2109=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1936 2110
1937=item $term->XChangeInput ($window, $add_events[, $del_events]) 2111=item $term->XChangeInput ($window, $add_events[, $del_events])
2112
2113=item $keysym = $term->XStringToKeysym ($string)
2114
2115=item $string = $term->XKeysymToString ($keysym)
1938 2116
1939Various X or X-related functions. The C<$term> object only serves as 2117Various X or X-related functions. The C<$term> object only serves as
1940the source of the display, otherwise those functions map more-or-less 2118the source of the display, otherwise those functions map more-or-less
1941directly onto the X functions of the same name. 2119directly onto the X functions of the same name.
1942 2120

Diff Legend

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