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

Diff Legend

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