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.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.110 by root, Thu Jan 19 16:22:13 2006 UTC

… …
76 76
77Rot-13 the selection when activated. Used via keyboard trigger: 77Rot-13 the selection when activated. Used via keyboard trigger:
78 78
79 URxvt.keysym.C-M-r: perl:selection:rot13 79 URxvt.keysym.C-M-r: perl:selection:rot13
80 80
81=item remote-pastebin
82
83Upload the selection as textfile to a remote site.
84
85 URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87To set the command to upload the file set this resource:
88
89 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92md5 sum of the selection.
93After an successful upload the selection will be replaced by the following url
94(the % is the placeholder for the filename):
95
96 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98=back 81=back
99 82
100=item option-popup (enabled by default) 83=item option-popup (enabled by default)
101 84
102Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
… …
105=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
106 89
107Binds 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
108text into various other formats/action (such as uri unescaping, perl 91text into various other formats/action (such as uri unescaping, perl
109evalution, 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 };
110 112
111=item searchable-scrollback<hotkey> (enabled by default) 113=item searchable-scrollback<hotkey> (enabled by default)
112 114
113Adds regex search functionality to the scrollback buffer, triggered 115Adds regex search functionality to the scrollback buffer, triggered
114by 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
… …
142 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/
143 145
144And 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
145paste directly into your (vi :) editor: 147paste directly into your (vi :) editor:
146 148
147 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/
148 150
149Of 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 :)
150 152
151To expand the example above to typical perl error messages ("XXX at 153To expand the example above to typical perl error messages ("XXX at
152FILENAME line YYY."), you need a slightly more elaborate solution: 154FILENAME line YYY."), you need a slightly more elaborate solution:
153 155
154 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 156 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155 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/
156 158
157The 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
158every error message as a selection pattern, and the second line transforms 160every error message as a selection pattern, and the second line transforms
159the message into vi commands to load the file. 161the message into vi commands to load the file.
160 162
… …
163Uses 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
164make them clickable. When middle-clicked, the program specified in the 166make them clickable. When middle-clicked, the program specified in the
165resource C<urlLauncher> (default C<x-www-browser>) will be started with 167resource C<urlLauncher> (default C<x-www-browser>) will be started with
166the URL as first argument. 168the URL as first argument.
167 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
168=item block-graphics-to-ascii 178=item block-graphics-to-ascii
169 179
170A 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,
171by replacing all line-drawing characters (U+2500 .. U+259F) by a 181by replacing all line-drawing characters (U+2500 .. U+259F) by a
172similar-looking ascii character. 182similar-looking ascii character.
… …
178=item example-refresh-hooks 188=item example-refresh-hooks
179 189
180Displays a very simple digital clock in the upper right corner of the 190Displays a very simple digital clock in the upper right corner of the
181window. Illustrates overwriting the refresh callbacks to create your own 191window. Illustrates overwriting the refresh callbacks to create your own
182overlays or changes. 192overlays or changes.
193
194=item selection-pastebin
195
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.
203
204 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
205
206Pressing this combination runs a command with C<%> replaced by the name of
207the textfile. This command can be set via a resource:
208
209 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
210
211And the default is likely not useful to anybody but the few people around
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
217After a successful upload the selection will be replaced by the text given
218in the C<selection-pastebin-url> resource (again, the % is the placeholder
219for the filename):
220
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.
… …
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.
408 456
457=item on_configure_notify $term, $event
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
413=item on_button_press $term, $event 463=item on_button_press $term, $event
… …
497 547
498Using this function has the advantage that its output ends up in the 548Using this function has the advantage that its output ends up in the
499correct place, e.g. on stderr of the connecting urxvtc client. 549correct place, e.g. on stderr of the connecting urxvtc client.
500 550
501Messages have a size limit of 1023 bytes currently. 551Messages have a size limit of 1023 bytes currently.
502
503=item $is_safe = urxvt::safe
504
505Returns true when it is safe to do potentially unsafe things, such as
506evaluating perl code specified by the user. This is true when urxvt was
507started setuid or setgid.
508 552
509=item $time = urxvt::NOW 553=item $time = urxvt::NOW
510 554
511Returns the "current time" (as per the event loop). 555Returns the "current time" (as per the event loop).
512 556
… …
589=back 633=back
590 634
591=cut 635=cut
592 636
593BEGIN { 637BEGIN {
594 urxvt->bootstrap;
595
596 # overwrite perl's warn 638 # overwrite perl's warn
597 *CORE::GLOBAL::warn = sub { 639 *CORE::GLOBAL::warn = sub {
598 my $msg = join "", @_; 640 my $msg = join "", @_;
599 $msg .= "\n" 641 $msg .= "\n"
600 unless $msg =~ /\n$/; 642 unless $msg =~ /\n$/;
601 urxvt::warn ($msg); 643 urxvt::warn ($msg);
602 }; 644 };
603
604 # %ENV is the original startup environment
605 delete $ENV{IFS};
606 delete $ENV{CDPATH};
607 delete $ENV{BASH_ENV};
608 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
609} 645}
610 646
611my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 647my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612 648
613sub verbose { 649sub verbose {
614 my ($level, $msg) = @_; 650 my ($level, $msg) = @_;
615 warn "$msg\n" if $level <= $verbosity; 651 warn "$msg\n" if $level <= $verbosity;
616} 652}
617 653
618my $extension_pkg = "extension0000";
619my %extension_pkg; 654my %extension_pkg;
620 655
621# load a single script into its own package, once only 656# load a single script into its own package, once only
622sub extension_package($) { 657sub extension_package($) {
623 my ($path) = @_; 658 my ($path) = @_;
624 659
660 no strict 'refs';
661
625 $extension_pkg{$path} ||= do { 662 $extension_pkg{$path} ||= do {
626 my $pkg = "urxvt::" . ($extension_pkg++); 663 $path =~ /([^\/\\]+)$/;
664 my $pkg = $1;
665 $pkg =~ s/[^[:word:]]/_/g;
666 $pkg = "urxvt::ext::$pkg";
627 667
628 verbose 3, "loading extension '$path' into package '$pkg'"; 668 verbose 3, "loading extension '$path' into package '$pkg'";
629 669
630 open my $fh, "<:raw", $path 670 open my $fh, "<:raw", $path
631 or die "$path: $!"; 671 or die "$path: $!";
632 672
673 @{"$pkg\::ISA"} = urxvt::term::extension::;
674
633 my $source = untaint 675 my $source =
634 "package $pkg; use strict; use utf8;\n" 676 "package $pkg; use strict; use utf8;\n"
635 . "use base urxvt::term::extension::;\n"
636 . "#line 1 \"$path\"\n{\n" 677 . "#line 1 \"$path\"\n{\n"
637 . (do { local $/; <$fh> }) 678 . (do { local $/; <$fh> })
638 . "\n};\n1"; 679 . "\n};\n1";
639 680
640 eval $source 681 eval $source
… …
713 } 754 }
714 755
715 $retval 756 $retval
716} 757}
717 758
718sub exec_async(@) {
719 my $pid = fork;
720
721 return
722 if !defined $pid or $pid;
723
724 %ENV = %{ $TERM->env };
725
726 exec @_;
727 _exit 255;
728}
729
730# urxvt::term::extension 759# urxvt::term::extension
731 760
732package urxvt::term::extension; 761package urxvt::term::extension;
733 762
734sub enable { 763sub enable {
… …
911 940
912Destroy the terminal object (close the window, free resources 941Destroy the terminal object (close the window, free resources
913etc.). 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
914watchers (timers, io watchers) are still active. 943watchers (timers, io watchers) are still active.
915 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
916=item $isset = $term->option ($optval[, $set]) 970=item $isset = $term->option ($optval[, $set])
917 971
918Returns true if the option specified by C<$optval> is enabled, and 972Returns true if the option specified by C<$optval> is enabled, and
919optionally 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
920C<%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.
… …
922Here 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
923source file F</src/optinc.h> to see the actual list: 977source file F</src/optinc.h> to see the actual list:
924 978
925 borderLess console cursorBlink cursorUnderline hold iconic insecure 979 borderLess console cursorBlink cursorUnderline hold iconic insecure
926 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 980 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
927 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 981 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
928 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 982 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
929 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 983 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
930 tripleclickwords utmpInhibit visualBell 984 transparent tripleclickwords utmpInhibit visualBell
931 985
932=item $value = $term->resource ($name[, $newval]) 986=item $value = $term->resource ($name[, $newval])
933 987
934Returns the current resource value associated with a given name and 988Returns the current resource value associated with a given name and
935optionally 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>
… …
952 1006
953 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1007 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
954 borderLess color cursorBlink cursorUnderline cutchars delete_key 1008 borderLess color cursorBlink cursorUnderline cutchars delete_key
955 display_name embed ext_bwidth fade font geometry hold iconName 1009 display_name embed ext_bwidth fade font geometry hold iconName
956 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1010 imFont imLocale inputMethod insecure int_bwidth intensityStyles
957 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1011 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
958 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1012 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1013 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1014 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1015 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1016 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963 shade term_name title transparent transparent_all tripleclickwords 1017 secondaryScreen secondaryScroll selectstyle shade term_name title
964 utmpInhibit visualBell 1018 transient_for transparent transparent_all tripleclickwords utmpInhibit
1019 visualBell
965 1020
966=cut 1021=cut
967 1022
968sub resource($$;$) { 1023sub resource($$;$) {
969 my ($self, $name) = (shift, shift); 1024 my ($self, $name) = (shift, shift);
… …
1561 my $env = $self->{term}->env; 1616 my $env = $self->{term}->env;
1562 # 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.
1563 delete $env->{LC_ALL}; 1618 delete $env->{LC_ALL};
1564 $env->{LC_CTYPE} = $self->{term}->locale; 1619 $env->{LC_CTYPE} = $self->{term}->locale;
1565 1620
1566 urxvt::term->new ($env, $self->{term}->resource ("name"), 1621 urxvt::term->new ($env, "popup",
1567 "--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",
1568 "--transient-for" => $self->{term}->parent, 1625 "--transient-for" => $self->{term}->parent,
1569 "-display" => $self->{term}->display_id, 1626 "-display" => $self->{term}->display_id,
1570 "-pe" => "urxvt-popup") 1627 "-pe" => "urxvt-popup")
1571 or die "unable to create popup window\n"; 1628 or die "unable to create popup window\n";
1572} 1629}
… …
1624Start the timer. 1681Start the timer.
1625 1682
1626=item $timer = $timer->start ($tstamp) 1683=item $timer = $timer->start ($tstamp)
1627 1684
1628Set 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>.
1629 1690
1630=item $timer = $timer->stop 1691=item $timer = $timer->stop
1631 1692
1632Stop the timer. 1693Stop the timer.
1633 1694

Diff Legend

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