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.181 by sf-exg, Wed Jan 6 17:52:43 2010 UTC vs.
Revision 1.211 by root, Wed Jun 6 14:34:03 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
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343 345
344=item selection-pastebin 346=item selection-pastebin
345 347
346This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to 350not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.). 351F</tmp> directly.).
350 352
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
370 372
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372 374
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead, 376the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file 377which works regardless of whether xrdb is used to parse the resource file
376or not. 378or not.
377 379
378=item macosx-pastebin and macosx-pastebin-native 380=item macosx-clipboard and macosx-clipboard-native
379 381
380These two modules implement an extended clipboard for Mac OS X. They are 382These two modules implement an extended clipboard for Mac OS X. They are
381used like this: 383used like this:
382 384
383 URxvt.perl-ext-common: default,macosx-clipboard 385 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy 386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste 387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386 388
387The difference between them is that the native variant requires a 389The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the 390perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is 391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc. 392simpler etc. etc.
391 393
392=item example-refresh-hooks 394=item example-refresh-hooks
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.
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"
397 412
398=back 413=back
399 414
400=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
401 416
417 432
418=over 4 433=over 4
419 434
420=item $text 435=item $text
421 436
422Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
423always represents one screen cell. See L<ROW_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
424 439
425=item $string 440=item $string
426 441
427A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
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
688 723
689=item on_map_notify $term, $event 724=item on_map_notify $term, $event
690 725
691=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
692 727
693Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
694the hook returns true, then the even will be ignored by rxvt-unicode. 729the hook returns true, then the event will be ignored by rxvt-unicode.
695 730
696The event is a hash with most values as named by Xlib (see the XEvent 731The event is a hash with most values as named by Xlib (see the XEvent
697manpage), with the additional members C<row> and C<col>, which are the 732manpage), with the additional members C<row> and C<col>, which are the
698(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
699 734
727use Scalar::Util (); 762use Scalar::Util ();
728use List::Util (); 763use List::Util ();
729 764
730our $VERSION = 1; 765our $VERSION = 1;
731our $TERM; 766our $TERM;
732our @TERM_INIT; 767our @TERM_INIT; # should go, prevents async I/O etc.
733our @TERM_EXT; 768our @TERM_EXT; # should go, prevents async I/O etc.
734our @HOOKNAME; 769our @HOOKNAME;
735our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
736our %OPTION; 771our %OPTION;
737 772
738our $LIBDIR; 773our $LIBDIR;
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 parse_resource {
949 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 my $r = $term->{meta}{resource};
954 while (my ($pattern, $v) = each %$r) {
955 $name =~ y/-/./ if $isarg;
956
957 if (
958 $pattern =~ s/\*$//
959 ? $pattern eq substr $name, 0, length $pattern
960 : $pattern eq $name
961 ) {
962 $name = "$urxvt::RESCLASS.$name";
963
964 push @TERM_EXT, $v->[0];
965
966 if ($v->[1] eq "boolean") {
967 $term->put_option_db ($name, $flag ? "true" : "false");
968 return 1;
969 } else {
970 $term->put_option_db ($name, $value);
971 return 1 + 2;
972 }
973 }
974 }
975
976 0
977}
978
979sub usage {
980 my ($term, $usage_type) = @_;
981
982 $term->scan_meta;
983
984 my $r = $term->{meta}{resource};
985
986 for my $pattern (sort keys %$r) {
987 my ($ext, $type, $desc) = @{ $r->{$pattern} };
988
989 $desc .= " (-pe $ext)";
990
991 if ($usage_type == 1) {
992 $pattern =~ y/./-/;
993 $pattern =~ s/\*/.../g;
994
995 if ($type eq "boolean") {
996 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
997 } else {
998 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
999 }
1000 } else {
1001 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1002 }
1003 }
1004}
1005
911my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1006my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
912 1007
913sub verbose { 1008sub verbose {
914 my ($level, $msg) = @_; 1009 my ($level, $msg) = @_;
915 warn "$msg\n" if $level <= $verbosity; 1010 warn "$msg\n" if $level <= $verbosity;
951sub invoke { 1046sub invoke {
952 local $TERM = shift; 1047 local $TERM = shift;
953 my $htype = shift; 1048 my $htype = shift;
954 1049
955 if ($htype == 0) { # INIT 1050 if ($htype == 0) { # INIT
956 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1051 my @dirs = $TERM->perl_libdirs;
957 1052
958 my %ext_arg; 1053 my %ext_arg;
959 1054
960 { 1055 {
961 my @init = @TERM_INIT; 1056 my @init = @TERM_INIT;
1122=head2 The C<urxvt::anyevent> Class 1217=head2 The C<urxvt::anyevent> Class
1123 1218
1124The sole purpose of this class is to deliver an interface to the 1219The sole purpose of this class is to deliver an interface to the
1125C<AnyEvent> module - any module using it will work inside urxvt without 1220C<AnyEvent> module - any module using it will work inside urxvt without
1126further programming. The only exception is that you cannot wait on 1221further programming. The only exception is that you cannot wait on
1127condition variables, but non-blocking condvar use is ok. What this means 1222condition variables, but non-blocking condvar use is ok.
1128is that you cannot use blocking APIs, but the non-blocking variant should 1223
1129work. 1224In practical terms this means is that you cannot use blocking APIs, but
1225the non-blocking variant should work.
1130 1226
1131=cut 1227=cut
1132 1228
1133our $VERSION = '5.23'; 1229our $VERSION = '5.23';
1134 1230
1193 1289
1194sub DESTROY { 1290sub DESTROY {
1195 $_[0][1]->stop; 1291 $_[0][1]->stop;
1196} 1292}
1197 1293
1294# only needed for AnyEvent < 6 compatibility
1198sub one_event { 1295sub one_event {
1199 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1296 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1200} 1297}
1201 1298
1202package urxvt::term; 1299package urxvt::term;
1231 $proxy->enable ($name => $ref); 1328 $proxy->enable ($name => $ref);
1232 } 1329 }
1233 } 1330 }
1234} 1331}
1235 1332
1333sub perl_libdirs {
1334 map { split /:/ }
1335 $_[0]->resource ("perl_lib"),
1336 $ENV{URXVT_PERL_LIB},
1337 "$ENV{HOME}/.urxvt/ext",
1338 "$LIBDIR/perl"
1339}
1340
1341sub scan_meta {
1342 my ($self) = @_;
1343 my @libdirs = perl_libdirs $self;
1344
1345 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1346
1347 my %meta;
1348
1349 $self->{meta_libdirs} = join "\x00", @libdirs;
1350 $self->{meta} = \%meta;
1351
1352 for my $dir (reverse @libdirs) {
1353 opendir my $fh, $dir
1354 or next;
1355 for my $ext (readdir $fh) {
1356 $ext ne "."
1357 and $ext ne ".."
1358 and open my $fh, "<", "$dir/$ext"
1359 or next;
1360
1361 while (<$fh>) {
1362 if (/^#:META:X_RESOURCE:(.*)/) {
1363 my ($pattern, $type, $desc) = split /:/, $1;
1364 $pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
1365 if ($pattern =~ /[^a-zA-Z\*\.]/) {
1366 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1367 } else {
1368 $meta{resource}{$pattern} = [$ext, $type, $desc];
1369 }
1370 } elsif (/^\s*(?:#|$)/) {
1371 # skip other comments and empty lines
1372 } else {
1373 last; # stop parsing on first non-empty non-comment line
1374 }
1375 }
1376 }
1377 }
1378}
1379
1236=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1380=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1237 1381
1238Creates a new terminal, very similar as if you had started it with system 1382Creates 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 1383C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1240hash which defines the environment of the new terminal. 1384hash which defines the environment of the new terminal.
1294C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1438C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1295 1439
1296Here is a likely non-exhaustive list of option names, please see the 1440Here is a likely non-exhaustive list of option names, please see the
1297source file F</src/optinc.h> to see the actual list: 1441source file F</src/optinc.h> to see the actual list:
1298 1442
1299 borderLess console cursorBlink cursorUnderline hold iconic insecure 1443 borderLess buffered console cursorBlink cursorUnderline hold iconic
1300 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1444 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1301 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1445 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1302 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1446 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1303 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1447 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1304 transparent tripleclickwords utmpInhibit visualBell 1448 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1449 urgentOnBell utmpInhibit visualBell
1305 1450
1306=item $value = $term->resource ($name[, $newval]) 1451=item $value = $term->resource ($name[, $newval])
1307 1452
1308Returns the current resource value associated with a given name and 1453Returns the current resource value associated with a given name and
1309optionally sets a new value. Setting values is most useful in the C<init> 1454optionally sets a new value. Setting values is most useful in the C<init>
1322 1467
1323Here is a likely non-exhaustive list of resource names, not all of which 1468Here 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> 1469are supported in every build, please see the source file F</src/rsinc.h>
1325to see the actual list: 1470to see the actual list:
1326 1471
1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1472 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1473 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1329 display_name embed ext_bwidth fade font geometry hold iconName 1474 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1475 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8 1476 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1477 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path 1478 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1479 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1480 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1481 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1482 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1337 secondaryScreen secondaryScroll shade term_name title 1483 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1338 transient_for transparent transparent_all tripleclickwords utmpInhibit 1484 term_name title transient_for transparent tripleclickwords urgentOnBell
1339 visualBell 1485 utmpInhibit visualBell
1340 1486
1341=cut 1487=cut
1342 1488
1343sub resource($$;$) { 1489sub resource($$;$) {
1344 my ($self, $name) = (shift, shift); 1490 my ($self, $name) = (shift, shift);
1355 1501
1356This method should only be called during the C<on_start> hook, as there is 1502This 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 1503only one resource database per display, and later invocations might return
1358the wrong resources. 1504the wrong resources.
1359 1505
1360=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1506=item $value = $term->x_resource_boolean ($pattern)
1361 1507
1508Like C<x_resource>, above, but interprets the string value as a boolean
1509and returns C<1> for true values, C<0> for false values and C<undef> if
1510the resource or option isn't specified.
1511
1512You should always use this method to parse boolean resources.
1513
1514=cut
1515
1516sub x_resource_boolean {
1517 my $res = &x_resource;
1518
1519 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1520}
1521
1522=item $success = $term->parse_keysym ($key, $octets)
1523
1362Adds a keymap translation exactly as specified via a resource. See the 1524Adds a key binding exactly as specified via a resource. See the
1363C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1525C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1526
1527=item $term->register_command ($keysym, $modifiermask, $string)
1528
1529Adds a key binding. This is a lower level api compared to
1530C<parse_keysym>, as it expects a parsed key description, and can be
1531used only inside either the C<on_init> hook, to add a binding, or the
1532C<on_register_command> hook, to modify a parsed binding.
1364 1533
1365=item $rend = $term->rstyle ([$new_rstyle]) 1534=item $rend = $term->rstyle ([$new_rstyle])
1366 1535
1367Return and optionally change the current rendition. Text that is output by 1536Return and optionally change the current rendition. Text that is output by
1368the terminal application will use this style. 1537the terminal application will use this style.
1390 1559
1391=item $term->selection_make ($eventtime[, $rectangular]) 1560=item $term->selection_make ($eventtime[, $rectangular])
1392 1561
1393Tries to make a selection as set by C<selection_beg> and 1562Tries to make a selection as set by C<selection_beg> and
1394C<selection_end>. If C<$rectangular> is true (default: false), a 1563C<selection_end>. If C<$rectangular> is true (default: false), a
1395rectangular selection will be made. This is the prefered function to make 1564rectangular selection will be made. This is the preferred function to make
1396a selection. 1565a selection.
1397 1566
1398=item $success = $term->selection_grab ($eventtime) 1567=item $success = $term->selection_grab ($eventtime[, $clipboard])
1399 1568
1400Try to request the primary selection text from the server (for example, as 1569Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1570true) selection from the server. The corresponding text can be set
1401set by the next method). No visual feedback will be given. This function 1571with the next method. No visual feedback will be given. This function
1402is mostly useful from within C<on_sel_grab> hooks. 1572is mostly useful from within C<on_sel_grab> hooks.
1403 1573
1404=item $oldtext = $term->selection ([$newtext]) 1574=item $oldtext = $term->selection ([$newtext, $clipboard])
1405 1575
1406Return the current selection text and optionally replace it by C<$newtext>. 1576Return the current selection (clipboard if C<$clipboard> is true) text
1577and optionally replace it by C<$newtext>.
1578
1579=item $term->selection_clear ([$clipboard])
1580
1581Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1407 1582
1408=item $term->overlay_simple ($x, $y, $text) 1583=item $term->overlay_simple ($x, $y, $text)
1409 1584
1410Create a simple multi-line overlay box. See the next method for details. 1585Create a simple multi-line overlay box. See the next method for details.
1411 1586
1539locale-specific encoding of the terminal and can contain command sequences 1714locale-specific encoding of the terminal and can contain command sequences
1540(escape codes) that will be interpreted. 1715(escape codes) that will be interpreted.
1541 1716
1542=item $term->tt_write ($octets) 1717=item $term->tt_write ($octets)
1543 1718
1544Write the octets given in C<$data> to the tty (i.e. as program input). To 1719Write the octets given in C<$octets> to the tty (i.e. as program input). To
1545pass characters instead of octets, you should convert your strings first 1720pass characters instead of octets, you should convert your strings first
1546to the locale-specific encoding using C<< $term->locale_encode >>. 1721to the locale-specific encoding using C<< $term->locale_encode >>.
1722
1723=item $term->tt_paste ($octets)
1724
1725Write the octets given in C<$octets> to the tty as a paste, converting NL to
1726CR and bracketing the data with control sequences if bracketed paste mode
1727is set.
1547 1728
1548=item $old_events = $term->pty_ev_events ([$new_events]) 1729=item $old_events = $term->pty_ev_events ([$new_events])
1549 1730
1550Replaces the event mask of the pty watcher by the given event mask. Can 1731Replaces the event mask of the pty watcher by the given event mask. Can
1551be used to suppress input and output handling to the pty/tty. See the 1732be used to suppress input and output handling to the pty/tty. See the
1569 1750
1570Adds the specified events to the vt event mask. Useful e.g. when you want 1751Adds the specified events to the vt event mask. Useful e.g. when you want
1571to receive pointer events all the times: 1752to receive pointer events all the times:
1572 1753
1573 $term->vt_emask_add (urxvt::PointerMotionMask); 1754 $term->vt_emask_add (urxvt::PointerMotionMask);
1755
1756=item $term->set_urgency ($set)
1757
1758Enable/disable the urgency hint on the toplevel window.
1574 1759
1575=item $term->focus_in 1760=item $term->focus_in
1576 1761
1577=item $term->focus_out 1762=item $term->focus_out
1578 1763
1865Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2050Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1866recent grab. 2051recent grab.
1867 2052
1868=item $term->ungrab 2053=item $term->ungrab
1869 2054
1870Calls XUngrab for the most recent grab. Is called automatically on 2055Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1871evaluation errors, as it is better to lose the grab in the error case as 2056evaluation errors, as it is better to lose the grab in the error case as
1872the session. 2057the session.
1873 2058
1874=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2059=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1875 2060
1895 2080
1896=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2081=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1897 2082
1898=item $term->XChangeInput ($window, $add_events[, $del_events]) 2083=item $term->XChangeInput ($window, $add_events[, $del_events])
1899 2084
2085=item $keysym = $term->XStringToKeysym ($string)
2086
2087=item $string = $term->XKeysymToString ($keysym)
2088
1900Various X or X-related functions. The C<$term> object only serves as 2089Various X or X-related functions. The C<$term> object only serves as
1901the source of the display, otherwise those functions map more-or-less 2090the source of the display, otherwise those functions map more-or-less
1902directory onto the X functions of the same name. 2091directly onto the X functions of the same name.
1903 2092
1904=back 2093=back
1905 2094
1906=cut 2095=cut
1907 2096
2225 2414
2226=back 2415=back
2227 2416
2228=head1 AUTHOR 2417=head1 AUTHOR
2229 2418
2230 Marc Lehmann <pcg@goof.com> 2419 Marc Lehmann <schmorp@schmorp.de>
2231 http://software.schmorp.de/pkg/rxvt-unicode 2420 http://software.schmorp.de/pkg/rxvt-unicode
2232 2421
2233=cut 2422=cut
2234 2423
22351 24241

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines