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.93 by root, Fri Jan 13 07:03:48 2006 UTC vs.
Revision 1.110 by root, Thu Jan 19 16:22:13 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
95onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
96popup is displayed.
97
98It's sole argument is the popup menu, which can be modified. The selection
99is in C<$_>, which can be used to decide wether to add something or not.
100It should either return nothing or a string and a code reference. The
101string will be used as button text and the code reference will be called
102when the button gets activated and should transform C<$_>.
103
104The following will add an entry C<a to b> that transforms all C<a>s in
105the selection to C<b>s, but only if the selection currently contains any
106C<a>s:
107
108 push @{ $self->{term}{selection_popup_hook} }, sub {
109 /a/ ? ("a to be" => sub { s/a/b/g }
110 : ()
111 };
93 112
94=item searchable-scrollback<hotkey> (enabled by default) 113=item searchable-scrollback<hotkey> (enabled by default)
95 114
96Adds regex search functionality to the scrollback buffer, triggered 115Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 116by 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/ 144 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 145
127And 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
128paste directly into your (vi :) editor: 147paste directly into your (vi :) editor:
129 148
130 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/
131 150
132Of 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 :)
133 152
134To expand the example above to typical perl error messages ("XXX at 153To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 154FILENAME line YYY."), you need a slightly more elaborate solution:
136 155
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 156 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 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/
139 158
140The 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
141every error message as a selection pattern, and the second line transforms 160every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 161the message into vi commands to load the file.
143 162
… …
146Uses 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
147make them clickable. When middle-clicked, the program specified in the 166make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 167resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument. 168the URL as first argument.
150 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
177
151=item block-graphics-to-ascii 178=item block-graphics-to-ascii
152 179
153A 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,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 181by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 182similar-looking ascii character.
… …
161=item example-refresh-hooks 188=item example-refresh-hooks
162 189
163Displays a very simple digital clock in the upper right corner of the 190Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own 191window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 192overlays or changes.
193
194=item selection-pastebin
195
196This is a little rarely useful extension that Uploads the selection as
197textfile to a remote site (or does other things). (The implementation is
198not currently secure for use in a multiuser environment as it writes to
199F</tmp> directly.).
200
201It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
202i.e.
203
204 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
205
206Pressing this combination runs a command with C<%> replaced by the name of
207the textfile. This command can be set via a resource:
208
209 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
210
211And the default is likely not useful to anybody but the few people around
212here :)
213
214The name of the textfile is the hex encoded md5 sum of the selection, so
215the same content should lead to the same filename.
216
217After a successful upload the selection will be replaced by the text given
218in the C<selection-pastebin-url> resource (again, the % is the placeholder
219for the filename):
220
221 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 222
167=back 223=back
168 224
169=head1 API DOCUMENTATION 225=head1 API DOCUMENTATION
170 226
… …
270=item on_start $term 326=item on_start $term
271 327
272Called 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
273returning to the mainloop. 329returning to the mainloop.
274 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
275=item on_sel_make $term, $eventtime 340=item on_sel_make $term, $eventtime
276 341
277Called 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
278selection 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
279selection will be honored. 344selection will be honored.
… …
387=item on_focus_out $term 452=item on_focus_out $term
388 453
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 454Called wheneever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 455focus out processing.
391 456
457=item on_configure_notify $term, $event
458
392=item on_key_press $term, $event, $keysym, $octets 459=item on_key_press $term, $event, $keysym, $octets
393 460
394=item on_key_release $term, $event, $keysym 461=item on_key_release $term, $event, $keysym
395 462
396=item on_button_press $term, $event 463=item on_button_press $term, $event
… …
480 547
481Using this function has the advantage that its output ends up in the 548Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 549correct place, e.g. on stderr of the connecting urxvtc client.
483 550
484Messages have a size limit of 1023 bytes currently. 551Messages 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 552
492=item $time = urxvt::NOW 553=item $time = urxvt::NOW
493 554
494Returns the "current time" (as per the event loop). 555Returns the "current time" (as per the event loop).
495 556
… …
572=back 633=back
573 634
574=cut 635=cut
575 636
576BEGIN { 637BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 638 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 639 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 640 my $msg = join "", @_;
582 $msg .= "\n" 641 $msg .= "\n"
583 unless $msg =~ /\n$/; 642 unless $msg =~ /\n$/;
584 urxvt::warn ($msg); 643 urxvt::warn ($msg);
585 }; 644 };
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} 645}
593 646
594my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 647my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595 648
596sub verbose { 649sub verbose {
597 my ($level, $msg) = @_; 650 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 651 warn "$msg\n" if $level <= $verbosity;
599} 652}
600 653
601my $extension_pkg = "extension0000";
602my %extension_pkg; 654my %extension_pkg;
603 655
604# load a single script into its own package, once only 656# load a single script into its own package, once only
605sub extension_package($) { 657sub extension_package($) {
606 my ($path) = @_; 658 my ($path) = @_;
607 659
660 no strict 'refs';
661
608 $extension_pkg{$path} ||= do { 662 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 663 $path =~ /([^\/\\]+)$/;
664 my $pkg = $1;
665 $pkg =~ s/[^[:word:]]/_/g;
666 $pkg = "urxvt::ext::$pkg";
610 667
611 verbose 3, "loading extension '$path' into package '$pkg'"; 668 verbose 3, "loading extension '$path' into package '$pkg'";
612 669
613 open my $fh, "<:raw", $path 670 open my $fh, "<:raw", $path
614 or die "$path: $!"; 671 or die "$path: $!";
615 672
673 @{"$pkg\::ISA"} = urxvt::term::extension::;
674
616 my $source = untaint 675 my $source =
617 "package $pkg; use strict; use utf8;\n" 676 "package $pkg; use strict; use utf8;\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 677 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 678 . (do { local $/; <$fh> })
621 . "\n};\n1"; 679 . "\n};\n1";
622 680
623 eval $source 681 eval $source
… …
696 } 754 }
697 755
698 $retval 756 $retval
699} 757}
700 758
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 759# urxvt::term::extension
714 760
715package urxvt::term::extension; 761package urxvt::term::extension;
716 762
717sub enable { 763sub enable {
… …
894 940
895Destroy the terminal object (close the window, free resources 941Destroy the terminal object (close the window, free resources
896etc.). 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
897watchers (timers, io watchers) are still active. 943watchers (timers, io watchers) are still active.
898 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
899=item $isset = $term->option ($optval[, $set]) 970=item $isset = $term->option ($optval[, $set])
900 971
901Returns true if the option specified by C<$optval> is enabled, and 972Returns true if the option specified by C<$optval> is enabled, and
902optionally 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
903C<%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.
… …
905Here 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
906source file F</src/optinc.h> to see the actual list: 977source file F</src/optinc.h> to see the actual list:
907 978
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 979 borderLess console cursorBlink cursorUnderline hold iconic insecure
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 980 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 981 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 982 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 983 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913 tripleclickwords utmpInhibit visualBell 984 transparent tripleclickwords utmpInhibit visualBell
914 985
915=item $value = $term->resource ($name[, $newval]) 986=item $value = $term->resource ($name[, $newval])
916 987
917Returns the current resource value associated with a given name and 988Returns the current resource value associated with a given name and
918optionally 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>
… …
935 1006
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1007 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 1008 borderLess color cursorBlink cursorUnderline cutchars delete_key
938 display_name embed ext_bwidth fade font geometry hold iconName 1009 display_name embed ext_bwidth fade font geometry hold iconName
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1010 imFont imLocale inputMethod insecure int_bwidth intensityStyles
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1011 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1012 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1013 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1014 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1015 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1016 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1017 secondaryScreen secondaryScroll selectstyle shade term_name title
947 utmpInhibit visualBell 1018 transient_for transparent transparent_all tripleclickwords utmpInhibit
1019 visualBell
948 1020
949=cut 1021=cut
950 1022
951sub resource($$;$) { 1023sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1024 my ($self, $name) = (shift, shift);
… …
1182 1254
1183=item $max_scrollback = $term->saveLines 1255=item $max_scrollback = $term->saveLines
1184 1256
1185=item $nrow_plus_saveLines = $term->total_rows 1257=item $nrow_plus_saveLines = $term->total_rows
1186 1258
1187=item $lines_in_scrollback = $term->nsaved 1259=item $topmost_scrollback_row = $term->top_row
1188 1260
1189Return various integers describing terminal characteristics. 1261Return various integers describing terminal characteristics.
1190 1262
1191=item $x_display = $term->display_id 1263=item $x_display = $term->display_id
1192 1264
… …
1220Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1292Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1221AltGr), the meta key (often Alt) and the num lock key, if applicable. 1293AltGr), the meta key (often Alt) and the num lock key, if applicable.
1222 1294
1223=item $view_start = $term->view_start ([$newvalue]) 1295=item $view_start = $term->view_start ([$newvalue])
1224 1296
1225Returns the negative row number of the topmost line. Minimum value is 1297Returns the row number of the topmost displayed line. Maximum value is
1226C<0>, which displays the normal terminal contents. Larger values scroll 1298C<0>, which displays the normal terminal contents. Lower values scroll
1227this many lines into the scrollback buffer. 1299this many lines into the scrollback buffer.
1228 1300
1229=item $term->want_refresh 1301=item $term->want_refresh
1230 1302
1231Requests a screen refresh. At the next opportunity, rxvt-unicode will 1303Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1544 my $env = $self->{term}->env; 1616 my $env = $self->{term}->env;
1545 # 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.
1546 delete $env->{LC_ALL}; 1618 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1619 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1620
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1621 urxvt::term->new ($env, "popup",
1550 "--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",
1551 "--transient-for" => $self->{term}->parent, 1625 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1626 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1627 "-pe" => "urxvt-popup")
1554 or die "unable to create popup window\n"; 1628 or die "unable to create popup window\n";
1555} 1629}
… …
1607Start the timer. 1681Start the timer.
1608 1682
1609=item $timer = $timer->start ($tstamp) 1683=item $timer = $timer->start ($tstamp)
1610 1684
1611Set 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>.
1612 1690
1613=item $timer = $timer->stop 1691=item $timer = $timer->stop
1614 1692
1615Stop the timer. 1693Stop the timer.
1616 1694

Diff Legend

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