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.169 by root, Sun Jun 15 14:54:44 2008 UTC vs.
Revision 1.215 by root, Thu Jun 7 16:30:58 2012 UTC

20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
108reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
110first argument. 110first argument.
111 111
112The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>: 113C<< $self->{myoption} >>:
114 114
115 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 }; 117 };
118 118
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
303extension will actually grab a physical key just for this function. 305extension will actually grab a physical key just for this function.
304 306
305If you want a quake-like animation, tell your window manager to do so 307If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it). 308(fvwm can do it).
307 309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
315
308=item block-graphics-to-ascii 316=item block-graphics-to-ascii
309 317
310A not very useful example of filtering all text output to the terminal 318A not very useful example of filtering all text output to the terminal
311by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
312similar-looking ascii character. 320similar-looking ascii character.
335 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337 345
338=item selection-pastebin 346=item selection-pastebin
339 347
340This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
341textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
342not 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
343F</tmp> directly.). 351F</tmp> directly.).
344 352
345It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
364 372
365 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366 374
367I<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
368the double C</> characters as comment start. Use C<\057\057> instead, 376the double C</> characters as comment start. Use C<\057\057> instead,
369which 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
370or not. 378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
371 393
372=item example-refresh-hooks 394=item example-refresh-hooks
373 395
374Displays 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
375window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
376overlays 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"
377 412
378=back 413=back
379 414
380=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
381 416
397 432
398=over 4 433=over 4
399 434
400=item $text 435=item $text
401 436
402Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
403always 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.
404 439
405=item $string 440=item $string
406 441
407A 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
411=item $octets 446=item $octets
412 447
413Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
414locale-specific way. 449locale-specific way.
415 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
416=back 457=back
417 458
418=head2 Extension Objects 459=head2 Extension Objects
419 460
420Every 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
421for 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,
422which 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
423their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
424extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
425that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
426internal use. 467internal use.
541 582
542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 583It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 584$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
545 586
546=item on_osc_seq $term, $op, $args 587=item on_osc_seq $term, $op, $args, $resp
547 588
548Called on every OSC sequence and can be used to suppress it or modify its 589Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value 590behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get 591suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within 592confused by recursive invocations when you output an OSC sequence within
552this callback. 593this callback.
553 594
554C<on_osc_seq_perl> should be used for new behaviour. 595C<on_osc_seq_perl> should be used for new behaviour.
555 596
556=item on_osc_seq_perl $term, $string 597=item on_osc_seq_perl $term, $args, $resp
557 598
558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
560information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
561string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
562it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
563future. 604enforced in the future.
605
606For example, C<overlay-osc> uses this:
607
608 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_;
610
611 return unless $osc =~ s/^overlay;//;
612
613 ... process remaining $osc string
614 }
564 615
565Be careful not ever to trust (in a security sense) the data you receive, 616Be careful not ever to trust (in a security sense) the data you receive,
566as its source can not easily be controlled (e-mail content, messages from 617as its source can not easily be controlled (e-mail content, messages from
567other users on the same system etc.). 618other users on the same system etc.).
619
620For responses, C<$resp> contains the end-of-args separator used by the
621sender.
568 622
569=item on_add_lines $term, $string 623=item on_add_lines $term, $string
570 624
571Called whenever text is about to be output, with the text as argument. You 625Called whenever text is about to be output, with the text as argument. You
572can filter/change and output the text yourself by returning a true value 626can filter/change and output the text yourself by returning a true value
577=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
578 632
579Called 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
580suppress or filter tty input. 634suppress or filter tty input.
581 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
582=item on_line_update $term, $row 643=item on_line_update $term, $row
583 644
584Called 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
585screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
586that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
593later with the already-modified line (e.g. if unrelated parts change), so 654later with the already-modified line (e.g. if unrelated parts change), so
594you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
595 656
596=item on_refresh_begin $term 657=item on_refresh_begin $term
597 658
598Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
599or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
600restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
601code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
602 663
603=item on_refresh_end $term 664=item on_refresh_end $term
604 665
611resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
612 673
613The 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
614slightly in the future. 675slightly in the future.
615 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
616=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
617 685
618Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
619windows 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
620returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
621 689
655 723
656=item on_map_notify $term, $event 724=item on_map_notify $term, $event
657 725
658=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
659 727
660Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
661the 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.
662 730
663The 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
664manpage), 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
665(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
666 734
676=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
677 745
678Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
679format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
680 748
749=item on_bell $term
750
751Called on receipt of a bell character.
752
681=back 753=back
682 754
683=cut 755=cut
684 756
685package urxvt; 757package urxvt;
686 758
687use utf8; 759use utf8;
688use strict; 760use strict 'vars';
689use Carp (); 761use Carp ();
690use Scalar::Util (); 762use Scalar::Util ();
691use List::Util (); 763use List::Util ();
692 764
693our $VERSION = 1; 765our $VERSION = 1;
694our $TERM; 766our $TERM;
695our @TERM_INIT; 767our @TERM_INIT; # should go, prevents async I/O etc.
696our @TERM_EXT; 768our @TERM_EXT; # should go, prevents async I/O etc.
697our @HOOKNAME; 769our @HOOKNAME;
698our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
699our %OPTION; 771our %OPTION;
700 772
701our $LIBDIR; 773our $LIBDIR;
749 821
750=over 4 822=over 4
751 823
752=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
753 825
754Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
755costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
756starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
757 830
758=item urxvt::warn $string 831=item urxvt::warn $string
759 832
760Calls 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
761newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
762that calls this function. 835that calls this function.
763 836
764Using 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
765correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
769=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
770 843
771Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
772whether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
773objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
774is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
775 848
776=item $time = urxvt::NOW 849=item $time = urxvt::NOW
777 850
778Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
779 852
822 895
823=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
824 897
825Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
826 899
827=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
828 902
829Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
830underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
831the bitset. 905the bitset.
832 906
869 }; 943 };
870} 944}
871 945
872no warnings 'utf8'; 946no warnings 'utf8';
873 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 =~ /\.$/
959 ? $pattern eq substr $name, 0, length $pattern
960 : $pattern eq $name
961 ) {
962 $name = "$urxvt::RESCLASS.$name";
963
964 push @{ $term->{perl_ext_3} }, $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 $pattern =~ s/\.$/.*/g;
1002 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1003 }
1004 }
1005}
1006
874my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1007my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
875 1008
876sub verbose { 1009sub verbose {
877 my ($level, $msg) = @_; 1010 my ($level, $msg) = @_;
878 warn "$msg\n" if $level <= $verbosity; 1011 warn "$msg\n" if $level <= $verbosity;
894 1027
895 open my $fh, "<:raw", $path 1028 open my $fh, "<:raw", $path
896 or die "$path: $!"; 1029 or die "$path: $!";
897 1030
898 my $source = 1031 my $source =
899 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 1032 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
900 . "#line 1 \"$path\"\n{\n" 1033 . "#line 1 \"$path\"\n{\n"
901 . (do { local $/; <$fh> }) 1034 . (do { local $/; <$fh> })
902 . "\n};\n1"; 1035 . "\n};\n1";
903 1036
904 eval $source 1037 eval $source
914sub invoke { 1047sub invoke {
915 local $TERM = shift; 1048 local $TERM = shift;
916 my $htype = shift; 1049 my $htype = shift;
917 1050
918 if ($htype == 0) { # INIT 1051 if ($htype == 0) { # INIT
919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1052 my @dirs = $TERM->perl_libdirs;
920 1053
921 my %ext_arg; 1054 my %ext_arg;
922 1055
923 { 1056 {
924 my @init = @TERM_INIT; 1057 my @init = @TERM_INIT;
927 my @pkg = @TERM_EXT; 1060 my @pkg = @TERM_EXT;
928 @TERM_EXT = (); 1061 @TERM_EXT = ();
929 $TERM->register_package ($_) for @pkg; 1062 $TERM->register_package ($_) for @pkg;
930 } 1063 }
931 1064
1065 for (
1066 @{ delete $TERM->{perl_ext_3} },
932 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1067 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
1068 ) {
933 if ($_ eq "default") { 1069 if ($_ eq "default") {
934 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 1070 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
935 } elsif (/^-(.*)$/) { 1071 } elsif (/^-(.*)$/) {
936 delete $ext_arg{$1}; 1072 delete $ext_arg{$1};
937 } elsif (/^([^<]+)<(.*)>$/) { 1073 } elsif (/^([^<]+)<(.*)>$/) {
1085=head2 The C<urxvt::anyevent> Class 1221=head2 The C<urxvt::anyevent> Class
1086 1222
1087The sole purpose of this class is to deliver an interface to the 1223The sole purpose of this class is to deliver an interface to the
1088C<AnyEvent> module - any module using it will work inside urxvt without 1224C<AnyEvent> module - any module using it will work inside urxvt without
1089further programming. The only exception is that you cannot wait on 1225further programming. The only exception is that you cannot wait on
1090condition variables, but non-blocking condvar use is ok. What this means 1226condition variables, but non-blocking condvar use is ok.
1091is that you cannot use blocking APIs, but the non-blocking variant should 1227
1092work. 1228In practical terms this means is that you cannot use blocking APIs, but
1229the non-blocking variant should work.
1093 1230
1094=cut 1231=cut
1095 1232
1096our $VERSION = '3.4'; 1233our $VERSION = '5.23';
1097 1234
1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1235$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1236push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100 1237
1101sub timer { 1238sub timer {
1103 1240
1104 my $cb = $arg{cb}; 1241 my $cb = $arg{cb};
1105 1242
1106 urxvt::timer 1243 urxvt::timer
1107 ->new 1244 ->new
1108 ->start (urxvt::NOW + $arg{after}) 1245 ->after ($arg{after}, $arg{interval})
1109 ->cb (sub { 1246 ->cb ($arg{interval} ? $cb : sub {
1110 $_[0]->stop; # need to cancel manually 1247 $_[0]->stop; # need to cancel manually
1111 $cb->(); 1248 $cb->();
1112 }) 1249 })
1113} 1250}
1114 1251
1115sub io { 1252sub io {
1116 my ($class, %arg) = @_; 1253 my ($class, %arg) = @_;
1117 1254
1118 my $cb = $arg{cb}; 1255 my $cb = $arg{cb};
1256 my $fd = fileno $arg{fh};
1257 defined $fd or $fd = $arg{fh};
1119 1258
1120 bless [$arg{fh}, urxvt::iow 1259 bless [$arg{fh}, urxvt::iow
1121 ->new 1260 ->new
1122 ->fd (fileno $arg{fh}) 1261 ->fd ($fd)
1123 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1262 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1124 | ($arg{poll} =~ /w/ ? 2 : 0)) 1263 | ($arg{poll} =~ /w/ ? 2 : 0))
1125 ->start 1264 ->start
1126 ->cb (sub { 1265 ->cb ($cb)
1127 $cb->(($_[1] & 1 ? 'r' : '')
1128 . ($_[1] & 2 ? 'w' : ''));
1129 })],
1130 urxvt::anyevent:: 1266 ], urxvt::anyevent::
1267}
1268
1269sub idle {
1270 my ($class, %arg) = @_;
1271
1272 my $cb = $arg{cb};
1273
1274 urxvt::iw
1275 ->new
1276 ->start
1277 ->cb ($cb)
1278}
1279
1280sub child {
1281 my ($class, %arg) = @_;
1282
1283 my $cb = $arg{cb};
1284
1285 urxvt::pw
1286 ->new
1287 ->start ($arg{pid})
1288 ->cb (sub {
1289 $_[0]->stop; # need to cancel manually
1290 $cb->($_[0]->rpid, $_[0]->rstatus);
1291 })
1131} 1292}
1132 1293
1133sub DESTROY { 1294sub DESTROY {
1134 $_[0][1]->stop; 1295 $_[0][1]->stop;
1135} 1296}
1136 1297
1298# only needed for AnyEvent < 6 compatibility
1137sub one_event { 1299sub one_event {
1138 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1300 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1139} 1301}
1140 1302
1141package urxvt::term; 1303package urxvt::term;
1170 $proxy->enable ($name => $ref); 1332 $proxy->enable ($name => $ref);
1171 } 1333 }
1172 } 1334 }
1173} 1335}
1174 1336
1337sub perl_libdirs {
1338 map { split /:/ }
1339 $_[0]->resource ("perl_lib"),
1340 $ENV{URXVT_PERL_LIB},
1341 "$ENV{HOME}/.urxvt/ext",
1342 "$LIBDIR/perl"
1343}
1344
1345sub scan_meta {
1346 my ($self) = @_;
1347 my @libdirs = perl_libdirs $self;
1348
1349 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1350
1351 my %meta;
1352
1353 $self->{meta_libdirs} = join "\x00", @libdirs;
1354 $self->{meta} = \%meta;
1355
1356 for my $dir (reverse @libdirs) {
1357 opendir my $fh, $dir
1358 or next;
1359 for my $ext (readdir $fh) {
1360 $ext ne "."
1361 and $ext ne ".."
1362 and open my $fh, "<", "$dir/$ext"
1363 or next;
1364
1365 while (<$fh>) {
1366 if (/^#:META:X_RESOURCE:(.*)/) {
1367 my ($pattern, $type, $desc) = split /:/, $1;
1368 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1369 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1370 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1371 } else {
1372 $meta{resource}{$pattern} = [$ext, $type, $desc];
1373 }
1374 } elsif (/^\s*(?:#|$)/) {
1375 # skip other comments and empty lines
1376 } else {
1377 last; # stop parsing on first non-empty non-comment line
1378 }
1379 }
1380 }
1381 }
1382}
1383
1175=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1384=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1176 1385
1177Creates a new terminal, very similar as if you had started it with system 1386Creates a new terminal, very similar as if you had started it with system
1178C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1387C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1179hash which defines the environment of the new terminal. 1388hash which defines the environment of the new terminal.
1233C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1442C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1234 1443
1235Here is a likely non-exhaustive list of option names, please see the 1444Here is a likely non-exhaustive list of option names, please see the
1236source file F</src/optinc.h> to see the actual list: 1445source file F</src/optinc.h> to see the actual list:
1237 1446
1238 borderLess console cursorBlink cursorUnderline hold iconic insecure 1447 borderLess buffered console cursorBlink cursorUnderline hold iconic
1239 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1448 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1240 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1449 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1241 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1450 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1242 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1451 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1243 transparent tripleclickwords utmpInhibit visualBell 1452 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1453 urgentOnBell utmpInhibit visualBell
1244 1454
1245=item $value = $term->resource ($name[, $newval]) 1455=item $value = $term->resource ($name[, $newval])
1246 1456
1247Returns the current resource value associated with a given name and 1457Returns the current resource value associated with a given name and
1248optionally sets a new value. Setting values is most useful in the C<init> 1458optionally sets a new value. Setting values is most useful in the C<init>
1261 1471
1262Here is a likely non-exhaustive list of resource names, not all of which 1472Here is a likely non-exhaustive list of resource names, not all of which
1263are supported in every build, please see the source file F</src/rsinc.h> 1473are supported in every build, please see the source file F</src/rsinc.h>
1264to see the actual list: 1474to see the actual list:
1265 1475
1266 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1476 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1267 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1477 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1268 display_name embed ext_bwidth fade font geometry hold iconName 1478 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1269 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1479 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1480 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1270 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1481 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1482 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1483 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1484 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1485 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1486 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1276 secondaryScreen secondaryScroll shade term_name title 1487 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1277 transient_for transparent transparent_all tripleclickwords utmpInhibit 1488 term_name title transient_for transparent tripleclickwords urgentOnBell
1278 visualBell 1489 utmpInhibit visualBell
1279 1490
1280=cut 1491=cut
1281 1492
1282sub resource($$;$) { 1493sub resource($$;$) {
1283 my ($self, $name) = (shift, shift); 1494 my ($self, $name) = (shift, shift);
1294 1505
1295This method should only be called during the C<on_start> hook, as there is 1506This method should only be called during the C<on_start> hook, as there is
1296only one resource database per display, and later invocations might return 1507only one resource database per display, and later invocations might return
1297the wrong resources. 1508the wrong resources.
1298 1509
1299=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1510=item $value = $term->x_resource_boolean ($pattern)
1300 1511
1512Like C<x_resource>, above, but interprets the string value as a boolean
1513and returns C<1> for true values, C<0> for false values and C<undef> if
1514the resource or option isn't specified.
1515
1516You should always use this method to parse boolean resources.
1517
1518=cut
1519
1520sub x_resource_boolean {
1521 my $res = &x_resource;
1522
1523 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1524}
1525
1526=item $success = $term->parse_keysym ($key, $octets)
1527
1301Adds a keymap translation exactly as specified via a resource. See the 1528Adds a key binding exactly as specified via a resource. See the
1302C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1529C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1530
1531=item $term->register_command ($keysym, $modifiermask, $string)
1532
1533Adds a key binding. This is a lower level api compared to
1534C<parse_keysym>, as it expects a parsed key description, and can be
1535used only inside either the C<on_init> hook, to add a binding, or the
1536C<on_register_command> hook, to modify a parsed binding.
1303 1537
1304=item $rend = $term->rstyle ([$new_rstyle]) 1538=item $rend = $term->rstyle ([$new_rstyle])
1305 1539
1306Return and optionally change the current rendition. Text that is output by 1540Return and optionally change the current rendition. Text that is output by
1307the terminal application will use this style. 1541the terminal application will use this style.
1315 1549
1316=item ($row, $col) = $term->selection_beg ([$row, $col]) 1550=item ($row, $col) = $term->selection_beg ([$row, $col])
1317 1551
1318=item ($row, $col) = $term->selection_end ([$row, $col]) 1552=item ($row, $col) = $term->selection_end ([$row, $col])
1319 1553
1320Return the current values of the selection mark, begin or end positions, 1554Return the current values of the selection mark, begin or end positions.
1321and optionally set them to new values. 1555
1556When arguments are given, then the selection coordinates are set to
1557C<$row> and C<$col>, and the selection screen is set to the current
1558screen.
1559
1560=item $screen = $term->selection_screen ([$screen])
1561
1562Returns the current selection screen, and then optionally sets it.
1322 1563
1323=item $term->selection_make ($eventtime[, $rectangular]) 1564=item $term->selection_make ($eventtime[, $rectangular])
1324 1565
1325Tries to make a selection as set by C<selection_beg> and 1566Tries to make a selection as set by C<selection_beg> and
1326C<selection_end>. If C<$rectangular> is true (default: false), a 1567C<selection_end>. If C<$rectangular> is true (default: false), a
1327rectangular selection will be made. This is the prefered function to make 1568rectangular selection will be made. This is the preferred function to make
1328a selection. 1569a selection.
1329 1570
1330=item $success = $term->selection_grab ($eventtime) 1571=item $success = $term->selection_grab ($eventtime[, $clipboard])
1331 1572
1332Try to request the primary selection text from the server (for example, as 1573Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1574true) selection from the server. The corresponding text can be set
1333set by the next method). No visual feedback will be given. This function 1575with the next method. No visual feedback will be given. This function
1334is mostly useful from within C<on_sel_grab> hooks. 1576is mostly useful from within C<on_sel_grab> hooks.
1335 1577
1336=item $oldtext = $term->selection ([$newtext]) 1578=item $oldtext = $term->selection ([$newtext, $clipboard])
1337 1579
1338Return the current selection text and optionally replace it by C<$newtext>. 1580Return the current selection (clipboard if C<$clipboard> is true) text
1581and optionally replace it by C<$newtext>.
1582
1583=item $term->selection_clear ([$clipboard])
1584
1585Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1339 1586
1340=item $term->overlay_simple ($x, $y, $text) 1587=item $term->overlay_simple ($x, $y, $text)
1341 1588
1342Create a simple multi-line overlay box. See the next method for details. 1589Create a simple multi-line overlay box. See the next method for details.
1343 1590
1373 1620
1374The methods currently supported on C<urxvt::overlay> objects are: 1621The methods currently supported on C<urxvt::overlay> objects are:
1375 1622
1376=over 4 1623=over 4
1377 1624
1378=item $overlay->set ($x, $y, $text, $rend) 1625=item $overlay->set ($x, $y, $text[, $rend])
1379 1626
1380Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1627Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1381text in rxvt-unicode's special encoding and an array of rendition values 1628text in rxvt-unicode's special encoding and an array of rendition values
1382at a specific position inside the overlay. 1629at a specific position inside the overlay.
1630
1631If C<$rend> is missing, then the rendition will not be changed.
1383 1632
1384=item $overlay->hide 1633=item $overlay->hide
1385 1634
1386If visible, hide the overlay, but do not destroy it. 1635If visible, hide the overlay, but do not destroy it.
1387 1636
1469locale-specific encoding of the terminal and can contain command sequences 1718locale-specific encoding of the terminal and can contain command sequences
1470(escape codes) that will be interpreted. 1719(escape codes) that will be interpreted.
1471 1720
1472=item $term->tt_write ($octets) 1721=item $term->tt_write ($octets)
1473 1722
1474Write the octets given in C<$data> to the tty (i.e. as program input). To 1723Write the octets given in C<$octets> to the tty (i.e. as program input). To
1475pass characters instead of octets, you should convert your strings first 1724pass characters instead of octets, you should convert your strings first
1476to the locale-specific encoding using C<< $term->locale_encode >>. 1725to the locale-specific encoding using C<< $term->locale_encode >>.
1726
1727=item $term->tt_paste ($octets)
1728
1729Write the octets given in C<$octets> to the tty as a paste, converting NL to
1730CR and bracketing the data with control sequences if bracketed paste mode
1731is set.
1477 1732
1478=item $old_events = $term->pty_ev_events ([$new_events]) 1733=item $old_events = $term->pty_ev_events ([$new_events])
1479 1734
1480Replaces the event mask of the pty watcher by the given event mask. Can 1735Replaces the event mask of the pty watcher by the given event mask. Can
1481be used to suppress input and output handling to the pty/tty. See the 1736be used to suppress input and output handling to the pty/tty. See the
1499 1754
1500Adds the specified events to the vt event mask. Useful e.g. when you want 1755Adds the specified events to the vt event mask. Useful e.g. when you want
1501to receive pointer events all the times: 1756to receive pointer events all the times:
1502 1757
1503 $term->vt_emask_add (urxvt::PointerMotionMask); 1758 $term->vt_emask_add (urxvt::PointerMotionMask);
1759
1760=item $term->set_urgency ($set)
1761
1762Enable/disable the urgency hint on the toplevel window.
1504 1763
1505=item $term->focus_in 1764=item $term->focus_in
1506 1765
1507=item $term->focus_out 1766=item $term->focus_out
1508 1767
1795Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2054Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1796recent grab. 2055recent grab.
1797 2056
1798=item $term->ungrab 2057=item $term->ungrab
1799 2058
1800Calls XUngrab for the most recent grab. Is called automatically on 2059Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1801evaluation errors, as it is better to lose the grab in the error case as 2060evaluation errors, as it is better to lose the grab in the error case as
1802the session. 2061the session.
1803 2062
1804=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2063=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1805 2064
1825 2084
1826=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2085=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1827 2086
1828=item $term->XChangeInput ($window, $add_events[, $del_events]) 2087=item $term->XChangeInput ($window, $add_events[, $del_events])
1829 2088
2089=item $keysym = $term->XStringToKeysym ($string)
2090
2091=item $string = $term->XKeysymToString ($keysym)
2092
1830Various X or X-related functions. The C<$term> object only serves as 2093Various X or X-related functions. The C<$term> object only serves as
1831the source of the display, otherwise those functions map more-or-less 2094the source of the display, otherwise those functions map more-or-less
1832directory onto the X functions of the same name. 2095directly onto the X functions of the same name.
1833 2096
1834=back 2097=back
1835 2098
1836=cut 2099=cut
1837 2100
1994 2257
1995=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2258=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1996 2259
1997Set the callback to be called when the timer triggers. 2260Set the callback to be called when the timer triggers.
1998 2261
1999=item $tstamp = $timer->at
2000
2001Return the time this watcher will fire next.
2002
2003=item $timer = $timer->set ($tstamp) 2262=item $timer = $timer->set ($tstamp[, $interval])
2004 2263
2005Set the time the event is generated to $tstamp. 2264Set the time the event is generated to $tstamp (and optionally specifies a
2265new $interval).
2006 2266
2007=item $timer = $timer->interval ($interval) 2267=item $timer = $timer->interval ($interval)
2008 2268
2009Normally (and when C<$interval> is C<0>), the timer will automatically 2269By default (and when C<$interval> is C<0>), the timer will automatically
2010stop after it has fired once. If C<$interval> is non-zero, then the timer 2270stop after it has fired once. If C<$interval> is non-zero, then the timer
2011is automatically rescheduled at the given intervals. 2271is automatically rescheduled at the given intervals.
2012 2272
2013=item $timer = $timer->start 2273=item $timer = $timer->start
2014 2274
2015Start the timer. 2275Start the timer.
2016 2276
2017=item $timer = $timer->start ($tstamp) 2277=item $timer = $timer->start ($tstamp[, $interval])
2018 2278
2019Set the event trigger time to C<$tstamp> and start the timer. 2279Set the event trigger time to C<$tstamp> and start the timer. Optionally
2280also replaces the interval.
2020 2281
2021=item $timer = $timer->after ($delay) 2282=item $timer = $timer->after ($delay[, $interval])
2022 2283
2023Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2284Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2024 2285
2025=item $timer = $timer->stop 2286=item $timer = $timer->stop
2026 2287
2157 2418
2158=back 2419=back
2159 2420
2160=head1 AUTHOR 2421=head1 AUTHOR
2161 2422
2162 Marc Lehmann <pcg@goof.com> 2423 Marc Lehmann <schmorp@schmorp.de>
2163 http://software.schmorp.de/pkg/rxvt-unicode 2424 http://software.schmorp.de/pkg/rxvt-unicode
2164 2425
2165=cut 2426=cut
2166 2427
21671 24281

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines