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.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.95 by elmex, Tue Jan 17 13:19:45 2006 UTC

40=over 4 40=over 4
41 41
42=item selection (enabled by default) 42=item selection (enabled by default)
43 43
44(More) intelligent selection. This extension tries to be more intelligent 44(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 45when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 46now, it tries to select words, urls and complete shell-quoted
47too, if 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
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
49It also offers the following bindable keyboard command: 71This extension also offers following bindable keyboard commands:
50 72
51=over 4 73=over 4
52 74
53=item rot13 75=item rot13
54 76
55Rot-13 the selection when activated. Used via keyboard trigger: 77Rot-13 the selection when activated. Used via keyboard trigger:
56 78
57 URxvt.keysym.C-M-r: perl:selection:rot13 79 URxvt.keysym.C-M-r: perl:selection:rot13
80
81=item remote-pastebin
82
83Upload the selection as textfile to a remote site.
84
85 URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87To set the command to upload the file set this resource:
88
89 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92md5 sum of the selection.
93After an successful upload the selection will be replaced by the following url
94(the % is the placeholder for the filename):
95
96 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
58 97
59=back 98=back
60 99
61=item option-popup (enabled by default) 100=item option-popup (enabled by default)
62 101
70evalution, web-browser starting etc.), depending on content. 109evalution, web-browser starting etc.), depending on content.
71 110
72=item searchable-scrollback<hotkey> (enabled by default) 111=item searchable-scrollback<hotkey> (enabled by default)
73 112
74Adds regex search functionality to the scrollback buffer, triggered 113Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 114by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 115input/output is suspended and a regex is displayed at the bottom of the
116screen.
77 117
78C</> starts an incremental regex search, C<n> searches further, C<p> or 118Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 119search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 120search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 121bottom. C<Escape> leaves search mode and returns to the point where search
122was started, while C<Enter> or C<Return> stay at the current position and
123additionally stores the first match in the current line into the primary
124selection.
82 125
83=item digital-clock 126=item selection-autotransform
84 127
85Displays a digital clock using the built-in overlay. 128This selection allows you to do automatic transforms on a selection
129whenever a selection is made.
130
131It works by specifying perl snippets (most useful is a single C<s///>
132operator) that modify C<$_> as resources:
133
134 URxvt.selection-autotransform.0: transform
135 URxvt.selection-autotransform.1: transform
136 ...
137
138For example, the following will transform selections of the form
139C<filename:number>, often seen in compiler messages, into C<vi +$filename
140$word>:
141
142 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
143
144And this example matches the same,but replaces it with vi-commands you can
145paste directly into your (vi :) editor:
146
147 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
148
149Of course, this can be modified to suit your needs and your editor :)
150
151To expand the example above to typical perl error messages ("XXX at
152FILENAME line YYY."), you need a slightly more elaborate solution:
153
154 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
155 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
156
157The first line tells the selection code to treat the unchanging part of
158every error message as a selection pattern, and the second line transforms
159the message into vi commands to load the file.
86 160
87=item mark-urls 161=item mark-urls
88 162
89Uses per-line display filtering (C<on_line_update>) to underline urls. 163Uses per-line display filtering (C<on_line_update>) to underline urls and
164make them clickable. When middle-clicked, the program specified in the
165resource C<urlLauncher> (default C<x-www-browser>) will be started with
166the URL as first argument.
90 167
91=item block-graphics-to-ascii 168=item block-graphics-to-ascii
92 169
93A not very useful example of filtering all text output to the terminal, 170A not very useful example of filtering all text output to the terminal,
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 171by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 172similar-looking ascii character.
173
174=item digital-clock
175
176Displays a digital clock using the built-in overlay.
96 177
97=item example-refresh-hooks 178=item example-refresh-hooks
98 179
99Displays a very simple digital clock in the upper right corner of the 180Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 181window. Illustrates overwriting the refresh callbacks to create your own
123=over 4 204=over 4
124 205
125=item $text 206=item $text
126 207
127Rxvt-unicodes special way of encoding text, where one "unicode" character 208Rxvt-unicodes special way of encoding text, where one "unicode" character
128always represents one screen cell. See L<row_t> for a discussion of this format. 209always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 210
130=item $string 211=item $string
131 212
132A perl text string, with an emphasis on I<text>. It can store all unicode 213A perl text string, with an emphasis on I<text>. It can store all unicode
133characters and is to be distinguished with text encoded in a specific 214characters and is to be distinguished with text encoded in a specific
228=item on_sel_extend $term 309=item on_sel_extend $term
229 310
230Called whenever the user tries to extend the selection (e.g. with a double 311Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 312click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 313should extend the selection itelf and return true to suppress the built-in
233processing. 314processing. This can happen multiple times, as long as the callback
315returns true, it will be called on every further click by the user and is
316supposed to enlarge the selection more and more, if possible.
234 317
235See the F<selection> example extension. 318See the F<selection> example extension.
236 319
237=item on_view_change $term, $offset 320=item on_view_change $term, $offset
238 321
305 388
306Called whenever the user presses a key combination that has a 389Called whenever the user presses a key combination that has a
307C<perl:string> action bound to it (see description of the B<keysym> 390C<perl:string> action bound to it (see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 391resource in the @@RXVT_NAME@@(1) manpage).
309 392
393=item on_x_event $term, $event
394
395Called on every X event received on the vt window (and possibly other
396windows). Should only be used as a last resort. Most event structure
397members are not passed.
398
310=item on_focus_in $term 399=item on_focus_in $term
311 400
312Called whenever the window gets the keyboard focus, before rxvt-unicode 401Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 402does focus in processing.
314 403
340 429
341C<on_key_press> additionally receives the string rxvt-unicode would 430C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 431output, if any, in locale-specific encoding.
343 432
344subwindow. 433subwindow.
345
346=back
347
348=head2 Variables in the C<urxvt> Package
349
350=over 4
351
352=item $urxvt::LIBDIR
353
354The rxvt-unicode library directory, where, among other things, the perl
355modules and scripts are stored.
356
357=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359The resource class and name rxvt-unicode uses to look up X resources.
360
361=item $urxvt::RXVTNAME
362
363The basename of the installed binaries, usually C<urxvt>.
364
365=item $urxvt::TERM
366
367The current terminal. This variable stores the current C<urxvt::term>
368object, whenever a callback/hook is executing.
369
370=item
371
372=back
373
374=head2 Functions in the C<urxvt> Package
375
376=over 4
377
378=item $term = new urxvt [arg...]
379
380Creates a new terminal, very similar as if you had started it with
381C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382if the new instance couldn't be created. Returns C<undef> if the new
383instance didn't initialise perl, and the terminal object otherwise. The
384C<init> and C<start> hooks will be called during the call.
385
386=item urxvt::fatal $errormessage
387
388Fatally aborts execution with the given error message. Avoid at all
389costs! The only time this is acceptable is when the terminal process
390starts up.
391
392=item urxvt::warn $string
393
394Calls C<rxvt_warn> with the given string which should not include a
395newline. The module also overwrites the C<warn> builtin with a function
396that calls this function.
397
398Using this function has the advantage that its output ends up in the
399correct place, e.g. on stderr of the connecting urxvtc client.
400
401=item $is_safe = urxvt::safe
402
403Returns true when it is safe to do potentially unsafe things, such as
404evaluating perl code specified by the user. This is true when urxvt was
405started setuid or setgid.
406
407=item $time = urxvt::NOW
408
409Returns the "current time" (as per the event loop).
410
411=item urxvt::CurrentTime
412
413=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415Button4Mask, Button5Mask, AnyModifier
416
417Various constants for use in X calls and event processing.
418
419=back
420
421=head2 RENDITION
422
423Rendition bitsets contain information about colour, font, font styles and
424similar information for each screen cell.
425
426The following "macros" deal with changes in rendition sets. You should
427never just create a bitset, you should always modify an existing one,
428as they contain important information required for correct operation of
429rxvt-unicode.
430
431=over 4
432
433=item $rend = urxvt::DEFAULT_RSTYLE
434
435Returns the default rendition, as used when the terminal is starting up or
436being reset. Useful as a base to start when creating renditions.
437
438=item $rend = urxvt::OVERLAY_RSTYLE
439
440Return the rendition mask used for overlays by default.
441
442=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444Return the bit that enabled bold, italic, blink, reverse-video and
445underline, respectively. To enable such a style, just logically OR it into
446the bitset.
447
448=item $foreground = urxvt::GET_BASEFG $rend
449
450=item $background = urxvt::GET_BASEBG $rend
451
452Return the foreground/background colour index, respectively.
453
454=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458Replace the foreground/background colour in the rendition mask with the
459specified one.
460
461=item $value = urxvt::GET_CUSTOM $rend
462
463Return the "custom" value: Every rendition has 5 bits for use by
464extensions. They can be set and changed as you like and are initially
465zero.
466
467=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469Change the custom value.
470 434
471=back 435=back
472 436
473=cut 437=cut
474 438
488 452
489our $LIBDIR; 453our $LIBDIR;
490our $RESNAME; 454our $RESNAME;
491our $RESCLASS; 455our $RESCLASS;
492our $RXVTNAME; 456our $RXVTNAME;
457
458=head2 Variables in the C<urxvt> Package
459
460=over 4
461
462=item $urxvt::LIBDIR
463
464The rxvt-unicode library directory, where, among other things, the perl
465modules and scripts are stored.
466
467=item $urxvt::RESCLASS, $urxvt::RESCLASS
468
469The resource class and name rxvt-unicode uses to look up X resources.
470
471=item $urxvt::RXVTNAME
472
473The basename of the installed binaries, usually C<urxvt>.
474
475=item $urxvt::TERM
476
477The current terminal. This variable stores the current C<urxvt::term>
478object, whenever a callback/hook is executing.
479
480=back
481
482=head2 Functions in the C<urxvt> Package
483
484=over 4
485
486=item urxvt::fatal $errormessage
487
488Fatally aborts execution with the given error message. Avoid at all
489costs! The only time this is acceptable is when the terminal process
490starts up.
491
492=item urxvt::warn $string
493
494Calls C<rxvt_warn> with the given string which should not include a
495newline. The module also overwrites the C<warn> builtin with a function
496that calls this function.
497
498Using this function has the advantage that its output ends up in the
499correct place, e.g. on stderr of the connecting urxvtc client.
500
501Messages have a size limit of 1023 bytes currently.
502
503=item $is_safe = urxvt::safe
504
505Returns true when it is safe to do potentially unsafe things, such as
506evaluating perl code specified by the user. This is true when urxvt was
507started setuid or setgid.
508
509=item $time = urxvt::NOW
510
511Returns the "current time" (as per the event loop).
512
513=item urxvt::CurrentTime
514
515=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
516Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
517Button4Mask, Button5Mask, AnyModifier
518
519=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
520ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
521PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
522Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
523KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
524ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
525FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
526
527=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
528EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
529GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
530UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
531ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
532CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
533SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
534
535Various constants for use in X calls and event processing.
536
537=back
538
539=head2 RENDITION
540
541Rendition bitsets contain information about colour, font, font styles and
542similar information for each screen cell.
543
544The following "macros" deal with changes in rendition sets. You should
545never just create a bitset, you should always modify an existing one,
546as they contain important information required for correct operation of
547rxvt-unicode.
548
549=over 4
550
551=item $rend = urxvt::DEFAULT_RSTYLE
552
553Returns the default rendition, as used when the terminal is starting up or
554being reset. Useful as a base to start when creating renditions.
555
556=item $rend = urxvt::OVERLAY_RSTYLE
557
558Return the rendition mask used for overlays by default.
559
560=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
561
562Return the bit that enabled bold, italic, blink, reverse-video and
563underline, respectively. To enable such a style, just logically OR it into
564the bitset.
565
566=item $foreground = urxvt::GET_BASEFG $rend
567
568=item $background = urxvt::GET_BASEBG $rend
569
570Return the foreground/background colour index, respectively.
571
572=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
573
574=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
575
576Replace the foreground/background colour in the rendition mask with the
577specified one.
578
579=item $value = urxvt::GET_CUSTOM $rend
580
581Return the "custom" value: Every rendition has 5 bits for use by
582extensions. They can be set and changed as you like and are initially
583zero.
584
585=item $rend = urxvt::SET_CUSTOM $rend, $new_value
586
587Change the custom value.
588
589=back
590
591=cut
493 592
494BEGIN { 593BEGIN {
495 urxvt->bootstrap; 594 urxvt->bootstrap;
496 595
497 # overwrite perl's warn 596 # overwrite perl's warn
500 $msg .= "\n" 599 $msg .= "\n"
501 unless $msg =~ /\n$/; 600 unless $msg =~ /\n$/;
502 urxvt::warn ($msg); 601 urxvt::warn ($msg);
503 }; 602 };
504 603
604 # %ENV is the original startup environment
505 delete $ENV{IFS}; 605 delete $ENV{IFS};
506 delete $ENV{CDPATH}; 606 delete $ENV{CDPATH};
507 delete $ENV{BASH_ENV}; 607 delete $ENV{BASH_ENV};
508 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 608 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509} 609}
510 610
511my @hook_count;
512my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 611my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513 612
514sub verbose { 613sub verbose {
515 my ($level, $msg) = @_; 614 my ($level, $msg) = @_;
516 warn "$msg\n" if $level <= $verbosity; 615 warn "$msg\n" if $level <= $verbosity;
598 if ($@) { 697 if ($@) {
599 $TERM->ungrab; # better to lose the grab than the session 698 $TERM->ungrab; # better to lose the grab than the session
600 warn $@; 699 warn $@;
601 } 700 }
602 } 701 }
702
703 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
704 if $verbosity >= 11;
603 } 705 }
604 706
605 if ($htype == 1) { # DESTROY 707 if ($htype == 1) { # DESTROY
606 if (my $hook = delete $TERM->{_hook}) {
607 for my $htype (0..$#$hook) {
608 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
609 or set_should_invoke $htype, 0;
610 }
611 }
612
613 # clear package objects 708 # clear package objects
614 %$_ = () for values %{ $TERM->{_pkg} }; 709 %$_ = () for values %{ $TERM->{_pkg} };
615 710
616 # clear package 711 # clear package
617 %$TERM = (); 712 %$TERM = ();
618 } 713 }
619 714
620 $retval 715 $retval
716}
717
718sub exec_async(@) {
719 my $pid = fork;
720
721 return
722 if !defined $pid or $pid;
723
724 %ENV = %{ $TERM->env };
725
726 exec @_;
727 _exit 255;
621} 728}
622 729
623# urxvt::term::extension 730# urxvt::term::extension
624 731
625package urxvt::term::extension; 732package urxvt::term::extension;
631 while (my ($name, $cb) = each %hook) { 738 while (my ($name, $cb) = each %hook) {
632 my $htype = $HOOKTYPE{uc $name}; 739 my $htype = $HOOKTYPE{uc $name};
633 defined $htype 740 defined $htype
634 or Carp::croak "unsupported hook type '$name'"; 741 or Carp::croak "unsupported hook type '$name'";
635 742
743 $self->set_should_invoke ($htype, +1)
636 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 744 unless exists $self->{term}{_hook}[$htype]{$pkg};
637 $hook_count[$htype]++
638 or urxvt::set_should_invoke $htype, 1;
639 }
640 745
641 $self->{term}{_hook}[$htype]{$pkg} = $cb; 746 $self->{term}{_hook}[$htype]{$pkg} = $cb;
642 } 747 }
643} 748}
644 749
649 for my $name (@hook) { 754 for my $name (@hook) {
650 my $htype = $HOOKTYPE{uc $name}; 755 my $htype = $HOOKTYPE{uc $name};
651 defined $htype 756 defined $htype
652 or Carp::croak "unsupported hook type '$name'"; 757 or Carp::croak "unsupported hook type '$name'";
653 758
759 $self->set_should_invoke ($htype, -1)
654 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 760 if delete $self->{term}{_hook}[$htype]{$pkg};
655 --$hook_count[$htype]
656 or urxvt::set_should_invoke $htype, 0;
657 }
658 } 761 }
659} 762}
660 763
661our $AUTOLOAD; 764our $AUTOLOAD;
662 765
781 for my $name (@HOOKNAME) { 884 for my $name (@HOOKNAME) {
782 if (my $ref = $pkg->can ("on_" . lc $name)) { 885 if (my $ref = $pkg->can ("on_" . lc $name)) {
783 $proxy->enable ($name => $ref); 886 $proxy->enable ($name => $ref);
784 } 887 }
785 } 888 }
889}
890
891=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
892
893Creates a new terminal, very similar as if you had started it with system
894C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
895hash which defines the environment of the new terminal.
896
897Croaks (and probably outputs an error message) if the new instance
898couldn't be created. Returns C<undef> if the new instance didn't
899initialise perl, and the terminal object otherwise. The C<init> and
900C<start> hooks will be called during this call.
901
902=cut
903
904sub new {
905 my ($class, $env, @args) = @_;
906
907 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
786} 908}
787 909
788=item $term->destroy 910=item $term->destroy
789 911
790Destroy the terminal object (close the window, free resources 912Destroy the terminal object (close the window, free resources
847 my ($self, $name) = (shift, shift); 969 my ($self, $name) = (shift, shift);
848 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 970 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849 &urxvt::term::_resource 971 &urxvt::term::_resource
850} 972}
851 973
974=item $value = $term->x_resource ($pattern)
975
976Returns the X-Resource for the given pattern, excluding the program or
977class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
978same value as used by this instance of rxvt-unicode. Returns C<undef> if no
979resource with that pattern exists.
980
981This method should only be called during the C<on_start> hook, as there is
982only one resource database per display, and later invocations might return
983the wrong resources.
984
852=item $success = $term->parse_keysym ($keysym_spec, $command_string) 985=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853 986
854Adds a keymap translation exactly as specified via a resource. See the 987Adds a keymap translation exactly as specified via a resource. See the
855C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 988C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
856 989
871=item ($row, $col) = $term->selection_end ([$row, $col]) 1004=item ($row, $col) = $term->selection_end ([$row, $col])
872 1005
873Return the current values of the selection mark, begin or end positions, 1006Return the current values of the selection mark, begin or end positions,
874and optionally set them to new values. 1007and optionally set them to new values.
875 1008
1009=item $term->selection_make ($eventtime[, $rectangular])
1010
1011Tries to make a selection as set by C<selection_beg> and
1012C<selection_end>. If C<$rectangular> is true (default: false), a
1013rectangular selection will be made. This is the prefered function to make
1014a selection.
1015
876=item $success = $term->selection_grab ($eventtime) 1016=item $success = $term->selection_grab ($eventtime)
877 1017
878Try to request the primary selection from the server (for example, as set 1018Try to request the primary selection text from the server (for example, as
879by the next method). 1019set by the next method). No visual feedback will be given. This function
1020is mostly useful from within C<on_sel_grab> hooks.
880 1021
881=item $oldtext = $term->selection ([$newtext]) 1022=item $oldtext = $term->selection ([$newtext])
882 1023
883Return the current selection text and optionally replace it by C<$newtext>. 1024Return the current selection text and optionally replace it by C<$newtext>.
884 1025
977Convert the given locale-encoded octets into a perl string. 1118Convert the given locale-encoded octets into a perl string.
978 1119
979=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1120=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980 1121
981XORs the rendition values in the given span with the provided value 1122XORs the rendition values in the given span with the provided value
982(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1123(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983to the selection. 1124refresh hooks to provide effects similar to the selection.
984 1125
985=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1126=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986 1127
987Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1128Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988whitespace will additionally be xored with the C<$rstyle2>, which defaults 1129whitespace will additionally be xored with the C<$rstyle2>, which defaults
989to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1130to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990it instead. 1131it instead. Both styles I<MUST NOT> contain font styles.
991 1132
992=item $term->scr_bell 1133=item $term->scr_bell
993 1134
994Ring the bell! 1135Ring the bell!
995 1136
1029 1170
1030=item $windowid = $term->vt 1171=item $windowid = $term->vt
1031 1172
1032Return the window id of the terminal window. 1173Return the window id of the terminal window.
1033 1174
1175=item $term->vt_emask_add ($x_event_mask)
1176
1177Adds the specified events to the vt event mask. Useful e.g. when you want
1178to receive pointer events all the times:
1179
1180 $term->vt_emask_add (urxvt::PointerMotionMask);
1181
1034=item $window_width = $term->width 1182=item $window_width = $term->width
1035 1183
1036=item $window_height = $term->height 1184=item $window_height = $term->height
1037 1185
1038=item $font_width = $term->fwidth 1186=item $font_width = $term->fwidth
1051 1199
1052=item $max_scrollback = $term->saveLines 1200=item $max_scrollback = $term->saveLines
1053 1201
1054=item $nrow_plus_saveLines = $term->total_rows 1202=item $nrow_plus_saveLines = $term->total_rows
1055 1203
1056=item $lines_in_scrollback = $term->nsaved 1204=item $topmost_scrollback_row = $term->top_row
1057 1205
1058Return various integers describing terminal characteristics. 1206Return various integers describing terminal characteristics.
1059 1207
1208=item $x_display = $term->display_id
1209
1210Return the DISPLAY used by rxvt-unicode.
1211
1060=item $lc_ctype = $term->locale 1212=item $lc_ctype = $term->locale
1061 1213
1062Returns the LC_CTYPE category string used by this rxvt-unicode. 1214Returns the LC_CTYPE category string used by this rxvt-unicode.
1063 1215
1064=item $x_display = $term->display_id 1216=item $env = $term->env
1065 1217
1066Return the DISPLAY used by rxvt-unicode. 1218Returns a copy of the environment in effect for the terminal as a hashref
1219similar to C<\%ENV>.
1220
1221=cut
1222
1223sub env {
1224 if (my $env = $_[0]->_env) {
1225 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1226 } else {
1227 +{ %ENV }
1228 }
1229}
1067 1230
1068=item $modifiermask = $term->ModLevel3Mask 1231=item $modifiermask = $term->ModLevel3Mask
1069 1232
1070=item $modifiermask = $term->ModMetaMask 1233=item $modifiermask = $term->ModMetaMask
1071 1234
1074Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1237Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075AltGr), the meta key (often Alt) and the num lock key, if applicable. 1238AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076 1239
1077=item $view_start = $term->view_start ([$newvalue]) 1240=item $view_start = $term->view_start ([$newvalue])
1078 1241
1079Returns the negative row number of the topmost line. Minimum value is 1242Returns the row number of the topmost displayed line. Maximum value is
1080C<0>, which displays the normal terminal contents. Larger values scroll 1243C<0>, which displays the normal terminal contents. Lower values scroll
1081this many lines into the scrollback buffer. 1244this many lines into the scrollback buffer.
1082 1245
1083=item $term->want_refresh 1246=item $term->want_refresh
1084 1247
1085Requests a screen refresh. At the next opportunity, rxvt-unicode will 1248Requests a screen refresh. At the next opportunity, rxvt-unicode will
1164Return the row number of the first/last row of the line, respectively. 1327Return the row number of the first/last row of the line, respectively.
1165 1328
1166=item $offset = $line->offset_of ($row, $col) 1329=item $offset = $line->offset_of ($row, $col)
1167 1330
1168Returns the character offset of the given row|col pair within the logical 1331Returns the character offset of the given row|col pair within the logical
1169line. 1332line. Works for rows outside the line, too, and returns corresponding
1333offsets outside the string.
1170 1334
1171=item ($row, $col) = $line->coord_of ($offset) 1335=item ($row, $col) = $line->coord_of ($offset)
1172 1336
1173Translates a string offset into terminal coordinates again. 1337Translates a string offset into terminal coordinates again.
1174 1338
1392sub show { 1556sub show {
1393 my ($self) = @_; 1557 my ($self) = @_;
1394 1558
1395 local $urxvt::popup::self = $self; 1559 local $urxvt::popup::self = $self;
1396 1560
1561 my $env = $self->{term}->env;
1562 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563 delete $env->{LC_ALL};
1397 local $ENV{LC_ALL} = $self->{term}->locale; 1564 $env->{LC_CTYPE} = $self->{term}->locale;
1398 1565
1566 urxvt::term->new ($env, $self->{term}->resource ("name"),
1399 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1567 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1400 "--transient-for" => $self->{term}->parent, 1568 "--transient-for" => $self->{term}->parent,
1401 "-display" => $self->{term}->display_id, 1569 "-display" => $self->{term}->display_id,
1402 "-pe" => "urxvt-popup") 1570 "-pe" => "urxvt-popup")
1403 or die "unable to create popup window\n"; 1571 or die "unable to create popup window\n";
1404} 1572}
1405 1573
1406sub DESTROY { 1574sub DESTROY {
1407 my ($self) = @_; 1575 my ($self) = @_;
1408 1576
1409 delete $self->{term}{_destroy}{$self}; 1577 delete $self->{term}{_destroy}{$self};
1410 $self->{term}->ungrab; 1578 $self->{term}->ungrab;
1411} 1579}
1580
1581=back
1412 1582
1413=head2 The C<urxvt::timer> Class 1583=head2 The C<urxvt::timer> Class
1414 1584
1415This class implements timer watchers/events. Time is represented as a 1585This class implements timer watchers/events. Time is represented as a
1416fractional number of seconds since the epoch. Example: 1586fractional number of seconds since the epoch. Example:
1523 1693
1524=item == 0 - fatal messages 1694=item == 0 - fatal messages
1525 1695
1526=item >= 3 - script loading and management 1696=item >= 3 - script loading and management
1527 1697
1528=item >=10 - all events received 1698=item >=10 - all called hooks
1699
1700=item >=11 - hook reutrn values
1529 1701
1530=back 1702=back
1531 1703
1532=head1 AUTHOR 1704=head1 AUTHOR
1533 1705

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines