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.155 by tpope, Sun Jun 10 23:42:36 2007 UTC vs.
Revision 1.165 by root, Sat May 10 22:36:46 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
276 276
277=item xim-onthespot 277=item xim-onthespot
278 278
279This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
280not 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
281OnTheSpot 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
282kinput2. 282kinput2.
283 283
284You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
286 286
294will 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
295or show it again. 295or show it again.
296 296
297Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
298 298
299This 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
300space 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.
301 301
302The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
304 304
305If 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
306(fvwm can do it). 306(fvwm can do it).
307
308=item automove-background
309
310This is basically a very small extension that dynamically changes the
311background pixmap offset to the window position, in effect creating the
312same effect as pseudo transparency with a custom pixmap. No scaling is
313supported in this mode. Example:
314
315 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318shows how this extension can be used to implement an automatically blurred
319transparent background.
320 307
321=item block-graphics-to-ascii 308=item block-graphics-to-ascii
322 309
323A 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
324by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
329Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
330 317
331=item remote-clipboard 318=item remote-clipboard
332 319
333Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
334selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
335selection somewhere and fetch it again. 322selection somewhere and fetch it again.
336 323
337We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
338means 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
339reads it. 326reads it.
928 local $TERM = shift; 915 local $TERM = shift;
929 my $htype = shift; 916 my $htype = shift;
930 917
931 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
933 920
934 my %ext_arg; 921 my %ext_arg;
935 922
936 { 923 {
937 my @init = @TERM_INIT; 924 my @init = @TERM_INIT;
938 @TERM_INIT = (); 925 @TERM_INIT = ();
1104is 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
1105work. 1092work.
1106 1093
1107=cut 1094=cut
1108 1095
1109our $VERSION = 1; 1096our $VERSION = '3.4';
1110 1097
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1100
1114sub timer { 1101sub timer {
1145 1132
1146sub DESTROY { 1133sub DESTROY {
1147 $_[0][1]->stop; 1134 $_[0][1]->stop;
1148} 1135}
1149 1136
1150sub condvar {
1151 bless \my $flag, urxvt::anyevent::
1152}
1153
1154sub broadcast {
1155 ${$_[0]}++;
1156}
1157
1158sub wait {
1159 unless (${$_[0]}) {
1160 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1161 }
1162}
1163
1164sub one_event { 1137sub one_event {
1165 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";
1166} 1139}
1167 1140
1168package urxvt::term; 1141package urxvt::term;
1298 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303 secondaryScreen secondaryScroll selectstyle shade term_name title 1276 secondaryScreen secondaryScroll shade term_name title
1304 transient_for transparent transparent_all tripleclickwords utmpInhibit 1277 transient_for transparent transparent_all tripleclickwords utmpInhibit
1305 visualBell 1278 visualBell
1306 1279
1307=cut 1280=cut
1308 1281
1638automatically be updated. 1611automatically be updated.
1639 1612
1640C<$text> is in a special encoding: tabs and wide characters that use more 1613C<$text> is in a special encoding: tabs and wide characters that use more
1641than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1614than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642characters. Characters with combining characters and other characters that 1615characters. Characters with combining characters and other characters that
1643do not fit into the normal tetx encoding will be replaced with characters 1616do not fit into the normal text encoding will be replaced with characters
1644in the private use area. 1617in the private use area.
1645 1618
1646You have to obey this encoding when changing text. The advantage is 1619You have to obey this encoding when changing text. The advantage is
1647that C<substr> and similar functions work on screen cells and not on 1620that C<substr> and similar functions work on screen cells and not on
1648characters. 1621characters.
1967 my $env = $self->{term}->env; 1940 my $env = $self->{term}->env;
1968 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1941 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969 delete $env->{LC_ALL}; 1942 delete $env->{LC_ALL};
1970 $env->{LC_CTYPE} = $self->{term}->locale; 1943 $env->{LC_CTYPE} = $self->{term}->locale;
1971 1944
1972 urxvt::term->new ($env, "popup", 1945 my $term = urxvt::term->new (
1946 $env, "popup",
1973 "--perl-lib" => "", "--perl-ext-common" => "", 1947 "--perl-lib" => "", "--perl-ext-common" => "",
1974 "-pty-fd" => -1, "-sl" => 0, 1948 "-pty-fd" => -1, "-sl" => 0,
1975 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1949 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976 "--transient-for" => $self->{term}->parent, 1950 "--transient-for" => $self->{term}->parent,
1977 "-display" => $self->{term}->display_id, 1951 "-display" => $self->{term}->display_id,
1978 "-pe" => "urxvt-popup") 1952 "-pe" => "urxvt-popup",
1979 or die "unable to create popup window\n"; 1953 ) or die "unable to create popup window\n";
1954
1955 unless (delete $term->{urxvt_popup_init_done}) {
1956 $term->ungrab;
1957 $term->destroy;
1958 die "unable to initialise popup window\n";
1959 }
1980} 1960}
1981 1961
1982sub DESTROY { 1962sub DESTROY {
1983 my ($self) = @_; 1963 my ($self) = @_;
1984 1964
2002 ->new 1982 ->new
2003 ->interval (1) 1983 ->interval (1)
2004 ->cb (sub { 1984 ->cb (sub {
2005 $term->{overlay}->set (0, 0, 1985 $term->{overlay}->set (0, 0,
2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1986 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2007 }); 1987 });
2008 1988
2009=over 4 1989=over 4
2010 1990
2011=item $timer = new urxvt::timer 1991=item $timer = new urxvt::timer
2012 1992
2055 2035
2056 $term->{socket} = ... 2036 $term->{socket} = ...
2057 $term->{iow} = urxvt::iow 2037 $term->{iow} = urxvt::iow
2058 ->new 2038 ->new
2059 ->fd (fileno $term->{socket}) 2039 ->fd (fileno $term->{socket})
2060 ->events (urxvt::EVENT_READ) 2040 ->events (urxvt::EV_READ)
2061 ->start 2041 ->start
2062 ->cb (sub { 2042 ->cb (sub {
2063 my ($iow, $revents) = @_; 2043 my ($iow, $revents) = @_;
2064 # $revents must be 1 here, no need to check 2044 # $revents must be 1 here, no need to check
2065 sysread $term->{socket}, my $buf, 8192 2045 sysread $term->{socket}, my $buf, 8192
2083Set the file descriptor (not handle) to watch. 2063Set the file descriptor (not handle) to watch.
2084 2064
2085=item $iow = $iow->events ($eventmask) 2065=item $iow = $iow->events ($eventmask)
2086 2066
2087Set the event mask to watch. The only allowed values are 2067Set the event mask to watch. The only allowed values are
2088C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2068C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089together, or C<urxvt::EVENT_NONE>. 2069together, or C<urxvt::EV_NONE>.
2090 2070
2091=item $iow = $iow->start 2071=item $iow = $iow->start
2092 2072
2093Start watching for requested events on the given handle. 2073Start watching for requested events on the given handle.
2094 2074
2135 ->new 2115 ->new
2136 ->start ($pid) 2116 ->start ($pid)
2137 ->cb (sub { 2117 ->cb (sub {
2138 my ($pw, $exit_status) = @_; 2118 my ($pw, $exit_status) = @_;
2139 ... 2119 ...
2140 }); 2120 });
2141 2121
2142=over 4 2122=over 4
2143 2123
2144=item $pw = new urxvt::pw 2124=item $pw = new urxvt::pw
2145 2125

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines