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.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 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;
1207 1264
1208sub DESTROY { 1265sub DESTROY {
1209 $_[0][1]->stop; 1266 $_[0][1]->stop;
1210} 1267}
1211 1268
1269# only needed for AnyEvent < 6 compatibility
1212sub one_event { 1270sub one_event {
1213 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";
1214} 1272}
1215 1273
1216package urxvt::term; 1274package urxvt::term;
1245 $proxy->enable ($name => $ref); 1303 $proxy->enable ($name => $ref);
1246 } 1304 }
1247 } 1305 }
1248} 1306}
1249 1307
1308sub 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
1316sub 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 }
1347 }
1348 }
1349}
1350
1250=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1351=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1251 1352
1252Creates a new terminal, very similar as if you had started it with system 1353Creates 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 1354C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1254hash which defines the environment of the new terminal. 1355hash which defines the environment of the new terminal.
1308C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1409C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1309 1410
1310Here is a likely non-exhaustive list of option names, please see the 1411Here is a likely non-exhaustive list of option names, please see the
1311source file F</src/optinc.h> to see the actual list: 1412source file F</src/optinc.h> to see the actual list:
1312 1413
1313 borderLess console cursorBlink cursorUnderline hold iconic insecure 1414 borderLess buffered console cursorBlink cursorUnderline hold iconic
1314 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1415 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1416 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1417 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1418 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318 transparent tripleclickwords utmpInhibit visualBell 1419 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1420 urgentOnBell utmpInhibit visualBell
1319 1421
1320=item $value = $term->resource ($name[, $newval]) 1422=item $value = $term->resource ($name[, $newval])
1321 1423
1322Returns the current resource value associated with a given name and 1424Returns the current resource value associated with a given name and
1323optionally sets a new value. Setting values is most useful in the C<init> 1425optionally sets a new value. Setting values is most useful in the C<init>
1336 1438
1337Here is a likely non-exhaustive list of resource names, not all of which 1439Here is a likely non-exhaustive list of resource names, not all of which
1338are supported in every build, please see the source file F</src/rsinc.h> 1440are supported in every build, please see the source file F</src/rsinc.h>
1339to see the actual list: 1441to see the actual list:
1340 1442
1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1443 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1444 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1343 display_name embed ext_bwidth fade font geometry hold iconName 1445 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1446 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1447 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1448 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1449 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1450 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1451 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1452 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1453 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1351 secondaryScreen secondaryScroll shade term_name title 1454 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1352 transient_for transparent transparent_all tripleclickwords utmpInhibit 1455 term_name title transient_for transparent tripleclickwords urgentOnBell
1353 visualBell 1456 utmpInhibit visualBell
1354 1457
1355=cut 1458=cut
1356 1459
1357sub resource($$;$) { 1460sub resource($$;$) {
1358 my ($self, $name) = (shift, shift); 1461 my ($self, $name) = (shift, shift);
1369 1472
1370This method should only be called during the C<on_start> hook, as there is 1473This method should only be called during the C<on_start> hook, as there is
1371only one resource database per display, and later invocations might return 1474only one resource database per display, and later invocations might return
1372the wrong resources. 1475the wrong resources.
1373 1476
1374=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1477=item $success = $term->parse_keysym ($key, $octets)
1375 1478
1376Adds a keymap translation exactly as specified via a resource. See the 1479Adds a key binding exactly as specified via a resource. See the
1377C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1480C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1481
1482=item $term->register_command ($keysym, $modifiermask, $string)
1483
1484Adds a key binding. This is a lower level api compared to
1485C<parse_keysym>, as it expects a parsed key description, and can be
1486used only inside either the C<on_init> hook, to add a binding, or the
1487C<on_register_command> hook, to modify a parsed binding.
1378 1488
1379=item $rend = $term->rstyle ([$new_rstyle]) 1489=item $rend = $term->rstyle ([$new_rstyle])
1380 1490
1381Return and optionally change the current rendition. Text that is output by 1491Return and optionally change the current rendition. Text that is output by
1382the terminal application will use this style. 1492the terminal application will use this style.
1595 1705
1596Adds the specified events to the vt event mask. Useful e.g. when you want 1706Adds the specified events to the vt event mask. Useful e.g. when you want
1597to receive pointer events all the times: 1707to receive pointer events all the times:
1598 1708
1599 $term->vt_emask_add (urxvt::PointerMotionMask); 1709 $term->vt_emask_add (urxvt::PointerMotionMask);
1710
1711=item $term->set_urgency ($set)
1712
1713Enable/disable the urgency hint on the toplevel window.
1600 1714
1601=item $term->focus_in 1715=item $term->focus_in
1602 1716
1603=item $term->focus_out 1717=item $term->focus_out
1604 1718
1920=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2034=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1921 2035
1922=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2036=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1923 2037
1924=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)
1925 2043
1926Various X or X-related functions. The C<$term> object only serves as 2044Various X or X-related functions. The C<$term> object only serves as
1927the source of the display, otherwise those functions map more-or-less 2045the source of the display, otherwise those functions map more-or-less
1928directly onto the X functions of the same name. 2046directly onto the X functions of the same name.
1929 2047

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines