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.112 by root, Thu Jan 19 21:02:06 2006 UTC vs.
Revision 1.138 by root, Sat Mar 4 22:36:50 2006 UTC

67the match. For example, the followign adds a regex that matches everything 67the match. For example, the followign adds a regex that matches everything
68between two vertical bars: 68between two vertical bars:
69 69
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71 71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
72You can look at the source of the selection extension to see more 79You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end. 80interesting uses, such as parsing a line from beginning to end.
74 81
75This extension also offers following bindable keyboard commands: 82This extension also offers following bindable keyboard commands:
76 83
87=item option-popup (enabled by default) 94=item option-popup (enabled by default)
88 95
89Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90runtime. 97runtime.
91 98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
115
92=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
93 117
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
96evalution, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
97 121
98Other extensions can extend this popup menu by pushing a code reference 122Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100popup is displayed. 124popup is being displayed.
101 125
102It's sole argument is the popup menu, which can be modified. The selection 126It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not. 127is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The 128It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called 129string will be used as button text and the code reference will be called
127bottom. C<Escape> leaves search mode and returns to the point where search 151bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and 152was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary 153additionally stores the first match in the current line into the primary
130selection. 154selection.
131 155
156=item readline (enabled by default)
157
158A support package that tries to make editing with readline easier. At
159the moment, it reacts to clicking shift-left mouse button by trying to
160move the text cursor to this position. It does so by generating as many
161cursor-left or cursor-right keypresses as required (the this only works
162for programs that correctly support wide characters).
163
164To avoid too many false positives, this is only done when:
165
166=over 4
167
168=item - the tty is in ICANON state.
169
170=item - the text cursor is visible.
171
172=item - the primary screen is currently being displayed.
173
174=item - the mouse is on the same (multi-row-) line as the text cursor.
175
176=back
177
178The normal selection mechanism isn't disabled, so quick successive clicks
179might interfere with selection creation in harmless ways.
180
132=item selection-autotransform 181=item selection-autotransform
133 182
134This selection allows you to do automatic transforms on a selection 183This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 184whenever a selection is made.
136 185
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/ 210 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162 211
163The first line tells the selection code to treat the unchanging part of 212The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 213every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 214the message into vi commands to load the file.
215
216=item tabbed
217
218This transforms the terminal into a tabbar with additional terminals, that
219is, it implements what is commonly refered to as "tabbed terminal". The topmost line
220displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221button per tab.
222
223Clicking a button will activate that tab. Pressing B<Shift-Left> and
224B<Shift-Right> will switch to the tab left or right of the current one,
225while B<Shift-Down> creates a new tab.
226
227The tabbar itself can be configured similarly to a normal terminal, but
228with a resource class of C<URxvt.tabbed>. In addition, it supports the
229following four resources (shown with defaults):
230
231 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
232 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
233 URxvt.tabbed.tab-fg: <colour-index, default 0>
234 URxvt.tabbed.tab-bg: <colour-index, default 1>
235
236See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237indices.
166 238
167=item mark-urls 239=item mark-urls
168 240
169Uses per-line display filtering (C<on_line_update>) to underline urls and 241Uses per-line display filtering (C<on_line_update>) to underline urls and
170make them clickable. When middle-clicked, the program specified in the 242make them clickable. When middle-clicked, the program specified in the
171resource C<urlLauncher> (default C<x-www-browser>) will be started with 243resource C<urlLauncher> (default C<x-www-browser>) will be started with
172the URL as first argument. 244the URL as first argument.
173 245
246=item xim-onthespot
247
248This (experimental) perl extension implements OnTheSpot editing. It does
249not work perfectly, and some input methods don't seem to work well with
250OnTheSpot editing in general, but it seems to work at leats for SCIM and
251kinput2.
252
253You enable it by specifying this extension and a preedit style of
254C<OnTheSpot>, i.e.:
255
256 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257
174=item automove-background 258=item automove-background
175 259
176This is basically a one-line extension that dynamically changes the background pixmap offset 260This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with 261to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple: 262a custom pixmap. No scaling is supported in this mode. Exmaple:
187 271
188=item digital-clock 272=item digital-clock
189 273
190Displays a digital clock using the built-in overlay. 274Displays a digital clock using the built-in overlay.
191 275
192=item example-refresh-hooks 276=item remote-clipboard
193 277
194Displays a very simple digital clock in the upper right corner of the 278Somewhat of a misnomer, this extension adds two menu entries to the
195window. Illustrates overwriting the refresh callbacks to create your own 279selection popup that allows one ti run external commands to store the
196overlays or changes. 280selection somewhere and fetch it again.
281
282We use it to implement a "distributed selection mechanism", which just
283means that one command uploads the file to a remote server, and another
284reads it.
285
286The commands can be set using the C<URxvt.remote-selection.store> and
287C<URxvt.remote-selection.fetch> resources. The first should read the
288selection to store from STDIN (always in UTF-8), the second should provide
289the selection data on STDOUT (also in UTF-8).
290
291The defaults (which are likely useless to you) use rsh and cat:
292
293 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
197 295
198=item selection-pastebin 296=item selection-pastebin
199 297
200This is a little rarely useful extension that Uploads the selection as 298This is a little rarely useful extension that Uploads the selection as
201textfile to a remote site (or does other things). (The implementation is 299textfile to a remote site (or does other things). (The implementation is
221After a successful upload the selection will be replaced by the text given 319After a successful upload the selection will be replaced by the text given
222in the C<selection-pastebin-url> resource (again, the % is the placeholder 320in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename): 321for the filename):
224 322
225 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 323 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325=item example-refresh-hooks
326
327Displays a very simple digital clock in the upper right corner of the
328window. Illustrates overwriting the refresh callbacks to create your own
329overlays or changes.
226 330
227=back 331=back
228 332
229=head1 API DOCUMENTATION 333=head1 API DOCUMENTATION
230 334
323place. 427place.
324 428
325=item on_start $term 429=item on_start $term
326 430
327Called at the very end of initialisation of a new terminal, just before 431Called at the very end of initialisation of a new terminal, just before
328returning to the mainloop. 432trying to map (display) the toplevel and returning to the mainloop.
433
434=item on_destroy $term
435
436Called whenever something tries to destroy terminal, when the terminal is
437still fully functional (not for long, though).
329 438
330=item on_reset $term 439=item on_reset $term
331 440
332Called after the screen is "reset" for any reason, such as resizing or 441Called after the screen is "reset" for any reason, such as resizing or
333control sequences. Here is where you can react on changes to size-related 442control sequences. Here is where you can react on changes to size-related
384 493
385It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 494It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
386$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 495$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
387number of lines that will be in the scrollback buffer. 496number of lines that will be in the scrollback buffer.
388 497
498=item on_osc_seq $term, $op, $args
499
500Called on every OSC sequence and can be used to suppress it or modify its
501behaviour. The default should be to return an empty list. A true value
502suppresses execution of the request completely. Make sure you don't get
503confused by recursive invocations when you output an osc sequence within
504this callback.
505
506C<on_osc_seq_perl> should be used for new behaviour.
507
389=item on_osc_seq $term, $string 508=item on_osc_seq_perl $term, $string
390 509
391Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 510Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
392operating system command) is processed. Cursor position and other state 511operating system command) is processed. Cursor position and other state
393information is up-to-date when this happens. For interoperability, the 512information is up-to-date when this happens. For interoperability, the
394string should start with the extension name and a colon, to distinguish 513string should start with the extension name and a colon, to distinguish
435 554
436=item on_refresh_end $term 555=item on_refresh_end $term
437 556
438Called just after the screen gets redrawn. See C<on_refresh_begin>. 557Called just after the screen gets redrawn. See C<on_refresh_begin>.
439 558
440=item on_keyboard_command $term, $string 559=item on_user_command $term, $string
441 560
442Called whenever the user presses a key combination that has a 561Called whenever the a user-configured event is being activated (e.g. via
443C<perl:string> action bound to it (see description of the B<keysym> 562a C<perl:string> action bound to a key, see description of the B<keysym>
444resource in the @@RXVT_NAME@@(1) manpage). 563resource in the @@RXVT_NAME@@(1) manpage).
564
565The event is simply the action string. This interface is assumed to change
566slightly in the future.
567
568=item on_resize_all_windows $tern, $new_width, $new_height
569
570Called just after the new window size has been calculcated, but before
571windows are actually being resized or hints are being set. If this hook
572returns TRUE, setting of the window hints is being skipped.
445 573
446=item on_x_event $term, $event 574=item on_x_event $term, $event
447 575
448Called on every X event received on the vt window (and possibly other 576Called on every X event received on the vt window (and possibly other
449windows). Should only be used as a last resort. Most event structure 577windows). Should only be used as a last resort. Most event structure
459Called wheneever the window loses keyboard focus, before rxvt-unicode does 587Called wheneever the window loses keyboard focus, before rxvt-unicode does
460focus out processing. 588focus out processing.
461 589
462=item on_configure_notify $term, $event 590=item on_configure_notify $term, $event
463 591
592=item on_property_notify $term, $event
593
464=item on_key_press $term, $event, $keysym, $octets 594=item on_key_press $term, $event, $keysym, $octets
465 595
466=item on_key_release $term, $event, $keysym 596=item on_key_release $term, $event, $keysym
467 597
468=item on_button_press $term, $event 598=item on_button_press $term, $event
477 607
478Called whenever the corresponding X event is received for the terminal If 608Called whenever the corresponding X event is received for the terminal If
479the hook returns true, then the even will be ignored by rxvt-unicode. 609the hook returns true, then the even will be ignored by rxvt-unicode.
480 610
481The event is a hash with most values as named by Xlib (see the XEvent 611The event is a hash with most values as named by Xlib (see the XEvent
482manpage), with the additional members C<row> and C<col>, which are the row 612manpage), with the additional members C<row> and C<col>, which are the
483and column under the mouse cursor. 613(real, not screen-based) row and column under the mouse cursor.
484 614
485C<on_key_press> additionally receives the string rxvt-unicode would 615C<on_key_press> additionally receives the string rxvt-unicode would
486output, if any, in locale-specific encoding. 616output, if any, in locale-specific encoding.
487 617
488subwindow. 618subwindow.
619
620=item on_client_message $term, $event
621
622=item on_wm_protocols $term, $event
623
624=item on_wm_delete_window $term, $event
625
626Called when various types of ClientMessage events are received (all with
627format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
489 628
490=back 629=back
491 630
492=cut 631=cut
493 632
499use Scalar::Util (); 638use Scalar::Util ();
500use List::Util (); 639use List::Util ();
501 640
502our $VERSION = 1; 641our $VERSION = 1;
503our $TERM; 642our $TERM;
643our @TERM_INIT;
644our @TERM_EXT;
504our @HOOKNAME; 645our @HOOKNAME;
505our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 646our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
506our %OPTION; 647our %OPTION;
507 648
508our $LIBDIR; 649our $LIBDIR;
509our $RESNAME; 650our $RESNAME;
510our $RESCLASS; 651our $RESCLASS;
511our $RXVTNAME; 652our $RXVTNAME;
512 653
654our $NOCHAR = chr 0xffff;
655
513=head2 Variables in the C<urxvt> Package 656=head2 Variables in the C<urxvt> Package
514 657
515=over 4 658=over 4
516 659
517=item $urxvt::LIBDIR 660=item $urxvt::LIBDIR
529 672
530=item $urxvt::TERM 673=item $urxvt::TERM
531 674
532The current terminal. This variable stores the current C<urxvt::term> 675The current terminal. This variable stores the current C<urxvt::term>
533object, whenever a callback/hook is executing. 676object, whenever a callback/hook is executing.
677
678=item @urxvt::TERM_INIT
679
680All coderefs in this array will be called as methods of the next newly
681created C<urxvt::term> object (during the C<on_init> phase). The array
682gets cleared before the codereferences that were in it are being executed,
683so coderefs can push themselves onto it again if they so desire.
684
685This complements to the perl-eval commandline option, but gets executed
686first.
687
688=item @urxvt::TERM_EXT
689
690Works similar to C<@TERM_INIT>, but contains perl package/class names, which
691get registered as normal extensions after calling the hooks in C<@TERM_INIT>
692but before other extensions. Gets cleared just like C<@TERM_INIT>.
534 693
535=back 694=back
536 695
537=head2 Functions in the C<urxvt> Package 696=head2 Functions in the C<urxvt> Package
538 697
552 711
553Using this function has the advantage that its output ends up in the 712Using this function has the advantage that its output ends up in the
554correct place, e.g. on stderr of the connecting urxvtc client. 713correct place, e.g. on stderr of the connecting urxvtc client.
555 714
556Messages have a size limit of 1023 bytes currently. 715Messages have a size limit of 1023 bytes currently.
716
717=item @terms = urxvt::termlist
718
719Returns all urxvt::term objects that exist in this process, regardless of
720wether they are started, being destroyed etc., so be careful. Only term
721objects that have perl extensions attached will be returned (because there
722is no urxvt::term objet associated with others).
557 723
558=item $time = urxvt::NOW 724=item $time = urxvt::NOW
559 725
560Returns the "current time" (as per the event loop). 726Returns the "current time" (as per the event loop).
561 727
619Return the foreground/background colour index, respectively. 785Return the foreground/background colour index, respectively.
620 786
621=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 787=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
622 788
623=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 789=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
790
791=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
624 792
625Replace the foreground/background colour in the rendition mask with the 793Replace the foreground/background colour in the rendition mask with the
626specified one. 794specified one.
627 795
628=item $value = urxvt::GET_CUSTOM $rend 796=item $value = urxvt::GET_CUSTOM $rend
647 unless $msg =~ /\n$/; 815 unless $msg =~ /\n$/;
648 urxvt::warn ($msg); 816 urxvt::warn ($msg);
649 }; 817 };
650} 818}
651 819
820no warnings 'utf8';
821
652my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 822my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
653 823
654sub verbose { 824sub verbose {
655 my ($level, $msg) = @_; 825 my ($level, $msg) = @_;
656 warn "$msg\n" if $level <= $verbosity; 826 warn "$msg\n" if $level <= $verbosity;
659my %extension_pkg; 829my %extension_pkg;
660 830
661# load a single script into its own package, once only 831# load a single script into its own package, once only
662sub extension_package($) { 832sub extension_package($) {
663 my ($path) = @_; 833 my ($path) = @_;
664
665 no strict 'refs';
666 834
667 $extension_pkg{$path} ||= do { 835 $extension_pkg{$path} ||= do {
668 $path =~ /([^\/\\]+)$/; 836 $path =~ /([^\/\\]+)$/;
669 my $pkg = $1; 837 my $pkg = $1;
670 $pkg =~ s/[^[:word:]]/_/g; 838 $pkg =~ s/[^[:word:]]/_/g;
673 verbose 3, "loading extension '$path' into package '$pkg'"; 841 verbose 3, "loading extension '$path' into package '$pkg'";
674 842
675 open my $fh, "<:raw", $path 843 open my $fh, "<:raw", $path
676 or die "$path: $!"; 844 or die "$path: $!";
677 845
678 @{"$pkg\::ISA"} = urxvt::term::extension::;
679
680 my $source = 846 my $source =
681 "package $pkg; use strict; use utf8;\n" 847 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
682 . "#line 1 \"$path\"\n{\n" 848 . "#line 1 \"$path\"\n{\n"
683 . (do { local $/; <$fh> }) 849 . (do { local $/; <$fh> })
684 . "\n};\n1"; 850 . "\n};\n1";
685 851
686 eval $source 852 eval $source
700 if ($htype == 0) { # INIT 866 if ($htype == 0) { # INIT
701 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 867 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
702 868
703 my %ext_arg; 869 my %ext_arg;
704 870
871 {
872 my @init = @TERM_INIT;
873 @TERM_INIT = ();
874 $_->($TERM) for @init;
875 my @pkg = @TERM_EXT;
876 @TERM_EXT = ();
877 $TERM->register_package ($_) for @pkg;
878 }
879
705 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 880 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
706 if ($_ eq "default") { 881 if ($_ eq "default") {
707 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 882 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
708 } elsif (/^-(.*)$/) { 883 } elsif (/^-(.*)$/) {
709 delete $ext_arg{$1}; 884 delete $ext_arg{$1};
710 } elsif (/^([^<]+)<(.*)>$/) { 885 } elsif (/^([^<]+)<(.*)>$/) {
711 push @{ $ext_arg{$1} }, $2; 886 push @{ $ext_arg{$1} }, $2;
712 } else { 887 } else {
713 $ext_arg{$_} ||= []; 888 $ext_arg{$_} ||= [];
714 } 889 }
715 } 890 }
716 891
717 while (my ($ext, $argv) = each %ext_arg) { 892 for my $ext (sort keys %ext_arg) {
718 my @files = grep -f $_, map "$_/$ext", @dirs; 893 my @files = grep -f $_, map "$_/$ext", @dirs;
719 894
720 if (@files) { 895 if (@files) {
721 $TERM->register_package (extension_package $files[0], $argv); 896 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
722 } else { 897 } else {
723 warn "perl extension '$ext' not found in perl library search path\n"; 898 warn "perl extension '$ext' not found in perl library search path\n";
724 } 899 }
725 } 900 }
726 901
732 907
733 if (my $cb = $TERM->{_hook}[$htype]) { 908 if (my $cb = $TERM->{_hook}[$htype]) {
734 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 909 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
735 if $verbosity >= 10; 910 if $verbosity >= 10;
736 911
737 keys %$cb; 912 for my $pkg (keys %$cb) {
738
739 while (my ($pkg, $cb) = each %$cb) {
740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 913 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
914 $retval ||= $retval_;
741 915
742 if ($@) { 916 if ($@) {
743 $TERM->ungrab; # better to lose the grab than the session 917 $TERM->ungrab; # better to lose the grab than the session
744 warn $@; 918 warn $@;
745 } 919 }
756 # clear package 930 # clear package
757 %$TERM = (); 931 %$TERM = ();
758 } 932 }
759 933
760 $retval 934 $retval
935}
936
937sub SET_COLOR($$$) {
938 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
761} 939}
762 940
763# urxvt::term::extension 941# urxvt::term::extension
764 942
765package urxvt::term::extension; 943package urxvt::term::extension;
904# find on_xxx subs in the package and register them 1082# find on_xxx subs in the package and register them
905# as hooks 1083# as hooks
906sub register_package { 1084sub register_package {
907 my ($self, $pkg, $argv) = @_; 1085 my ($self, $pkg, $argv) = @_;
908 1086
1087 no strict 'refs';
1088
1089 urxvt::verbose 6, "register package $pkg to $self";
1090
1091 @{"$pkg\::ISA"} = urxvt::term::extension::;
1092
909 my $proxy = bless { 1093 my $proxy = bless {
910 _pkg => $pkg, 1094 _pkg => $pkg,
911 argv => $argv, 1095 argv => $argv,
912 }, $pkg; 1096 }, $pkg;
913 Scalar::Util::weaken ($proxy->{term} = $self); 1097 Scalar::Util::weaken ($proxy->{term} = $self);
928hash which defines the environment of the new terminal. 1112hash which defines the environment of the new terminal.
929 1113
930Croaks (and probably outputs an error message) if the new instance 1114Croaks (and probably outputs an error message) if the new instance
931couldn't be created. Returns C<undef> if the new instance didn't 1115couldn't be created. Returns C<undef> if the new instance didn't
932initialise perl, and the terminal object otherwise. The C<init> and 1116initialise perl, and the terminal object otherwise. The C<init> and
933C<start> hooks will be called during this call. 1117C<start> hooks will be called before this call returns, and are free to
1118refer to global data (which is race free).
934 1119
935=cut 1120=cut
936 1121
937sub new { 1122sub new {
938 my ($class, $env, @args) = @_; 1123 my ($class, $env, @args) = @_;
939 1124
1125 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1126 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1127
940 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1128 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
941} 1129}
942 1130
943=item $term->destroy 1131=item $term->destroy
944 1132
945Destroy the terminal object (close the window, free resources 1133Destroy the terminal object (close the window, free resources
1202 1390
1203Normally its not a good idea to use this function, as programs might be 1391Normally its not a good idea to use this function, as programs might be
1204confused by changes in cursor position or scrolling. Its useful inside a 1392confused by changes in cursor position or scrolling. Its useful inside a
1205C<on_add_lines> hook, though. 1393C<on_add_lines> hook, though.
1206 1394
1395=item $term->scr_change_screen ($screen)
1396
1397Switch to given screen - 0 primary, 1 secondary.
1398
1207=item $term->cmd_parse ($octets) 1399=item $term->cmd_parse ($octets)
1208 1400
1209Similar to C<scr_add_lines>, but the argument must be in the 1401Similar to C<scr_add_lines>, but the argument must be in the
1210locale-specific encoding of the terminal and can contain command sequences 1402locale-specific encoding of the terminal and can contain command sequences
1211(escape codes) that will be interpreted. 1403(escape codes) that will be interpreted.
1221Replaces the event mask of the pty watcher by the given event mask. Can 1413Replaces the event mask of the pty watcher by the given event mask. Can
1222be used to suppress input and output handling to the pty/tty. See the 1414be used to suppress input and output handling to the pty/tty. See the
1223description of C<< urxvt::timer->events >>. Make sure to always restore 1415description of C<< urxvt::timer->events >>. Make sure to always restore
1224the previous value. 1416the previous value.
1225 1417
1418=item $fd = $term->pty_fd
1419
1420Returns the master file descriptor for the pty in use, or C<-1> if no pty
1421is used.
1422
1226=item $windowid = $term->parent 1423=item $windowid = $term->parent
1227 1424
1228Return the window id of the toplevel window. 1425Return the window id of the toplevel window.
1229 1426
1230=item $windowid = $term->vt 1427=item $windowid = $term->vt
1236Adds the specified events to the vt event mask. Useful e.g. when you want 1433Adds the specified events to the vt event mask. Useful e.g. when you want
1237to receive pointer events all the times: 1434to receive pointer events all the times:
1238 1435
1239 $term->vt_emask_add (urxvt::PointerMotionMask); 1436 $term->vt_emask_add (urxvt::PointerMotionMask);
1240 1437
1438=item $term->focus_in
1439
1440=item $term->focus_out
1441
1442=item $term->key_press ($state, $keycode[, $time])
1443
1444=item $term->key_release ($state, $keycode[, $time])
1445
1446Deliver various fake events to to terminal.
1447
1241=item $window_width = $term->width 1448=item $window_width = $term->width
1242 1449
1243=item $window_height = $term->height 1450=item $window_height = $term->height
1244 1451
1245=item $font_width = $term->fwidth 1452=item $font_width = $term->fwidth
1275=item $env = $term->env 1482=item $env = $term->env
1276 1483
1277Returns a copy of the environment in effect for the terminal as a hashref 1484Returns a copy of the environment in effect for the terminal as a hashref
1278similar to C<\%ENV>. 1485similar to C<\%ENV>.
1279 1486
1487=item @envv = $term->envv
1488
1489Returns the environment as array of strings of the form C<VAR=VALUE>.
1490
1491=item @argv = $term->argv
1492
1493Return the argument vector as this terminal, similar to @ARGV, but
1494includes the program name as first element.
1495
1280=cut 1496=cut
1281 1497
1282sub env { 1498sub env {
1283 if (my $env = $_[0]->_env) {
1284 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1499 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1285 } else {
1286 +{ %ENV }
1287 }
1288} 1500}
1289 1501
1290=item $modifiermask = $term->ModLevel3Mask 1502=item $modifiermask = $term->ModLevel3Mask
1291 1503
1292=item $modifiermask = $term->ModMetaMask 1504=item $modifiermask = $term->ModMetaMask
1293 1505
1294=item $modifiermask = $term->ModNumLockMask 1506=item $modifiermask = $term->ModNumLockMask
1295 1507
1296Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1508Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1297AltGr), the meta key (often Alt) and the num lock key, if applicable. 1509AltGr), the meta key (often Alt) and the num lock key, if applicable.
1510
1511=item $screen = $term->current_screen
1512
1513Returns the currently displayed screen (0 primary, 1 secondary).
1514
1515=item $cursor_is_hidden = $term->hidden_cursor
1516
1517Returns wether the cursor is currently hidden or not.
1298 1518
1299=item $view_start = $term->view_start ([$newvalue]) 1519=item $view_start = $term->view_start ([$newvalue])
1300 1520
1301Returns the row number of the topmost displayed line. Maximum value is 1521Returns the row number of the topmost displayed line. Maximum value is
1302C<0>, which displays the normal terminal contents. Lower values scroll 1522C<0>, which displays the normal terminal contents. Lower values scroll
1322line, starting at column C<$start_col> (default C<0>), which is useful 1542line, starting at column C<$start_col> (default C<0>), which is useful
1323to replace only parts of a line. The font index in the rendition will 1543to replace only parts of a line. The font index in the rendition will
1324automatically be updated. 1544automatically be updated.
1325 1545
1326C<$text> is in a special encoding: tabs and wide characters that use more 1546C<$text> is in a special encoding: tabs and wide characters that use more
1327than one cell when displayed are padded with urxvt::NOCHAR characters 1547than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1328(C<chr 65535>). Characters with combining characters and other characters 1548characters. Characters with combining characters and other characters that
1329that do not fit into the normal tetx encoding will be replaced with 1549do not fit into the normal tetx encoding will be replaced with characters
1330characters in the private use area. 1550in the private use area.
1331 1551
1332You have to obey this encoding when changing text. The advantage is 1552You have to obey this encoding when changing text. The advantage is
1333that C<substr> and similar functions work on screen cells and not on 1553that C<substr> and similar functions work on screen cells and not on
1334characters. 1554characters.
1335 1555
1482=item $string = $term->special_decode $text 1702=item $string = $term->special_decode $text
1483 1703
1484Converts rxvt-unicodes text reprsentation into a perl string. See 1704Converts rxvt-unicodes text reprsentation into a perl string. See
1485C<< $term->ROW_t >> for details. 1705C<< $term->ROW_t >> for details.
1486 1706
1487=item $success = $term->grab_button ($button, $modifiermask) 1707=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1488 1708
1709=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1710
1489Registers a synchronous button grab. See the XGrabButton manpage. 1711Register/unregister a synchronous button grab. See the XGrabButton
1712manpage.
1490 1713
1491=item $success = $term->grab ($eventtime[, $sync]) 1714=item $success = $term->grab ($eventtime[, $sync])
1492 1715
1493Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1716Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494synchronous (C<$sync> is true). Also remembers the grab timestampe. 1717synchronous (C<$sync> is true). Also remembers the grab timestampe.
1509=item $term->ungrab 1732=item $term->ungrab
1510 1733
1511Calls XUngrab for the most recent grab. Is called automatically on 1734Calls XUngrab for the most recent grab. Is called automatically on
1512evaluation errors, as it is better to lose the grab in the error case as 1735evaluation errors, as it is better to lose the grab in the error case as
1513the session. 1736the session.
1737
1738=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1739
1740=item $atom_name = $term->XGetAtomName ($atom)
1741
1742=item @atoms = $term->XListProperties ($window)
1743
1744=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1745
1746=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1747
1748=item $term->XDeleteProperty ($window, $property)
1749
1750=item $window = $term->DefaultRootWindow
1751
1752=item $term->XReparentWindow ($window, $parent, [$x, $y])
1753
1754=item $term->XMapWindow ($window)
1755
1756=item $term->XUnmapWindow ($window)
1757
1758=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1759
1760=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1761
1762=item $term->XChangeInput ($window, $add_events[, $del_events])
1763
1764Various X or X-related functions. The C<$term> object only serves as
1765the source of the display, otherwise those functions map more-or-less
1766directory onto the X functions of the same name.
1514 1767
1515=back 1768=back
1516 1769
1517=cut 1770=cut
1518 1771
1582 my ($self, $text, $cb) = @_; 1835 my ($self, $text, $cb) = @_;
1583 1836
1584 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1837 $self->add_item ({ type => "button", text => $text, activate => $cb});
1585} 1838}
1586 1839
1587=item $popup->add_toggle ($text, $cb, $initial_value) 1840=item $popup->add_toggle ($text, $initial_value, $cb)
1588 1841
1589Adds a toggle/checkbox item to the popup. Teh callback gets called 1842Adds a toggle/checkbox item to the popup. The callback gets called
1590whenever it gets toggled, with a boolean indicating its value as its first 1843whenever it gets toggled, with a boolean indicating its new value as its
1591argument. 1844first argument.
1592 1845
1593=cut 1846=cut
1594 1847
1595sub add_toggle { 1848sub add_toggle {
1596 my ($self, $text, $cb, $value) = @_; 1849 my ($self, $text, $value, $cb) = @_;
1597 1850
1598 my $item; $item = { 1851 my $item; $item = {
1599 type => "button", 1852 type => "button",
1600 text => " $text", 1853 text => " $text",
1601 value => $value, 1854 value => $value,
1638 delete $self->{term}{_destroy}{$self}; 1891 delete $self->{term}{_destroy}{$self};
1639 $self->{term}->ungrab; 1892 $self->{term}->ungrab;
1640} 1893}
1641 1894
1642=back 1895=back
1896
1897=cut
1898
1899package urxvt::watcher;
1900
1901@urxvt::timer::ISA = __PACKAGE__;
1902@urxvt::iow::ISA = __PACKAGE__;
1903@urxvt::pw::ISA = __PACKAGE__;
1904@urxvt::iw::ISA = __PACKAGE__;
1643 1905
1644=head2 The C<urxvt::timer> Class 1906=head2 The C<urxvt::timer> Class
1645 1907
1646This class implements timer watchers/events. Time is represented as a 1908This class implements timer watchers/events. Time is represented as a
1647fractional number of seconds since the epoch. Example: 1909fractional number of seconds since the epoch. Example:
1745 2007
1746Stop watching for events on the given filehandle. 2008Stop watching for events on the given filehandle.
1747 2009
1748=back 2010=back
1749 2011
2012=head2 The C<urxvt::iw> Class
2013
2014This class implements idle watchers, that get called automatically when
2015the process is idle. They should return as fast as possible, after doing
2016some useful work.
2017
2018=over 4
2019
2020=item $iw = new urxvt::iw
2021
2022Create a new idle watcher object in stopped state.
2023
2024=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2025
2026Set the callback to be called when the watcher triggers.
2027
2028=item $timer = $timer->start
2029
2030Start the watcher.
2031
2032=item $timer = $timer->stop
2033
2034Stop the watcher.
2035
2036=back
2037
2038=head2 The C<urxvt::pw> Class
2039
2040This class implements process watchers. They create an event whenever a
2041process exits, after which they stop automatically.
2042
2043 my $pid = fork;
2044 ...
2045 $term->{pw} = urxvt::pw
2046 ->new
2047 ->start ($pid)
2048 ->cb (sub {
2049 my ($pw, $exit_status) = @_;
2050 ...
2051 });
2052
2053=over 4
2054
2055=item $pw = new urxvt::pw
2056
2057Create a new process watcher in stopped state.
2058
2059=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2060
2061Set the callback to be called when the timer triggers.
2062
2063=item $pw = $timer->start ($pid)
2064
2065Tells the wqtcher to start watching for process C<$pid>.
2066
2067=item $pw = $pw->stop
2068
2069Stop the watcher.
2070
2071=back
2072
1750=head1 ENVIRONMENT 2073=head1 ENVIRONMENT
1751 2074
1752=head2 URXVT_PERL_VERBOSITY 2075=head2 URXVT_PERL_VERBOSITY
1753 2076
1754This variable controls the verbosity level of the perl extension. Higher 2077This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines