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.110 by root, Thu Jan 19 16:22:13 2006 UTC

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

Diff Legend

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