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.154 by root, Sat Jun 2 06:43:02 2007 UTC vs.
Revision 1.166 by root, Thu Jun 5 08:40:39 2008 UTC

40 40
41 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42 42
43Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
44 44
45 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
46 46
47=over 4 47=over 4
48 48
49=item selection (enabled by default) 49=item selection (enabled by default)
50 50
101 101
102Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed. 104popup is being displayed.
105 105
106It'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
107either 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
108reference. 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
109will 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
110first argument. 110first argument.
111 111
124 124
125Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed. 127popup is being displayed.
128 128
129It'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
130is 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.
131It 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
132string 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
133when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
134 134
135The 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
136the 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
137C<a>s: 137C<a>s:
138 138
139 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : () 141 : ()
142 }; 142 };
143 143
144=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
145 145
152search. 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>
153search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
154bottom. 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
155was 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
156additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
157selection. 157selection if the C<Shift> modifier is active.
158 158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get 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>
161or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
162 162
165=item readline (enabled by default) 165=item readline (enabled by default)
166 166
167A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
168the 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
169move 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
170cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters). 171for programs that correctly support wide characters).
172 172
173To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
174 174
175=over 4 175=over 4
259The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
263 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
264Example configuration: 267Example configuration:
265 268
266 URxvt.perl-ext: default,matcher 269 URxvt.perl-ext: default,matcher
267 URxvt.urlLauncher: sensible-browser 270 URxvt.urlLauncher: sensible-browser
268 URxvt.keysym.C-Delete: perl:matcher 271 URxvt.keysym.C-Delete: perl:matcher
273 276
274=item xim-onthespot 277=item xim-onthespot
275 278
276This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
277not 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
278OnTheSpot 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
279kinput2. 282kinput2.
280 283
281You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
282C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
283 286
291will 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
292or show it again. 295or show it again.
293 296
294Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
295 298
296This 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
297space 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.
298 301
299The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
300extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
301 304
302If 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
303(fvwm can do it). 306(fvwm can do it).
304
305=item automove-background
306
307This is basically a very small extension that dynamically changes the
308background pixmap offset to the window position, in effect creating the
309same effect as pseudo transparency with a custom pixmap. No scaling is
310supported in this mode. Example:
311
312 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
313
314L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
315shows how this extension can be used to implement an automatically blurred
316transparent background.
317 307
318=item block-graphics-to-ascii 308=item block-graphics-to-ascii
319 309
320A 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
321by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
326Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
327 317
328=item remote-clipboard 318=item remote-clipboard
329 319
330Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
331selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
332selection somewhere and fetch it again. 322selection somewhere and fetch it again.
333 323
334We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
335means 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
336reads it. 326reads it.
925 local $TERM = shift; 915 local $TERM = shift;
926 my $htype = shift; 916 my $htype = shift;
927 917
928 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
929 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
930 920
931 my %ext_arg; 921 my %ext_arg;
932 922
933 { 923 {
934 my @init = @TERM_INIT; 924 my @init = @TERM_INIT;
935 @TERM_INIT = (); 925 @TERM_INIT = ();
1101is 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
1102work. 1092work.
1103 1093
1104=cut 1094=cut
1105 1095
1106our $VERSION = 1; 1096our $VERSION = '3.4';
1107 1097
1108$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1109push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1110 1100
1111sub timer { 1101sub timer {
1142 1132
1143sub DESTROY { 1133sub DESTROY {
1144 $_[0][1]->stop; 1134 $_[0][1]->stop;
1145} 1135}
1146 1136
1147sub condvar {
1148 bless \my $flag, urxvt::anyevent::
1149}
1150
1151sub broadcast {
1152 ${$_[0]}++;
1153}
1154
1155sub wait {
1156 unless (${$_[0]}) {
1157 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1158 }
1159}
1160
1161sub one_event { 1137sub one_event {
1162 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";
1163} 1139}
1164 1140
1165package urxvt::term; 1141package urxvt::term;
1295 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1296 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1297 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1298 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1299 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1300 secondaryScreen secondaryScroll selectstyle shade term_name title 1276 secondaryScreen secondaryScroll shade term_name title
1301 transient_for transparent transparent_all tripleclickwords utmpInhibit 1277 transient_for transparent transparent_all tripleclickwords utmpInhibit
1302 visualBell 1278 visualBell
1303 1279
1304=cut 1280=cut
1305 1281
1621 1597
1622Used after changing terminal contents to display them. 1598Used after changing terminal contents to display them.
1623 1599
1624=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1600=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1625 1601
1626Returns 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 >>
1627is 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
1628terminal line. The scrollback buffer starts at line C<-1> and extends to
1629line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1604terminal line. Nothing will be returned if a nonexistent line
1630is requested. 1605is requested.
1631 1606
1632If 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
1633line, 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
1634to 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
1635automatically be updated. 1610automatically be updated.
1636 1611
1637C<$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
1638than 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)
1639characters. Characters with combining characters and other characters that 1614characters. Characters with combining characters and other characters that
1640do 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
1641in the private use area. 1616in the private use area.
1642 1617
1643You have to obey this encoding when changing text. The advantage is 1618You have to obey this encoding when changing text. The advantage is
1644that 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
1645characters. 1620characters.
1964 my $env = $self->{term}->env; 1939 my $env = $self->{term}->env;
1965 # 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.
1966 delete $env->{LC_ALL}; 1941 delete $env->{LC_ALL};
1967 $env->{LC_CTYPE} = $self->{term}->locale; 1942 $env->{LC_CTYPE} = $self->{term}->locale;
1968 1943
1969 urxvt::term->new ($env, "popup", 1944 my $term = urxvt::term->new (
1945 $env, "popup",
1970 "--perl-lib" => "", "--perl-ext-common" => "", 1946 "--perl-lib" => "", "--perl-ext-common" => "",
1971 "-pty-fd" => -1, "-sl" => 0, 1947 "-pty-fd" => -1, "-sl" => 0,
1972 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1948 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1973 "--transient-for" => $self->{term}->parent, 1949 "--transient-for" => $self->{term}->parent,
1974 "-display" => $self->{term}->display_id, 1950 "-display" => $self->{term}->display_id,
1975 "-pe" => "urxvt-popup") 1951 "-pe" => "urxvt-popup",
1976 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 }
1977} 1959}
1978 1960
1979sub DESTROY { 1961sub DESTROY {
1980 my ($self) = @_; 1962 my ($self) = @_;
1981 1963
1999 ->new 1981 ->new
2000 ->interval (1) 1982 ->interval (1)
2001 ->cb (sub { 1983 ->cb (sub {
2002 $term->{overlay}->set (0, 0, 1984 $term->{overlay}->set (0, 0,
2003 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1985 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2004 }); 1986 });
2005 1987
2006=over 4 1988=over 4
2007 1989
2008=item $timer = new urxvt::timer 1990=item $timer = new urxvt::timer
2009 1991
2052 2034
2053 $term->{socket} = ... 2035 $term->{socket} = ...
2054 $term->{iow} = urxvt::iow 2036 $term->{iow} = urxvt::iow
2055 ->new 2037 ->new
2056 ->fd (fileno $term->{socket}) 2038 ->fd (fileno $term->{socket})
2057 ->events (urxvt::EVENT_READ) 2039 ->events (urxvt::EV_READ)
2058 ->start 2040 ->start
2059 ->cb (sub { 2041 ->cb (sub {
2060 my ($iow, $revents) = @_; 2042 my ($iow, $revents) = @_;
2061 # $revents must be 1 here, no need to check 2043 # $revents must be 1 here, no need to check
2062 sysread $term->{socket}, my $buf, 8192 2044 sysread $term->{socket}, my $buf, 8192
2080Set the file descriptor (not handle) to watch. 2062Set the file descriptor (not handle) to watch.
2081 2063
2082=item $iow = $iow->events ($eventmask) 2064=item $iow = $iow->events ($eventmask)
2083 2065
2084Set the event mask to watch. The only allowed values are 2066Set the event mask to watch. The only allowed values are
2085C<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
2086together, or C<urxvt::EVENT_NONE>. 2068together, or C<urxvt::EV_NONE>.
2087 2069
2088=item $iow = $iow->start 2070=item $iow = $iow->start
2089 2071
2090Start watching for requested events on the given handle. 2072Start watching for requested events on the given handle.
2091 2073
2132 ->new 2114 ->new
2133 ->start ($pid) 2115 ->start ($pid)
2134 ->cb (sub { 2116 ->cb (sub {
2135 my ($pw, $exit_status) = @_; 2117 my ($pw, $exit_status) = @_;
2136 ... 2118 ...
2137 }); 2119 });
2138 2120
2139=over 4 2121=over 4
2140 2122
2141=item $pw = new urxvt::pw 2123=item $pw = new urxvt::pw
2142 2124

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines