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.106 by root, Wed Jan 18 19:44:22 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 };
93 111
94=item searchable-scrollback<hotkey> (enabled by default) 112=item searchable-scrollback<hotkey> (enabled by default)
95 113
96Adds regex search functionality to the scrollback buffer, triggered 114Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 115by a hotkey (default: C<M-s>). While in search mode, normal terminal
… …
146Uses per-line display filtering (C<on_line_update>) to underline urls and 164Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the 165make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 166resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 167the URL as first argument.
150 168
169=item automove-background
170
171This is basically a one-line extension that dynamically changes the background pixmap offset
172to the window position, in effect creating the same effect as pseudo transparency with
173a custom pixmap. No scaling is supported in this mode. Exmaple:
174
175 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
176
151=item block-graphics-to-ascii 177=item block-graphics-to-ascii
152 178
153A not very useful example of filtering all text output to the terminal, 179A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 180by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 181similar-looking ascii character.
… …
161=item example-refresh-hooks 187=item example-refresh-hooks
162 188
163Displays a very simple digital clock in the upper right corner of the 189Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own 190window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 191overlays or changes.
192
193=item selection-pastebin
194
195This is a little rarely useful extension that Uploads the selection as
196textfile to a remote site (or does other things). (The implementation is
197not currently secure for use in a multiuser environment as it writes to
198F</tmp> directly.).
199
200It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
201i.e.
202
203 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
204
205Pressing this combination runs a command with C<%> replaced by the name of
206the textfile. This command can be set via a resource:
207
208 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
209
210And the default is likely not useful to anybody but the few people around
211here :)
212
213The name of the textfile is the hex encoded md5 sum of the selection, so
214the same content should lead to the same filename.
215
216After a successful upload the selection will be replaced by the text given
217in the C<selection-pastebin-url> resource (again, the % is the placeholder
218for the filename):
219
220 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 221
167=back 222=back
168 223
169=head1 API DOCUMENTATION 224=head1 API DOCUMENTATION
170 225
… …
387=item on_focus_out $term 442=item on_focus_out $term
388 443
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 444Called wheneever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 445focus out processing.
391 446
447=item on_configure_notify $term, $event
448
392=item on_key_press $term, $event, $keysym, $octets 449=item on_key_press $term, $event, $keysym, $octets
393 450
394=item on_key_release $term, $event, $keysym 451=item on_key_release $term, $event, $keysym
395 452
396=item on_button_press $term, $event 453=item on_button_press $term, $event
… …
480 537
481Using this function has the advantage that its output ends up in the 538Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 539correct place, e.g. on stderr of the connecting urxvtc client.
483 540
484Messages have a size limit of 1023 bytes currently. 541Messages 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 542
492=item $time = urxvt::NOW 543=item $time = urxvt::NOW
493 544
494Returns the "current time" (as per the event loop). 545Returns the "current time" (as per the event loop).
495 546
… …
572=back 623=back
573 624
574=cut 625=cut
575 626
576BEGIN { 627BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 628 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 629 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 630 my $msg = join "", @_;
582 $msg .= "\n" 631 $msg .= "\n"
583 unless $msg =~ /\n$/; 632 unless $msg =~ /\n$/;
… …
596sub verbose { 645sub verbose {
597 my ($level, $msg) = @_; 646 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 647 warn "$msg\n" if $level <= $verbosity;
599} 648}
600 649
601my $extension_pkg = "extension0000";
602my %extension_pkg; 650my %extension_pkg;
603 651
604# load a single script into its own package, once only 652# load a single script into its own package, once only
605sub extension_package($) { 653sub extension_package($) {
606 my ($path) = @_; 654 my ($path) = @_;
607 655
656 no strict 'refs';
657
608 $extension_pkg{$path} ||= do { 658 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 659 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g;
662 $pkg = "urxvt::ext::$pkg";
610 663
611 verbose 3, "loading extension '$path' into package '$pkg'"; 664 verbose 3, "loading extension '$path' into package '$pkg'";
612 665
613 open my $fh, "<:raw", $path 666 open my $fh, "<:raw", $path
614 or die "$path: $!"; 667 or die "$path: $!";
615 668
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
616 my $source = untaint 671 my $source =
617 "package $pkg; use strict; use utf8;\n" 672 "package $pkg; use strict; use utf8;\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 673 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 674 . (do { local $/; <$fh> })
621 . "\n};\n1"; 675 . "\n};\n1";
622 676
623 eval $source 677 eval $source
… …
905Here is a a likely non-exhaustive list of option names, please see the 959Here is a a likely non-exhaustive list of option names, please see the
906source file F</src/optinc.h> to see the actual list: 960source file F</src/optinc.h> to see the actual list:
907 961
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 962 borderLess console cursorBlink cursorUnderline hold iconic insecure
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 963 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 964 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 965 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 966 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913 tripleclickwords utmpInhibit visualBell 967 transparent tripleclickwords utmpInhibit visualBell
914 968
915=item $value = $term->resource ($name[, $newval]) 969=item $value = $term->resource ($name[, $newval])
916 970
917Returns the current resource value associated with a given name and 971Returns the current resource value associated with a given name and
918optionally sets a new value. Setting values is most useful in the C<init> 972optionally sets a new value. Setting values is most useful in the C<init>
… …
935 989
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 990 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 991 borderLess color cursorBlink cursorUnderline cutchars delete_key
938 display_name embed ext_bwidth fade font geometry hold iconName 992 display_name embed ext_bwidth fade font geometry hold iconName
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 993 imFont imLocale inputMethod insecure int_bwidth intensityStyles
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 994 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 995 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 996 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 997 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 998 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 999 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1000 secondaryScreen secondaryScroll selectstyle shade term_name title
947 utmpInhibit visualBell 1001 transient_for transparent transparent_all tripleclickwords utmpInhibit
1002 visualBell
948 1003
949=cut 1004=cut
950 1005
951sub resource($$;$) { 1006sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1007 my ($self, $name) = (shift, shift);
… …
1544 my $env = $self->{term}->env; 1599 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1600 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL}; 1601 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1602 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1603
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1604 urxvt::term->new ($env, "popup",
1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1605 "--perl-lib" => "", "--perl-ext-common" => "",
1606 "-pty-fd" => -1, "-sl" => 0,
1607 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551 "--transient-for" => $self->{term}->parent, 1608 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1609 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1610 "-pe" => "urxvt-popup")
1554 or die "unable to create popup window\n"; 1611 or die "unable to create popup window\n";
1555} 1612}
… …
1607Start the timer. 1664Start the timer.
1608 1665
1609=item $timer = $timer->start ($tstamp) 1666=item $timer = $timer->start ($tstamp)
1610 1667
1611Set the event trigger time to C<$tstamp> and start the timer. 1668Set the event trigger time to C<$tstamp> and start the timer.
1669
1670=item $timer = $timer->after ($delay)
1671
1672Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612 1673
1613=item $timer = $timer->stop 1674=item $timer = $timer->stop
1614 1675
1615Stop the timer. 1676Stop the timer.
1616 1677

Diff Legend

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