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.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.158 by ayin, Wed Oct 31 15:17:51 2007 UTC

… …
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
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
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
30 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/>.
… …
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
… …
287same effect as pseudo transparency with a custom pixmap. No scaling is 312same effect as pseudo transparency with a custom pixmap. No scaling is
288supported in this mode. Example: 313supported in this mode. Example:
289 314
290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 315 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291 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
292=item block-graphics-to-ascii 321=item block-graphics-to-ascii
293 322
294A not very useful example of filtering all text output to the terminal 323A not very useful example of filtering all text output to the terminal
295by replacing all line-drawing characters (U+2500 .. U+259F) by a 324by replacing all line-drawing characters (U+2500 .. U+259F) by a
296similar-looking ascii character. 325similar-looking ascii character.
… …
300Displays a digital clock using the built-in overlay. 329Displays a digital clock using the built-in overlay.
301 330
302=item remote-clipboard 331=item remote-clipboard
303 332
304Somewhat of a misnomer, this extension adds two menu entries to the 333Somewhat of a misnomer, this extension adds two menu entries to the
305selection popup that allows one ti run external commands to store the 334selection popup that allows one to run external commands to store the
306selection somewhere and fetch it again. 335selection somewhere and fetch it again.
307 336
308We use it to implement a "distributed selection mechanism", which just 337We use it to implement a "distributed selection mechanism", which just
309means that one command uploads the file to a remote server, and another 338means that one command uploads the file to a remote server, and another
310reads it. 339reads it.
… …
899 local $TERM = shift; 928 local $TERM = shift;
900 my $htype = shift; 929 my $htype = shift;
901 930
902 if ($htype == 0) { # INIT 931 if ($htype == 0) { # INIT
903 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
904 933
905 my %ext_arg; 934 my %ext_arg;
906 935
907 { 936 {
908 my @init = @TERM_INIT; 937 my @init = @TERM_INIT;
909 @TERM_INIT = (); 938 @TERM_INIT = ();
… …
972 1001
973sub SET_COLOR($$$) { 1002sub SET_COLOR($$$) {
974 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1003 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975} 1004}
976 1005
1006sub rend2mask {
1007 no strict 'refs';
1008 my ($str, $mask) = (@_, 0);
1009 my %color = ( fg => undef, bg => undef );
1010 my @failed;
1011 for my $spec ( split /\s+/, $str ) {
1012 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1013 $color{lc($1)} = $2;
1014 } else {
1015 my $neg = $spec =~ s/^[-^]//;
1016 unless ( exists &{"RS_$spec"} ) {
1017 push @failed, $spec;
1018 next;
1019 }
1020 my $cur = &{"RS_$spec"};
1021 if ( $neg ) {
1022 $mask &= ~$cur;
1023 } else {
1024 $mask |= $cur;
1025 }
1026 }
1027 }
1028 ($mask, @color{qw(fg bg)}, \@failed)
1029}
1030
977# urxvt::term::extension 1031# urxvt::term::extension
978 1032
979package urxvt::term::extension; 1033package urxvt::term::extension;
980 1034
981sub enable { 1035sub enable {
… …
1092sub DESTROY { 1146sub DESTROY {
1093 $_[0][1]->stop; 1147 $_[0][1]->stop;
1094} 1148}
1095 1149
1096sub condvar { 1150sub condvar {
1097 bless \my $flag, urxvt::anyevent::condvar:: 1151 bless \my $flag, urxvt::anyevent::
1098} 1152}
1099 1153
1100sub urxvt::anyevent::condvar::broadcast { 1154sub broadcast {
1101 ${$_[0]}++; 1155 ${$_[0]}++;
1102} 1156}
1103 1157
1104sub urxvt::anyevent::condvar::wait { 1158sub wait {
1105 unless (${$_[0]}) { 1159 unless (${$_[0]}) {
1106 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1160 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1107 } 1161 }
1162}
1163
1164sub one_event {
1165 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1108} 1166}
1109 1167
1110package urxvt::term; 1168package urxvt::term;
1111 1169
1112=head2 The C<urxvt::term> Class 1170=head2 The C<urxvt::term> Class
… …
1932 1990
1933=cut 1991=cut
1934 1992
1935package urxvt::watcher; 1993package urxvt::watcher;
1936 1994
1937@urxvt::timer::ISA = __PACKAGE__;
1938@urxvt::iow::ISA = __PACKAGE__;
1939@urxvt::pw::ISA = __PACKAGE__;
1940@urxvt::iw::ISA = __PACKAGE__;
1941
1942=head2 The C<urxvt::timer> Class 1995=head2 The C<urxvt::timer> Class
1943 1996
1944This class implements timer watchers/events. Time is represented as a 1997This class implements timer watchers/events. Time is represented as a
1945fractional number of seconds since the epoch. Example: 1998fractional number of seconds since the epoch. Example:
1946 1999
… …
1949 ->new 2002 ->new
1950 ->interval (1) 2003 ->interval (1)
1951 ->cb (sub { 2004 ->cb (sub {
1952 $term->{overlay}->set (0, 0, 2005 $term->{overlay}->set (0, 0,
1953 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954 }); 2007 });
1955 2008
1956=over 4 2009=over 4
1957 2010
1958=item $timer = new urxvt::timer 2011=item $timer = new urxvt::timer
1959 2012
… …
2082 ->new 2135 ->new
2083 ->start ($pid) 2136 ->start ($pid)
2084 ->cb (sub { 2137 ->cb (sub {
2085 my ($pw, $exit_status) = @_; 2138 my ($pw, $exit_status) = @_;
2086 ... 2139 ...
2087 }); 2140 });
2088 2141
2089=over 4 2142=over 4
2090 2143
2091=item $pw = new urxvt::pw 2144=item $pw = new urxvt::pw
2092 2145
… …
2131 http://software.schmorp.de/pkg/rxvt-unicode 2184 http://software.schmorp.de/pkg/rxvt-unicode
2132 2185
2133=cut 2186=cut
2134 2187
21351 21881
2189
2190# vim: sw=3:

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines