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.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.140 by root, Mon Jul 3 19:10:09 2006 UTC

94=item option-popup (enabled by default) 94=item option-popup (enabled by default)
95 95
96Binds 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
97runtime. 97runtime.
98 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
99=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
100 117
101Binds 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
102text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
103evaluation, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
104 121
105Other extensions can extend this popup menu by pushing a code reference 122Other extensions can extend this popup menu by pushing a code reference
106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107popup is displayed. 124popup is being displayed.
108 125
109It'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
110is 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.
111It 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
112string 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
136additionally stores the first match in the current line into the primary 153additionally stores the first match in the current line into the primary
137selection. 154selection.
138 155
139=item readline (enabled by default) 156=item readline (enabled by default)
140 157
141A support package that tries to make editing with readline easier. At the 158A support package that tries to make editing with readline easier. At
142moment, it reacts to clicking with the left mouse button by trying to 159the moment, it reacts to clicking shift-left mouse button by trying to
143move the text cursor to this position. It does so by generating as many 160move the text cursor to this position. It does so by generating as many
144cursor-left or cursor-right keypresses as required (the this only works 161cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters). 162for programs that correctly support wide characters).
146 163
147To avoid too many false positives, this is only done when: 164To avoid too many false positives, this is only done when:
238 255
239 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 256 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240 257
241=item automove-background 258=item automove-background
242 259
243This is basically a one-line extension that dynamically changes the background pixmap offset 260This is basically a very small extension that dynamically changes the
244to the window position, in effect creating the same effect as pseudo transparency with 261background pixmap offset to the window position, in effect creating the
245a custom pixmap. No scaling is supported in this mode. Exmaple: 262same effect as pseudo transparency with a custom pixmap. No scaling is
263supported in this mode. Exmaple:
246 264
247 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 265 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
248 266
249=item block-graphics-to-ascii 267=item block-graphics-to-ascii
250 268
351 369
352=back 370=back
353 371
354=head2 Extension Objects 372=head2 Extension Objects
355 373
356Very perl extension is a perl class. A separate perl object is created 374Every perl extension is a perl class. A separate perl object is created
357for each terminal and each extension and passed as the first parameter to 375for each terminal and each extension and passed as the first parameter to
358hooks. So extensions can use their C<$self> object without having to think 376hooks. So extensions can use their C<$self> object without having to think
359about other extensions, with the exception of methods and members that 377about other extensions, with the exception of methods and members that
360begin with an underscore character C<_>: these are reserved for internal 378begin with an underscore character C<_>: these are reserved for internal
361use. 379use.
476 494
477It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 495It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
478$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 496$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
479number of lines that will be in the scrollback buffer. 497number of lines that will be in the scrollback buffer.
480 498
499=item on_osc_seq $term, $op, $args
500
501Called on every OSC sequence and can be used to suppress it or modify its
502behaviour. The default should be to return an empty list. A true value
503suppresses execution of the request completely. Make sure you don't get
504confused by recursive invocations when you output an osc sequence within
505this callback.
506
507C<on_osc_seq_perl> should be used for new behaviour.
508
481=item on_osc_seq $term, $string 509=item on_osc_seq_perl $term, $string
482 510
483Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 511Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484operating system command) is processed. Cursor position and other state 512operating system command) is processed. Cursor position and other state
485information is up-to-date when this happens. For interoperability, the 513information is up-to-date when this happens. For interoperability, the
486string should start with the extension name and a colon, to distinguish 514string should start with the extension name and a colon, to distinguish
535a C<perl:string> action bound to a key, see description of the B<keysym> 563a C<perl:string> action bound to a key, see description of the B<keysym>
536resource in the @@RXVT_NAME@@(1) manpage). 564resource in the @@RXVT_NAME@@(1) manpage).
537 565
538The event is simply the action string. This interface is assumed to change 566The event is simply the action string. This interface is assumed to change
539slightly in the future. 567slightly in the future.
568
569=item on_resize_all_windows $tern, $new_width, $new_height
570
571Called just after the new window size has been calculcated, but before
572windows are actually being resized or hints are being set. If this hook
573returns TRUE, setting of the window hints is being skipped.
540 574
541=item on_x_event $term, $event 575=item on_x_event $term, $event
542 576
543Called on every X event received on the vt window (and possibly other 577Called on every X event received on the vt window (and possibly other
544windows). Should only be used as a last resort. Most event structure 578windows). Should only be used as a last resort. Most event structure
854 } else { 888 } else {
855 $ext_arg{$_} ||= []; 889 $ext_arg{$_} ||= [];
856 } 890 }
857 } 891 }
858 892
859 while (my ($ext, $argv) = each %ext_arg) { 893 for my $ext (sort keys %ext_arg) {
860 my @files = grep -f $_, map "$_/$ext", @dirs; 894 my @files = grep -f $_, map "$_/$ext", @dirs;
861 895
862 if (@files) { 896 if (@files) {
863 $TERM->register_package (extension_package $files[0], $argv); 897 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864 } else { 898 } else {
865 warn "perl extension '$ext' not found in perl library search path\n"; 899 warn "perl extension '$ext' not found in perl library search path\n";
866 } 900 }
867 } 901 }
868 902
874 908
875 if (my $cb = $TERM->{_hook}[$htype]) { 909 if (my $cb = $TERM->{_hook}[$htype]) {
876 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 910 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877 if $verbosity >= 10; 911 if $verbosity >= 10;
878 912
879 keys %$cb; 913 for my $pkg (keys %$cb) {
880
881 while (my ($pkg, $cb) = each %$cb) {
882 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 914 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
883 $retval ||= $retval_; 915 $retval ||= $retval_;
884 916
885 if ($@) { 917 if ($@) {
886 $TERM->ungrab; # better to lose the grab than the session 918 $TERM->ungrab; # better to lose the grab than the session
887 warn $@; 919 warn $@;
1451=item $env = $term->env 1483=item $env = $term->env
1452 1484
1453Returns a copy of the environment in effect for the terminal as a hashref 1485Returns a copy of the environment in effect for the terminal as a hashref
1454similar to C<\%ENV>. 1486similar to C<\%ENV>.
1455 1487
1488=item @envv = $term->envv
1489
1490Returns the environment as array of strings of the form C<VAR=VALUE>.
1491
1492=item @argv = $term->argv
1493
1494Return the argument vector as this terminal, similar to @ARGV, but
1495includes the program name as first element.
1496
1456=cut 1497=cut
1457 1498
1458sub env { 1499sub env {
1459 if (my $env = $_[0]->_env) {
1460 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1500 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461 } else {
1462 +{ %ENV }
1463 }
1464} 1501}
1465 1502
1466=item $modifiermask = $term->ModLevel3Mask 1503=item $modifiermask = $term->ModLevel3Mask
1467 1504
1468=item $modifiermask = $term->ModMetaMask 1505=item $modifiermask = $term->ModMetaMask
1799 my ($self, $text, $cb) = @_; 1836 my ($self, $text, $cb) = @_;
1800 1837
1801 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1838 $self->add_item ({ type => "button", text => $text, activate => $cb});
1802} 1839}
1803 1840
1804=item $popup->add_toggle ($text, $cb, $initial_value) 1841=item $popup->add_toggle ($text, $initial_value, $cb)
1805 1842
1806Adds a toggle/checkbox item to the popup. Teh callback gets called 1843Adds a toggle/checkbox item to the popup. The callback gets called
1807whenever it gets toggled, with a boolean indicating its value as its first 1844whenever it gets toggled, with a boolean indicating its new value as its
1808argument. 1845first argument.
1809 1846
1810=cut 1847=cut
1811 1848
1812sub add_toggle { 1849sub add_toggle {
1813 my ($self, $text, $cb, $value) = @_; 1850 my ($self, $text, $value, $cb) = @_;
1814 1851
1815 my $item; $item = { 1852 my $item; $item = {
1816 type => "button", 1853 type => "button",
1817 text => " $text", 1854 text => " $text",
1818 value => $value, 1855 value => $value,

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines