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.209 by root, Tue Jun 5 22:38:17 2012 UTC

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
655a 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>
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.
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>.
660 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
920 }; 943 };
921} 944}
922 945
923no warnings 'utf8'; 946no warnings 'utf8';
924 947
948sub resource {
949 my ($term, $name, $isarg, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 warn "resourece<@_>\n";#d#
954
955 0
956}
957
958sub 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
925my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
926 983
927sub verbose { 984sub verbose {
928 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
929 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
965sub invoke { 1022sub invoke {
966 local $TERM = shift; 1023 local $TERM = shift;
967 my $htype = shift; 1024 my $htype = shift;
968 1025
969 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
971 1028
972 my %ext_arg; 1029 my %ext_arg;
973 1030
974 { 1031 {
975 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
1136=head2 The C<urxvt::anyevent> Class 1193=head2 The C<urxvt::anyevent> Class
1137 1194
1138The sole purpose of this class is to deliver an interface to the 1195The sole purpose of this class is to deliver an interface to the
1139C<AnyEvent> module - any module using it will work inside urxvt without 1196C<AnyEvent> module - any module using it will work inside urxvt without
1140further programming. The only exception is that you cannot wait on 1197further programming. The only exception is that you cannot wait on
1141condition variables, but non-blocking condvar use is ok. What this means 1198condition variables, but non-blocking condvar use is ok.
1142is that you cannot use blocking APIs, but the non-blocking variant should 1199
1143work. 1200In practical terms this means is that you cannot use blocking APIs, but
1201the non-blocking variant should work.
1144 1202
1145=cut 1203=cut
1146 1204
1147our $VERSION = '5.23'; 1205our $VERSION = '5.23';
1148 1206
1207 1265
1208sub DESTROY { 1266sub DESTROY {
1209 $_[0][1]->stop; 1267 $_[0][1]->stop;
1210} 1268}
1211 1269
1270# only needed for AnyEvent < 6 compatibility
1212sub one_event { 1271sub one_event {
1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1272 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1214} 1273}
1215 1274
1216package urxvt::term; 1275package urxvt::term;
1245 $proxy->enable ($name => $ref); 1304 $proxy->enable ($name => $ref);
1246 } 1305 }
1247 } 1306 }
1248} 1307}
1249 1308
1309sub perl_libdirs {
1310 map { split /:/ }
1311 $_[0]->resource ("perl_lib"),
1312 $ENV{URXVT_PERL_LIB},
1313 "$ENV{HOME}/.urxvt/ext",
1314 "$LIBDIR/perl"
1315}
1316
1317sub scan_meta {
1318 my ($self) = @_;
1319 my @libdirs = perl_libdirs $self;
1320
1321 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1322
1323 my %meta;
1324
1325 $self->{meta_libdirs} = join "\x00", @libdirs;
1326 $self->{meta} = \%meta;
1327
1328 for my $dir (reverse @libdirs) {
1329 opendir my $fh, $dir
1330 or next;
1331 for my $ext (readdir $fh) {
1332 $ext ne "."
1333 and $ext ne ".."
1334 and open my $fh, "<", "$dir/$ext"
1335 or next;
1336
1337 while (<$fh>) {
1338 if (/^#:META:RESOURCE:(.*)/) {
1339 my ($regex, $type, $desc) = split /:/, $1;
1340 $regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
1341 $meta{resource}{$regex} = [$ext, $type, $desc];
1342 } elsif (/^\s*(?:#|$)/) {
1343 # skip other comments and empty lines
1344 } else {
1345 last; # stop parsing on first non-empty non-comment line
1346 }
1347 }
1348 }
1349 }
1350}
1351
1250=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1352=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1251 1353
1252Creates a new terminal, very similar as if you had started it with system 1354Creates 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 1355C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1254hash which defines the environment of the new terminal. 1356hash which defines the environment of the new terminal.
1310Here is a likely non-exhaustive list of option names, please see the 1412Here is a likely non-exhaustive list of option names, please see the
1311source file F</src/optinc.h> to see the actual list: 1413source file F</src/optinc.h> to see the actual list:
1312 1414
1313 borderLess buffered console cursorBlink cursorUnderline hold iconic 1415 borderLess buffered console cursorBlink cursorUnderline hold iconic
1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1416 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315 mapAlert meta8 mouseWheelScrollPage override-redirect pastableTabs 1417 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1418 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1419 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1420 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell 1421 urgentOnBell utmpInhibit visualBell
1320 1422
1371 1473
1372This method should only be called during the C<on_start> hook, as there is 1474This 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 1475only one resource database per display, and later invocations might return
1374the wrong resources. 1476the wrong resources.
1375 1477
1376=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1478=item $success = $term->parse_keysym ($key, $octets)
1377 1479
1378Adds a keymap translation exactly as specified via a resource. See the 1480Adds a key binding exactly as specified via a resource. See the
1379C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1481C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1482
1483=item $term->register_command ($keysym, $modifiermask, $string)
1484
1485Adds a key binding. This is a lower level api compared to
1486C<parse_keysym>, as it expects a parsed key description, and can be
1487used only inside either the C<on_init> hook, to add a binding, or the
1488C<on_register_command> hook, to modify a parsed binding.
1380 1489
1381=item $rend = $term->rstyle ([$new_rstyle]) 1490=item $rend = $term->rstyle ([$new_rstyle])
1382 1491
1383Return and optionally change the current rendition. Text that is output by 1492Return and optionally change the current rendition. Text that is output by
1384the terminal application will use this style. 1493the terminal application will use this style.
1597 1706
1598Adds the specified events to the vt event mask. Useful e.g. when you want 1707Adds the specified events to the vt event mask. Useful e.g. when you want
1599to receive pointer events all the times: 1708to receive pointer events all the times:
1600 1709
1601 $term->vt_emask_add (urxvt::PointerMotionMask); 1710 $term->vt_emask_add (urxvt::PointerMotionMask);
1711
1712=item $term->set_urgency ($set)
1713
1714Enable/disable the urgency hint on the toplevel window.
1602 1715
1603=item $term->focus_in 1716=item $term->focus_in
1604 1717
1605=item $term->focus_out 1718=item $term->focus_out
1606 1719
1922=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2035=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1923 2036
1924=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2037=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1925 2038
1926=item $term->XChangeInput ($window, $add_events[, $del_events]) 2039=item $term->XChangeInput ($window, $add_events[, $del_events])
2040
2041=item $keysym = $term->XStringToKeysym ($string)
2042
2043=item $string = $term->XKeysymToString ($keysym)
1927 2044
1928Various X or X-related functions. The C<$term> object only serves as 2045Various X or X-related functions. The C<$term> object only serves as
1929the source of the display, otherwise those functions map more-or-less 2046the source of the display, otherwise those functions map more-or-less
1930directly onto the X functions of the same name. 2047directly onto the X functions of the same name.
1931 2048

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines