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.198 by root, Tue Oct 4 22:25:14 2011 UTC vs.
Revision 1.214 by root, Wed Jun 6 15:26:32 2012 UTC

… …
400=item confirm-paste 400=item confirm-paste
401 401
402Displays a confirmation dialog when a paste containing at least a full 402Displays a confirmation dialog when a paste containing at least a full
403line is detected. 403line is detected.
404 404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
412
405=back 413=back
406 414
407=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
408 416
409=head2 General API Considerations 417=head2 General API Considerations
… …
437 445
438=item $octets 446=item $octets
439 447
440Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
441locale-specific way. 449locale-specific way.
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>.
442 456
443=back 457=back
444 458
445=head2 Extension Objects 459=head2 Extension Objects
446 460
… …
658resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
659 673
660The 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
661slightly in the future. 675slightly in the future.
662 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
663=item on_resize_all_windows $term, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
664 685
665Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
666windows 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
667returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
… …
741use Scalar::Util (); 762use Scalar::Util ();
742use List::Util (); 763use List::Util ();
743 764
744our $VERSION = 1; 765our $VERSION = 1;
745our $TERM; 766our $TERM;
746our @TERM_INIT; 767our @TERM_INIT; # should go, prevents async I/O etc.
747our @TERM_EXT; 768our @TERM_EXT; # should go, prevents async I/O etc.
748our @HOOKNAME; 769our @HOOKNAME;
749our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
750our %OPTION; 771our %OPTION;
751 772
752our $LIBDIR; 773our $LIBDIR;
… …
922 }; 943 };
923} 944}
924 945
925no warnings 'utf8'; 946no warnings 'utf8';
926 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 =~ /\.$/
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 $pattern =~ s/\.$/.*/g;
1002 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1003 }
1004 }
1005}
1006
927my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1007my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
928 1008
929sub verbose { 1009sub verbose {
930 my ($level, $msg) = @_; 1010 my ($level, $msg) = @_;
931 warn "$msg\n" if $level <= $verbosity; 1011 warn "$msg\n" if $level <= $verbosity;
… …
967sub invoke { 1047sub invoke {
968 local $TERM = shift; 1048 local $TERM = shift;
969 my $htype = shift; 1049 my $htype = shift;
970 1050
971 if ($htype == 0) { # INIT 1051 if ($htype == 0) { # INIT
972 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1052 my @dirs = $TERM->perl_libdirs;
973 1053
974 my %ext_arg; 1054 my %ext_arg;
975 1055
976 { 1056 {
977 my @init = @TERM_INIT; 1057 my @init = @TERM_INIT;
… …
1138=head2 The C<urxvt::anyevent> Class 1218=head2 The C<urxvt::anyevent> Class
1139 1219
1140The sole purpose of this class is to deliver an interface to the 1220The sole purpose of this class is to deliver an interface to the
1141C<AnyEvent> module - any module using it will work inside urxvt without 1221C<AnyEvent> module - any module using it will work inside urxvt without
1142further programming. The only exception is that you cannot wait on 1222further programming. The only exception is that you cannot wait on
1143condition variables, but non-blocking condvar use is ok. What this means 1223condition variables, but non-blocking condvar use is ok.
1144is that you cannot use blocking APIs, but the non-blocking variant should 1224
1145work. 1225In practical terms this means is that you cannot use blocking APIs, but
1226the non-blocking variant should work.
1146 1227
1147=cut 1228=cut
1148 1229
1149our $VERSION = '5.23'; 1230our $VERSION = '5.23';
1150 1231
… …
1244 $self->{_pkg}{$pkg} = $proxy; 1325 $self->{_pkg}{$pkg} = $proxy;
1245 1326
1246 for my $name (@HOOKNAME) { 1327 for my $name (@HOOKNAME) {
1247 if (my $ref = $pkg->can ("on_" . lc $name)) { 1328 if (my $ref = $pkg->can ("on_" . lc $name)) {
1248 $proxy->enable ($name => $ref); 1329 $proxy->enable ($name => $ref);
1330 }
1331 }
1332}
1333
1334sub perl_libdirs {
1335 map { split /:/ }
1336 $_[0]->resource ("perl_lib"),
1337 $ENV{URXVT_PERL_LIB},
1338 "$ENV{HOME}/.urxvt/ext",
1339 "$LIBDIR/perl"
1340}
1341
1342sub scan_meta {
1343 my ($self) = @_;
1344 my @libdirs = perl_libdirs $self;
1345
1346 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1347
1348 my %meta;
1349
1350 $self->{meta_libdirs} = join "\x00", @libdirs;
1351 $self->{meta} = \%meta;
1352
1353 for my $dir (reverse @libdirs) {
1354 opendir my $fh, $dir
1355 or next;
1356 for my $ext (readdir $fh) {
1357 $ext ne "."
1358 and $ext ne ".."
1359 and open my $fh, "<", "$dir/$ext"
1360 or next;
1361
1362 while (<$fh>) {
1363 if (/^#:META:X_RESOURCE:(.*)/) {
1364 my ($pattern, $type, $desc) = split /:/, $1;
1365 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1366 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1367 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1368 } else {
1369 $meta{resource}{$pattern} = [$ext, $type, $desc];
1370 }
1371 } elsif (/^\s*(?:#|$)/) {
1372 # skip other comments and empty lines
1373 } else {
1374 last; # stop parsing on first non-empty non-comment line
1375 }
1376 }
1249 } 1377 }
1250 } 1378 }
1251} 1379}
1252 1380
1253=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1381=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
… …
1374 1502
1375This method should only be called during the C<on_start> hook, as there is 1503This method should only be called during the C<on_start> hook, as there is
1376only one resource database per display, and later invocations might return 1504only one resource database per display, and later invocations might return
1377the wrong resources. 1505the wrong resources.
1378 1506
1379=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1507=item $value = $term->x_resource_boolean ($pattern)
1380 1508
1509Like C<x_resource>, above, but interprets the string value as a boolean
1510and returns C<1> for true values, C<0> for false values and C<undef> if
1511the resource or option isn't specified.
1512
1513You should always use this method to parse boolean resources.
1514
1515=cut
1516
1517sub x_resource_boolean {
1518 my $res = &x_resource;
1519
1520 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1521}
1522
1523=item $success = $term->parse_keysym ($key, $octets)
1524
1381Adds a keymap translation exactly as specified via a resource. See the 1525Adds a key binding exactly as specified via a resource. See the
1382C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1526C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1527
1528=item $term->register_command ($keysym, $modifiermask, $string)
1529
1530Adds a key binding. This is a lower level api compared to
1531C<parse_keysym>, as it expects a parsed key description, and can be
1532used only inside either the C<on_init> hook, to add a binding, or the
1533C<on_register_command> hook, to modify a parsed binding.
1383 1534
1384=item $rend = $term->rstyle ([$new_rstyle]) 1535=item $rend = $term->rstyle ([$new_rstyle])
1385 1536
1386Return and optionally change the current rendition. Text that is output by 1537Return and optionally change the current rendition. Text that is output by
1387the terminal application will use this style. 1538the terminal application will use this style.
… …
1600 1751
1601Adds the specified events to the vt event mask. Useful e.g. when you want 1752Adds the specified events to the vt event mask. Useful e.g. when you want
1602to receive pointer events all the times: 1753to receive pointer events all the times:
1603 1754
1604 $term->vt_emask_add (urxvt::PointerMotionMask); 1755 $term->vt_emask_add (urxvt::PointerMotionMask);
1756
1757=item $term->set_urgency ($set)
1758
1759Enable/disable the urgency hint on the toplevel window.
1605 1760
1606=item $term->focus_in 1761=item $term->focus_in
1607 1762
1608=item $term->focus_out 1763=item $term->focus_out
1609 1764
… …
1925=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2080=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1926 2081
1927=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2082=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1928 2083
1929=item $term->XChangeInput ($window, $add_events[, $del_events]) 2084=item $term->XChangeInput ($window, $add_events[, $del_events])
2085
2086=item $keysym = $term->XStringToKeysym ($string)
2087
2088=item $string = $term->XKeysymToString ($keysym)
1930 2089
1931Various X or X-related functions. The C<$term> object only serves as 2090Various X or X-related functions. The C<$term> object only serves as
1932the source of the display, otherwise those functions map more-or-less 2091the source of the display, otherwise those functions map more-or-less
1933directly onto the X functions of the same name. 2092directly onto the X functions of the same name.
1934 2093

Diff Legend

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