5 @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
9 # create a file grab_test in $HOME:
12 warn "you selected ", $_[0]->selection;
16 # start a @@RXVT_NAME@@ using it:
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
22 Everytime a terminal object gets created, extension scripts specified via
23 the C<perl> resource are loaded and associated with it.
25 Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26 thus must be encoded as UTF-8.
28 Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29 scripts will be shared (but not enabled) for all terminals.
31 =head2 Prepackaged Extensions
33 This section describes the extensiosn delivered with this version. You can
34 find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
36 You can activate them like this:
38 @@RXVT_NAME@@ -pe <extensionname>
42 =item selection (enabled by default)
44 Intelligent selection. This extension tries to be more intelligent when
45 the user extends selections (double-click). Right now, it tries to select
46 urls and complete shell-quoted arguments, which is very convenient, too,
47 if your F<ls> supports C<--quoting-style=shell>.
49 It also offers the following bindable event:
55 Rot-13 the selection when activated. Used via keyboard trigger:
57 URxvt.keysym.C-M-r: perl:selection:rot13
61 =item option-popup (enabled by default)
63 Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
66 =item selection-popup (enabled by default)
68 Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69 text into various other formats/action.
73 Displays a digital clock using the built-in overlay.
77 Uses per-line display filtering (C<on_line_update>) to underline urls.
79 =item block-graphics-to-ascii
81 A not very useful example of filtering all text output to the terminal,
82 by replacing all line-drawing characters (U+2500 .. U+259F) by a
83 similar-looking ascii character.
85 =item example-refresh-hooks
87 Displays a very simple digital clock in the upper right corner of the
88 window. Illustrates overwriting the refresh callbacks to create your own
93 =head2 General API Considerations
95 All objects (such as terminals, time watchers etc.) are typical
96 reference-to-hash objects. The hash can be used to store anything you
97 like. All members starting with an underscore (such as C<_ptr> or
98 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
101 When objects are destroyed on the C++ side, the perl object hashes are
102 emptied, so its best to store related objects such as time watchers and
103 the like inside the terminal object so they get destroyed as soon as the
104 terminal is destroyed.
106 Argument names also often indicate the type of a parameter. Here are some
107 hints on what they mean:
113 Rxvt-unicodes special way of encoding text, where one "unicode" character
114 always represents one screen cell. See L<row_t> for a discussion of this format.
118 A perl text string, with an emphasis on I<text>. It can store all unicode
119 characters and is to be distinguished with text encoded in a specific
120 encoding (often locale-specific) and binary data.
124 Either binary data or - more common - a text string encoded in a
131 The following subroutines can be declared in extension files, and will be
132 called whenever the relevant event happens.
134 The first argument passed to them is an object private to each terminal
135 and extension package. You can call all C<urxvt::term> methods on it, but
136 its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
137 object that is shared between all packages is stored in the C<term>
138 member. It is, however, blessed intot he package of the extension script,
139 so for all practical purposes you can treat an extension script as a class.
141 All of them must return a boolean value. If it is true, then the event
142 counts as being I<consumed>, and the invocation of other hooks is skipped,
143 and the relevant action might not be carried out by the C++ code.
145 When in doubt, return a false value (preferably C<()>).
151 Called after a new terminal object has been initialized, but before
152 windows are created or the command gets run. Most methods are unsafe to
153 call or deliver senseless data, as terminal size and other characteristics
154 have not yet been determined. You can safely query and change resources,
159 Called after the screen is "reset" for any reason, such as resizing or
160 control sequences. Here is where you can react on changes to size-related
165 Called at the very end of initialisation of a new terminal, just before
166 returning to the mainloop.
168 =item on_sel_make $term, $eventtime
170 Called whenever a selection has been made by the user, but before the
171 selection text is copied, so changes to the beginning, end or type of the
172 selection will be honored.
174 Returning a true value aborts selection making by urxvt, in which case you
175 have to make a selection yourself by calling C<< $term->selection_grab >>.
177 =item on_sel_grab $term, $eventtime
179 Called whenever a selection has been copied, but before the selection is
180 requested from the server. The selection text can be queried and changed
181 by calling C<< $term->selection >>.
183 Returning a true value aborts selection grabbing. It will still be hilighted.
185 =item on_sel_extend $term
187 Called whenever the user tries to extend the selection (e.g. with a double
188 click) and is either supposed to return false (normal operation), or
189 should extend the selection itelf and return true to suppress the built-in
192 See the F<selection> example extension.
194 =item on_view_change $term, $offset
196 Called whenever the view offset changes, i..e the user or program
197 scrolls. Offset C<0> means display the normal terminal, positive values
198 show this many lines of scrollback.
200 =item on_scroll_back $term, $lines, $saved
202 Called whenever lines scroll out of the terminal area into the scrollback
203 buffer. C<$lines> is the number of lines scrolled out and may be larger
204 than the scroll back buffer or the terminal.
206 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
207 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
208 number of lines that will be in the scrollback buffer.
210 =item on_tty_activity $term *NYI*
212 Called whenever the program(s) running in the urxvt window send output.
214 =item on_osc_seq $term, $string
216 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
217 operating system command) is processed. Cursor position and other state
218 information is up-to-date when this happens. For interoperability, the
219 string should start with the extension name and a colon, to distinguish
220 it from commands for other extensions, and this might be enforced in the
223 Be careful not ever to trust (in a security sense) the data you receive,
224 as its source can not easily be controleld (e-mail content, messages from
225 other users on the same system etc.).
227 =item on_add_lines $term, $string
229 Called whenever text is about to be output, with the text as argument. You
230 can filter/change and output the text yourself by returning a true value
231 and calling C<< $term->scr_add_lines >> yourself. Please note that this
232 might be very slow, however, as your hook is called for B<all> text being
235 =item on_line_update $term, $row
237 Called whenever a line was updated or changed. Can be used to filter
238 screen output (e.g. underline urls or other useless stuff). Only lines
239 that are being shown will be filtered, and, due to performance reasons,
240 not always immediately.
242 The row number is always the topmost row of the line if the line spans
245 Please note that, if you change the line, then the hook might get called
246 later with the already-modified line (e.g. if unrelated parts change), so
247 you cannot just toggle rendition bits, but only set them.
249 =item on_refresh_begin $term
251 Called just before the screen gets redrawn. Can be used for overlay
252 or similar effects by modify terminal contents in refresh_begin, and
253 restoring them in refresh_end. The built-in overlay and selection display
254 code is run after this hook, and takes precedence.
256 =item on_refresh_end $term
258 Called just after the screen gets redrawn. See C<on_refresh_begin>.
260 =item on_keyboard_command $term, $string
262 Called whenever the user presses a key combination that has a
263 C<perl:string> action bound to it (see description of the B<keysym>
264 resource in the @@RXVT_NAME@@(1) manpage).
266 =item on_focus_in $term
268 Called whenever the window gets the keyboard focus, before rxvt-unicode
269 does focus in processing.
271 =item on_focus_out $term
273 Called wheneever the window loses keyboard focus, before rxvt-unicode does
274 focus out processing.
276 =item on_key_press $term, $event, $octets
278 =item on_key_release $term, $event
280 =item on_button_press $term, $event
282 =item on_button_release $term, $event
284 =item on_motion_notify $term, $event
286 =item on_map_notify $term, $event
288 =item on_unmap_notify $term, $event
290 Called whenever the corresponding X event is received for the terminal If
291 the hook returns true, then the even will be ignored by rxvt-unicode.
293 The event is a hash with most values as named by Xlib (see the XEvent
294 manpage), with the additional members C<row> and C<col>, which are the row
295 and column under the mouse cursor.
297 C<on_key_press> additionally receives the string rxvt-unicode would
298 output, if any, in locale-specific encoding.
304 =head2 Variables in the C<urxvt> Package
310 The current terminal. This variable stores the current C<urxvt::term>
311 object, whenever a callback/hook is executing.
315 =head2 Functions in the C<urxvt> Package
319 =item $term = new urxvt [arg...]
321 Creates a new terminal, very similar as if you had started it with
322 C<system $binfile, arg...>. Croaks (and probably outputs an error message)
323 if the new instance couldn't be created. Returns C<undef> if the new
324 instance didn't initialise perl, and the terminal object otherwise. The
325 C<init> and C<start> hooks will be called during the call.
327 =item urxvt::fatal $errormessage
329 Fatally aborts execution with the given error message. Avoid at all
330 costs! The only time this is acceptable is when the terminal process
333 =item urxvt::warn $string
335 Calls C<rxvt_warn> with the given string which should not include a
336 newline. The module also overwrites the C<warn> builtin with a function
337 that calls this function.
339 Using this function has the advantage that its output ends up in the
340 correct place, e.g. on stderr of the connecting urxvtc client.
342 =item $time = urxvt::NOW
344 Returns the "current time" (as per the event loop).
346 =item urxvt::CurrentTime
348 =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
349 Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
350 Button4Mask, Button5Mask, AnyModifier
352 Various constants for use in X calls and event processing.
358 Rendition bitsets contain information about colour, font, font styles and
359 similar information for each screen cell.
361 The following "macros" deal with changes in rendition sets. You should
362 never just create a bitset, you should always modify an existing one,
363 as they contain important information required for correct operation of
368 =item $rend = urxvt::DEFAULT_RSTYLE
370 Returns the default rendition, as used when the terminal is starting up or
371 being reset. Useful as a base to start when creating renditions.
373 =item $rend = urxvt::OVERLAY_RSTYLE
375 Return the rendition mask used for overlays by default.
377 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
379 Return the bit that enabled bold, italic, blink, reverse-video and
380 underline, respectively. To enable such a style, just logically OR it into
383 =item $foreground = urxvt::GET_BASEFG $rend
385 =item $background = urxvt::GET_BASEBG $rend
387 Return the foreground/background colour index, respectively.
389 =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
391 =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
393 Replace the foreground/background colour in the rendition mask with the
396 =item $value = urxvt::GET_CUSTOM ($rend)
398 Return the "custom" value: Every rendition has 5 bits for use by
399 extensions. They can be set and changed as you like and are initially
402 =item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
404 Change the custom value.
426 # overwrite perl's warn
427 *CORE::GLOBAL::warn = sub {
428 my $msg = join "", @_;
430 unless $msg =~ /\n$/;
436 delete $ENV{BASH_ENV};
437 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
441 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
444 my ($level, $msg) = @_;
445 warn "$msg\n" if $level <= $verbosity;
448 # find on_xxx subs in the package and register them
450 sub register_package($) {
453 for my $htype (0.. $#HOOKNAME) {
454 my $name = $HOOKNAME[$htype];
456 my $ref = $pkg->can ("on_" . lc $name)
459 $TERM->{_hook}[$htype]{$pkg} = $ref;
460 $hook_count[$htype]++
461 or set_should_invoke $htype, 1;
465 my $extension_pkg = "extension0000";
468 # load a single script into its own package, once only
469 sub extension_package($) {
472 $extension_pkg{$path} ||= do {
473 my $pkg = "urxvt::" . ($extension_pkg++);
475 verbose 3, "loading extension '$path' into package '$pkg'";
477 open my $fh, "<:raw", $path
480 my $source = untaint "package $pkg; use strict; use utf8;\n"
481 . "use base urxvt::term::proxy::;\n"
482 . "#line 1 \"$path\"\n{\n"
483 . (do { local $/; <$fh> })
486 eval $source or die "$path: $@";
492 our $retval; # return value for urxvt
494 # called by the rxvt core
499 if ($htype == 0) { # INIT
500 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
504 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
505 if ($_ eq "default") {
506 $want_ext{$_}++ for qw(selection option-popup selection-popup);
507 } elsif (/^-(.*)$/) {
508 delete $want_ext{$1};
514 for my $ext (keys %want_ext) {
515 my @files = grep -f $_, map "$_/$ext", @dirs;
518 register_package extension_package $files[0];
520 warn "perl extension '$ext' not found in perl library search path\n";
524 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
530 if (my $cb = $TERM->{_hook}[$htype]) {
531 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
536 while (my ($pkg, $cb) = each %$cb) {
539 $TERM->{_pkg}{$pkg} ||= do {
540 my $proxy = bless { }, $pkg;
541 Scalar::Util::weaken ($proxy->{term} = $TERM);
548 $TERM->ungrab; # better to lose the grab than the session
554 if ($htype == 1) { # DESTROY
555 # remove hooks if unused
556 if (my $hook = $TERM->{_hook}) {
557 for my $htype (0..$#$hook) {
558 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
559 or set_should_invoke $htype, 0;
563 # clear package objects
564 %$_ = () for values %{ $TERM->{_pkg} };
575 sub urxvt::term::proxy::AUTOLOAD {
576 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
577 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
580 sub $urxvt::term::proxy::AUTOLOAD {
582 \$proxy->{term}->$1 (\@_)
585 } or die "FATAL: unable to compile method forwarder: $@";
587 goto &$urxvt::term::proxy::AUTOLOAD;
590 sub urxvt::term::proxy::DESTROY {
594 # urxvt::destroy_hook
596 sub urxvt::destroy_hook::DESTROY {
600 sub urxvt::destroy_hook(&) {
601 bless \shift, urxvt::destroy_hook::
604 package urxvt::anyevent;
606 =head2 The C<urxvt::anyevent> Class
608 The sole purpose of this class is to deliver an interface to the
609 C<AnyEvent> module - any module using it will work inside urxvt without
610 further work. The only exception is that you cannot wait on condition
611 variables, but non-blocking condvar use is ok. What this means is that you
612 cannot use blocking APIs, but the non-blocking variant should work.
618 $INC{"urxvt/anyevent.pm"} = 1; # mark us as there
619 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
622 my ($class, %arg) = @_;
628 ->start (urxvt::NOW + $arg{after})
630 $_[0]->stop; # need to cancel manually
636 my ($class, %arg) = @_;
640 bless [$arg{fh}, urxvt::iow
642 ->fd (fileno $arg{fh})
643 ->events (($arg{poll} =~ /r/ ? 1 : 0)
644 | ($arg{poll} =~ /w/ ? 2 : 0))
647 $cb->(($_[1] & 1 ? 'r' : '')
648 . ($_[1] & 2 ? 'w' : ''));
658 bless \my $flag, urxvt::anyevent::condvar::
661 sub urxvt::anyevent::condvar::broadcast {
665 sub urxvt::anyevent::condvar::wait {
668 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
674 =head2 The C<urxvt::term> Class
680 Destroy the terminal object (close the window, free resources etc.).
682 =item $isset = $term->option ($optval[, $set])
684 Returns true if the option specified by C<$optval> is enabled, and
685 optionally change it. All option values are stored by name in the hash
686 C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
688 Here is a a likely non-exhaustive list of option names, please see the
689 source file F</src/optinc.h> to see the actual list:
691 borderLess console cursorBlink cursorUnderline hold iconic insecure
692 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
693 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
694 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
695 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
696 tripleclickwords utmpInhibit visualBell
698 =item $value = $term->resource ($name[, $newval])
700 Returns the current resource value associated with a given name and
701 optionally sets a new value. Setting values is most useful in the C<init>
702 hook. Unset resources are returned and accepted as C<undef>.
704 The new value must be properly encoded to a suitable character encoding
705 before passing it to this method. Similarly, the returned value may need
706 to be converted from the used encoding to text.
708 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
709 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
712 Please note that resource strings will currently only be freed when the
713 terminal is destroyed, so changing options frequently will eat memory.
715 Here is a a likely non-exhaustive list of resource names, not all of which
716 are supported in every build, please see the source file F</src/rsinc.h>
717 to see the actual list:
719 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
720 borderLess color cursorBlink cursorUnderline cutchars delete_key
721 display_name embed ext_bwidth fade font geometry hold iconName
722 imFont imLocale inputMethod insecure int_bwidth intensityStyles
723 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
724 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
725 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
726 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
727 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
728 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
729 shade term_name title transparent transparent_all tripleclickwords
730 utmpInhibit visualBell
735 my ($self, $name) = (shift, shift);
736 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
737 &urxvt::term::_resource
740 =item $rend = $term->rstyle ([$new_rstyle])
742 Return and optionally change the current rendition. Text that is output by
743 the terminal application will use this style.
745 =item ($row, $col) = $term->screen_cur ([$row, $col])
747 Return the current coordinates of the text cursor position and optionally
748 set it (which is usually bad as applications don't expect that).
750 =item ($row, $col) = $term->selection_mark ([$row, $col])
752 =item ($row, $col) = $term->selection_beg ([$row, $col])
754 =item ($row, $col) = $term->selection_end ([$row, $col])
756 Return the current values of the selection mark, begin or end positions,
757 and optionally set them to new values.
759 =item $success = $term->selection_grab ($eventtime)
761 Try to request the primary selection from the server (for example, as set
764 =item $oldtext = $term->selection ([$newtext])
766 Return the current selection text and optionally replace it by C<$newtext>.
768 #=item $term->overlay ($x, $y, $text)
770 #Create a simple multi-line overlay box. See the next method for details.
774 #sub urxvt::term::scr_overlay {
775 # my ($self, $x, $y, $text) = @_;
777 # my @lines = split /\n/, $text;
780 # for (map $self->strwidth ($_), @lines) {
781 # $w = $_ if $w < $_;
784 # $self->scr_overlay_new ($x, $y, $w, scalar @lines);
785 # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
788 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
790 Create a new (empty) overlay at the given position with the given
791 width/height. C<$rstyle> defines the initial rendition style
792 (default: C<OVERLAY_RSTYLE>).
794 If C<$border> is C<2> (default), then a decorative border will be put
797 If either C<$x> or C<$y> is negative, then this is counted from the
798 right/bottom side, respectively.
800 This method returns an urxvt::overlay object. The overlay will be visible
801 as long as the perl object is referenced.
803 The methods currently supported on C<urxvt::overlay> objects are:
807 =item $overlay->set ($x, $y, $text, $rend)
809 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
810 text in rxvt-unicode's special encoding and an array of rendition values
811 at a specific position inside the overlay.
815 If visible, hide the overlay, but do not destroy it.
819 If hidden, display the overlay again.
823 =item $popup = $term->popup ($event)
825 Creates a new C<urxvt::popup> object that implements a popup menu. The
826 C<$event> I<must> be the event causing the menu to pop up (a button event,
832 my ($self, $event) = @_;
834 $self->grab ($event->{time}, 1)
842 Scalar::Util::weaken $popup->{term};
844 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
845 Scalar::Util::weaken $self->{_destroy}{$popup};
850 =item $cellwidth = $term->strwidth ($string)
852 Returns the number of screen-cells this string would need. Correctly
853 accounts for wide and combining characters.
855 =item $octets = $term->locale_encode ($string)
857 Convert the given text string into the corresponding locale encoding.
859 =item $string = $term->locale_decode ($octets)
861 Convert the given locale-encoded octets into a perl string.
863 =item $term->scr_add_lines ($string)
865 Write the given text string to the screen, as if output by the application
866 running inside the terminal. It may not contain command sequences (escape
867 codes), but is free to use line feeds, carriage returns and tabs. The
868 string is a normal text string, not in locale-dependent encoding.
870 Normally its not a good idea to use this function, as programs might be
871 confused by changes in cursor position or scrolling. Its useful inside a
872 C<on_add_lines> hook, though.
874 =item $term->cmd_parse ($octets)
876 Similar to C<scr_add_lines>, but the argument must be in the
877 locale-specific encoding of the terminal and can contain command sequences
878 (escape codes) that will be interpreted.
880 =item $term->tt_write ($octets)
882 Write the octets given in C<$data> to the tty (i.e. as program input). To
883 pass characters instead of octets, you should convert your strings first
884 to the locale-specific encoding using C<< $term->locale_encode >>.
886 =item $windowid = $term->parent
888 Return the window id of the toplevel window.
890 =item $windowid = $term->vt
892 Return the window id of the terminal window.
894 =item $window_width = $term->width
896 =item $window_height = $term->height
898 =item $font_width = $term->fwidth
900 =item $font_height = $term->fheight
902 =item $font_ascent = $term->fbase
904 =item $terminal_rows = $term->nrow
906 =item $terminal_columns = $term->ncol
908 =item $has_focus = $term->focus
910 =item $is_mapped = $term->mapped
912 =item $max_scrollback = $term->saveLines
914 =item $nrow_plus_saveLines = $term->total_rows
916 =item $lines_in_scrollback = $term->nsaved
918 Return various integers describing terminal characteristics.
920 =item $modifiermask = $term->ModLevel3Mask
922 =item $modifiermask = $term->ModMetaMask
924 =item $modifiermask = $term->ModNumLockMask
926 Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
927 AltGr), the meta key (often Alt) and the num lock key, if applicable.
929 =item $view_start = $term->view_start ([$newvalue])
931 Returns the negative row number of the topmost line. Minimum value is
932 C<0>, which displays the normal terminal contents. Larger values scroll
933 this many lines into the scrollback buffer.
935 =item $term->want_refresh
937 Requests a screen refresh. At the next opportunity, rxvt-unicode will
938 compare the on-screen display with its stored representation. If they
939 differ, it redraws the differences.
941 Used after changing terminal contents to display them.
943 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
945 Returns the text of the entire row with number C<$row_number>. Row C<0>
946 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
947 terminal line. The scrollback buffer starts at line C<-1> and extends to
948 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
951 If C<$new_text> is specified, it will replace characters in the current
952 line, starting at column C<$start_col> (default C<0>), which is useful
953 to replace only parts of a line. The font index in the rendition will
954 automatically be updated.
956 C<$text> is in a special encoding: tabs and wide characters that use more
957 than one cell when displayed are padded with urxvt::NOCHAR characters
958 (C<chr 65535>). Characters with combining characters and other characters
959 that do not fit into the normal tetx encoding will be replaced with
960 characters in the private use area.
962 You have to obey this encoding when changing text. The advantage is
963 that C<substr> and similar functions work on screen cells and not on
966 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
967 can be used to convert normal strings into this encoding and vice versa.
969 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
971 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
972 bitsets. Rendition bitsets contain information about colour, font, font
973 styles and similar information. See also C<< $term->ROW_t >>.
975 When setting rendition, the font mask will be ignored.
977 See the section on RENDITION, above.
979 =item $length = $term->ROW_l ($row_number[, $new_length])
981 Returns the number of screen cells that are in use ("the line
982 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
983 line is joined with the following one.
985 =item $bool = $term->is_longer ($row_number)
987 Returns true if the row is part of a multiple-row logical "line" (i.e.
988 joined with the following row), which means all characters are in use
989 and it is continued on the next row (and possibly a continuation of the
992 =item $line = $term->line ($row_number)
994 Create and return a new C<urxvt::line> object that stores information
995 about the logical line that row C<$row_number> is part of. It supports the
1000 =item $text = $line->t ([$new_text])
1002 Returns or replaces the full text of the line, similar to C<ROW_t>
1004 =item $rend = $line->r ([$new_rend])
1006 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
1008 =item $length = $line->l
1010 Returns the length of the line in cells, similar to C<ROW_l>.
1012 =item $rownum = $line->beg
1014 =item $rownum = $line->end
1016 Return the row number of the first/last row of the line, respectively.
1018 =item $offset = $line->offset_of ($row, $col)
1020 Returns the character offset of the given row|col pair within the logical
1023 =item ($row, $col) = $line->coord_of ($offset)
1025 Translates a string offset into terminal coordinates again.
1032 my ($self, $row) = @_;
1034 my $maxrow = $self->nrow - 1;
1036 my ($beg, $end) = ($row, $row);
1038 --$beg while $self->ROW_is_longer ($beg - 1);
1039 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1045 ncol => $self->ncol,
1046 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1050 sub urxvt::line::t {
1055 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1056 for $self->{beg} .. $self->{end};
1059 defined wantarray &&
1060 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1064 sub urxvt::line::r {
1069 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1070 for $self->{beg} .. $self->{end};
1073 if (defined wantarray) {
1075 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1077 $#$rend = $self->{len} - 1;
1084 sub urxvt::line::beg { $_[0]{beg} }
1085 sub urxvt::line::end { $_[0]{end} }
1086 sub urxvt::line::l { $_[0]{len} }
1088 sub urxvt::line::offset_of {
1089 my ($self, $row, $col) = @_;
1091 ($row - $self->{beg}) * $self->{ncol} + $col
1094 sub urxvt::line::coord_of {
1095 my ($self, $offset) = @_;
1100 $offset / $self->{ncol} + $self->{beg},
1101 $offset % $self->{ncol}
1105 =item ($row, $col) = $line->coord_of ($offset)
1106 =item $text = $term->special_encode $string
1108 Converts a perl string into the special encoding used by rxvt-unicode,
1109 where one character corresponds to one screen cell. See
1110 C<< $term->ROW_t >> for details.
1112 =item $string = $term->special_decode $text
1114 Converts rxvt-unicodes text reprsentation into a perl string. See
1115 C<< $term->ROW_t >> for details.
1121 package urxvt::popup;
1123 =head2 The C<urxvt::popup> Class
1130 my ($self, $item) = @_;
1132 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1133 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1134 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1136 $item->{render} ||= sub { $_[0]{text} };
1138 push @{ $self->{item} }, $item;
1142 my ($self, $sep) = @_;
1147 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1149 render => sub { $sep x $urxvt::TERM->ncol },
1150 activate => sub { },
1155 my ($self, $title) = @_;
1158 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1160 activate => sub { },
1165 my ($self, $text, $cb) = @_;
1167 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1171 my ($self, $text, $cb, $value) = @_;
1177 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1178 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },
1181 $self->add_item ($item);
1187 local $urxvt::popup::self = $self;
1189 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1190 "--transient-for" => $self->{term}->parent,
1191 "-pe" => "urxvt-popup")
1192 or die "unable to create popup window\n";
1198 delete $self->{term}{_destroy}{$self};
1199 $self->{term}->ungrab;
1202 =head2 The C<urxvt::timer> Class
1204 This class implements timer watchers/events. Time is represented as a
1205 fractional number of seconds since the epoch. Example:
1207 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1208 $term->{timer} = urxvt::timer
1212 $term->{overlay}->set (0, 0,
1213 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1218 =item $timer = new urxvt::timer
1220 Create a new timer object in started state. It is scheduled to fire
1223 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1225 Set the callback to be called when the timer triggers.
1227 =item $tstamp = $timer->at
1229 Return the time this watcher will fire next.
1231 =item $timer = $timer->set ($tstamp)
1233 Set the time the event is generated to $tstamp.
1235 =item $timer = $timer->interval ($interval)
1237 Normally (and when C<$interval> is C<0>), the timer will automatically
1238 stop after it has fired once. If C<$interval> is non-zero, then the timer
1239 is automatically rescheduled at the given intervals.
1241 =item $timer = $timer->start
1245 =item $timer = $timer->start ($tstamp)
1247 Set the event trigger time to C<$tstamp> and start the timer.
1249 =item $timer = $timer->stop
1255 =head2 The C<urxvt::iow> Class
1257 This class implements io watchers/events. Example:
1259 $term->{socket} = ...
1260 $term->{iow} = urxvt::iow
1262 ->fd (fileno $term->{socket})
1263 ->events (1) # wait for read data
1266 my ($iow, $revents) = @_;
1267 # $revents must be 1 here, no need to check
1268 sysread $term->{socket}, my $buf, 8192
1275 =item $iow = new urxvt::iow
1277 Create a new io watcher object in stopped state.
1279 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
1281 Set the callback to be called when io events are triggered. C<$reventmask>
1282 is a bitset as described in the C<events> method.
1284 =item $iow = $iow->fd ($fd)
1286 Set the filedescriptor (not handle) to watch.
1288 =item $iow = $iow->events ($eventmask)
1290 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
1291 data, Bit #1 (value C<2>) enables watching for write data.
1293 =item $iow = $iow->start
1295 Start watching for requested events on the given handle.
1297 =item $iow = $iow->stop
1299 Stop watching for events on the given filehandle.
1305 =head2 URXVT_PERL_VERBOSITY
1307 This variable controls the verbosity level of the perl extension. Higher
1308 numbers indicate more verbose output.
1312 =item == 0 - fatal messages
1314 =item >= 3 - script loading and management
1316 =item >=10 - all events received
1322 Marc Lehmann <pcg@goof.com>
1323 http://software.schmorp.de/pkg/rxvt-unicode