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 =head1 PREPACKAGED EXTENSIONS
33 This section describes the extensions delivered with this release. 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 (More) intelligent selection. This extension tries to be more intelligent
45 when the user extends selections (double-click). Right now, it tries to
46 select urls and complete shell-quoted arguments, which is very convenient,
47 too, if your F<ls> supports C<--quoting-style=shell>.
49 It also offers the following bindable keyboard command:
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-Button2 that lets you toggle (some) options at
66 =item selection-popup (enabled by default)
68 Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69 text into various other formats/action (such as uri unescaping, perl
70 evalution, web-browser starting etc.), depending on content.
72 =item searchable-scrollback<hotkey> (enabled by default)
74 Adds regex search functionality to the scrollback buffer, triggered
75 by a hotkey (default: C<M-s>). When in search mode, normal terminal
76 input/output is suspended.
78 C</> starts an incremental regex search, C<n> searches further, C<p> or
79 C<N> jump to the previous match, C<G> jumps to the bottom and clears the
80 history, C<enter> leaves search mode at the current position and C<escape>
81 returns to the original position.
85 Displays a digital clock using the built-in overlay.
89 Uses per-line display filtering (C<on_line_update>) to underline urls and
90 make them clickable. When clicked, the program specified in the resource
91 C<urlLauncher> (default C<x-www-browser>) will be started.
93 =item block-graphics-to-ascii
95 A not very useful example of filtering all text output to the terminal,
96 by replacing all line-drawing characters (U+2500 .. U+259F) by a
97 similar-looking ascii character.
99 =item example-refresh-hooks
101 Displays a very simple digital clock in the upper right corner of the
102 window. Illustrates overwriting the refresh callbacks to create your own
107 =head1 API DOCUMENTATION
109 =head2 General API Considerations
111 All objects (such as terminals, time watchers etc.) are typical
112 reference-to-hash objects. The hash can be used to store anything you
113 like. All members starting with an underscore (such as C<_ptr> or
114 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
117 When objects are destroyed on the C++ side, the perl object hashes are
118 emptied, so its best to store related objects such as time watchers and
119 the like inside the terminal object so they get destroyed as soon as the
120 terminal is destroyed.
122 Argument names also often indicate the type of a parameter. Here are some
123 hints on what they mean:
129 Rxvt-unicodes special way of encoding text, where one "unicode" character
130 always represents one screen cell. See L<ROW_t> for a discussion of this format.
134 A perl text string, with an emphasis on I<text>. It can store all unicode
135 characters and is to be distinguished with text encoded in a specific
136 encoding (often locale-specific) and binary data.
140 Either binary data or - more common - a text string encoded in a
145 =head2 Extension Objects
147 Very perl extension is a perl class. A separate perl object is created
148 for each terminal and each extension and passed as the first parameter to
149 hooks. So extensions can use their C<$self> object without having to think
150 about other extensions, with the exception of methods and members that
151 begin with an underscore character C<_>: these are reserved for internal
154 Although it isn't a C<urxvt::term> object, you can call all methods of the
155 C<urxvt::term> class on this object.
157 It has the following methods and data members:
161 =item $urxvt_term = $self->{term}
163 Returns the C<urxvt::term> object associated with this instance of the
164 extension. This member I<must not> be changed in any way.
166 =item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
168 Dynamically enable the given hooks (named without the C<on_> prefix) for
169 this extension, replacing any previous hook. This is useful when you want
170 to overwrite time-critical hooks only temporarily.
172 =item $self->disable ($hook_name[, $hook_name..])
174 Dynamically disable the given hooks.
180 The following subroutines can be declared in extension files, and will be
181 called whenever the relevant event happens.
183 The first argument passed to them is an extension oject as described in
184 the in the C<Extension Objects> section.
186 B<All> of these hooks must return a boolean value. If it is true, then the
187 event counts as being I<consumed>, and the invocation of other hooks is
188 skipped, and the relevant action might not be carried out by the C++ code.
190 I<< When in doubt, return a false value (preferably C<()>). >>
196 Called after a new terminal object has been initialized, but before
197 windows are created or the command gets run. Most methods are unsafe to
198 call or deliver senseless data, as terminal size and other characteristics
199 have not yet been determined. You can safely query and change resources,
204 Called after the screen is "reset" for any reason, such as resizing or
205 control sequences. Here is where you can react on changes to size-related
210 Called at the very end of initialisation of a new terminal, just before
211 returning to the mainloop.
213 =item on_sel_make $term, $eventtime
215 Called whenever a selection has been made by the user, but before the
216 selection text is copied, so changes to the beginning, end or type of the
217 selection will be honored.
219 Returning a true value aborts selection making by urxvt, in which case you
220 have to make a selection yourself by calling C<< $term->selection_grab >>.
222 =item on_sel_grab $term, $eventtime
224 Called whenever a selection has been copied, but before the selection is
225 requested from the server. The selection text can be queried and changed
226 by calling C<< $term->selection >>.
228 Returning a true value aborts selection grabbing. It will still be hilighted.
230 =item on_sel_extend $term
232 Called whenever the user tries to extend the selection (e.g. with a double
233 click) and is either supposed to return false (normal operation), or
234 should extend the selection itelf and return true to suppress the built-in
237 See the F<selection> example extension.
239 =item on_view_change $term, $offset
241 Called whenever the view offset changes, i..e the user or program
242 scrolls. Offset C<0> means display the normal terminal, positive values
243 show this many lines of scrollback.
245 =item on_scroll_back $term, $lines, $saved
247 Called whenever lines scroll out of the terminal area into the scrollback
248 buffer. C<$lines> is the number of lines scrolled out and may be larger
249 than the scroll back buffer or the terminal.
251 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
252 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
253 number of lines that will be in the scrollback buffer.
255 =item on_osc_seq $term, $string
257 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
258 operating system command) is processed. Cursor position and other state
259 information is up-to-date when this happens. For interoperability, the
260 string should start with the extension name and a colon, to distinguish
261 it from commands for other extensions, and this might be enforced in the
264 Be careful not ever to trust (in a security sense) the data you receive,
265 as its source can not easily be controleld (e-mail content, messages from
266 other users on the same system etc.).
268 =item on_add_lines $term, $string
270 Called whenever text is about to be output, with the text as argument. You
271 can filter/change and output the text yourself by returning a true value
272 and calling C<< $term->scr_add_lines >> yourself. Please note that this
273 might be very slow, however, as your hook is called for B<all> text being
276 =item on_tt_write $term, $octets
278 Called whenever some data is written to the tty/pty and can be used to
279 suppress or filter tty input.
281 =item on_line_update $term, $row
283 Called whenever a line was updated or changed. Can be used to filter
284 screen output (e.g. underline urls or other useless stuff). Only lines
285 that are being shown will be filtered, and, due to performance reasons,
286 not always immediately.
288 The row number is always the topmost row of the line if the line spans
291 Please note that, if you change the line, then the hook might get called
292 later with the already-modified line (e.g. if unrelated parts change), so
293 you cannot just toggle rendition bits, but only set them.
295 =item on_refresh_begin $term
297 Called just before the screen gets redrawn. Can be used for overlay
298 or similar effects by modify terminal contents in refresh_begin, and
299 restoring them in refresh_end. The built-in overlay and selection display
300 code is run after this hook, and takes precedence.
302 =item on_refresh_end $term
304 Called just after the screen gets redrawn. See C<on_refresh_begin>.
306 =item on_keyboard_command $term, $string
308 Called whenever the user presses a key combination that has a
309 C<perl:string> action bound to it (see description of the B<keysym>
310 resource in the @@RXVT_NAME@@(1) manpage).
312 =item on_focus_in $term
314 Called whenever the window gets the keyboard focus, before rxvt-unicode
315 does focus in processing.
317 =item on_focus_out $term
319 Called wheneever the window loses keyboard focus, before rxvt-unicode does
320 focus out processing.
322 =item on_key_press $term, $event, $keysym, $octets
324 =item on_key_release $term, $event, $keysym
326 =item on_button_press $term, $event
328 =item on_button_release $term, $event
330 =item on_motion_notify $term, $event
332 =item on_map_notify $term, $event
334 =item on_unmap_notify $term, $event
336 Called whenever the corresponding X event is received for the terminal If
337 the hook returns true, then the even will be ignored by rxvt-unicode.
339 The event is a hash with most values as named by Xlib (see the XEvent
340 manpage), with the additional members C<row> and C<col>, which are the row
341 and column under the mouse cursor.
343 C<on_key_press> additionally receives the string rxvt-unicode would
344 output, if any, in locale-specific encoding.
363 our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
371 =head2 Variables in the C<urxvt> Package
377 The rxvt-unicode library directory, where, among other things, the perl
378 modules and scripts are stored.
380 =item $urxvt::RESCLASS, $urxvt::RESCLASS
382 The resource class and name rxvt-unicode uses to look up X resources.
384 =item $urxvt::RXVTNAME
386 The basename of the installed binaries, usually C<urxvt>.
390 The current terminal. This variable stores the current C<urxvt::term>
391 object, whenever a callback/hook is executing.
395 =head2 Functions in the C<urxvt> Package
399 =item urxvt::fatal $errormessage
401 Fatally aborts execution with the given error message. Avoid at all
402 costs! The only time this is acceptable is when the terminal process
405 =item urxvt::warn $string
407 Calls C<rxvt_warn> with the given string which should not include a
408 newline. The module also overwrites the C<warn> builtin with a function
409 that calls this function.
411 Using this function has the advantage that its output ends up in the
412 correct place, e.g. on stderr of the connecting urxvtc client.
414 Messages have a size limit of 1023 bytes currently.
416 =item $is_safe = urxvt::safe
418 Returns true when it is safe to do potentially unsafe things, such as
419 evaluating perl code specified by the user. This is true when urxvt was
420 started setuid or setgid.
422 =item $time = urxvt::NOW
424 Returns the "current time" (as per the event loop).
426 =item urxvt::CurrentTime
428 =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
429 Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
430 Button4Mask, Button5Mask, AnyModifier
432 Various constants for use in X calls and event processing.
438 Rendition bitsets contain information about colour, font, font styles and
439 similar information for each screen cell.
441 The following "macros" deal with changes in rendition sets. You should
442 never just create a bitset, you should always modify an existing one,
443 as they contain important information required for correct operation of
448 =item $rend = urxvt::DEFAULT_RSTYLE
450 Returns the default rendition, as used when the terminal is starting up or
451 being reset. Useful as a base to start when creating renditions.
453 =item $rend = urxvt::OVERLAY_RSTYLE
455 Return the rendition mask used for overlays by default.
457 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
459 Return the bit that enabled bold, italic, blink, reverse-video and
460 underline, respectively. To enable such a style, just logically OR it into
463 =item $foreground = urxvt::GET_BASEFG $rend
465 =item $background = urxvt::GET_BASEBG $rend
467 Return the foreground/background colour index, respectively.
469 =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
471 =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
473 Replace the foreground/background colour in the rendition mask with the
476 =item $value = urxvt::GET_CUSTOM $rend
478 Return the "custom" value: Every rendition has 5 bits for use by
479 extensions. They can be set and changed as you like and are initially
482 =item $rend = urxvt::SET_CUSTOM $rend, $new_value
484 Change the custom value.
493 # overwrite perl's warn
494 *CORE::GLOBAL::warn = sub {
495 my $msg = join "", @_;
497 unless $msg =~ /\n$/;
502 # delete $ENV{CDPATH};
503 # delete $ENV{BASH_ENV};
504 # $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
511 my ($level, $msg) = @_;
512 warn "$msg\n" if $level <= $verbosity;
515 my $extension_pkg = "extension0000";
518 # load a single script into its own package, once only
519 sub extension_package($) {
522 $extension_pkg{$path} ||= do {
523 my $pkg = "urxvt::" . ($extension_pkg++);
525 verbose 3, "loading extension '$path' into package '$pkg'";
527 open my $fh, "<:raw", $path
531 "package $pkg; use strict; use utf8;\n"
532 . "use base urxvt::term::extension::;\n"
533 . "#line 1 \"$path\"\n{\n"
534 . (do { local $/; <$fh> })
544 our $retval; # return value for urxvt
546 # called by the rxvt core
551 if ($htype == 0) { # INIT
552 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
556 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
557 if ($_ eq "default") {
558 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
559 } elsif (/^-(.*)$/) {
561 } elsif (/^([^<]+)<(.*)>$/) {
562 push @{ $ext_arg{$1} }, $2;
568 while (my ($ext, $argv) = each %ext_arg) {
569 my @files = grep -f $_, map "$_/$ext", @dirs;
572 $TERM->register_package (extension_package $files[0], $argv);
574 warn "perl extension '$ext' not found in perl library search path\n";
578 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
584 if (my $cb = $TERM->{_hook}[$htype]) {
585 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
590 while (my ($pkg, $cb) = each %$cb) {
591 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }
595 $TERM->ungrab; # better to lose the grab than the session
601 if ($htype == 1) { # DESTROY
602 if (my $hook = delete $TERM->{_hook}) {
603 for my $htype (0..$#$hook) {
604 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
605 or set_should_invoke $htype, 0;
609 # clear package objects
610 %$_ = () for values %{ $TERM->{_pkg} };
619 # urxvt::term::extension
621 package urxvt::term::extension;
624 my ($self, %hook) = @_;
625 my $pkg = $self->{_pkg};
627 while (my ($name, $cb) = each %hook) {
628 my $htype = $HOOKTYPE{uc $name};
630 or Carp::croak "unsupported hook type '$name'";
632 unless (exists $self->{term}{_hook}[$htype]{$pkg}) {
633 $hook_count[$htype]++
634 or urxvt::set_should_invoke $htype, 1;
637 $self->{term}{_hook}[$htype]{$pkg} = $cb;
642 my ($self, @hook) = @_;
643 my $pkg = $self->{_pkg};
645 for my $name (@hook) {
646 my $htype = $HOOKTYPE{uc $name};
648 or Carp::croak "unsupported hook type '$name'";
650 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
651 --$hook_count[$htype]
652 or urxvt::set_should_invoke $htype, 0;
660 $AUTOLOAD =~ /:([^:]+)$/
661 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
666 \$proxy->{term}->$1 (\@_)
669 } or die "FATAL: unable to compile method forwarder: $@";
678 # urxvt::destroy_hook
680 sub urxvt::destroy_hook::DESTROY {
684 sub urxvt::destroy_hook(&) {
685 bless \shift, urxvt::destroy_hook::
688 package urxvt::anyevent;
690 =head2 The C<urxvt::anyevent> Class
692 The sole purpose of this class is to deliver an interface to the
693 C<AnyEvent> module - any module using it will work inside urxvt without
694 further programming. The only exception is that you cannot wait on
695 condition variables, but non-blocking condvar use is ok. What this means
696 is that you cannot use blocking APIs, but the non-blocking variant should
703 $INC{"urxvt/anyevent.pm"} = 1; # mark us as there
704 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
707 my ($class, %arg) = @_;
713 ->start (urxvt::NOW + $arg{after})
715 $_[0]->stop; # need to cancel manually
721 my ($class, %arg) = @_;
725 bless [$arg{fh}, urxvt::iow
727 ->fd (fileno $arg{fh})
728 ->events (($arg{poll} =~ /r/ ? 1 : 0)
729 | ($arg{poll} =~ /w/ ? 2 : 0))
732 $cb->(($_[1] & 1 ? 'r' : '')
733 . ($_[1] & 2 ? 'w' : ''));
743 bless \my $flag, urxvt::anyevent::condvar::
746 sub urxvt::anyevent::condvar::broadcast {
750 sub urxvt::anyevent::condvar::wait {
752 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
758 =head2 The C<urxvt::term> Class
764 # find on_xxx subs in the package and register them
766 sub register_package {
767 my ($self, $pkg, $argv) = @_;
773 Scalar::Util::weaken ($proxy->{term} = $self);
775 $self->{_pkg}{$pkg} = $proxy;
777 for my $name (@HOOKNAME) {
778 if (my $ref = $pkg->can ("on_" . lc $name)) {
779 $proxy->enable ($name => $ref);
784 =item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
786 Creates a new terminal, very similar as if you had started it with system
787 C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
788 hash which defines the environment of the new terminal.
790 Croaks (and probably outputs an error message) if the new instance
791 couldn't be created. Returns C<undef> if the new instance didn't
792 initialise perl, and the terminal object otherwise. The C<init> and
793 C<start> hooks will be called during this call.
798 my ($class, $env, @args) = @_;
800 _new ([ map "$_=$env->{$_}", keys %$env ], @args);
805 Destroy the terminal object (close the window, free resources
806 etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
807 watchers (timers, io watchers) are still active.
809 =item $isset = $term->option ($optval[, $set])
811 Returns true if the option specified by C<$optval> is enabled, and
812 optionally change it. All option values are stored by name in the hash
813 C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
815 Here is a a likely non-exhaustive list of option names, please see the
816 source file F</src/optinc.h> to see the actual list:
818 borderLess console cursorBlink cursorUnderline hold iconic insecure
819 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
820 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating
821 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer
822 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent
823 tripleclickwords utmpInhibit visualBell
825 =item $value = $term->resource ($name[, $newval])
827 Returns the current resource value associated with a given name and
828 optionally sets a new value. Setting values is most useful in the C<init>
829 hook. Unset resources are returned and accepted as C<undef>.
831 The new value must be properly encoded to a suitable character encoding
832 before passing it to this method. Similarly, the returned value may need
833 to be converted from the used encoding to text.
835 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
836 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
839 Please note that resource strings will currently only be freed when the
840 terminal is destroyed, so changing options frequently will eat memory.
842 Here is a a likely non-exhaustive list of resource names, not all of which
843 are supported in every build, please see the source file F</src/rsinc.h>
844 to see the actual list:
846 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
847 borderLess color cursorBlink cursorUnderline cutchars delete_key
848 display_name embed ext_bwidth fade font geometry hold iconName
849 imFont imLocale inputMethod insecure int_bwidth intensityStyles
850 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier
851 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2
852 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd
853 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating
854 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput
855 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle
856 shade term_name title transparent transparent_all tripleclickwords
857 utmpInhibit visualBell
862 my ($self, $name) = (shift, shift);
863 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
864 &urxvt::term::_resource
867 =item $value = $term->x_resource ($pattern)
869 Returns the X-Resource for the given pattern, excluding the program or
870 class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
871 same value as used by this instance of rxvt-unicode. Returns C<undef> if no
872 resource with that pattern exists.
874 This method should only be called during the C<on_start> hook, as there is
875 only one resource database per display, and later invocations might return
878 =item $success = $term->parse_keysym ($keysym_spec, $command_string)
880 Adds a keymap translation exactly as specified via a resource. See the
881 C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
883 =item $rend = $term->rstyle ([$new_rstyle])
885 Return and optionally change the current rendition. Text that is output by
886 the terminal application will use this style.
888 =item ($row, $col) = $term->screen_cur ([$row, $col])
890 Return the current coordinates of the text cursor position and optionally
891 set it (which is usually bad as applications don't expect that).
893 =item ($row, $col) = $term->selection_mark ([$row, $col])
895 =item ($row, $col) = $term->selection_beg ([$row, $col])
897 =item ($row, $col) = $term->selection_end ([$row, $col])
899 Return the current values of the selection mark, begin or end positions,
900 and optionally set them to new values.
902 =item $success = $term->selection_grab ($eventtime)
904 Try to request the primary selection from the server (for example, as set
907 =item $oldtext = $term->selection ([$newtext])
909 Return the current selection text and optionally replace it by C<$newtext>.
911 =item $term->overlay_simple ($x, $y, $text)
913 Create a simple multi-line overlay box. See the next method for details.
918 my ($self, $x, $y, $text) = @_;
920 my @lines = split /\n/, $text;
922 my $w = List::Util::max map $self->strwidth ($_), @lines;
924 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
925 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
930 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
932 Create a new (empty) overlay at the given position with the given
933 width/height. C<$rstyle> defines the initial rendition style
934 (default: C<OVERLAY_RSTYLE>).
936 If C<$border> is C<2> (default), then a decorative border will be put
939 If either C<$x> or C<$y> is negative, then this is counted from the
940 right/bottom side, respectively.
942 This method returns an urxvt::overlay object. The overlay will be visible
943 as long as the perl object is referenced.
945 The methods currently supported on C<urxvt::overlay> objects are:
949 =item $overlay->set ($x, $y, $text, $rend)
951 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
952 text in rxvt-unicode's special encoding and an array of rendition values
953 at a specific position inside the overlay.
957 If visible, hide the overlay, but do not destroy it.
961 If hidden, display the overlay again.
965 =item $popup = $term->popup ($event)
967 Creates a new C<urxvt::popup> object that implements a popup menu. The
968 C<$event> I<must> be the event causing the menu to pop up (a button event,
974 my ($self, $event) = @_;
976 $self->grab ($event->{time}, 1)
984 Scalar::Util::weaken $popup->{term};
986 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
987 Scalar::Util::weaken $self->{_destroy}{$popup};
992 =item $cellwidth = $term->strwidth ($string)
994 Returns the number of screen-cells this string would need. Correctly
995 accounts for wide and combining characters.
997 =item $octets = $term->locale_encode ($string)
999 Convert the given text string into the corresponding locale encoding.
1001 =item $string = $term->locale_decode ($octets)
1003 Convert the given locale-encoded octets into a perl string.
1005 =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1007 XORs the rendition values in the given span with the provided value
1008 (default: C<RS_RVid>). Useful in refresh hooks to provide effects similar
1011 =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1013 Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1014 whitespace will additionally be xored with the C<$rstyle2>, which defaults
1015 to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1018 =item $term->scr_bell
1022 =item $term->scr_add_lines ($string)
1024 Write the given text string to the screen, as if output by the application
1025 running inside the terminal. It may not contain command sequences (escape
1026 codes), but is free to use line feeds, carriage returns and tabs. The
1027 string is a normal text string, not in locale-dependent encoding.
1029 Normally its not a good idea to use this function, as programs might be
1030 confused by changes in cursor position or scrolling. Its useful inside a
1031 C<on_add_lines> hook, though.
1033 =item $term->cmd_parse ($octets)
1035 Similar to C<scr_add_lines>, but the argument must be in the
1036 locale-specific encoding of the terminal and can contain command sequences
1037 (escape codes) that will be interpreted.
1039 =item $term->tt_write ($octets)
1041 Write the octets given in C<$data> to the tty (i.e. as program input). To
1042 pass characters instead of octets, you should convert your strings first
1043 to the locale-specific encoding using C<< $term->locale_encode >>.
1045 =item $old_events = $term->pty_ev_events ([$new_events])
1047 Replaces the event mask of the pty watcher by the given event mask. Can
1048 be used to suppress input and output handling to the pty/tty. See the
1049 description of C<< urxvt::timer->events >>. Make sure to always restore
1052 =item $windowid = $term->parent
1054 Return the window id of the toplevel window.
1056 =item $windowid = $term->vt
1058 Return the window id of the terminal window.
1060 =item $window_width = $term->width
1062 =item $window_height = $term->height
1064 =item $font_width = $term->fwidth
1066 =item $font_height = $term->fheight
1068 =item $font_ascent = $term->fbase
1070 =item $terminal_rows = $term->nrow
1072 =item $terminal_columns = $term->ncol
1074 =item $has_focus = $term->focus
1076 =item $is_mapped = $term->mapped
1078 =item $max_scrollback = $term->saveLines
1080 =item $nrow_plus_saveLines = $term->total_rows
1082 =item $lines_in_scrollback = $term->nsaved
1084 Return various integers describing terminal characteristics.
1086 =item $x_display = $term->display_id
1088 Return the DISPLAY used by rxvt-unicode.
1090 =item $lc_ctype = $term->locale
1092 Returns the LC_CTYPE category string used by this rxvt-unicode.
1094 =item $env = $term->env
1096 Returns a copy of the environment in effect for the terminal as a hashref
1097 similar to C<\%ENV>.
1102 if (my $env = $_[0]->_env) {
1103 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1109 =item $modifiermask = $term->ModLevel3Mask
1111 =item $modifiermask = $term->ModMetaMask
1113 =item $modifiermask = $term->ModNumLockMask
1115 Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1116 AltGr), the meta key (often Alt) and the num lock key, if applicable.
1118 =item $view_start = $term->view_start ([$newvalue])
1120 Returns the negative row number of the topmost line. Minimum value is
1121 C<0>, which displays the normal terminal contents. Larger values scroll
1122 this many lines into the scrollback buffer.
1124 =item $term->want_refresh
1126 Requests a screen refresh. At the next opportunity, rxvt-unicode will
1127 compare the on-screen display with its stored representation. If they
1128 differ, it redraws the differences.
1130 Used after changing terminal contents to display them.
1132 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1134 Returns the text of the entire row with number C<$row_number>. Row C<0>
1135 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
1136 terminal line. The scrollback buffer starts at line C<-1> and extends to
1137 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
1140 If C<$new_text> is specified, it will replace characters in the current
1141 line, starting at column C<$start_col> (default C<0>), which is useful
1142 to replace only parts of a line. The font index in the rendition will
1143 automatically be updated.
1145 C<$text> is in a special encoding: tabs and wide characters that use more
1146 than one cell when displayed are padded with urxvt::NOCHAR characters
1147 (C<chr 65535>). Characters with combining characters and other characters
1148 that do not fit into the normal tetx encoding will be replaced with
1149 characters in the private use area.
1151 You have to obey this encoding when changing text. The advantage is
1152 that C<substr> and similar functions work on screen cells and not on
1155 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
1156 can be used to convert normal strings into this encoding and vice versa.
1158 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
1160 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
1161 bitsets. Rendition bitsets contain information about colour, font, font
1162 styles and similar information. See also C<< $term->ROW_t >>.
1164 When setting rendition, the font mask will be ignored.
1166 See the section on RENDITION, above.
1168 =item $length = $term->ROW_l ($row_number[, $new_length])
1170 Returns the number of screen cells that are in use ("the line
1171 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
1172 line is joined with the following one.
1174 =item $bool = $term->is_longer ($row_number)
1176 Returns true if the row is part of a multiple-row logical "line" (i.e.
1177 joined with the following row), which means all characters are in use
1178 and it is continued on the next row (and possibly a continuation of the
1181 =item $line = $term->line ($row_number)
1183 Create and return a new C<urxvt::line> object that stores information
1184 about the logical line that row C<$row_number> is part of. It supports the
1189 =item $text = $line->t ([$new_text])
1191 Returns or replaces the full text of the line, similar to C<ROW_t>
1193 =item $rend = $line->r ([$new_rend])
1195 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
1197 =item $length = $line->l
1199 Returns the length of the line in cells, similar to C<ROW_l>.
1201 =item $rownum = $line->beg
1203 =item $rownum = $line->end
1205 Return the row number of the first/last row of the line, respectively.
1207 =item $offset = $line->offset_of ($row, $col)
1209 Returns the character offset of the given row|col pair within the logical
1212 =item ($row, $col) = $line->coord_of ($offset)
1214 Translates a string offset into terminal coordinates again.
1221 my ($self, $row) = @_;
1223 my $maxrow = $self->nrow - 1;
1225 my ($beg, $end) = ($row, $row);
1227 --$beg while $self->ROW_is_longer ($beg - 1);
1228 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1234 ncol => $self->ncol,
1235 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1239 sub urxvt::line::t {
1244 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1245 for $self->{beg} .. $self->{end};
1248 defined wantarray &&
1249 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1253 sub urxvt::line::r {
1258 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1259 for $self->{beg} .. $self->{end};
1262 if (defined wantarray) {
1264 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1266 $#$rend = $self->{len} - 1;
1273 sub urxvt::line::beg { $_[0]{beg} }
1274 sub urxvt::line::end { $_[0]{end} }
1275 sub urxvt::line::l { $_[0]{len} }
1277 sub urxvt::line::offset_of {
1278 my ($self, $row, $col) = @_;
1280 ($row - $self->{beg}) * $self->{ncol} + $col
1283 sub urxvt::line::coord_of {
1284 my ($self, $offset) = @_;
1289 $offset / $self->{ncol} + $self->{beg},
1290 $offset % $self->{ncol}
1294 =item $text = $term->special_encode $string
1296 Converts a perl string into the special encoding used by rxvt-unicode,
1297 where one character corresponds to one screen cell. See
1298 C<< $term->ROW_t >> for details.
1300 =item $string = $term->special_decode $text
1302 Converts rxvt-unicodes text reprsentation into a perl string. See
1303 C<< $term->ROW_t >> for details.
1305 =item $success = $term->grab_button ($button, $modifiermask)
1307 Registers a synchronous button grab. See the XGrabButton manpage.
1309 =item $success = $term->grab ($eventtime[, $sync])
1311 Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1312 synchronous (C<$sync> is true). Also remembers the grab timestampe.
1314 =item $term->allow_events_async
1316 Calls XAllowEvents with AsyncBoth for the most recent grab.
1318 =item $term->allow_events_sync
1320 Calls XAllowEvents with SyncBoth for the most recent grab.
1322 =item $term->allow_events_replay
1324 Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1329 Calls XUngrab for the most recent grab. Is called automatically on
1330 evaluation errors, as it is better to lose the grab in the error case as
1337 package urxvt::popup;
1339 =head2 The C<urxvt::popup> Class
1346 my ($self, $item) = @_;
1348 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1349 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1350 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1352 $item->{render} ||= sub { $_[0]{text} };
1354 push @{ $self->{item} }, $item;
1357 =item $popup->add_title ($title)
1359 Adds a non-clickable title to the popup.
1364 my ($self, $title) = @_;
1367 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1369 activate => sub { },
1373 =item $popup->add_separator ([$sepchr])
1375 Creates a separator, optionally using the character given as C<$sepchr>.
1380 my ($self, $sep) = @_;
1385 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1387 render => sub { $sep x $self->{term}->ncol },
1388 activate => sub { },
1392 =item $popup->add_button ($text, $cb)
1394 Adds a clickable button to the popup. C<$cb> is called whenever it is
1400 my ($self, $text, $cb) = @_;
1402 $self->add_item ({ type => "button", text => $text, activate => $cb});
1405 =item $popup->add_toggle ($text, $cb, $initial_value)
1407 Adds a toggle/checkbox item to the popup. Teh callback gets called
1408 whenever it gets toggled, with a boolean indicating its value as its first
1414 my ($self, $text, $cb, $value) = @_;
1420 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1421 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1424 $self->add_item ($item);
1429 Displays the popup (which is initially hidden).
1436 local $urxvt::popup::self = $self;
1438 my $env = $self->{term}->env;
1439 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1440 delete $env->{LC_ALL};
1441 $env->{LC_CTYPE} = $self->{term}->locale;
1443 urxvt::term->new ($env, $self->{term}->resource ("name"),
1444 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1445 "--transient-for" => $self->{term}->parent,
1446 "-display" => $self->{term}->display_id,
1447 "-pe" => "urxvt-popup")
1448 or die "unable to create popup window\n";
1454 delete $self->{term}{_destroy}{$self};
1455 $self->{term}->ungrab;
1460 =head2 The C<urxvt::timer> Class
1462 This class implements timer watchers/events. Time is represented as a
1463 fractional number of seconds since the epoch. Example:
1465 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1466 $term->{timer} = urxvt::timer
1470 $term->{overlay}->set (0, 0,
1471 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1476 =item $timer = new urxvt::timer
1478 Create a new timer object in started state. It is scheduled to fire
1481 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1483 Set the callback to be called when the timer triggers.
1485 =item $tstamp = $timer->at
1487 Return the time this watcher will fire next.
1489 =item $timer = $timer->set ($tstamp)
1491 Set the time the event is generated to $tstamp.
1493 =item $timer = $timer->interval ($interval)
1495 Normally (and when C<$interval> is C<0>), the timer will automatically
1496 stop after it has fired once. If C<$interval> is non-zero, then the timer
1497 is automatically rescheduled at the given intervals.
1499 =item $timer = $timer->start
1503 =item $timer = $timer->start ($tstamp)
1505 Set the event trigger time to C<$tstamp> and start the timer.
1507 =item $timer = $timer->stop
1513 =head2 The C<urxvt::iow> Class
1515 This class implements io watchers/events. Example:
1517 $term->{socket} = ...
1518 $term->{iow} = urxvt::iow
1520 ->fd (fileno $term->{socket})
1521 ->events (urxvt::EVENT_READ)
1524 my ($iow, $revents) = @_;
1525 # $revents must be 1 here, no need to check
1526 sysread $term->{socket}, my $buf, 8192
1533 =item $iow = new urxvt::iow
1535 Create a new io watcher object in stopped state.
1537 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
1539 Set the callback to be called when io events are triggered. C<$reventmask>
1540 is a bitset as described in the C<events> method.
1542 =item $iow = $iow->fd ($fd)
1544 Set the filedescriptor (not handle) to watch.
1546 =item $iow = $iow->events ($eventmask)
1548 Set the event mask to watch. The only allowed values are
1549 C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1550 together, or C<urxvt::EVENT_NONE>.
1552 =item $iow = $iow->start
1554 Start watching for requested events on the given handle.
1556 =item $iow = $iow->stop
1558 Stop watching for events on the given filehandle.
1564 =head2 URXVT_PERL_VERBOSITY
1566 This variable controls the verbosity level of the perl extension. Higher
1567 numbers indicate more verbose output.
1571 =item == 0 - fatal messages
1573 =item >= 3 - script loading and management
1575 =item >=10 - all events received
1581 Marc Lehmann <pcg@goof.com>
1582 http://software.schmorp.de/pkg/rxvt-unicode