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.97 by elmex, Tue Jan 17 16:53:47 2006 UTC vs.
Revision 1.111 by root, Thu Jan 19 19:52:54 2006 UTC

… …
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
… …
88=item selection-popup (enabled by default) 92=item selection-popup (enabled by default)
89 93
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
93 116
94=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
95 118
96Adds regex search functionality to the scrollback buffer, triggered 119Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 120by a hotkey (default: C<M-s>). While in search mode, normal terminal
… …
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 149
127And this example matches the same,but replaces it with vi-commands you can 150And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
129 152
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 154
132Of course, this can be modified to suit your needs and your editor :) 155Of course, this can be modified to suit your needs and your editor :)
133 156
134To expand the example above to typical perl error messages ("XXX at 157To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 158FILENAME line YYY."), you need a slightly more elaborate solution:
136 159
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139 162
140The first line tells the selection code to treat the unchanging part of 163The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 165the message into vi commands to load the file.
143 166
… …
146Uses per-line display filtering (C<on_line_update>) to underline urls and 169Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 172the URL as first argument.
150 173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181
151=item block-graphics-to-ascii 182=item block-graphics-to-ascii
152 183
153A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 186similar-looking ascii character.
… …
164window. Illustrates overwriting the refresh callbacks to create your own 195window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 196overlays or changes.
166 197
167=item selection-pastebin 198=item selection-pastebin
168 199
169Uploads the selection as textfile to a remote site. 200This is a little rarely useful extension that Uploads the selection as
201textfile to a remote site (or does other things). (The implementation is
202not currently secure for use in a multiuser environment as it writes to
203F</tmp> directly.).
204
205It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206i.e.
170 207
171 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 208 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
172 209
173To set the command to upload the file set this resource: 210Pressing this combination runs a command with C<%> replaced by the name of
211the textfile. This command can be set via a resource:
174 212
175 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. 213 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
176 214
177The % is the placeholder for the textfile. The name of the textfile is the hex encoded 215And the default is likely not useful to anybody but the few people around
178md5 sum of the selection. 216here :)
217
218The name of the textfile is the hex encoded md5 sum of the selection, so
219the same content should lead to the same filename.
220
179After an successful upload the selection will be replaced by the following url 221After a successful upload the selection will be replaced by the text given
180(the % is the placeholder for the filename): 222in the C<selection-pastebin-url> resource (again, the % is the placeholder
223for the filename):
181 224
182 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/% 225 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
183 226
184=back 227=back
185 228
186=head1 API DOCUMENTATION 229=head1 API DOCUMENTATION
187 230
… …
287=item on_start $term 330=item on_start $term
288 331
289Called at the very end of initialisation of a new terminal, just before 332Called at the very end of initialisation of a new terminal, just before
290returning to the mainloop. 333returning to the mainloop.
291 334
335=item on_child_start $term, $pid
336
337Called just after the child process has been C<fork>ed.
338
339=item on_child_exit $term, $status
340
341Called just after the child process has exited. C<$status> is the status
342from C<waitpid>.
343
292=item on_sel_make $term, $eventtime 344=item on_sel_make $term, $eventtime
293 345
294Called whenever a selection has been made by the user, but before the 346Called whenever a selection has been made by the user, but before the
295selection text is copied, so changes to the beginning, end or type of the 347selection text is copied, so changes to the beginning, end or type of the
296selection will be honored. 348selection will be honored.
… …
403 455
404=item on_focus_out $term 456=item on_focus_out $term
405 457
406Called wheneever the window loses keyboard focus, before rxvt-unicode does 458Called wheneever the window loses keyboard focus, before rxvt-unicode does
407focus out processing. 459focus out processing.
460
461=item on_configure_notify $term, $event
408 462
409=item on_key_press $term, $event, $keysym, $octets 463=item on_key_press $term, $event, $keysym, $octets
410 464
411=item on_key_release $term, $event, $keysym 465=item on_key_release $term, $event, $keysym
412 466
… …
583=back 637=back
584 638
585=cut 639=cut
586 640
587BEGIN { 641BEGIN {
588 urxvt->bootstrap;
589
590 # overwrite perl's warn 642 # overwrite perl's warn
591 *CORE::GLOBAL::warn = sub { 643 *CORE::GLOBAL::warn = sub {
592 my $msg = join "", @_; 644 my $msg = join "", @_;
593 $msg .= "\n" 645 $msg .= "\n"
594 unless $msg =~ /\n$/; 646 unless $msg =~ /\n$/;
595 urxvt::warn ($msg); 647 urxvt::warn ($msg);
596 }; 648 };
597
598 # %ENV is the original startup environment
599 delete $ENV{IFS};
600 delete $ENV{CDPATH};
601 delete $ENV{BASH_ENV};
602 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
603} 649}
604 650
605my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 651my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
606 652
607sub verbose { 653sub verbose {
608 my ($level, $msg) = @_; 654 my ($level, $msg) = @_;
609 warn "$msg\n" if $level <= $verbosity; 655 warn "$msg\n" if $level <= $verbosity;
610} 656}
611 657
612my $extension_pkg = "extension0000";
613my %extension_pkg; 658my %extension_pkg;
614 659
615# load a single script into its own package, once only 660# load a single script into its own package, once only
616sub extension_package($) { 661sub extension_package($) {
617 my ($path) = @_; 662 my ($path) = @_;
618 663
664 no strict 'refs';
665
619 $extension_pkg{$path} ||= do { 666 $extension_pkg{$path} ||= do {
620 my $pkg = "urxvt::" . ($extension_pkg++); 667 $path =~ /([^\/\\]+)$/;
668 my $pkg = $1;
669 $pkg =~ s/[^[:word:]]/_/g;
670 $pkg = "urxvt::ext::$pkg";
621 671
622 verbose 3, "loading extension '$path' into package '$pkg'"; 672 verbose 3, "loading extension '$path' into package '$pkg'";
623 673
624 open my $fh, "<:raw", $path 674 open my $fh, "<:raw", $path
625 or die "$path: $!"; 675 or die "$path: $!";
626 676
677 @{"$pkg\::ISA"} = urxvt::term::extension::;
678
627 my $source = 679 my $source =
628 "package $pkg; use strict; use utf8;\n" 680 "package $pkg; use strict; use utf8;\n"
629 . "use base urxvt::term::extension::;\n"
630 . "#line 1 \"$path\"\n{\n" 681 . "#line 1 \"$path\"\n{\n"
631 . (do { local $/; <$fh> }) 682 . (do { local $/; <$fh> })
632 . "\n};\n1"; 683 . "\n};\n1";
633 684
634 eval $source 685 eval $source
… …
707 } 758 }
708 759
709 $retval 760 $retval
710} 761}
711 762
712sub exec_async(@) {
713 my $pid = fork;
714
715 return
716 if !defined $pid or $pid;
717
718 %ENV = %{ $TERM->env };
719
720 exec @_;
721 _exit 255;
722}
723
724# urxvt::term::extension 763# urxvt::term::extension
725 764
726package urxvt::term::extension; 765package urxvt::term::extension;
727 766
728sub enable { 767sub enable {
… …
905 944
906Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
907etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 946etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
908watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
909 948
949=item $term->exec_async ($cmd[, @args])
950
951Works like the combination of the C<fork>/C<exec> builtins, which executes
952("starts") programs in the background. This function takes care of setting
953the user environment before exec'ing the command (e.g. C<PATH>) and should
954be preferred over explicit calls to C<exec> or C<system>.
955
956Returns the pid of the subprocess or C<undef> on error.
957
958=cut
959
960sub exec_async {
961 my $self = shift;
962
963 my $pid = fork;
964
965 return $pid
966 if !defined $pid or $pid;
967
968 %ENV = %{ $self->env };
969
970 exec @_;
971 urxvt::_exit 255;
972}
973
910=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
911 975
912Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
913optionally change it. All option values are stored by name in the hash 977optionally change it. All option values are stored by name in the hash
914C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 978C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
… …
916Here is a a likely non-exhaustive list of option names, please see the 980Here is a a likely non-exhaustive list of option names, please see the
917source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
918 982
919 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
920 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
921 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
922 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
923 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
924 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
925 989
926=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
927 991
928Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
929optionally sets a new value. Setting values is most useful in the C<init> 993optionally sets a new value. Setting values is most useful in the C<init>
… …
946 1010
947 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
948 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
949 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
950 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
951 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
952 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
953 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
958 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
959 1024
960=cut 1025=cut
961 1026
962sub resource($$;$) { 1027sub resource($$;$) {
963 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
… …
1555 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1556 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1621 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1557 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1558 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1559 1624
1560 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1561 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1626 "--perl-lib" => "", "--perl-ext-common" => "",
1627 "-pty-fd" => -1, "-sl" => 0,
1628 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1562 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1563 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1564 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1565 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1566} 1633}
… …
1618Start the timer. 1685Start the timer.
1619 1686
1620=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1621 1688
1622Set the event trigger time to C<$tstamp> and start the timer. 1689Set the event trigger time to C<$tstamp> and start the timer.
1690
1691=item $timer = $timer->after ($delay)
1692
1693Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1623 1694
1624=item $timer = $timer->stop 1695=item $timer = $timer->stop
1625 1696
1626Stop the timer. 1697Stop the timer.
1627 1698

Diff Legend

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