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.185 by sf-exg, Fri Jul 2 12:44:45 2010 UTC vs.
Revision 1.207 by root, Tue Jun 5 21:29:52 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,
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.
648 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
649=item on_resize_all_windows $tern, $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
653returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
654 689
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 perl_libdirs {
949 map { split /:/ }
950 $_[0]->resource ("perl_lib"),
951 $ENV{URXVT_PERL_LIB},
952 "$ENV{HOME}/.urxvt/ext",
953 "$LIBDIR/perl"
954}
955
956our %META; # meta header information from scripts
957our %SCAN; # which dirs already scanned
958
959sub resource {
960 my ($term, $name, $isarg, $flag, $value) = @_;
961
962 for my $dir (perl_libdirs $term) {
963 }
964
965 warn "resourece<@_>\n";#d#
966
967 0
968}
969
911my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 970my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
912 971
913sub verbose { 972sub verbose {
914 my ($level, $msg) = @_; 973 my ($level, $msg) = @_;
915 warn "$msg\n" if $level <= $verbosity; 974 warn "$msg\n" if $level <= $verbosity;
951sub invoke { 1010sub invoke {
952 local $TERM = shift; 1011 local $TERM = shift;
953 my $htype = shift; 1012 my $htype = shift;
954 1013
955 if ($htype == 0) { # INIT 1014 if ($htype == 0) { # INIT
956 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1015 my @dirs = perl_libdirs $TERM;
957 1016
958 my %ext_arg; 1017 my %ext_arg;
959 1018
960 { 1019 {
961 my @init = @TERM_INIT; 1020 my @init = @TERM_INIT;
1193 1252
1194sub DESTROY { 1253sub DESTROY {
1195 $_[0][1]->stop; 1254 $_[0][1]->stop;
1196} 1255}
1197 1256
1257# only needed for AnyEvent < 6 compatibility
1198sub one_event { 1258sub one_event {
1199 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1259 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1200} 1260}
1201 1261
1202package urxvt::term; 1262package urxvt::term;
1294C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1354C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1295 1355
1296Here is a likely non-exhaustive list of option names, please see the 1356Here is a likely non-exhaustive list of option names, please see the
1297source file F</src/optinc.h> to see the actual list: 1357source file F</src/optinc.h> to see the actual list:
1298 1358
1299 borderLess console cursorBlink cursorUnderline hold iconic insecure 1359 borderLess buffered console cursorBlink cursorUnderline hold iconic
1300 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1360 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1301 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1361 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1302 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1362 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1303 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1363 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1304 transparent tripleclickwords utmpInhibit visualBell 1364 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1365 urgentOnBell utmpInhibit visualBell
1305 1366
1306=item $value = $term->resource ($name[, $newval]) 1367=item $value = $term->resource ($name[, $newval])
1307 1368
1308Returns the current resource value associated with a given name and 1369Returns the current resource value associated with a given name and
1309optionally sets a new value. Setting values is most useful in the C<init> 1370optionally sets a new value. Setting values is most useful in the C<init>
1322 1383
1323Here is a likely non-exhaustive list of resource names, not all of which 1384Here 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> 1385are supported in every build, please see the source file F</src/rsinc.h>
1325to see the actual list: 1386to see the actual list:
1326 1387
1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1388 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1389 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1329 display_name embed ext_bwidth fade font geometry hold iconName 1390 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1391 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1392 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1393 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1394 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1395 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1396 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1397 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1398 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1337 secondaryScreen secondaryScroll shade term_name title 1399 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1338 transient_for transparent transparent_all tripleclickwords utmpInhibit 1400 term_name title transient_for transparent tripleclickwords urgentOnBell
1339 visualBell 1401 utmpInhibit visualBell
1340 1402
1341=cut 1403=cut
1342 1404
1343sub resource($$;$) { 1405sub resource($$;$) {
1344 my ($self, $name) = (shift, shift); 1406 my ($self, $name) = (shift, shift);
1355 1417
1356This method should only be called during the C<on_start> hook, as there is 1418This 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 1419only one resource database per display, and later invocations might return
1358the wrong resources. 1420the wrong resources.
1359 1421
1360=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1422=item $success = $term->parse_keysym ($key, $octets)
1361 1423
1362Adds a keymap translation exactly as specified via a resource. See the 1424Adds a key binding exactly as specified via a resource. See the
1363C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1425C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1426
1427=item $term->register_command ($keysym, $modifiermask, $string)
1428
1429Adds a key binding. This is a lower level api compared to
1430C<parse_keysym>, as it expects a parsed key description, and can be
1431used only inside either the C<on_init> hook, to add a binding, or the
1432C<on_register_command> hook, to modify a parsed binding.
1364 1433
1365=item $rend = $term->rstyle ([$new_rstyle]) 1434=item $rend = $term->rstyle ([$new_rstyle])
1366 1435
1367Return and optionally change the current rendition. Text that is output by 1436Return and optionally change the current rendition. Text that is output by
1368the terminal application will use this style. 1437the terminal application will use this style.
1545locale-specific encoding of the terminal and can contain command sequences 1614locale-specific encoding of the terminal and can contain command sequences
1546(escape codes) that will be interpreted. 1615(escape codes) that will be interpreted.
1547 1616
1548=item $term->tt_write ($octets) 1617=item $term->tt_write ($octets)
1549 1618
1550Write the octets given in C<$data> to the tty (i.e. as program input). To 1619Write 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 1620pass characters instead of octets, you should convert your strings first
1552to the locale-specific encoding using C<< $term->locale_encode >>. 1621to the locale-specific encoding using C<< $term->locale_encode >>.
1622
1623=item $term->tt_paste ($octets)
1624
1625Write the octets given in C<$octets> to the tty as a paste, converting NL to
1626CR and bracketing the data with control sequences if bracketed paste mode
1627is set.
1553 1628
1554=item $old_events = $term->pty_ev_events ([$new_events]) 1629=item $old_events = $term->pty_ev_events ([$new_events])
1555 1630
1556Replaces the event mask of the pty watcher by the given event mask. Can 1631Replaces 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 1632be used to suppress input and output handling to the pty/tty. See the
1575 1650
1576Adds the specified events to the vt event mask. Useful e.g. when you want 1651Adds the specified events to the vt event mask. Useful e.g. when you want
1577to receive pointer events all the times: 1652to receive pointer events all the times:
1578 1653
1579 $term->vt_emask_add (urxvt::PointerMotionMask); 1654 $term->vt_emask_add (urxvt::PointerMotionMask);
1655
1656=item $term->set_urgency ($set)
1657
1658Enable/disable the urgency hint on the toplevel window.
1580 1659
1581=item $term->focus_in 1660=item $term->focus_in
1582 1661
1583=item $term->focus_out 1662=item $term->focus_out
1584 1663
1900=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1979=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1901 1980
1902=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1981=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1903 1982
1904=item $term->XChangeInput ($window, $add_events[, $del_events]) 1983=item $term->XChangeInput ($window, $add_events[, $del_events])
1984
1985=item $keysym = $term->XStringToKeysym ($string)
1986
1987=item $string = $term->XKeysymToString ($keysym)
1905 1988
1906Various X or X-related functions. The C<$term> object only serves as 1989Various X or X-related functions. The C<$term> object only serves as
1907the source of the display, otherwise those functions map more-or-less 1990the source of the display, otherwise those functions map more-or-less
1908directly onto the X functions of the same name. 1991directly onto the X functions of the same name.
1909 1992
2231 2314
2232=back 2315=back
2233 2316
2234=head1 AUTHOR 2317=head1 AUTHOR
2235 2318
2236 Marc Lehmann <pcg@goof.com> 2319 Marc Lehmann <schmorp@schmorp.de>
2237 http://software.schmorp.de/pkg/rxvt-unicode 2320 http://software.schmorp.de/pkg/rxvt-unicode
2238 2321
2239=cut 2322=cut
2240 2323
22411 23241

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines