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.110 by root, Thu Jan 19 16:22:13 2006 UTC vs.
Revision 1.136 by root, Mon Feb 20 20:44:22 2006 UTC

34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
63the match. For example, the followign adds a regex that matches everything 67the match. For example, the followign adds a regex that matches everything
64between two vertical bars: 68between two vertical bars:
65 69
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 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
68You 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
69interesting uses, such as parsing a line from beginning to end. 80interesting uses, such as parsing a line from beginning to end.
70 81
71This extension also offers following bindable keyboard commands: 82This extension also offers following bindable keyboard commands:
72 83
83=item option-popup (enabled by default) 94=item option-popup (enabled by default)
84 95
85Binds 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
86runtime. 97runtime.
87 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
88=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
89 117
90Binds 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
91text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
93 121
94Other extensions can extend this popup menu by pushing a code reference 122Other extensions can extend this popup menu by pushing a code reference
95onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
96popup is displayed. 124popup is being displayed.
97 125
98It'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
99is 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.
100It 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
101string 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
123bottom. 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
124was 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
125additionally stores the first match in the current line into the primary 153additionally stores the first match in the current line into the primary
126selection. 154selection.
127 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
128=item selection-autotransform 181=item selection-autotransform
129 182
130This selection allows you to do automatic transforms on a selection 183This selection allows you to do automatic transforms on a selection
131whenever a selection is made. 184whenever a selection is made.
132 185
157 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/
158 211
159The 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
160every error message as a selection pattern, and the second line transforms 213every error message as a selection pattern, and the second line transforms
161the 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.
162 238
163=item mark-urls 239=item mark-urls
164 240
165Uses 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
166make them clickable. When middle-clicked, the program specified in the 242make them clickable. When middle-clicked, the program specified in the
167resource C<urlLauncher> (default C<x-www-browser>) will be started with 243resource C<urlLauncher> (default C<x-www-browser>) will be started with
168the URL as first argument. 244the URL as first argument.
169 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
170=item automove-background 258=item automove-background
171 259
172This 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
173to 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
174a custom pixmap. No scaling is supported in this mode. Exmaple: 262a custom pixmap. No scaling is supported in this mode. Exmaple:
183 271
184=item digital-clock 272=item digital-clock
185 273
186Displays a digital clock using the built-in overlay. 274Displays a digital clock using the built-in overlay.
187 275
188=item example-refresh-hooks 276=item remote-clipboard
189 277
190Displays a very simple digital clock in the upper right corner of the 278Somewhat of a misnomer, this extension adds two menu entries to the
191window. Illustrates overwriting the refresh callbacks to create your own 279selection popup that allows one ti run external commands to store the
192overlays 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'
193 295
194=item selection-pastebin 296=item selection-pastebin
195 297
196This is a little rarely useful extension that Uploads the selection as 298This is a little rarely useful extension that Uploads the selection as
197textfile to a remote site (or does other things). (The implementation is 299textfile to a remote site (or does other things). (The implementation is
217After 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
218in the C<selection-pastebin-url> resource (again, the % is the placeholder 320in the C<selection-pastebin-url> resource (again, the % is the placeholder
219for the filename): 321for the filename):
220 322
221 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.
222 330
223=back 331=back
224 332
225=head1 API DOCUMENTATION 333=head1 API DOCUMENTATION
226 334
299called whenever the relevant event happens. 407called whenever the relevant event happens.
300 408
301The first argument passed to them is an extension oject as described in 409The first argument passed to them is an extension oject as described in
302the in the C<Extension Objects> section. 410the in the C<Extension Objects> section.
303 411
304B<All> of these hooks must return a boolean value. If it is true, then the 412B<All> of these hooks must return a boolean value. If any of the called
305event counts as being I<consumed>, and the invocation of other hooks is 413hooks returns true, then the event counts as being I<consumed>, and the
306skipped, and the relevant action might not be carried out by the C++ code. 414relevant action might not be carried out by the C++ code.
307 415
308I<< When in doubt, return a false value (preferably C<()>). >> 416I<< When in doubt, return a false value (preferably C<()>). >>
309 417
310=over 4 418=over 4
311 419
312=item on_init $term 420=item on_init $term
313 421
314Called after a new terminal object has been initialized, but before 422Called after a new terminal object has been initialized, but before
315windows are created or the command gets run. Most methods are unsafe to 423windows are created or the command gets run. Most methods are unsafe to
316call or deliver senseless data, as terminal size and other characteristics 424call or deliver senseless data, as terminal size and other characteristics
317have not yet been determined. You can safely query and change resources, 425have not yet been determined. You can safely query and change resources
318though. 426and options, though. For many purposes the C<on_start> hook is a better
427place.
428
429=item on_start $term
430
431Called at the very end of initialisation of a new terminal, just before
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).
319 438
320=item on_reset $term 439=item on_reset $term
321 440
322Called 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
323control 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
324variables. 443variables.
325
326=item on_start $term
327
328Called at the very end of initialisation of a new terminal, just before
329returning to the mainloop.
330 444
331=item on_child_start $term, $pid 445=item on_child_start $term, $pid
332 446
333Called just after the child process has been C<fork>ed. 447Called just after the child process has been C<fork>ed.
334 448
430 544
431=item on_refresh_end $term 545=item on_refresh_end $term
432 546
433Called just after the screen gets redrawn. See C<on_refresh_begin>. 547Called just after the screen gets redrawn. See C<on_refresh_begin>.
434 548
435=item on_keyboard_command $term, $string 549=item on_user_command $term, $string
436 550
437Called whenever the user presses a key combination that has a 551Called whenever the a user-configured event is being activated (e.g. via
438C<perl:string> action bound to it (see description of the B<keysym> 552a C<perl:string> action bound to a key, see description of the B<keysym>
439resource in the @@RXVT_NAME@@(1) manpage). 553resource in the @@RXVT_NAME@@(1) manpage).
554
555The event is simply the action string. This interface is assumed to change
556slightly in the future.
557
558=item on_resize_all_windows $tern, $new_width, $new_height
559
560Called just after the new window size has been calculcated, but before
561windows are actually being resized or hints are being set. If this hook
562returns TRUE, setting of the window hints is being skipped.
440 563
441=item on_x_event $term, $event 564=item on_x_event $term, $event
442 565
443Called on every X event received on the vt window (and possibly other 566Called on every X event received on the vt window (and possibly other
444windows). Should only be used as a last resort. Most event structure 567windows). Should only be used as a last resort. Most event structure
454Called wheneever the window loses keyboard focus, before rxvt-unicode does 577Called wheneever the window loses keyboard focus, before rxvt-unicode does
455focus out processing. 578focus out processing.
456 579
457=item on_configure_notify $term, $event 580=item on_configure_notify $term, $event
458 581
582=item on_property_notify $term, $event
583
459=item on_key_press $term, $event, $keysym, $octets 584=item on_key_press $term, $event, $keysym, $octets
460 585
461=item on_key_release $term, $event, $keysym 586=item on_key_release $term, $event, $keysym
462 587
463=item on_button_press $term, $event 588=item on_button_press $term, $event
472 597
473Called whenever the corresponding X event is received for the terminal If 598Called whenever the corresponding X event is received for the terminal If
474the hook returns true, then the even will be ignored by rxvt-unicode. 599the hook returns true, then the even will be ignored by rxvt-unicode.
475 600
476The event is a hash with most values as named by Xlib (see the XEvent 601The event is a hash with most values as named by Xlib (see the XEvent
477manpage), with the additional members C<row> and C<col>, which are the row 602manpage), with the additional members C<row> and C<col>, which are the
478and column under the mouse cursor. 603(real, not screen-based) row and column under the mouse cursor.
479 604
480C<on_key_press> additionally receives the string rxvt-unicode would 605C<on_key_press> additionally receives the string rxvt-unicode would
481output, if any, in locale-specific encoding. 606output, if any, in locale-specific encoding.
482 607
483subwindow. 608subwindow.
609
610=item on_client_message $term, $event
611
612=item on_wm_protocols $term, $event
613
614=item on_wm_delete_window $term, $event
615
616Called when various types of ClientMessage events are received (all with
617format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
484 618
485=back 619=back
486 620
487=cut 621=cut
488 622
494use Scalar::Util (); 628use Scalar::Util ();
495use List::Util (); 629use List::Util ();
496 630
497our $VERSION = 1; 631our $VERSION = 1;
498our $TERM; 632our $TERM;
633our @TERM_INIT;
634our @TERM_EXT;
499our @HOOKNAME; 635our @HOOKNAME;
500our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 636our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
501our %OPTION; 637our %OPTION;
502 638
503our $LIBDIR; 639our $LIBDIR;
504our $RESNAME; 640our $RESNAME;
505our $RESCLASS; 641our $RESCLASS;
506our $RXVTNAME; 642our $RXVTNAME;
507 643
644our $NOCHAR = chr 0xffff;
645
508=head2 Variables in the C<urxvt> Package 646=head2 Variables in the C<urxvt> Package
509 647
510=over 4 648=over 4
511 649
512=item $urxvt::LIBDIR 650=item $urxvt::LIBDIR
524 662
525=item $urxvt::TERM 663=item $urxvt::TERM
526 664
527The current terminal. This variable stores the current C<urxvt::term> 665The current terminal. This variable stores the current C<urxvt::term>
528object, whenever a callback/hook is executing. 666object, whenever a callback/hook is executing.
667
668=item @urxvt::TERM_INIT
669
670All coderefs in this array will be called as methods of the next newly
671created C<urxvt::term> object (during the C<on_init> phase). The array
672gets cleared before the codereferences that were in it are being executed,
673so coderefs can push themselves onto it again if they so desire.
674
675This complements to the perl-eval commandline option, but gets executed
676first.
677
678=item @urxvt::TERM_EXT
679
680Works similar to C<@TERM_INIT>, but contains perl package/class names, which
681get registered as normal extensions after calling the hooks in C<@TERM_INIT>
682but before other extensions. Gets cleared just like C<@TERM_INIT>.
529 683
530=back 684=back
531 685
532=head2 Functions in the C<urxvt> Package 686=head2 Functions in the C<urxvt> Package
533 687
547 701
548Using this function has the advantage that its output ends up in the 702Using this function has the advantage that its output ends up in the
549correct place, e.g. on stderr of the connecting urxvtc client. 703correct place, e.g. on stderr of the connecting urxvtc client.
550 704
551Messages have a size limit of 1023 bytes currently. 705Messages have a size limit of 1023 bytes currently.
706
707=item @terms = urxvt::termlist
708
709Returns all urxvt::term objects that exist in this process, regardless of
710wether they are started, being destroyed etc., so be careful. Only term
711objects that have perl extensions attached will be returned (because there
712is no urxvt::term objet associated with others).
552 713
553=item $time = urxvt::NOW 714=item $time = urxvt::NOW
554 715
555Returns the "current time" (as per the event loop). 716Returns the "current time" (as per the event loop).
556 717
614Return the foreground/background colour index, respectively. 775Return the foreground/background colour index, respectively.
615 776
616=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 777=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
617 778
618=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 779=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
780
781=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
619 782
620Replace the foreground/background colour in the rendition mask with the 783Replace the foreground/background colour in the rendition mask with the
621specified one. 784specified one.
622 785
623=item $value = urxvt::GET_CUSTOM $rend 786=item $value = urxvt::GET_CUSTOM $rend
642 unless $msg =~ /\n$/; 805 unless $msg =~ /\n$/;
643 urxvt::warn ($msg); 806 urxvt::warn ($msg);
644 }; 807 };
645} 808}
646 809
810no warnings 'utf8';
811
647my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 812my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
648 813
649sub verbose { 814sub verbose {
650 my ($level, $msg) = @_; 815 my ($level, $msg) = @_;
651 warn "$msg\n" if $level <= $verbosity; 816 warn "$msg\n" if $level <= $verbosity;
654my %extension_pkg; 819my %extension_pkg;
655 820
656# load a single script into its own package, once only 821# load a single script into its own package, once only
657sub extension_package($) { 822sub extension_package($) {
658 my ($path) = @_; 823 my ($path) = @_;
659
660 no strict 'refs';
661 824
662 $extension_pkg{$path} ||= do { 825 $extension_pkg{$path} ||= do {
663 $path =~ /([^\/\\]+)$/; 826 $path =~ /([^\/\\]+)$/;
664 my $pkg = $1; 827 my $pkg = $1;
665 $pkg =~ s/[^[:word:]]/_/g; 828 $pkg =~ s/[^[:word:]]/_/g;
668 verbose 3, "loading extension '$path' into package '$pkg'"; 831 verbose 3, "loading extension '$path' into package '$pkg'";
669 832
670 open my $fh, "<:raw", $path 833 open my $fh, "<:raw", $path
671 or die "$path: $!"; 834 or die "$path: $!";
672 835
673 @{"$pkg\::ISA"} = urxvt::term::extension::;
674
675 my $source = 836 my $source =
676 "package $pkg; use strict; use utf8;\n" 837 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
677 . "#line 1 \"$path\"\n{\n" 838 . "#line 1 \"$path\"\n{\n"
678 . (do { local $/; <$fh> }) 839 . (do { local $/; <$fh> })
679 . "\n};\n1"; 840 . "\n};\n1";
680 841
681 eval $source 842 eval $source
695 if ($htype == 0) { # INIT 856 if ($htype == 0) { # INIT
696 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 857 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
697 858
698 my %ext_arg; 859 my %ext_arg;
699 860
861 {
862 my @init = @TERM_INIT;
863 @TERM_INIT = ();
864 $_->($TERM) for @init;
865 my @pkg = @TERM_EXT;
866 @TERM_EXT = ();
867 $TERM->register_package ($_) for @pkg;
868 }
869
700 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 870 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
701 if ($_ eq "default") { 871 if ($_ eq "default") {
702 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 872 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
703 } elsif (/^-(.*)$/) { 873 } elsif (/^-(.*)$/) {
704 delete $ext_arg{$1}; 874 delete $ext_arg{$1};
705 } elsif (/^([^<]+)<(.*)>$/) { 875 } elsif (/^([^<]+)<(.*)>$/) {
706 push @{ $ext_arg{$1} }, $2; 876 push @{ $ext_arg{$1} }, $2;
707 } else { 877 } else {
708 $ext_arg{$_} ||= []; 878 $ext_arg{$_} ||= [];
709 } 879 }
710 } 880 }
711 881
712 while (my ($ext, $argv) = each %ext_arg) { 882 for my $ext (sort keys %ext_arg) {
713 my @files = grep -f $_, map "$_/$ext", @dirs; 883 my @files = grep -f $_, map "$_/$ext", @dirs;
714 884
715 if (@files) { 885 if (@files) {
716 $TERM->register_package (extension_package $files[0], $argv); 886 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
717 } else { 887 } else {
718 warn "perl extension '$ext' not found in perl library search path\n"; 888 warn "perl extension '$ext' not found in perl library search path\n";
719 } 889 }
720 } 890 }
721 891
730 if $verbosity >= 10; 900 if $verbosity >= 10;
731 901
732 keys %$cb; 902 keys %$cb;
733 903
734 while (my ($pkg, $cb) = each %$cb) { 904 while (my ($pkg, $cb) = each %$cb) {
735 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 905 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
736 and last; 906 $retval ||= $retval_;
737 907
738 if ($@) { 908 if ($@) {
739 $TERM->ungrab; # better to lose the grab than the session 909 $TERM->ungrab; # better to lose the grab than the session
740 warn $@; 910 warn $@;
741 } 911 }
752 # clear package 922 # clear package
753 %$TERM = (); 923 %$TERM = ();
754 } 924 }
755 925
756 $retval 926 $retval
927}
928
929sub SET_COLOR($$$) {
930 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
757} 931}
758 932
759# urxvt::term::extension 933# urxvt::term::extension
760 934
761package urxvt::term::extension; 935package urxvt::term::extension;
900# find on_xxx subs in the package and register them 1074# find on_xxx subs in the package and register them
901# as hooks 1075# as hooks
902sub register_package { 1076sub register_package {
903 my ($self, $pkg, $argv) = @_; 1077 my ($self, $pkg, $argv) = @_;
904 1078
1079 no strict 'refs';
1080
1081 urxvt::verbose 6, "register package $pkg to $self";
1082
1083 @{"$pkg\::ISA"} = urxvt::term::extension::;
1084
905 my $proxy = bless { 1085 my $proxy = bless {
906 _pkg => $pkg, 1086 _pkg => $pkg,
907 argv => $argv, 1087 argv => $argv,
908 }, $pkg; 1088 }, $pkg;
909 Scalar::Util::weaken ($proxy->{term} = $self); 1089 Scalar::Util::weaken ($proxy->{term} = $self);
924hash which defines the environment of the new terminal. 1104hash which defines the environment of the new terminal.
925 1105
926Croaks (and probably outputs an error message) if the new instance 1106Croaks (and probably outputs an error message) if the new instance
927couldn't be created. Returns C<undef> if the new instance didn't 1107couldn't be created. Returns C<undef> if the new instance didn't
928initialise perl, and the terminal object otherwise. The C<init> and 1108initialise perl, and the terminal object otherwise. The C<init> and
929C<start> hooks will be called during this call. 1109C<start> hooks will be called before this call returns, and are free to
1110refer to global data (which is race free).
930 1111
931=cut 1112=cut
932 1113
933sub new { 1114sub new {
934 my ($class, $env, @args) = @_; 1115 my ($class, $env, @args) = @_;
935 1116
1117 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1118 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1119
936 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1120 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
937} 1121}
938 1122
939=item $term->destroy 1123=item $term->destroy
940 1124
941Destroy the terminal object (close the window, free resources 1125Destroy the terminal object (close the window, free resources
1198 1382
1199Normally its not a good idea to use this function, as programs might be 1383Normally its not a good idea to use this function, as programs might be
1200confused by changes in cursor position or scrolling. Its useful inside a 1384confused by changes in cursor position or scrolling. Its useful inside a
1201C<on_add_lines> hook, though. 1385C<on_add_lines> hook, though.
1202 1386
1387=item $term->scr_change_screen ($screen)
1388
1389Switch to given screen - 0 primary, 1 secondary.
1390
1203=item $term->cmd_parse ($octets) 1391=item $term->cmd_parse ($octets)
1204 1392
1205Similar to C<scr_add_lines>, but the argument must be in the 1393Similar to C<scr_add_lines>, but the argument must be in the
1206locale-specific encoding of the terminal and can contain command sequences 1394locale-specific encoding of the terminal and can contain command sequences
1207(escape codes) that will be interpreted. 1395(escape codes) that will be interpreted.
1217Replaces the event mask of the pty watcher by the given event mask. Can 1405Replaces the event mask of the pty watcher by the given event mask. Can
1218be used to suppress input and output handling to the pty/tty. See the 1406be used to suppress input and output handling to the pty/tty. See the
1219description of C<< urxvt::timer->events >>. Make sure to always restore 1407description of C<< urxvt::timer->events >>. Make sure to always restore
1220the previous value. 1408the previous value.
1221 1409
1410=item $fd = $term->pty_fd
1411
1412Returns the master file descriptor for the pty in use, or C<-1> if no pty
1413is used.
1414
1222=item $windowid = $term->parent 1415=item $windowid = $term->parent
1223 1416
1224Return the window id of the toplevel window. 1417Return the window id of the toplevel window.
1225 1418
1226=item $windowid = $term->vt 1419=item $windowid = $term->vt
1232Adds the specified events to the vt event mask. Useful e.g. when you want 1425Adds the specified events to the vt event mask. Useful e.g. when you want
1233to receive pointer events all the times: 1426to receive pointer events all the times:
1234 1427
1235 $term->vt_emask_add (urxvt::PointerMotionMask); 1428 $term->vt_emask_add (urxvt::PointerMotionMask);
1236 1429
1430=item $term->focus_in
1431
1432=item $term->focus_out
1433
1434=item $term->key_press ($state, $keycode[, $time])
1435
1436=item $term->key_release ($state, $keycode[, $time])
1437
1438Deliver various fake events to to terminal.
1439
1237=item $window_width = $term->width 1440=item $window_width = $term->width
1238 1441
1239=item $window_height = $term->height 1442=item $window_height = $term->height
1240 1443
1241=item $font_width = $term->fwidth 1444=item $font_width = $term->fwidth
1271=item $env = $term->env 1474=item $env = $term->env
1272 1475
1273Returns a copy of the environment in effect for the terminal as a hashref 1476Returns a copy of the environment in effect for the terminal as a hashref
1274similar to C<\%ENV>. 1477similar to C<\%ENV>.
1275 1478
1479=item @envv = $term->envv
1480
1481Returns the environment as array of strings of the form C<VAR=VALUE>.
1482
1483=item @argv = $term->argv
1484
1485Return the argument vector as this terminal, similar to @ARGV, but
1486includes the program name as first element.
1487
1276=cut 1488=cut
1277 1489
1278sub env { 1490sub env {
1279 if (my $env = $_[0]->_env) {
1280 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1491 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1281 } else {
1282 +{ %ENV }
1283 }
1284} 1492}
1285 1493
1286=item $modifiermask = $term->ModLevel3Mask 1494=item $modifiermask = $term->ModLevel3Mask
1287 1495
1288=item $modifiermask = $term->ModMetaMask 1496=item $modifiermask = $term->ModMetaMask
1289 1497
1290=item $modifiermask = $term->ModNumLockMask 1498=item $modifiermask = $term->ModNumLockMask
1291 1499
1292Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1500Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1293AltGr), the meta key (often Alt) and the num lock key, if applicable. 1501AltGr), the meta key (often Alt) and the num lock key, if applicable.
1502
1503=item $screen = $term->current_screen
1504
1505Returns the currently displayed screen (0 primary, 1 secondary).
1506
1507=item $cursor_is_hidden = $term->hidden_cursor
1508
1509Returns wether the cursor is currently hidden or not.
1294 1510
1295=item $view_start = $term->view_start ([$newvalue]) 1511=item $view_start = $term->view_start ([$newvalue])
1296 1512
1297Returns the row number of the topmost displayed line. Maximum value is 1513Returns the row number of the topmost displayed line. Maximum value is
1298C<0>, which displays the normal terminal contents. Lower values scroll 1514C<0>, which displays the normal terminal contents. Lower values scroll
1318line, starting at column C<$start_col> (default C<0>), which is useful 1534line, starting at column C<$start_col> (default C<0>), which is useful
1319to replace only parts of a line. The font index in the rendition will 1535to replace only parts of a line. The font index in the rendition will
1320automatically be updated. 1536automatically be updated.
1321 1537
1322C<$text> is in a special encoding: tabs and wide characters that use more 1538C<$text> is in a special encoding: tabs and wide characters that use more
1323than one cell when displayed are padded with urxvt::NOCHAR characters 1539than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1324(C<chr 65535>). Characters with combining characters and other characters 1540characters. Characters with combining characters and other characters that
1325that do not fit into the normal tetx encoding will be replaced with 1541do not fit into the normal tetx encoding will be replaced with characters
1326characters in the private use area. 1542in the private use area.
1327 1543
1328You have to obey this encoding when changing text. The advantage is 1544You have to obey this encoding when changing text. The advantage is
1329that C<substr> and similar functions work on screen cells and not on 1545that C<substr> and similar functions work on screen cells and not on
1330characters. 1546characters.
1331 1547
1478=item $string = $term->special_decode $text 1694=item $string = $term->special_decode $text
1479 1695
1480Converts rxvt-unicodes text reprsentation into a perl string. See 1696Converts rxvt-unicodes text reprsentation into a perl string. See
1481C<< $term->ROW_t >> for details. 1697C<< $term->ROW_t >> for details.
1482 1698
1483=item $success = $term->grab_button ($button, $modifiermask) 1699=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1484 1700
1701=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1702
1485Registers a synchronous button grab. See the XGrabButton manpage. 1703Register/unregister a synchronous button grab. See the XGrabButton
1704manpage.
1486 1705
1487=item $success = $term->grab ($eventtime[, $sync]) 1706=item $success = $term->grab ($eventtime[, $sync])
1488 1707
1489Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1708Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1490synchronous (C<$sync> is true). Also remembers the grab timestampe. 1709synchronous (C<$sync> is true). Also remembers the grab timestampe.
1505=item $term->ungrab 1724=item $term->ungrab
1506 1725
1507Calls XUngrab for the most recent grab. Is called automatically on 1726Calls XUngrab for the most recent grab. Is called automatically on
1508evaluation errors, as it is better to lose the grab in the error case as 1727evaluation errors, as it is better to lose the grab in the error case as
1509the session. 1728the session.
1729
1730=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1731
1732=item $atom_name = $term->XGetAtomName ($atom)
1733
1734=item @atoms = $term->XListProperties ($window)
1735
1736=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1737
1738=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1739
1740=item $term->XDeleteProperty ($window, $property)
1741
1742=item $window = $term->DefaultRootWindow
1743
1744=item $term->XReparentWindow ($window, $parent, [$x, $y])
1745
1746=item $term->XMapWindow ($window)
1747
1748=item $term->XUnmapWindow ($window)
1749
1750=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1751
1752=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1753
1754=item $term->XChangeInput ($window, $add_events[, $del_events])
1755
1756Various X or X-related functions. The C<$term> object only serves as
1757the source of the display, otherwise those functions map more-or-less
1758directory onto the X functions of the same name.
1510 1759
1511=back 1760=back
1512 1761
1513=cut 1762=cut
1514 1763
1578 my ($self, $text, $cb) = @_; 1827 my ($self, $text, $cb) = @_;
1579 1828
1580 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1829 $self->add_item ({ type => "button", text => $text, activate => $cb});
1581} 1830}
1582 1831
1583=item $popup->add_toggle ($text, $cb, $initial_value) 1832=item $popup->add_toggle ($text, $initial_value, $cb)
1584 1833
1585Adds a toggle/checkbox item to the popup. Teh callback gets called 1834Adds a toggle/checkbox item to the popup. The callback gets called
1586whenever it gets toggled, with a boolean indicating its value as its first 1835whenever it gets toggled, with a boolean indicating its new value as its
1587argument. 1836first argument.
1588 1837
1589=cut 1838=cut
1590 1839
1591sub add_toggle { 1840sub add_toggle {
1592 my ($self, $text, $cb, $value) = @_; 1841 my ($self, $text, $value, $cb) = @_;
1593 1842
1594 my $item; $item = { 1843 my $item; $item = {
1595 type => "button", 1844 type => "button",
1596 text => " $text", 1845 text => " $text",
1597 value => $value, 1846 value => $value,
1634 delete $self->{term}{_destroy}{$self}; 1883 delete $self->{term}{_destroy}{$self};
1635 $self->{term}->ungrab; 1884 $self->{term}->ungrab;
1636} 1885}
1637 1886
1638=back 1887=back
1888
1889=cut
1890
1891package urxvt::watcher;
1892
1893@urxvt::timer::ISA = __PACKAGE__;
1894@urxvt::iow::ISA = __PACKAGE__;
1895@urxvt::pw::ISA = __PACKAGE__;
1896@urxvt::iw::ISA = __PACKAGE__;
1639 1897
1640=head2 The C<urxvt::timer> Class 1898=head2 The C<urxvt::timer> Class
1641 1899
1642This class implements timer watchers/events. Time is represented as a 1900This class implements timer watchers/events. Time is represented as a
1643fractional number of seconds since the epoch. Example: 1901fractional number of seconds since the epoch. Example:
1741 1999
1742Stop watching for events on the given filehandle. 2000Stop watching for events on the given filehandle.
1743 2001
1744=back 2002=back
1745 2003
2004=head2 The C<urxvt::iw> Class
2005
2006This class implements idle watchers, that get called automatically when
2007the process is idle. They should return as fast as possible, after doing
2008some useful work.
2009
2010=over 4
2011
2012=item $iw = new urxvt::iw
2013
2014Create a new idle watcher object in stopped state.
2015
2016=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2017
2018Set the callback to be called when the watcher triggers.
2019
2020=item $timer = $timer->start
2021
2022Start the watcher.
2023
2024=item $timer = $timer->stop
2025
2026Stop the watcher.
2027
2028=back
2029
2030=head2 The C<urxvt::pw> Class
2031
2032This class implements process watchers. They create an event whenever a
2033process exits, after which they stop automatically.
2034
2035 my $pid = fork;
2036 ...
2037 $term->{pw} = urxvt::pw
2038 ->new
2039 ->start ($pid)
2040 ->cb (sub {
2041 my ($pw, $exit_status) = @_;
2042 ...
2043 });
2044
2045=over 4
2046
2047=item $pw = new urxvt::pw
2048
2049Create a new process watcher in stopped state.
2050
2051=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2052
2053Set the callback to be called when the timer triggers.
2054
2055=item $pw = $timer->start ($pid)
2056
2057Tells the wqtcher to start watching for process C<$pid>.
2058
2059=item $pw = $pw->stop
2060
2061Stop the watcher.
2062
2063=back
2064
1746=head1 ENVIRONMENT 2065=head1 ENVIRONMENT
1747 2066
1748=head2 URXVT_PERL_VERBOSITY 2067=head2 URXVT_PERL_VERBOSITY
1749 2068
1750This variable controls the verbosity level of the perl extension. Higher 2069This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines