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.142 by root, Thu Jul 6 18:56:10 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
134bottom. 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
135was 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
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
156The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix.
159
160See L<perlre> for more info about perl regular expression syntax.
161
139=item readline (enabled by default) 162=item readline (enabled by default)
140 163
141A support package that tries to make editing with readline easier. At the 164A support package that tries to make editing with readline easier. At
142moment, it reacts to clicking with the left mouse button by trying to 165the 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 166move 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 167cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters). 168for programs that correctly support wide characters).
146 169
147To avoid too many false positives, this is only done when: 170To avoid too many false positives, this is only done when:
238 261
239 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 262 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240 263
241=item automove-background 264=item automove-background
242 265
243This is basically a one-line extension that dynamically changes the background pixmap offset 266This is basically a very small extension that dynamically changes the
244to the window position, in effect creating the same effect as pseudo transparency with 267background pixmap offset to the window position, in effect creating the
245a custom pixmap. No scaling is supported in this mode. Exmaple: 268same effect as pseudo transparency with a custom pixmap. No scaling is
269supported in this mode. Exmaple:
246 270
247 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 271 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
248 272
249=item block-graphics-to-ascii 273=item block-graphics-to-ascii
250 274
251A not very useful example of filtering all text output to the terminal, 275A not very useful example of filtering all text output to the terminal
252by replacing all line-drawing characters (U+2500 .. U+259F) by a 276by replacing all line-drawing characters (U+2500 .. U+259F) by a
253similar-looking ascii character. 277similar-looking ascii character.
254 278
255=item digital-clock 279=item digital-clock
256 280
351 375
352=back 376=back
353 377
354=head2 Extension Objects 378=head2 Extension Objects
355 379
356Very perl extension is a perl class. A separate perl object is created 380Every 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 381for 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 382hooks. So extensions can use their C<$self> object without having to think
359about other extensions, with the exception of methods and members that 383about other extensions, with the exception of methods and members that
360begin with an underscore character C<_>: these are reserved for internal 384begin with an underscore character C<_>: these are reserved for internal
361use. 385use.
476 500
477It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 501It 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 502$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
479number of lines that will be in the scrollback buffer. 503number of lines that will be in the scrollback buffer.
480 504
505=item on_osc_seq $term, $op, $args
506
507Called on every OSC sequence and can be used to suppress it or modify its
508behaviour. The default should be to return an empty list. A true value
509suppresses execution of the request completely. Make sure you don't get
510confused by recursive invocations when you output an osc sequence within
511this callback.
512
513C<on_osc_seq_perl> should be used for new behaviour.
514
481=item on_osc_seq $term, $string 515=item on_osc_seq_perl $term, $string
482 516
483Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 517Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484operating system command) is processed. Cursor position and other state 518operating system command) is processed. Cursor position and other state
485information is up-to-date when this happens. For interoperability, the 519information is up-to-date when this happens. For interoperability, the
486string should start with the extension name and a colon, to distinguish 520string 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> 569a C<perl:string> action bound to a key, see description of the B<keysym>
536resource in the @@RXVT_NAME@@(1) manpage). 570resource in the @@RXVT_NAME@@(1) manpage).
537 571
538The event is simply the action string. This interface is assumed to change 572The event is simply the action string. This interface is assumed to change
539slightly in the future. 573slightly in the future.
574
575=item on_resize_all_windows $tern, $new_width, $new_height
576
577Called just after the new window size has been calculcated, but before
578windows are actually being resized or hints are being set. If this hook
579returns TRUE, setting of the window hints is being skipped.
540 580
541=item on_x_event $term, $event 581=item on_x_event $term, $event
542 582
543Called on every X event received on the vt window (and possibly other 583Called on every X event received on the vt window (and possibly other
544windows). Should only be used as a last resort. Most event structure 584windows). Should only be used as a last resort. Most event structure
854 } else { 894 } else {
855 $ext_arg{$_} ||= []; 895 $ext_arg{$_} ||= [];
856 } 896 }
857 } 897 }
858 898
859 while (my ($ext, $argv) = each %ext_arg) { 899 for my $ext (sort keys %ext_arg) {
860 my @files = grep -f $_, map "$_/$ext", @dirs; 900 my @files = grep -f $_, map "$_/$ext", @dirs;
861 901
862 if (@files) { 902 if (@files) {
863 $TERM->register_package (extension_package $files[0], $argv); 903 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864 } else { 904 } else {
865 warn "perl extension '$ext' not found in perl library search path\n"; 905 warn "perl extension '$ext' not found in perl library search path\n";
866 } 906 }
867 } 907 }
868 908
874 914
875 if (my $cb = $TERM->{_hook}[$htype]) { 915 if (my $cb = $TERM->{_hook}[$htype]) {
876 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 916 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877 if $verbosity >= 10; 917 if $verbosity >= 10;
878 918
879 keys %$cb; 919 for my $pkg (keys %$cb) {
880
881 while (my ($pkg, $cb) = each %$cb) {
882 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 920 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
883 $retval ||= $retval_; 921 $retval ||= $retval_;
884 922
885 if ($@) { 923 if ($@) {
886 $TERM->ungrab; # better to lose the grab than the session 924 $TERM->ungrab; # better to lose the grab than the session
887 warn $@; 925 warn $@;
1451=item $env = $term->env 1489=item $env = $term->env
1452 1490
1453Returns a copy of the environment in effect for the terminal as a hashref 1491Returns a copy of the environment in effect for the terminal as a hashref
1454similar to C<\%ENV>. 1492similar to C<\%ENV>.
1455 1493
1494=item @envv = $term->envv
1495
1496Returns the environment as array of strings of the form C<VAR=VALUE>.
1497
1498=item @argv = $term->argv
1499
1500Return the argument vector as this terminal, similar to @ARGV, but
1501includes the program name as first element.
1502
1456=cut 1503=cut
1457 1504
1458sub env { 1505sub env {
1459 if (my $env = $_[0]->_env) {
1460 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1506 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461 } else {
1462 +{ %ENV }
1463 }
1464} 1507}
1465 1508
1466=item $modifiermask = $term->ModLevel3Mask 1509=item $modifiermask = $term->ModLevel3Mask
1467 1510
1468=item $modifiermask = $term->ModMetaMask 1511=item $modifiermask = $term->ModMetaMask
1799 my ($self, $text, $cb) = @_; 1842 my ($self, $text, $cb) = @_;
1800 1843
1801 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1844 $self->add_item ({ type => "button", text => $text, activate => $cb});
1802} 1845}
1803 1846
1804=item $popup->add_toggle ($text, $cb, $initial_value) 1847=item $popup->add_toggle ($text, $initial_value, $cb)
1805 1848
1806Adds a toggle/checkbox item to the popup. Teh callback gets called 1849Adds a toggle/checkbox item to the popup. The callback gets called
1807whenever it gets toggled, with a boolean indicating its value as its first 1850whenever it gets toggled, with a boolean indicating its new value as its
1808argument. 1851first argument.
1809 1852
1810=cut 1853=cut
1811 1854
1812sub add_toggle { 1855sub add_toggle {
1813 my ($self, $text, $cb, $value) = @_; 1856 my ($self, $text, $value, $cb) = @_;
1814 1857
1815 my $item; $item = { 1858 my $item; $item = {
1816 type => "button", 1859 type => "button",
1817 text => " $text", 1860 text => " $text",
1818 value => $value, 1861 value => $value,

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines