| … | |
… | |
| 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 | |
| … | |
… | |
| 657 | a C<perl:string> action bound to a key, see description of the B<keysym> |
671 | a C<perl:string> action bound to a key, see description of the B<keysym> |
| 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. |
|
|
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>. |
| 662 | |
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 |
| … | |
… | |
| 922 | }; |
943 | }; |
| 923 | } |
944 | } |
| 924 | |
945 | |
| 925 | no warnings 'utf8'; |
946 | no warnings 'utf8'; |
| 926 | |
947 | |
|
|
948 | sub resource { |
|
|
949 | my ($term, $name, $isarg, $flag, $value) = @_; |
|
|
950 | |
|
|
951 | $term->scan_meta; |
|
|
952 | |
|
|
953 | warn "resourece<@_>\n";#d# |
|
|
954 | |
|
|
955 | 0 |
|
|
956 | } |
|
|
957 | |
|
|
958 | sub usage { |
|
|
959 | my ($term, $usage_type) = @_; |
|
|
960 | |
|
|
961 | $term->scan_meta; |
|
|
962 | |
|
|
963 | my $r = $term->{meta}{resource}; |
|
|
964 | |
|
|
965 | for my $regex (sort keys %$r) { |
|
|
966 | my ($ext, $type, $desc) = @{ $r->{$regex} }; |
|
|
967 | |
|
|
968 | $desc .= " (-pe $ext)"; |
|
|
969 | |
|
|
970 | if ($usage_type == 1) { |
|
|
971 | if ($type eq "boolean") { |
|
|
972 | urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc; |
|
|
973 | } else { |
|
|
974 | urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc; |
|
|
975 | } |
|
|
976 | } else { |
|
|
977 | urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type; |
|
|
978 | } |
|
|
979 | } |
|
|
980 | } |
|
|
981 | |
| 927 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
982 | my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; |
| 928 | |
983 | |
| 929 | sub verbose { |
984 | sub verbose { |
| 930 | my ($level, $msg) = @_; |
985 | my ($level, $msg) = @_; |
| 931 | warn "$msg\n" if $level <= $verbosity; |
986 | warn "$msg\n" if $level <= $verbosity; |
| … | |
… | |
| 967 | sub invoke { |
1022 | sub invoke { |
| 968 | local $TERM = shift; |
1023 | local $TERM = shift; |
| 969 | my $htype = shift; |
1024 | my $htype = shift; |
| 970 | |
1025 | |
| 971 | if ($htype == 0) { # INIT |
1026 | if ($htype == 0) { # INIT |
| 972 | my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); |
1027 | my @dirs = $TERM->perl_libdirs; |
| 973 | |
1028 | |
| 974 | my %ext_arg; |
1029 | my %ext_arg; |
| 975 | |
1030 | |
| 976 | { |
1031 | { |
| 977 | my @init = @TERM_INIT; |
1032 | my @init = @TERM_INIT; |
| … | |
… | |
| 1209 | |
1264 | |
| 1210 | sub DESTROY { |
1265 | sub DESTROY { |
| 1211 | $_[0][1]->stop; |
1266 | $_[0][1]->stop; |
| 1212 | } |
1267 | } |
| 1213 | |
1268 | |
|
|
1269 | # only needed for AnyEvent < 6 compatibility |
| 1214 | sub one_event { |
1270 | sub one_event { |
| 1215 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
1271 | Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; |
| 1216 | } |
1272 | } |
| 1217 | |
1273 | |
| 1218 | package urxvt::term; |
1274 | package urxvt::term; |
| … | |
… | |
| 1243 | $self->{_pkg}{$pkg} = $proxy; |
1299 | $self->{_pkg}{$pkg} = $proxy; |
| 1244 | |
1300 | |
| 1245 | for my $name (@HOOKNAME) { |
1301 | for my $name (@HOOKNAME) { |
| 1246 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
1302 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
| 1247 | $proxy->enable ($name => $ref); |
1303 | $proxy->enable ($name => $ref); |
|
|
1304 | } |
|
|
1305 | } |
|
|
1306 | } |
|
|
1307 | |
|
|
1308 | sub perl_libdirs { |
|
|
1309 | map { split /:/ } |
|
|
1310 | $_[0]->resource ("perl_lib"), |
|
|
1311 | $ENV{URXVT_PERL_LIB}, |
|
|
1312 | "$ENV{HOME}/.urxvt/ext", |
|
|
1313 | "$LIBDIR/perl" |
|
|
1314 | } |
|
|
1315 | |
|
|
1316 | sub scan_meta { |
|
|
1317 | my ($self) = @_; |
|
|
1318 | my @libdirs = perl_libdirs $self; |
|
|
1319 | |
|
|
1320 | return if $self->{meta_libdirs} eq join "\x00", @libdirs; |
|
|
1321 | |
|
|
1322 | my %meta; |
|
|
1323 | |
|
|
1324 | $self->{meta_libdirs} = join "\x00", @libdirs; |
|
|
1325 | $self->{meta} = \%meta; |
|
|
1326 | |
|
|
1327 | for my $dir (reverse @libdirs) { |
|
|
1328 | opendir my $fh, $dir |
|
|
1329 | or next; |
|
|
1330 | for my $ext (readdir $fh) { |
|
|
1331 | $ext ne "." |
|
|
1332 | and $ext ne ".." |
|
|
1333 | and open my $fh, "<", "$dir/$ext" |
|
|
1334 | or next; |
|
|
1335 | |
|
|
1336 | while (<$fh>) { |
|
|
1337 | if (/^#:META:RESOURCE:(.*)/) { |
|
|
1338 | my ($regex, $type, $desc) = split /:/, $1; |
|
|
1339 | $regex =~ s/\$\$/$ext/g; # $$ in regex == extension name |
|
|
1340 | $meta{resource}{$regex} = [$ext, $type, $desc]; |
|
|
1341 | } elsif (/^\s*(?:#|$)/) { |
|
|
1342 | # skip other comments and empty lines |
|
|
1343 | } else { |
|
|
1344 | last; # stop parsing on first non-empty non-comment line |
|
|
1345 | } |
|
|
1346 | } |
| 1248 | } |
1347 | } |
| 1249 | } |
1348 | } |
| 1250 | } |
1349 | } |
| 1251 | |
1350 | |
| 1252 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
1351 | =item $term = new urxvt::term $envhashref, $rxvtname, [arg...] |
| … | |
… | |
| 1373 | |
1472 | |
| 1374 | This method should only be called during the C<on_start> hook, as there is |
1473 | This method should only be called during the C<on_start> hook, as there is |
| 1375 | only one resource database per display, and later invocations might return |
1474 | only one resource database per display, and later invocations might return |
| 1376 | the wrong resources. |
1475 | the wrong resources. |
| 1377 | |
1476 | |
| 1378 | =item $success = $term->parse_keysym ($keysym_spec, $command_string) |
1477 | =item $success = $term->parse_keysym ($key, $octets) |
| 1379 | |
1478 | |
| 1380 | Adds a keymap translation exactly as specified via a resource. See the |
1479 | Adds a key binding exactly as specified via a resource. See the |
| 1381 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
1480 | C<keysym> resource in the @@RXVT_NAME@@(1) manpage. |
|
|
1481 | |
|
|
1482 | =item $term->register_command ($keysym, $modifiermask, $string) |
|
|
1483 | |
|
|
1484 | Adds a key binding. This is a lower level api compared to |
|
|
1485 | C<parse_keysym>, as it expects a parsed key description, and can be |
|
|
1486 | used only inside either the C<on_init> hook, to add a binding, or the |
|
|
1487 | C<on_register_command> hook, to modify a parsed binding. |
| 1382 | |
1488 | |
| 1383 | =item $rend = $term->rstyle ([$new_rstyle]) |
1489 | =item $rend = $term->rstyle ([$new_rstyle]) |
| 1384 | |
1490 | |
| 1385 | Return and optionally change the current rendition. Text that is output by |
1491 | Return and optionally change the current rendition. Text that is output by |
| 1386 | the terminal application will use this style. |
1492 | the terminal application will use this style. |
| … | |
… | |
| 1599 | |
1705 | |
| 1600 | Adds the specified events to the vt event mask. Useful e.g. when you want |
1706 | Adds the specified events to the vt event mask. Useful e.g. when you want |
| 1601 | to receive pointer events all the times: |
1707 | to receive pointer events all the times: |
| 1602 | |
1708 | |
| 1603 | $term->vt_emask_add (urxvt::PointerMotionMask); |
1709 | $term->vt_emask_add (urxvt::PointerMotionMask); |
|
|
1710 | |
|
|
1711 | =item $term->set_urgency ($set) |
|
|
1712 | |
|
|
1713 | Enable/disable the urgency hint on the toplevel window. |
| 1604 | |
1714 | |
| 1605 | =item $term->focus_in |
1715 | =item $term->focus_in |
| 1606 | |
1716 | |
| 1607 | =item $term->focus_out |
1717 | =item $term->focus_out |
| 1608 | |
1718 | |
| … | |
… | |
| 1924 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
2034 | =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) |
| 1925 | |
2035 | |
| 1926 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
2036 | =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) |
| 1927 | |
2037 | |
| 1928 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
2038 | =item $term->XChangeInput ($window, $add_events[, $del_events]) |
|
|
2039 | |
|
|
2040 | =item $keysym = $term->XStringToKeysym ($string) |
|
|
2041 | |
|
|
2042 | =item $string = $term->XKeysymToString ($keysym) |
| 1929 | |
2043 | |
| 1930 | Various X or X-related functions. The C<$term> object only serves as |
2044 | Various X or X-related functions. The C<$term> object only serves as |
| 1931 | the source of the display, otherwise those functions map more-or-less |
2045 | the source of the display, otherwise those functions map more-or-less |
| 1932 | directly onto the X functions of the same name. |
2046 | directly onto the X functions of the same name. |
| 1933 | |
2047 | |
