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.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.166 by root, Thu Jun 5 08:40:39 2008 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its 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 107either 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 108reference. 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 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide whether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 157selection if the C<Shift> modifier is active.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
166move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
256The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
260 263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
261Example configuration: 267Example configuration:
262 268
263 URxvt.perl-ext: default,matcher 269 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser 270 URxvt.urlLauncher: sensible-browser
265 URxvt.keysym.C-Delete: perl:matcher 271 URxvt.keysym.C-Delete: perl:matcher
270 276
271=item xim-onthespot 277=item xim-onthespot
272 278
273This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
274not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
275OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
276kinput2. 282kinput2.
277 283
278You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
279C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
280 286
288will show or hide itself. Another press of the accelerator key will hide 294will show or hide itself. Another press of the accelerator key will hide
289or show it again. 295or show it again.
290 296
291Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
292 298
293This is useful if you need a single terminal thats not using any desktop 299This is useful if you need a single terminal that is not using any desktop
294space most of the time but is quickly available at the press of a key. 300space most of the time but is quickly available at the press of a key.
295 301
296The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
297extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
298 304
299If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
300(fvwm can do it). 306(fvwm can do it).
301
302=item automove-background
303
304This is basically a very small extension that dynamically changes the
305background pixmap offset to the window position, in effect creating the
306same effect as pseudo transparency with a custom pixmap. No scaling is
307supported in this mode. Example:
308
309 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310
311L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
312shows how this extension can be used to implement an automatically blurred
313transparent background.
314 307
315=item block-graphics-to-ascii 308=item block-graphics-to-ascii
316 309
317A not very useful example of filtering all text output to the terminal 310A not very useful example of filtering all text output to the terminal
318by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
323Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
324 317
325=item remote-clipboard 318=item remote-clipboard
326 319
327Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
328selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
329selection somewhere and fetch it again. 322selection somewhere and fetch it again.
330 323
331We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
332means that one command uploads the file to a remote server, and another 325means that one command uploads the file to a remote server, and another
333reads it. 326reads it.
922 local $TERM = shift; 915 local $TERM = shift;
923 my $htype = shift; 916 my $htype = shift;
924 917
925 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
926 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
927 920
928 my %ext_arg; 921 my %ext_arg;
929 922
930 { 923 {
931 my @init = @TERM_INIT; 924 my @init = @TERM_INIT;
932 @TERM_INIT = (); 925 @TERM_INIT = ();
1098is that you cannot use blocking APIs, but the non-blocking variant should 1091is that you cannot use blocking APIs, but the non-blocking variant should
1099work. 1092work.
1100 1093
1101=cut 1094=cut
1102 1095
1103our $VERSION = 1; 1096our $VERSION = '3.4';
1104 1097
1105$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1106push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1107 1100
1108sub timer { 1101sub timer {
1139 1132
1140sub DESTROY { 1133sub DESTROY {
1141 $_[0][1]->stop; 1134 $_[0][1]->stop;
1142} 1135}
1143 1136
1144sub condvar {
1145 bless \my $flag, urxvt::anyevent::
1146}
1147
1148sub broadcast {
1149 ${$_[0]}++;
1150}
1151
1152sub wait {
1153 unless (${$_[0]}) {
1154 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1155 }
1156}
1157
1158sub one_event { 1137sub one_event {
1159 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1138 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1160} 1139}
1161 1140
1162package urxvt::term; 1141package urxvt::term;
1292 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1293 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1294 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297 secondaryScreen secondaryScroll selectstyle shade term_name title 1276 secondaryScreen secondaryScroll shade term_name title
1298 transient_for transparent transparent_all tripleclickwords utmpInhibit 1277 transient_for transparent transparent_all tripleclickwords utmpInhibit
1299 visualBell 1278 visualBell
1300 1279
1301=cut 1280=cut
1302 1281
1618 1597
1619Used after changing terminal contents to display them. 1598Used after changing terminal contents to display them.
1620 1599
1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1600=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622 1601
1623Returns the text of the entire row with number C<$row_number>. Row C<0> 1602Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1624is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1603is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1625terminal line. The scrollback buffer starts at line C<-1> and extends to
1626line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1604terminal line. Nothing will be returned if a nonexistent line
1627is requested. 1605is requested.
1628 1606
1629If C<$new_text> is specified, it will replace characters in the current 1607If C<$new_text> is specified, it will replace characters in the current
1630line, starting at column C<$start_col> (default C<0>), which is useful 1608line, starting at column C<$start_col> (default C<0>), which is useful
1631to replace only parts of a line. The font index in the rendition will 1609to replace only parts of a line. The font index in the rendition will
1632automatically be updated. 1610automatically be updated.
1633 1611
1634C<$text> is in a special encoding: tabs and wide characters that use more 1612C<$text> is in a special encoding: tabs and wide characters that use more
1635than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1613than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1636characters. Characters with combining characters and other characters that 1614characters. Characters with combining characters and other characters that
1637do not fit into the normal tetx encoding will be replaced with characters 1615do not fit into the normal text encoding will be replaced with characters
1638in the private use area. 1616in the private use area.
1639 1617
1640You have to obey this encoding when changing text. The advantage is 1618You have to obey this encoding when changing text. The advantage is
1641that C<substr> and similar functions work on screen cells and not on 1619that C<substr> and similar functions work on screen cells and not on
1642characters. 1620characters.
1961 my $env = $self->{term}->env; 1939 my $env = $self->{term}->env;
1962 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1940 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1963 delete $env->{LC_ALL}; 1941 delete $env->{LC_ALL};
1964 $env->{LC_CTYPE} = $self->{term}->locale; 1942 $env->{LC_CTYPE} = $self->{term}->locale;
1965 1943
1966 urxvt::term->new ($env, "popup", 1944 my $term = urxvt::term->new (
1945 $env, "popup",
1967 "--perl-lib" => "", "--perl-ext-common" => "", 1946 "--perl-lib" => "", "--perl-ext-common" => "",
1968 "-pty-fd" => -1, "-sl" => 0, 1947 "-pty-fd" => -1, "-sl" => 0,
1969 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1948 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1970 "--transient-for" => $self->{term}->parent, 1949 "--transient-for" => $self->{term}->parent,
1971 "-display" => $self->{term}->display_id, 1950 "-display" => $self->{term}->display_id,
1972 "-pe" => "urxvt-popup") 1951 "-pe" => "urxvt-popup",
1973 or die "unable to create popup window\n"; 1952 ) or die "unable to create popup window\n";
1953
1954 unless (delete $term->{urxvt_popup_init_done}) {
1955 $term->ungrab;
1956 $term->destroy;
1957 die "unable to initialise popup window\n";
1958 }
1974} 1959}
1975 1960
1976sub DESTROY { 1961sub DESTROY {
1977 my ($self) = @_; 1962 my ($self) = @_;
1978 1963
1996 ->new 1981 ->new
1997 ->interval (1) 1982 ->interval (1)
1998 ->cb (sub { 1983 ->cb (sub {
1999 $term->{overlay}->set (0, 0, 1984 $term->{overlay}->set (0, 0,
2000 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1985 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2001 }); 1986 });
2002 1987
2003=over 4 1988=over 4
2004 1989
2005=item $timer = new urxvt::timer 1990=item $timer = new urxvt::timer
2006 1991
2049 2034
2050 $term->{socket} = ... 2035 $term->{socket} = ...
2051 $term->{iow} = urxvt::iow 2036 $term->{iow} = urxvt::iow
2052 ->new 2037 ->new
2053 ->fd (fileno $term->{socket}) 2038 ->fd (fileno $term->{socket})
2054 ->events (urxvt::EVENT_READ) 2039 ->events (urxvt::EV_READ)
2055 ->start 2040 ->start
2056 ->cb (sub { 2041 ->cb (sub {
2057 my ($iow, $revents) = @_; 2042 my ($iow, $revents) = @_;
2058 # $revents must be 1 here, no need to check 2043 # $revents must be 1 here, no need to check
2059 sysread $term->{socket}, my $buf, 8192 2044 sysread $term->{socket}, my $buf, 8192
2077Set the file descriptor (not handle) to watch. 2062Set the file descriptor (not handle) to watch.
2078 2063
2079=item $iow = $iow->events ($eventmask) 2064=item $iow = $iow->events ($eventmask)
2080 2065
2081Set the event mask to watch. The only allowed values are 2066Set the event mask to watch. The only allowed values are
2082C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2067C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2083together, or C<urxvt::EVENT_NONE>. 2068together, or C<urxvt::EV_NONE>.
2084 2069
2085=item $iow = $iow->start 2070=item $iow = $iow->start
2086 2071
2087Start watching for requested events on the given handle. 2072Start watching for requested events on the given handle.
2088 2073
2129 ->new 2114 ->new
2130 ->start ($pid) 2115 ->start ($pid)
2131 ->cb (sub { 2116 ->cb (sub {
2132 my ($pw, $exit_status) = @_; 2117 my ($pw, $exit_status) = @_;
2133 ... 2118 ...
2134 }); 2119 });
2135 2120
2136=over 4 2121=over 4
2137 2122
2138=item $pw = new urxvt::pw 2123=item $pw = new urxvt::pw
2139 2124

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines