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.92 by root, Fri Jan 13 04:59:04 2006 UTC vs.
Revision 1.103 by root, Wed Jan 18 11:05: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 };
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
… …
120 138
121For example, the following will transform selections of the form 139For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename 140C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>: 141$word>:
124 142
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 144
127And this example matches the same,but replaces it with vi-commands you can 145And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 146paste directly into your (vi :) editor:
129 147
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131 149
132Of course, this can be modified to suit your needs and your editor :) 150Of course, this can be modified to suit your needs and your editor :)
133 151
134To expand the example above to typical perl error messages ("XXX at 152To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 153FILENAME line YYY."), you need a slightly more elaborate solution:
… …
161=item example-refresh-hooks 179=item example-refresh-hooks
162 180
163Displays a very simple digital clock in the upper right corner of the 181Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own 182window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes. 183overlays or changes.
184
185=item selection-pastebin
186
187This is a little rarely useful extension that Uploads the selection as
188textfile to a remote site (or does other things). (The implementation is
189not currently secure for use in a multiuser environment as it writes to
190F</tmp> directly.).
191
192It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
193i.e.
194
195 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
196
197Pressing this combination runs a command with C<%> replaced by the name of
198the textfile. This command can be set via a resource:
199
200 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
201
202And the default is likely not useful to anybody but the few people around
203here :)
204
205The name of the textfile is the hex encoded md5 sum of the selection, so
206the same content should lead to the same filename.
207
208After a successful upload the selection will be replaced by the text given
209in the C<selection-pastebin-url> resource (again, the % is the placeholder
210for the filename):
211
212 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
166 213
167=back 214=back
168 215
169=head1 API DOCUMENTATION 216=head1 API DOCUMENTATION
170 217
… …
387=item on_focus_out $term 434=item on_focus_out $term
388 435
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 436Called wheneever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 437focus out processing.
391 438
439=item on_configure_notify $term, $event
440
392=item on_key_press $term, $event, $keysym, $octets 441=item on_key_press $term, $event, $keysym, $octets
393 442
394=item on_key_release $term, $event, $keysym 443=item on_key_release $term, $event, $keysym
395 444
396=item on_button_press $term, $event 445=item on_button_press $term, $event
… …
480 529
481Using this function has the advantage that its output ends up in the 530Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 531correct place, e.g. on stderr of the connecting urxvtc client.
483 532
484Messages have a size limit of 1023 bytes currently. 533Messages 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 534
492=item $time = urxvt::NOW 535=item $time = urxvt::NOW
493 536
494Returns the "current time" (as per the event loop). 537Returns the "current time" (as per the event loop).
495 538
… …
572=back 615=back
573 616
574=cut 617=cut
575 618
576BEGIN { 619BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 620 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 621 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 622 my $msg = join "", @_;
582 $msg .= "\n" 623 $msg .= "\n"
583 unless $msg =~ /\n$/; 624 unless $msg =~ /\n$/;
… …
596sub verbose { 637sub verbose {
597 my ($level, $msg) = @_; 638 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 639 warn "$msg\n" if $level <= $verbosity;
599} 640}
600 641
601my $extension_pkg = "extension0000";
602my %extension_pkg; 642my %extension_pkg;
603 643
604# load a single script into its own package, once only 644# load a single script into its own package, once only
605sub extension_package($) { 645sub extension_package($) {
606 my ($path) = @_; 646 my ($path) = @_;
607 647
648 no strict 'refs';
649
608 $extension_pkg{$path} ||= do { 650 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 651 $path =~ /([^\/\\]+)$/;
652 my $pkg = $1;
653 $pkg =~ s/[^[:word:]]/_/g;
654 $pkg = "urxvt::ext::$pkg";
610 655
611 verbose 3, "loading extension '$path' into package '$pkg'"; 656 verbose 3, "loading extension '$path' into package '$pkg'";
612 657
613 open my $fh, "<:raw", $path 658 open my $fh, "<:raw", $path
614 or die "$path: $!"; 659 or die "$path: $!";
615 660
661 @{"$pkg\::ISA"} = urxvt::term::extension::;
662
616 my $source = untaint 663 my $source =
617 "package $pkg; use strict; use utf8;\n" 664 "package $pkg; use strict; use utf8;\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 665 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 666 . (do { local $/; <$fh> })
621 . "\n};\n1"; 667 . "\n};\n1";
622 668
623 eval $source 669 eval $source
… …
1182 1228
1183=item $max_scrollback = $term->saveLines 1229=item $max_scrollback = $term->saveLines
1184 1230
1185=item $nrow_plus_saveLines = $term->total_rows 1231=item $nrow_plus_saveLines = $term->total_rows
1186 1232
1187=item $lines_in_scrollback = $term->nsaved 1233=item $topmost_scrollback_row = $term->top_row
1188 1234
1189Return various integers describing terminal characteristics. 1235Return various integers describing terminal characteristics.
1190 1236
1191=item $x_display = $term->display_id 1237=item $x_display = $term->display_id
1192 1238
… …
1220Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1266Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1221AltGr), the meta key (often Alt) and the num lock key, if applicable. 1267AltGr), the meta key (often Alt) and the num lock key, if applicable.
1222 1268
1223=item $view_start = $term->view_start ([$newvalue]) 1269=item $view_start = $term->view_start ([$newvalue])
1224 1270
1225Returns the negative row number of the topmost line. Minimum value is 1271Returns the row number of the topmost displayed line. Maximum value is
1226C<0>, which displays the normal terminal contents. Larger values scroll 1272C<0>, which displays the normal terminal contents. Lower values scroll
1227this many lines into the scrollback buffer. 1273this many lines into the scrollback buffer.
1228 1274
1229=item $term->want_refresh 1275=item $term->want_refresh
1230 1276
1231Requests a screen refresh. At the next opportunity, rxvt-unicode will 1277Requests a screen refresh. At the next opportunity, rxvt-unicode will
… …
1544 my $env = $self->{term}->env; 1590 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1591 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL}; 1592 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1593 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1594
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1595 urxvt::term->new ($env, "popup",
1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1596 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1551 "--transient-for" => $self->{term}->parent, 1597 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1598 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1599 "-pe" => "urxvt-popup")
1554 or die "unable to create popup window\n"; 1600 or die "unable to create popup window\n";
… …
1607Start the timer. 1653Start the timer.
1608 1654
1609=item $timer = $timer->start ($tstamp) 1655=item $timer = $timer->start ($tstamp)
1610 1656
1611Set the event trigger time to C<$tstamp> and start the timer. 1657Set the event trigger time to C<$tstamp> and start the timer.
1658
1659=item $timer = $timer->after ($delay)
1660
1661Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612 1662
1613=item $timer = $timer->stop 1663=item $timer = $timer->stop
1614 1664
1615Stop the timer. 1665Stop the timer.
1616 1666

Diff Legend

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