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>
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
63 Displays a digital clock using the built-in overlay.
67 Uses per-line display filtering (C<on_line_update>) to underline urls.
69 =item block-graphics-to-ascii
71 A not very useful example of filtering all text output to the terminal,
72 by replacing all line-drawing characters (U+2500 .. U+259F) by a
73 similar-looking ascii character.
75 =item example-refresh-hooks
77 Displays a very simple digital clock in the upper right corner of the
78 window. Illustrates overwriting the refresh callbacks to create your own
83 =head2 General API Considerations
85 All objects (such as terminals, time watchers etc.) are typical
86 reference-to-hash objects. The hash can be used to store anything you
87 like. All members starting with an underscore (such as C<_ptr> or
88 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
91 When objects are destroyed on the C++ side, the perl object hashes are
92 emptied, so its best to store related objects such as time watchers and
93 the like inside the terminal object so they get destroyed as soon as the
94 terminal is destroyed.
96 Argument names also often indicate the type of a parameter. Here are some
97 hints on what they mean:
103 Rxvt-unicodes special way of encoding text, where one "unicode" character
104 always represents one screen cell. See L<row_t> for a discussion of this format.
108 A perl text string, with an emphasis on I<text>. It can store all unicode
109 characters and is to be distinguished with text encoded in a specific
110 encoding (often locale-specific) and binary data.
114 Either binary data or - more common - a text string encoded in a
121 The following subroutines can be declared in extension files, and will be
122 called whenever the relevant event happens.
124 The first argument passed to them is an object private to each terminal
125 and extension package. You can call all C<urxvt::term> methods on it, but
126 its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127 object that is shared between all packages is stored in the C<term>
128 member. It is, however, blessed intot he package of the extension script,
129 so for all practical purposes you can treat an extension script as a class.
131 All of them must return a boolean value. If it is true, then the event
132 counts as being I<consumed>, and the invocation of other hooks is skipped,
133 and the relevant action might not be carried out by the C++ code.
135 When in doubt, return a false value (preferably C<()>).
141 Called after a new terminal object has been initialized, but before
142 windows are created or the command gets run. Most methods are unsafe to
143 call or deliver senseless data, as terminal size and other characteristics
144 have not yet been determined. You can safely query and change resources,
149 Called after the screen is "reset" for any reason, such as resizing or
150 control sequences. Here is where you can react on changes to size-related
155 Called at the very end of initialisation of a new terminal, just before
156 returning to the mainloop.
158 =item on_sel_make $term, $eventtime
160 Called whenever a selection has been made by the user, but before the
161 selection text is copied, so changes to the beginning, end or type of the
162 selection will be honored.
164 Returning a true value aborts selection making by urxvt, in which case you
165 have to make a selection yourself by calling C<< $term->selection_grab >>.
167 =item on_sel_grab $term, $eventtime
169 Called whenever a selection has been copied, but before the selection is
170 requested from the server. The selection text can be queried and changed
171 by calling C<< $term->selection >>.
173 Returning a true value aborts selection grabbing. It will still be hilighted.
175 =item on_sel_extend $term
177 Called whenever the user tries to extend the selection (e.g. with a double
178 click) and is either supposed to return false (normal operation), or
179 should extend the selection itelf and return true to suppress the built-in
182 See the F<selection> example extension.
184 =item on_view_change $term, $offset
186 Called whenever the view offset changes, i..e the user or program
187 scrolls. Offset C<0> means display the normal terminal, positive values
188 show this many lines of scrollback.
190 =item on_scroll_back $term, $lines, $saved
192 Called whenever lines scroll out of the terminal area into the scrollback
193 buffer. C<$lines> is the number of lines scrolled out and may be larger
194 than the scroll back buffer or the terminal.
196 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198 number of lines that will be in the scrollback buffer.
200 =item on_tty_activity $term *NYI*
202 Called whenever the program(s) running in the urxvt window send output.
204 =item on_osc_seq $term, $string
206 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207 operating system command) is processed. Cursor position and other state
208 information is up-to-date when this happens. For interoperability, the
209 string should start with the extension name and a colon, to distinguish
210 it from commands for other extensions, and this might be enforced in the
213 Be careful not ever to trust (in a security sense) the data you receive,
214 as its source can not easily be controleld (e-mail content, messages from
215 other users on the same system etc.).
217 =item on_add_lines $term, $string
219 Called whenever text is about to be output, with the text as argument. You
220 can filter/change and output the text yourself by returning a true value
221 and calling C<< $term->scr_add_lines >> yourself. Please note that this
222 might be very slow, however, as your hook is called for B<all> text being
225 =item on_line_update $term, $row
227 Called whenever a line was updated or changed. Can be used to filter
228 screen output (e.g. underline urls or other useless stuff). Only lines
229 that are being shown will be filtered, and, due to performance reasons,
230 not always immediately.
232 The row number is always the topmost row of the line if the line spans
235 Please note that, if you change the line, then the hook might get called
236 later with the already-modified line (e.g. if unrelated parts change), so
237 you cannot just toggle rendition bits, but only set them.
239 =item on_refresh_begin $term
241 Called just before the screen gets redrawn. Can be used for overlay
242 or similar effects by modify terminal contents in refresh_begin, and
243 restoring them in refresh_end. The built-in overlay and selection display
244 code is run after this hook, and takes precedence.
246 =item on_refresh_end $term
248 Called just after the screen gets redrawn. See C<on_refresh_begin>.
250 =item on_keyboard_command $term, $string
252 Called whenever the user presses a key combination that has a
253 C<perl:string> action bound to it (see description of the B<keysym>
254 resource in the @@RXVT_NAME@@(1) manpage).
256 =item on_focus_in $term
258 Called whenever the window gets the keyboard focus, before rxvt-unicode
259 does focus in processing.
261 =item on_focus_out $term
263 Called wheneever the window loses keyboard focus, before rxvt-unicode does
264 focus out processing.
266 =item on_key_press $term, $event, $octets
268 =item on_key_release $term, $event
270 =item on_button_press $term, $event
272 =item on_button_release $term, $event
274 =item on_motion_notify $term, $event
276 =item on_map_notify $term, $event
278 =item on_unmap_notify $term, $event
280 Called whenever the corresponding X event is received for the terminal If
281 the hook returns true, then the even will be ignored by rxvt-unicode.
283 The event is a hash with most values as named by Xlib (see the XEvent
284 manpage), with the additional members C<row> and C<col>, which are the row
285 and column under the mouse cursor.
287 C<on_key_press> additionally receives the string rxvt-unicode would
288 output, if any, in locale-specific encoding.
294 =head2 Variables in the C<urxvt> Package
300 The current terminal. This variable stores the current C<urxvt::term>
301 object, whenever a callback/hook is executing.
305 =head2 Functions in the C<urxvt> Package
309 =item $term = new urxvt [arg...]
311 Creates a new terminal, very similar as if you had started it with
312 C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313 if the new instance couldn't be created. Returns C<undef> if the new
314 instance didn't initialise perl, and the terminal object otherwise. The
315 C<init> and C<start> hooks will be called during the call.
317 =item urxvt::fatal $errormessage
319 Fatally aborts execution with the given error message. Avoid at all
320 costs! The only time this is acceptable is when the terminal process
323 =item urxvt::warn $string
325 Calls C<rxvt_warn> with the given string which should not include a
326 newline. The module also overwrites the C<warn> builtin with a function
327 that calls this function.
329 Using this function has the advantage that its output ends up in the
330 correct place, e.g. on stderr of the connecting urxvtc client.
332 =item $time = urxvt::NOW
334 Returns the "current time" (as per the event loop).
336 =item urxvt::CurrentTime
338 =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
339 Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
340 Button4Mask, Button5Mask, AnyModifier
342 Various constants for use in X events.
348 Rendition bitsets contain information about colour, font, font styles and
349 similar information for each screen cell.
351 The following "macros" deal with changes in rendition sets. You should
352 never just create a bitset, you should always modify an existing one,
353 as they contain important information required for correct operation of
358 =item $rend = urxvt::DEFAULT_RSTYLE
360 Returns the default rendition, as used when the terminal is starting up or
361 being reset. Useful as a base to start when creating renditions.
363 =item $rend = urxvt::OVERLAY_RSTYLE
365 Return the rendition mask used for overlays by default.
367 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
369 Return the bit that enabled bold, italic, blink, reverse-video and
370 underline, respectively. To enable such a style, just logically OR it into
373 =item $foreground = urxvt::GET_BASEFG $rend
375 =item $background = urxvt::GET_BASEBG $rend
377 Return the foreground/background colour index, respectively.
379 =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
381 =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
383 Replace the foreground/background colour in the rendition mask with the
386 =item $value = urxvt::GET_CUSTOM ($rend)
388 Return the "custom" value: Every rendition has 5 bits for use by
389 extensions. They can be set and changed as you like and are initially
392 =item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
394 Change the custom value.
415 # overwrite perl's warn
416 *CORE::GLOBAL::warn = sub {
417 my $msg = join "", @_;
419 unless $msg =~ /\n$/;
425 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
428 my ($level, $msg) = @_;
429 warn "$msg\n" if $level <= $verbosity;
432 # find on_xxx subs in the package and register them
434 sub register_package($) {
437 for my $htype (0.. $#HOOKNAME) {
438 my $name = $HOOKNAME[$htype];
440 my $ref = $pkg->can ("on_" . lc $name)
443 $TERM->{_hook}[$htype]{$pkg} = $ref;
444 $hook_count[$htype]++
445 or set_should_invoke $htype, 1;
449 my $extension_pkg = "extension0000";
452 # load a single script into its own package, once only
453 sub extension_package($) {
456 $extension_pkg{$path} ||= do {
457 my $pkg = "urxvt::" . ($extension_pkg++);
459 verbose 3, "loading extension '$path' into package '$pkg'";
461 open my $fh, "<:raw", $path
464 my $source = "package $pkg; use strict; use utf8;\n"
465 . "use base urxvt::term::proxy::;\n"
466 . "#line 1 \"$path\"\n{\n"
467 . (do { local $/; <$fh> })
470 eval $source or die "$path: $@";
476 our $retval; # return value for urxvt
478 # called by the rxvt core
483 if ($htype == 0) { # INIT
484 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
488 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
489 if ($_ eq "default") {
490 $want_ext{$_}++ for qw(selection option-popup);
491 } elsif (/^-(.*)$/) {
492 delete $want_ext{$1};
498 for my $ext (keys %want_ext) {
499 my @files = grep -f $_, map "$_/$ext", @dirs;
502 register_package extension_package $files[0];
504 warn "perl extension '$ext' not found in perl library search path\n";
511 if (my $cb = $TERM->{_hook}[$htype]) {
512 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
517 while (my ($pkg, $cb) = each %$cb) {
520 $TERM->{_pkg}{$pkg} ||= do {
521 my $proxy = bless { }, $pkg;
522 Scalar::Util::weaken ($proxy->{term} = $TERM);
532 if ($htype == 1) { # DESTROY
533 # remove hooks if unused
534 if (my $hook = $TERM->{_hook}) {
535 for my $htype (0..$#$hook) {
536 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
537 or set_should_invoke $htype, 0;
541 # clear package objects
542 %$_ = () for values %{ $TERM->{_pkg} };
551 sub urxvt::term::proxy::AUTOLOAD {
552 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
553 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
556 sub $urxvt::term::proxy::AUTOLOAD {
558 \$proxy->{term}->$1 (\@_)
561 } or die "FATAL: unable to compile method forwarder: $@";
563 goto &$urxvt::term::proxy::AUTOLOAD;
566 sub urxvt::destroy_hook::DESTROY {
570 sub urxvt::destroy_hook(&) {
571 bless \shift, urxvt::destroy_hook::
574 =head2 The C<urxvt::term> Class
580 Destroy the terminal object (close the window, free resources etc.).
582 =item $isset = $term->option ($optval[, $set])
584 Returns true if the option specified by C<$optval> is enabled, and
585 optionally change it. All option values are stored by name in the hash
586 C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
588 Here is a a likely non-exhaustive list of option names, please see the
589 source file F</src/optinc.h> to see the actual list:
591 borderLess console cursorBlink cursorUnderline hold iconic insecure
592 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
593 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
594 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
595 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
596 tripleclickwords utmpInhibit visualBell
598 =item $value = $term->resource ($name[, $newval])
600 Returns the current resource value associated with a given name and
601 optionally sets a new value. Setting values is most useful in the C<init>
602 hook. Unset resources are returned and accepted as C<undef>.
604 The new value must be properly encoded to a suitable character encoding
605 before passing it to this method. Similarly, the returned value may need
606 to be converted from the used encoding to text.
608 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
609 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
612 Please note that resource strings will currently only be freed when the
613 terminal is destroyed, so changing options frequently will eat memory.
615 Here is a a likely non-exhaustive list of resource names, not all of which
616 are supported in every build, please see the source file F</src/rsinc.h>
617 to see the actual list:
619 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
620 borderLess color cursorBlink cursorUnderline cutchars delete_key
621 display_name embed ext_bwidth fade font geometry hold iconName
622 imFont imLocale inputMethod insecure int_bwidth intensityStyles
623 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
624 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
625 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
626 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
627 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
628 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
629 shade term_name title transparent transparent_all tripleclickwords
630 utmpInhibit visualBell
634 sub urxvt::term::resource($$;$) {
635 my ($self, $name) = (shift, shift);
636 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
637 &urxvt::term::_resource
640 =item $rend = $term->rstyle ([$new_rstyle])
642 Return and optionally change the current rendition. Text that is output by
643 the terminal application will use this style.
645 =item ($row, $col) = $term->screen_cur ([$row, $col])
647 Return the current coordinates of the text cursor position and optionally
648 set it (which is usually bad as applications don't expect that).
650 =item ($row, $col) = $term->selection_mark ([$row, $col])
652 =item ($row, $col) = $term->selection_beg ([$row, $col])
654 =item ($row, $col) = $term->selection_end ([$row, $col])
656 Return the current values of the selection mark, begin or end positions,
657 and optionally set them to new values.
659 =item $success = $term->selection_grab ($eventtime)
661 Try to request the primary selection from the server (for example, as set
664 =item $oldtext = $term->selection ([$newtext])
666 Return the current selection text and optionally replace it by C<$newtext>.
668 #=item $term->overlay ($x, $y, $text)
670 #Create a simple multi-line overlay box. See the next method for details.
674 #sub urxvt::term::scr_overlay {
675 # my ($self, $x, $y, $text) = @_;
677 # my @lines = split /\n/, $text;
680 # for (map $self->strwidth ($_), @lines) {
681 # $w = $_ if $w < $_;
684 # $self->scr_overlay_new ($x, $y, $w, scalar @lines);
685 # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
688 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
690 Create a new (empty) overlay at the given position with the given
691 width/height. C<$rstyle> defines the initial rendition style
692 (default: C<OVERLAY_RSTYLE>).
694 If C<$border> is C<2> (default), then a decorative border will be put
697 If either C<$x> or C<$y> is negative, then this is counted from the
698 right/bottom side, respectively.
700 This method returns an urxvt::overlay object. The overlay will be visible
701 as long as the perl object is referenced.
703 The methods currently supported on C<urxvt::overlay> objects are:
707 =item $overlay->set ($x, $y, $text, $rend)
709 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
710 text in rxvt-unicode's special encoding and an array of rendition values
711 at a specific position inside the overlay.
715 If visible, hide the overlay, but do not destroy it.
719 If hidden, display the overlay again.
723 =item $popup = $term->popup ($event)
725 Creates a new C<urxvt::popup> object that implements a popup menu. The
726 C<$event> I<must> be the event causing the menu to pop up (a button event,
731 sub urxvt::term::popup {
732 my ($self, $event) = @_;
734 $self->grab ($event->{time}, 1)
742 Scalar::Util::weaken $popup->{term};
744 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
745 Scalar::Util::weaken $self->{_destroy}{$popup};
750 =item $cellwidth = $term->strwidth ($string)
752 Returns the number of screen-cells this string would need. Correctly
753 accounts for wide and combining characters.
755 =item $octets = $term->locale_encode ($string)
757 Convert the given text string into the corresponding locale encoding.
759 =item $string = $term->locale_decode ($octets)
761 Convert the given locale-encoded octets into a perl string.
763 =item $term->scr_add_lines ($string)
765 Write the given text string to the screen, as if output by the application
766 running inside the terminal. It may not contain command sequences (escape
767 codes), but is free to use line feeds, carriage returns and tabs. The
768 string is a normal text string, not in locale-dependent encoding.
770 Normally its not a good idea to use this function, as programs might be
771 confused by changes in cursor position or scrolling. Its useful inside a
772 C<on_add_lines> hook, though.
774 =item $term->cmd_parse ($octets)
776 Similar to C<scr_add_lines>, but the argument must be in the
777 locale-specific encoding of the terminal and can contain command sequences
778 (escape codes) that will be interpreted.
780 =item $term->tt_write ($octets)
782 Write the octets given in C<$data> to the tty (i.e. as program input). To
783 pass characters instead of octets, you should convert your strings first
784 to the locale-specific encoding using C<< $term->locale_encode >>.
786 =item $windowid = $term->parent
788 Return the window id of the toplevel window.
790 =item $windowid = $term->vt
792 Return the window id of the terminal window.
794 =item $window_width = $term->width
796 =item $window_height = $term->height
798 =item $font_width = $term->fwidth
800 =item $font_height = $term->fheight
802 =item $font_ascent = $term->fbase
804 =item $terminal_rows = $term->nrow
806 =item $terminal_columns = $term->ncol
808 =item $has_focus = $term->focus
810 =item $is_mapped = $term->mapped
812 =item $max_scrollback = $term->saveLines
814 =item $nrow_plus_saveLines = $term->total_rows
816 =item $lines_in_scrollback = $term->nsaved
818 Return various integers describing terminal characteristics.
820 =item $modifiermask = $term->ModLevel3Mask
822 =item $modifiermask = $term->ModMetaMask
824 =item $modifiermask = $term->ModNumLockMask
826 Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
827 AltGr), the meta key (often Alt) and the num lock key, if applicable.
829 =item $view_start = $term->view_start ([$newvalue])
831 Returns the negative row number of the topmost line. Minimum value is
832 C<0>, which displays the normal terminal contents. Larger values scroll
833 this many lines into the scrollback buffer.
835 =item $term->want_refresh
837 Requests a screen refresh. At the next opportunity, rxvt-unicode will
838 compare the on-screen display with its stored representation. If they
839 differ, it redraws the differences.
841 Used after changing terminal contents to display them.
843 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
845 Returns the text of the entire row with number C<$row_number>. Row C<0>
846 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
847 terminal line. The scrollback buffer starts at line C<-1> and extends to
848 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
851 If C<$new_text> is specified, it will replace characters in the current
852 line, starting at column C<$start_col> (default C<0>), which is useful
853 to replace only parts of a line. The font index in the rendition will
854 automatically be updated.
856 C<$text> is in a special encoding: tabs and wide characters that use more
857 than one cell when displayed are padded with urxvt::NOCHAR characters
858 (C<chr 65535>). Characters with combining characters and other characters
859 that do not fit into the normal tetx encoding will be replaced with
860 characters in the private use area.
862 You have to obey this encoding when changing text. The advantage is
863 that C<substr> and similar functions work on screen cells and not on
866 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
867 can be used to convert normal strings into this encoding and vice versa.
869 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
871 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
872 bitsets. Rendition bitsets contain information about colour, font, font
873 styles and similar information. See also C<< $term->ROW_t >>.
875 When setting rendition, the font mask will be ignored.
877 See the section on RENDITION, above.
879 =item $length = $term->ROW_l ($row_number[, $new_length])
881 Returns the number of screen cells that are in use ("the line
882 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
883 line is joined with the following one.
885 =item $bool = $term->is_longer ($row_number)
887 Returns true if the row is part of a multiple-row logical "line" (i.e.
888 joined with the following row), which means all characters are in use
889 and it is continued on the next row (and possibly a continuation of the
892 =item $line = $term->line ($row_number)
894 Create and return a new C<urxvt::line> object that stores information
895 about the logical line that row C<$row_number> is part of. It supports the
900 =item $text = $line->t ([$new_text])
902 Returns or replaces the full text of the line, similar to C<ROW_t>
904 =item $rend = $line->r ([$new_rend])
906 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
908 =item $length = $line->l
910 Returns the length of the line in cells, similar to C<ROW_l>.
912 =item $rownum = $line->beg
914 =item $rownum = $line->end
916 Return the row number of the first/last row of the line, respectively.
918 =item $offset = $line->offset_of ($row, $col)
920 Returns the character offset of the given row|col pair within the logical
923 =item ($row, $col) = $line->coord_of ($offset)
925 Translates a string offset into terminal coordinates again.
931 sub urxvt::term::line {
932 my ($self, $row) = @_;
934 my $maxrow = $self->nrow - 1;
936 my ($beg, $end) = ($row, $row);
938 --$beg while $self->ROW_is_longer ($beg - 1);
939 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
946 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
955 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
956 for $self->{beg} .. $self->{end};
960 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
969 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
970 for $self->{beg} .. $self->{end};
973 if (defined wantarray) {
975 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
977 $#$rend = $self->{len} - 1;
984 sub urxvt::line::beg { $_[0]{beg} }
985 sub urxvt::line::end { $_[0]{end} }
986 sub urxvt::line::l { $_[0]{len} }
988 sub urxvt::line::offset_of {
989 my ($self, $row, $col) = @_;
991 ($row - $self->{beg}) * $self->{ncol} + $col
994 sub urxvt::line::coord_of {
995 my ($self, $offset) = @_;
1000 $offset / $self->{ncol} + $self->{beg},
1001 $offset % $self->{ncol}
1005 =item ($row, $col) = $line->coord_of ($offset)
1006 =item $text = $term->special_encode $string
1008 Converts a perl string into the special encoding used by rxvt-unicode,
1009 where one character corresponds to one screen cell. See
1010 C<< $term->ROW_t >> for details.
1012 =item $string = $term->special_decode $text
1014 Converts rxvt-unicodes text reprsentation into a perl string. See
1015 C<< $term->ROW_t >> for details.
1019 =head2 The C<urxvt::popup> Class
1025 package urxvt::popup;
1028 my ($self, $item) = @_;
1030 push @{ $self->{item} }, $item;
1034 my ($self, $text, $cb) = @_;
1036 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb,
1037 render => sub { $_[0]{text} },
1042 my ($self, $text, $cb, $value) = @_;
1048 render => sub { ($item->{value} ? "* " : " ") . $text },
1049 activate => sub { $cb->($item->{value} = !$item->{value}); },
1052 $self->add_item ($item);
1058 local $urxvt::popup::self = $self;
1060 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1061 "--transient-for" => $self->{term}->parent,
1062 "-pe" => "urxvt-popup")
1063 or die "unable to create popup window\n";
1069 $self->{term}->ungrab;
1072 =head2 The C<urxvt::timer> Class
1074 This class implements timer watchers/events. Time is represented as a
1075 fractional number of seconds since the epoch. Example:
1077 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1078 $term->{timer} = urxvt::timer
1082 $term->{overlay}->set (0, 0,
1083 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1088 =item $timer = new urxvt::timer
1090 Create a new timer object in started state. It is scheduled to fire
1093 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1095 Set the callback to be called when the timer triggers.
1097 =item $tstamp = $timer->at
1099 Return the time this watcher will fire next.
1101 =item $timer = $timer->set ($tstamp)
1103 Set the time the event is generated to $tstamp.
1105 =item $timer = $timer->interval ($interval)
1107 Normally (and when C<$interval> is C<0>), the timer will automatically
1108 stop after it has fired once. If C<$interval> is non-zero, then the timer
1109 is automatically rescheduled at the given intervals.
1111 =item $timer = $timer->start
1115 =item $timer = $timer->start ($tstamp)
1117 Set the event trigger time to C<$tstamp> and start the timer.
1119 =item $timer = $timer->stop
1125 =head2 The C<urxvt::iow> Class
1127 This class implements io watchers/events. Example:
1129 $term->{socket} = ...
1130 $term->{iow} = urxvt::iow
1132 ->fd (fileno $term->{socket})
1133 ->events (1) # wait for read data
1136 my ($iow, $revents) = @_;
1137 # $revents must be 1 here, no need to check
1138 sysread $term->{socket}, my $buf, 8192
1145 =item $iow = new urxvt::iow
1147 Create a new io watcher object in stopped state.
1149 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
1151 Set the callback to be called when io events are triggered. C<$reventmask>
1152 is a bitset as described in the C<events> method.
1154 =item $iow = $iow->fd ($fd)
1156 Set the filedescriptor (not handle) to watch.
1158 =item $iow = $iow->events ($eventmask)
1160 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
1161 data, Bit #1 (value C<2>) enables watching for write data.
1163 =item $iow = $iow->start
1165 Start watching for requested events on the given handle.
1167 =item $iow = $iow->stop
1169 Stop watching for events on the given filehandle.
1175 =head2 URXVT_PERL_VERBOSITY
1177 This variable controls the verbosity level of the perl extension. Higher
1178 numbers indicate more verbose output.
1182 =item =0 - only fatal messages
1184 =item =3 - script loading and management
1186 =item =10 - all events received
1192 Marc Lehmann <pcg@goof.com>
1193 http://software.schmorp.de/pkg/rxvt-unicode