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.94 by root, Sun Jan 15 06:02:41 2006 UTC vs.
Revision 1.109 by root, Thu Jan 19 16:07:09 2006 UTC

… …
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 67
68You can look at the source of the selection extension to see more 68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 69interesting uses, such as parsing a line from beginning to end.
70 70
71This extension also offers the following bindable keyboard command: 71This extension also offers following bindable keyboard commands:
72 72
73=over 4 73=over 4
74 74
75=item rot13 75=item rot13
76 76
… …
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 };
111
112Don't run it in a hook, otherwise the menu will grow and grow. Instead put
113it at the toplevel of your extension.
93 114
94=item searchable-scrollback<hotkey> (enabled by default) 115=item searchable-scrollback<hotkey> (enabled by default)
95 116
96Adds regex search functionality to the scrollback buffer, triggered 117Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 118by 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/ 146 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 147
127And this example matches the same,but replaces it with vi-commands you can 148And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 149paste directly into your (vi :) editor:
129 150
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 151 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 152
132Of course, this can be modified to suit your needs and your editor :) 153Of course, this can be modified to suit your needs and your editor :)
133 154
134To expand the example above to typical perl error messages ("XXX at 155To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 156FILENAME line YYY."), you need a slightly more elaborate solution:
136 157
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 158 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 159 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139 160
140The first line tells the selection code to treat the unchanging part of 161The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms 162every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 163the message into vi commands to load the file.
143 164
… …
146Uses per-line display filtering (C<on_line_update>) to underline urls and 167Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 168make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 169resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 170the URL as first argument.
150 171
172=item automove-background
173
174This is basically a one-line extension that dynamically changes the background pixmap offset
175to the window position, in effect creating the same effect as pseudo transparency with
176a custom pixmap. No scaling is supported in this mode. Exmaple:
177
178 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
179
151=item block-graphics-to-ascii 180=item block-graphics-to-ascii
152 181
153A not very useful example of filtering all text output to the terminal, 182A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 183by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 184similar-looking ascii character.
… …
161=item example-refresh-hooks 190=item example-refresh-hooks
162 191
163Displays a very simple digital clock in the upper right corner of the 192Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own 193window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 194overlays or changes.
195
196=item selection-pastebin
197
198This is a little rarely useful extension that Uploads the selection as
199textfile to a remote site (or does other things). (The implementation is
200not currently secure for use in a multiuser environment as it writes to
201F</tmp> directly.).
202
203It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
204i.e.
205
206 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
207
208Pressing this combination runs a command with C<%> replaced by the name of
209the textfile. This command can be set via a resource:
210
211 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
212
213And the default is likely not useful to anybody but the few people around
214here :)
215
216The name of the textfile is the hex encoded md5 sum of the selection, so
217the same content should lead to the same filename.
218
219After a successful upload the selection will be replaced by the text given
220in the C<selection-pastebin-url> resource (again, the % is the placeholder
221for the filename):
222
223 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 224
167=back 225=back
168 226
169=head1 API DOCUMENTATION 227=head1 API DOCUMENTATION
170 228
… …
270=item on_start $term 328=item on_start $term
271 329
272Called at the very end of initialisation of a new terminal, just before 330Called at the very end of initialisation of a new terminal, just before
273returning to the mainloop. 331returning to the mainloop.
274 332
333=item on_child_start $term, $pid
334
335Called just after the child process has been C<fork>ed.
336
337=item on_child_exit $term, $status
338
339Called just after the child process has exited. C<$status> is the status
340from C<waitpid>.
341
275=item on_sel_make $term, $eventtime 342=item on_sel_make $term, $eventtime
276 343
277Called whenever a selection has been made by the user, but before the 344Called whenever a selection has been made by the user, but before the
278selection text is copied, so changes to the beginning, end or type of the 345selection text is copied, so changes to the beginning, end or type of the
279selection will be honored. 346selection will be honored.
… …
387=item on_focus_out $term 454=item on_focus_out $term
388 455
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 456Called wheneever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 457focus out processing.
391 458
459=item on_configure_notify $term, $event
460
392=item on_key_press $term, $event, $keysym, $octets 461=item on_key_press $term, $event, $keysym, $octets
393 462
394=item on_key_release $term, $event, $keysym 463=item on_key_release $term, $event, $keysym
395 464
396=item on_button_press $term, $event 465=item on_button_press $term, $event
… …
480 549
481Using this function has the advantage that its output ends up in the 550Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 551correct place, e.g. on stderr of the connecting urxvtc client.
483 552
484Messages have a size limit of 1023 bytes currently. 553Messages have a size limit of 1023 bytes currently.
485
486=item $is_safe = urxvt::safe
487
488Returns true when it is safe to do potentially unsafe things, such as
489evaluating perl code specified by the user. This is true when urxvt was
490started setuid or setgid.
491 554
492=item $time = urxvt::NOW 555=item $time = urxvt::NOW
493 556
494Returns the "current time" (as per the event loop). 557Returns the "current time" (as per the event loop).
495 558
… …
572=back 635=back
573 636
574=cut 637=cut
575 638
576BEGIN { 639BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 640 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 641 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 642 my $msg = join "", @_;
582 $msg .= "\n" 643 $msg .= "\n"
583 unless $msg =~ /\n$/; 644 unless $msg =~ /\n$/;
584 urxvt::warn ($msg); 645 urxvt::warn ($msg);
585 }; 646 };
586
587 # %ENV is the original startup environment
588 delete $ENV{IFS};
589 delete $ENV{CDPATH};
590 delete $ENV{BASH_ENV};
591 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
592} 647}
593 648
594my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 649my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595 650
596sub verbose { 651sub verbose {
597 my ($level, $msg) = @_; 652 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 653 warn "$msg\n" if $level <= $verbosity;
599} 654}
600 655
601my $extension_pkg = "extension0000";
602my %extension_pkg; 656my %extension_pkg;
603 657
604# load a single script into its own package, once only 658# load a single script into its own package, once only
605sub extension_package($) { 659sub extension_package($) {
606 my ($path) = @_; 660 my ($path) = @_;
607 661
662 no strict 'refs';
663
608 $extension_pkg{$path} ||= do { 664 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 665 $path =~ /([^\/\\]+)$/;
666 my $pkg = $1;
667 $pkg =~ s/[^[:word:]]/_/g;
668 $pkg = "urxvt::ext::$pkg";
610 669
611 verbose 3, "loading extension '$path' into package '$pkg'"; 670 verbose 3, "loading extension '$path' into package '$pkg'";
612 671
613 open my $fh, "<:raw", $path 672 open my $fh, "<:raw", $path
614 or die "$path: $!"; 673 or die "$path: $!";
615 674
675 @{"$pkg\::ISA"} = urxvt::term::extension::;
676
616 my $source = untaint 677 my $source =
617 "package $pkg; use strict; use utf8;\n" 678 "package $pkg; use strict; use utf8;\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 679 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 680 . (do { local $/; <$fh> })
621 . "\n};\n1"; 681 . "\n};\n1";
622 682
623 eval $source 683 eval $source
… …
696 } 756 }
697 757
698 $retval 758 $retval
699} 759}
700 760
701sub exec_async(@) {
702 my $pid = fork;
703
704 return
705 if !defined $pid or $pid;
706
707 %ENV = %{ $TERM->env };
708
709 exec @_;
710 _exit 255;
711}
712
713# urxvt::term::extension 761# urxvt::term::extension
714 762
715package urxvt::term::extension; 763package urxvt::term::extension;
716 764
717sub enable { 765sub enable {
… …
894 942
895Destroy the terminal object (close the window, free resources 943Destroy the terminal object (close the window, free resources
896etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 944etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897watchers (timers, io watchers) are still active. 945watchers (timers, io watchers) are still active.
898 946
947=item $term->exec_async ($cmd[, @args])
948
949Works like the combination of the C<fork>/C<exec> builtins, which executes
950("starts") programs in the background. This function takes care of setting
951the user environment before exec'ing the command (e.g. C<PATH>) and should
952be preferred over explicit calls to C<exec> or C<system>.
953
954Returns the pid of the subprocess or C<undef> on error.
955
956=cut
957
958sub exec_async {
959 my $self = shift;
960
961 my $pid = fork;
962
963 return $pid
964 if !defined $pid or $pid;
965
966 %ENV = %{ $self->env };
967
968 exec @_;
969 urxvt::_exit 255;
970}
971
899=item $isset = $term->option ($optval[, $set]) 972=item $isset = $term->option ($optval[, $set])
900 973
901Returns true if the option specified by C<$optval> is enabled, and 974Returns true if the option specified by C<$optval> is enabled, and
902optionally change it. All option values are stored by name in the hash 975optionally change it. All option values are stored by name in the hash
903C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 976C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
… …
905Here is a a likely non-exhaustive list of option names, please see the 978Here is a a likely non-exhaustive list of option names, please see the
906source file F</src/optinc.h> to see the actual list: 979source file F</src/optinc.h> to see the actual list:
907 980
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 981 borderLess console cursorBlink cursorUnderline hold iconic insecure
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 982 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 983 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 984 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 985 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913 tripleclickwords utmpInhibit visualBell 986 transparent tripleclickwords utmpInhibit visualBell
914 987
915=item $value = $term->resource ($name[, $newval]) 988=item $value = $term->resource ($name[, $newval])
916 989
917Returns the current resource value associated with a given name and 990Returns the current resource value associated with a given name and
918optionally sets a new value. Setting values is most useful in the C<init> 991optionally sets a new value. Setting values is most useful in the C<init>
… …
935 1008
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1009 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 1010 borderLess color cursorBlink cursorUnderline cutchars delete_key
938 display_name embed ext_bwidth fade font geometry hold iconName 1011 display_name embed ext_bwidth fade font geometry hold iconName
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1012 imFont imLocale inputMethod insecure int_bwidth intensityStyles
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1013 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1014 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1015 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1016 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1017 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1018 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1019 secondaryScreen secondaryScroll selectstyle shade term_name title
947 utmpInhibit visualBell 1020 transient_for transparent transparent_all tripleclickwords utmpInhibit
1021 visualBell
948 1022
949=cut 1023=cut
950 1024
951sub resource($$;$) { 1025sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1026 my ($self, $name) = (shift, shift);
… …
1544 my $env = $self->{term}->env; 1618 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1619 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL}; 1620 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1621 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1622
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1623 urxvt::term->new ($env, "popup",
1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1624 "--perl-lib" => "", "--perl-ext-common" => "",
1625 "-pty-fd" => -1, "-sl" => 0,
1626 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551 "--transient-for" => $self->{term}->parent, 1627 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1628 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1629 "-pe" => "urxvt-popup")
1554 or die "unable to create popup window\n"; 1630 or die "unable to create popup window\n";
1555} 1631}
… …
1607Start the timer. 1683Start the timer.
1608 1684
1609=item $timer = $timer->start ($tstamp) 1685=item $timer = $timer->start ($tstamp)
1610 1686
1611Set the event trigger time to C<$tstamp> and start the timer. 1687Set the event trigger time to C<$tstamp> and start the timer.
1688
1689=item $timer = $timer->after ($delay)
1690
1691Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612 1692
1613=item $timer = $timer->stop 1693=item $timer = $timer->stop
1614 1694
1615Stop the timer. 1695Stop the timer.
1616 1696

Diff Legend

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