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.201 by sf-exg, Tue Nov 29 19:20:18 2011 UTC vs.
Revision 1.211 by root, Wed Jun 6 14:34:03 2012 UTC

… …
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.
… …
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 $term->scan_meta;
952
953 my $r = $term->{meta}{resource};
954 while (my ($pattern, $v) = each %$r) {
955 $name =~ y/-/./ if $isarg;
956
957 if (
958 $pattern =~ s/\*$//
959 ? $pattern eq substr $name, 0, length $pattern
960 : $pattern eq $name
961 ) {
962 $name = "$urxvt::RESCLASS.$name";
963
964 push @TERM_EXT, $v->[0];
965
966 if ($v->[1] eq "boolean") {
967 $term->put_option_db ($name, $flag ? "true" : "false");
968 return 1;
969 } else {
970 $term->put_option_db ($name, $value);
971 return 1 + 2;
972 }
973 }
974 }
975
976 0
977}
978
979sub usage {
980 my ($term, $usage_type) = @_;
981
982 $term->scan_meta;
983
984 my $r = $term->{meta}{resource};
985
986 for my $pattern (sort keys %$r) {
987 my ($ext, $type, $desc) = @{ $r->{$pattern} };
988
989 $desc .= " (-pe $ext)";
990
991 if ($usage_type == 1) {
992 $pattern =~ y/./-/;
993 $pattern =~ s/\*/.../g;
994
995 if ($type eq "boolean") {
996 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
997 } else {
998 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
999 }
1000 } else {
1001 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1002 }
1003 }
1004}
1005
935my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1006my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
936 1007
937sub verbose { 1008sub verbose {
938 my ($level, $msg) = @_; 1009 my ($level, $msg) = @_;
939 warn "$msg\n" if $level <= $verbosity; 1010 warn "$msg\n" if $level <= $verbosity;
… …
975sub invoke { 1046sub invoke {
976 local $TERM = shift; 1047 local $TERM = shift;
977 my $htype = shift; 1048 my $htype = shift;
978 1049
979 if ($htype == 0) { # INIT 1050 if ($htype == 0) { # INIT
980 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl"); 1051 my @dirs = $TERM->perl_libdirs;
981 1052
982 my %ext_arg; 1053 my %ext_arg;
983 1054
984 { 1055 {
985 my @init = @TERM_INIT; 1056 my @init = @TERM_INIT;
… …
1146=head2 The C<urxvt::anyevent> Class 1217=head2 The C<urxvt::anyevent> Class
1147 1218
1148The sole purpose of this class is to deliver an interface to the 1219The sole purpose of this class is to deliver an interface to the
1149C<AnyEvent> module - any module using it will work inside urxvt without 1220C<AnyEvent> module - any module using it will work inside urxvt without
1150further programming. The only exception is that you cannot wait on 1221further programming. The only exception is that you cannot wait on
1151condition variables, but non-blocking condvar use is ok. What this means 1222condition variables, but non-blocking condvar use is ok.
1152is that you cannot use blocking APIs, but the non-blocking variant should 1223
1153work. 1224In practical terms this means is that you cannot use blocking APIs, but
1225the non-blocking variant should work.
1154 1226
1155=cut 1227=cut
1156 1228
1157our $VERSION = '5.23'; 1229our $VERSION = '5.23';
1158 1230
… …
1252 $self->{_pkg}{$pkg} = $proxy; 1324 $self->{_pkg}{$pkg} = $proxy;
1253 1325
1254 for my $name (@HOOKNAME) { 1326 for my $name (@HOOKNAME) {
1255 if (my $ref = $pkg->can ("on_" . lc $name)) { 1327 if (my $ref = $pkg->can ("on_" . lc $name)) {
1256 $proxy->enable ($name => $ref); 1328 $proxy->enable ($name => $ref);
1329 }
1330 }
1331}
1332
1333sub perl_libdirs {
1334 map { split /:/ }
1335 $_[0]->resource ("perl_lib"),
1336 $ENV{URXVT_PERL_LIB},
1337 "$ENV{HOME}/.urxvt/ext",
1338 "$LIBDIR/perl"
1339}
1340
1341sub scan_meta {
1342 my ($self) = @_;
1343 my @libdirs = perl_libdirs $self;
1344
1345 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1346
1347 my %meta;
1348
1349 $self->{meta_libdirs} = join "\x00", @libdirs;
1350 $self->{meta} = \%meta;
1351
1352 for my $dir (reverse @libdirs) {
1353 opendir my $fh, $dir
1354 or next;
1355 for my $ext (readdir $fh) {
1356 $ext ne "."
1357 and $ext ne ".."
1358 and open my $fh, "<", "$dir/$ext"
1359 or next;
1360
1361 while (<$fh>) {
1362 if (/^#:META:X_RESOURCE:(.*)/) {
1363 my ($pattern, $type, $desc) = split /:/, $1;
1364 $pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
1365 if ($pattern =~ /[^a-zA-Z\*\.]/) {
1366 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1367 } else {
1368 $meta{resource}{$pattern} = [$ext, $type, $desc];
1369 }
1370 } elsif (/^\s*(?:#|$)/) {
1371 # skip other comments and empty lines
1372 } else {
1373 last; # stop parsing on first non-empty non-comment line
1374 }
1375 }
1257 } 1376 }
1258 } 1377 }
1259} 1378}
1260 1379
1261=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1380=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
… …
1382 1501
1383This method should only be called during the C<on_start> hook, as there is 1502This 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 1503only one resource database per display, and later invocations might return
1385the wrong resources. 1504the wrong resources.
1386 1505
1506=item $value = $term->x_resource_boolean ($pattern)
1507
1508Like C<x_resource>, above, but interprets the string value as a boolean
1509and returns C<1> for true values, C<0> for false values and C<undef> if
1510the resource or option isn't specified.
1511
1512You should always use this method to parse boolean resources.
1513
1514=cut
1515
1516sub x_resource_boolean {
1517 my $res = &x_resource;
1518
1519 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1520}
1521
1387=item $success = $term->parse_keysym ($key, $octets) 1522=item $success = $term->parse_keysym ($key, $octets)
1388 1523
1389Adds a key binding exactly as specified via a resource. See the 1524Adds a key binding exactly as specified via a resource. See the
1390C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1525C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1526
1527=item $term->register_command ($keysym, $modifiermask, $string)
1528
1529Adds a key binding. This is a lower level api compared to
1530C<parse_keysym>, as it expects a parsed key description, and can be
1531used only inside either the C<on_init> hook, to add a binding, or the
1532C<on_register_command> hook, to modify a parsed binding.
1391 1533
1392=item $rend = $term->rstyle ([$new_rstyle]) 1534=item $rend = $term->rstyle ([$new_rstyle])
1393 1535
1394Return and optionally change the current rendition. Text that is output by 1536Return and optionally change the current rendition. Text that is output by
1395the terminal application will use this style. 1537the terminal application will use this style.
… …
1608 1750
1609Adds the specified events to the vt event mask. Useful e.g. when you want 1751Adds the specified events to the vt event mask. Useful e.g. when you want
1610to receive pointer events all the times: 1752to receive pointer events all the times:
1611 1753
1612 $term->vt_emask_add (urxvt::PointerMotionMask); 1754 $term->vt_emask_add (urxvt::PointerMotionMask);
1755
1756=item $term->set_urgency ($set)
1757
1758Enable/disable the urgency hint on the toplevel window.
1613 1759
1614=item $term->focus_in 1760=item $term->focus_in
1615 1761
1616=item $term->focus_out 1762=item $term->focus_out
1617 1763
… …
1933=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2079=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1934 2080
1935=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2081=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1936 2082
1937=item $term->XChangeInput ($window, $add_events[, $del_events]) 2083=item $term->XChangeInput ($window, $add_events[, $del_events])
2084
2085=item $keysym = $term->XStringToKeysym ($string)
2086
2087=item $string = $term->XKeysymToString ($keysym)
1938 2088
1939Various X or X-related functions. The C<$term> object only serves as 2089Various X or X-related functions. The C<$term> object only serves as
1940the source of the display, otherwise those functions map more-or-less 2090the source of the display, otherwise those functions map more-or-less
1941directly onto the X functions of the same name. 2091directly onto the X functions of the same name.
1942 2092

Diff Legend

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