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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.111 by root, Thu Jan 19 19:52:54 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
317=item on_start $term 330=item on_start $term
318 331
319Called at the very end of initialisation of a new terminal, just before 332Called at the very end of initialisation of a new terminal, just before
320returning to the mainloop. 333returning to the mainloop.
321 334
335=item on_child_start $term, $pid
336
337Called just after the child process has been C<fork>ed.
338
339=item on_child_exit $term, $status
340
341Called just after the child process has exited. C<$status> is the status
342from C<waitpid>.
343
322=item on_sel_make $term, $eventtime 344=item on_sel_make $term, $eventtime
323 345
324Called whenever a selection has been made by the user, but before the 346Called 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 347selection text is copied, so changes to the beginning, end or type of the
326selection will be honored. 348selection will be honored.
433 455
434=item on_focus_out $term 456=item on_focus_out $term
435 457
436Called wheneever the window loses keyboard focus, before rxvt-unicode does 458Called wheneever the window loses keyboard focus, before rxvt-unicode does
437focus out processing. 459focus out processing.
460
461=item on_configure_notify $term, $event
438 462
439=item on_key_press $term, $event, $keysym, $octets 463=item on_key_press $term, $event, $keysym, $octets
440 464
441=item on_key_release $term, $event, $keysym 465=item on_key_release $term, $event, $keysym
442 466
620 my $msg = join "", @_; 644 my $msg = join "", @_;
621 $msg .= "\n" 645 $msg .= "\n"
622 unless $msg =~ /\n$/; 646 unless $msg =~ /\n$/;
623 urxvt::warn ($msg); 647 urxvt::warn ($msg);
624 }; 648 };
625
626 # %ENV is the original startup environment
627 delete $ENV{IFS};
628 delete $ENV{CDPATH};
629 delete $ENV{BASH_ENV};
630 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
631} 649}
632 650
633my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 651my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634 652
635sub verbose { 653sub verbose {
740 } 758 }
741 759
742 $retval 760 $retval
743} 761}
744 762
745sub exec_async(@) {
746 my $pid = fork;
747
748 return
749 if !defined $pid or $pid;
750
751 %ENV = %{ $TERM->env };
752
753 exec @_;
754 _exit 255;
755}
756
757# urxvt::term::extension 763# urxvt::term::extension
758 764
759package urxvt::term::extension; 765package urxvt::term::extension;
760 766
761sub enable { 767sub enable {
938 944
939Destroy the terminal object (close the window, free resources 945Destroy the terminal object (close the window, free resources
940etc.). 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
941watchers (timers, io watchers) are still active. 947watchers (timers, io watchers) are still active.
942 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
943=item $isset = $term->option ($optval[, $set]) 974=item $isset = $term->option ($optval[, $set])
944 975
945Returns true if the option specified by C<$optval> is enabled, and 976Returns true if the option specified by C<$optval> is enabled, and
946optionally 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
947C<%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.
949Here 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
950source file F</src/optinc.h> to see the actual list: 981source file F</src/optinc.h> to see the actual list:
951 982
952 borderLess console cursorBlink cursorUnderline hold iconic insecure 983 borderLess console cursorBlink cursorUnderline hold iconic insecure
953 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 984 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
954 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 985 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
955 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 986 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
956 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 987 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
957 tripleclickwords utmpInhibit visualBell 988 transparent tripleclickwords utmpInhibit visualBell
958 989
959=item $value = $term->resource ($name[, $newval]) 990=item $value = $term->resource ($name[, $newval])
960 991
961Returns the current resource value associated with a given name and 992Returns the current resource value associated with a given name and
962optionally 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>
979 1010
980 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1011 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
981 borderLess color cursorBlink cursorUnderline cutchars delete_key 1012 borderLess color cursorBlink cursorUnderline cutchars delete_key
982 display_name embed ext_bwidth fade font geometry hold iconName 1013 display_name embed ext_bwidth fade font geometry hold iconName
983 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1014 imFont imLocale inputMethod insecure int_bwidth intensityStyles
984 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1015 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
985 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1016 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1017 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1018 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1019 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1020 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990 shade term_name title transparent transparent_all tripleclickwords 1021 secondaryScreen secondaryScroll selectstyle shade term_name title
991 utmpInhibit visualBell 1022 transient_for transparent transparent_all tripleclickwords utmpInhibit
1023 visualBell
992 1024
993=cut 1025=cut
994 1026
995sub resource($$;$) { 1027sub resource($$;$) {
996 my ($self, $name) = (shift, shift); 1028 my ($self, $name) = (shift, shift);
1588 my $env = $self->{term}->env; 1620 my $env = $self->{term}->env;
1589 # 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.
1590 delete $env->{LC_ALL}; 1622 delete $env->{LC_ALL};
1591 $env->{LC_CTYPE} = $self->{term}->locale; 1623 $env->{LC_CTYPE} = $self->{term}->locale;
1592 1624
1593 urxvt::term->new ($env, $self->{term}->resource ("name"), 1625 urxvt::term->new ($env, "popup",
1594 "--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",
1595 "--transient-for" => $self->{term}->parent, 1629 "--transient-for" => $self->{term}->parent,
1596 "-display" => $self->{term}->display_id, 1630 "-display" => $self->{term}->display_id,
1597 "-pe" => "urxvt-popup") 1631 "-pe" => "urxvt-popup")
1598 or die "unable to create popup window\n"; 1632 or die "unable to create popup window\n";
1599} 1633}
1651Start the timer. 1685Start the timer.
1652 1686
1653=item $timer = $timer->start ($tstamp) 1687=item $timer = $timer->start ($tstamp)
1654 1688
1655Set the event trigger time to C<$tstamp> and start the timer. 1689Set the event trigger time to C<$tstamp> and start the timer.
1690
1691=item $timer = $timer->after ($delay)
1692
1693Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656 1694
1657=item $timer = $timer->stop 1695=item $timer = $timer->stop
1658 1696
1659Stop the timer. 1697Stop the timer.
1660 1698

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines