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.197 by sf-tpope, Fri Aug 19 23:08:35 2011 UTC vs.
Revision 1.211 by root, Wed Jun 6 14:34:03 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 =~ 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
927my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1006my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
928 1007
929sub verbose { 1008sub verbose {
930 my ($level, $msg) = @_; 1009 my ($level, $msg) = @_;
931 warn "$msg\n" if $level <= $verbosity; 1010 warn "$msg\n" if $level <= $verbosity;
… …
967sub invoke { 1046sub invoke {
968 local $TERM = shift; 1047 local $TERM = shift;
969 my $htype = shift; 1048 my $htype = shift;
970 1049
971 if ($htype == 0) { # INIT 1050 if ($htype == 0) { # INIT
972 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1051 my @dirs = $TERM->perl_libdirs;
973 1052
974 my %ext_arg; 1053 my %ext_arg;
975 1054
976 { 1055 {
977 my @init = @TERM_INIT; 1056 my @init = @TERM_INIT;
… …
1138=head2 The C<urxvt::anyevent> Class 1217=head2 The C<urxvt::anyevent> Class
1139 1218
1140The 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
1141C<AnyEvent> module - any module using it will work inside urxvt without 1220C<AnyEvent> module - any module using it will work inside urxvt without
1142further programming. The only exception is that you cannot wait on 1221further programming. The only exception is that you cannot wait on
1143condition variables, but non-blocking condvar use is ok. What this means 1222condition variables, but non-blocking condvar use is ok.
1144is that you cannot use blocking APIs, but the non-blocking variant should 1223
1145work. 1224In practical terms this means is that you cannot use blocking APIs, but
1225the non-blocking variant should work.
1146 1226
1147=cut 1227=cut
1148 1228
1149our $VERSION = '5.23'; 1229our $VERSION = '5.23';
1150 1230
… …
1209 1289
1210sub DESTROY { 1290sub DESTROY {
1211 $_[0][1]->stop; 1291 $_[0][1]->stop;
1212} 1292}
1213 1293
1294# only needed for AnyEvent < 6 compatibility
1214sub one_event { 1295sub one_event {
1215 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1296 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1216} 1297}
1217 1298
1218package urxvt::term; 1299package urxvt::term;
… …
1243 $self->{_pkg}{$pkg} = $proxy; 1324 $self->{_pkg}{$pkg} = $proxy;
1244 1325
1245 for my $name (@HOOKNAME) { 1326 for my $name (@HOOKNAME) {
1246 if (my $ref = $pkg->can ("on_" . lc $name)) { 1327 if (my $ref = $pkg->can ("on_" . lc $name)) {
1247 $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 }
1248 } 1376 }
1249 } 1377 }
1250} 1378}
1251 1379
1252=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1380=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
… …
1373 1501
1374This 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
1375only one resource database per display, and later invocations might return 1503only one resource database per display, and later invocations might return
1376the wrong resources. 1504the wrong resources.
1377 1505
1378=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1506=item $value = $term->x_resource_boolean ($pattern)
1379 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
1522=item $success = $term->parse_keysym ($key, $octets)
1523
1380Adds a keymap translation exactly as specified via a resource. See the 1524Adds a key binding exactly as specified via a resource. See the
1381C<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.
1382 1533
1383=item $rend = $term->rstyle ([$new_rstyle]) 1534=item $rend = $term->rstyle ([$new_rstyle])
1384 1535
1385Return and optionally change the current rendition. Text that is output by 1536Return and optionally change the current rendition. Text that is output by
1386the terminal application will use this style. 1537the terminal application will use this style.
… …
1599 1750
1600Adds 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
1601to receive pointer events all the times: 1752to receive pointer events all the times:
1602 1753
1603 $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.
1604 1759
1605=item $term->focus_in 1760=item $term->focus_in
1606 1761
1607=item $term->focus_out 1762=item $term->focus_out
1608 1763
… …
1924=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2079=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1925 2080
1926=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2081=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1927 2082
1928=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)
1929 2088
1930Various 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
1931the source of the display, otherwise those functions map more-or-less 2090the source of the display, otherwise those functions map more-or-less
1932directly onto the X functions of the same name. 2091directly onto the X functions of the same name.
1933 2092

Diff Legend

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