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 Miscellaneous selection modifications.
50 Rot-13 the selection when activated. Used via keyboard trigger:
52 URxvt.keysym.C-M-r: perl:selection:rot13
58 Displays a very simple digital clock in the upper right corner of the
59 window. Illustrates overwriting the refresh callbacks to create your own
62 =item simple-overlay-clock
64 Displays a digital clock using the built-in overlay (colourful, useless).
68 =head2 General API Considerations
70 All objects (such as terminals, time watchers etc.) are typical
71 reference-to-hash objects. The hash can be used to store anything you
72 like. All members starting with an underscore (such as C<_ptr> or
73 C<_hook>) are reserved for internal uses and must not be accessed or
76 When objects are destroyed on the C++ side, the perl object hashes are
77 emptied, so its best to store related objects such as time watchers and
78 the like inside the terminal object so they get destroyed as soon as the
79 terminal is destroyed.
83 The following subroutines can be declared in loaded scripts, and will be called
84 whenever the relevant event happens.
86 All of them must return a boolean value. If it is true, then the event
87 counts as being I<consumed>, and the invocation of other hooks is skipped,
88 and the relevant action might not be carried out by the C++ code.
90 When in doubt, return a false value (preferably C<()>).
96 Called after a new terminal object has been initialized, but before
97 windows are created or the command gets run.
101 Called after the screen is "reset" for any reason, such as resizing or
102 control sequences. Here is where you can react on changes to size-related
107 Called at the very end of initialisation of a new terminal, just before
108 returning to the mainloop.
110 =item on_sel_make $term, $eventtime
112 Called whenever a selection has been made by the user, but before the
113 selection text is copied, so changes to the beginning, end or type of the
114 selection will be honored.
116 Returning a true value aborts selection making by urxvt, in which case you
117 have to make a selection yourself by calling C<< $term->selection_grab >>.
119 =item on_sel_grab $term, $eventtime
121 Called whenever a selection has been copied, but before the selection is
122 requested from the server. The selection text can be queried and changed
123 by calling C<< $term->selection >>.
125 Returning a true value aborts selection grabbing. It will still be hilighted.
127 =item on_focus_in $term
129 Called whenever the window gets the keyboard focus, before urxvt does
132 =item on_focus_out $term
134 Called wheneever the window loses keyboard focus, before urxvt does focus
137 =item on_view_change $term, $offset
139 Called whenever the view offset changes, i..e the user or program
140 scrolls. Offset C<0> means display the normal terminal, positive values
141 show this many lines of scrollback.
143 =item on_scroll_back $term, $lines, $saved
145 Called whenever lines scroll out of the terminal area into the scrollback
146 buffer. C<$lines> is the number of lines scrolled out and may be larger
147 than the scroll back buffer or the terminal.
149 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
150 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
151 number of lines that will be in the scrollback buffer.
153 =item on_tty_activity $term *NYI*
155 Called whenever the program(s) running in the urxvt window send output.
157 =item on_refresh_begin $term
159 Called just before the screen gets redrawn. Can be used for overlay
160 or similar effects by modify terminal contents in refresh_begin, and
161 restoring them in refresh_end. The built-in overlay and selection display
162 code is run after this hook, and takes precedence.
164 =item on_refresh_end $term
166 Called just after the screen gets redrawn. See C<on_refresh_begin>.
168 =item on_keyboard_command $term, $string
170 Called whenever the user presses a key combination that has a
171 C<perl:string> action bound to it (see description of the B<keysym>
172 resource in the @@RXVT_NAME@@(1) manpage).
176 =head2 Functions in the C<urxvt> Package
180 =item urxvt::fatal $errormessage
182 Fatally aborts execution with the given error message. Avoid at all
183 costs! The only time this is acceptable is when the terminal process
186 =item urxvt::warn $string
188 Calls C<rxvt_warn> with the given string which should not include a
189 newline. The module also overwrites the C<warn> builtin with a function
190 that calls this function.
192 Using this function has the advantage that its output ends up in the
193 correct place, e.g. on stderr of the connecting urxvtc client.
195 =item $time = urxvt::NOW
197 Returns the "current time" (as per the event loop).
201 Rendition bitsets contain information about colour, font, font styles and
202 similar information for each screen cell.
204 The following "macros" deal with changes in rendition sets. You should
205 never just create a bitset, you should always modify an existing one,
206 as they contain important information required for correct operation of
211 =item $rend = urxvt::DEFAULT_RSTYLE
213 Returns the default rendition, as used when the terminal is starting up or
214 being reset. Useful as a base to start when creating renditions.
216 =item $rend = urxvt::OVERLAY_RSTYLE
218 Return the rendition mask used for overlays by default.
220 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
222 Return the bit that enabled bold, italic, blink, reverse-video and
223 underline, respectively. To enable such a style, just logically OR it into
226 =item $foreground = urxvt::GET_BASEFG $rend
228 =item $background = urxvt::GET_BASEBG $rend
230 Return the foreground/background colour index, respectively.
232 =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
234 =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
236 Replace the foreground/background colour in the rendition mask with the
239 =item $value = urxvt::GET_CUSTOM ($rend)
241 Return the "custom" value: Every rendition has 5 bits for use by
242 extensions. They can be set and changed as you like and are initially
245 =item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
247 Change the custom value.
264 # overwrite perl's warn
265 *CORE::GLOBAL::warn = sub {
266 my $msg = join "", @_;
268 unless $msg =~ /\n$/;
274 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
277 my ($level, $msg) = @_;
278 warn "$msg\n" if $level <= $verbosity;
281 # find on_xxx subs in the package and register them
283 sub register_package($) {
286 for my $htype (0.. $#HOOKNAME) {
287 my $name = $HOOKNAME[$htype];
289 my $ref = $pkg->can ("on_" . lc $name)
292 $term->{_hook}[$htype]{$ref*1} = $ref;
293 $hook_count[$htype]++
294 or set_should_invoke $htype, 1;
298 my $script_pkg = "script0000";
301 # load a single script into its own package, once only
302 sub script_package($) {
305 $script_pkg{$path} ||= do {
306 my $pkg = "urxvt::" . ($script_pkg++);
308 verbose 3, "loading script '$path' into package '$pkg'";
310 open my $fh, "<:raw", $path
313 my $source = "package $pkg; use strict; use utf8;\n"
314 . "#line 1 \"$path\"\n{\n"
315 . (do { local $/; <$fh> })
318 eval $source or die "$path: $@";
324 # called by the rxvt core
329 if ($htype == 0) { # INIT
330 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
332 for my $ext (split /:/, $term->resource ("perl_ext")) {
333 my @files = grep -f $_, map "$_/$ext", @dirs;
336 register_package script_package $files[0];
338 warn "perl extension '$ext' not found in perl library search path\n";
342 } elsif ($htype == 1) { # DESTROY
343 if (my $hook = $term->{_hook}) {
344 for my $htype (0..$#$hook) {
345 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
346 or set_should_invoke $htype, 0;
351 my $cb = $term->{_hook}[$htype]
354 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
357 while (my ($k, $v) = each %$cb) {
358 return 1 if $v->($term, @_);
366 =head2 The C<urxvt::term> Class
370 =item $value = $term->resource ($name[, $newval])
372 Returns the current resource value associated with a given name and
373 optionally sets a new value. Setting values is most useful in the C<init>
374 hook. Unset resources are returned and accepted as C<undef>.
376 The new value must be properly encoded to a suitable character encoding
377 before passing it to this method. Similarly, the returned value may need
378 to be converted from the used encoding to text.
380 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
381 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
384 Please note that resource strings will currently only be freed when the
385 terminal is destroyed, so changing options frequently will eat memory.
387 Here is a a likely non-exhaustive list of resource names, not all of which
388 are supported in every build, please see the source to see the actual
391 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
392 borderLess color cursorBlink cursorUnderline cutchars delete_key
393 display_name embed ext_bwidth fade font geometry hold iconName
394 imFont imLocale inputMethod insecure int_bwidth intensityStyles
395 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
396 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
397 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
398 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
399 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
400 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
401 shade term_name title transparent transparent_all tripleclickwords
402 utmpInhibit visualBell
406 sub urxvt::term::resource($$;$) {
407 my ($self, $name) = (shift, shift);
408 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
409 goto &urxvt::term::_resource;
412 =item ($row, $col) = $term->selection_mark ([$row, $col])
414 =item ($row, $col) = $term->selection_beg ([$row, $col])
416 =item ($row, $col) = $term->selection_end ([$row, $col])
418 Return the current values of the selection mark, begin or end positions,
419 and optionally set them to new values.
421 =item $success = $term->selection_grab ($eventtime)
423 Try to request the primary selection from the server (for example, as set
426 =item $oldtext = $term->selection ([$newtext])
428 Return the current selection text and optionally replace it by C<$newtext>.
430 =item $term->scr_overlay ($x, $y, $text)
432 Create a simple multi-line overlay box. See the next method for details.
436 sub urxvt::term::scr_overlay {
437 my ($self, $x, $y, $text) = @_;
439 my @lines = split /\n/, $text;
442 for (map $self->strwidth ($_), @lines) {
446 $self->scr_overlay_new ($x, $y, $w, scalar @lines);
447 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
450 =item $term->scr_overlay_new ($x, $y, $width, $height)
452 Create a new (empty) overlay at the given position with the given
453 width/height. A border will be put around the box. If either C<$x> or
454 C<$y> is negative, then this is counted from the right/bottom side,
457 =item $term->scr_overlay_off
459 Switch the overlay off again.
461 =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)
463 Put a single character (specified numerically) at the given overlay
466 =item $term->scr_overlay_set ($x, $y, $text)
468 Write a string at the given position into the overlay.
470 =item $cellwidth = $term->strwidth $string
472 Returns the number of screen-cells this string would need. Correctly
473 accounts for wide and combining characters.
475 =item $octets = $term->locale_encode $string
477 Convert the given text string into the corresponding locale encoding.
479 =item $string = $term->locale_decode $octets
481 Convert the given locale-encoded octets into a perl string.
483 =item $term->tt_write ($octets)
485 Write the octets given in C<$data> to the tty (i.e. as program input). To
486 pass characters instead of octets, you should convert your strings first
487 to the locale-specific encoding using C<< $term->locale_encode >>.
489 =item $nrow = $term->nrow
491 =item $ncol = $term->ncol
493 Return the number of rows/columns of the terminal window (i.e. as
494 specified by C<-geometry>, excluding any scrollback).
496 =item $nsaved = $term->nsaved
498 Returns the number of lines in the scrollback buffer.
500 =item $view_start = $term->view_start ([$newvalue])
502 Returns the negative row number of the topmost line. Minimum value is
503 C<0>, which displays the normal terminal contents. Larger values scroll
504 this many lines into the scrollback buffer.
506 =item $term->want_refresh
508 Requests a screen refresh. At the next opportunity, rxvt-unicode will
509 compare the on-screen display with its stored representation. If they
510 differ, it redraws the differences.
512 Used after changing terminal contents to display them.
514 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
516 Returns the text of the entire row with number C<$row_number>. Row C<0>
517 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
518 terminal line. The scrollback buffer starts at line C<-1> and extends to
519 line C<< -$term->nsaved >>.
521 If C<$new_text> is specified, it will replace characters in the current
522 line, starting at column C<$start_col> (default C<0>), which is useful
523 to replace only parts of a line. The font index in the rendition will
524 automatically be updated.
526 C<$text> is in a special encoding: tabs and wide characters that use more
527 than one cell when displayed are padded with urxvt::NOCHAR characters
528 (C<chr 65535>). Characters with combining characters and other characters
529 that do not fit into the normal tetx encoding will be replaced with
530 characters in the private use area.
532 You have to obey this encoding when changing text. The advantage is
533 that C<substr> and similar functions work on screen cells and not on
536 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
537 can be used to convert normal strings into this encoding and vice versa.
539 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
541 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
542 bitsets. Rendition bitsets contain information about colour, font, font
543 styles and similar information. See also C<< $term->ROW_t >>.
545 When setting rendition, the font mask will be ignored.
547 See the section on RENDITION, above.
549 =item $length = $term->ROW_l ($row_number[, $new_length])
551 Returns the number of screen cells that are in use ("the line length"). If
552 it is C<-1>, then the line is part of a multiple-row logical "line", which
553 means all characters are in use and it is continued on the next row.
555 =item $text = $term->special_encode $string
557 Converts a perl string into the special encoding used by rxvt-unicode,
558 where one character corresponds to one screen cell. See
559 C<< $term->ROW_t >> for details.
561 =item $string = $term->special_decode $text
563 Converts rxvt-unicodes text reprsentation into a perl string. See
564 C<< $term->ROW_t >> for details.
568 =head2 The C<urxvt::timer> Class
570 This class implements timer watchers/events. Time is represented as a
571 fractional number of seconds since the epoch. Example:
573 # create a digital clock display in upper right corner
574 $term->{timer} = urxvt::timer
579 my $time = $timer->at;
580 $timer->start ($time + 1);
581 $self->scr_overlay (-1, 0,
582 POSIX::strftime "%H:%M:%S", localtime $time);
587 =item $timer = new urxvt::timer
589 Create a new timer object in stopped state.
591 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
593 Set the callback to be called when the timer triggers.
595 =item $tstamp = $timer->at
597 Return the time this watcher will fire next.
599 =item $timer = $timer->set ($tstamp)
601 Set the time the event is generated to $tstamp.
603 =item $timer = $timer->start
607 =item $timer = $timer->start ($tstamp)
609 Set the event trigger time to C<$tstamp> and start the timer.
611 =item $timer = $timer->stop
617 =head2 The C<urxvt::iow> Class
619 This class implements io watchers/events. Example:
621 $term->{socket} = ...
622 $term->{iow} = urxvt::iow
624 ->fd (fileno $term->{socket})
625 ->events (1) # wait for read data
628 my ($iow, $revents) = @_;
629 # $revents must be 1 here, no need to check
630 sysread $term->{socket}, my $buf, 8192
637 =item $iow = new urxvt::iow
639 Create a new io watcher object in stopped state.
641 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
643 Set the callback to be called when io events are triggered. C<$reventmask>
644 is a bitset as described in the C<events> method.
646 =item $iow = $iow->fd ($fd)
648 Set the filedescriptor (not handle) to watch.
650 =item $iow = $iow->events ($eventmask)
652 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
653 data, Bit #1 (value C<2>) enables watching for write data.
655 =item $iow = $iow->start
657 Start watching for requested events on the given handle.
659 =item $iow = $iow->stop
661 Stop watching for events on the given filehandle.
667 =head2 URXVT_PERL_VERBOSITY
669 This variable controls the verbosity level of the perl extension. Higher
670 numbers indicate more verbose output.
674 =item 0 - only fatal messages
676 =item 3 - script loading and management
678 =item 10 - all events received
684 Marc Lehmann <pcg@goof.com>
685 http://software.schmorp.de/pkg/rxvt-unicode