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.103 by root, Wed Jan 18 11:05:09 2006 UTC vs.
Revision 1.112 by root, Thu Jan 19 21:02:06 2006 UTC

34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
89 93
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 95text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 96evalution, web-browser starting etc.), depending on content.
93 97
94Other extensions can extend this popup menu by pushing a code reference onto 98Other extensions can extend this popup menu by pushing a code reference
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. 99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
96 101
97It's sole argument is the popup menu, which can be modified. The selection 102It'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. 103is 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 104It 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 105string will be used as button text and the code reference will be called
102 107
103The following will add an entry C<a to b> that transforms all C<a>s in 108The 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 109the selection to C<b>s, but only if the selection currently contains any
105C<a>s: 110C<a>s:
106 111
107 push urxvt::ext::selection_popup::hook, sub { 112 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 113 /a/ ? ("a to be" => sub { s/a/b/g }
109 : () 114 : ()
110 }; 115 };
111 116
112=item searchable-scrollback<hotkey> (enabled by default) 117=item searchable-scrollback<hotkey> (enabled by default)
143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144 149
145And this example matches the same,but replaces it with vi-commands you can 150And this example matches the same,but replaces it with vi-commands you can
146paste directly into your (vi :) editor: 151paste directly into your (vi :) editor:
147 152
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149 154
150Of course, this can be modified to suit your needs and your editor :) 155Of course, this can be modified to suit your needs and your editor :)
151 156
152To expand the example above to typical perl error messages ("XXX at 157To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution: 158FILENAME line YYY."), you need a slightly more elaborate solution:
154 159
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157 162
158The first line tells the selection code to treat the unchanging part of 163The first line tells the selection code to treat the unchanging part of
159every error message as a selection pattern, and the second line transforms 164every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file. 165the message into vi commands to load the file.
161 166
163 168
164Uses per-line display filtering (C<on_line_update>) to underline urls and 169Uses per-line display filtering (C<on_line_update>) to underline urls and
165make them clickable. When middle-clicked, the program specified in the 170make them clickable. When middle-clicked, the program specified in the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with 171resource C<urlLauncher> (default C<x-www-browser>) will be started with
167the URL as first argument. 172the URL as first argument.
173
174=item automove-background
175
176This is basically a one-line extension that dynamically changes the background pixmap offset
177to the window position, in effect creating the same effect as pseudo transparency with
178a custom pixmap. No scaling is supported in this mode. Exmaple:
179
180 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
168 181
169=item block-graphics-to-ascii 182=item block-graphics-to-ascii
170 183
171A not very useful example of filtering all text output to the terminal, 184A not very useful example of filtering all text output to the terminal,
172by replacing all line-drawing characters (U+2500 .. U+259F) by a 185by replacing all line-drawing characters (U+2500 .. U+259F) by a
290called whenever the relevant event happens. 303called whenever the relevant event happens.
291 304
292The first argument passed to them is an extension oject as described in 305The first argument passed to them is an extension oject as described in
293the in the C<Extension Objects> section. 306the in the C<Extension Objects> section.
294 307
295B<All> of these hooks must return a boolean value. If it is true, then the 308B<All> of these hooks must return a boolean value. If any of the called
296event counts as being I<consumed>, and the invocation of other hooks is 309hooks returns true, then the event counts as being I<consumed>, and the
297skipped, and the relevant action might not be carried out by the C++ code. 310relevant action might not be carried out by the C++ code.
298 311
299I<< When in doubt, return a false value (preferably C<()>). >> 312I<< When in doubt, return a false value (preferably C<()>). >>
300 313
301=over 4 314=over 4
302 315
303=item on_init $term 316=item on_init $term
304 317
305Called after a new terminal object has been initialized, but before 318Called after a new terminal object has been initialized, but before
306windows are created or the command gets run. Most methods are unsafe to 319windows are created or the command gets run. Most methods are unsafe to
307call or deliver senseless data, as terminal size and other characteristics 320call or deliver senseless data, as terminal size and other characteristics
308have not yet been determined. You can safely query and change resources, 321have not yet been determined. You can safely query and change resources
309though. 322and options, though. For many purposes the C<on_start> hook is a better
323place.
324
325=item on_start $term
326
327Called at the very end of initialisation of a new terminal, just before
328returning to the mainloop.
310 329
311=item on_reset $term 330=item on_reset $term
312 331
313Called after the screen is "reset" for any reason, such as resizing or 332Called after the screen is "reset" for any reason, such as resizing or
314control sequences. Here is where you can react on changes to size-related 333control sequences. Here is where you can react on changes to size-related
315variables. 334variables.
316 335
317=item on_start $term 336=item on_child_start $term, $pid
318 337
319Called at the very end of initialisation of a new terminal, just before 338Called just after the child process has been C<fork>ed.
320returning to the mainloop. 339
340=item on_child_exit $term, $status
341
342Called just after the child process has exited. C<$status> is the status
343from C<waitpid>.
321 344
322=item on_sel_make $term, $eventtime 345=item on_sel_make $term, $eventtime
323 346
324Called whenever a selection has been made by the user, but before the 347Called whenever a selection has been made by the user, but before the
325selection text is copied, so changes to the beginning, end or type of the 348selection text is copied, so changes to the beginning, end or type of the
622 my $msg = join "", @_; 645 my $msg = join "", @_;
623 $msg .= "\n" 646 $msg .= "\n"
624 unless $msg =~ /\n$/; 647 unless $msg =~ /\n$/;
625 urxvt::warn ($msg); 648 urxvt::warn ($msg);
626 }; 649 };
627
628 # %ENV is the original startup environment
629 delete $ENV{IFS};
630 delete $ENV{CDPATH};
631 delete $ENV{BASH_ENV};
632 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
633} 650}
634 651
635my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
636 653
637sub verbose { 654sub verbose {
718 if $verbosity >= 10; 735 if $verbosity >= 10;
719 736
720 keys %$cb; 737 keys %$cb;
721 738
722 while (my ($pkg, $cb) = each %$cb) { 739 while (my ($pkg, $cb) = each %$cb) {
723 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 740 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
724 and last;
725 741
726 if ($@) { 742 if ($@) {
727 $TERM->ungrab; # better to lose the grab than the session 743 $TERM->ungrab; # better to lose the grab than the session
728 warn $@; 744 warn $@;
729 } 745 }
740 # clear package 756 # clear package
741 %$TERM = (); 757 %$TERM = ();
742 } 758 }
743 759
744 $retval 760 $retval
745}
746
747sub exec_async(@) {
748 my $pid = fork;
749
750 return
751 if !defined $pid or $pid;
752
753 %ENV = %{ $TERM->env };
754
755 exec @_;
756 _exit 255;
757} 761}
758 762
759# urxvt::term::extension 763# urxvt::term::extension
760 764
761package urxvt::term::extension; 765package urxvt::term::extension;
940 944
941Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
942etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 946etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
943watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
944 948
949=item $term->exec_async ($cmd[, @args])
950
951Works like the combination of the C<fork>/C<exec> builtins, which executes
952("starts") programs in the background. This function takes care of setting
953the user environment before exec'ing the command (e.g. C<PATH>) and should
954be preferred over explicit calls to C<exec> or C<system>.
955
956Returns the pid of the subprocess or C<undef> on error.
957
958=cut
959
960sub exec_async {
961 my $self = shift;
962
963 my $pid = fork;
964
965 return $pid
966 if !defined $pid or $pid;
967
968 %ENV = %{ $self->env };
969
970 exec @_;
971 urxvt::_exit 255;
972}
973
945=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
946 975
947Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
948optionally change it. All option values are stored by name in the hash 977optionally change it. All option values are stored by name in the hash
949C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 978C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
951Here is a a likely non-exhaustive list of option names, please see the 980Here is a a likely non-exhaustive list of option names, please see the
952source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
953 982
954 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
955 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
956 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
957 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
958 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
959 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
960 989
961=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
962 991
963Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
964optionally sets a new value. Setting values is most useful in the C<init> 993optionally sets a new value. Setting values is most useful in the C<init>
981 1010
982 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
983 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
984 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
985 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
986 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
987 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
988 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
989 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
990 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
991 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
992 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
993 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
994 1024
995=cut 1025=cut
996 1026
997sub resource($$;$) { 1027sub resource($$;$) {
998 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
1591 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1621 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1592 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1593 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1594 1624
1595 urxvt::term->new ($env, "popup", 1625 urxvt::term->new ($env, "popup",
1596 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1626 "--perl-lib" => "", "--perl-ext-common" => "",
1627 "-pty-fd" => -1, "-sl" => 0,
1628 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1597 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1598 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1599 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1600 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1601} 1633}

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines