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 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.
65 =item example-refresh-hooks
67 Displays a very simple digital clock in the upper right corner of the
68 window. Illustrates overwriting the refresh callbacks to create your own
73 =head2 General API Considerations
75 All objects (such as terminals, time watchers etc.) are typical
76 reference-to-hash objects. The hash can be used to store anything you
77 like. All members starting with an underscore (such as C<_ptr> or
78 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
81 When objects are destroyed on the C++ side, the perl object hashes are
82 emptied, so its best to store related objects such as time watchers and
83 the like inside the terminal object so they get destroyed as soon as the
84 terminal is destroyed.
88 The following subroutines can be declared in loaded scripts, and will be
89 called whenever the relevant event happens.
91 The first argument passed to them is an object private to each terminal
92 and extension package. You can call all C<urxvt::term> methods on it, but
93 its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
94 object that is shared between all packages is stored in the C<term>
97 All of them must return a boolean value. If it is true, then the event
98 counts as being I<consumed>, and the invocation of other hooks is skipped,
99 and the relevant action might not be carried out by the C++ code.
101 When in doubt, return a false value (preferably C<()>).
107 Called after a new terminal object has been initialized, but before
108 windows are created or the command gets run.
112 Called after the screen is "reset" for any reason, such as resizing or
113 control sequences. Here is where you can react on changes to size-related
118 Called at the very end of initialisation of a new terminal, just before
119 returning to the mainloop.
121 =item on_sel_make $term, $eventtime
123 Called whenever a selection has been made by the user, but before the
124 selection text is copied, so changes to the beginning, end or type of the
125 selection will be honored.
127 Returning a true value aborts selection making by urxvt, in which case you
128 have to make a selection yourself by calling C<< $term->selection_grab >>.
130 =item on_sel_grab $term, $eventtime
132 Called whenever a selection has been copied, but before the selection is
133 requested from the server. The selection text can be queried and changed
134 by calling C<< $term->selection >>.
136 Returning a true value aborts selection grabbing. It will still be hilighted.
138 =item on_sel_extend $term
140 Called whenever the user tries to extend the selection (e.g. with a double
141 click) and is either supposed to return false (normal operation), or
142 should extend the selection itelf and return true to suppress the built-in
145 See the F<selection> example extension.
147 =item on_focus_in $term
149 Called whenever the window gets the keyboard focus, before urxvt does
152 =item on_focus_out $term
154 Called wheneever the window loses keyboard focus, before urxvt does focus
157 =item on_view_change $term, $offset
159 Called whenever the view offset changes, i..e the user or program
160 scrolls. Offset C<0> means display the normal terminal, positive values
161 show this many lines of scrollback.
163 =item on_scroll_back $term, $lines, $saved
165 Called whenever lines scroll out of the terminal area into the scrollback
166 buffer. C<$lines> is the number of lines scrolled out and may be larger
167 than the scroll back buffer or the terminal.
169 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
170 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
171 number of lines that will be in the scrollback buffer.
173 =item on_tty_activity $term *NYI*
175 Called whenever the program(s) running in the urxvt window send output.
177 =item on_osc_seq $term, $string
179 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
180 operating system command) is processed. Cursor position and other state
181 information is up-to-date when this happens. For interoperability, the
182 string should start with the extension name and a colon, to distinguish
183 it from commands for other extensions, and this might be enforced in the
186 Be careful not ever to trust (in a security sense) the data you receive,
187 as its source can not easily be controleld (e-mail content, messages from
188 other users on the same system etc.).
190 =item on_refresh_begin $term
192 Called just before the screen gets redrawn. Can be used for overlay
193 or similar effects by modify terminal contents in refresh_begin, and
194 restoring them in refresh_end. The built-in overlay and selection display
195 code is run after this hook, and takes precedence.
197 =item on_refresh_end $term
199 Called just after the screen gets redrawn. See C<on_refresh_begin>.
201 =item on_keyboard_command $term, $string
203 Called whenever the user presses a key combination that has a
204 C<perl:string> action bound to it (see description of the B<keysym>
205 resource in the @@RXVT_NAME@@(1) manpage).
209 =head2 Variables in the C<urxvt> Package
215 The current terminal. Whenever a callback/Hook is bein executed, this
216 variable stores the current C<urxvt::term> object.
220 =head2 Functions in the C<urxvt> Package
224 =item urxvt::fatal $errormessage
226 Fatally aborts execution with the given error message. Avoid at all
227 costs! The only time this is acceptable is when the terminal process
230 =item urxvt::warn $string
232 Calls C<rxvt_warn> with the given string which should not include a
233 newline. The module also overwrites the C<warn> builtin with a function
234 that calls this function.
236 Using this function has the advantage that its output ends up in the
237 correct place, e.g. on stderr of the connecting urxvtc client.
239 =item $time = urxvt::NOW
241 Returns the "current time" (as per the event loop).
247 Rendition bitsets contain information about colour, font, font styles and
248 similar information for each screen cell.
250 The following "macros" deal with changes in rendition sets. You should
251 never just create a bitset, you should always modify an existing one,
252 as they contain important information required for correct operation of
257 =item $rend = urxvt::DEFAULT_RSTYLE
259 Returns the default rendition, as used when the terminal is starting up or
260 being reset. Useful as a base to start when creating renditions.
262 =item $rend = urxvt::OVERLAY_RSTYLE
264 Return the rendition mask used for overlays by default.
266 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
268 Return the bit that enabled bold, italic, blink, reverse-video and
269 underline, respectively. To enable such a style, just logically OR it into
272 =item $foreground = urxvt::GET_BASEFG $rend
274 =item $background = urxvt::GET_BASEBG $rend
276 Return the foreground/background colour index, respectively.
278 =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
280 =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
282 Replace the foreground/background colour in the rendition mask with the
285 =item $value = urxvt::GET_CUSTOM ($rend)
287 Return the "custom" value: Every rendition has 5 bits for use by
288 extensions. They can be set and changed as you like and are initially
291 =item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
293 Change the custom value.
311 # overwrite perl's warn
312 *CORE::GLOBAL::warn = sub {
313 my $msg = join "", @_;
315 unless $msg =~ /\n$/;
321 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
324 my ($level, $msg) = @_;
325 warn "$msg\n" if $level <= $verbosity;
328 # find on_xxx subs in the package and register them
330 sub register_package($) {
333 for my $htype (0.. $#HOOKNAME) {
334 my $name = $HOOKNAME[$htype];
336 my $ref = $pkg->can ("on_" . lc $name)
339 $TERM->{_hook}[$htype]{$pkg} = $ref;
340 $hook_count[$htype]++
341 or set_should_invoke $htype, 1;
345 my $script_pkg = "script0000";
348 # load a single script into its own package, once only
349 sub script_package($) {
352 $script_pkg{$path} ||= do {
353 my $pkg = "urxvt::" . ($script_pkg++);
355 verbose 3, "loading script '$path' into package '$pkg'";
357 open my $fh, "<:raw", $path
360 my $source = "package $pkg; use strict; use utf8;\n"
361 . "#line 1 \"$path\"\n{\n"
362 . (do { local $/; <$fh> })
365 eval $source or die "$path: $@";
371 our $retval; # return value for urxvt
373 # called by the rxvt core
378 if ($htype == 0) { # INIT
379 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
381 for my $ext (map { split /:/, $TERM->resource ("perl_ext_$_") } 1, 2) {
382 my @files = grep -f $_, map "$_/$ext", @dirs;
385 register_package script_package $files[0];
387 warn "perl extension '$ext' not found in perl library search path\n";
394 if (my $cb = $TERM->{_hook}[$htype]) {
395 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
400 while (my ($pkg, $cb) = each %$cb) {
402 $TERM->{_pkg}{$pkg} ||= do {
403 my $proxy = bless { }, urxvt::term::proxy::;
404 Scalar::Util::weaken ($proxy->{term} = $TERM);
412 if ($htype == 1) { # DESTROY
413 # remove hooks if unused
414 if (my $hook = $TERM->{_hook}) {
415 for my $htype (0..$#$hook) {
416 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
417 or set_should_invoke $htype, 0;
421 # clear package objects
422 %$_ = () for values %{ $TERM->{_pkg} };
431 sub urxvt::term::proxy::AUTOLOAD {
432 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
433 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
436 sub $urxvt::term::proxy::AUTOLOAD {
438 \$proxy->{term}->$1 (\@_)
441 } or die "FATAL: unable to compile method forwarder: $@";
443 goto &$urxvt::term::proxy::AUTOLOAD;
446 =head2 The C<urxvt::term> Class
450 =item $value = $term->resource ($name[, $newval])
452 Returns the current resource value associated with a given name and
453 optionally sets a new value. Setting values is most useful in the C<init>
454 hook. Unset resources are returned and accepted as C<undef>.
456 The new value must be properly encoded to a suitable character encoding
457 before passing it to this method. Similarly, the returned value may need
458 to be converted from the used encoding to text.
460 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
461 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
464 Please note that resource strings will currently only be freed when the
465 terminal is destroyed, so changing options frequently will eat memory.
467 Here is a a likely non-exhaustive list of resource names, not all of which
468 are supported in every build, please see the source to see the actual
471 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
472 borderLess color cursorBlink cursorUnderline cutchars delete_key
473 display_name embed ext_bwidth fade font geometry hold iconName
474 imFont imLocale inputMethod insecure int_bwidth intensityStyles
475 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
476 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
477 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
478 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
479 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
480 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
481 shade term_name title transparent transparent_all tripleclickwords
482 utmpInhibit visualBell
486 sub urxvt::term::resource($$;$) {
487 my ($self, $name) = (shift, shift);
488 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
489 goto &urxvt::term::_resource;
492 =item ($row, $col) = $term->selection_mark ([$row, $col])
494 =item ($row, $col) = $term->selection_beg ([$row, $col])
496 =item ($row, $col) = $term->selection_end ([$row, $col])
498 Return the current values of the selection mark, begin or end positions,
499 and optionally set them to new values.
501 =item $success = $term->selection_grab ($eventtime)
503 Try to request the primary selection from the server (for example, as set
506 =item $oldtext = $term->selection ([$newtext])
508 Return the current selection text and optionally replace it by C<$newtext>.
510 #=item $term->overlay ($x, $y, $text)
512 #Create a simple multi-line overlay box. See the next method for details.
516 sub urxvt::term::scr_overlay {
518 my ($self, $x, $y, $text) = @_;
520 my @lines = split /\n/, $text;
523 for (map $self->strwidth ($_), @lines) {
527 $self->scr_overlay_new ($x, $y, $w, scalar @lines);
528 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
531 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
533 Create a new (empty) overlay at the given position with the given
534 width/height. C<$rstyle> defines the initial rendition style
535 (default: C<OVERLAY_RSTYLE>).
537 If C<$border> is C<2> (default), then a decorative border will be put
540 If either C<$x> or C<$y> is negative, then this is counted from the
541 right/bottom side, respectively.
543 This method returns an urxvt::overlay object. The overlay will be visible
544 as long as the perl object is referenced.
546 The methods currently supported on C<urxvt::overlay> objects are:
550 =item $overlay->set ($x, $y, $text, $rend)
552 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
553 text in rxvt-unicode's special encoding and an array of rendition values
554 at a specific position inside the overlay.
558 If visible, hide the overlay, but do not destroy it.
562 If hidden, display the overlay again.
566 =item $cellwidth = $term->strwidth $string
568 Returns the number of screen-cells this string would need. Correctly
569 accounts for wide and combining characters.
571 =item $octets = $term->locale_encode $string
573 Convert the given text string into the corresponding locale encoding.
575 =item $string = $term->locale_decode $octets
577 Convert the given locale-encoded octets into a perl string.
579 =item $term->tt_write ($octets)
581 Write the octets given in C<$data> to the tty (i.e. as program input). To
582 pass characters instead of octets, you should convert your strings first
583 to the locale-specific encoding using C<< $term->locale_encode >>.
585 =item $nrow = $term->nrow
587 =item $ncol = $term->ncol
589 Return the number of rows/columns of the terminal window (i.e. as
590 specified by C<-geometry>, excluding any scrollback).
592 =item $nsaved = $term->nsaved
594 Returns the number of lines in the scrollback buffer.
596 =item $view_start = $term->view_start ([$newvalue])
598 Returns the negative row number of the topmost line. Minimum value is
599 C<0>, which displays the normal terminal contents. Larger values scroll
600 this many lines into the scrollback buffer.
602 =item $term->want_refresh
604 Requests a screen refresh. At the next opportunity, rxvt-unicode will
605 compare the on-screen display with its stored representation. If they
606 differ, it redraws the differences.
608 Used after changing terminal contents to display them.
610 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
612 Returns the text of the entire row with number C<$row_number>. Row C<0>
613 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
614 terminal line. The scrollback buffer starts at line C<-1> and extends to
615 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
618 If C<$new_text> is specified, it will replace characters in the current
619 line, starting at column C<$start_col> (default C<0>), which is useful
620 to replace only parts of a line. The font index in the rendition will
621 automatically be updated.
623 C<$text> is in a special encoding: tabs and wide characters that use more
624 than one cell when displayed are padded with urxvt::NOCHAR characters
625 (C<chr 65535>). Characters with combining characters and other characters
626 that do not fit into the normal tetx encoding will be replaced with
627 characters in the private use area.
629 You have to obey this encoding when changing text. The advantage is
630 that C<substr> and similar functions work on screen cells and not on
633 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
634 can be used to convert normal strings into this encoding and vice versa.
636 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
638 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
639 bitsets. Rendition bitsets contain information about colour, font, font
640 styles and similar information. See also C<< $term->ROW_t >>.
642 When setting rendition, the font mask will be ignored.
644 See the section on RENDITION, above.
646 =item $length = $term->ROW_l ($row_number[, $new_length])
648 Returns the number of screen cells that are in use ("the line
649 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
650 line is joined with the following one.
652 =item $bool = $term->is_longer ($row_number)
654 Returns true if the row is part of a multiple-row logical "line" (i.e.
655 joined with the following row), which means all characters are in use
656 and it is continued on the next row (and possibly a continuation of the
659 =item $line = $term->line ($row_number)
661 Create and return a new C<urxvt::line> object that stores information
662 about the logical line that row C<$row_number> is part of. It supports the
667 =item $text = $line->t
669 Returns the full text of the line, similar to C<ROW_t>
671 =item $rend = $line->r
673 Returns the full rendition array of the line, similar to C<ROW_r>
675 =item $length = $line->l
677 Returns the length of the line in cells, similar to C<ROW_l>.
679 =item $rownum = $line->beg
681 =item $rownum = $line->end
683 Return the row number of the first/last row of the line, respectively.
685 =item $offset = $line->offset_of ($row, $col)
687 Returns the character offset of the given row|col pair within the logical
690 =item ($row, $col) = $line->coord_of ($offset)
692 Translates a string offset into terminal coordinates again.
698 sub urxvt::term::line {
699 my ($self, $row) = @_;
701 my $maxrow = $self->nrow - 1;
703 my ($beg, $end) = ($row, $row);
705 --$beg while $self->ROW_is_longer ($beg - 1);
706 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
712 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
719 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
727 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
729 $#$rend = $self->{len} - 1;
733 sub urxvt::line::beg { $_[0]{beg} }
734 sub urxvt::line::end { $_[0]{end} }
735 sub urxvt::line::l { $_[0]{len} }
737 sub urxvt::line::offset_of {
738 my ($self, $row, $col) = @_;
740 ($row - $self->{beg}) * $self->{term}->ncol + $col
743 sub urxvt::line::coord_of {
744 my ($self, $offset) = @_;
749 $offset / $self->{term}->ncol + $self->{beg},
750 $offset % $self->{term}->ncol
754 =item ($row, $col) = $line->coord_of ($offset)
755 =item $text = $term->special_encode $string
757 Converts a perl string into the special encoding used by rxvt-unicode,
758 where one character corresponds to one screen cell. See
759 C<< $term->ROW_t >> for details.
761 =item $string = $term->special_decode $text
763 Converts rxvt-unicodes text reprsentation into a perl string. See
764 C<< $term->ROW_t >> for details.
768 =head2 The C<urxvt::timer> Class
770 This class implements timer watchers/events. Time is represented as a
771 fractional number of seconds since the epoch. Example:
773 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
774 $term->{timer} = urxvt::timer
778 $term->{overlay}->set (0, 0,
779 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
784 =item $timer = new urxvt::timer
786 Create a new timer object in started state. It is scheduled to fire
789 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
791 Set the callback to be called when the timer triggers.
793 =item $tstamp = $timer->at
795 Return the time this watcher will fire next.
797 =item $timer = $timer->set ($tstamp)
799 Set the time the event is generated to $tstamp.
801 =item $timer = $timer->interval ($interval)
803 Normally (and when C<$interval> is C<0>), the timer will automatically
804 stop after it has fired once. If C<$interval> is non-zero, then the timer
805 is automatically rescheduled at the given intervals.
807 =item $timer = $timer->start
811 =item $timer = $timer->start ($tstamp)
813 Set the event trigger time to C<$tstamp> and start the timer.
815 =item $timer = $timer->stop
821 =head2 The C<urxvt::iow> Class
823 This class implements io watchers/events. Example:
825 $term->{socket} = ...
826 $term->{iow} = urxvt::iow
828 ->fd (fileno $term->{socket})
829 ->events (1) # wait for read data
832 my ($iow, $revents) = @_;
833 # $revents must be 1 here, no need to check
834 sysread $term->{socket}, my $buf, 8192
841 =item $iow = new urxvt::iow
843 Create a new io watcher object in stopped state.
845 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
847 Set the callback to be called when io events are triggered. C<$reventmask>
848 is a bitset as described in the C<events> method.
850 =item $iow = $iow->fd ($fd)
852 Set the filedescriptor (not handle) to watch.
854 =item $iow = $iow->events ($eventmask)
856 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
857 data, Bit #1 (value C<2>) enables watching for write data.
859 =item $iow = $iow->start
861 Start watching for requested events on the given handle.
863 =item $iow = $iow->stop
865 Stop watching for events on the given filehandle.
871 =head2 URXVT_PERL_VERBOSITY
873 This variable controls the verbosity level of the perl extension. Higher
874 numbers indicate more verbose output.
878 =item =0 - only fatal messages
880 =item =3 - script loading and management
882 =item =10 - all events received
888 Marc Lehmann <pcg@goof.com>
889 http://software.schmorp.de/pkg/rxvt-unicode