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.68 by root, Mon Jan 9 20:00:31 2006 UTC vs.
Revision 1.94 by root, Sun Jan 15 06:02:41 2006 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31=head1 PREPACKAGED EXTENSIONS
32 32
33This section describes the extensiosn delivered with this version. You can 33This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44Intelligent selection. This extension tries to be more intelligent when 44(More) intelligent selection. This extension tries to be more intelligent
45the user extends selections (double-click). Right now, it tries to select 45when the user extends selections (double-click and further clicks). Right
46urls and complete shell-quoted arguments, which is very convenient, too, 46now, it tries to select words, urls and complete shell-quoted
47if your F<ls> supports C<--quoting-style=shell>. 47arguments, which is very convenient, too, if your F<ls> supports
48C<--quoting-style=shell>.
48 49
49It also offers the following bindable event: 50A double-click usually selects the word under the cursor, further clicks
51will enlarge the selection.
52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
71This extension also offers the following bindable keyboard command:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
64runtime. 86runtime.
65 87
66=item selection-popup (enabled by default) 88=item selection-popup (enabled by default)
67 89
68Binds 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
69text into various other formats/action. 91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content.
70 93
71=item digital-clock 94=item searchable-scrollback<hotkey> (enabled by default)
72 95
73Displays a digital clock using the built-in overlay. 96Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal
98input/output is suspended and a regex is displayed at the bottom of the
99screen.
100
101Inputting characters appends them to the regex and continues incremental
102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
108
109=item selection-autotransform
110
111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
124
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132Of course, this can be modified to suit your needs and your editor :)
133
134To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution:
136
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
139
140The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file.
74 143
75=item mark-urls 144=item mark-urls
76 145
77Uses per-line display filtering (C<on_line_update>) to underline urls. 146Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument.
78 150
79=item block-graphics-to-ascii 151=item block-graphics-to-ascii
80 152
81A not very useful example of filtering all text output to the terminal, 153A not very useful example of filtering all text output to the terminal,
82by replacing all line-drawing characters (U+2500 .. U+259F) by a 154by replacing all line-drawing characters (U+2500 .. U+259F) by a
83similar-looking ascii character. 155similar-looking ascii character.
84 156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
160
85=item example-refresh-hooks 161=item example-refresh-hooks
86 162
87Displays a very simple digital clock in the upper right corner of the 163Displays a very simple digital clock in the upper right corner of the
88window. Illustrates overwriting the refresh callbacks to create your own 164window. Illustrates overwriting the refresh callbacks to create your own
89overlays or changes. 165overlays or changes.
90 166
91=back 167=back
168
169=head1 API DOCUMENTATION
92 170
93=head2 General API Considerations 171=head2 General API Considerations
94 172
95All objects (such as terminals, time watchers etc.) are typical 173All objects (such as terminals, time watchers etc.) are typical
96reference-to-hash objects. The hash can be used to store anything you 174reference-to-hash objects. The hash can be used to store anything you
109=over 4 187=over 4
110 188
111=item $text 189=item $text
112 190
113Rxvt-unicodes special way of encoding text, where one "unicode" character 191Rxvt-unicodes special way of encoding text, where one "unicode" character
114always represents one screen cell. See L<row_t> for a discussion of this format. 192always represents one screen cell. See L<ROW_t> for a discussion of this format.
115 193
116=item $string 194=item $string
117 195
118A perl text string, with an emphasis on I<text>. It can store all unicode 196A perl text string, with an emphasis on I<text>. It can store all unicode
119characters and is to be distinguished with text encoded in a specific 197characters and is to be distinguished with text encoded in a specific
124Either binary data or - more common - a text string encoded in a 202Either binary data or - more common - a text string encoded in a
125locale-specific way. 203locale-specific way.
126 204
127=back 205=back
128 206
207=head2 Extension Objects
208
209Very perl extension is a perl class. A separate perl object is created
210for each terminal and each extension and passed as the first parameter to
211hooks. So extensions can use their C<$self> object without having to think
212about other extensions, with the exception of methods and members that
213begin with an underscore character C<_>: these are reserved for internal
214use.
215
216Although it isn't a C<urxvt::term> object, you can call all methods of the
217C<urxvt::term> class on this object.
218
219It has the following methods and data members:
220
221=over 4
222
223=item $urxvt_term = $self->{term}
224
225Returns the C<urxvt::term> object associated with this instance of the
226extension. This member I<must not> be changed in any way.
227
228=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
229
230Dynamically enable the given hooks (named without the C<on_> prefix) for
231this extension, replacing any previous hook. This is useful when you want
232to overwrite time-critical hooks only temporarily.
233
234=item $self->disable ($hook_name[, $hook_name..])
235
236Dynamically disable the given hooks.
237
238=back
239
129=head2 Hooks 240=head2 Hooks
130 241
131The following subroutines can be declared in extension files, and will be 242The following subroutines can be declared in extension files, and will be
132called whenever the relevant event happens. 243called whenever the relevant event happens.
133 244
134The first argument passed to them is an object private to each terminal 245The first argument passed to them is an extension oject as described in
135and extension package. You can call all C<urxvt::term> methods on it, but 246the in the C<Extension Objects> section.
136its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137object that is shared between all packages is stored in the C<term>
138member. It is, however, blessed intot he package of the extension script,
139so for all practical purposes you can treat an extension script as a class.
140 247
141All of them must return a boolean value. If it is true, then the event 248B<All> of these hooks must return a boolean value. If it is true, then the
142counts as being I<consumed>, and the invocation of other hooks is skipped, 249event counts as being I<consumed>, and the invocation of other hooks is
143and the relevant action might not be carried out by the C++ code. 250skipped, and the relevant action might not be carried out by the C++ code.
144 251
145When in doubt, return a false value (preferably C<()>). 252I<< When in doubt, return a false value (preferably C<()>). >>
146 253
147=over 4 254=over 4
148 255
149=item on_init $term 256=item on_init $term
150 257
185=item on_sel_extend $term 292=item on_sel_extend $term
186 293
187Called whenever the user tries to extend the selection (e.g. with a double 294Called whenever the user tries to extend the selection (e.g. with a double
188click) and is either supposed to return false (normal operation), or 295click) and is either supposed to return false (normal operation), or
189should extend the selection itelf and return true to suppress the built-in 296should extend the selection itelf and return true to suppress the built-in
190processing. 297processing. This can happen multiple times, as long as the callback
298returns true, it will be called on every further click by the user and is
299supposed to enlarge the selection more and more, if possible.
191 300
192See the F<selection> example extension. 301See the F<selection> example extension.
193 302
194=item on_view_change $term, $offset 303=item on_view_change $term, $offset
195 304
226can filter/change and output the text yourself by returning a true value 335can filter/change and output the text yourself by returning a true value
227and calling C<< $term->scr_add_lines >> yourself. Please note that this 336and calling C<< $term->scr_add_lines >> yourself. Please note that this
228might be very slow, however, as your hook is called for B<all> text being 337might be very slow, however, as your hook is called for B<all> text being
229output. 338output.
230 339
340=item on_tt_write $term, $octets
341
342Called whenever some data is written to the tty/pty and can be used to
343suppress or filter tty input.
344
231=item on_line_update $term, $row 345=item on_line_update $term, $row
232 346
233Called whenever a line was updated or changed. Can be used to filter 347Called whenever a line was updated or changed. Can be used to filter
234screen output (e.g. underline urls or other useless stuff). Only lines 348screen output (e.g. underline urls or other useless stuff). Only lines
235that are being shown will be filtered, and, due to performance reasons, 349that are being shown will be filtered, and, due to performance reasons,
257 371
258Called whenever the user presses a key combination that has a 372Called whenever the user presses a key combination that has a
259C<perl:string> action bound to it (see description of the B<keysym> 373C<perl:string> action bound to it (see description of the B<keysym>
260resource in the @@RXVT_NAME@@(1) manpage). 374resource in the @@RXVT_NAME@@(1) manpage).
261 375
376=item on_x_event $term, $event
377
378Called on every X event received on the vt window (and possibly other
379windows). Should only be used as a last resort. Most event structure
380members are not passed.
381
262=item on_focus_in $term 382=item on_focus_in $term
263 383
264Called whenever the window gets the keyboard focus, before rxvt-unicode 384Called whenever the window gets the keyboard focus, before rxvt-unicode
265does focus in processing. 385does focus in processing.
266 386
267=item on_focus_out $term 387=item on_focus_out $term
268 388
269Called wheneever the window loses keyboard focus, before rxvt-unicode does 389Called wheneever the window loses keyboard focus, before rxvt-unicode does
270focus out processing. 390focus out processing.
271 391
272=item on_key_press $term, $event, $octets 392=item on_key_press $term, $event, $keysym, $octets
273 393
274=item on_key_release $term, $event 394=item on_key_release $term, $event, $keysym
275 395
276=item on_button_press $term, $event 396=item on_button_press $term, $event
277 397
278=item on_button_release $term, $event 398=item on_button_release $term, $event
279 399
295 415
296subwindow. 416subwindow.
297 417
298=back 418=back
299 419
420=cut
421
422package urxvt;
423
424use utf8;
425use strict;
426use Carp ();
427use Scalar::Util ();
428use List::Util ();
429
430our $VERSION = 1;
431our $TERM;
432our @HOOKNAME;
433our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434our %OPTION;
435
436our $LIBDIR;
437our $RESNAME;
438our $RESCLASS;
439our $RXVTNAME;
440
300=head2 Variables in the C<urxvt> Package 441=head2 Variables in the C<urxvt> Package
301 442
302=over 4 443=over 4
444
445=item $urxvt::LIBDIR
446
447The rxvt-unicode library directory, where, among other things, the perl
448modules and scripts are stored.
449
450=item $urxvt::RESCLASS, $urxvt::RESCLASS
451
452The resource class and name rxvt-unicode uses to look up X resources.
453
454=item $urxvt::RXVTNAME
455
456The basename of the installed binaries, usually C<urxvt>.
303 457
304=item $urxvt::TERM 458=item $urxvt::TERM
305 459
306The current terminal. This variable stores the current C<urxvt::term> 460The current terminal. This variable stores the current C<urxvt::term>
307object, whenever a callback/hook is executing. 461object, whenever a callback/hook is executing.
309=back 463=back
310 464
311=head2 Functions in the C<urxvt> Package 465=head2 Functions in the C<urxvt> Package
312 466
313=over 4 467=over 4
314
315=item $term = new urxvt [arg...]
316
317Creates a new terminal, very similar as if you had started it with
318C<system $binfile, arg...>. Croaks (and probably outputs an error message)
319if the new instance couldn't be created. Returns C<undef> if the new
320instance didn't initialise perl, and the terminal object otherwise. The
321C<init> and C<start> hooks will be called during the call.
322 468
323=item urxvt::fatal $errormessage 469=item urxvt::fatal $errormessage
324 470
325Fatally aborts execution with the given error message. Avoid at all 471Fatally aborts execution with the given error message. Avoid at all
326costs! The only time this is acceptable is when the terminal process 472costs! The only time this is acceptable is when the terminal process
333that calls this function. 479that calls this function.
334 480
335Using this function has the advantage that its output ends up in the 481Using this function has the advantage that its output ends up in the
336correct place, e.g. on stderr of the connecting urxvtc client. 482correct place, e.g. on stderr of the connecting urxvtc client.
337 483
484Messages have a size limit of 1023 bytes currently.
485
338=item $is_safe = urxvt::safe 486=item $is_safe = urxvt::safe
339 487
340Returns true when it is safe to do potentially unsafe things, such as 488Returns true when it is safe to do potentially unsafe things, such as
341evaluating perl code specified by the user. This is true when urxvt was 489evaluating perl code specified by the user. This is true when urxvt was
342started setuid or setgid. 490started setuid or setgid.
348=item urxvt::CurrentTime 496=item urxvt::CurrentTime
349 497
350=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 498=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
351Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 499Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
352Button4Mask, Button5Mask, AnyModifier 500Button4Mask, Button5Mask, AnyModifier
501
502=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
503ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
504PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
505Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
506KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
507ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
508FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
509
510=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
511EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
512GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
513UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
514ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
515CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
516SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
353 517
354Various constants for use in X calls and event processing. 518Various constants for use in X calls and event processing.
355 519
356=back 520=back
357 521
386 550
387=item $background = urxvt::GET_BASEBG $rend 551=item $background = urxvt::GET_BASEBG $rend
388 552
389Return the foreground/background colour index, respectively. 553Return the foreground/background colour index, respectively.
390 554
391=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 555=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
392 556
393=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 557=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
394 558
395Replace the foreground/background colour in the rendition mask with the 559Replace the foreground/background colour in the rendition mask with the
396specified one. 560specified one.
397 561
398=item $value = urxvt::GET_CUSTOM ($rend) 562=item $value = urxvt::GET_CUSTOM $rend
399 563
400Return the "custom" value: Every rendition has 5 bits for use by 564Return the "custom" value: Every rendition has 5 bits for use by
401extensions. They can be set and changed as you like and are initially 565extensions. They can be set and changed as you like and are initially
402zero. 566zero.
403 567
404=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 568=item $rend = urxvt::SET_CUSTOM $rend, $new_value
405 569
406Change the custom value. 570Change the custom value.
407 571
408=back 572=back
409 573
410=cut 574=cut
411
412package urxvt;
413
414use utf8;
415use strict;
416use Scalar::Util ();
417use List::Util ();
418
419our $VERSION = 1;
420our $TERM;
421our @HOOKNAME;
422our %OPTION;
423our $LIBDIR;
424 575
425BEGIN { 576BEGIN {
426 urxvt->bootstrap; 577 urxvt->bootstrap;
427 578
428 # overwrite perl's warn 579 # overwrite perl's warn
431 $msg .= "\n" 582 $msg .= "\n"
432 unless $msg =~ /\n$/; 583 unless $msg =~ /\n$/;
433 urxvt::warn ($msg); 584 urxvt::warn ($msg);
434 }; 585 };
435 586
587 # %ENV is the original startup environment
436 delete $ENV{IFS}; 588 delete $ENV{IFS};
437 delete $ENV{CDPATH}; 589 delete $ENV{CDPATH};
438 delete $ENV{BASH_ENV}; 590 delete $ENV{BASH_ENV};
439 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 591 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
440} 592}
441 593
442my @hook_count;
443my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 594my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444 595
445sub verbose { 596sub verbose {
446 my ($level, $msg) = @_; 597 my ($level, $msg) = @_;
447 warn "$msg\n" if $level <= $verbosity; 598 warn "$msg\n" if $level <= $verbosity;
460 verbose 3, "loading extension '$path' into package '$pkg'"; 611 verbose 3, "loading extension '$path' into package '$pkg'";
461 612
462 open my $fh, "<:raw", $path 613 open my $fh, "<:raw", $path
463 or die "$path: $!"; 614 or die "$path: $!";
464 615
616 my $source = untaint
465 my $source = untaint "package $pkg; use strict; use utf8;\n" 617 "package $pkg; use strict; use utf8;\n"
466 . "use base urxvt::term::proxy::;\n" 618 . "use base urxvt::term::extension::;\n"
467 . "#line 1 \"$path\"\n{\n" 619 . "#line 1 \"$path\"\n{\n"
468 . (do { local $/; <$fh> }) 620 . (do { local $/; <$fh> })
469 . "\n};\n1"; 621 . "\n};\n1";
470 622
623 eval $source
471 eval $source or die "$path: $@"; 624 or die "$path: $@";
472 625
473 $pkg 626 $pkg
474 } 627 }
475} 628}
476 629
486 639
487 my %ext_arg; 640 my %ext_arg;
488 641
489 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 642 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
490 if ($_ eq "default") { 643 if ($_ eq "default") {
491 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup); 644 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
492 } elsif (/^-(.*)$/) { 645 } elsif (/^-(.*)$/) {
493 delete $ext_arg{$1}; 646 delete $ext_arg{$1};
494 } elsif (/^([^<]+)<(.*)>$/) { 647 } elsif (/^([^<]+)<(.*)>$/) {
495 push @{ $ext_arg{$1} }, $2; 648 push @{ $ext_arg{$1} }, $2;
496 } else { 649 } else {
527 if ($@) { 680 if ($@) {
528 $TERM->ungrab; # better to lose the grab than the session 681 $TERM->ungrab; # better to lose the grab than the session
529 warn $@; 682 warn $@;
530 } 683 }
531 } 684 }
685
686 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
687 if $verbosity >= 11;
532 } 688 }
533 689
534 if ($htype == 1) { # DESTROY 690 if ($htype == 1) { # DESTROY
535 # remove hooks if unused
536 if (my $hook = $TERM->{_hook}) {
537 for my $htype (0..$#$hook) {
538 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
539 or set_should_invoke $htype, 0;
540 }
541 }
542
543 # clear package objects 691 # clear package objects
544 %$_ = () for values %{ $TERM->{_pkg} }; 692 %$_ = () for values %{ $TERM->{_pkg} };
545 693
546 # clear package 694 # clear package
547 %$TERM = (); 695 %$TERM = ();
548 } 696 }
549 697
550 $retval 698 $retval
551} 699}
552 700
553# urxvt::term::proxy 701sub exec_async(@) {
702 my $pid = fork;
554 703
555sub urxvt::term::proxy::AUTOLOAD { 704 return
556 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 705 if !defined $pid or $pid;
706
707 %ENV = %{ $TERM->env };
708
709 exec @_;
710 _exit 255;
711}
712
713# urxvt::term::extension
714
715package urxvt::term::extension;
716
717sub enable {
718 my ($self, %hook) = @_;
719 my $pkg = $self->{_pkg};
720
721 while (my ($name, $cb) = each %hook) {
722 my $htype = $HOOKTYPE{uc $name};
723 defined $htype
724 or Carp::croak "unsupported hook type '$name'";
725
726 $self->set_should_invoke ($htype, +1)
727 unless exists $self->{term}{_hook}[$htype]{$pkg};
728
729 $self->{term}{_hook}[$htype]{$pkg} = $cb;
730 }
731}
732
733sub disable {
734 my ($self, @hook) = @_;
735 my $pkg = $self->{_pkg};
736
737 for my $name (@hook) {
738 my $htype = $HOOKTYPE{uc $name};
739 defined $htype
740 or Carp::croak "unsupported hook type '$name'";
741
742 $self->set_should_invoke ($htype, -1)
743 if delete $self->{term}{_hook}[$htype]{$pkg};
744 }
745}
746
747our $AUTOLOAD;
748
749sub AUTOLOAD {
750 $AUTOLOAD =~ /:([^:]+)$/
557 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 751 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
558 752
559 eval qq{ 753 eval qq{
560 sub $urxvt::term::proxy::AUTOLOAD { 754 sub $AUTOLOAD {
561 my \$proxy = shift; 755 my \$proxy = shift;
562 \$proxy->{term}->$1 (\@_) 756 \$proxy->{term}->$1 (\@_)
563 } 757 }
564 1 758 1
565 } or die "FATAL: unable to compile method forwarder: $@"; 759 } or die "FATAL: unable to compile method forwarder: $@";
566 760
567 goto &$urxvt::term::proxy::AUTOLOAD; 761 goto &$AUTOLOAD;
568} 762}
569 763
570sub urxvt::term::proxy::DESTROY { 764sub DESTROY {
571 # nop 765 # nop
572} 766}
573 767
574# urxvt::destroy_hook 768# urxvt::destroy_hook
575 769
585 779
586=head2 The C<urxvt::anyevent> Class 780=head2 The C<urxvt::anyevent> Class
587 781
588The sole purpose of this class is to deliver an interface to the 782The sole purpose of this class is to deliver an interface to the
589C<AnyEvent> module - any module using it will work inside urxvt without 783C<AnyEvent> module - any module using it will work inside urxvt without
590further work. The only exception is that you cannot wait on condition 784further programming. The only exception is that you cannot wait on
591variables, but non-blocking condvar use is ok. What this means is that you 785condition variables, but non-blocking condvar use is ok. What this means
592cannot use blocking APIs, but the non-blocking variant should work. 786is that you cannot use blocking APIs, but the non-blocking variant should
787work.
593 788
594=cut 789=cut
595 790
596our $VERSION = 1; 791our $VERSION = 1;
597 792
642 ${$_[0]}++; 837 ${$_[0]}++;
643} 838}
644 839
645sub urxvt::anyevent::condvar::wait { 840sub urxvt::anyevent::condvar::wait {
646 unless (${$_[0]}) { 841 unless (${$_[0]}) {
647 require Carp;
648 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); 842 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
649 } 843 }
650} 844}
651 845
652package urxvt::term; 846package urxvt::term;
653 847
660# find on_xxx subs in the package and register them 854# find on_xxx subs in the package and register them
661# as hooks 855# as hooks
662sub register_package { 856sub register_package {
663 my ($self, $pkg, $argv) = @_; 857 my ($self, $pkg, $argv) = @_;
664 858
665 my $proxy = bless { argv => $argv }, $pkg; 859 my $proxy = bless {
860 _pkg => $pkg,
861 argv => $argv,
862 }, $pkg;
666 Scalar::Util::weaken ($proxy->{term} = $TERM); 863 Scalar::Util::weaken ($proxy->{term} = $self);
667 864
668 $self->{_pkg}{$pkg} = $proxy; 865 $self->{_pkg}{$pkg} = $proxy;
669 866
670 for my $htype (0.. $#HOOKNAME) { 867 for my $name (@HOOKNAME) {
671 my $name = $HOOKNAME[$htype];
672
673 my $ref = $pkg->can ("on_" . lc $name) 868 if (my $ref = $pkg->can ("on_" . lc $name)) {
674 or next; 869 $proxy->enable ($name => $ref);
675 870 }
676 $self->{_hook}[$htype]{$pkg} = $ref;
677 $hook_count[$htype]++
678 or urxvt::set_should_invoke $htype, 1;
679 } 871 }
680} 872}
681 873
874=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
875
876Creates a new terminal, very similar as if you had started it with system
877C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
878hash which defines the environment of the new terminal.
879
880Croaks (and probably outputs an error message) if the new instance
881couldn't be created. Returns C<undef> if the new instance didn't
882initialise perl, and the terminal object otherwise. The C<init> and
883C<start> hooks will be called during this call.
884
885=cut
886
887sub new {
888 my ($class, $env, @args) = @_;
889
890 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
891}
892
682=item $term->destroy 893=item $term->destroy
683 894
684Destroy the terminal object (close the window, free resources etc.). 895Destroy the terminal object (close the window, free resources
896etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897watchers (timers, io watchers) are still active.
685 898
686=item $isset = $term->option ($optval[, $set]) 899=item $isset = $term->option ($optval[, $set])
687 900
688Returns true if the option specified by C<$optval> is enabled, and 901Returns true if the option specified by C<$optval> is enabled, and
689optionally change it. All option values are stored by name in the hash 902optionally change it. All option values are stored by name in the hash
739 my ($self, $name) = (shift, shift); 952 my ($self, $name) = (shift, shift);
740 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 953 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
741 &urxvt::term::_resource 954 &urxvt::term::_resource
742} 955}
743 956
957=item $value = $term->x_resource ($pattern)
958
959Returns the X-Resource for the given pattern, excluding the program or
960class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
961same value as used by this instance of rxvt-unicode. Returns C<undef> if no
962resource with that pattern exists.
963
964This method should only be called during the C<on_start> hook, as there is
965only one resource database per display, and later invocations might return
966the wrong resources.
967
968=item $success = $term->parse_keysym ($keysym_spec, $command_string)
969
970Adds a keymap translation exactly as specified via a resource. See the
971C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
972
744=item $rend = $term->rstyle ([$new_rstyle]) 973=item $rend = $term->rstyle ([$new_rstyle])
745 974
746Return and optionally change the current rendition. Text that is output by 975Return and optionally change the current rendition. Text that is output by
747the terminal application will use this style. 976the terminal application will use this style.
748 977
758=item ($row, $col) = $term->selection_end ([$row, $col]) 987=item ($row, $col) = $term->selection_end ([$row, $col])
759 988
760Return the current values of the selection mark, begin or end positions, 989Return the current values of the selection mark, begin or end positions,
761and optionally set them to new values. 990and optionally set them to new values.
762 991
992=item $term->selection_make ($eventtime[, $rectangular])
993
994Tries to make a selection as set by C<selection_beg> and
995C<selection_end>. If C<$rectangular> is true (default: false), a
996rectangular selection will be made. This is the prefered function to make
997a selection.
998
763=item $success = $term->selection_grab ($eventtime) 999=item $success = $term->selection_grab ($eventtime)
764 1000
765Try to request the primary selection from the server (for example, as set 1001Try to request the primary selection text from the server (for example, as
766by the next method). 1002set by the next method). No visual feedback will be given. This function
1003is mostly useful from within C<on_sel_grab> hooks.
767 1004
768=item $oldtext = $term->selection ([$newtext]) 1005=item $oldtext = $term->selection ([$newtext])
769 1006
770Return the current selection text and optionally replace it by C<$newtext>. 1007Return the current selection text and optionally replace it by C<$newtext>.
771 1008
772#=item $term->overlay ($x, $y, $text) 1009=item $term->overlay_simple ($x, $y, $text)
773# 1010
774#Create a simple multi-line overlay box. See the next method for details. 1011Create a simple multi-line overlay box. See the next method for details.
775# 1012
776#=cut 1013=cut
777# 1014
778#sub urxvt::term::scr_overlay { 1015sub overlay_simple {
779# my ($self, $x, $y, $text) = @_; 1016 my ($self, $x, $y, $text) = @_;
780# 1017
781# my @lines = split /\n/, $text; 1018 my @lines = split /\n/, $text;
782# 1019
783# my $w = 0; 1020 my $w = List::Util::max map $self->strwidth ($_), @lines;
784# for (map $self->strwidth ($_), @lines) { 1021
785# $w = $_ if $w < $_;
786# }
787#
788# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1022 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
789# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1023 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
790#} 1024
1025 $overlay
1026}
791 1027
792=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1028=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
793 1029
794Create a new (empty) overlay at the given position with the given 1030Create a new (empty) overlay at the given position with the given
795width/height. C<$rstyle> defines the initial rendition style 1031width/height. C<$rstyle> defines the initial rendition style
862 1098
863=item $string = $term->locale_decode ($octets) 1099=item $string = $term->locale_decode ($octets)
864 1100
865Convert the given locale-encoded octets into a perl string. 1101Convert the given locale-encoded octets into a perl string.
866 1102
1103=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1104
1105XORs the rendition values in the given span with the provided value
1106(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1107refresh hooks to provide effects similar to the selection.
1108
1109=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1110
1111Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1112whitespace will additionally be xored with the C<$rstyle2>, which defaults
1113to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1114it instead. Both styles I<MUST NOT> contain font styles.
1115
1116=item $term->scr_bell
1117
1118Ring the bell!
1119
867=item $term->scr_add_lines ($string) 1120=item $term->scr_add_lines ($string)
868 1121
869Write the given text string to the screen, as if output by the application 1122Write the given text string to the screen, as if output by the application
870running inside the terminal. It may not contain command sequences (escape 1123running inside the terminal. It may not contain command sequences (escape
871codes), but is free to use line feeds, carriage returns and tabs. The 1124codes), but is free to use line feeds, carriage returns and tabs. The
885 1138
886Write the octets given in C<$data> to the tty (i.e. as program input). To 1139Write the octets given in C<$data> to the tty (i.e. as program input). To
887pass characters instead of octets, you should convert your strings first 1140pass characters instead of octets, you should convert your strings first
888to the locale-specific encoding using C<< $term->locale_encode >>. 1141to the locale-specific encoding using C<< $term->locale_encode >>.
889 1142
1143=item $old_events = $term->pty_ev_events ([$new_events])
1144
1145Replaces the event mask of the pty watcher by the given event mask. Can
1146be used to suppress input and output handling to the pty/tty. See the
1147description of C<< urxvt::timer->events >>. Make sure to always restore
1148the previous value.
1149
890=item $windowid = $term->parent 1150=item $windowid = $term->parent
891 1151
892Return the window id of the toplevel window. 1152Return the window id of the toplevel window.
893 1153
894=item $windowid = $term->vt 1154=item $windowid = $term->vt
895 1155
896Return the window id of the terminal window. 1156Return the window id of the terminal window.
897 1157
1158=item $term->vt_emask_add ($x_event_mask)
1159
1160Adds the specified events to the vt event mask. Useful e.g. when you want
1161to receive pointer events all the times:
1162
1163 $term->vt_emask_add (urxvt::PointerMotionMask);
1164
898=item $window_width = $term->width 1165=item $window_width = $term->width
899 1166
900=item $window_height = $term->height 1167=item $window_height = $term->height
901 1168
902=item $font_width = $term->fwidth 1169=item $font_width = $term->fwidth
915 1182
916=item $max_scrollback = $term->saveLines 1183=item $max_scrollback = $term->saveLines
917 1184
918=item $nrow_plus_saveLines = $term->total_rows 1185=item $nrow_plus_saveLines = $term->total_rows
919 1186
920=item $lines_in_scrollback = $term->nsaved 1187=item $topmost_scrollback_row = $term->top_row
921 1188
922Return various integers describing terminal characteristics. 1189Return various integers describing terminal characteristics.
923 1190
1191=item $x_display = $term->display_id
1192
1193Return the DISPLAY used by rxvt-unicode.
1194
924=item $lc_ctype = $term->locale 1195=item $lc_ctype = $term->locale
925 1196
926Returns the LC_CTYPE category string used by this rxvt-unicode. 1197Returns the LC_CTYPE category string used by this rxvt-unicode.
927 1198
928=item $x_display = $term->display_id 1199=item $env = $term->env
929 1200
930Return the DISPLAY used by rxvt-unicode. 1201Returns a copy of the environment in effect for the terminal as a hashref
1202similar to C<\%ENV>.
1203
1204=cut
1205
1206sub env {
1207 if (my $env = $_[0]->_env) {
1208 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1209 } else {
1210 +{ %ENV }
1211 }
1212}
931 1213
932=item $modifiermask = $term->ModLevel3Mask 1214=item $modifiermask = $term->ModLevel3Mask
933 1215
934=item $modifiermask = $term->ModMetaMask 1216=item $modifiermask = $term->ModMetaMask
935 1217
938Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1220Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
939AltGr), the meta key (often Alt) and the num lock key, if applicable. 1221AltGr), the meta key (often Alt) and the num lock key, if applicable.
940 1222
941=item $view_start = $term->view_start ([$newvalue]) 1223=item $view_start = $term->view_start ([$newvalue])
942 1224
943Returns the negative row number of the topmost line. Minimum value is 1225Returns the row number of the topmost displayed line. Maximum value is
944C<0>, which displays the normal terminal contents. Larger values scroll 1226C<0>, which displays the normal terminal contents. Lower values scroll
945this many lines into the scrollback buffer. 1227this many lines into the scrollback buffer.
946 1228
947=item $term->want_refresh 1229=item $term->want_refresh
948 1230
949Requests a screen refresh. At the next opportunity, rxvt-unicode will 1231Requests a screen refresh. At the next opportunity, rxvt-unicode will
1028Return the row number of the first/last row of the line, respectively. 1310Return the row number of the first/last row of the line, respectively.
1029 1311
1030=item $offset = $line->offset_of ($row, $col) 1312=item $offset = $line->offset_of ($row, $col)
1031 1313
1032Returns the character offset of the given row|col pair within the logical 1314Returns the character offset of the given row|col pair within the logical
1033line. 1315line. Works for rows outside the line, too, and returns corresponding
1316offsets outside the string.
1034 1317
1035=item ($row, $col) = $line->coord_of ($offset) 1318=item ($row, $col) = $line->coord_of ($offset)
1036 1319
1037Translates a string offset into terminal coordinates again. 1320Translates a string offset into terminal coordinates again.
1038 1321
1175 $item->{render} ||= sub { $_[0]{text} }; 1458 $item->{render} ||= sub { $_[0]{text} };
1176 1459
1177 push @{ $self->{item} }, $item; 1460 push @{ $self->{item} }, $item;
1178} 1461}
1179 1462
1463=item $popup->add_title ($title)
1464
1465Adds a non-clickable title to the popup.
1466
1467=cut
1468
1469sub add_title {
1470 my ($self, $title) = @_;
1471
1472 $self->add_item ({
1473 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1474 text => $title,
1475 activate => sub { },
1476 });
1477}
1478
1479=item $popup->add_separator ([$sepchr])
1480
1481Creates a separator, optionally using the character given as C<$sepchr>.
1482
1483=cut
1484
1180sub add_separator { 1485sub add_separator {
1181 my ($self, $sep) = @_; 1486 my ($self, $sep) = @_;
1182 1487
1183 $sep ||= "="; 1488 $sep ||= "=";
1184 1489
1188 render => sub { $sep x $self->{term}->ncol }, 1493 render => sub { $sep x $self->{term}->ncol },
1189 activate => sub { }, 1494 activate => sub { },
1190 }); 1495 });
1191} 1496}
1192 1497
1193sub add_title { 1498=item $popup->add_button ($text, $cb)
1194 my ($self, $title) = @_;
1195 1499
1196 $self->add_item ({ 1500Adds a clickable button to the popup. C<$cb> is called whenever it is
1197 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1501selected.
1198 text => $title, 1502
1199 activate => sub { }, 1503=cut
1200 });
1201}
1202 1504
1203sub add_button { 1505sub add_button {
1204 my ($self, $text, $cb) = @_; 1506 my ($self, $text, $cb) = @_;
1205 1507
1206 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1508 $self->add_item ({ type => "button", text => $text, activate => $cb});
1207} 1509}
1510
1511=item $popup->add_toggle ($text, $cb, $initial_value)
1512
1513Adds a toggle/checkbox item to the popup. Teh callback gets called
1514whenever it gets toggled, with a boolean indicating its value as its first
1515argument.
1516
1517=cut
1208 1518
1209sub add_toggle { 1519sub add_toggle {
1210 my ($self, $text, $cb, $value) = @_; 1520 my ($self, $text, $cb, $value) = @_;
1211 1521
1212 my $item; $item = { 1522 my $item; $item = {
1213 type => "button", 1523 type => "button",
1214 text => " $text", 1524 text => " $text",
1215 value => $value, 1525 value => $value,
1216 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1526 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1217 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1527 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1218 }; 1528 };
1219 1529
1220 $self->add_item ($item); 1530 $self->add_item ($item);
1221} 1531}
1532
1533=item $popup->show
1534
1535Displays the popup (which is initially hidden).
1536
1537=cut
1222 1538
1223sub show { 1539sub show {
1224 my ($self) = @_; 1540 my ($self) = @_;
1225 1541
1226 local $urxvt::popup::self = $self; 1542 local $urxvt::popup::self = $self;
1227 1543
1544 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL};
1228 local $ENV{LC_ALL} = $self->{term}->locale; 1547 $env->{LC_CTYPE} = $self->{term}->locale;
1229 1548
1549 urxvt::term->new ($env, $self->{term}->resource ("name"),
1230 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1231 "--transient-for" => $self->{term}->parent, 1551 "--transient-for" => $self->{term}->parent,
1232 "-display" => $self->{term}->display_id, 1552 "-display" => $self->{term}->display_id,
1233 "-pe" => "urxvt-popup") 1553 "-pe" => "urxvt-popup")
1234 or die "unable to create popup window\n"; 1554 or die "unable to create popup window\n";
1235} 1555}
1236 1556
1237sub DESTROY { 1557sub DESTROY {
1238 my ($self) = @_; 1558 my ($self) = @_;
1239 1559
1240 delete $self->{term}{_destroy}{$self}; 1560 delete $self->{term}{_destroy}{$self};
1241 $self->{term}->ungrab; 1561 $self->{term}->ungrab;
1242} 1562}
1563
1564=back
1243 1565
1244=head2 The C<urxvt::timer> Class 1566=head2 The C<urxvt::timer> Class
1245 1567
1246This class implements timer watchers/events. Time is represented as a 1568This class implements timer watchers/events. Time is represented as a
1247fractional number of seconds since the epoch. Example: 1569fractional number of seconds since the epoch. Example:
1300 1622
1301 $term->{socket} = ... 1623 $term->{socket} = ...
1302 $term->{iow} = urxvt::iow 1624 $term->{iow} = urxvt::iow
1303 ->new 1625 ->new
1304 ->fd (fileno $term->{socket}) 1626 ->fd (fileno $term->{socket})
1305 ->events (1) # wait for read data 1627 ->events (urxvt::EVENT_READ)
1306 ->start 1628 ->start
1307 ->cb (sub { 1629 ->cb (sub {
1308 my ($iow, $revents) = @_; 1630 my ($iow, $revents) = @_;
1309 # $revents must be 1 here, no need to check 1631 # $revents must be 1 here, no need to check
1310 sysread $term->{socket}, my $buf, 8192 1632 sysread $term->{socket}, my $buf, 8192
1327 1649
1328Set the filedescriptor (not handle) to watch. 1650Set the filedescriptor (not handle) to watch.
1329 1651
1330=item $iow = $iow->events ($eventmask) 1652=item $iow = $iow->events ($eventmask)
1331 1653
1332Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 1654Set the event mask to watch. The only allowed values are
1333data, Bit #1 (value C<2>) enables watching for write data. 1655C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1656together, or C<urxvt::EVENT_NONE>.
1334 1657
1335=item $iow = $iow->start 1658=item $iow = $iow->start
1336 1659
1337Start watching for requested events on the given handle. 1660Start watching for requested events on the given handle.
1338 1661
1353 1676
1354=item == 0 - fatal messages 1677=item == 0 - fatal messages
1355 1678
1356=item >= 3 - script loading and management 1679=item >= 3 - script loading and management
1357 1680
1358=item >=10 - all events received 1681=item >=10 - all called hooks
1682
1683=item >=11 - hook reutrn values
1359 1684
1360=back 1685=back
1361 1686
1362=head1 AUTHOR 1687=head1 AUTHOR
1363 1688

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines