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, scripts specified via the
23 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 etxension tries to be more intelligent when the user
45 extends selections (double-click).
47 It also offers the following bindable event:
53 Rot-13 the selection when activated. Used via keyboard trigger:
55 URxvt.keysym.C-M-r: perl:selection:rot13
61 Displays a digital clock using the built-in overlay.
63 =item example-refresh-hooks
65 Displays a very simple digital clock in the upper right corner of the
66 window. Illustrates overwriting the refresh callbacks to create your own
71 =head2 General API Considerations
73 All objects (such as terminals, time watchers etc.) are typical
74 reference-to-hash objects. The hash can be used to store anything you
75 like. All members starting with an underscore (such as C<_ptr> or
76 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
79 When objects are destroyed on the C++ side, the perl object hashes are
80 emptied, so its best to store related objects such as time watchers and
81 the like inside the terminal object so they get destroyed as soon as the
82 terminal is destroyed.
86 The following subroutines can be declared in loaded scripts, and will be
87 called whenever the relevant event happens.
89 The first argument passed to them is an object private to each terminal
90 and extension package. You can call all C<urxvt::term> methods on it, but
91 its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
92 object that is shared between all packages is stored in the C<term>
95 All of them must return a boolean value. If it is true, then the event
96 counts as being I<consumed>, and the invocation of other hooks is skipped,
97 and the relevant action might not be carried out by the C++ code.
99 When in doubt, return a false value (preferably C<()>).
105 Called after a new terminal object has been initialized, but before
106 windows are created or the command gets run.
110 Called after the screen is "reset" for any reason, such as resizing or
111 control sequences. Here is where you can react on changes to size-related
116 Called at the very end of initialisation of a new terminal, just before
117 returning to the mainloop.
119 =item on_sel_make $term, $eventtime
121 Called whenever a selection has been made by the user, but before the
122 selection text is copied, so changes to the beginning, end or type of the
123 selection will be honored.
125 Returning a true value aborts selection making by urxvt, in which case you
126 have to make a selection yourself by calling C<< $term->selection_grab >>.
128 =item on_sel_grab $term, $eventtime
130 Called whenever a selection has been copied, but before the selection is
131 requested from the server. The selection text can be queried and changed
132 by calling C<< $term->selection >>.
134 Returning a true value aborts selection grabbing. It will still be hilighted.
136 =item on_sel_extend $term
138 Called whenever the user tries to extend the selection (e.g. with a double
139 click) and is either supposed to return false (normal operation), or
140 should extend the selection itelf and return true to suppress the built-in
143 See the F<selection> example extension.
145 =item on_focus_in $term
147 Called whenever the window gets the keyboard focus, before urxvt does
150 =item on_focus_out $term
152 Called wheneever the window loses keyboard focus, before urxvt does focus
155 =item on_view_change $term, $offset
157 Called whenever the view offset changes, i..e the user or program
158 scrolls. Offset C<0> means display the normal terminal, positive values
159 show this many lines of scrollback.
161 =item on_scroll_back $term, $lines, $saved
163 Called whenever lines scroll out of the terminal area into the scrollback
164 buffer. C<$lines> is the number of lines scrolled out and may be larger
165 than the scroll back buffer or the terminal.
167 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
168 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
169 number of lines that will be in the scrollback buffer.
171 =item on_tty_activity $term *NYI*
173 Called whenever the program(s) running in the urxvt window send output.
175 =item on_refresh_begin $term
177 Called just before the screen gets redrawn. Can be used for overlay
178 or similar effects by modify terminal contents in refresh_begin, and
179 restoring them in refresh_end. The built-in overlay and selection display
180 code is run after this hook, and takes precedence.
182 =item on_refresh_end $term
184 Called just after the screen gets redrawn. See C<on_refresh_begin>.
186 =item on_keyboard_command $term, $string
188 Called whenever the user presses a key combination that has a
189 C<perl:string> action bound to it (see description of the B<keysym>
190 resource in the @@RXVT_NAME@@(1) manpage).
194 =head2 Variables in the C<urxvt> Package
200 The current terminal. Whenever a callback/Hook is bein executed, this
201 variable stores the current C<urxvt::term> object.
205 =head2 Functions in the C<urxvt> Package
209 =item urxvt::fatal $errormessage
211 Fatally aborts execution with the given error message. Avoid at all
212 costs! The only time this is acceptable is when the terminal process
215 =item urxvt::warn $string
217 Calls C<rxvt_warn> with the given string which should not include a
218 newline. The module also overwrites the C<warn> builtin with a function
219 that calls this function.
221 Using this function has the advantage that its output ends up in the
222 correct place, e.g. on stderr of the connecting urxvtc client.
224 =item $time = urxvt::NOW
226 Returns the "current time" (as per the event loop).
232 Rendition bitsets contain information about colour, font, font styles and
233 similar information for each screen cell.
235 The following "macros" deal with changes in rendition sets. You should
236 never just create a bitset, you should always modify an existing one,
237 as they contain important information required for correct operation of
242 =item $rend = urxvt::DEFAULT_RSTYLE
244 Returns the default rendition, as used when the terminal is starting up or
245 being reset. Useful as a base to start when creating renditions.
247 =item $rend = urxvt::OVERLAY_RSTYLE
249 Return the rendition mask used for overlays by default.
251 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
253 Return the bit that enabled bold, italic, blink, reverse-video and
254 underline, respectively. To enable such a style, just logically OR it into
257 =item $foreground = urxvt::GET_BASEFG $rend
259 =item $background = urxvt::GET_BASEBG $rend
261 Return the foreground/background colour index, respectively.
263 =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
265 =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
267 Replace the foreground/background colour in the rendition mask with the
270 =item $value = urxvt::GET_CUSTOM ($rend)
272 Return the "custom" value: Every rendition has 5 bits for use by
273 extensions. They can be set and changed as you like and are initially
276 =item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
278 Change the custom value.
296 # overwrite perl's warn
297 *CORE::GLOBAL::warn = sub {
298 my $msg = join "", @_;
300 unless $msg =~ /\n$/;
306 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
309 my ($level, $msg) = @_;
310 warn "$msg\n" if $level <= $verbosity;
313 # find on_xxx subs in the package and register them
315 sub register_package($) {
318 for my $htype (0.. $#HOOKNAME) {
319 my $name = $HOOKNAME[$htype];
321 my $ref = $pkg->can ("on_" . lc $name)
324 $TERM->{_hook}[$htype]{$pkg} = $ref;
325 $hook_count[$htype]++
326 or set_should_invoke $htype, 1;
330 my $script_pkg = "script0000";
333 # load a single script into its own package, once only
334 sub script_package($) {
337 $script_pkg{$path} ||= do {
338 my $pkg = "urxvt::" . ($script_pkg++);
340 verbose 3, "loading script '$path' into package '$pkg'";
342 open my $fh, "<:raw", $path
345 my $source = "package $pkg; use strict; use utf8;\n"
346 . "#line 1 \"$path\"\n{\n"
347 . (do { local $/; <$fh> })
350 eval $source or die "$path: $@";
356 # called by the rxvt core
361 if ($htype == 0) { # INIT
362 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
364 for my $ext (split /:/, $TERM->resource ("perl_ext")) {
365 my @files = grep -f $_, map "$_/$ext", @dirs;
368 register_package script_package $files[0];
370 warn "perl extension '$ext' not found in perl library search path\n";
374 } elsif ($htype == 1) { # DESTROY
375 if (my $hook = $TERM->{_hook}) {
376 for my $htype (0..$#$hook) {
377 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
378 or set_should_invoke $htype, 0;
383 my $cb = $TERM->{_hook}[$htype]
386 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
391 while (my ($pkg, $cb) = each %$cb) {
394 $TERM->{$pkg} ||= do {
395 my $proxy = bless { }, urxvt::term::proxy::;
396 Scalar::Util::weaken ($proxy->{term} = $TERM);
406 sub urxvt::term::proxy::AUTOLOAD {
407 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
408 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
411 sub $urxvt::term::proxy::AUTOLOAD {
413 \$proxy->{term}->$1 (\@_)
416 } or die "FATAL: unable to compile method forwarder: $@";
418 goto &$urxvt::term::proxy::AUTOLOAD;
421 =head2 The C<urxvt::term> Class
425 =item $value = $term->resource ($name[, $newval])
427 Returns the current resource value associated with a given name and
428 optionally sets a new value. Setting values is most useful in the C<init>
429 hook. Unset resources are returned and accepted as C<undef>.
431 The new value must be properly encoded to a suitable character encoding
432 before passing it to this method. Similarly, the returned value may need
433 to be converted from the used encoding to text.
435 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
436 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
439 Please note that resource strings will currently only be freed when the
440 terminal is destroyed, so changing options frequently will eat memory.
442 Here is a a likely non-exhaustive list of resource names, not all of which
443 are supported in every build, please see the source to see the actual
446 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
447 borderLess color cursorBlink cursorUnderline cutchars delete_key
448 display_name embed ext_bwidth fade font geometry hold iconName
449 imFont imLocale inputMethod insecure int_bwidth intensityStyles
450 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
451 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
452 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
453 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
454 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
455 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
456 shade term_name title transparent transparent_all tripleclickwords
457 utmpInhibit visualBell
461 sub urxvt::term::resource($$;$) {
462 my ($self, $name) = (shift, shift);
463 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
464 goto &urxvt::term::_resource;
467 =item ($row, $col) = $term->selection_mark ([$row, $col])
469 =item ($row, $col) = $term->selection_beg ([$row, $col])
471 =item ($row, $col) = $term->selection_end ([$row, $col])
473 Return the current values of the selection mark, begin or end positions,
474 and optionally set them to new values.
476 =item $success = $term->selection_grab ($eventtime)
478 Try to request the primary selection from the server (for example, as set
481 =item $oldtext = $term->selection ([$newtext])
483 Return the current selection text and optionally replace it by C<$newtext>.
485 #=item $term->overlay ($x, $y, $text)
487 #Create a simple multi-line overlay box. See the next method for details.
491 sub urxvt::term::scr_overlay {
493 my ($self, $x, $y, $text) = @_;
495 my @lines = split /\n/, $text;
498 for (map $self->strwidth ($_), @lines) {
502 $self->scr_overlay_new ($x, $y, $w, scalar @lines);
503 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
506 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
508 Create a new (empty) overlay at the given position with the given
509 width/height. C<$rstyle> defines the initial rendition style
510 (default: C<OVERLAY_RSTYLE>).
512 If C<$border> is C<2> (default), then a decorative border will be put
515 If either C<$x> or C<$y> is negative, then this is counted from the
516 right/bottom side, respectively.
518 This method returns an urxvt::overlay object. The overlay will be visible
519 as long as the perl object is referenced.
521 The methods currently supported on C<urxvt::overlay> objects are:
525 =item $overlay->set ($x, $y, $text, $rend)
527 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
528 text in rxvt-unicode's special encoding and an array of rendition values
529 at a specific position inside the overlay.
533 If visible, hide the overlay, but do not destroy it.
537 If hidden, display the overlay again.
541 =item $cellwidth = $term->strwidth $string
543 Returns the number of screen-cells this string would need. Correctly
544 accounts for wide and combining characters.
546 =item $octets = $term->locale_encode $string
548 Convert the given text string into the corresponding locale encoding.
550 =item $string = $term->locale_decode $octets
552 Convert the given locale-encoded octets into a perl string.
554 =item $term->tt_write ($octets)
556 Write the octets given in C<$data> to the tty (i.e. as program input). To
557 pass characters instead of octets, you should convert your strings first
558 to the locale-specific encoding using C<< $term->locale_encode >>.
560 =item $nrow = $term->nrow
562 =item $ncol = $term->ncol
564 Return the number of rows/columns of the terminal window (i.e. as
565 specified by C<-geometry>, excluding any scrollback).
567 =item $nsaved = $term->nsaved
569 Returns the number of lines in the scrollback buffer.
571 =item $view_start = $term->view_start ([$newvalue])
573 Returns the negative row number of the topmost line. Minimum value is
574 C<0>, which displays the normal terminal contents. Larger values scroll
575 this many lines into the scrollback buffer.
577 =item $term->want_refresh
579 Requests a screen refresh. At the next opportunity, rxvt-unicode will
580 compare the on-screen display with its stored representation. If they
581 differ, it redraws the differences.
583 Used after changing terminal contents to display them.
585 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
587 Returns the text of the entire row with number C<$row_number>. Row C<0>
588 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
589 terminal line. The scrollback buffer starts at line C<-1> and extends to
590 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
593 If C<$new_text> is specified, it will replace characters in the current
594 line, starting at column C<$start_col> (default C<0>), which is useful
595 to replace only parts of a line. The font index in the rendition will
596 automatically be updated.
598 C<$text> is in a special encoding: tabs and wide characters that use more
599 than one cell when displayed are padded with urxvt::NOCHAR characters
600 (C<chr 65535>). Characters with combining characters and other characters
601 that do not fit into the normal tetx encoding will be replaced with
602 characters in the private use area.
604 You have to obey this encoding when changing text. The advantage is
605 that C<substr> and similar functions work on screen cells and not on
608 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
609 can be used to convert normal strings into this encoding and vice versa.
611 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
613 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
614 bitsets. Rendition bitsets contain information about colour, font, font
615 styles and similar information. See also C<< $term->ROW_t >>.
617 When setting rendition, the font mask will be ignored.
619 See the section on RENDITION, above.
621 =item $length = $term->ROW_l ($row_number[, $new_length])
623 Returns the number of screen cells that are in use ("the line
624 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
625 line is joined with the following one.
627 =item $bool = $term->is_longer ($row_number)
629 Returns true if the row is part of a multiple-row logical "line" (i.e.
630 joined with the following row), which means all characters are in use
631 and it is continued on the next row (and possibly a continuation of the
634 =item $line = $term->line ($row_number)
636 Create and return a new C<urxvt::line> object that stores information
637 about the logical line that row C<$row_number> is part of. It supports the
642 =item $text = $line->t
644 Returns the full text of the line, similar to C<ROW_t>
646 =item $rend = $line->r
648 Returns the full rendition array of the line, similar to C<ROW_r>
650 =item $length = $line->l
652 Returns the length of the line in cells, similar to C<ROW_l>.
654 =item $rownum = $line->beg
656 =item $rownum = $line->end
658 Return the row number of the first/last row of the line, respectively.
660 =item $offset = $line->offset_of ($row, $col)
662 Returns the character offset of the given row|col pair within the logical
665 =item ($row, $col) = $line->coord_of ($offset)
667 Translates a string offset into terminal coordinates again.
673 sub urxvt::term::line {
674 my ($self, $row) = @_;
676 my $maxrow = $self->nrow - 1;
678 my ($beg, $end) = ($row, $row);
680 --$beg while $self->ROW_is_longer ($beg - 1);
681 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
687 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
694 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
702 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
704 $#$rend = $self->{len} - 1;
708 sub urxvt::line::beg { $_[0]{beg} }
709 sub urxvt::line::end { $_[0]{end} }
710 sub urxvt::line::l { $_[0]{len} }
712 sub urxvt::line::offset_of {
713 my ($self, $row, $col) = @_;
715 ($row - $self->{beg}) * $self->{term}->ncol + $col
718 sub urxvt::line::coord_of {
719 my ($self, $offset) = @_;
724 $offset / $self->{term}->ncol + $self->{beg},
725 $offset % $self->{term}->ncol
729 =item ($row, $col) = $line->coord_of ($offset)
730 =item $text = $term->special_encode $string
732 Converts a perl string into the special encoding used by rxvt-unicode,
733 where one character corresponds to one screen cell. See
734 C<< $term->ROW_t >> for details.
736 =item $string = $term->special_decode $text
738 Converts rxvt-unicodes text reprsentation into a perl string. See
739 C<< $term->ROW_t >> for details.
743 =head2 The C<urxvt::timer> Class
745 This class implements timer watchers/events. Time is represented as a
746 fractional number of seconds since the epoch. Example:
748 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
749 $term->{timer} = urxvt::timer
753 $term->{overlay}->set (0, 0,
754 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
759 =item $timer = new urxvt::timer
761 Create a new timer object in started state. It is scheduled to fire
764 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
766 Set the callback to be called when the timer triggers.
768 =item $tstamp = $timer->at
770 Return the time this watcher will fire next.
772 =item $timer = $timer->set ($tstamp)
774 Set the time the event is generated to $tstamp.
776 =item $timer = $timer->interval ($interval)
778 Normally (and when C<$interval> is C<0>), the timer will automatically
779 stop after it has fired once. If C<$interval> is non-zero, then the timer
780 is automatically rescheduled at the given intervals.
782 =item $timer = $timer->start
786 =item $timer = $timer->start ($tstamp)
788 Set the event trigger time to C<$tstamp> and start the timer.
790 =item $timer = $timer->stop
796 =head2 The C<urxvt::iow> Class
798 This class implements io watchers/events. Example:
800 $term->{socket} = ...
801 $term->{iow} = urxvt::iow
803 ->fd (fileno $term->{socket})
804 ->events (1) # wait for read data
807 my ($iow, $revents) = @_;
808 # $revents must be 1 here, no need to check
809 sysread $term->{socket}, my $buf, 8192
816 =item $iow = new urxvt::iow
818 Create a new io watcher object in stopped state.
820 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
822 Set the callback to be called when io events are triggered. C<$reventmask>
823 is a bitset as described in the C<events> method.
825 =item $iow = $iow->fd ($fd)
827 Set the filedescriptor (not handle) to watch.
829 =item $iow = $iow->events ($eventmask)
831 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
832 data, Bit #1 (value C<2>) enables watching for write data.
834 =item $iow = $iow->start
836 Start watching for requested events on the given handle.
838 =item $iow = $iow->stop
840 Stop watching for events on the given filehandle.
846 =head2 URXVT_PERL_VERBOSITY
848 This variable controls the verbosity level of the perl extension. Higher
849 numbers indicate more verbose output.
853 =item 0 - only fatal messages
855 =item 3 - script loading and management
857 =item 10 - all events received
863 Marc Lehmann <pcg@goof.com>
864 http://software.schmorp.de/pkg/rxvt-unicode