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.195 by sf-exg, Wed Jun 29 22:18:11 2011 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 2012 UTC

20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
259The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
263 263
264It is possible to activate the most recently seen match from the keyboard. 264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265Simply bind a keysym to "perl:matcher" as seen in the example below. 266"perl:matcher:list" as seen in the example below.
266 267
267Example configuration: 268Example configuration:
268 269
269 URxvt.perl-ext: default,matcher 270 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser 271 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher 272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
272 URxvt.matcher.button: 1 274 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1 277 URxvt.matcher.launcher.2: gvim +$2 $1
276 278
398=item confirm-paste 400=item confirm-paste
399 401
400Displays a confirmation dialog when a paste containing at least a full 402Displays a confirmation dialog when a paste containing at least a full
401line is detected. 403line is detected.
402 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
403=back 413=back
404 414
405=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
406 416
407=head2 General API Considerations 417=head2 General API Considerations
435 445
436=item $octets 446=item $octets
437 447
438Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
439locale-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>.
440 456
441=back 457=back
442 458
443=head2 Extension Objects 459=head2 Extension Objects
444 460
656resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
657 673
658The 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
659slightly in the future. 675slightly in the future.
660 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
661=item on_resize_all_windows $term, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
662 685
663Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
664windows 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
665returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
732=cut 755=cut
733 756
734package urxvt; 757package urxvt;
735 758
736use utf8; 759use utf8;
737use strict; 760use strict 'vars';
738use Carp (); 761use Carp ();
739use Scalar::Util (); 762use Scalar::Util ();
740use List::Util (); 763use List::Util ();
741 764
742our $VERSION = 1; 765our $VERSION = 1;
743our $TERM; 766our $TERM;
744our @TERM_INIT; 767our @TERM_INIT; # should go, prevents async I/O etc.
745our @TERM_EXT; 768our @TERM_EXT; # should go, prevents async I/O etc.
746our @HOOKNAME; 769our @HOOKNAME;
747our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
748our %OPTION; 771our %OPTION;
749 772
750our $LIBDIR; 773our $LIBDIR;
920 }; 943 };
921} 944}
922 945
923no warnings 'utf8'; 946no warnings 'utf8';
924 947
948sub parse_resource {
949 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950
951 $name =~ y/-/./ if $isarg;
952
953 $term->scan_meta;
954
955 my $r = $term->{meta}{resource};
956 keys %$r; # reste iterator
957 while (my ($pattern, $v) = each %$r) {
958 if (
959 $pattern =~ /\.$/
960 ? $pattern eq substr $name, 0, length $pattern
961 : $pattern eq $name
962 ) {
963 $name = "$urxvt::RESCLASS.$name";
964
965 push @{ $term->{perl_ext_3} }, $v->[0];
966
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 $pattern =~ s/\.$/.*/g;
1003 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1004 }
1005 }
1006}
1007
925my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1008my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
926 1009
927sub verbose { 1010sub verbose {
928 my ($level, $msg) = @_; 1011 my ($level, $msg) = @_;
929 warn "$msg\n" if $level <= $verbosity; 1012 warn "$msg\n" if $level <= $verbosity;
941 $pkg =~ s/[^[:word:]]/_/g; 1024 $pkg =~ s/[^[:word:]]/_/g;
942 $pkg = "urxvt::ext::$pkg"; 1025 $pkg = "urxvt::ext::$pkg";
943 1026
944 verbose 3, "loading extension '$path' into package '$pkg'"; 1027 verbose 3, "loading extension '$path' into package '$pkg'";
945 1028
1029 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
1030
946 open my $fh, "<:raw", $path 1031 open my $fh, "<:raw", $path
947 or die "$path: $!"; 1032 or die "$path: $!";
948 1033
949 my $source = 1034 my $source =
950 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 1035 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
951 . "#line 1 \"$path\"\n{\n" 1036 . "#line 1 \"$path\"\n{\n"
952 . (do { local $/; <$fh> }) 1037 . (do { local $/; <$fh> })
953 . "\n};\n1"; 1038 . "\n};\n1";
954 1039
955 eval $source 1040 eval $source
965sub invoke { 1050sub invoke {
966 local $TERM = shift; 1051 local $TERM = shift;
967 my $htype = shift; 1052 my $htype = shift;
968 1053
969 if ($htype == 0) { # INIT 1054 if ($htype == 0) { # INIT
970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1055 my @dirs = $TERM->perl_libdirs;
971 1056
972 my %ext_arg; 1057 my %ext_arg;
973 1058
974 { 1059 {
975 my @init = @TERM_INIT; 1060 my @init = @TERM_INIT;
978 my @pkg = @TERM_EXT; 1063 my @pkg = @TERM_EXT;
979 @TERM_EXT = (); 1064 @TERM_EXT = ();
980 $TERM->register_package ($_) for @pkg; 1065 $TERM->register_package ($_) for @pkg;
981 } 1066 }
982 1067
1068 for (
1069 @{ delete $TERM->{perl_ext_3} },
983 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1070 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
1071 ) {
984 if ($_ eq "default") { 1072 if ($_ eq "default") {
985 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 1073 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
986 } elsif (/^-(.*)$/) { 1074 } elsif (/^-(.*)$/) {
987 delete $ext_arg{$1}; 1075 delete $ext_arg{$1};
988 } elsif (/^([^<]+)<(.*)>$/) { 1076 } elsif (/^([^<]+)<(.*)>$/) {
1064 } 1152 }
1065 } 1153 }
1066 ($mask, @color{qw(fg bg)}, \@failed) 1154 ($mask, @color{qw(fg bg)}, \@failed)
1067} 1155}
1068 1156
1069# urxvt::term::extension
1070
1071package urxvt::term::extension; 1157package urxvt::term::extension;
1072 1158
1073sub enable { 1159sub enable {
1074 my ($self, %hook) = @_; 1160 my ($self, %hook) = @_;
1075 my $pkg = $self->{_pkg}; 1161 my $pkg = $self->{_pkg};
1129 1215
1130sub urxvt::destroy_hook(&) { 1216sub urxvt::destroy_hook(&) {
1131 bless \shift, urxvt::destroy_hook:: 1217 bless \shift, urxvt::destroy_hook::
1132} 1218}
1133 1219
1220sub x_resource {
1221 my ($self, $name) = @_;
1222 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1223 $self->{term}->x_resource ($name)
1224}
1225
1226sub x_resource_boolean {
1227 my ($self, $name) = @_;
1228 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1229 $self->{term}->x_resource_boolean ($name)
1230}
1231
1134package urxvt::anyevent; 1232package urxvt::anyevent;
1135 1233
1136=head2 The C<urxvt::anyevent> Class 1234=head2 The C<urxvt::anyevent> Class
1137 1235
1138The sole purpose of this class is to deliver an interface to the 1236The sole purpose of this class is to deliver an interface to the
1139C<AnyEvent> module - any module using it will work inside urxvt without 1237C<AnyEvent> module - any module using it will work inside urxvt without
1140further programming. The only exception is that you cannot wait on 1238further programming. The only exception is that you cannot wait on
1141condition variables, but non-blocking condvar use is ok. What this means 1239condition variables, but non-blocking condvar use is ok.
1142is that you cannot use blocking APIs, but the non-blocking variant should 1240
1143work. 1241In practical terms this means is that you cannot use blocking APIs, but
1242the non-blocking variant should work.
1144 1243
1145=cut 1244=cut
1146 1245
1147our $VERSION = '5.23'; 1246our $VERSION = '5.23';
1148 1247
1207 1306
1208sub DESTROY { 1307sub DESTROY {
1209 $_[0][1]->stop; 1308 $_[0][1]->stop;
1210} 1309}
1211 1310
1311# only needed for AnyEvent < 6 compatibility
1212sub one_event { 1312sub one_event {
1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1313 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1214} 1314}
1215 1315
1216package urxvt::term; 1316package urxvt::term;
1231 urxvt::verbose 6, "register package $pkg to $self"; 1331 urxvt::verbose 6, "register package $pkg to $self";
1232 1332
1233 @{"$pkg\::ISA"} = urxvt::term::extension::; 1333 @{"$pkg\::ISA"} = urxvt::term::extension::;
1234 1334
1235 my $proxy = bless { 1335 my $proxy = bless {
1236 _pkg => $pkg, 1336 _pkg => $pkg,
1337 _name => ${"$pkg\::_NAME"}, # hackish
1237 argv => $argv, 1338 argv => $argv,
1238 }, $pkg; 1339 }, $pkg;
1239 Scalar::Util::weaken ($proxy->{term} = $self); 1340 Scalar::Util::weaken ($proxy->{term} = $self);
1240 1341
1241 $self->{_pkg}{$pkg} = $proxy; 1342 $self->{_pkg}{$pkg} = $proxy;
1242 1343
1245 $proxy->enable ($name => $ref); 1346 $proxy->enable ($name => $ref);
1246 } 1347 }
1247 } 1348 }
1248} 1349}
1249 1350
1351sub perl_libdirs {
1352 map { split /:/ }
1353 $_[0]->resource ("perl_lib"),
1354 $ENV{URXVT_PERL_LIB},
1355 "$ENV{HOME}/.urxvt/ext",
1356 "$LIBDIR/perl"
1357}
1358
1359sub scan_meta {
1360 my ($self) = @_;
1361 my @libdirs = perl_libdirs $self;
1362
1363 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1364
1365 my %meta;
1366
1367 $self->{meta_libdirs} = join "\x00", @libdirs;
1368 $self->{meta} = \%meta;
1369
1370 for my $dir (reverse @libdirs) {
1371 opendir my $fh, $dir
1372 or next;
1373 for my $ext (readdir $fh) {
1374 $ext ne "."
1375 and $ext ne ".."
1376 and open my $fh, "<", "$dir/$ext"
1377 or next;
1378
1379 while (<$fh>) {
1380 if (/^#:META:X_RESOURCE:(.*)/) {
1381 my ($pattern, $type, $desc) = split /:/, $1;
1382 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1383 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1384 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1385 } else {
1386 $meta{resource}{$pattern} = [$ext, $type, $desc];
1387 }
1388 } elsif (/^\s*(?:#|$)/) {
1389 # skip other comments and empty lines
1390 } else {
1391 last; # stop parsing on first non-empty non-comment line
1392 }
1393 }
1394 }
1395 }
1396}
1397
1250=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1398=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1251 1399
1252Creates a new terminal, very similar as if you had started it with system 1400Creates a new terminal, very similar as if you had started it with system
1253C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1401C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1254hash which defines the environment of the new terminal. 1402hash which defines the environment of the new terminal.
1310Here is a likely non-exhaustive list of option names, please see the 1458Here is a likely non-exhaustive list of option names, please see the
1311source file F</src/optinc.h> to see the actual list: 1459source file F</src/optinc.h> to see the actual list:
1312 1460
1313 borderLess buffered console cursorBlink cursorUnderline hold iconic 1461 borderLess buffered console cursorBlink cursorUnderline hold iconic
1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1462 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315 mapAlert meta8 mouseWheelScrollPage override-redirect pastableTabs 1463 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1464 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1465 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1466 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell 1467 urgentOnBell utmpInhibit visualBell
1320 1468
1367Returns the X-Resource for the given pattern, excluding the program or 1515Returns the X-Resource for the given pattern, excluding the program or
1368class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1516class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1369same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1517same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1370resource with that pattern exists. 1518resource with that pattern exists.
1371 1519
1520Extensions that define extra resource or command line arguments also need
1521to call this method to access their values.
1522
1523If the method is called on an extension object (basically, from an
1524extension), then the special prefix C<%.> will be replaced by the name of
1525the extension and a dot, and the lone string C<%> will be replcaed by the
1526extension name itself. This makes it possible to code extensions so you
1527can rename them and get a new set of commandline switches and resources
1528without having to change the actual code.
1529
1372This method should only be called during the C<on_start> hook, as there is 1530This method should only be called during the C<on_start> hook, as there is
1373only one resource database per display, and later invocations might return 1531only one resource database per display, and later invocations might return
1374the wrong resources. 1532the wrong resources.
1375 1533
1376=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1534=item $value = $term->x_resource_boolean ($pattern)
1377 1535
1536Like C<x_resource>, above, but interprets the string value as a boolean
1537and returns C<1> for true values, C<0> for false values and C<undef> if
1538the resource or option isn't specified.
1539
1540You should always use this method to parse boolean resources.
1541
1542=cut
1543
1544sub x_resource_boolean {
1545 my $res = &x_resource;
1546
1547 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1548}
1549
1550=item $success = $term->parse_keysym ($key, $octets)
1551
1378Adds a keymap translation exactly as specified via a resource. See the 1552Adds a key binding exactly as specified via a resource. See the
1379C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1553C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1554
1555=item $term->register_command ($keysym, $modifiermask, $string)
1556
1557Adds a key binding. This is a lower level api compared to
1558C<parse_keysym>, as it expects a parsed key description, and can be
1559used only inside either the C<on_init> hook, to add a binding, or the
1560C<on_register_command> hook, to modify a parsed binding.
1380 1561
1381=item $rend = $term->rstyle ([$new_rstyle]) 1562=item $rend = $term->rstyle ([$new_rstyle])
1382 1563
1383Return and optionally change the current rendition. Text that is output by 1564Return and optionally change the current rendition. Text that is output by
1384the terminal application will use this style. 1565the terminal application will use this style.
1597 1778
1598Adds the specified events to the vt event mask. Useful e.g. when you want 1779Adds the specified events to the vt event mask. Useful e.g. when you want
1599to receive pointer events all the times: 1780to receive pointer events all the times:
1600 1781
1601 $term->vt_emask_add (urxvt::PointerMotionMask); 1782 $term->vt_emask_add (urxvt::PointerMotionMask);
1783
1784=item $term->set_urgency ($set)
1785
1786Enable/disable the urgency hint on the toplevel window.
1602 1787
1603=item $term->focus_in 1788=item $term->focus_in
1604 1789
1605=item $term->focus_out 1790=item $term->focus_out
1606 1791
1922=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2107=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1923 2108
1924=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2109=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1925 2110
1926=item $term->XChangeInput ($window, $add_events[, $del_events]) 2111=item $term->XChangeInput ($window, $add_events[, $del_events])
2112
2113=item $keysym = $term->XStringToKeysym ($string)
2114
2115=item $string = $term->XKeysymToString ($keysym)
1927 2116
1928Various X or X-related functions. The C<$term> object only serves as 2117Various X or X-related functions. The C<$term> object only serves as
1929the source of the display, otherwise those functions map more-or-less 2118the source of the display, otherwise those functions map more-or-less
1930directly onto the X functions of the same name. 2119directly onto the X functions of the same name.
1931 2120

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines