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.210 by root, Wed Jun 6 11:46:11 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
657a C<perl:string> action bound to a key, see description of the B<keysym> 671a C<perl:string> action bound to a key, see description of the B<keysym>
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.
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>.
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
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
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 warn "resourece<@_>\n";#d#
954
955 my $r = $term->{meta}{resource};
956 while (my ($pattern, $v) = each %$r) {
957 $name =~ y/-/./ if $isarg;
958
959 if (
960 $pattern =~ s/\*$//
961 ? $pattern eq substr $name, 0, length $pattern
962 : $pattern eq $name
963 ) {
964 $name = "$urxvt::RESCLASS.$name";
965 warn "set option <$name=$value>\n";#d#
966 #TODO: queue $v->[0] for loading
967 if ($v->[1] eq "boolean") {
968 $term->put_option_db ($name, $flag ? "true" : "false");
969 return 1;
970 } else {
971 $term->put_option_db ($name, $value);
972 return 1 + 2;
973 }
974 }
975 }
976
977 0
978}
979
980sub usage {
981 my ($term, $usage_type) = @_;
982
983 $term->scan_meta;
984
985 my $r = $term->{meta}{resource};
986
987 for my $pattern (sort keys %$r) {
988 my ($ext, $type, $desc) = @{ $r->{$pattern} };
989
990 $desc .= " (-pe $ext)";
991
992 if ($usage_type == 1) {
993 $pattern =~ y/./-/;
994 $pattern =~ s/\*/.../g;
995
996 if ($type eq "boolean") {
997 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
998 } else {
999 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
1000 }
1001 } else {
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
1209 1290
1210sub DESTROY { 1291sub DESTROY {
1211 $_[0][1]->stop; 1292 $_[0][1]->stop;
1212} 1293}
1213 1294
1295# only needed for AnyEvent < 6 compatibility
1214sub one_event { 1296sub one_event {
1215 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1297 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1216} 1298}
1217 1299
1218package urxvt::term; 1300package urxvt::term;
1243 $self->{_pkg}{$pkg} = $proxy; 1325 $self->{_pkg}{$pkg} = $proxy;
1244 1326
1245 for my $name (@HOOKNAME) { 1327 for my $name (@HOOKNAME) {
1246 if (my $ref = $pkg->can ("on_" . lc $name)) { 1328 if (my $ref = $pkg->can ("on_" . lc $name)) {
1247 $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./g; # $$ in pattern == extension name
1366 if ($pattern =~ /[^a-zA-Z\*\.]/) {
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 }
1248 } 1377 }
1249 } 1378 }
1250} 1379}
1251 1380
1252=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1381=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1373 1502
1374This 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
1375only one resource database per display, and later invocations might return 1504only one resource database per display, and later invocations might return
1376the wrong resources. 1505the wrong resources.
1377 1506
1378=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1507=item $success = $term->parse_keysym ($key, $octets)
1379 1508
1380Adds a keymap translation exactly as specified via a resource. See the 1509Adds a key binding exactly as specified via a resource. See the
1381C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1510C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1511
1512=item $term->register_command ($keysym, $modifiermask, $string)
1513
1514Adds a key binding. This is a lower level api compared to
1515C<parse_keysym>, as it expects a parsed key description, and can be
1516used only inside either the C<on_init> hook, to add a binding, or the
1517C<on_register_command> hook, to modify a parsed binding.
1382 1518
1383=item $rend = $term->rstyle ([$new_rstyle]) 1519=item $rend = $term->rstyle ([$new_rstyle])
1384 1520
1385Return and optionally change the current rendition. Text that is output by 1521Return and optionally change the current rendition. Text that is output by
1386the terminal application will use this style. 1522the terminal application will use this style.
1599 1735
1600Adds the specified events to the vt event mask. Useful e.g. when you want 1736Adds the specified events to the vt event mask. Useful e.g. when you want
1601to receive pointer events all the times: 1737to receive pointer events all the times:
1602 1738
1603 $term->vt_emask_add (urxvt::PointerMotionMask); 1739 $term->vt_emask_add (urxvt::PointerMotionMask);
1740
1741=item $term->set_urgency ($set)
1742
1743Enable/disable the urgency hint on the toplevel window.
1604 1744
1605=item $term->focus_in 1745=item $term->focus_in
1606 1746
1607=item $term->focus_out 1747=item $term->focus_out
1608 1748
1924=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2064=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1925 2065
1926=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2066=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1927 2067
1928=item $term->XChangeInput ($window, $add_events[, $del_events]) 2068=item $term->XChangeInput ($window, $add_events[, $del_events])
2069
2070=item $keysym = $term->XStringToKeysym ($string)
2071
2072=item $string = $term->XKeysymToString ($keysym)
1929 2073
1930Various X or X-related functions. The C<$term> object only serves as 2074Various X or X-related functions. The C<$term> object only serves as
1931the source of the display, otherwise those functions map more-or-less 2075the source of the display, otherwise those functions map more-or-less
1932directly onto the X functions of the same name. 2076directly onto the X functions of the same name.
1933 2077

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines