3 @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
7 # create a file grab_test in $HOME:
10 warn "you selected ", $_[0]->selection;
14 # start a @@RXVT_NAME@@ using it:
16 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
20 Everytime a terminal object gets created, scripts specified via the
21 C<perl> resource are loaded and associated with it.
23 Scripts are compiled in a 'use strict' and 'use utf8' environment, and
24 thus must be encoded as UTF-8.
26 Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
27 scripts will be shared (but not enabled) for all terminals.
29 =head1 PACKAGED EXTENSIONS
31 This section describes the extensiosn delivered with this version. You can
32 find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
34 You can activate them like this:
36 @@RXVT_NAME@@ -pe <extensionname>
42 Miscellaneous selection modifications.
48 Rot-13 the selection when activated. Used via keyboard trigger:
50 URxvt.keysym.C-M-r: perl:selection:rot13
56 Displays a very simple digital clock in the upper right corner of the
57 window. Illustrates overwriting the refresh callbacks to create your own
60 =item simple-overlay-clock
62 Displays a digital clock using the built-in overlay (colorful, useless).
66 =head2 General API Considerations
68 All objects (such as terminals, time watchers etc.) are typical
69 reference-to-hash objects. The hash can be used to store anything you
70 like. All members starting with an underscore (such as C<_ptr> or
71 C<_hook>) are reserved for internal uses and must not be accessed or
74 When objects are destroyed on the C++ side, the perl object hashes are
75 emptied, so its best to store related objects such as time watchers and
76 the like inside the terminal object so they get destroyed as soon as the
77 terminal is destroyed.
81 The following subroutines can be declared in loaded scripts, and will be called
82 whenever the relevant event happens.
84 All of them must return a boolean value. If it is true, then the event
85 counts as being I<consumed>, and the invocation of other hooks is skipped,
86 and the relevant action might not be carried out by the C++ code.
88 When in doubt, return a false value (preferably C<()>).
94 Called after a new terminal object has been initialized, but before
95 windows are created or the command gets run.
99 Called after the screen is "reset" for any reason, such as resizing or
100 control sequences. Here is where you can react on changes to size-related
105 Called at the very end of initialisation of a new terminal, just before
106 returning to the mainloop.
108 =item on_sel_make $term, $eventtime
110 Called whenever a selection has been made by the user, but before the
111 selection text is copied, so changes to the beginning, end or type of the
112 selection will be honored.
114 Returning a true value aborts selection making by urxvt, in which case you
115 have to make a selection yourself by calling C<< $term->selection_grab >>.
117 =item on_sel_grab $term, $eventtime
119 Called whenever a selection has been copied, but before the selection is
120 requested from the server. The selection text can be queried and changed
121 by calling C<< $term->selection >>.
123 Returning a true value aborts selection grabbing. It will still be hilighted.
125 =item on_focus_in $term
127 Called whenever the window gets the keyboard focus, before urxvt does
130 =item on_focus_out $term
132 Called wheneever the window loses keyboard focus, before urxvt does focus
135 =item on_view_change $term, $offset
137 Called whenever the view offset changes, i..e the user or program
138 scrolls. Offset C<0> means display the normal terminal, positive values
139 show this many lines of scrollback.
141 =item on_scroll_back $term, $lines, $saved
143 Called whenever lines scroll out of the terminal area into the scrollback
144 buffer. C<$lines> is the number of lines scrolled out and may be larger
145 than the scroll back buffer or the terminal.
147 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
148 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
149 number of lines that will be in the scrollback buffer.
151 =item on_tty_activity $term *NYI*
153 Called whenever the program(s) running in the urxvt window send output.
155 =item on_refresh_begin $term
157 Called just before the screen gets redrawn. Can be used for overlay
158 or similar effects by modify terminal contents in refresh_begin, and
159 restoring them in refresh_end. The built-in overlay and selection display
160 code is run after this hook, and takes precedence.
162 =item on_refresh_end $term
164 Called just after the screen gets redrawn. See C<on_refresh_begin>.
166 =item on_keyboard_command $term, $string
168 Called whenever the user presses a key combination that has a
169 C<perl:string> action bound to it (see description of the B<keysym>
170 resource in the @@RXVT_NAME@@(1) manpage).
174 =head2 Functions in the C<urxvt> Package
178 =item urxvt::fatal $errormessage
180 Fatally aborts execution with the given error message. Avoid at all
181 costs! The only time this is acceptable is when the terminal process
184 =item urxvt::warn $string
186 Calls C<rxvt_warn> with the given string which should not include a
187 newline. The module also overwrites the C<warn> builtin with a function
188 that calls this function.
190 Using this function has the advantage that its output ends up in the
191 correct place, e.g. on stderr of the connecting urxvtc client.
193 =item $time = urxvt::NOW
195 Returns the "current time" (as per the event loop).
210 # overwrite perl's warn
211 *CORE::GLOBAL::warn = sub {
212 my $msg = join "", @_;
214 unless $msg =~ /\n$/;
220 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
223 my ($level, $msg) = @_;
224 warn "$msg\n" if $level <= $verbosity;
227 # find on_xxx subs in the package and register them
229 sub register_package($) {
232 for my $htype (0.. $#HOOKNAME) {
233 my $name = $HOOKNAME[$htype];
235 my $ref = $pkg->can ("on_" . lc $name)
238 $term->{_hook}[$htype]{$ref*1} = $ref;
239 $hook_count[$htype]++
240 or set_should_invoke $htype, 1;
244 my $script_pkg = "script0000";
247 # load a single script into its own package, once only
248 sub script_package($) {
251 $script_pkg{$path} ||= do {
252 my $pkg = "urxvt::" . ($script_pkg++);
254 verbose 3, "loading script '$path' into package '$pkg'";
256 open my $fh, "<:raw", $path
259 my $source = "package $pkg; use strict; use utf8;\n"
260 . "#line 1 \"$path\"\n{\n"
261 . (do { local $/; <$fh> })
264 eval $source or die "$path: $@";
270 # called by the rxvt core
275 if ($htype == 0) { # INIT
276 my @dirs = ((split /:/, $term->resource ("perl_lib")), "$LIBDIR/perl");
278 for my $ext (split /:/, $term->resource ("perl_ext")) {
279 my @files = grep -f $_, map "$_/$ext", @dirs;
282 register_package script_package $files[0];
284 warn "perl extension '$ext' not found in perl library search path\n";
288 } elsif ($htype == 1) { # DESTROY
289 if (my $hook = $term->{_hook}) {
290 for my $htype (0..$#$hook) {
291 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
292 or set_should_invoke $htype, 0;
297 my $cb = $term->{_hook}[$htype]
300 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $term, @_) . ")"
303 while (my ($k, $v) = each %$cb) {
304 return 1 if $v->($term, @_);
312 =head2 The C<urxvt::term> Class
316 =item $value = $term->resource ($name[, $newval])
318 Returns the current resource value associated with a given name and
319 optionally sets a new value. Setting values is most useful in the C<init>
320 hook. Unset resources are returned and accepted as C<undef>.
322 The new value must be properly encoded to a suitable character encoding
323 before passing it to this method. Similarly, the returned value may need
324 to be converted from the used encoding to text.
326 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
327 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
330 Please note that resource strings will currently only be freed when the
331 terminal is destroyed, so changing options frequently will eat memory.
333 Here is a a likely non-exhaustive list of resource names, not all of which
334 are supported in every build, please see the source to see the actual
337 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
338 borderLess color cursorBlink cursorUnderline cutchars delete_key
339 display_name embed ext_bwidth fade font geometry hold iconName
340 imFont imLocale inputMethod insecure int_bwidth intensityStyles
341 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
342 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext
343 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
344 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
345 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
346 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
347 shade term_name title transparent transparent_all tripleclickwords
348 utmpInhibit visualBell
352 sub urxvt::term::resource($$;$) {
353 my ($self, $name) = (shift, shift);
354 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
355 goto &urxvt::term::_resource;
358 =item ($row, $col) = $term->selection_mark ([$row, $col])
360 =item ($row, $col) = $term->selection_beg ([$row, $col])
362 =item ($row, $col) = $term->selection_end ([$row, $col])
364 Return the current values of the selection mark, begin or end positions,
365 and optionally set them to new values.
367 =item $success = $term->selection_grab ($eventtime)
369 Try to request the primary selection from the server (for example, as set
372 =item $oldtext = $term->selection ([$newtext])
374 Return the current selection text and optionally replace it by C<$newtext>.
376 =item $term->scr_overlay ($x, $y, $text)
378 Create a simple multi-line overlay box. See the next method for details.
382 sub urxvt::term::scr_overlay {
383 my ($self, $x, $y, $text) = @_;
385 my @lines = split /\n/, $text;
388 for (map $self->strwidth ($_), @lines) {
392 $self->scr_overlay_new ($x, $y, $w, scalar @lines);
393 $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
396 =item $term->scr_overlay_new ($x, $y, $width, $height)
398 Create a new (empty) overlay at the given position with the given
399 width/height. A border will be put around the box. If either C<$x> or
400 C<$y> is negative, then this is counted from the right/bottom side,
403 =item $term->scr_overlay_off
405 Switch the overlay off again.
407 =item $term->scr_overlay_set_char ($x, $y, $char, $rend = OVERLAY_RSTYLE)
409 Put a single character (specified numerically) at the given overlay
412 =item $term->scr_overlay_set ($x, $y, $text)
414 Write a string at the given position into the overlay.
416 =item $cellwidth = $term->strwidth $string
418 Returns the number of screen-cells this string would need. Correctly
419 accounts for wide and combining characters.
421 =item $octets = $term->locale_encode $string
423 Convert the given text string into the corresponding locale encoding.
425 =item $string = $term->locale_decode $octets
427 Convert the given locale-encoded octets into a perl string.
429 =item $term->tt_write ($octets)
431 Write the octets given in C<$data> to the tty (i.e. as program input). To
432 pass characters instead of octets, you should convert your strings first
433 to the locale-specific encoding using C<< $term->locale_encode >>.
435 =item $nrow = $term->nrow
437 =item $ncol = $term->ncol
439 Return the number of rows/columns of the terminal window (i.e. as
440 specified by C<-geometry>, excluding any scrollback).
442 =item $nsaved = $term->nsaved
444 Returns the number of lines in the scrollback buffer.
446 =item $view_start = $term->view_start ([$newvalue])
448 Returns the negative row number of the topmost line. Minimum value is
449 C<0>, which displays the normal terminal contents. Larger values scroll
450 this many lines into the scrollback buffer.
452 =item $term->want_refresh
454 Requests a screen refresh. At the next opportunity, rxvt-unicode will
455 compare the on-screen display with its stored representation. If they
456 differ, it redraws the differences.
458 Used after changing terminal contents to display them.
460 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
462 Returns the text of the entire row with number C<$row_number>. Row C<0>
463 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
464 terminal line. The scrollback buffer starts at line C<-1> and extends to
465 line C<< -$term->nsaved >>.
467 If C<$new_text> is specified, it will replace characters in the current
468 line, starting at column C<$start_col> (default C<0>), which is useful
469 to replace only parts of a line. The font iindex in the rendition will
470 automatically be updated.
472 C<$text> is in a special encoding: tabs and wide characters that use more
473 than one cell when displayed are padded with urxvt::NOCHAR characters
474 (C<chr 65535>). Characters with combining characters and other characters
475 that do not fit into the normal tetx encoding will be replaced with
476 characters in the private use area.
478 You have to obey this encoding when changing text. The advantage is
479 that C<substr> and similar functions work on screen cells and not on
482 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
483 can be used to convert normal strings into this encoding and vice versa.
485 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
487 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
488 bitsets. Rendition bitsets contain information about colour, font, font
489 styles and similar information. See also C<< $term->ROW_t >>.
491 When setting rendition, the font mask will be ignored.
493 See the section on RENDITION, below.
495 =item $length = $term->ROW_l ($row_number[, $new_length])
497 Returns the number of screen cells that are in use ("the line length"). If
498 it is C<-1>, then the line is part of a multiple-row logical "line", which
499 means all characters are in use and it is continued on the next row.
501 =item $text = $term->special_encode $string
503 Converts a perl string into the special encoding used by rxvt-unicode,
504 where one character corresponds to one screen cell. See
505 C<< $term->ROW_t >> for details.
507 =item $string = $term->special_decode $text
509 Converts rxvt-unicodes text reprsentation into a perl string. See
510 C<< $term->ROW_t >> for details.
516 Rendition bitsets contain information about colour, font, font styles and
517 similar information for each screen cell.
519 The following "macros" deal with changes in rendition sets. You should
520 never just create a bitset, you should always modify an existing one,
521 as they contain important information required for correct operation of
526 =item $rend = urxvt::DEFAULT_RSTYLE
528 Returns the default rendition, as used when the terminal is starting up or
529 being reset. Useful as a base
535 =head2 The C<urxvt::timer> Class
537 This class implements timer watchers/events. Time is represented as a
538 fractional number of seconds since the epoch. Example:
540 # create a digital clock display in upper right corner
541 $term->{timer} = urxvt::timer
546 my $time = $timer->at;
547 $timer->start ($time + 1);
548 $self->scr_overlay (-1, 0,
549 POSIX::strftime "%H:%M:%S", localtime $time);
554 =item $timer = new urxvt::timer
556 Create a new timer object in stopped state.
558 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
560 Set the callback to be called when the timer triggers.
562 =item $tstamp = $timer->at
564 Return the time this watcher will fire next.
566 =item $timer = $timer->set ($tstamp)
568 Set the time the event is generated to $tstamp.
570 =item $timer = $timer->start
574 =item $timer = $timer->start ($tstamp)
576 Set the event trigger time to C<$tstamp> and start the timer.
578 =item $timer = $timer->stop
584 =head2 The C<urxvt::iow> Class
586 This class implements io watchers/events. Example:
588 $term->{socket} = ...
589 $term->{iow} = urxvt::iow
591 ->fd (fileno $term->{socket})
592 ->events (1) # wait for read data
595 my ($iow, $revents) = @_;
596 # $revents must be 1 here, no need to check
597 sysread $term->{socket}, my $buf, 8192
604 =item $iow = new urxvt::iow
606 Create a new io watcher object in stopped state.
608 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
610 Set the callback to be called when io events are triggered. C<$reventmask>
611 is a bitset as described in the C<events> method.
613 =item $iow = $iow->fd ($fd)
615 Set the filedescriptor (not handle) to watch.
617 =item $iow = $iow->events ($eventmask)
619 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
620 data, Bit #1 (value C<2>) enables watching for write data.
622 =item $iow = $iow->start
624 Start watching for requested events on the given handle.
626 =item $iow = $iow->stop
628 Stop watching for events on the given filehandle.
634 =head2 URXVT_PERL_VERBOSITY
636 This variable controls the verbosity level of the perl extension. Higher
637 numbers indicate more verbose output.
641 =item 0 - only fatal messages
643 =item 3 - script loading and management
645 =item 10 - all events received
651 Marc Lehmann <pcg@goof.com>
652 http://software.schmorp.de/pkg/rxvt-unicode