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.189 by root, Sat Dec 18 15:37:10 2010 UTC vs.
Revision 1.205 by root, Tue Jun 5 19:32:29 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
798 821
799=over 4 822=over 4
800 823
801=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
802 825
803Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
804costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
805starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
806 830
807=item urxvt::warn $string 831=item urxvt::warn $string
808 832
809Calls 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
810newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
811that calls this function. 835that calls this function.
812 836
813Using 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
814correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
818=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
819 843
820Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
821whether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
822objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
823is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
824 848
825=item $time = urxvt::NOW 849=item $time = urxvt::NOW
826 850
827Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
828 852
964sub invoke { 988sub invoke {
965 local $TERM = shift; 989 local $TERM = shift;
966 my $htype = shift; 990 my $htype = shift;
967 991
968 if ($htype == 0) { # INIT 992 if ($htype == 0) { # INIT
969 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 993 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
970 994
971 my %ext_arg; 995 my %ext_arg;
972 996
973 { 997 {
974 my @init = @TERM_INIT; 998 my @init = @TERM_INIT;
1076 while (my ($name, $cb) = each %hook) { 1100 while (my ($name, $cb) = each %hook) {
1077 my $htype = $HOOKTYPE{uc $name}; 1101 my $htype = $HOOKTYPE{uc $name};
1078 defined $htype 1102 defined $htype
1079 or Carp::croak "unsupported hook type '$name'"; 1103 or Carp::croak "unsupported hook type '$name'";
1080 1104
1081 $self->set_should_invoke ($htype, +1) 1105 $self->modify_should_invoke_count ($htype, +1)
1082 unless exists $self->{term}{_hook}[$htype]{$pkg}; 1106 unless exists $self->{term}{_hook}[$htype]{$pkg};
1083 1107
1084 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1108 $self->{term}{_hook}[$htype]{$pkg} = $cb;
1085 } 1109 }
1086} 1110}
1092 for my $name (@hook) { 1116 for my $name (@hook) {
1093 my $htype = $HOOKTYPE{uc $name}; 1117 my $htype = $HOOKTYPE{uc $name};
1094 defined $htype 1118 defined $htype
1095 or Carp::croak "unsupported hook type '$name'"; 1119 or Carp::croak "unsupported hook type '$name'";
1096 1120
1097 $self->set_should_invoke ($htype, -1) 1121 $self->modify_should_invoke_count ($htype, -1)
1098 if delete $self->{term}{_hook}[$htype]{$pkg}; 1122 if delete $self->{term}{_hook}[$htype]{$pkg};
1099 } 1123 }
1100} 1124}
1101 1125
1102our $AUTOLOAD; 1126our $AUTOLOAD;
1206 1230
1207sub DESTROY { 1231sub DESTROY {
1208 $_[0][1]->stop; 1232 $_[0][1]->stop;
1209} 1233}
1210 1234
1235# only needed for AnyEvent < 6 compatibility
1211sub one_event { 1236sub one_event {
1212 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1237 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1213} 1238}
1214 1239
1215package urxvt::term; 1240package urxvt::term;
1307C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1332C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1308 1333
1309Here is a likely non-exhaustive list of option names, please see the 1334Here is a likely non-exhaustive list of option names, please see the
1310source file F</src/optinc.h> to see the actual list: 1335source file F</src/optinc.h> to see the actual list:
1311 1336
1312 borderLess console cursorBlink cursorUnderline hold iconic insecure 1337 borderLess buffered console cursorBlink cursorUnderline hold iconic
1313 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1338 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1314 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1339 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1315 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1340 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1316 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1341 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1317 transparent tripleclickwords utmpInhibit visualBell 1342 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1343 urgentOnBell utmpInhibit visualBell
1318 1344
1319=item $value = $term->resource ($name[, $newval]) 1345=item $value = $term->resource ($name[, $newval])
1320 1346
1321Returns the current resource value associated with a given name and 1347Returns the current resource value associated with a given name and
1322optionally sets a new value. Setting values is most useful in the C<init> 1348optionally sets a new value. Setting values is most useful in the C<init>
1335 1361
1336Here is a likely non-exhaustive list of resource names, not all of which 1362Here is a likely non-exhaustive list of resource names, not all of which
1337are supported in every build, please see the source file F</src/rsinc.h> 1363are supported in every build, please see the source file F</src/rsinc.h>
1338to see the actual list: 1364to see the actual list:
1339 1365
1340 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1366 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1341 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1367 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1342 display_name embed ext_bwidth fade font geometry hold iconName 1368 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1343 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1369 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1344 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1370 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1371 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1345 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1372 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1346 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1373 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1347 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1374 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1348 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1375 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1349 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1376 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1350 secondaryScreen secondaryScroll shade term_name title 1377 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1351 transient_for transparent transparent_all tripleclickwords utmpInhibit 1378 term_name title transient_for transparent tripleclickwords urgentOnBell
1352 visualBell 1379 utmpInhibit visualBell
1353 1380
1354=cut 1381=cut
1355 1382
1356sub resource($$;$) { 1383sub resource($$;$) {
1357 my ($self, $name) = (shift, shift); 1384 my ($self, $name) = (shift, shift);
1368 1395
1369This method should only be called during the C<on_start> hook, as there is 1396This method should only be called during the C<on_start> hook, as there is
1370only one resource database per display, and later invocations might return 1397only one resource database per display, and later invocations might return
1371the wrong resources. 1398the wrong resources.
1372 1399
1373=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1400=item $success = $term->parse_keysym ($key, $octets)
1374 1401
1375Adds a keymap translation exactly as specified via a resource. See the 1402Adds a key binding exactly as specified via a resource. See the
1376C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1403C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1404
1405=item $term->register_command ($keysym, $modifiermask, $string)
1406
1407Adds a key binding. This is a lower level api compared to
1408C<parse_keysym>, as it expects a parsed key description, and can be
1409used only inside either the C<on_init> hook, to add a binding, or the
1410C<on_register_command> hook, to modify a parsed binding.
1377 1411
1378=item $rend = $term->rstyle ([$new_rstyle]) 1412=item $rend = $term->rstyle ([$new_rstyle])
1379 1413
1380Return and optionally change the current rendition. Text that is output by 1414Return and optionally change the current rendition. Text that is output by
1381the terminal application will use this style. 1415the terminal application will use this style.
1594 1628
1595Adds the specified events to the vt event mask. Useful e.g. when you want 1629Adds the specified events to the vt event mask. Useful e.g. when you want
1596to receive pointer events all the times: 1630to receive pointer events all the times:
1597 1631
1598 $term->vt_emask_add (urxvt::PointerMotionMask); 1632 $term->vt_emask_add (urxvt::PointerMotionMask);
1633
1634=item $term->set_urgency ($set)
1635
1636Enable/disable the urgency hint on the toplevel window.
1599 1637
1600=item $term->focus_in 1638=item $term->focus_in
1601 1639
1602=item $term->focus_out 1640=item $term->focus_out
1603 1641
1919=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1957=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1920 1958
1921=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1959=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1922 1960
1923=item $term->XChangeInput ($window, $add_events[, $del_events]) 1961=item $term->XChangeInput ($window, $add_events[, $del_events])
1962
1963=item $keysym = $term->XStringToKeysym ($string)
1964
1965=item $string = $term->XKeysymToString ($keysym)
1924 1966
1925Various X or X-related functions. The C<$term> object only serves as 1967Various X or X-related functions. The C<$term> object only serves as
1926the source of the display, otherwise those functions map more-or-less 1968the source of the display, otherwise those functions map more-or-less
1927directly onto the X functions of the same name. 1969directly onto the X functions of the same name.
1928 1970
2250 2292
2251=back 2293=back
2252 2294
2253=head1 AUTHOR 2295=head1 AUTHOR
2254 2296
2255 Marc Lehmann <pcg@goof.com> 2297 Marc Lehmann <schmorp@schmorp.de>
2256 http://software.schmorp.de/pkg/rxvt-unicode 2298 http://software.schmorp.de/pkg/rxvt-unicode
2257 2299
2258=cut 2300=cut
2259 2301
22601 23021

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines