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.154 by root, Sat Jun 2 06:43:02 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/>.
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
264Example configuration:
265
266 URxvt.perl-ext: default,matcher
267 URxvt.urlLauncher: sensible-browser
268 URxvt.keysym.C-Delete: perl:matcher
269 URxvt.matcher.button: 1
270 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
271 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
272 URxvt.matcher.launcher.2: gvim +$2 $1
251 273
252=item xim-onthespot 274=item xim-onthespot
253 275
254This (experimental) perl extension implements OnTheSpot editing. It does 276This (experimental) perl extension implements OnTheSpot editing. It does
255not work perfectly, and some input methods don't seem to work well with 277not work perfectly, and some input methods don't seem to work well with
287same effect as pseudo transparency with a custom pixmap. No scaling is 309same effect as pseudo transparency with a custom pixmap. No scaling is
288supported in this mode. Example: 310supported in this mode. Example:
289 311
290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 312 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291 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
292=item block-graphics-to-ascii 318=item block-graphics-to-ascii
293 319
294A not very useful example of filtering all text output to the terminal 320A not very useful example of filtering all text output to the terminal
295by replacing all line-drawing characters (U+2500 .. U+259F) by a 321by replacing all line-drawing characters (U+2500 .. U+259F) by a
296similar-looking ascii character. 322similar-looking ascii character.
345After a successful upload the selection will be replaced by the text given 371After a successful upload the selection will be replaced by the text given
346in the C<selection-pastebin-url> resource (again, the % is the placeholder 372in the C<selection-pastebin-url> resource (again, the % is the placeholder
347for the filename): 373for the filename):
348 374
349 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 375 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
376
377I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
378the double C</> characters as comment start. Use C<\057\057> instead,
379which works regardless of wether xrdb is used to parse the resource file
380or not.
350 381
351=item example-refresh-hooks 382=item example-refresh-hooks
352 383
353Displays a very simple digital clock in the upper right corner of the 384Displays a very simple digital clock in the upper right corner of the
354window. Illustrates overwriting the refresh callbacks to create your own 385window. Illustrates overwriting the refresh callbacks to create your own
395=back 426=back
396 427
397=head2 Extension Objects 428=head2 Extension Objects
398 429
399Every perl extension is a perl class. A separate perl object is created 430Every 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 431for 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 432which are passed as the first parameter to hooks. So extensions can use
402about other extensions, with the exception of methods and members that 433their C<$self> object without having to think about clashes with other
434extensions or other terminals, with the exception of methods and members
403begin with an underscore character C<_>: these are reserved for internal 435that begin with an underscore character C<_>: these are reserved for
404use. 436internal use.
405 437
406Although it isn't a C<urxvt::term> object, you can call all methods of the 438Although it isn't a C<urxvt::term> object, you can call all methods of the
407C<urxvt::term> class on this object. 439C<urxvt::term> class on this object.
408 440
409It has the following methods and data members: 441It has the following methods and data members:
966 998
967sub SET_COLOR($$$) { 999sub SET_COLOR($$$) {
968 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1000 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969} 1001}
970 1002
1003sub rend2mask {
1004 no strict 'refs';
1005 my ($str, $mask) = (@_, 0);
1006 my %color = ( fg => undef, bg => undef );
1007 my @failed;
1008 for my $spec ( split /\s+/, $str ) {
1009 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1010 $color{lc($1)} = $2;
1011 } else {
1012 my $neg = $spec =~ s/^[-^]//;
1013 unless ( exists &{"RS_$spec"} ) {
1014 push @failed, $spec;
1015 next;
1016 }
1017 my $cur = &{"RS_$spec"};
1018 if ( $neg ) {
1019 $mask &= ~$cur;
1020 } else {
1021 $mask |= $cur;
1022 }
1023 }
1024 }
1025 ($mask, @color{qw(fg bg)}, \@failed)
1026}
1027
971# urxvt::term::extension 1028# urxvt::term::extension
972 1029
973package urxvt::term::extension; 1030package urxvt::term::extension;
974 1031
975sub enable { 1032sub enable {
1086sub DESTROY { 1143sub DESTROY {
1087 $_[0][1]->stop; 1144 $_[0][1]->stop;
1088} 1145}
1089 1146
1090sub condvar { 1147sub condvar {
1091 bless \my $flag, urxvt::anyevent::condvar:: 1148 bless \my $flag, urxvt::anyevent::
1092} 1149}
1093 1150
1094sub urxvt::anyevent::condvar::broadcast { 1151sub broadcast {
1095 ${$_[0]}++; 1152 ${$_[0]}++;
1096} 1153}
1097 1154
1098sub urxvt::anyevent::condvar::wait { 1155sub wait {
1099 unless (${$_[0]}) { 1156 unless (${$_[0]}) {
1100 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1157 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1101 } 1158 }
1159}
1160
1161sub one_event {
1162 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1102} 1163}
1103 1164
1104package urxvt::term; 1165package urxvt::term;
1105 1166
1106=head2 The C<urxvt::term> Class 1167=head2 The C<urxvt::term> Class
1926 1987
1927=cut 1988=cut
1928 1989
1929package urxvt::watcher; 1990package urxvt::watcher;
1930 1991
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 1992=head2 The C<urxvt::timer> Class
1937 1993
1938This class implements timer watchers/events. Time is represented as a 1994This class implements timer watchers/events. Time is represented as a
1939fractional number of seconds since the epoch. Example: 1995fractional number of seconds since the epoch. Example:
1940 1996
2125 http://software.schmorp.de/pkg/rxvt-unicode 2181 http://software.schmorp.de/pkg/rxvt-unicode
2126 2182
2127=cut 2183=cut
2128 2184
21291 21851
2186
2187# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines