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.98 by root, Tue Jan 17 17:01:54 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.
… …
165overlays or changes. 192overlays or changes.
166 193
167=item selection-pastebin 194=item selection-pastebin
168 195
169This is a little rarely useful extension that Uploads the selection as 196This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things). 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.).
171 200
172It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 201It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173i.e. 202i.e.
174 203
175 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 204 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
… …
297=item on_start $term 326=item on_start $term
298 327
299Called 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
300returning to the mainloop. 329returning to the mainloop.
301 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
302=item on_sel_make $term, $eventtime 340=item on_sel_make $term, $eventtime
303 341
304Called 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
305selection 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
306selection will be honored. 344selection will be honored.
… …
413 451
414=item on_focus_out $term 452=item on_focus_out $term
415 453
416Called wheneever the window loses keyboard focus, before rxvt-unicode does 454Called wheneever the window loses keyboard focus, before rxvt-unicode does
417focus out processing. 455focus out processing.
456
457=item on_configure_notify $term, $event
418 458
419=item on_key_press $term, $event, $keysym, $octets 459=item on_key_press $term, $event, $keysym, $octets
420 460
421=item on_key_release $term, $event, $keysym 461=item on_key_release $term, $event, $keysym
422 462
… …
593=back 633=back
594 634
595=cut 635=cut
596 636
597BEGIN { 637BEGIN {
598 urxvt->bootstrap;
599
600 # overwrite perl's warn 638 # overwrite perl's warn
601 *CORE::GLOBAL::warn = sub { 639 *CORE::GLOBAL::warn = sub {
602 my $msg = join "", @_; 640 my $msg = join "", @_;
603 $msg .= "\n" 641 $msg .= "\n"
604 unless $msg =~ /\n$/; 642 unless $msg =~ /\n$/;
605 urxvt::warn ($msg); 643 urxvt::warn ($msg);
606 }; 644 };
607
608 # %ENV is the original startup environment
609 delete $ENV{IFS};
610 delete $ENV{CDPATH};
611 delete $ENV{BASH_ENV};
612 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613} 645}
614 646
615my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 647my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616 648
617sub verbose { 649sub verbose {
618 my ($level, $msg) = @_; 650 my ($level, $msg) = @_;
619 warn "$msg\n" if $level <= $verbosity; 651 warn "$msg\n" if $level <= $verbosity;
620} 652}
621 653
622my $extension_pkg = "extension0000";
623my %extension_pkg; 654my %extension_pkg;
624 655
625# load a single script into its own package, once only 656# load a single script into its own package, once only
626sub extension_package($) { 657sub extension_package($) {
627 my ($path) = @_; 658 my ($path) = @_;
628 659
660 no strict 'refs';
661
629 $extension_pkg{$path} ||= do { 662 $extension_pkg{$path} ||= do {
630 my $pkg = "urxvt::" . ($extension_pkg++); 663 $path =~ /([^\/\\]+)$/;
664 my $pkg = $1;
665 $pkg =~ s/[^[:word:]]/_/g;
666 $pkg = "urxvt::ext::$pkg";
631 667
632 verbose 3, "loading extension '$path' into package '$pkg'"; 668 verbose 3, "loading extension '$path' into package '$pkg'";
633 669
634 open my $fh, "<:raw", $path 670 open my $fh, "<:raw", $path
635 or die "$path: $!"; 671 or die "$path: $!";
636 672
673 @{"$pkg\::ISA"} = urxvt::term::extension::;
674
637 my $source = 675 my $source =
638 "package $pkg; use strict; use utf8;\n" 676 "package $pkg; use strict; use utf8;\n"
639 . "use base urxvt::term::extension::;\n"
640 . "#line 1 \"$path\"\n{\n" 677 . "#line 1 \"$path\"\n{\n"
641 . (do { local $/; <$fh> }) 678 . (do { local $/; <$fh> })
642 . "\n};\n1"; 679 . "\n};\n1";
643 680
644 eval $source 681 eval $source
… …
717 } 754 }
718 755
719 $retval 756 $retval
720} 757}
721 758
722sub exec_async(@) {
723 my $pid = fork;
724
725 return
726 if !defined $pid or $pid;
727
728 %ENV = %{ $TERM->env };
729
730 exec @_;
731 _exit 255;
732}
733
734# urxvt::term::extension 759# urxvt::term::extension
735 760
736package urxvt::term::extension; 761package urxvt::term::extension;
737 762
738sub enable { 763sub enable {
… …
915 940
916Destroy the terminal object (close the window, free resources 941Destroy the terminal object (close the window, free resources
917etc.). 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
918watchers (timers, io watchers) are still active. 943watchers (timers, io watchers) are still active.
919 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
920=item $isset = $term->option ($optval[, $set]) 970=item $isset = $term->option ($optval[, $set])
921 971
922Returns true if the option specified by C<$optval> is enabled, and 972Returns true if the option specified by C<$optval> is enabled, and
923optionally 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
924C<%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.
… …
926Here 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
927source file F</src/optinc.h> to see the actual list: 977source file F</src/optinc.h> to see the actual list:
928 978
929 borderLess console cursorBlink cursorUnderline hold iconic insecure 979 borderLess console cursorBlink cursorUnderline hold iconic insecure
930 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 980 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 981 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 982 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 983 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934 tripleclickwords utmpInhibit visualBell 984 transparent tripleclickwords utmpInhibit visualBell
935 985
936=item $value = $term->resource ($name[, $newval]) 986=item $value = $term->resource ($name[, $newval])
937 987
938Returns the current resource value associated with a given name and 988Returns the current resource value associated with a given name and
939optionally 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>
… …
956 1006
957 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1007 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958 borderLess color cursorBlink cursorUnderline cutchars delete_key 1008 borderLess color cursorBlink cursorUnderline cutchars delete_key
959 display_name embed ext_bwidth fade font geometry hold iconName 1009 display_name embed ext_bwidth fade font geometry hold iconName
960 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1010 imFont imLocale inputMethod insecure int_bwidth intensityStyles
961 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1011 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1012 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1013 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1014 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1015 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1016 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967 shade term_name title transparent transparent_all tripleclickwords 1017 secondaryScreen secondaryScroll selectstyle shade term_name title
968 utmpInhibit visualBell 1018 transient_for transparent transparent_all tripleclickwords utmpInhibit
1019 visualBell
969 1020
970=cut 1021=cut
971 1022
972sub resource($$;$) { 1023sub resource($$;$) {
973 my ($self, $name) = (shift, shift); 1024 my ($self, $name) = (shift, shift);
… …
1565 my $env = $self->{term}->env; 1616 my $env = $self->{term}->env;
1566 # 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.
1567 delete $env->{LC_ALL}; 1618 delete $env->{LC_ALL};
1568 $env->{LC_CTYPE} = $self->{term}->locale; 1619 $env->{LC_CTYPE} = $self->{term}->locale;
1569 1620
1570 urxvt::term->new ($env, $self->{term}->resource ("name"), 1621 urxvt::term->new ($env, "popup",
1571 "--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",
1572 "--transient-for" => $self->{term}->parent, 1625 "--transient-for" => $self->{term}->parent,
1573 "-display" => $self->{term}->display_id, 1626 "-display" => $self->{term}->display_id,
1574 "-pe" => "urxvt-popup") 1627 "-pe" => "urxvt-popup")
1575 or die "unable to create popup window\n"; 1628 or die "unable to create popup window\n";
1576} 1629}
… …
1628Start the timer. 1681Start the timer.
1629 1682
1630=item $timer = $timer->start ($tstamp) 1683=item $timer = $timer->start ($tstamp)
1631 1684
1632Set 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>.
1633 1690
1634=item $timer = $timer->stop 1691=item $timer = $timer->stop
1635 1692
1636Stop the timer. 1693Stop the timer.
1637 1694

Diff Legend

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