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.108 by root, Thu Jan 19 09:47:15 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 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 };
93 111
94=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
95 113
96Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
97by 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
… …
125 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/
126 144
127And 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
128paste directly into your (vi :) editor: 146paste directly into your (vi :) editor:
129 147
130 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/
131 149
132Of 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 :)
133 151
134To expand the example above to typical perl error messages ("XXX at 152To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 153FILENAME line YYY."), you need a slightly more elaborate solution:
136 154
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 155 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 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/
139 157
140The 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
141every error message as a selection pattern, and the second line transforms 159every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 160the message into vi commands to load the file.
143 161
… …
146Uses 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
147make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 166resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 167the URL as first argument.
150 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
151=item block-graphics-to-ascii 177=item block-graphics-to-ascii
152 178
153A 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,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 181similar-looking ascii character.
… …
164window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 191overlays or changes.
166 192
167=item selection-pastebin 193=item selection-pastebin
168 194
169Uploads the selection as textfile to a remote site. 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.
170 202
171 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 203 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
172 204
173To set the command to upload the file set this resource: 205Pressing this combination runs a command with C<%> replaced by the name of
206the textfile. This command can be set via a resource:
174 207
175 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/. 208 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
176 209
177The % is the placeholder for the textfile. The name of the textfile is the hex encoded 210And the default is likely not useful to anybody but the few people around
178md5 sum of the selection. 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
179After an successful upload the selection will be replaced by the following url 216After a successful upload the selection will be replaced by the text given
180(the % is the placeholder for the filename): 217in the C<selection-pastebin-url> resource (again, the % is the placeholder
218for the filename):
181 219
182 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/% 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.
… …
403 450
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.
455
456=item on_configure_notify $term, $event
408 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
… …
583=back 632=back
584 633
585=cut 634=cut
586 635
587BEGIN { 636BEGIN {
588 urxvt->bootstrap;
589
590 # overwrite perl's warn 637 # overwrite perl's warn
591 *CORE::GLOBAL::warn = sub { 638 *CORE::GLOBAL::warn = sub {
592 my $msg = join "", @_; 639 my $msg = join "", @_;
593 $msg .= "\n" 640 $msg .= "\n"
594 unless $msg =~ /\n$/; 641 unless $msg =~ /\n$/;
595 urxvt::warn ($msg); 642 urxvt::warn ($msg);
596 }; 643 };
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} 644}
604 645
605my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 646my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
606 647
607sub verbose { 648sub verbose {
608 my ($level, $msg) = @_; 649 my ($level, $msg) = @_;
609 warn "$msg\n" if $level <= $verbosity; 650 warn "$msg\n" if $level <= $verbosity;
610} 651}
611 652
612my $extension_pkg = "extension0000";
613my %extension_pkg; 653my %extension_pkg;
614 654
615# load a single script into its own package, once only 655# load a single script into its own package, once only
616sub extension_package($) { 656sub extension_package($) {
617 my ($path) = @_; 657 my ($path) = @_;
618 658
659 no strict 'refs';
660
619 $extension_pkg{$path} ||= do { 661 $extension_pkg{$path} ||= do {
620 my $pkg = "urxvt::" . ($extension_pkg++); 662 $path =~ /([^\/\\]+)$/;
663 my $pkg = $1;
664 $pkg =~ s/[^[:word:]]/_/g;
665 $pkg = "urxvt::ext::$pkg";
621 666
622 verbose 3, "loading extension '$path' into package '$pkg'"; 667 verbose 3, "loading extension '$path' into package '$pkg'";
623 668
624 open my $fh, "<:raw", $path 669 open my $fh, "<:raw", $path
625 or die "$path: $!"; 670 or die "$path: $!";
626 671
672 @{"$pkg\::ISA"} = urxvt::term::extension::;
673
627 my $source = 674 my $source =
628 "package $pkg; use strict; use utf8;\n" 675 "package $pkg; use strict; use utf8;\n"
629 . "use base urxvt::term::extension::;\n"
630 . "#line 1 \"$path\"\n{\n" 676 . "#line 1 \"$path\"\n{\n"
631 . (do { local $/; <$fh> }) 677 . (do { local $/; <$fh> })
632 . "\n};\n1"; 678 . "\n};\n1";
633 679
634 eval $source 680 eval $source
… …
707 } 753 }
708 754
709 $retval 755 $retval
710} 756}
711 757
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 758# urxvt::term::extension
725 759
726package urxvt::term::extension; 760package urxvt::term::extension;
727 761
728sub enable { 762sub enable {
… …
905 939
906Destroy the terminal object (close the window, free resources 940Destroy the terminal object (close the window, free resources
907etc.). 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
908watchers (timers, io watchers) are still active. 942watchers (timers, io watchers) are still active.
909 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
910=item $isset = $term->option ($optval[, $set]) 969=item $isset = $term->option ($optval[, $set])
911 970
912Returns true if the option specified by C<$optval> is enabled, and 971Returns true if the option specified by C<$optval> is enabled, and
913optionally 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
914C<%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.
… …
916Here 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
917source file F</src/optinc.h> to see the actual list: 976source file F</src/optinc.h> to see the actual list:
918 977
919 borderLess console cursorBlink cursorUnderline hold iconic insecure 978 borderLess console cursorBlink cursorUnderline hold iconic insecure
920 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 979 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
921 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 980 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
922 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 981 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
923 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 982 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
924 tripleclickwords utmpInhibit visualBell 983 transparent tripleclickwords utmpInhibit visualBell
925 984
926=item $value = $term->resource ($name[, $newval]) 985=item $value = $term->resource ($name[, $newval])
927 986
928Returns the current resource value associated with a given name and 987Returns the current resource value associated with a given name and
929optionally 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>
… …
946 1005
947 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1006 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
948 borderLess color cursorBlink cursorUnderline cutchars delete_key 1007 borderLess color cursorBlink cursorUnderline cutchars delete_key
949 display_name embed ext_bwidth fade font geometry hold iconName 1008 display_name embed ext_bwidth fade font geometry hold iconName
950 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1009 imFont imLocale inputMethod insecure int_bwidth intensityStyles
951 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1010 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
952 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1011 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
953 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1012 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
954 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1013 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
955 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1014 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
956 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1015 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
957 shade term_name title transparent transparent_all tripleclickwords 1016 secondaryScreen secondaryScroll selectstyle shade term_name title
958 utmpInhibit visualBell 1017 transient_for transparent transparent_all tripleclickwords utmpInhibit
1018 visualBell
959 1019
960=cut 1020=cut
961 1021
962sub resource($$;$) { 1022sub resource($$;$) {
963 my ($self, $name) = (shift, shift); 1023 my ($self, $name) = (shift, shift);
… …
1555 my $env = $self->{term}->env; 1615 my $env = $self->{term}->env;
1556 # 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.
1557 delete $env->{LC_ALL}; 1617 delete $env->{LC_ALL};
1558 $env->{LC_CTYPE} = $self->{term}->locale; 1618 $env->{LC_CTYPE} = $self->{term}->locale;
1559 1619
1560 urxvt::term->new ($env, $self->{term}->resource ("name"), 1620 urxvt::term->new ($env, "popup",
1561 "--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",
1562 "--transient-for" => $self->{term}->parent, 1624 "--transient-for" => $self->{term}->parent,
1563 "-display" => $self->{term}->display_id, 1625 "-display" => $self->{term}->display_id,
1564 "-pe" => "urxvt-popup") 1626 "-pe" => "urxvt-popup")
1565 or die "unable to create popup window\n"; 1627 or die "unable to create popup window\n";
1566} 1628}
… …
1618Start the timer. 1680Start the timer.
1619 1681
1620=item $timer = $timer->start ($tstamp) 1682=item $timer = $timer->start ($tstamp)
1621 1683
1622Set 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>.
1623 1689
1624=item $timer = $timer->stop 1690=item $timer = $timer->stop
1625 1691
1626Stop the timer. 1692Stop the timer.
1627 1693

Diff Legend

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