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.190 by root, Fri Jan 7 21:17:08 2011 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
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
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.
440 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
441=back 457=back
442 458
443=head2 Extension Objects 459=head2 Extension Objects
444 460
445Every 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
446for 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,
447which 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
448their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
449extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
450that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
451internal use. 467internal use.
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
801=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
802 825
803Fatally aborts execution with the given error message (which should 826Fatally aborts execution with the given error message (which should
804include a trailing newline). Avoid at all costs! The only time this 827include a trailing newline). Avoid at all costs! The only time this
805is acceptable (and useful) is in the init hook, where it prevents the 828is acceptable (and useful) is in the init hook, where it prevents the
806temrinal from starting up. 829terminal from starting up.
807 830
808=item urxvt::warn $string 831=item urxvt::warn $string
809 832
810Calls C<rxvt_warn> with the given string which should include a trailing 833Calls C<rxvt_warn> with the given string which should include a trailing
811newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
819=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
820 843
821Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
822whether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
823objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
824is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
825 848
826=item $time = urxvt::NOW 849=item $time = urxvt::NOW
827 850
828Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
829 852
920 }; 943 };
921} 944}
922 945
923no warnings 'utf8'; 946no warnings 'utf8';
924 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
925my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 970my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
926 971
927sub verbose { 972sub verbose {
928 my ($level, $msg) = @_; 973 my ($level, $msg) = @_;
929 warn "$msg\n" if $level <= $verbosity; 974 warn "$msg\n" if $level <= $verbosity;
965sub invoke { 1010sub invoke {
966 local $TERM = shift; 1011 local $TERM = shift;
967 my $htype = shift; 1012 my $htype = shift;
968 1013
969 if ($htype == 0) { # INIT 1014 if ($htype == 0) { # INIT
970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1015 my @dirs = perl_libdirs $TERM;
971 1016
972 my %ext_arg; 1017 my %ext_arg;
973 1018
974 { 1019 {
975 my @init = @TERM_INIT; 1020 my @init = @TERM_INIT;
1207 1252
1208sub DESTROY { 1253sub DESTROY {
1209 $_[0][1]->stop; 1254 $_[0][1]->stop;
1210} 1255}
1211 1256
1257# only needed for AnyEvent < 6 compatibility
1212sub one_event { 1258sub one_event {
1213 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";
1214} 1260}
1215 1261
1216package urxvt::term; 1262package urxvt::term;
1308C<%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.
1309 1355
1310Here 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
1311source file F</src/optinc.h> to see the actual list: 1357source file F</src/optinc.h> to see the actual list:
1312 1358
1313 borderLess console cursorBlink cursorUnderline hold iconic insecure 1359 borderLess buffered console cursorBlink cursorUnderline hold iconic
1314 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1360 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1315 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1361 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1316 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1362 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1317 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1363 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1318 transparent tripleclickwords utmpInhibit visualBell 1364 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1365 urgentOnBell utmpInhibit visualBell
1319 1366
1320=item $value = $term->resource ($name[, $newval]) 1367=item $value = $term->resource ($name[, $newval])
1321 1368
1322Returns the current resource value associated with a given name and 1369Returns the current resource value associated with a given name and
1323optionally 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>
1336 1383
1337Here 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
1338are 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>
1339to see the actual list: 1386to see the actual list:
1340 1387
1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1388 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1389 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1343 display_name embed ext_bwidth fade font geometry hold iconName 1390 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1391 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1392 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1393 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1394 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1395 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1396 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1397 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1398 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1351 secondaryScreen secondaryScroll shade term_name title 1399 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1352 transient_for transparent transparent_all tripleclickwords utmpInhibit 1400 term_name title transient_for transparent tripleclickwords urgentOnBell
1353 visualBell 1401 utmpInhibit visualBell
1354 1402
1355=cut 1403=cut
1356 1404
1357sub resource($$;$) { 1405sub resource($$;$) {
1358 my ($self, $name) = (shift, shift); 1406 my ($self, $name) = (shift, shift);
1369 1417
1370This 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
1371only one resource database per display, and later invocations might return 1419only one resource database per display, and later invocations might return
1372the wrong resources. 1420the wrong resources.
1373 1421
1374=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1422=item $success = $term->parse_keysym ($key, $octets)
1375 1423
1376Adds a keymap translation exactly as specified via a resource. See the 1424Adds a key binding exactly as specified via a resource. See the
1377C<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.
1378 1433
1379=item $rend = $term->rstyle ([$new_rstyle]) 1434=item $rend = $term->rstyle ([$new_rstyle])
1380 1435
1381Return and optionally change the current rendition. Text that is output by 1436Return and optionally change the current rendition. Text that is output by
1382the terminal application will use this style. 1437the terminal application will use this style.
1595 1650
1596Adds 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
1597to receive pointer events all the times: 1652to receive pointer events all the times:
1598 1653
1599 $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.
1600 1659
1601=item $term->focus_in 1660=item $term->focus_in
1602 1661
1603=item $term->focus_out 1662=item $term->focus_out
1604 1663
1920=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1979=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1921 1980
1922=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1981=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1923 1982
1924=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)
1925 1988
1926Various 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
1927the source of the display, otherwise those functions map more-or-less 1990the source of the display, otherwise those functions map more-or-less
1928directly onto the X functions of the same name. 1991directly onto the X functions of the same name.
1929 1992
2251 2314
2252=back 2315=back
2253 2316
2254=head1 AUTHOR 2317=head1 AUTHOR
2255 2318
2256 Marc Lehmann <pcg@goof.com> 2319 Marc Lehmann <schmorp@schmorp.de>
2257 http://software.schmorp.de/pkg/rxvt-unicode 2320 http://software.schmorp.de/pkg/rxvt-unicode
2258 2321
2259=cut 2322=cut
2260 2323
22611 23241

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines