… | |
… | |
400 | =item confirm-paste |
400 | =item confirm-paste |
401 | |
401 | |
402 | Displays a confirmation dialog when a paste containing at least a full |
402 | Displays a confirmation dialog when a paste containing at least a full |
403 | line is detected. |
403 | line is detected. |
404 | |
404 | |
|
|
405 | =item bell-command |
|
|
406 | |
|
|
407 | Runs the command specified by the C<URxvt.bell-command> resource when |
|
|
408 | a bell event occurs. For example, the following pops up a notification |
|
|
409 | bubble 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 | |
440 | Either binary data or - more common - a text string encoded in a |
448 | Either binary data or - more common - a text string encoded in a |
441 | locale-specific way. |
449 | locale-specific way. |
|
|
450 | |
|
|
451 | =item $keysym |
|
|
452 | |
|
|
453 | an integer that is a valid X11 keysym code. You can convert a string |
|
|
454 | into a keysym and viceversa by using C<XStringToKeysym> and |
|
|
455 | C<XKeysymToString>. |
442 | |
456 | |
443 | =back |
457 | =back |
444 | |
458 | |
445 | =head2 Extension Objects |
459 | =head2 Extension Objects |
446 | |
460 | |
… | |
… | |
658 | resource in the @@RXVT_NAME@@(1) manpage). |
672 | resource in the @@RXVT_NAME@@(1) manpage). |
659 | |
673 | |
660 | The event is simply the action string. This interface is assumed to change |
674 | The event is simply the action string. This interface is assumed to change |
661 | slightly in the future. |
675 | slightly in the future. |
662 | |
676 | |
|
|
677 | =item on_register_command $term, $keysym, $modifiermask, $string |
|
|
678 | |
|
|
679 | Called after parsing a keysym resource but before registering the |
|
|
680 | associated binding. If this hook returns TRUE the binding is not |
|
|
681 | registered. It can be used to modify a binding by calling |
|
|
682 | C<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 | |
665 | Called just after the new window size has been calculated, but before |
686 | Called just after the new window size has been calculated, but before |
666 | windows are actually being resized or hints are being set. If this hook |
687 | windows are actually being resized or hints are being set. If this hook |
667 | returns TRUE, setting of the window hints is being skipped. |
688 | returns TRUE, setting of the window hints is being skipped. |
… | |
… | |
741 | use Scalar::Util (); |
762 | use Scalar::Util (); |
742 | use List::Util (); |
763 | use List::Util (); |
743 | |
764 | |
744 | our $VERSION = 1; |
765 | our $VERSION = 1; |
745 | our $TERM; |
766 | our $TERM; |
746 | our @TERM_INIT; |
767 | our @TERM_INIT; # should go, prevents async I/O etc. |
747 | our @TERM_EXT; |
768 | our @TERM_EXT; # should go, prevents async I/O etc. |
748 | our @HOOKNAME; |
769 | our @HOOKNAME; |
749 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
770 | our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; |
750 | our %OPTION; |
771 | our %OPTION; |
751 | |
772 | |
752 | our $LIBDIR; |
773 | our $LIBDIR; |
… | |
… | |
922 | }; |
943 | }; |
923 | } |
944 | } |
924 | |
945 | |
925 | no warnings 'utf8'; |
946 | no warnings 'utf8'; |
926 | |
947 | |
|
|
948 | sub 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 | |
|
|
979 | sub 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 | |
927 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
1007 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
928 | |
1008 | |
929 | sub verbose { |
1009 | sub verbose { |
930 | my ($level, $msg) = @_; |
1010 | my ($level, $msg) = @_; |
931 | warn "$msg\n" if $level <= $verbosity; |
1011 | warn "$msg\n" if $level <= $verbosity; |
… | |
… | |
967 | sub invoke { |
1047 | sub 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 | |
1140 | The sole purpose of this class is to deliver an interface to the |
1220 | The sole purpose of this class is to deliver an interface to the |
1141 | C<AnyEvent> module - any module using it will work inside urxvt without |
1221 | C<AnyEvent> module - any module using it will work inside urxvt without |
1142 | further programming. The only exception is that you cannot wait on |
1222 | further programming. The only exception is that you cannot wait on |
1143 | condition variables, but non-blocking condvar use is ok. What this means |
1223 | condition variables, but non-blocking condvar use is ok. |
1144 | is that you cannot use blocking APIs, but the non-blocking variant should |
1224 | |
1145 | work. |
1225 | In practical terms this means is that you cannot use blocking APIs, but |
|
|
1226 | the non-blocking variant should work. |
1146 | |
1227 | |
1147 | =cut |
1228 | =cut |
1148 | |
1229 | |
1149 | our $VERSION = '5.23'; |
1230 | our $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 | |
|
|
1334 | sub 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 | |
|
|
1342 | sub 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./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 | |
1375 | This method should only be called during the C<on_start> hook, as there is |
1503 | This method should only be called during the C<on_start> hook, as there is |
1376 | only one resource database per display, and later invocations might return |
1504 | only one resource database per display, and later invocations might return |
1377 | the wrong resources. |
1505 | the wrong resources. |
1378 | |
1506 | |
1379 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1507 | =item $value = $term->x_resource_boolean ($pattern) |
1380 | |
1508 | |
|
|
1509 | Like C<x_resource>, above, but interprets the string value as a boolean |
|
|
1510 | and returns C<1> for true values, C<0> for false values and C<undef> if |
|
|
1511 | the resource or option isn't specified. |
|
|
1512 | |
|
|
1513 | You should always use this method to parse boolean resources. |
|
|
1514 | |
|
|
1515 | =cut |
|
|
1516 | |
|
|
1517 | sub 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 | |
1381 | Adds a keymap translation exactly as specified via a resource. See the |
1525 | Adds a key binding exactly as specified via a resource. See the |
1382 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1526 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
1527 | |
|
|
1528 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1529 | |
|
|
1530 | Adds a key binding. This is a lower level api compared to |
|
|
1531 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1532 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1533 | C<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 | |
1386 | Return and optionally change the current rendition. Text that is output by |
1537 | Return and optionally change the current rendition. Text that is output by |
1387 | the terminal application will use this style. |
1538 | the terminal application will use this style. |
… | |
… | |
1600 | |
1751 | |
1601 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1752 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1602 | to receive pointer events all the times: |
1753 | to 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 | |
|
|
1759 | Enable/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 | |
1931 | Various X or X-related functions. The C<$term> object only serves as |
2090 | Various X or X-related functions. The C<$term> object only serves as |
1932 | the source of the display, otherwise those functions map more-or-less |
2091 | the source of the display, otherwise those functions map more-or-less |
1933 | directly onto the X functions of the same name. |
2092 | directly onto the X functions of the same name. |
1934 | |
2093 | |