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.144 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.160 by ayin, Fri Nov 16 10:06:40 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
240 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
241 244
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid 245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices. 246indices.
244 247
245=item mark-urls 248=item matcher
246 249
247Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
248make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
249resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
250the URL as first argument. 253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
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
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
251 276
252=item xim-onthespot 277=item xim-onthespot
253 278
254This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
255not 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
256OnTheSpot 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
257kinput2. 282kinput2.
258 283
259You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
261 286
269will 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
270or show it again. 295or show it again.
271 296
272Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
273 298
274This 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
275space 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.
276 301
277The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
278extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
279 304
280If 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
281(fvwm can do it). 306(fvwm can do it).
282
283=item automove-background
284
285This is basically a very small extension that dynamically changes the
286background pixmap offset to the window position, in effect creating the
287same effect as pseudo transparency with a custom pixmap. No scaling is
288supported in this mode. Example:
289
290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291 307
292=item block-graphics-to-ascii 308=item block-graphics-to-ascii
293 309
294A 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
295by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
300Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
301 317
302=item remote-clipboard 318=item remote-clipboard
303 319
304Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
305selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
306selection somewhere and fetch it again. 322selection somewhere and fetch it again.
307 323
308We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
309means 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
310reads it. 326reads it.
345After a successful upload the selection will be replaced by the text given 361After a successful upload the selection will be replaced by the text given
346in the C<selection-pastebin-url> resource (again, the % is the placeholder 362in the C<selection-pastebin-url> resource (again, the % is the placeholder
347for the filename): 363for the filename):
348 364
349 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 365 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366
367I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368the double C</> characters as comment start. Use C<\057\057> instead,
369which works regardless of wether xrdb is used to parse the resource file
370or not.
350 371
351=item example-refresh-hooks 372=item example-refresh-hooks
352 373
353Displays a very simple digital clock in the upper right corner of the 374Displays a very simple digital clock in the upper right corner of the
354window. Illustrates overwriting the refresh callbacks to create your own 375window. Illustrates overwriting the refresh callbacks to create your own
395=back 416=back
396 417
397=head2 Extension Objects 418=head2 Extension Objects
398 419
399Every perl extension is a perl class. A separate perl object is created 420Every perl extension is a perl class. A separate perl object is created
400for each terminal and each extension and passed as the first parameter to 421for each terminal, and each terminal has its own set of extenion objects,
401hooks. So extensions can use their C<$self> object without having to think 422which are passed as the first parameter to hooks. So extensions can use
402about other extensions, with the exception of methods and members that 423their C<$self> object without having to think about clashes with other
424extensions or other terminals, with the exception of methods and members
403begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
404use. 426internal use.
405 427
406Although it isn't a C<urxvt::term> object, you can call all methods of the 428Although it isn't a C<urxvt::term> object, you can call all methods of the
407C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
408 430
409It has the following methods and data members: 431It has the following methods and data members:
893 local $TERM = shift; 915 local $TERM = shift;
894 my $htype = shift; 916 my $htype = shift;
895 917
896 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
897 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
898 920
899 my %ext_arg; 921 my %ext_arg;
900 922
901 { 923 {
902 my @init = @TERM_INIT; 924 my @init = @TERM_INIT;
903 @TERM_INIT = (); 925 @TERM_INIT = ();
966 988
967sub SET_COLOR($$$) { 989sub SET_COLOR($$$) {
968 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 990 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969} 991}
970 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
971# urxvt::term::extension 1018# urxvt::term::extension
972 1019
973package urxvt::term::extension; 1020package urxvt::term::extension;
974 1021
975sub enable { 1022sub enable {
1086sub DESTROY { 1133sub DESTROY {
1087 $_[0][1]->stop; 1134 $_[0][1]->stop;
1088} 1135}
1089 1136
1090sub condvar { 1137sub condvar {
1091 bless \my $flag, urxvt::anyevent::condvar:: 1138 bless \my $flag, urxvt::anyevent::
1092} 1139}
1093 1140
1094sub urxvt::anyevent::condvar::broadcast { 1141sub broadcast {
1095 ${$_[0]}++; 1142 ${$_[0]}++;
1096} 1143}
1097 1144
1098sub urxvt::anyevent::condvar::wait { 1145sub wait {
1099 unless (${$_[0]}) { 1146 unless (${$_[0]}) {
1100 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";
1101 } 1148 }
1149}
1150
1151sub one_event {
1152 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1102} 1153}
1103 1154
1104package urxvt::term; 1155package urxvt::term;
1105 1156
1106=head2 The C<urxvt::term> Class 1157=head2 The C<urxvt::term> Class
1926 1977
1927=cut 1978=cut
1928 1979
1929package urxvt::watcher; 1980package urxvt::watcher;
1930 1981
1931@urxvt::timer::ISA = __PACKAGE__;
1932@urxvt::iow::ISA = __PACKAGE__;
1933@urxvt::pw::ISA = __PACKAGE__;
1934@urxvt::iw::ISA = __PACKAGE__;
1935
1936=head2 The C<urxvt::timer> Class 1982=head2 The C<urxvt::timer> Class
1937 1983
1938This class implements timer watchers/events. Time is represented as a 1984This class implements timer watchers/events. Time is represented as a
1939fractional number of seconds since the epoch. Example: 1985fractional number of seconds since the epoch. Example:
1940 1986
1943 ->new 1989 ->new
1944 ->interval (1) 1990 ->interval (1)
1945 ->cb (sub { 1991 ->cb (sub {
1946 $term->{overlay}->set (0, 0, 1992 $term->{overlay}->set (0, 0,
1947 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1993 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948 }); 1994 });
1949 1995
1950=over 4 1996=over 4
1951 1997
1952=item $timer = new urxvt::timer 1998=item $timer = new urxvt::timer
1953 1999
1996 2042
1997 $term->{socket} = ... 2043 $term->{socket} = ...
1998 $term->{iow} = urxvt::iow 2044 $term->{iow} = urxvt::iow
1999 ->new 2045 ->new
2000 ->fd (fileno $term->{socket}) 2046 ->fd (fileno $term->{socket})
2001 ->events (urxvt::EVENT_READ) 2047 ->events (urxvt::EV_READ)
2002 ->start 2048 ->start
2003 ->cb (sub { 2049 ->cb (sub {
2004 my ($iow, $revents) = @_; 2050 my ($iow, $revents) = @_;
2005 # $revents must be 1 here, no need to check 2051 # $revents must be 1 here, no need to check
2006 sysread $term->{socket}, my $buf, 8192 2052 sysread $term->{socket}, my $buf, 8192
2024Set the file descriptor (not handle) to watch. 2070Set the file descriptor (not handle) to watch.
2025 2071
2026=item $iow = $iow->events ($eventmask) 2072=item $iow = $iow->events ($eventmask)
2027 2073
2028Set the event mask to watch. The only allowed values are 2074Set the event mask to watch. The only allowed values are
2029C<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
2030together, or C<urxvt::EVENT_NONE>. 2076together, or C<urxvt::EV_NONE>.
2031 2077
2032=item $iow = $iow->start 2078=item $iow = $iow->start
2033 2079
2034Start watching for requested events on the given handle. 2080Start watching for requested events on the given handle.
2035 2081
2076 ->new 2122 ->new
2077 ->start ($pid) 2123 ->start ($pid)
2078 ->cb (sub { 2124 ->cb (sub {
2079 my ($pw, $exit_status) = @_; 2125 my ($pw, $exit_status) = @_;
2080 ... 2126 ...
2081 }); 2127 });
2082 2128
2083=over 4 2129=over 4
2084 2130
2085=item $pw = new urxvt::pw 2131=item $pw = new urxvt::pw
2086 2132
2125 http://software.schmorp.de/pkg/rxvt-unicode 2171 http://software.schmorp.de/pkg/rxvt-unicode
2126 2172
2127=cut 2173=cut
2128 2174
21291 21751
2176
2177# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines