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.110 by root, Thu Jan 19 16:22:13 2006 UTC

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 93
94Other extensions can extend this popup menu by pushing a code reference onto 94Other 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. 95onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
96popup is displayed.
96 97
97It's sole argument is the popup menu, which can be modified. The selection 98It'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. 99is 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 100It 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 101string will be used as button text and the code reference will be called
102 103
103The following will add an entry C<a to b> that transforms all C<a>s in 104The 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 105the selection to C<b>s, but only if the selection currently contains any
105C<a>s: 106C<a>s:
106 107
107 push urxvt::ext::selection_popup::hook, sub { 108 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 109 /a/ ? ("a to be" => sub { s/a/b/g }
109 : () 110 : ()
110 }; 111 };
111 112
112=item searchable-scrollback<hotkey> (enabled by default) 113=item searchable-scrollback<hotkey> (enabled by default)
143 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/
144 145
145And 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
146paste directly into your (vi :) editor: 147paste directly into your (vi :) editor:
147 148
148 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/
149 150
150Of 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 :)
151 152
152To expand the example above to typical perl error messages ("XXX at 153To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution: 154FILENAME line YYY."), you need a slightly more elaborate solution:
154 155
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 156 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156 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/
157 158
158The 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
159every error message as a selection pattern, and the second line transforms 160every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file. 161the message into vi commands to load the file.
161 162
163 164
164Uses 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
165make them clickable. When middle-clicked, the program specified in the 166make them clickable. When middle-clicked, the program specified in the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with 167resource C<urlLauncher> (default C<x-www-browser>) will be started with
167the URL as first argument. 168the URL as first argument.
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
168 177
169=item block-graphics-to-ascii 178=item block-graphics-to-ascii
170 179
171A 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,
172by replacing all line-drawing characters (U+2500 .. U+259F) by a 181by replacing all line-drawing characters (U+2500 .. U+259F) by a
317=item on_start $term 326=item on_start $term
318 327
319Called 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
320returning to the mainloop. 329returning to the mainloop.
321 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
322=item on_sel_make $term, $eventtime 340=item on_sel_make $term, $eventtime
323 341
324Called 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
325selection 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
326selection will be honored. 344selection will be honored.
433 451
434=item on_focus_out $term 452=item on_focus_out $term
435 453
436Called wheneever the window loses keyboard focus, before rxvt-unicode does 454Called wheneever the window loses keyboard focus, before rxvt-unicode does
437focus out processing. 455focus out processing.
456
457=item on_configure_notify $term, $event
438 458
439=item on_key_press $term, $event, $keysym, $octets 459=item on_key_press $term, $event, $keysym, $octets
440 460
441=item on_key_release $term, $event, $keysym 461=item on_key_release $term, $event, $keysym
442 462
620 my $msg = join "", @_; 640 my $msg = join "", @_;
621 $msg .= "\n" 641 $msg .= "\n"
622 unless $msg =~ /\n$/; 642 unless $msg =~ /\n$/;
623 urxvt::warn ($msg); 643 urxvt::warn ($msg);
624 }; 644 };
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} 645}
632 646
633my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 647my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634 648
635sub verbose { 649sub verbose {
740 } 754 }
741 755
742 $retval 756 $retval
743} 757}
744 758
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 759# urxvt::term::extension
758 760
759package urxvt::term::extension; 761package urxvt::term::extension;
760 762
761sub enable { 763sub enable {
938 940
939Destroy the terminal object (close the window, free resources 941Destroy the terminal object (close the window, free resources
940etc.). 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
941watchers (timers, io watchers) are still active. 943watchers (timers, io watchers) are still active.
942 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
943=item $isset = $term->option ($optval[, $set]) 970=item $isset = $term->option ($optval[, $set])
944 971
945Returns true if the option specified by C<$optval> is enabled, and 972Returns true if the option specified by C<$optval> is enabled, and
946optionally 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
947C<%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.
949Here 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
950source file F</src/optinc.h> to see the actual list: 977source file F</src/optinc.h> to see the actual list:
951 978
952 borderLess console cursorBlink cursorUnderline hold iconic insecure 979 borderLess console cursorBlink cursorUnderline hold iconic insecure
953 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 980 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
954 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 981 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
955 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 982 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
956 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 983 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
957 tripleclickwords utmpInhibit visualBell 984 transparent tripleclickwords utmpInhibit visualBell
958 985
959=item $value = $term->resource ($name[, $newval]) 986=item $value = $term->resource ($name[, $newval])
960 987
961Returns the current resource value associated with a given name and 988Returns the current resource value associated with a given name and
962optionally 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>
979 1006
980 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1007 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
981 borderLess color cursorBlink cursorUnderline cutchars delete_key 1008 borderLess color cursorBlink cursorUnderline cutchars delete_key
982 display_name embed ext_bwidth fade font geometry hold iconName 1009 display_name embed ext_bwidth fade font geometry hold iconName
983 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1010 imFont imLocale inputMethod insecure int_bwidth intensityStyles
984 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1011 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
985 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1012 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1013 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1014 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1015 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1016 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990 shade term_name title transparent transparent_all tripleclickwords 1017 secondaryScreen secondaryScroll selectstyle shade term_name title
991 utmpInhibit visualBell 1018 transient_for transparent transparent_all tripleclickwords utmpInhibit
1019 visualBell
992 1020
993=cut 1021=cut
994 1022
995sub resource($$;$) { 1023sub resource($$;$) {
996 my ($self, $name) = (shift, shift); 1024 my ($self, $name) = (shift, shift);
1588 my $env = $self->{term}->env; 1616 my $env = $self->{term}->env;
1589 # 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.
1590 delete $env->{LC_ALL}; 1618 delete $env->{LC_ALL};
1591 $env->{LC_CTYPE} = $self->{term}->locale; 1619 $env->{LC_CTYPE} = $self->{term}->locale;
1592 1620
1593 urxvt::term->new ($env, $self->{term}->resource ("name"), 1621 urxvt::term->new ($env, "popup",
1594 "--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",
1595 "--transient-for" => $self->{term}->parent, 1625 "--transient-for" => $self->{term}->parent,
1596 "-display" => $self->{term}->display_id, 1626 "-display" => $self->{term}->display_id,
1597 "-pe" => "urxvt-popup") 1627 "-pe" => "urxvt-popup")
1598 or die "unable to create popup window\n"; 1628 or die "unable to create popup window\n";
1599} 1629}
1651Start the timer. 1681Start the timer.
1652 1682
1653=item $timer = $timer->start ($tstamp) 1683=item $timer = $timer->start ($tstamp)
1654 1684
1655Set 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>.
1656 1690
1657=item $timer = $timer->stop 1691=item $timer = $timer->stop
1658 1692
1659Stop the timer. 1693Stop the timer.
1660 1694

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines