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 Every time 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 You can disable the embedded perl interpreter by setting both "perl-ext"
32 and "perl-ext-common" resources to the empty string.
34 =head1 PREPACKAGED EXTENSIONS
36 This section describes the extensions delivered with this release. You can
37 find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
39 You can activate them like this:
41 @@RXVT_NAME@@ -pe <extensionname>
43 Or by adding them to the resource for extensions loaded by default:
45 URxvt.perl-ext-common: default,automove-background,selection-autotransform
49 =item selection (enabled by default)
51 (More) intelligent selection. This extension tries to be more intelligent
52 when the user extends selections (double-click and further clicks). Right
53 now, it tries to select words, urls and complete shell-quoted
54 arguments, which is very convenient, too, if your F<ls> supports
55 C<--quoting-style=shell>.
57 A double-click usually selects the word under the cursor, further clicks
58 will enlarge the selection.
60 The selection works by trying to match a number of regexes and displaying
61 them in increasing order of length. You can add your own regexes by
62 specifying resources of the form:
64 URxvt.selection.pattern-0: perl-regex
65 URxvt.selection.pattern-1: perl-regex
68 The index number (0, 1...) must not have any holes, and each regex must
69 contain at least one pair of capturing parentheses, which will be used for
70 the match. For example, the following adds a regex that matches everything
71 between two vertical bars:
73 URxvt.selection.pattern-0: \\|([^|]+)\\|
75 Another example: Programs I use often output "absolute path: " at the
76 beginning of a line when they process multiple files. The following
77 pattern matches the filename (note, there is a single space at the very
80 URxvt.selection.pattern-0: ^(/[^:]+):\
82 You can look at the source of the selection extension to see more
83 interesting uses, such as parsing a line from beginning to end.
85 This extension also offers following bindable keyboard commands:
91 Rot-13 the selection when activated. Used via keyboard trigger:
93 URxvt.keysym.C-M-r: perl:selection:rot13
97 =item option-popup (enabled by default)
99 Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
102 Other extensions can extend this popup menu by pushing a code reference
103 onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104 popup is being displayed.
106 Its sole argument is the popup menu, which can be modified. It should
107 either return nothing or a string, the initial boolean value and a code
108 reference. The string will be used as button text and the code reference
109 will be called when the toggle changes, with the new boolean value as
112 The following will add an entry C<myoption> that changes
113 C<$self->{myoption}>:
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
119 =item selection-popup (enabled by default)
121 Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122 text into various other formats/action (such as uri unescaping, perl
123 evaluation, web-browser starting etc.), depending on content.
125 Other extensions can extend this popup menu by pushing a code reference
126 onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127 popup is being displayed.
129 Its sole argument is the popup menu, which can be modified. The selection
130 is in C<$_>, which can be used to decide whether to add something or not.
131 It should either return nothing or a string and a code reference. The
132 string will be used as button text and the code reference will be called
133 when the button gets activated and should transform C<$_>.
135 The following will add an entry C<a to b> that transforms all C<a>s in
136 the selection to C<b>s, but only if the selection currently contains any
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
144 =item searchable-scrollback<hotkey> (enabled by default)
146 Adds regex search functionality to the scrollback buffer, triggered
147 by a hotkey (default: C<M-s>). While in search mode, normal terminal
148 input/output is suspended and a regex is displayed at the bottom of the
151 Inputting characters appends them to the regex and continues incremental
152 search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153 search upwards/downwards in the scrollback buffer, C<End> jumps to the
154 bottom. C<Escape> leaves search mode and returns to the point where search
155 was started, while C<Enter> or C<Return> stay at the current position and
156 additionally stores the first match in the current line into the primary
157 selection if the C<Shift> modifier is active.
159 The regex defaults to "(?i)", resulting in a case-insensitive search. To
160 get a case-sensitive search you can delete this prefix using C<BackSpace>
161 or simply use an uppercase character which removes the "(?i)" prefix.
163 See L<perlre> for more info about perl regular expression syntax.
165 =item readline (enabled by default)
167 A support package that tries to make editing with readline easier. At
168 the moment, it reacts to clicking shift-left mouse button by trying to
169 move the text cursor to this position. It does so by generating as many
170 cursor-left or cursor-right keypresses as required (the this only works
171 for programs that correctly support wide characters).
173 To avoid too many false positives, this is only done when:
177 =item - the tty is in ICANON state.
179 =item - the text cursor is visible.
181 =item - the primary screen is currently being displayed.
183 =item - the mouse is on the same (multi-row-) line as the text cursor.
187 The normal selection mechanism isn't disabled, so quick successive clicks
188 might interfere with selection creation in harmless ways.
190 =item selection-autotransform
192 This selection allows you to do automatic transforms on a selection
193 whenever a selection is made.
195 It works by specifying perl snippets (most useful is a single C<s///>
196 operator) that modify C<$_> as resources:
198 URxvt.selection-autotransform.0: transform
199 URxvt.selection-autotransform.1: transform
202 For example, the following will transform selections of the form
203 C<filename:number>, often seen in compiler messages, into C<vi +$filename
206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
208 And this example matches the same,but replaces it with vi-commands you can
209 paste directly into your (vi :) editor:
211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
213 Of course, this can be modified to suit your needs and your editor :)
215 To expand the example above to typical perl error messages ("XXX at
216 FILENAME line YYY."), you need a slightly more elaborate solution:
218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
221 The first line tells the selection code to treat the unchanging part of
222 every error message as a selection pattern, and the second line transforms
223 the message into vi commands to load the file.
227 This transforms the terminal into a tabbar with additional terminals, that
228 is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229 displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
232 Clicking a button will activate that tab. Pressing B<Shift-Left> and
233 B<Shift-Right> will switch to the tab left or right of the current one,
234 while B<Shift-Down> creates a new tab.
236 The tabbar itself can be configured similarly to a normal terminal, but
237 with a resource class of C<URxvt.tabbed>. In addition, it supports the
238 following four resources (shown with defaults):
240 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242 URxvt.tabbed.tab-fg: <colour-index, default 0>
243 URxvt.tabbed.tab-bg: <colour-index, default 1>
245 See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
250 Uses per-line display filtering (C<on_line_update>) to underline text
251 matching a certain pattern and make it clickable. When clicked with the
252 mouse button specified in the C<matcher.button> resource (default 2, or
253 middle), the program specified in the C<matcher.launcher> resource
254 (default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255 with the matched text as first argument. The default configuration is
256 suitable for matching URLs and launching a web browser, like the
257 former "mark-urls" extension.
259 The default pattern to match URLs can be overridden with the
260 C<matcher.pattern.0> resource, and additional patterns can be specified
261 with numbered patterns, in a manner similar to the "selection" extension.
262 The launcher can also be overridden on a per-pattern basis.
264 It is possible to activate the most recently seen match from the keyboard.
265 Simply bind a keysym to "perl:matcher" as seen in the example below.
267 Example configuration:
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
279 This (experimental) perl extension implements OnTheSpot editing. It does
280 not work perfectly, and some input methods don't seem to work well with
281 OnTheSpot editing in general, but it seems to work at least for SCIM and
284 You enable it by specifying this extension and a preedit style of
287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
291 A very primitive quake-console-like extension. It was inspired by a
292 description of how the programs C<kuake> and C<yakuake> work: Whenever the
293 user presses a global accelerator key (by default C<F10>), the terminal
294 will show or hide itself. Another press of the accelerator key will hide
297 Initially, the window will not be shown when using this extension.
299 This is useful if you need a single terminal that is not using any desktop
300 space most of the time but is quickly available at the press of a key.
302 The accelerator key is grabbed regardless of any modifiers, so this
303 extension will actually grab a physical key just for this function.
305 If you want a quake-like animation, tell your window manager to do so
308 =item automove-background
310 This is basically a very small extension that dynamically changes the
311 background pixmap offset to the window position, in effect creating the
312 same effect as pseudo transparency with a custom pixmap. No scaling is
313 supported in this mode. Example:
315 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
317 L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318 shows how this extension can be used to implement an automatically blurred
319 transparent background.
321 =item block-graphics-to-ascii
323 A not very useful example of filtering all text output to the terminal
324 by replacing all line-drawing characters (U+2500 .. U+259F) by a
325 similar-looking ascii character.
329 Displays a digital clock using the built-in overlay.
331 =item remote-clipboard
333 Somewhat of a misnomer, this extension adds two menu entries to the
334 selection popup that allows one to run external commands to store the
335 selection somewhere and fetch it again.
337 We use it to implement a "distributed selection mechanism", which just
338 means that one command uploads the file to a remote server, and another
341 The commands can be set using the C<URxvt.remote-selection.store> and
342 C<URxvt.remote-selection.fetch> resources. The first should read the
343 selection to store from STDIN (always in UTF-8), the second should provide
344 the selection data on STDOUT (also in UTF-8).
346 The defaults (which are likely useless to you) use rsh and cat:
348 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
349 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
351 =item selection-pastebin
353 This is a little rarely useful extension that Uploads the selection as
354 textfile to a remote site (or does other things). (The implementation is
355 not currently secure for use in a multiuser environment as it writes to
358 It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
361 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
363 Pressing this combination runs a command with C<%> replaced by the name of
364 the textfile. This command can be set via a resource:
366 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
368 And the default is likely not useful to anybody but the few people around
371 The name of the textfile is the hex encoded md5 sum of the selection, so
372 the same content should lead to the same filename.
374 After a successful upload the selection will be replaced by the text given
375 in the C<selection-pastebin-url> resource (again, the % is the placeholder
378 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
380 I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
381 the double C</> characters as comment start. Use C<\057\057> instead,
382 which works regardless of wether xrdb is used to parse the resource file
385 =item example-refresh-hooks
387 Displays a very simple digital clock in the upper right corner of the
388 window. Illustrates overwriting the refresh callbacks to create your own
393 =head1 API DOCUMENTATION
395 =head2 General API Considerations
397 All objects (such as terminals, time watchers etc.) are typical
398 reference-to-hash objects. The hash can be used to store anything you
399 like. All members starting with an underscore (such as C<_ptr> or
400 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
403 When objects are destroyed on the C++ side, the perl object hashes are
404 emptied, so its best to store related objects such as time watchers and
405 the like inside the terminal object so they get destroyed as soon as the
406 terminal is destroyed.
408 Argument names also often indicate the type of a parameter. Here are some
409 hints on what they mean:
415 Rxvt-unicodes special way of encoding text, where one "unicode" character
416 always represents one screen cell. See L<ROW_t> for a discussion of this format.
420 A perl text string, with an emphasis on I<text>. It can store all unicode
421 characters and is to be distinguished with text encoded in a specific
422 encoding (often locale-specific) and binary data.
426 Either binary data or - more common - a text string encoded in a
431 =head2 Extension Objects
433 Every perl extension is a perl class. A separate perl object is created
434 for each terminal, and each terminal has its own set of extenion objects,
435 which are passed as the first parameter to hooks. So extensions can use
436 their C<$self> object without having to think about clashes with other
437 extensions or other terminals, with the exception of methods and members
438 that begin with an underscore character C<_>: these are reserved for
441 Although it isn't a C<urxvt::term> object, you can call all methods of the
442 C<urxvt::term> class on this object.
444 It has the following methods and data members:
448 =item $urxvt_term = $self->{term}
450 Returns the C<urxvt::term> object associated with this instance of the
451 extension. This member I<must not> be changed in any way.
453 =item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
455 Dynamically enable the given hooks (named without the C<on_> prefix) for
456 this extension, replacing any previous hook. This is useful when you want
457 to overwrite time-critical hooks only temporarily.
459 =item $self->disable ($hook_name[, $hook_name..])
461 Dynamically disable the given hooks.
467 The following subroutines can be declared in extension files, and will be
468 called whenever the relevant event happens.
470 The first argument passed to them is an extension object as described in
471 the in the C<Extension Objects> section.
473 B<All> of these hooks must return a boolean value. If any of the called
474 hooks returns true, then the event counts as being I<consumed>, and the
475 relevant action might not be carried out by the C++ code.
477 I<< When in doubt, return a false value (preferably C<()>). >>
483 Called after a new terminal object has been initialized, but before
484 windows are created or the command gets run. Most methods are unsafe to
485 call or deliver senseless data, as terminal size and other characteristics
486 have not yet been determined. You can safely query and change resources
487 and options, though. For many purposes the C<on_start> hook is a better
492 Called at the very end of initialisation of a new terminal, just before
493 trying to map (display) the toplevel and returning to the main loop.
495 =item on_destroy $term
497 Called whenever something tries to destroy terminal, when the terminal is
498 still fully functional (not for long, though).
502 Called after the screen is "reset" for any reason, such as resizing or
503 control sequences. Here is where you can react on changes to size-related
506 =item on_child_start $term, $pid
508 Called just after the child process has been C<fork>ed.
510 =item on_child_exit $term, $status
512 Called just after the child process has exited. C<$status> is the status
515 =item on_sel_make $term, $eventtime
517 Called whenever a selection has been made by the user, but before the
518 selection text is copied, so changes to the beginning, end or type of the
519 selection will be honored.
521 Returning a true value aborts selection making by urxvt, in which case you
522 have to make a selection yourself by calling C<< $term->selection_grab >>.
524 =item on_sel_grab $term, $eventtime
526 Called whenever a selection has been copied, but before the selection is
527 requested from the server. The selection text can be queried and changed
528 by calling C<< $term->selection >>.
530 Returning a true value aborts selection grabbing. It will still be highlighted.
532 =item on_sel_extend $term
534 Called whenever the user tries to extend the selection (e.g. with a double
535 click) and is either supposed to return false (normal operation), or
536 should extend the selection itself and return true to suppress the built-in
537 processing. This can happen multiple times, as long as the callback
538 returns true, it will be called on every further click by the user and is
539 supposed to enlarge the selection more and more, if possible.
541 See the F<selection> example extension.
543 =item on_view_change $term, $offset
545 Called whenever the view offset changes, i.e. the user or program
546 scrolls. Offset C<0> means display the normal terminal, positive values
547 show this many lines of scrollback.
549 =item on_scroll_back $term, $lines, $saved
551 Called whenever lines scroll out of the terminal area into the scrollback
552 buffer. C<$lines> is the number of lines scrolled out and may be larger
553 than the scroll back buffer or the terminal.
555 It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
556 $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
557 number of lines that will be in the scrollback buffer.
559 =item on_osc_seq $term, $op, $args
561 Called on every OSC sequence and can be used to suppress it or modify its
562 behaviour. The default should be to return an empty list. A true value
563 suppresses execution of the request completely. Make sure you don't get
564 confused by recursive invocations when you output an osc sequence within
567 C<on_osc_seq_perl> should be used for new behaviour.
569 =item on_osc_seq_perl $term, $string
571 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
572 operating system command) is processed. Cursor position and other state
573 information is up-to-date when this happens. For interoperability, the
574 string should start with the extension name and a colon, to distinguish
575 it from commands for other extensions, and this might be enforced in the
578 Be careful not ever to trust (in a security sense) the data you receive,
579 as its source can not easily be controlled (e-mail content, messages from
580 other users on the same system etc.).
582 =item on_add_lines $term, $string
584 Called whenever text is about to be output, with the text as argument. You
585 can filter/change and output the text yourself by returning a true value
586 and calling C<< $term->scr_add_lines >> yourself. Please note that this
587 might be very slow, however, as your hook is called for B<all> text being
590 =item on_tt_write $term, $octets
592 Called whenever some data is written to the tty/pty and can be used to
593 suppress or filter tty input.
595 =item on_line_update $term, $row
597 Called whenever a line was updated or changed. Can be used to filter
598 screen output (e.g. underline urls or other useless stuff). Only lines
599 that are being shown will be filtered, and, due to performance reasons,
600 not always immediately.
602 The row number is always the topmost row of the line if the line spans
605 Please note that, if you change the line, then the hook might get called
606 later with the already-modified line (e.g. if unrelated parts change), so
607 you cannot just toggle rendition bits, but only set them.
609 =item on_refresh_begin $term
611 Called just before the screen gets redrawn. Can be used for overlay
612 or similar effects by modify terminal contents in refresh_begin, and
613 restoring them in refresh_end. The built-in overlay and selection display
614 code is run after this hook, and takes precedence.
616 =item on_refresh_end $term
618 Called just after the screen gets redrawn. See C<on_refresh_begin>.
620 =item on_user_command $term, $string
622 Called whenever a user-configured event is being activated (e.g. via
623 a C<perl:string> action bound to a key, see description of the B<keysym>
624 resource in the @@RXVT_NAME@@(1) manpage).
626 The event is simply the action string. This interface is assumed to change
627 slightly in the future.
629 =item on_resize_all_windows $tern, $new_width, $new_height
631 Called just after the new window size has been calculated, but before
632 windows are actually being resized or hints are being set. If this hook
633 returns TRUE, setting of the window hints is being skipped.
635 =item on_x_event $term, $event
637 Called on every X event received on the vt window (and possibly other
638 windows). Should only be used as a last resort. Most event structure
639 members are not passed.
641 =item on_root_event $term, $event
643 Like C<on_x_event>, but is called for events on the root window.
645 =item on_focus_in $term
647 Called whenever the window gets the keyboard focus, before rxvt-unicode
648 does focus in processing.
650 =item on_focus_out $term
652 Called whenever the window loses keyboard focus, before rxvt-unicode does
653 focus out processing.
655 =item on_configure_notify $term, $event
657 =item on_property_notify $term, $event
659 =item on_key_press $term, $event, $keysym, $octets
661 =item on_key_release $term, $event, $keysym
663 =item on_button_press $term, $event
665 =item on_button_release $term, $event
667 =item on_motion_notify $term, $event
669 =item on_map_notify $term, $event
671 =item on_unmap_notify $term, $event
673 Called whenever the corresponding X event is received for the terminal If
674 the hook returns true, then the even will be ignored by rxvt-unicode.
676 The event is a hash with most values as named by Xlib (see the XEvent
677 manpage), with the additional members C<row> and C<col>, which are the
678 (real, not screen-based) row and column under the mouse cursor.
680 C<on_key_press> additionally receives the string rxvt-unicode would
681 output, if any, in locale-specific encoding.
685 =item on_client_message $term, $event
687 =item on_wm_protocols $term, $event
689 =item on_wm_delete_window $term, $event
691 Called when various types of ClientMessage events are received (all with
692 format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
711 our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
719 our $NOCHAR = chr 0xffff;
721 =head2 Variables in the C<urxvt> Package
727 The rxvt-unicode library directory, where, among other things, the perl
728 modules and scripts are stored.
730 =item $urxvt::RESCLASS, $urxvt::RESCLASS
732 The resource class and name rxvt-unicode uses to look up X resources.
734 =item $urxvt::RXVTNAME
736 The basename of the installed binaries, usually C<urxvt>.
740 The current terminal. This variable stores the current C<urxvt::term>
741 object, whenever a callback/hook is executing.
743 =item @urxvt::TERM_INIT
745 All code references in this array will be called as methods of the next newly
746 created C<urxvt::term> object (during the C<on_init> phase). The array
747 gets cleared before the code references that were in it are being executed,
748 so references can push themselves onto it again if they so desire.
750 This complements to the perl-eval command line option, but gets executed
753 =item @urxvt::TERM_EXT
755 Works similar to C<@TERM_INIT>, but contains perl package/class names, which
756 get registered as normal extensions after calling the hooks in C<@TERM_INIT>
757 but before other extensions. Gets cleared just like C<@TERM_INIT>.
761 =head2 Functions in the C<urxvt> Package
765 =item urxvt::fatal $errormessage
767 Fatally aborts execution with the given error message. Avoid at all
768 costs! The only time this is acceptable is when the terminal process
771 =item urxvt::warn $string
773 Calls C<rxvt_warn> with the given string which should not include a
774 newline. The module also overwrites the C<warn> builtin with a function
775 that calls this function.
777 Using this function has the advantage that its output ends up in the
778 correct place, e.g. on stderr of the connecting urxvtc client.
780 Messages have a size limit of 1023 bytes currently.
782 =item @terms = urxvt::termlist
784 Returns all urxvt::term objects that exist in this process, regardless of
785 whether they are started, being destroyed etc., so be careful. Only term
786 objects that have perl extensions attached will be returned (because there
787 is no urxvt::term objet associated with others).
789 =item $time = urxvt::NOW
791 Returns the "current time" (as per the event loop).
793 =item urxvt::CurrentTime
795 =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
796 Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
797 Button4Mask, Button5Mask, AnyModifier
799 =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
800 ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
801 PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
802 Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
803 KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
804 ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
805 FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
807 =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
808 EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
809 GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
810 UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
811 ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
812 CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
813 SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
815 Various constants for use in X calls and event processing.
821 Rendition bitsets contain information about colour, font, font styles and
822 similar information for each screen cell.
824 The following "macros" deal with changes in rendition sets. You should
825 never just create a bitset, you should always modify an existing one,
826 as they contain important information required for correct operation of
831 =item $rend = urxvt::DEFAULT_RSTYLE
833 Returns the default rendition, as used when the terminal is starting up or
834 being reset. Useful as a base to start when creating renditions.
836 =item $rend = urxvt::OVERLAY_RSTYLE
838 Return the rendition mask used for overlays by default.
840 =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
842 Return the bit that enabled bold, italic, blink, reverse-video and
843 underline, respectively. To enable such a style, just logically OR it into
846 =item $foreground = urxvt::GET_BASEFG $rend
848 =item $background = urxvt::GET_BASEBG $rend
850 Return the foreground/background colour index, respectively.
852 =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
854 =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
856 =item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
858 Replace the foreground/background colour in the rendition mask with the
861 =item $value = urxvt::GET_CUSTOM $rend
863 Return the "custom" value: Every rendition has 5 bits for use by
864 extensions. They can be set and changed as you like and are initially
867 =item $rend = urxvt::SET_CUSTOM $rend, $new_value
869 Change the custom value.
876 # overwrite perl's warn
877 *CORE::GLOBAL::warn = sub {
878 my $msg = join "", @_;
880 unless $msg =~ /\n$/;
887 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
890 my ($level, $msg) = @_;
891 warn "$msg\n" if $level <= $verbosity;
896 # load a single script into its own package, once only
897 sub extension_package($) {
900 $extension_pkg{$path} ||= do {
901 $path =~ /([^\/\\]+)$/;
903 $pkg =~ s/[^[:word:]]/_/g;
904 $pkg = "urxvt::ext::$pkg";
906 verbose 3, "loading extension '$path' into package '$pkg'";
908 open my $fh, "<:raw", $path
912 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
913 . "#line 1 \"$path\"\n{\n"
914 . (do { local $/; <$fh> })
924 our $retval; # return value for urxvt
926 # called by the rxvt core
931 if ($htype == 0) { # INIT
932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
937 my @init = @TERM_INIT;
939 $_->($TERM) for @init;
942 $TERM->register_package ($_) for @pkg;
945 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
946 if ($_ eq "default") {
947 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
948 } elsif (/^-(.*)$/) {
950 } elsif (/^([^<]+)<(.*)>$/) {
951 push @{ $ext_arg{$1} }, $2;
957 for my $ext (sort keys %ext_arg) {
958 my @files = grep -f $_, map "$_/$ext", @dirs;
961 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
963 warn "perl extension '$ext' not found in perl library search path\n";
967 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
973 if (my $cb = $TERM->{_hook}[$htype]) {
974 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
977 for my $pkg (keys %$cb) {
978 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
979 $retval ||= $retval_;
982 $TERM->ungrab; # better to lose the grab than the session
987 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
991 if ($htype == 1) { # DESTROY
992 # clear package objects
993 %$_ = () for values %{ $TERM->{_pkg} };
1002 sub SET_COLOR($$$) {
1003 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1008 my ($str, $mask) = (@_, 0);
1009 my %color = ( fg => undef, bg => undef );
1011 for my $spec ( split /\s+/, $str ) {
1012 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1013 $color{lc($1)} = $2;
1015 my $neg = $spec =~ s/^[-^]//;
1016 unless ( exists &{"RS_$spec"} ) {
1017 push @failed, $spec;
1020 my $cur = &{"RS_$spec"};
1028 ($mask, @color{qw(fg bg)}, \@failed)
1031 # urxvt::term::extension
1033 package urxvt::term::extension;
1036 my ($self, %hook) = @_;
1037 my $pkg = $self->{_pkg};
1039 while (my ($name, $cb) = each %hook) {
1040 my $htype = $HOOKTYPE{uc $name};
1042 or Carp::croak "unsupported hook type '$name'";
1044 $self->set_should_invoke ($htype, +1)
1045 unless exists $self->{term}{_hook}[$htype]{$pkg};
1047 $self->{term}{_hook}[$htype]{$pkg} = $cb;
1052 my ($self, @hook) = @_;
1053 my $pkg = $self->{_pkg};
1055 for my $name (@hook) {
1056 my $htype = $HOOKTYPE{uc $name};
1058 or Carp::croak "unsupported hook type '$name'";
1060 $self->set_should_invoke ($htype, -1)
1061 if delete $self->{term}{_hook}[$htype]{$pkg};
1068 $AUTOLOAD =~ /:([^:]+)$/
1069 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
1074 \$proxy->{term}->$1 (\@_)
1077 } or die "FATAL: unable to compile method forwarder: $@";
1086 # urxvt::destroy_hook
1088 sub urxvt::destroy_hook::DESTROY {
1092 sub urxvt::destroy_hook(&) {
1093 bless \shift, urxvt::destroy_hook::
1096 package urxvt::anyevent;
1098 =head2 The C<urxvt::anyevent> Class
1100 The sole purpose of this class is to deliver an interface to the
1101 C<AnyEvent> module - any module using it will work inside urxvt without
1102 further programming. The only exception is that you cannot wait on
1103 condition variables, but non-blocking condvar use is ok. What this means
1104 is that you cannot use blocking APIs, but the non-blocking variant should
1111 $INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112 push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1115 my ($class, %arg) = @_;
1121 ->start (urxvt::NOW + $arg{after})
1123 $_[0]->stop; # need to cancel manually
1129 my ($class, %arg) = @_;
1133 bless [$arg{fh}, urxvt::iow
1135 ->fd (fileno $arg{fh})
1136 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1137 | ($arg{poll} =~ /w/ ? 2 : 0))
1140 $cb->(($_[1] & 1 ? 'r' : '')
1141 . ($_[1] & 2 ? 'w' : ''));
1151 bless \my $flag, urxvt::anyevent::
1160 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1165 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1168 package urxvt::term;
1170 =head2 The C<urxvt::term> Class
1176 # find on_xxx subs in the package and register them
1178 sub register_package {
1179 my ($self, $pkg, $argv) = @_;
1183 urxvt::verbose 6, "register package $pkg to $self";
1185 @{"$pkg\::ISA"} = urxvt::term::extension::;
1191 Scalar::Util::weaken ($proxy->{term} = $self);
1193 $self->{_pkg}{$pkg} = $proxy;
1195 for my $name (@HOOKNAME) {
1196 if (my $ref = $pkg->can ("on_" . lc $name)) {
1197 $proxy->enable ($name => $ref);
1202 =item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1204 Creates a new terminal, very similar as if you had started it with system
1205 C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1206 hash which defines the environment of the new terminal.
1208 Croaks (and probably outputs an error message) if the new instance
1209 couldn't be created. Returns C<undef> if the new instance didn't
1210 initialise perl, and the terminal object otherwise. The C<init> and
1211 C<start> hooks will be called before this call returns, and are free to
1212 refer to global data (which is race free).
1217 my ($class, $env, @args) = @_;
1219 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1220 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1222 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1225 =item $term->destroy
1227 Destroy the terminal object (close the window, free resources
1228 etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1229 watchers (timers, io watchers) are still active.
1231 =item $term->exec_async ($cmd[, @args])
1233 Works like the combination of the C<fork>/C<exec> builtins, which executes
1234 ("starts") programs in the background. This function takes care of setting
1235 the user environment before exec'ing the command (e.g. C<PATH>) and should
1236 be preferred over explicit calls to C<exec> or C<system>.
1238 Returns the pid of the subprocess or C<undef> on error.
1248 if !defined $pid or $pid;
1250 %ENV = %{ $self->env };
1256 =item $isset = $term->option ($optval[, $set])
1258 Returns true if the option specified by C<$optval> is enabled, and
1259 optionally change it. All option values are stored by name in the hash
1260 C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1262 Here is a likely non-exhaustive list of option names, please see the
1263 source file F</src/optinc.h> to see the actual list:
1265 borderLess console cursorBlink cursorUnderline hold iconic insecure
1266 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1267 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1268 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
1269 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
1270 transparent tripleclickwords utmpInhibit visualBell
1272 =item $value = $term->resource ($name[, $newval])
1274 Returns the current resource value associated with a given name and
1275 optionally sets a new value. Setting values is most useful in the C<init>
1276 hook. Unset resources are returned and accepted as C<undef>.
1278 The new value must be properly encoded to a suitable character encoding
1279 before passing it to this method. Similarly, the returned value may need
1280 to be converted from the used encoding to text.
1282 Resource names are as defined in F<src/rsinc.h>. Colours can be specified
1283 as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
1286 Please note that resource strings will currently only be freed when the
1287 terminal is destroyed, so changing options frequently will eat memory.
1289 Here is a likely non-exhaustive list of resource names, not all of which
1290 are supported in every build, please see the source file F</src/rsinc.h>
1291 to see the actual list:
1293 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1294 borderLess color cursorBlink cursorUnderline cutchars delete_key
1295 display_name embed ext_bwidth fade font geometry hold iconName
1296 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1297 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1298 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1299 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1300 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1301 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1302 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1303 secondaryScreen secondaryScroll selectstyle shade term_name title
1304 transient_for transparent transparent_all tripleclickwords utmpInhibit
1309 sub resource($$;$) {
1310 my ($self, $name) = (shift, shift);
1311 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1312 &urxvt::term::_resource
1315 =item $value = $term->x_resource ($pattern)
1317 Returns the X-Resource for the given pattern, excluding the program or
1318 class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1319 same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1320 resource with that pattern exists.
1322 This method should only be called during the C<on_start> hook, as there is
1323 only one resource database per display, and later invocations might return
1324 the wrong resources.
1326 =item $success = $term->parse_keysym ($keysym_spec, $command_string)
1328 Adds a keymap translation exactly as specified via a resource. See the
1329 C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1331 =item $rend = $term->rstyle ([$new_rstyle])
1333 Return and optionally change the current rendition. Text that is output by
1334 the terminal application will use this style.
1336 =item ($row, $col) = $term->screen_cur ([$row, $col])
1338 Return the current coordinates of the text cursor position and optionally
1339 set it (which is usually bad as applications don't expect that).
1341 =item ($row, $col) = $term->selection_mark ([$row, $col])
1343 =item ($row, $col) = $term->selection_beg ([$row, $col])
1345 =item ($row, $col) = $term->selection_end ([$row, $col])
1347 Return the current values of the selection mark, begin or end positions,
1348 and optionally set them to new values.
1350 =item $term->selection_make ($eventtime[, $rectangular])
1352 Tries to make a selection as set by C<selection_beg> and
1353 C<selection_end>. If C<$rectangular> is true (default: false), a
1354 rectangular selection will be made. This is the prefered function to make
1357 =item $success = $term->selection_grab ($eventtime)
1359 Try to request the primary selection text from the server (for example, as
1360 set by the next method). No visual feedback will be given. This function
1361 is mostly useful from within C<on_sel_grab> hooks.
1363 =item $oldtext = $term->selection ([$newtext])
1365 Return the current selection text and optionally replace it by C<$newtext>.
1367 =item $term->overlay_simple ($x, $y, $text)
1369 Create a simple multi-line overlay box. See the next method for details.
1373 sub overlay_simple {
1374 my ($self, $x, $y, $text) = @_;
1376 my @lines = split /\n/, $text;
1378 my $w = List::Util::max map $self->strwidth ($_), @lines;
1380 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
1381 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
1386 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
1388 Create a new (empty) overlay at the given position with the given
1389 width/height. C<$rstyle> defines the initial rendition style
1390 (default: C<OVERLAY_RSTYLE>).
1392 If C<$border> is C<2> (default), then a decorative border will be put
1395 If either C<$x> or C<$y> is negative, then this is counted from the
1396 right/bottom side, respectively.
1398 This method returns an urxvt::overlay object. The overlay will be visible
1399 as long as the perl object is referenced.
1401 The methods currently supported on C<urxvt::overlay> objects are:
1405 =item $overlay->set ($x, $y, $text, $rend)
1407 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1408 text in rxvt-unicode's special encoding and an array of rendition values
1409 at a specific position inside the overlay.
1411 =item $overlay->hide
1413 If visible, hide the overlay, but do not destroy it.
1415 =item $overlay->show
1417 If hidden, display the overlay again.
1421 =item $popup = $term->popup ($event)
1423 Creates a new C<urxvt::popup> object that implements a popup menu. The
1424 C<$event> I<must> be the event causing the menu to pop up (a button event,
1430 my ($self, $event) = @_;
1432 $self->grab ($event->{time}, 1)
1440 Scalar::Util::weaken $popup->{term};
1442 $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
1443 Scalar::Util::weaken $self->{_destroy}{$popup};
1448 =item $cellwidth = $term->strwidth ($string)
1450 Returns the number of screen-cells this string would need. Correctly
1451 accounts for wide and combining characters.
1453 =item $octets = $term->locale_encode ($string)
1455 Convert the given text string into the corresponding locale encoding.
1457 =item $string = $term->locale_decode ($octets)
1459 Convert the given locale-encoded octets into a perl string.
1461 =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1463 XORs the rendition values in the given span with the provided value
1464 (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1465 refresh hooks to provide effects similar to the selection.
1467 =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1469 Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1470 whitespace will additionally be xored with the C<$rstyle2>, which defaults
1471 to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1472 it instead. Both styles I<MUST NOT> contain font styles.
1474 =item $term->scr_bell
1478 =item $term->scr_add_lines ($string)
1480 Write the given text string to the screen, as if output by the application
1481 running inside the terminal. It may not contain command sequences (escape
1482 codes), but is free to use line feeds, carriage returns and tabs. The
1483 string is a normal text string, not in locale-dependent encoding.
1485 Normally its not a good idea to use this function, as programs might be
1486 confused by changes in cursor position or scrolling. Its useful inside a
1487 C<on_add_lines> hook, though.
1489 =item $term->scr_change_screen ($screen)
1491 Switch to given screen - 0 primary, 1 secondary.
1493 =item $term->cmd_parse ($octets)
1495 Similar to C<scr_add_lines>, but the argument must be in the
1496 locale-specific encoding of the terminal and can contain command sequences
1497 (escape codes) that will be interpreted.
1499 =item $term->tt_write ($octets)
1501 Write the octets given in C<$data> to the tty (i.e. as program input). To
1502 pass characters instead of octets, you should convert your strings first
1503 to the locale-specific encoding using C<< $term->locale_encode >>.
1505 =item $old_events = $term->pty_ev_events ([$new_events])
1507 Replaces the event mask of the pty watcher by the given event mask. Can
1508 be used to suppress input and output handling to the pty/tty. See the
1509 description of C<< urxvt::timer->events >>. Make sure to always restore
1512 =item $fd = $term->pty_fd
1514 Returns the master file descriptor for the pty in use, or C<-1> if no pty
1517 =item $windowid = $term->parent
1519 Return the window id of the toplevel window.
1521 =item $windowid = $term->vt
1523 Return the window id of the terminal window.
1525 =item $term->vt_emask_add ($x_event_mask)
1527 Adds the specified events to the vt event mask. Useful e.g. when you want
1528 to receive pointer events all the times:
1530 $term->vt_emask_add (urxvt::PointerMotionMask);
1532 =item $term->focus_in
1534 =item $term->focus_out
1536 =item $term->key_press ($state, $keycode[, $time])
1538 =item $term->key_release ($state, $keycode[, $time])
1540 Deliver various fake events to to terminal.
1542 =item $window_width = $term->width
1544 =item $window_height = $term->height
1546 =item $font_width = $term->fwidth
1548 =item $font_height = $term->fheight
1550 =item $font_ascent = $term->fbase
1552 =item $terminal_rows = $term->nrow
1554 =item $terminal_columns = $term->ncol
1556 =item $has_focus = $term->focus
1558 =item $is_mapped = $term->mapped
1560 =item $max_scrollback = $term->saveLines
1562 =item $nrow_plus_saveLines = $term->total_rows
1564 =item $topmost_scrollback_row = $term->top_row
1566 Return various integers describing terminal characteristics.
1568 =item $x_display = $term->display_id
1570 Return the DISPLAY used by rxvt-unicode.
1572 =item $lc_ctype = $term->locale
1574 Returns the LC_CTYPE category string used by this rxvt-unicode.
1576 =item $env = $term->env
1578 Returns a copy of the environment in effect for the terminal as a hashref
1579 similar to C<\%ENV>.
1581 =item @envv = $term->envv
1583 Returns the environment as array of strings of the form C<VAR=VALUE>.
1585 =item @argv = $term->argv
1587 Return the argument vector as this terminal, similar to @ARGV, but
1588 includes the program name as first element.
1593 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1596 =item $modifiermask = $term->ModLevel3Mask
1598 =item $modifiermask = $term->ModMetaMask
1600 =item $modifiermask = $term->ModNumLockMask
1602 Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1603 AltGr), the meta key (often Alt) and the num lock key, if applicable.
1605 =item $screen = $term->current_screen
1607 Returns the currently displayed screen (0 primary, 1 secondary).
1609 =item $cursor_is_hidden = $term->hidden_cursor
1611 Returns whether the cursor is currently hidden or not.
1613 =item $view_start = $term->view_start ([$newvalue])
1615 Returns the row number of the topmost displayed line. Maximum value is
1616 C<0>, which displays the normal terminal contents. Lower values scroll
1617 this many lines into the scrollback buffer.
1619 =item $term->want_refresh
1621 Requests a screen refresh. At the next opportunity, rxvt-unicode will
1622 compare the on-screen display with its stored representation. If they
1623 differ, it redraws the differences.
1625 Used after changing terminal contents to display them.
1627 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1629 Returns the text of the entire row with number C<$row_number>. Row C<0>
1630 is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
1631 terminal line. The scrollback buffer starts at line C<-1> and extends to
1632 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
1635 If C<$new_text> is specified, it will replace characters in the current
1636 line, starting at column C<$start_col> (default C<0>), which is useful
1637 to replace only parts of a line. The font index in the rendition will
1638 automatically be updated.
1640 C<$text> is in a special encoding: tabs and wide characters that use more
1641 than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1642 characters. Characters with combining characters and other characters that
1643 do not fit into the normal tetx encoding will be replaced with characters
1644 in the private use area.
1646 You have to obey this encoding when changing text. The advantage is
1647 that C<substr> and similar functions work on screen cells and not on
1650 The methods C<< $term->special_encode >> and C<< $term->special_decode >>
1651 can be used to convert normal strings into this encoding and vice versa.
1653 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
1655 Like C<< $term->ROW_t >>, but returns an arrayref with rendition
1656 bitsets. Rendition bitsets contain information about colour, font, font
1657 styles and similar information. See also C<< $term->ROW_t >>.
1659 When setting rendition, the font mask will be ignored.
1661 See the section on RENDITION, above.
1663 =item $length = $term->ROW_l ($row_number[, $new_length])
1665 Returns the number of screen cells that are in use ("the line
1666 length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
1667 line is joined with the following one.
1669 =item $bool = $term->is_longer ($row_number)
1671 Returns true if the row is part of a multiple-row logical "line" (i.e.
1672 joined with the following row), which means all characters are in use
1673 and it is continued on the next row (and possibly a continuation of the
1676 =item $line = $term->line ($row_number)
1678 Create and return a new C<urxvt::line> object that stores information
1679 about the logical line that row C<$row_number> is part of. It supports the
1684 =item $text = $line->t ([$new_text])
1686 Returns or replaces the full text of the line, similar to C<ROW_t>
1688 =item $rend = $line->r ([$new_rend])
1690 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
1692 =item $length = $line->l
1694 Returns the length of the line in cells, similar to C<ROW_l>.
1696 =item $rownum = $line->beg
1698 =item $rownum = $line->end
1700 Return the row number of the first/last row of the line, respectively.
1702 =item $offset = $line->offset_of ($row, $col)
1704 Returns the character offset of the given row|col pair within the logical
1705 line. Works for rows outside the line, too, and returns corresponding
1706 offsets outside the string.
1708 =item ($row, $col) = $line->coord_of ($offset)
1710 Translates a string offset into terminal coordinates again.
1717 my ($self, $row) = @_;
1719 my $maxrow = $self->nrow - 1;
1721 my ($beg, $end) = ($row, $row);
1723 --$beg while $self->ROW_is_longer ($beg - 1);
1724 ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1730 ncol => $self->ncol,
1731 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1735 sub urxvt::line::t {
1740 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1741 for $self->{beg} .. $self->{end};
1744 defined wantarray &&
1745 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1749 sub urxvt::line::r {
1754 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1755 for $self->{beg} .. $self->{end};
1758 if (defined wantarray) {
1760 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1762 $#$rend = $self->{len} - 1;
1769 sub urxvt::line::beg { $_[0]{beg} }
1770 sub urxvt::line::end { $_[0]{end} }
1771 sub urxvt::line::l { $_[0]{len} }
1773 sub urxvt::line::offset_of {
1774 my ($self, $row, $col) = @_;
1776 ($row - $self->{beg}) * $self->{ncol} + $col
1779 sub urxvt::line::coord_of {
1780 my ($self, $offset) = @_;
1785 $offset / $self->{ncol} + $self->{beg},
1786 $offset % $self->{ncol}
1790 =item $text = $term->special_encode $string
1792 Converts a perl string into the special encoding used by rxvt-unicode,
1793 where one character corresponds to one screen cell. See
1794 C<< $term->ROW_t >> for details.
1796 =item $string = $term->special_decode $text
1798 Converts rxvt-unicodes text representation into a perl string. See
1799 C<< $term->ROW_t >> for details.
1801 =item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1803 =item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1805 Register/unregister a synchronous button grab. See the XGrabButton
1808 =item $success = $term->grab ($eventtime[, $sync])
1810 Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1811 synchronous (C<$sync> is true). Also remembers the grab timestamp.
1813 =item $term->allow_events_async
1815 Calls XAllowEvents with AsyncBoth for the most recent grab.
1817 =item $term->allow_events_sync
1819 Calls XAllowEvents with SyncBoth for the most recent grab.
1821 =item $term->allow_events_replay
1823 Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1828 Calls XUngrab for the most recent grab. Is called automatically on
1829 evaluation errors, as it is better to lose the grab in the error case as
1832 =item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1834 =item $atom_name = $term->XGetAtomName ($atom)
1836 =item @atoms = $term->XListProperties ($window)
1838 =item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1840 =item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1842 =item $term->XDeleteProperty ($window, $property)
1844 =item $window = $term->DefaultRootWindow
1846 =item $term->XReparentWindow ($window, $parent, [$x, $y])
1848 =item $term->XMapWindow ($window)
1850 =item $term->XUnmapWindow ($window)
1852 =item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1854 =item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1856 =item $term->XChangeInput ($window, $add_events[, $del_events])
1858 Various X or X-related functions. The C<$term> object only serves as
1859 the source of the display, otherwise those functions map more-or-less
1860 directory onto the X functions of the same name.
1866 package urxvt::popup;
1868 =head2 The C<urxvt::popup> Class
1875 my ($self, $item) = @_;
1877 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1878 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1879 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1881 $item->{render} ||= sub { $_[0]{text} };
1883 push @{ $self->{item} }, $item;
1886 =item $popup->add_title ($title)
1888 Adds a non-clickable title to the popup.
1893 my ($self, $title) = @_;
1896 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1898 activate => sub { },
1902 =item $popup->add_separator ([$sepchr])
1904 Creates a separator, optionally using the character given as C<$sepchr>.
1909 my ($self, $sep) = @_;
1914 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1916 render => sub { $sep x $self->{term}->ncol },
1917 activate => sub { },
1921 =item $popup->add_button ($text, $cb)
1923 Adds a clickable button to the popup. C<$cb> is called whenever it is
1929 my ($self, $text, $cb) = @_;
1931 $self->add_item ({ type => "button", text => $text, activate => $cb});
1934 =item $popup->add_toggle ($text, $initial_value, $cb)
1936 Adds a toggle/checkbox item to the popup. The callback gets called
1937 whenever it gets toggled, with a boolean indicating its new value as its
1943 my ($self, $text, $value, $cb) = @_;
1949 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1950 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1953 $self->add_item ($item);
1958 Displays the popup (which is initially hidden).
1965 local $urxvt::popup::self = $self;
1967 my $env = $self->{term}->env;
1968 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1969 delete $env->{LC_ALL};
1970 $env->{LC_CTYPE} = $self->{term}->locale;
1972 urxvt::term->new ($env, "popup",
1973 "--perl-lib" => "", "--perl-ext-common" => "",
1974 "-pty-fd" => -1, "-sl" => 0,
1975 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1976 "--transient-for" => $self->{term}->parent,
1977 "-display" => $self->{term}->display_id,
1978 "-pe" => "urxvt-popup")
1979 or die "unable to create popup window\n";
1985 delete $self->{term}{_destroy}{$self};
1986 $self->{term}->ungrab;
1993 package urxvt::watcher;
1995 =head2 The C<urxvt::timer> Class
1997 This class implements timer watchers/events. Time is represented as a
1998 fractional number of seconds since the epoch. Example:
2000 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
2001 $term->{timer} = urxvt::timer
2005 $term->{overlay}->set (0, 0,
2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2011 =item $timer = new urxvt::timer
2013 Create a new timer object in started state. It is scheduled to fire
2016 =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2018 Set the callback to be called when the timer triggers.
2020 =item $tstamp = $timer->at
2022 Return the time this watcher will fire next.
2024 =item $timer = $timer->set ($tstamp)
2026 Set the time the event is generated to $tstamp.
2028 =item $timer = $timer->interval ($interval)
2030 Normally (and when C<$interval> is C<0>), the timer will automatically
2031 stop after it has fired once. If C<$interval> is non-zero, then the timer
2032 is automatically rescheduled at the given intervals.
2034 =item $timer = $timer->start
2038 =item $timer = $timer->start ($tstamp)
2040 Set the event trigger time to C<$tstamp> and start the timer.
2042 =item $timer = $timer->after ($delay)
2044 Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2046 =item $timer = $timer->stop
2052 =head2 The C<urxvt::iow> Class
2054 This class implements io watchers/events. Example:
2056 $term->{socket} = ...
2057 $term->{iow} = urxvt::iow
2059 ->fd (fileno $term->{socket})
2060 ->events (urxvt::EV_READ)
2063 my ($iow, $revents) = @_;
2064 # $revents must be 1 here, no need to check
2065 sysread $term->{socket}, my $buf, 8192
2072 =item $iow = new urxvt::iow
2074 Create a new io watcher object in stopped state.
2076 =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
2078 Set the callback to be called when io events are triggered. C<$reventmask>
2079 is a bitset as described in the C<events> method.
2081 =item $iow = $iow->fd ($fd)
2083 Set the file descriptor (not handle) to watch.
2085 =item $iow = $iow->events ($eventmask)
2087 Set the event mask to watch. The only allowed values are
2088 C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2089 together, or C<urxvt::EV_NONE>.
2091 =item $iow = $iow->start
2093 Start watching for requested events on the given handle.
2095 =item $iow = $iow->stop
2097 Stop watching for events on the given file handle.
2101 =head2 The C<urxvt::iw> Class
2103 This class implements idle watchers, that get called automatically when
2104 the process is idle. They should return as fast as possible, after doing
2109 =item $iw = new urxvt::iw
2111 Create a new idle watcher object in stopped state.
2113 =item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2115 Set the callback to be called when the watcher triggers.
2117 =item $timer = $timer->start
2121 =item $timer = $timer->stop
2127 =head2 The C<urxvt::pw> Class
2129 This class implements process watchers. They create an event whenever a
2130 process exits, after which they stop automatically.
2134 $term->{pw} = urxvt::pw
2138 my ($pw, $exit_status) = @_;
2144 =item $pw = new urxvt::pw
2146 Create a new process watcher in stopped state.
2148 =item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2150 Set the callback to be called when the timer triggers.
2152 =item $pw = $timer->start ($pid)
2154 Tells the watcher to start watching for process C<$pid>.
2156 =item $pw = $pw->stop
2164 =head2 URXVT_PERL_VERBOSITY
2166 This variable controls the verbosity level of the perl extension. Higher
2167 numbers indicate more verbose output.
2171 =item == 0 - fatal messages
2173 =item >= 3 - script loading and management
2175 =item >=10 - all called hooks
2177 =item >=11 - hook return values
2183 Marc Lehmann <pcg@goof.com>
2184 http://software.schmorp.de/pkg/rxvt-unicode