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.186 by sf-exg, Fri Jul 23 17:50:41 2010 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
393 395
394Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
395window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
396overlays or changes. 398overlays or changes.
397 399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
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
398=back 413=back
399 414
400=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
401 416
402=head2 General API Considerations 417=head2 General API Considerations
431=item $octets 446=item $octets
432 447
433Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
434locale-specific way. 449locale-specific way.
435 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>.
456
436=back 457=back
437 458
438=head2 Extension Objects 459=head2 Extension Objects
439 460
440Every perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
441for each terminal, and each terminal has its own set of extenion objects, 462for each terminal, and each terminal has its own set of extension objects,
442which are passed as the first parameter to hooks. So extensions can use 463which are passed as the first parameter to hooks. So extensions can use
443their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
445that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
446internal use. 467internal use.
610=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
611 632
612Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
613suppress or filter tty input. 634suppress or filter tty input.
614 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
615=item on_line_update $term, $row 643=item on_line_update $term, $row
616 644
617Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
618screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
619that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
643a 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>
644resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
645 673
646The 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
647slightly 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>.
648 683
649=item on_resize_all_windows $term, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
650 685
651Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
652windows 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
786 821
787=over 4 822=over 4
788 823
789=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
790 825
791Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
792costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
793starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
794 830
795=item urxvt::warn $string 831=item urxvt::warn $string
796 832
797Calls C<rxvt_warn> with the given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
798newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
799that calls this function. 835that calls this function.
800 836
801Using this function has the advantage that its output ends up in the 837Using this function has the advantage that its output ends up in the
802correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
806=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
807 843
808Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
809whether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
810objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
811is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
812 848
813=item $time = urxvt::NOW 849=item $time = urxvt::NOW
814 850
815Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
816 852
859 895
860=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
861 897
862Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
863 899
864=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
865 902
866Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
867underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
868the bitset. 905the bitset.
869 906
906 }; 943 };
907} 944}
908 945
909no warnings 'utf8'; 946no warnings 'utf8';
910 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
911my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
912 983
913sub verbose { 984sub verbose {
914 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
915 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
951sub invoke { 1022sub invoke {
952 local $TERM = shift; 1023 local $TERM = shift;
953 my $htype = shift; 1024 my $htype = shift;
954 1025
955 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
956 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
957 1028
958 my %ext_arg; 1029 my %ext_arg;
959 1030
960 { 1031 {
961 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
1122=head2 The C<urxvt::anyevent> Class 1193=head2 The C<urxvt::anyevent> Class
1123 1194
1124The 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
1125C<AnyEvent> module - any module using it will work inside urxvt without 1196C<AnyEvent> module - any module using it will work inside urxvt without
1126further programming. The only exception is that you cannot wait on 1197further programming. The only exception is that you cannot wait on
1127condition variables, but non-blocking condvar use is ok. What this means 1198condition variables, but non-blocking condvar use is ok.
1128is that you cannot use blocking APIs, but the non-blocking variant should 1199
1129work. 1200In practical terms this means is that you cannot use blocking APIs, but
1201the non-blocking variant should work.
1130 1202
1131=cut 1203=cut
1132 1204
1133our $VERSION = '5.23'; 1205our $VERSION = '5.23';
1134 1206
1193 1265
1194sub DESTROY { 1266sub DESTROY {
1195 $_[0][1]->stop; 1267 $_[0][1]->stop;
1196} 1268}
1197 1269
1270# only needed for AnyEvent < 6 compatibility
1198sub one_event { 1271sub one_event {
1199 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";
1200} 1273}
1201 1274
1202package urxvt::term; 1275package urxvt::term;
1231 $proxy->enable ($name => $ref); 1304 $proxy->enable ($name => $ref);
1232 } 1305 }
1233 } 1306 }
1234} 1307}
1235 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
1236=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1352=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1237 1353
1238Creates 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
1239C<$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
1240hash which defines the environment of the new terminal. 1356hash which defines the environment of the new terminal.
1294C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1410C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1295 1411
1296Here 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
1297source file F</src/optinc.h> to see the actual list: 1413source file F</src/optinc.h> to see the actual list:
1298 1414
1299 borderLess console cursorBlink cursorUnderline hold iconic insecure 1415 borderLess buffered console cursorBlink cursorUnderline hold iconic
1300 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1416 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1301 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1417 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1302 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1418 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1303 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1419 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1304 transparent tripleclickwords utmpInhibit visualBell 1420 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1421 urgentOnBell utmpInhibit visualBell
1305 1422
1306=item $value = $term->resource ($name[, $newval]) 1423=item $value = $term->resource ($name[, $newval])
1307 1424
1308Returns the current resource value associated with a given name and 1425Returns the current resource value associated with a given name and
1309optionally sets a new value. Setting values is most useful in the C<init> 1426optionally sets a new value. Setting values is most useful in the C<init>
1322 1439
1323Here is a likely non-exhaustive list of resource names, not all of which 1440Here is a likely non-exhaustive list of resource names, not all of which
1324are supported in every build, please see the source file F</src/rsinc.h> 1441are supported in every build, please see the source file F</src/rsinc.h>
1325to see the actual list: 1442to see the actual list:
1326 1443
1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1444 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1445 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1329 display_name embed ext_bwidth fade font geometry hold iconName 1446 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1447 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1448 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1449 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1450 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1451 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1452 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1453 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1454 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1337 secondaryScreen secondaryScroll shade term_name title 1455 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1338 transient_for transparent transparent_all tripleclickwords utmpInhibit 1456 term_name title transient_for transparent tripleclickwords urgentOnBell
1339 visualBell 1457 utmpInhibit visualBell
1340 1458
1341=cut 1459=cut
1342 1460
1343sub resource($$;$) { 1461sub resource($$;$) {
1344 my ($self, $name) = (shift, shift); 1462 my ($self, $name) = (shift, shift);
1355 1473
1356This 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
1357only one resource database per display, and later invocations might return 1475only one resource database per display, and later invocations might return
1358the wrong resources. 1476the wrong resources.
1359 1477
1360=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1478=item $success = $term->parse_keysym ($key, $octets)
1361 1479
1362Adds a keymap translation exactly as specified via a resource. See the 1480Adds a key binding exactly as specified via a resource. See the
1363C<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.
1364 1489
1365=item $rend = $term->rstyle ([$new_rstyle]) 1490=item $rend = $term->rstyle ([$new_rstyle])
1366 1491
1367Return and optionally change the current rendition. Text that is output by 1492Return and optionally change the current rendition. Text that is output by
1368the terminal application will use this style. 1493the terminal application will use this style.
1549 1674
1550Write the octets given in C<$octets> to the tty (i.e. as program input). To 1675Write the octets given in C<$octets> to the tty (i.e. as program input). To
1551pass characters instead of octets, you should convert your strings first 1676pass characters instead of octets, you should convert your strings first
1552to the locale-specific encoding using C<< $term->locale_encode >>. 1677to the locale-specific encoding using C<< $term->locale_encode >>.
1553 1678
1679=item $term->tt_paste ($octets)
1680
1681Write the octets given in C<$octets> to the tty as a paste, converting NL to
1682CR and bracketing the data with control sequences if bracketed paste mode
1683is set.
1684
1554=item $old_events = $term->pty_ev_events ([$new_events]) 1685=item $old_events = $term->pty_ev_events ([$new_events])
1555 1686
1556Replaces the event mask of the pty watcher by the given event mask. Can 1687Replaces the event mask of the pty watcher by the given event mask. Can
1557be used to suppress input and output handling to the pty/tty. See the 1688be used to suppress input and output handling to the pty/tty. See the
1558description of C<< urxvt::timer->events >>. Make sure to always restore 1689description of C<< urxvt::timer->events >>. Make sure to always restore
1575 1706
1576Adds 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
1577to receive pointer events all the times: 1708to receive pointer events all the times:
1578 1709
1579 $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.
1580 1715
1581=item $term->focus_in 1716=item $term->focus_in
1582 1717
1583=item $term->focus_out 1718=item $term->focus_out
1584 1719
1900=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2035=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1901 2036
1902=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2037=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1903 2038
1904=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)
1905 2044
1906Various 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
1907the source of the display, otherwise those functions map more-or-less 2046the source of the display, otherwise those functions map more-or-less
1908directly onto the X functions of the same name. 2047directly onto the X functions of the same name.
1909 2048
2231 2370
2232=back 2371=back
2233 2372
2234=head1 AUTHOR 2373=head1 AUTHOR
2235 2374
2236 Marc Lehmann <pcg@goof.com> 2375 Marc Lehmann <schmorp@schmorp.de>
2237 http://software.schmorp.de/pkg/rxvt-unicode 2376 http://software.schmorp.de/pkg/rxvt-unicode
2238 2377
2239=cut 2378=cut
2240 2379
22411 23801

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines