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.148 by root, Tue Oct 3 21:41:07 2006 UTC vs.
Revision 1.162 by ayin, Mon Dec 17 16:57:57 2007 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
271 URxvt.keysym.C-Delete: perl:matcher
265 URxvt.matcher.button: 1 272 URxvt.matcher.button: 1
266 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
268 URxvt.matcher.launcher.2: gvim +$2 $1 275 URxvt.matcher.launcher.2: gvim +$2 $1
269 276
270=item xim-onthespot 277=item xim-onthespot
271 278
272This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
273not 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
274OnTheSpot 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
275kinput2. 282kinput2.
276 283
277You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
278C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
279 286
287will 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
288or show it again. 295or show it again.
289 296
290Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
291 298
292This 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
293space 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.
294 301
295The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
296extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
297 304
298If 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
299(fvwm can do it). 306(fvwm can do it).
300
301=item automove-background
302
303This is basically a very small extension that dynamically changes the
304background pixmap offset to the window position, in effect creating the
305same effect as pseudo transparency with a custom pixmap. No scaling is
306supported in this mode. Example:
307
308 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309 307
310=item block-graphics-to-ascii 308=item block-graphics-to-ascii
311 309
312A 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
313by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
318Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
319 317
320=item remote-clipboard 318=item remote-clipboard
321 319
322Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
323selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
324selection somewhere and fetch it again. 322selection somewhere and fetch it again.
325 323
326We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
327means 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
328reads it. 326reads it.
917 local $TERM = shift; 915 local $TERM = shift;
918 my $htype = shift; 916 my $htype = shift;
919 917
920 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
921 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
922 920
923 my %ext_arg; 921 my %ext_arg;
924 922
925 { 923 {
926 my @init = @TERM_INIT; 924 my @init = @TERM_INIT;
927 @TERM_INIT = (); 925 @TERM_INIT = ();
990 988
991sub SET_COLOR($$$) { 989sub SET_COLOR($$$) {
992 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 990 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993} 991}
994 992
993sub rend2mask {
994 no strict 'refs';
995 my ($str, $mask) = (@_, 0);
996 my %color = ( fg => undef, bg => undef );
997 my @failed;
998 for my $spec ( split /\s+/, $str ) {
999 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1000 $color{lc($1)} = $2;
1001 } else {
1002 my $neg = $spec =~ s/^[-^]//;
1003 unless ( exists &{"RS_$spec"} ) {
1004 push @failed, $spec;
1005 next;
1006 }
1007 my $cur = &{"RS_$spec"};
1008 if ( $neg ) {
1009 $mask &= ~$cur;
1010 } else {
1011 $mask |= $cur;
1012 }
1013 }
1014 }
1015 ($mask, @color{qw(fg bg)}, \@failed)
1016}
1017
995# urxvt::term::extension 1018# urxvt::term::extension
996 1019
997package urxvt::term::extension; 1020package urxvt::term::extension;
998 1021
999sub enable { 1022sub enable {
1110sub DESTROY { 1133sub DESTROY {
1111 $_[0][1]->stop; 1134 $_[0][1]->stop;
1112} 1135}
1113 1136
1114sub condvar { 1137sub condvar {
1115 bless \my $flag, urxvt::anyevent::condvar:: 1138 bless \my $flag, urxvt::anyevent::
1116} 1139}
1117 1140
1118sub urxvt::anyevent::condvar::broadcast { 1141sub broadcast {
1119 ${$_[0]}++; 1142 ${$_[0]}++;
1120} 1143}
1121 1144
1122sub urxvt::anyevent::condvar::wait { 1145sub wait {
1123 unless (${$_[0]}) { 1146 unless (${$_[0]}) {
1124 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1147 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1125 } 1148 }
1149}
1150
1151sub one_event {
1152 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1126} 1153}
1127 1154
1128package urxvt::term; 1155package urxvt::term;
1129 1156
1130=head2 The C<urxvt::term> Class 1157=head2 The C<urxvt::term> Class
1598automatically be updated. 1625automatically be updated.
1599 1626
1600C<$text> is in a special encoding: tabs and wide characters that use more 1627C<$text> is in a special encoding: tabs and wide characters that use more
1601than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1628than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1602characters. Characters with combining characters and other characters that 1629characters. Characters with combining characters and other characters that
1603do not fit into the normal tetx encoding will be replaced with characters 1630do not fit into the normal text encoding will be replaced with characters
1604in the private use area. 1631in the private use area.
1605 1632
1606You have to obey this encoding when changing text. The advantage is 1633You have to obey this encoding when changing text. The advantage is
1607that C<substr> and similar functions work on screen cells and not on 1634that C<substr> and similar functions work on screen cells and not on
1608characters. 1635characters.
1950 1977
1951=cut 1978=cut
1952 1979
1953package urxvt::watcher; 1980package urxvt::watcher;
1954 1981
1955@urxvt::timer::ISA = __PACKAGE__;
1956@urxvt::iow::ISA = __PACKAGE__;
1957@urxvt::pw::ISA = __PACKAGE__;
1958@urxvt::iw::ISA = __PACKAGE__;
1959
1960=head2 The C<urxvt::timer> Class 1982=head2 The C<urxvt::timer> Class
1961 1983
1962This class implements timer watchers/events. Time is represented as a 1984This class implements timer watchers/events. Time is represented as a
1963fractional number of seconds since the epoch. Example: 1985fractional number of seconds since the epoch. Example:
1964 1986
1967 ->new 1989 ->new
1968 ->interval (1) 1990 ->interval (1)
1969 ->cb (sub { 1991 ->cb (sub {
1970 $term->{overlay}->set (0, 0, 1992 $term->{overlay}->set (0, 0,
1971 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1993 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1972 }); 1994 });
1973 1995
1974=over 4 1996=over 4
1975 1997
1976=item $timer = new urxvt::timer 1998=item $timer = new urxvt::timer
1977 1999
2020 2042
2021 $term->{socket} = ... 2043 $term->{socket} = ...
2022 $term->{iow} = urxvt::iow 2044 $term->{iow} = urxvt::iow
2023 ->new 2045 ->new
2024 ->fd (fileno $term->{socket}) 2046 ->fd (fileno $term->{socket})
2025 ->events (urxvt::EVENT_READ) 2047 ->events (urxvt::EV_READ)
2026 ->start 2048 ->start
2027 ->cb (sub { 2049 ->cb (sub {
2028 my ($iow, $revents) = @_; 2050 my ($iow, $revents) = @_;
2029 # $revents must be 1 here, no need to check 2051 # $revents must be 1 here, no need to check
2030 sysread $term->{socket}, my $buf, 8192 2052 sysread $term->{socket}, my $buf, 8192
2048Set the file descriptor (not handle) to watch. 2070Set the file descriptor (not handle) to watch.
2049 2071
2050=item $iow = $iow->events ($eventmask) 2072=item $iow = $iow->events ($eventmask)
2051 2073
2052Set the event mask to watch. The only allowed values are 2074Set the event mask to watch. The only allowed values are
2053C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2075C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2054together, or C<urxvt::EVENT_NONE>. 2076together, or C<urxvt::EV_NONE>.
2055 2077
2056=item $iow = $iow->start 2078=item $iow = $iow->start
2057 2079
2058Start watching for requested events on the given handle. 2080Start watching for requested events on the given handle.
2059 2081
2100 ->new 2122 ->new
2101 ->start ($pid) 2123 ->start ($pid)
2102 ->cb (sub { 2124 ->cb (sub {
2103 my ($pw, $exit_status) = @_; 2125 my ($pw, $exit_status) = @_;
2104 ... 2126 ...
2105 }); 2127 });
2106 2128
2107=over 4 2129=over 4
2108 2130
2109=item $pw = new urxvt::pw 2131=item $pw = new urxvt::pw
2110 2132
2149 http://software.schmorp.de/pkg/rxvt-unicode 2171 http://software.schmorp.de/pkg/rxvt-unicode
2150 2172
2151=cut 2173=cut
2152 2174
21531 21751
2176
2177# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines