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>
42 =item selection (enabled by default)
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
61 =item option-popup (enabled by default)
63 Binds a popup menu to Ctrl-Button3 that lets you toggle (some) options at
68 Displays a digital clock using the built-in overlay.
72 Uses per-line display filtering (C<on_line_update>) to underline urls.
74 =item block-graphics-to-ascii
76 A not very useful example of filtering all text output to the terminal,
77 by replacing all line-drawing characters (U+2500 .. U+259F) by a
78 similar-looking ascii character.
80 =item example-refresh-hooks
82 Displays a very simple digital clock in the upper right corner of the
83 window. Illustrates overwriting the refresh callbacks to create your own
88 =head2 General API Considerations
90 All objects (such as terminals, time watchers etc.) are typical
91 reference-to-hash objects. The hash can be used to store anything you
92 like. All members starting with an underscore (such as C<_ptr> or
93 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
96 When objects are destroyed on the C++ side, the perl object hashes are
97 emptied, so its best to store related objects such as time watchers and
98 the like inside the terminal object so they get destroyed as soon as the
99 terminal is destroyed.
101 Argument names also often indicate the type of a parameter. Here are some
102 hints on what they mean:
108 Rxvt-unicodes special way of encoding text, where one "unicode" character
109 always represents one screen cell. See L<row_t> for a discussion of this format.
113 A perl text string, with an emphasis on I<text>. It can store all unicode
114 characters and is to be distinguished with text encoded in a specific
115 encoding (often locale-specific) and binary data.
119 Either binary data or - more common - a text string encoded in a
126 The following subroutines can be declared in extension files, and will be
127 called whenever the relevant event happens.
129 The first argument passed to them is an object private to each terminal
130 and extension package. You can call all C<urxvt::term> methods on it, but
131 its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132 object that is shared between all packages is stored in the C<term>
133 member. It is, however, blessed intot he package of the extension script,
134 so for all practical purposes you can treat an extension script as a class.
136 All of them must return a boolean value. If it is true, then the event
137 counts as being I<consumed>, and the invocation of other hooks is skipped,
138 and the relevant action might not be carried out by the C++ code.
140 When in doubt, return a false value (preferably C<()>).
146 Called after a new terminal object has been initialized, but before
147 windows are created or the command gets run. Most methods are unsafe to
148 call or deliver senseless data, as terminal size and other characteristics
149 have not yet been determined. You can safely query and change resources,
154 Called after the screen is "reset" for any reason, such as resizing or
155 control sequences. Here is where you can react on changes to size-related
160 Called at the very end of initialisation of a new terminal, just before
161 returning to the mainloop.
163 =item on_sel_make $term, $eventtime
165 Called whenever a selection has been made by the user, but before the
166 selection text is copied, so changes to the beginning, end or type of the
167 selection will be honored.
169 Returning a true value aborts selection making by urxvt, in which case you
170 have to make a selection yourself by calling C<< $term->selection_grab >>.
172 =item on_sel_grab $term, $eventtime
174 Called whenever a selection has been copied, but before the selection is
175 requested from the server. The selection text can be queried and changed
176 by calling C<< $term->selection >>.
178 Returning a true value aborts selection grabbing. It will still be hilighted.
180 =item on_sel_extend $term
182 Called whenever the user tries to extend the selection (e.g. with a double
183 click) and is either supposed to return false (normal operation), or
184 should extend the selection itelf and return true to suppress the built-in
187 See the F<selection> example extension.
189 =item on_view_change $term, $offset
191 Called whenever the view offset changes, i..e the user or program
192 scrolls. Offset C<0> means display the normal terminal, positive values
193 show this many lines of scrollback.
195 =item on_scroll_back $term, $lines, $saved
197 Called whenever lines scroll out of the terminal area into the scrollback
198 buffer. C<$lines> is the number of lines scrolled out and may be larger
199 than the scroll back buffer or the terminal.
201 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
202 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
203 number of lines that will be in the scrollback buffer.
205 =item on_tty_activity $term *NYI*
207 Called whenever the program(s) running in the urxvt window send output.
209 =item on_osc_seq $term, $string
211 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212 operating system command) is processed. Cursor position and other state
213 information is up-to-date when this happens. For interoperability, the
214 string should start with the extension name and a colon, to distinguish
215 it from commands for other extensions, and this might be enforced in the
218 Be careful not ever to trust (in a security sense) the data you receive,
219 as its source can not easily be controleld (e-mail content, messages from
220 other users on the same system etc.).
222 =item on_add_lines $term, $string
224 Called whenever text is about to be output, with the text as argument. You
225 can filter/change and output the text yourself by returning a true value
226 and calling C<< $term->scr_add_lines >> yourself. Please note that this
227 might be very slow, however, as your hook is called for B<all> text being
230 =item on_line_update $term, $row
232 Called whenever a line was updated or changed. Can be used to filter
233 screen output (e.g. underline urls or other useless stuff). Only lines
234 that are being shown will be filtered, and, due to performance reasons,
235 not always immediately.
237 The row number is always the topmost row of the line if the line spans
240 Please note that, if you change the line, then the hook might get called
241 later with the already-modified line (e.g. if unrelated parts change), so
242 you cannot just toggle rendition bits, but only set them.
244 =item on_refresh_begin $term
246 Called just before the screen gets redrawn. Can be used for overlay
247 or similar effects by modify terminal contents in refresh_begin, and
248 restoring them in refresh_end. The built-in overlay and selection display
249 code is run after this hook, and takes precedence.
251 =item on_refresh_end $term
253 Called just after the screen gets redrawn. See C<on_refresh_begin>.
255 =item on_keyboard_command $term, $string
257 Called whenever the user presses a key combination that has a
258 C<perl:string> action bound to it (see description of the B<keysym>
259 resource in the @@RXVT_NAME@@(1) manpage).
261 =item on_focus_in $term
263 Called whenever the window gets the keyboard focus, before rxvt-unicode
264 does focus in processing.
266 =item on_focus_out $term
268 Called wheneever the window loses keyboard focus, before rxvt-unicode does
269 focus out processing.
271 =item on_key_press $term, $event, $octets
273 =item on_key_release $term, $event
275 =item on_button_press $term, $event
277 =item on_button_release $term, $event
279 =item on_motion_notify $term, $event
281 =item on_map_notify $term, $event
283 =item on_unmap_notify $term, $event
285 Called whenever the corresponding X event is received for the terminal If
286 the hook returns true, then the even will be ignored by rxvt-unicode.
288 The event is a hash with most values as named by Xlib (see the XEvent
289 manpage), with the additional members C<row> and C<col>, which are the row
290 and column under the mouse cursor.
292 C<on_key_press> additionally receives the string rxvt-unicode would
293 output, if any, in locale-specific encoding.
299 =head2 Variables in the C<urxvt> Package
305 The current terminal. This variable stores the current C<urxvt::term>
306 object, whenever a callback/hook is executing.
310 =head2 Functions in the C<urxvt> Package
314 =item $term = new urxvt [arg...]
316 Creates a new terminal, very similar as if you had started it with
317 C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318 if the new instance couldn't be created. Returns C<undef> if the new
319 instance didn't initialise perl, and the terminal object otherwise. The
320 C<init> and C<start> hooks will be called during the call.
322 =item urxvt::fatal $errormessage
324 Fatally aborts execution with the given error message. Avoid at all
325 costs! The only time this is acceptable is when the terminal process
328 =item urxvt::warn $string
330 Calls C<rxvt_warn> with the given string which should not include a
331 newline. The module also overwrites the C<warn> builtin with a function
332 that calls this function.
334 Using this function has the advantage that its output ends up in the
335 correct place, e.g. on stderr of the connecting urxvtc client.
337 =item $time = urxvt::NOW
339 Returns the "current time" (as per the event loop).
341 =item urxvt::CurrentTime
343 =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344 Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345 Button4Mask, Button5Mask, AnyModifier
347 Various constants for use in X calls and event processing.
353 Rendition bitsets contain information about colour, font, font styles and
354 similar information for each screen cell.
356 The following "macros" deal with changes in rendition sets. You should
357 never just create a bitset, you should always modify an existing one,
358 as they contain important information required for correct operation of
363 =item $rend = urxvt::DEFAULT_RSTYLE
365 Returns the default rendition, as used when the terminal is starting up or
366 being reset. Useful as a base to start when creating renditions.
368 =item $rend = urxvt::OVERLAY_RSTYLE
370 Return the rendition mask used for overlays by default.
372 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
374 Return the bit that enabled bold, italic, blink, reverse-video and
375 underline, respectively. To enable such a style, just logically OR it into
378 =item $foreground = urxvt::GET_BASEFG $rend
380 =item $background = urxvt::GET_BASEBG $rend
382 Return the foreground/background colour index, respectively.
384 =item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
386 =item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
388 Replace the foreground/background colour in the rendition mask with the
391 =item $value = urxvt::GET_CUSTOM ($rend)
393 Return the "custom" value: Every rendition has 5 bits for use by
394 extensions. They can be set and changed as you like and are initially
397 =item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
399 Change the custom value.
421 # overwrite perl's warn
422 *CORE::GLOBAL::warn = sub {
423 my $msg = join "", @_;
425 unless $msg =~ /\n$/;
431 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
434 my ($level, $msg) = @_;
435 warn "$msg\n" if $level <= $verbosity;
438 # find on_xxx subs in the package and register them
440 sub register_package($) {
443 for my $htype (0.. $#HOOKNAME) {
444 my $name = $HOOKNAME[$htype];
446 my $ref = $pkg->can ("on_" . lc $name)
449 $TERM->{_hook}[$htype]{$pkg} = $ref;
450 $hook_count[$htype]++
451 or set_should_invoke $htype, 1;
455 my $extension_pkg = "extension0000";
458 # load a single script into its own package, once only
459 sub extension_package($) {
462 $extension_pkg{$path} ||= do {
463 my $pkg = "urxvt::" . ($extension_pkg++);
465 verbose 3, "loading extension '$path' into package '$pkg'";
467 open my $fh, "<:raw", $path
470 my $source = "package $pkg; use strict; use utf8;\n"
471 . "use base urxvt::term::proxy::;\n"
472 . "#line 1 \"$path\"\n{\n"
473 . (do { local $/; <$fh> })
476 eval $source or die "$path: $@";
482 our $retval; # return value for urxvt
484 # called by the rxvt core
489 if ($htype == 0) { # INIT
490 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
494 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
495 if ($_ eq "default") {
496 $want_ext{$_}++ for qw(selection option-popup);
497 } elsif (/^-(.*)$/) {
498 delete $want_ext{$1};
504 for my $ext (keys %want_ext) {
505 my @files = grep -f $_, map "$_/$ext", @dirs;
508 register_package extension_package $files[0];
510 warn "perl extension '$ext' not found in perl library search path\n";
514 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
520 if (my $cb = $TERM->{_hook}[$htype]) {
521 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
526 while (my ($pkg, $cb) = each %$cb) {
529 $TERM->{_pkg}{$pkg} ||= do {
530 my $proxy = bless { }, $pkg;
531 Scalar::Util::weaken ($proxy->{term} = $TERM);
541 if ($htype == 1) { # DESTROY
542 # remove hooks if unused
543 if (my $hook = $TERM->{_hook}) {
544 for my $htype (0..$#$hook) {
545 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
546 or set_should_invoke $htype, 0;
550 # clear package objects
551 %$_ = () for values %{ $TERM->{_pkg} };
562 sub urxvt::term::proxy::AUTOLOAD {
563 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/
564 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable";
567 sub $urxvt::term::proxy::AUTOLOAD {
569 \$proxy->{term}->$1 (\@_)
572 } or die "FATAL: unable to compile method forwarder: $@";
574 goto &$urxvt::term::proxy::AUTOLOAD;
577 # urxvt::destroy_hook
579 sub urxvt::destroy_hook::DESTROY {
583 sub urxvt::destroy_hook(&) {
584 bless \shift, urxvt::destroy_hook::
587 package urxvt::anyevent;
589 =head2 The C<urxvt::anyevent> Class
591 The sole purpose of this class is to deliver an interface to the
592 C<AnyEvent> module - any module using it will work inside urxvt without
593 further work. The only exception is that you cannot wait on condition
594 variables, but non-blocking condvar use is ok. What this means is that you
595 cannot use blocking APIs, but the non-blocking variant should work.
601 $INC{"urxvt/anyevent.pm"} = 1; # mark us as there
602 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
605 my ($class, %arg) = @_;
611 ->start (urxvt::NOW + $arg{after})
613 $_[0]->stop; # need to cancel manually
619 my ($class, %arg) = @_;
623 bless [$arg{fh}, urxvt::iow
625 ->fd (fileno $arg{fh})
626 ->events (($arg{poll} =~ /r/ ? 1 : 0)
627 | ($arg{poll} =~ /w/ ? 2 : 0))
630 $cb->(($_[1] & 1 ? 'r' : '')
631 . ($_[1] & 2 ? 'w' : ''));
641 bless \my $flag, urxvt::anyevent::condvar::
644 sub urxvt::anyevent::condvar::broadcast {
648 sub urxvt::anyevent::condvar::wait {
651 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API");
657 =head2 The C<urxvt::term> Class
663 Destroy the terminal object (close the window, free resources etc.).
665 =item $isset = $term->option ($optval[, $set])
667 Returns true if the option specified by C<$optval> is enabled, and
668 optionally change it. All option values are stored by name in the hash
669 C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
671 Here is a a likely non-exhaustive list of option names, please see the
672 source file F</src/optinc.h> to see the actual list:
674 borderLess console cursorBlink cursorUnderline hold iconic insecure
675 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
676 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
677 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
678 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
679 tripleclickwords utmpInhibit visualBell
681 =item $value = $term->resource ($name[, $newval])
683 Returns the current resource value associated with a given name and
684 optionally sets a new value. Setting values is most useful in the C<init>
685 hook. Unset resources are returned and accepted as C<undef>.
687 The new value must be properly encoded to a suitable character encoding
688 before passing it to this method. Similarly, the returned value may need
689 to be converted from the used encoding to text.
691 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
692 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
695 Please note that resource strings will currently only be freed when the
696 terminal is destroyed, so changing options frequently will eat memory.
698 Here is a a likely non-exhaustive list of resource names, not all of which
699 are supported in every build, please see the source file F</src/rsinc.h>
700 to see the actual list:
702 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
703 borderLess color cursorBlink cursorUnderline cutchars delete_key
704 display_name embed ext_bwidth fade font geometry hold iconName
705 imFont imLocale inputMethod insecure int_bwidth intensityStyles
706 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
707 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
708 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
709 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
710 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
711 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
712 shade term_name title transparent transparent_all tripleclickwords
713 utmpInhibit visualBell
718 my ($self, $name) = (shift, shift);
719 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
720 &urxvt::term::_resource
723 =item $rend = $term->rstyle ([$new_rstyle])
725 Return and optionally change the current rendition. Text that is output by
726 the terminal application will use this style.
728 =item ($row, $col) = $term->screen_cur ([$row, $col])
730 Return the current coordinates of the text cursor position and optionally
731 set it (which is usually bad as applications don't expect that).
733 =item ($row, $col) = $term->selection_mark ([$row, $col])
735 =item ($row, $col) = $term->selection_beg ([$row, $col])
737 =item ($row, $col) = $term->selection_end ([$row, $col])
739 Return the current values of the selection mark, begin or end positions,
740 and optionally set them to new values.
742 =item $success = $term->selection_grab ($eventtime)
744 Try to request the primary selection from the server (for example, as set
747 =item $oldtext = $term->selection ([$newtext])
749 Return the current selection text and optionally replace it by C<$newtext>.
751 #=item $term->overlay ($x, $y, $text)
753 #Create a simple multi-line overlay box. See the next method for details.
757 #sub urxvt::term::scr_overlay {
758 # my ($self, $x, $y, $text) = @_;
760 # my @lines = split /\n/, $text;
763 # for (map $self->strwidth ($_), @lines) {
764 # $w = $_ if $w < $_;
767 # $self->scr_overlay_new ($x, $y, $w, scalar @lines);
768 # $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines;
771 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
773 Create a new (empty) overlay at the given position with the given
774 width/height. C<$rstyle> defines the initial rendition style
775 (default: C<OVERLAY_RSTYLE>).
777 If C<$border> is C<2> (default), then a decorative border will be put
780 If either C<$x> or C<$y> is negative, then this is counted from the
781 right/bottom side, respectively.
783 This method returns an urxvt::overlay object. The overlay will be visible
784 as long as the perl object is referenced.
786 The methods currently supported on C<urxvt::overlay> objects are:
790 =item $overlay->set ($x, $y, $text, $rend)
792 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
793 text in rxvt-unicode's special encoding and an array of rendition values
794 at a specific position inside the overlay.
798 If visible, hide the overlay, but do not destroy it.
802 If hidden, display the overlay again.
806 =item $popup = $term->popup ($event)
808 Creates a new C<urxvt::popup> object that implements a popup menu. The
809 C<$event> I<must> be the event causing the menu to pop up (a button event,
815 my ($self, $event) = @_;
817 $self->grab ($event->{time}, 1)
825 Scalar::Util::weaken $popup->{term};
827 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
828 Scalar::Util::weaken $self->{_destroy}{$popup};
833 =item $cellwidth = $term->strwidth ($string)
835 Returns the number of screen-cells this string would need. Correctly
836 accounts for wide and combining characters.
838 =item $octets = $term->locale_encode ($string)
840 Convert the given text string into the corresponding locale encoding.
842 =item $string = $term->locale_decode ($octets)
844 Convert the given locale-encoded octets into a perl string.
846 =item $term->scr_add_lines ($string)
848 Write the given text string to the screen, as if output by the application
849 running inside the terminal. It may not contain command sequences (escape
850 codes), but is free to use line feeds, carriage returns and tabs. The
851 string is a normal text string, not in locale-dependent encoding.
853 Normally its not a good idea to use this function, as programs might be
854 confused by changes in cursor position or scrolling. Its useful inside a
855 C<on_add_lines> hook, though.
857 =item $term->cmd_parse ($octets)
859 Similar to C<scr_add_lines>, but the argument must be in the
860 locale-specific encoding of the terminal and can contain command sequences
861 (escape codes) that will be interpreted.
863 =item $term->tt_write ($octets)
865 Write the octets given in C<$data> to the tty (i.e. as program input). To
866 pass characters instead of octets, you should convert your strings first
867 to the locale-specific encoding using C<< $term->locale_encode >>.
869 =item $windowid = $term->parent
871 Return the window id of the toplevel window.
873 =item $windowid = $term->vt
875 Return the window id of the terminal window.
877 =item $window_width = $term->width
879 =item $window_height = $term->height
881 =item $font_width = $term->fwidth
883 =item $font_height = $term->fheight
885 =item $font_ascent = $term->fbase
887 =item $terminal_rows = $term->nrow
889 =item $terminal_columns = $term->ncol
891 =item $has_focus = $term->focus
893 =item $is_mapped = $term->mapped
895 =item $max_scrollback = $term->saveLines
897 =item $nrow_plus_saveLines = $term->total_rows
899 =item $lines_in_scrollback = $term->nsaved
901 Return various integers describing terminal characteristics.
903 =item $modifiermask = $term->ModLevel3Mask
905 =item $modifiermask = $term->ModMetaMask
907 =item $modifiermask = $term->ModNumLockMask
909 Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
910 AltGr), the meta key (often Alt) and the num lock key, if applicable.
912 =item $view_start = $term->view_start ([$newvalue])
914 Returns the negative row number of the topmost line. Minimum value is
915 C<0>, which displays the normal terminal contents. Larger values scroll
916 this many lines into the scrollback buffer.
918 =item $term->want_refresh
920 Requests a screen refresh. At the next opportunity, rxvt-unicode will
921 compare the on-screen display with its stored representation. If they
922 differ, it redraws the differences.
924 Used after changing terminal contents to display them.
926 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
928 Returns the text of the entire row with number C<$row_number>. Row C<0>
929 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
930 terminal line. The scrollback buffer starts at line C<-1> and extends to
931 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
934 If C<$new_text> is specified, it will replace characters in the current
935 line, starting at column C<$start_col> (default C<0>), which is useful
936 to replace only parts of a line. The font index in the rendition will
937 automatically be updated.
939 C<$text> is in a special encoding: tabs and wide characters that use more
940 than one cell when displayed are padded with urxvt::NOCHAR characters
941 (C<chr 65535>). Characters with combining characters and other characters
942 that do not fit into the normal tetx encoding will be replaced with
943 characters in the private use area.
945 You have to obey this encoding when changing text. The advantage is
946 that C<substr> and similar functions work on screen cells and not on
949 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
950 can be used to convert normal strings into this encoding and vice versa.
952 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
954 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
955 bitsets. Rendition bitsets contain information about colour, font, font
956 styles and similar information. See also C<< $term->ROW_t >>.
958 When setting rendition, the font mask will be ignored.
960 See the section on RENDITION, above.
962 =item $length = $term->ROW_l ($row_number[, $new_length])
964 Returns the number of screen cells that are in use ("the line
965 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
966 line is joined with the following one.
968 =item $bool = $term->is_longer ($row_number)
970 Returns true if the row is part of a multiple-row logical "line" (i.e.
971 joined with the following row), which means all characters are in use
972 and it is continued on the next row (and possibly a continuation of the
975 =item $line = $term->line ($row_number)
977 Create and return a new C<urxvt::line> object that stores information
978 about the logical line that row C<$row_number> is part of. It supports the
983 =item $text = $line->t ([$new_text])
985 Returns or replaces the full text of the line, similar to C<ROW_t>
987 =item $rend = $line->r ([$new_rend])
989 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
991 =item $length = $line->l
993 Returns the length of the line in cells, similar to C<ROW_l>.
995 =item $rownum = $line->beg
997 =item $rownum = $line->end
999 Return the row number of the first/last row of the line, respectively.
1001 =item $offset = $line->offset_of ($row, $col)
1003 Returns the character offset of the given row|col pair within the logical
1006 =item ($row, $col) = $line->coord_of ($offset)
1008 Translates a string offset into terminal coordinates again.
1015 my ($self, $row) = @_;
1017 my $maxrow = $self->nrow - 1;
1019 my ($beg, $end) = ($row, $row);
1021 --$beg while $self->ROW_is_longer ($beg - 1);
1022 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1028 ncol => $self->ncol,
1029 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1033 sub urxvt::line::t {
1038 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1039 for $self->{beg} .. $self->{end};
1042 defined wantarray &&
1043 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1047 sub urxvt::line::r {
1052 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1053 for $self->{beg} .. $self->{end};
1056 if (defined wantarray) {
1058 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1060 $#$rend = $self->{len} - 1;
1067 sub urxvt::line::beg { $_[0]{beg} }
1068 sub urxvt::line::end { $_[0]{end} }
1069 sub urxvt::line::l { $_[0]{len} }
1071 sub urxvt::line::offset_of {
1072 my ($self, $row, $col) = @_;
1074 ($row - $self->{beg}) * $self->{ncol} + $col
1077 sub urxvt::line::coord_of {
1078 my ($self, $offset) = @_;
1083 $offset / $self->{ncol} + $self->{beg},
1084 $offset % $self->{ncol}
1088 =item ($row, $col) = $line->coord_of ($offset)
1089 =item $text = $term->special_encode $string
1091 Converts a perl string into the special encoding used by rxvt-unicode,
1092 where one character corresponds to one screen cell. See
1093 C<< $term->ROW_t >> for details.
1095 =item $string = $term->special_decode $text
1097 Converts rxvt-unicodes text reprsentation into a perl string. See
1098 C<< $term->ROW_t >> for details.
1104 package urxvt::popup;
1106 =head2 The C<urxvt::popup> Class
1113 my ($self, $item) = @_;
1115 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1116 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1117 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1119 $item->{render} ||= sub { $_[0]{text} };
1121 push @{ $self->{item} }, $item;
1125 my ($self, $sep) = @_;
1130 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1132 render => sub { $sep x $urxvt::TERM->ncol },
1133 activate => sub { },
1138 my ($self, $title) = @_;
1141 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1143 activate => sub { },
1148 my ($self, $text, $cb) = @_;
1150 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb});
1154 my ($self, $text, $cb, $value) = @_;
1160 render => sub { ($item->{value} ? "* " : " ") . $text },
1161 activate => sub { $cb->($item->{value} = !$item->{value}); },
1164 $self->add_item ($item);
1170 local $urxvt::popup::self = $self;
1172 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1173 "--transient-for" => $self->{term}->parent,
1174 "-pe" => "urxvt-popup")
1175 or die "unable to create popup window\n";
1181 $self->{term}->ungrab;
1184 =head2 The C<urxvt::timer> Class
1186 This class implements timer watchers/events. Time is represented as a
1187 fractional number of seconds since the epoch. Example:
1189 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1190 $term->{timer} = urxvt::timer
1194 $term->{overlay}->set (0, 0,
1195 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1200 =item $timer = new urxvt::timer
1202 Create a new timer object in started state. It is scheduled to fire
1205 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1207 Set the callback to be called when the timer triggers.
1209 =item $tstamp = $timer->at
1211 Return the time this watcher will fire next.
1213 =item $timer = $timer->set ($tstamp)
1215 Set the time the event is generated to $tstamp.
1217 =item $timer = $timer->interval ($interval)
1219 Normally (and when C<$interval> is C<0>), the timer will automatically
1220 stop after it has fired once. If C<$interval> is non-zero, then the timer
1221 is automatically rescheduled at the given intervals.
1223 =item $timer = $timer->start
1227 =item $timer = $timer->start ($tstamp)
1229 Set the event trigger time to C<$tstamp> and start the timer.
1231 =item $timer = $timer->stop
1237 =head2 The C<urxvt::iow> Class
1239 This class implements io watchers/events. Example:
1241 $term->{socket} = ...
1242 $term->{iow} = urxvt::iow
1244 ->fd (fileno $term->{socket})
1245 ->events (1) # wait for read data
1248 my ($iow, $revents) = @_;
1249 # $revents must be 1 here, no need to check
1250 sysread $term->{socket}, my $buf, 8192
1257 =item $iow = new urxvt::iow
1259 Create a new io watcher object in stopped state.
1261 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
1263 Set the callback to be called when io events are triggered. C<$reventmask>
1264 is a bitset as described in the C<events> method.
1266 =item $iow = $iow->fd ($fd)
1268 Set the filedescriptor (not handle) to watch.
1270 =item $iow = $iow->events ($eventmask)
1272 Set the event mask to watch. Bit #0 (value C<1>) enables watching for read
1273 data, Bit #1 (value C<2>) enables watching for write data.
1275 =item $iow = $iow->start
1277 Start watching for requested events on the given handle.
1279 =item $iow = $iow->stop
1281 Stop watching for events on the given filehandle.
1287 =head2 URXVT_PERL_VERBOSITY
1289 This variable controls the verbosity level of the perl extension. Higher
1290 numbers indicate more verbose output.
1294 =item =0 - only fatal messages
1296 =item =3 - script loading and management
1298 =item =10 - all events received
1304 Marc Lehmann <pcg@goof.com>
1305 http://software.schmorp.de/pkg/rxvt-unicode