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

Diff Legend

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