ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
Revision: 1.112
Committed: Thu Jan 19 21:02:06 2006 UTC (18 years, 4 months ago) by root
Branch: MAIN
Changes since 1.111: +12 -12 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 root 1.17 =encoding utf8
2    
3 root 1.1 =head1 NAME
4    
5 root 1.11 @@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
6 root 1.1
7     =head1 SYNOPSIS
8    
9 root 1.10 # create a file grab_test in $HOME:
10 root 1.1
11     sub on_sel_grab {
12     warn "you selected ", $_[0]->selection;
13 root 1.3 ()
14 root 1.1 }
15    
16 root 1.10 # start a @@RXVT_NAME@@ using it:
17    
18     @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 root 1.1
20     =head1 DESCRIPTION
21    
22 root 1.44 Everytime a terminal object gets created, extension scripts specified via
23     the C<perl> resource are loaded and associated with it.
24 root 1.10
25     Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26     thus must be encoded as UTF-8.
27 root 1.6
28     Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29 root 1.16 scripts will be shared (but not enabled) for all terminals.
30 root 1.6
31 root 1.75 =head1 PREPACKAGED EXTENSIONS
32 root 1.15
33 root 1.75 This section describes the extensions delivered with this release. You can
34 root 1.15 find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35    
36     You can activate them like this:
37    
38     @@RXVT_NAME@@ -pe <extensionname>
39    
40 root 1.111 Or by adding them to the resource for extensions loaded by default:
41    
42     URxvt.perl-ext-common: default,automove-background,selection-autotransform
43    
44 root 1.15 =over 4
45    
46 root 1.54 =item selection (enabled by default)
47 root 1.15
48 root 1.75 (More) intelligent selection. This extension tries to be more intelligent
49 root 1.87 when the user extends selections (double-click and further clicks). Right
50     now, it tries to select words, urls and complete shell-quoted
51     arguments, which is very convenient, too, if your F<ls> supports
52     C<--quoting-style=shell>.
53    
54     A double-click usually selects the word under the cursor, further clicks
55     will enlarge the selection.
56 root 1.22
57 root 1.88 The selection works by trying to match a number of regexes and displaying
58     them in increasing order of length. You can add your own regexes by
59     specifying resources of the form:
60    
61     URxvt.selection.pattern-0: perl-regex
62     URxvt.selection.pattern-1: perl-regex
63     ...
64    
65     The index number (0, 1...) must not have any holes, and each regex must
66     contain at least one pair of capturing parentheses, which will be used for
67     the match. For example, the followign adds a regex that matches everything
68     between two vertical bars:
69    
70     URxvt.selection.pattern-0: \\|([^|]+)\\|
71    
72     You can look at the source of the selection extension to see more
73     interesting uses, such as parsing a line from beginning to end.
74    
75 elmex 1.95 This extension also offers following bindable keyboard commands:
76 root 1.15
77     =over 4
78    
79     =item rot13
80    
81     Rot-13 the selection when activated. Used via keyboard trigger:
82    
83     URxvt.keysym.C-M-r: perl:selection:rot13
84    
85     =back
86    
87 root 1.54 =item option-popup (enabled by default)
88    
89 root 1.59 Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90 root 1.54 runtime.
91    
92 root 1.59 =item selection-popup (enabled by default)
93    
94     Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95 root 1.75 text into various other formats/action (such as uri unescaping, perl
96     evalution, web-browser starting etc.), depending on content.
97 root 1.59
98 root 1.110 Other extensions can extend this popup menu by pushing a code reference
99     onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100     popup is displayed.
101 root 1.101
102     It's sole argument is the popup menu, which can be modified. The selection
103     is in C<$_>, which can be used to decide wether to add something or not.
104     It should either return nothing or a string and a code reference. The
105     string will be used as button text and the code reference will be called
106     when the button gets activated and should transform C<$_>.
107    
108     The following will add an entry C<a to b> that transforms all C<a>s in
109     the selection to C<b>s, but only if the selection currently contains any
110     C<a>s:
111    
112 root 1.110 push @{ $self->{term}{selection_popup_hook} }, sub {
113 root 1.101 /a/ ? ("a to be" => sub { s/a/b/g }
114     : ()
115     };
116    
117 root 1.74 =item searchable-scrollback<hotkey> (enabled by default)
118 root 1.69
119 root 1.74 Adds regex search functionality to the scrollback buffer, triggered
120 root 1.87 by a hotkey (default: C<M-s>). While in search mode, normal terminal
121     input/output is suspended and a regex is displayed at the bottom of the
122     screen.
123    
124     Inputting characters appends them to the regex and continues incremental
125     search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126     search upwards/downwards in the scrollback buffer, C<End> jumps to the
127     bottom. C<Escape> leaves search mode and returns to the point where search
128     was started, while C<Enter> or C<Return> stay at the current position and
129     additionally stores the first match in the current line into the primary
130     selection.
131 root 1.69
132 root 1.88 =item selection-autotransform
133    
134     This selection allows you to do automatic transforms on a selection
135     whenever a selection is made.
136    
137     It works by specifying perl snippets (most useful is a single C<s///>
138     operator) that modify C<$_> as resources:
139    
140     URxvt.selection-autotransform.0: transform
141     URxvt.selection-autotransform.1: transform
142     ...
143    
144     For example, the following will transform selections of the form
145 root 1.89 C<filename:number>, often seen in compiler messages, into C<vi +$filename
146     $word>:
147 root 1.88
148 root 1.93 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149 root 1.88
150     And this example matches the same,but replaces it with vi-commands you can
151 root 1.89 paste directly into your (vi :) editor:
152 root 1.15
153 root 1.108 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154 root 1.20
155 root 1.90 Of course, this can be modified to suit your needs and your editor :)
156    
157 root 1.91 To expand the example above to typical perl error messages ("XXX at
158     FILENAME line YYY."), you need a slightly more elaborate solution:
159    
160 root 1.108 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161     URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162 root 1.91
163     The first line tells the selection code to treat the unchanging part of
164     every error message as a selection pattern, and the second line transforms
165     the message into vi commands to load the file.
166    
167 root 1.35 =item mark-urls
168    
169 root 1.79 Uses per-line display filtering (C<on_line_update>) to underline urls and
170 root 1.83 make them clickable. When middle-clicked, the program specified in the
171 root 1.87 resource C<urlLauncher> (default C<x-www-browser>) will be started with
172     the URL as first argument.
173 root 1.42
174 root 1.104 =item automove-background
175    
176     This is basically a one-line extension that dynamically changes the background pixmap offset
177     to the window position, in effect creating the same effect as pseudo transparency with
178     a custom pixmap. No scaling is supported in this mode. Exmaple:
179    
180     @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
181    
182 root 1.42 =item block-graphics-to-ascii
183    
184     A not very useful example of filtering all text output to the terminal,
185     by replacing all line-drawing characters (U+2500 .. U+259F) by a
186     similar-looking ascii character.
187 root 1.35
188 root 1.88 =item digital-clock
189    
190     Displays a digital clock using the built-in overlay.
191    
192 root 1.20 =item example-refresh-hooks
193    
194 root 1.15 Displays a very simple digital clock in the upper right corner of the
195     window. Illustrates overwriting the refresh callbacks to create your own
196     overlays or changes.
197    
198 elmex 1.97 =item selection-pastebin
199    
200 root 1.98 This is a little rarely useful extension that Uploads the selection as
201 root 1.99 textfile to a remote site (or does other things). (The implementation is
202     not currently secure for use in a multiuser environment as it writes to
203     F</tmp> directly.).
204 root 1.98
205     It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
206     i.e.
207 elmex 1.97
208     URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
209    
210 root 1.98 Pressing this combination runs a command with C<%> replaced by the name of
211     the textfile. This command can be set via a resource:
212    
213     URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
214    
215     And the default is likely not useful to anybody but the few people around
216     here :)
217 elmex 1.97
218 root 1.98 The name of the textfile is the hex encoded md5 sum of the selection, so
219     the same content should lead to the same filename.
220 elmex 1.97
221 root 1.98 After a successful upload the selection will be replaced by the text given
222     in the C<selection-pastebin-url> resource (again, the % is the placeholder
223     for the filename):
224 elmex 1.97
225 root 1.98 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
226 elmex 1.97
227 root 1.15 =back
228    
229 root 1.75 =head1 API DOCUMENTATION
230    
231 root 1.6 =head2 General API Considerations
232    
233     All objects (such as terminals, time watchers etc.) are typical
234     reference-to-hash objects. The hash can be used to store anything you
235 root 1.7 like. All members starting with an underscore (such as C<_ptr> or
236 root 1.23 C<_hook>) are reserved for internal uses and B<MUST NOT> be accessed or
237 root 1.7 modified).
238 root 1.6
239     When objects are destroyed on the C++ side, the perl object hashes are
240     emptied, so its best to store related objects such as time watchers and
241     the like inside the terminal object so they get destroyed as soon as the
242     terminal is destroyed.
243    
244 root 1.33 Argument names also often indicate the type of a parameter. Here are some
245     hints on what they mean:
246    
247     =over 4
248    
249     =item $text
250    
251     Rxvt-unicodes special way of encoding text, where one "unicode" character
252 root 1.78 always represents one screen cell. See L<ROW_t> for a discussion of this format.
253 root 1.33
254     =item $string
255    
256     A perl text string, with an emphasis on I<text>. It can store all unicode
257     characters and is to be distinguished with text encoded in a specific
258     encoding (often locale-specific) and binary data.
259    
260     =item $octets
261    
262     Either binary data or - more common - a text string encoded in a
263     locale-specific way.
264    
265     =back
266    
267 root 1.69 =head2 Extension Objects
268    
269     Very perl extension is a perl class. A separate perl object is created
270     for each terminal and each extension and passed as the first parameter to
271     hooks. So extensions can use their C<$self> object without having to think
272     about other extensions, with the exception of methods and members that
273     begin with an underscore character C<_>: these are reserved for internal
274     use.
275    
276     Although it isn't a C<urxvt::term> object, you can call all methods of the
277     C<urxvt::term> class on this object.
278    
279     It has the following methods and data members:
280    
281     =over 4
282    
283     =item $urxvt_term = $self->{term}
284    
285     Returns the C<urxvt::term> object associated with this instance of the
286     extension. This member I<must not> be changed in any way.
287    
288     =item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
289    
290     Dynamically enable the given hooks (named without the C<on_> prefix) for
291     this extension, replacing any previous hook. This is useful when you want
292     to overwrite time-critical hooks only temporarily.
293    
294     =item $self->disable ($hook_name[, $hook_name..])
295    
296     Dynamically disable the given hooks.
297    
298     =back
299    
300 root 1.1 =head2 Hooks
301    
302 root 1.43 The following subroutines can be declared in extension files, and will be
303 root 1.23 called whenever the relevant event happens.
304    
305 root 1.69 The first argument passed to them is an extension oject as described in
306     the in the C<Extension Objects> section.
307    
308 root 1.112 B<All> of these hooks must return a boolean value. If any of the called
309     hooks returns true, then the event counts as being I<consumed>, and the
310     relevant action might not be carried out by the C++ code.
311 root 1.1
312 root 1.69 I<< When in doubt, return a false value (preferably C<()>). >>
313 root 1.1
314     =over 4
315    
316     =item on_init $term
317    
318     Called after a new terminal object has been initialized, but before
319 root 1.36 windows are created or the command gets run. Most methods are unsafe to
320     call or deliver senseless data, as terminal size and other characteristics
321 root 1.112 have not yet been determined. You can safely query and change resources
322     and options, though. For many purposes the C<on_start> hook is a better
323     place.
324    
325     =item on_start $term
326    
327     Called at the very end of initialisation of a new terminal, just before
328     returning to the mainloop.
329 root 1.1
330     =item on_reset $term
331    
332     Called after the screen is "reset" for any reason, such as resizing or
333     control sequences. Here is where you can react on changes to size-related
334     variables.
335    
336 root 1.108 =item on_child_start $term, $pid
337    
338     Called just after the child process has been C<fork>ed.
339    
340     =item on_child_exit $term, $status
341    
342     Called just after the child process has exited. C<$status> is the status
343     from C<waitpid>.
344    
345 root 1.1 =item on_sel_make $term, $eventtime
346    
347     Called whenever a selection has been made by the user, but before the
348     selection text is copied, so changes to the beginning, end or type of the
349     selection will be honored.
350    
351     Returning a true value aborts selection making by urxvt, in which case you
352     have to make a selection yourself by calling C<< $term->selection_grab >>.
353    
354     =item on_sel_grab $term, $eventtime
355    
356     Called whenever a selection has been copied, but before the selection is
357     requested from the server. The selection text can be queried and changed
358     by calling C<< $term->selection >>.
359    
360     Returning a true value aborts selection grabbing. It will still be hilighted.
361    
362 root 1.22 =item on_sel_extend $term
363    
364     Called whenever the user tries to extend the selection (e.g. with a double
365     click) and is either supposed to return false (normal operation), or
366     should extend the selection itelf and return true to suppress the built-in
367 root 1.85 processing. This can happen multiple times, as long as the callback
368     returns true, it will be called on every further click by the user and is
369     supposed to enlarge the selection more and more, if possible.
370 root 1.22
371     See the F<selection> example extension.
372    
373 root 1.1 =item on_view_change $term, $offset
374    
375     Called whenever the view offset changes, i..e the user or program
376     scrolls. Offset C<0> means display the normal terminal, positive values
377     show this many lines of scrollback.
378    
379     =item on_scroll_back $term, $lines, $saved
380    
381     Called whenever lines scroll out of the terminal area into the scrollback
382     buffer. C<$lines> is the number of lines scrolled out and may be larger
383     than the scroll back buffer or the terminal.
384    
385     It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
386     $nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
387     number of lines that will be in the scrollback buffer.
388    
389 root 1.28 =item on_osc_seq $term, $string
390    
391 root 1.29 Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
392     operating system command) is processed. Cursor position and other state
393     information is up-to-date when this happens. For interoperability, the
394     string should start with the extension name and a colon, to distinguish
395     it from commands for other extensions, and this might be enforced in the
396     future.
397    
398     Be careful not ever to trust (in a security sense) the data you receive,
399     as its source can not easily be controleld (e-mail content, messages from
400     other users on the same system etc.).
401 root 1.28
402 root 1.33 =item on_add_lines $term, $string
403    
404     Called whenever text is about to be output, with the text as argument. You
405     can filter/change and output the text yourself by returning a true value
406     and calling C<< $term->scr_add_lines >> yourself. Please note that this
407     might be very slow, however, as your hook is called for B<all> text being
408     output.
409    
410 root 1.72 =item on_tt_write $term, $octets
411    
412     Called whenever some data is written to the tty/pty and can be used to
413     suppress or filter tty input.
414    
415 root 1.35 =item on_line_update $term, $row
416    
417     Called whenever a line was updated or changed. Can be used to filter
418     screen output (e.g. underline urls or other useless stuff). Only lines
419     that are being shown will be filtered, and, due to performance reasons,
420     not always immediately.
421    
422     The row number is always the topmost row of the line if the line spans
423     multiple rows.
424    
425     Please note that, if you change the line, then the hook might get called
426     later with the already-modified line (e.g. if unrelated parts change), so
427     you cannot just toggle rendition bits, but only set them.
428    
429 root 1.1 =item on_refresh_begin $term
430    
431     Called just before the screen gets redrawn. Can be used for overlay
432     or similar effects by modify terminal contents in refresh_begin, and
433     restoring them in refresh_end. The built-in overlay and selection display
434     code is run after this hook, and takes precedence.
435    
436     =item on_refresh_end $term
437    
438     Called just after the screen gets redrawn. See C<on_refresh_begin>.
439    
440 root 1.11 =item on_keyboard_command $term, $string
441    
442     Called whenever the user presses a key combination that has a
443     C<perl:string> action bound to it (see description of the B<keysym>
444     resource in the @@RXVT_NAME@@(1) manpage).
445    
446 root 1.92 =item on_x_event $term, $event
447    
448     Called on every X event received on the vt window (and possibly other
449     windows). Should only be used as a last resort. Most event structure
450     members are not passed.
451    
452 root 1.45 =item on_focus_in $term
453    
454     Called whenever the window gets the keyboard focus, before rxvt-unicode
455     does focus in processing.
456    
457     =item on_focus_out $term
458    
459     Called wheneever the window loses keyboard focus, before rxvt-unicode does
460     focus out processing.
461    
462 root 1.102 =item on_configure_notify $term, $event
463    
464 root 1.69 =item on_key_press $term, $event, $keysym, $octets
465 root 1.37
466 root 1.69 =item on_key_release $term, $event, $keysym
467 root 1.37
468     =item on_button_press $term, $event
469    
470     =item on_button_release $term, $event
471    
472     =item on_motion_notify $term, $event
473    
474 root 1.45 =item on_map_notify $term, $event
475    
476     =item on_unmap_notify $term, $event
477    
478 root 1.39 Called whenever the corresponding X event is received for the terminal If
479     the hook returns true, then the even will be ignored by rxvt-unicode.
480    
481     The event is a hash with most values as named by Xlib (see the XEvent
482     manpage), with the additional members C<row> and C<col>, which are the row
483     and column under the mouse cursor.
484 root 1.38
485     C<on_key_press> additionally receives the string rxvt-unicode would
486     output, if any, in locale-specific encoding.
487 root 1.37
488     subwindow.
489    
490 root 1.1 =back
491    
492 root 1.77 =cut
493    
494     package urxvt;
495    
496     use utf8;
497     use strict;
498     use Carp ();
499     use Scalar::Util ();
500     use List::Util ();
501    
502     our $VERSION = 1;
503     our $TERM;
504     our @HOOKNAME;
505     our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
506     our %OPTION;
507    
508     our $LIBDIR;
509     our $RESNAME;
510     our $RESCLASS;
511     our $RXVTNAME;
512    
513 root 1.23 =head2 Variables in the C<urxvt> Package
514    
515     =over 4
516    
517 root 1.75 =item $urxvt::LIBDIR
518    
519     The rxvt-unicode library directory, where, among other things, the perl
520     modules and scripts are stored.
521    
522     =item $urxvt::RESCLASS, $urxvt::RESCLASS
523    
524     The resource class and name rxvt-unicode uses to look up X resources.
525    
526     =item $urxvt::RXVTNAME
527    
528     The basename of the installed binaries, usually C<urxvt>.
529    
530 root 1.23 =item $urxvt::TERM
531    
532 root 1.43 The current terminal. This variable stores the current C<urxvt::term>
533     object, whenever a callback/hook is executing.
534 root 1.23
535     =back
536    
537 root 1.1 =head2 Functions in the C<urxvt> Package
538    
539     =over 4
540    
541     =item urxvt::fatal $errormessage
542    
543     Fatally aborts execution with the given error message. Avoid at all
544     costs! The only time this is acceptable is when the terminal process
545     starts up.
546    
547     =item urxvt::warn $string
548    
549 root 1.6 Calls C<rxvt_warn> with the given string which should not include a
550 root 1.1 newline. The module also overwrites the C<warn> builtin with a function
551     that calls this function.
552    
553     Using this function has the advantage that its output ends up in the
554     correct place, e.g. on stderr of the connecting urxvtc client.
555    
556 root 1.77 Messages have a size limit of 1023 bytes currently.
557    
558 root 1.1 =item $time = urxvt::NOW
559    
560     Returns the "current time" (as per the event loop).
561    
562 root 1.47 =item urxvt::CurrentTime
563    
564     =item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
565     Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
566     Button4Mask, Button5Mask, AnyModifier
567    
568 root 1.92 =item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
569     ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
570     PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
571     Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
572     KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
573     ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
574     FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
575    
576     =item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
577     EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
578     GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
579     UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
580     ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
581     CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
582     SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
583    
584 root 1.55 Various constants for use in X calls and event processing.
585 root 1.47
586 root 1.21 =back
587    
588 root 1.18 =head2 RENDITION
589    
590     Rendition bitsets contain information about colour, font, font styles and
591     similar information for each screen cell.
592    
593     The following "macros" deal with changes in rendition sets. You should
594     never just create a bitset, you should always modify an existing one,
595     as they contain important information required for correct operation of
596     rxvt-unicode.
597    
598     =over 4
599    
600     =item $rend = urxvt::DEFAULT_RSTYLE
601    
602     Returns the default rendition, as used when the terminal is starting up or
603     being reset. Useful as a base to start when creating renditions.
604    
605     =item $rend = urxvt::OVERLAY_RSTYLE
606    
607     Return the rendition mask used for overlays by default.
608    
609     =item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
610    
611     Return the bit that enabled bold, italic, blink, reverse-video and
612 root 1.19 underline, respectively. To enable such a style, just logically OR it into
613     the bitset.
614 root 1.18
615     =item $foreground = urxvt::GET_BASEFG $rend
616    
617     =item $background = urxvt::GET_BASEBG $rend
618    
619     Return the foreground/background colour index, respectively.
620    
621 root 1.75 =item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
622 root 1.18
623 root 1.75 =item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
624 root 1.18
625     Replace the foreground/background colour in the rendition mask with the
626     specified one.
627    
628 root 1.75 =item $value = urxvt::GET_CUSTOM $rend
629 root 1.19
630     Return the "custom" value: Every rendition has 5 bits for use by
631     extensions. They can be set and changed as you like and are initially
632     zero.
633    
634 root 1.75 =item $rend = urxvt::SET_CUSTOM $rend, $new_value
635 root 1.19
636     Change the custom value.
637    
638 root 1.18 =back
639    
640 root 1.1 =cut
641    
642     BEGIN {
643     # overwrite perl's warn
644     *CORE::GLOBAL::warn = sub {
645     my $msg = join "", @_;
646     $msg .= "\n"
647     unless $msg =~ /\n$/;
648     urxvt::warn ($msg);
649     };
650     }
651    
652 root 1.7 my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
653 root 1.1
654     sub verbose {
655     my ($level, $msg) = @_;
656 root 1.8 warn "$msg\n" if $level <= $verbosity;
657 root 1.1 }
658    
659 root 1.44 my %extension_pkg;
660 root 1.1
661     # load a single script into its own package, once only
662 root 1.44 sub extension_package($) {
663 root 1.1 my ($path) = @_;
664    
665 root 1.100 no strict 'refs';
666    
667 root 1.44 $extension_pkg{$path} ||= do {
668 root 1.100 $path =~ /([^\/\\]+)$/;
669     my $pkg = $1;
670     $pkg =~ s/[^[:word:]]/_/g;
671     $pkg = "urxvt::ext::$pkg";
672 root 1.8
673 root 1.44 verbose 3, "loading extension '$path' into package '$pkg'";
674 root 1.1
675     open my $fh, "<:raw", $path
676     or die "$path: $!";
677    
678 root 1.100 @{"$pkg\::ISA"} = urxvt::term::extension::;
679    
680 root 1.96 my $source =
681 root 1.69 "package $pkg; use strict; use utf8;\n"
682     . "#line 1 \"$path\"\n{\n"
683     . (do { local $/; <$fh> })
684     . "\n};\n1";
685 root 1.8
686 root 1.69 eval $source
687     or die "$path: $@";
688 root 1.1
689     $pkg
690 root 1.7 }
691 root 1.1 }
692    
693 root 1.31 our $retval; # return value for urxvt
694    
695 root 1.8 # called by the rxvt core
696     sub invoke {
697 root 1.23 local $TERM = shift;
698 root 1.8 my $htype = shift;
699 root 1.6
700 root 1.8 if ($htype == 0) { # INIT
701 root 1.23 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
702 root 1.49
703 root 1.68 my %ext_arg;
704 root 1.6
705 root 1.50 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
706     if ($_ eq "default") {
707 root 1.69 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback);
708 root 1.51 } elsif (/^-(.*)$/) {
709 root 1.68 delete $ext_arg{$1};
710     } elsif (/^([^<]+)<(.*)>$/) {
711     push @{ $ext_arg{$1} }, $2;
712 root 1.49 } else {
713 root 1.68 $ext_arg{$_} ||= [];
714 root 1.50 }
715     }
716 root 1.6
717 root 1.68 while (my ($ext, $argv) = each %ext_arg) {
718 root 1.50 my @files = grep -f $_, map "$_/$ext", @dirs;
719    
720     if (@files) {
721 root 1.68 $TERM->register_package (extension_package $files[0], $argv);
722 root 1.50 } else {
723     warn "perl extension '$ext' not found in perl library search path\n";
724 root 1.8 }
725     }
726 root 1.55
727     eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
728     warn $@ if $@;
729 root 1.31 }
730    
731     $retval = undef;
732 root 1.6
733 root 1.31 if (my $cb = $TERM->{_hook}[$htype]) {
734     verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
735     if $verbosity >= 10;
736    
737     keys %$cb;
738    
739     while (my ($pkg, $cb) = each %$cb) {
740 root 1.112 $retval ||= eval { $cb->($TERM->{_pkg}{$pkg}, @_) };
741 root 1.68
742 root 1.58 if ($@) {
743     $TERM->ungrab; # better to lose the grab than the session
744     warn $@;
745     }
746 root 1.31 }
747 root 1.85
748     verbose 11, "$HOOKNAME[$htype] returning <$retval>"
749     if $verbosity >= 11;
750 root 1.31 }
751    
752     if ($htype == 1) { # DESTROY
753     # clear package objects
754     %$_ = () for values %{ $TERM->{_pkg} };
755 root 1.25
756 root 1.31 # clear package
757     %$TERM = ();
758 root 1.7 }
759    
760 root 1.31 $retval
761 root 1.7 }
762 root 1.1
763 root 1.71 # urxvt::term::extension
764 root 1.55
765 root 1.71 package urxvt::term::extension;
766 root 1.69
767     sub enable {
768     my ($self, %hook) = @_;
769     my $pkg = $self->{_pkg};
770    
771     while (my ($name, $cb) = each %hook) {
772     my $htype = $HOOKTYPE{uc $name};
773     defined $htype
774     or Carp::croak "unsupported hook type '$name'";
775    
776 root 1.92 $self->set_should_invoke ($htype, +1)
777     unless exists $self->{term}{_hook}[$htype]{$pkg};
778 root 1.69
779     $self->{term}{_hook}[$htype]{$pkg} = $cb;
780     }
781     }
782    
783     sub disable {
784     my ($self, @hook) = @_;
785     my $pkg = $self->{_pkg};
786    
787     for my $name (@hook) {
788     my $htype = $HOOKTYPE{uc $name};
789     defined $htype
790     or Carp::croak "unsupported hook type '$name'";
791    
792 root 1.92 $self->set_should_invoke ($htype, -1)
793     if delete $self->{term}{_hook}[$htype]{$pkg};
794 root 1.69 }
795     }
796    
797     our $AUTOLOAD;
798    
799     sub AUTOLOAD {
800     $AUTOLOAD =~ /:([^:]+)$/
801     or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
802 root 1.23
803     eval qq{
804 root 1.69 sub $AUTOLOAD {
805 root 1.24 my \$proxy = shift;
806     \$proxy->{term}->$1 (\@_)
807 root 1.23 }
808     1
809     } or die "FATAL: unable to compile method forwarder: $@";
810    
811 root 1.69 goto &$AUTOLOAD;
812 root 1.23 }
813    
814 root 1.69 sub DESTROY {
815 root 1.58 # nop
816     }
817    
818 root 1.55 # urxvt::destroy_hook
819    
820 root 1.45 sub urxvt::destroy_hook::DESTROY {
821     ${$_[0]}->();
822     }
823    
824     sub urxvt::destroy_hook(&) {
825     bless \shift, urxvt::destroy_hook::
826     }
827    
828 root 1.56 package urxvt::anyevent;
829    
830     =head2 The C<urxvt::anyevent> Class
831    
832     The sole purpose of this class is to deliver an interface to the
833     C<AnyEvent> module - any module using it will work inside urxvt without
834 root 1.75 further programming. The only exception is that you cannot wait on
835     condition variables, but non-blocking condvar use is ok. What this means
836     is that you cannot use blocking APIs, but the non-blocking variant should
837     work.
838 root 1.55
839 root 1.56 =cut
840 root 1.55
841     our $VERSION = 1;
842    
843     $INC{"urxvt/anyevent.pm"} = 1; # mark us as there
844     push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
845    
846     sub timer {
847     my ($class, %arg) = @_;
848    
849     my $cb = $arg{cb};
850    
851     urxvt::timer
852     ->new
853     ->start (urxvt::NOW + $arg{after})
854     ->cb (sub {
855     $_[0]->stop; # need to cancel manually
856     $cb->();
857     })
858     }
859    
860     sub io {
861     my ($class, %arg) = @_;
862    
863     my $cb = $arg{cb};
864    
865     bless [$arg{fh}, urxvt::iow
866     ->new
867     ->fd (fileno $arg{fh})
868     ->events (($arg{poll} =~ /r/ ? 1 : 0)
869     | ($arg{poll} =~ /w/ ? 2 : 0))
870     ->start
871     ->cb (sub {
872     $cb->(($_[1] & 1 ? 'r' : '')
873     . ($_[1] & 2 ? 'w' : ''));
874     })],
875     urxvt::anyevent::
876     }
877    
878     sub DESTROY {
879     $_[0][1]->stop;
880     }
881    
882     sub condvar {
883     bless \my $flag, urxvt::anyevent::condvar::
884     }
885    
886     sub urxvt::anyevent::condvar::broadcast {
887     ${$_[0]}++;
888     }
889    
890     sub urxvt::anyevent::condvar::wait {
891     unless (${$_[0]}) {
892 root 1.69 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
893 root 1.55 }
894     }
895    
896     package urxvt::term;
897    
898 root 1.1 =head2 The C<urxvt::term> Class
899    
900     =over 4
901    
902 root 1.68 =cut
903    
904     # find on_xxx subs in the package and register them
905     # as hooks
906     sub register_package {
907     my ($self, $pkg, $argv) = @_;
908    
909 root 1.69 my $proxy = bless {
910     _pkg => $pkg,
911     argv => $argv,
912     }, $pkg;
913     Scalar::Util::weaken ($proxy->{term} = $self);
914 root 1.68
915     $self->{_pkg}{$pkg} = $proxy;
916    
917 root 1.69 for my $name (@HOOKNAME) {
918     if (my $ref = $pkg->can ("on_" . lc $name)) {
919     $proxy->enable ($name => $ref);
920     }
921 root 1.68 }
922     }
923    
924 root 1.77 =item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
925    
926     Creates a new terminal, very similar as if you had started it with system
927 root 1.78 C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
928     hash which defines the environment of the new terminal.
929 root 1.77
930     Croaks (and probably outputs an error message) if the new instance
931     couldn't be created. Returns C<undef> if the new instance didn't
932     initialise perl, and the terminal object otherwise. The C<init> and
933     C<start> hooks will be called during this call.
934    
935     =cut
936    
937     sub new {
938     my ($class, $env, @args) = @_;
939    
940     _new ([ map "$_=$env->{$_}", keys %$env ], @args);
941     }
942    
943 root 1.36 =item $term->destroy
944    
945 root 1.75 Destroy the terminal object (close the window, free resources
946     etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
947     watchers (timers, io watchers) are still active.
948 root 1.36
949 root 1.108 =item $term->exec_async ($cmd[, @args])
950    
951     Works like the combination of the C<fork>/C<exec> builtins, which executes
952     ("starts") programs in the background. This function takes care of setting
953     the user environment before exec'ing the command (e.g. C<PATH>) and should
954     be preferred over explicit calls to C<exec> or C<system>.
955    
956     Returns the pid of the subprocess or C<undef> on error.
957    
958     =cut
959    
960     sub exec_async {
961     my $self = shift;
962    
963     my $pid = fork;
964    
965     return $pid
966     if !defined $pid or $pid;
967    
968     %ENV = %{ $self->env };
969    
970     exec @_;
971     urxvt::_exit 255;
972     }
973    
974 root 1.49 =item $isset = $term->option ($optval[, $set])
975    
976     Returns true if the option specified by C<$optval> is enabled, and
977     optionally change it. All option values are stored by name in the hash
978     C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
979    
980     Here is a a likely non-exhaustive list of option names, please see the
981     source file F</src/optinc.h> to see the actual list:
982    
983     borderLess console cursorBlink cursorUnderline hold iconic insecure
984     intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
985 root 1.105 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
986     scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
987     scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
988     transparent tripleclickwords utmpInhibit visualBell
989 root 1.49
990 root 1.4 =item $value = $term->resource ($name[, $newval])
991    
992     Returns the current resource value associated with a given name and
993     optionally sets a new value. Setting values is most useful in the C<init>
994     hook. Unset resources are returned and accepted as C<undef>.
995    
996     The new value must be properly encoded to a suitable character encoding
997     before passing it to this method. Similarly, the returned value may need
998     to be converted from the used encoding to text.
999    
1000     Resource names are as defined in F<src/rsinc.h>. Colours can be specified
1001     as resource names of the form C<< color+<index> >>, e.g. C<color+5>. (will
1002     likely change).
1003    
1004     Please note that resource strings will currently only be freed when the
1005     terminal is destroyed, so changing options frequently will eat memory.
1006    
1007 root 1.5 Here is a a likely non-exhaustive list of resource names, not all of which
1008 root 1.49 are supported in every build, please see the source file F</src/rsinc.h>
1009     to see the actual list:
1010 root 1.5
1011     answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1012     borderLess color cursorBlink cursorUnderline cutchars delete_key
1013     display_name embed ext_bwidth fade font geometry hold iconName
1014     imFont imLocale inputMethod insecure int_bwidth intensityStyles
1015 root 1.105 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1016     mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1017     perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1018     preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1019     scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1020     scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1021     secondaryScreen secondaryScroll selectstyle shade term_name title
1022     transient_for transparent transparent_all tripleclickwords utmpInhibit
1023     visualBell
1024 root 1.5
1025 root 1.4 =cut
1026    
1027 root 1.55 sub resource($$;$) {
1028 root 1.4 my ($self, $name) = (shift, shift);
1029     unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1030 root 1.45 &urxvt::term::_resource
1031 root 1.4 }
1032    
1033 root 1.79 =item $value = $term->x_resource ($pattern)
1034    
1035     Returns the X-Resource for the given pattern, excluding the program or
1036     class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1037     same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1038     resource with that pattern exists.
1039    
1040     This method should only be called during the C<on_start> hook, as there is
1041     only one resource database per display, and later invocations might return
1042     the wrong resources.
1043    
1044 root 1.69 =item $success = $term->parse_keysym ($keysym_spec, $command_string)
1045    
1046     Adds a keymap translation exactly as specified via a resource. See the
1047     C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1048    
1049 root 1.33 =item $rend = $term->rstyle ([$new_rstyle])
1050 root 1.32
1051 root 1.33 Return and optionally change the current rendition. Text that is output by
1052     the terminal application will use this style.
1053 root 1.32
1054     =item ($row, $col) = $term->screen_cur ([$row, $col])
1055    
1056     Return the current coordinates of the text cursor position and optionally
1057     set it (which is usually bad as applications don't expect that).
1058    
1059 root 1.1 =item ($row, $col) = $term->selection_mark ([$row, $col])
1060    
1061     =item ($row, $col) = $term->selection_beg ([$row, $col])
1062    
1063     =item ($row, $col) = $term->selection_end ([$row, $col])
1064    
1065     Return the current values of the selection mark, begin or end positions,
1066     and optionally set them to new values.
1067    
1068 root 1.86 =item $term->selection_make ($eventtime[, $rectangular])
1069    
1070     Tries to make a selection as set by C<selection_beg> and
1071     C<selection_end>. If C<$rectangular> is true (default: false), a
1072     rectangular selection will be made. This is the prefered function to make
1073     a selection.
1074    
1075 root 1.1 =item $success = $term->selection_grab ($eventtime)
1076    
1077 root 1.86 Try to request the primary selection text from the server (for example, as
1078     set by the next method). No visual feedback will be given. This function
1079     is mostly useful from within C<on_sel_grab> hooks.
1080 root 1.1
1081     =item $oldtext = $term->selection ([$newtext])
1082    
1083     Return the current selection text and optionally replace it by C<$newtext>.
1084    
1085 root 1.69 =item $term->overlay_simple ($x, $y, $text)
1086    
1087     Create a simple multi-line overlay box. See the next method for details.
1088    
1089     =cut
1090    
1091     sub overlay_simple {
1092     my ($self, $x, $y, $text) = @_;
1093    
1094     my @lines = split /\n/, $text;
1095    
1096     my $w = List::Util::max map $self->strwidth ($_), @lines;
1097    
1098     my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
1099     $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
1100    
1101     $overlay
1102     }
1103 root 1.1
1104 root 1.20 =item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
1105 root 1.1
1106     Create a new (empty) overlay at the given position with the given
1107 root 1.20 width/height. C<$rstyle> defines the initial rendition style
1108     (default: C<OVERLAY_RSTYLE>).
1109 root 1.1
1110 root 1.20 If C<$border> is C<2> (default), then a decorative border will be put
1111     around the box.
1112 root 1.1
1113 root 1.20 If either C<$x> or C<$y> is negative, then this is counted from the
1114     right/bottom side, respectively.
1115 root 1.1
1116 root 1.20 This method returns an urxvt::overlay object. The overlay will be visible
1117     as long as the perl object is referenced.
1118 root 1.1
1119 root 1.22 The methods currently supported on C<urxvt::overlay> objects are:
1120    
1121     =over 4
1122 root 1.1
1123 root 1.20 =item $overlay->set ($x, $y, $text, $rend)
1124 root 1.1
1125 root 1.20 Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1126     text in rxvt-unicode's special encoding and an array of rendition values
1127     at a specific position inside the overlay.
1128 root 1.1
1129 root 1.22 =item $overlay->hide
1130    
1131     If visible, hide the overlay, but do not destroy it.
1132    
1133     =item $overlay->show
1134    
1135     If hidden, display the overlay again.
1136    
1137     =back
1138    
1139 root 1.45 =item $popup = $term->popup ($event)
1140    
1141     Creates a new C<urxvt::popup> object that implements a popup menu. The
1142     C<$event> I<must> be the event causing the menu to pop up (a button event,
1143     currently).
1144    
1145     =cut
1146    
1147 root 1.55 sub popup {
1148 root 1.45 my ($self, $event) = @_;
1149    
1150     $self->grab ($event->{time}, 1)
1151     or return;
1152    
1153     my $popup = bless {
1154     term => $self,
1155     event => $event,
1156     }, urxvt::popup::;
1157    
1158     Scalar::Util::weaken $popup->{term};
1159    
1160     $self->{_destroy}{$popup} = urxvt::destroy_hook { $popup->{popup}->destroy };
1161     Scalar::Util::weaken $self->{_destroy}{$popup};
1162    
1163     $popup
1164     }
1165    
1166 root 1.40 =item $cellwidth = $term->strwidth ($string)
1167 root 1.6
1168     Returns the number of screen-cells this string would need. Correctly
1169     accounts for wide and combining characters.
1170    
1171 root 1.40 =item $octets = $term->locale_encode ($string)
1172 root 1.6
1173     Convert the given text string into the corresponding locale encoding.
1174    
1175 root 1.40 =item $string = $term->locale_decode ($octets)
1176 root 1.6
1177     Convert the given locale-encoded octets into a perl string.
1178    
1179 root 1.70 =item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1180    
1181     XORs the rendition values in the given span with the provided value
1182 root 1.86 (default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1183     refresh hooks to provide effects similar to the selection.
1184 root 1.70
1185     =item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1186    
1187     Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1188     whitespace will additionally be xored with the C<$rstyle2>, which defaults
1189     to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1190 root 1.86 it instead. Both styles I<MUST NOT> contain font styles.
1191 root 1.70
1192 root 1.69 =item $term->scr_bell
1193    
1194     Ring the bell!
1195    
1196 root 1.33 =item $term->scr_add_lines ($string)
1197    
1198     Write the given text string to the screen, as if output by the application
1199     running inside the terminal. It may not contain command sequences (escape
1200     codes), but is free to use line feeds, carriage returns and tabs. The
1201     string is a normal text string, not in locale-dependent encoding.
1202    
1203     Normally its not a good idea to use this function, as programs might be
1204     confused by changes in cursor position or scrolling. Its useful inside a
1205     C<on_add_lines> hook, though.
1206    
1207 root 1.36 =item $term->cmd_parse ($octets)
1208    
1209     Similar to C<scr_add_lines>, but the argument must be in the
1210     locale-specific encoding of the terminal and can contain command sequences
1211     (escape codes) that will be interpreted.
1212    
1213 root 1.6 =item $term->tt_write ($octets)
1214    
1215     Write the octets given in C<$data> to the tty (i.e. as program input). To
1216 root 1.12 pass characters instead of octets, you should convert your strings first
1217     to the locale-specific encoding using C<< $term->locale_encode >>.
1218    
1219 root 1.69 =item $old_events = $term->pty_ev_events ([$new_events])
1220    
1221     Replaces the event mask of the pty watcher by the given event mask. Can
1222     be used to suppress input and output handling to the pty/tty. See the
1223     description of C<< urxvt::timer->events >>. Make sure to always restore
1224     the previous value.
1225    
1226 root 1.40 =item $windowid = $term->parent
1227    
1228     Return the window id of the toplevel window.
1229    
1230     =item $windowid = $term->vt
1231    
1232     Return the window id of the terminal window.
1233    
1234 root 1.92 =item $term->vt_emask_add ($x_event_mask)
1235    
1236     Adds the specified events to the vt event mask. Useful e.g. when you want
1237     to receive pointer events all the times:
1238    
1239     $term->vt_emask_add (urxvt::PointerMotionMask);
1240    
1241 root 1.32 =item $window_width = $term->width
1242    
1243     =item $window_height = $term->height
1244    
1245     =item $font_width = $term->fwidth
1246    
1247     =item $font_height = $term->fheight
1248    
1249     =item $font_ascent = $term->fbase
1250    
1251     =item $terminal_rows = $term->nrow
1252    
1253     =item $terminal_columns = $term->ncol
1254    
1255     =item $has_focus = $term->focus
1256    
1257     =item $is_mapped = $term->mapped
1258 root 1.13
1259 root 1.32 =item $max_scrollback = $term->saveLines
1260 root 1.13
1261 root 1.32 =item $nrow_plus_saveLines = $term->total_rows
1262 root 1.13
1263 root 1.94 =item $topmost_scrollback_row = $term->top_row
1264 root 1.12
1265 root 1.32 Return various integers describing terminal characteristics.
1266 root 1.12
1267 root 1.77 =item $x_display = $term->display_id
1268    
1269     Return the DISPLAY used by rxvt-unicode.
1270    
1271 root 1.66 =item $lc_ctype = $term->locale
1272    
1273     Returns the LC_CTYPE category string used by this rxvt-unicode.
1274    
1275 root 1.77 =item $env = $term->env
1276    
1277     Returns a copy of the environment in effect for the terminal as a hashref
1278     similar to C<\%ENV>.
1279    
1280     =cut
1281 root 1.66
1282 root 1.77 sub env {
1283     if (my $env = $_[0]->_env) {
1284     +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
1285     } else {
1286     +{ %ENV }
1287     }
1288     }
1289 root 1.66
1290 root 1.47 =item $modifiermask = $term->ModLevel3Mask
1291    
1292     =item $modifiermask = $term->ModMetaMask
1293    
1294     =item $modifiermask = $term->ModNumLockMask
1295    
1296     Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1297     AltGr), the meta key (often Alt) and the num lock key, if applicable.
1298    
1299 root 1.12 =item $view_start = $term->view_start ([$newvalue])
1300    
1301 root 1.94 Returns the row number of the topmost displayed line. Maximum value is
1302     C<0>, which displays the normal terminal contents. Lower values scroll
1303 root 1.12 this many lines into the scrollback buffer.
1304    
1305 root 1.14 =item $term->want_refresh
1306    
1307     Requests a screen refresh. At the next opportunity, rxvt-unicode will
1308     compare the on-screen display with its stored representation. If they
1309     differ, it redraws the differences.
1310    
1311     Used after changing terminal contents to display them.
1312    
1313 root 1.13 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1314 root 1.12
1315     Returns the text of the entire row with number C<$row_number>. Row C<0>
1316     is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost
1317     terminal line. The scrollback buffer starts at line C<-1> and extends to
1318 root 1.24 line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line
1319     is requested.
1320 root 1.12
1321 root 1.13 If C<$new_text> is specified, it will replace characters in the current
1322     line, starting at column C<$start_col> (default C<0>), which is useful
1323 root 1.18 to replace only parts of a line. The font index in the rendition will
1324 root 1.13 automatically be updated.
1325 root 1.12
1326     C<$text> is in a special encoding: tabs and wide characters that use more
1327     than one cell when displayed are padded with urxvt::NOCHAR characters
1328     (C<chr 65535>). Characters with combining characters and other characters
1329     that do not fit into the normal tetx encoding will be replaced with
1330     characters in the private use area.
1331    
1332     You have to obey this encoding when changing text. The advantage is
1333     that C<substr> and similar functions work on screen cells and not on
1334     characters.
1335    
1336     The methods C<< $term->special_encode >> and C<< $term->special_decode >>
1337     can be used to convert normal strings into this encoding and vice versa.
1338    
1339 root 1.13 =item $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
1340    
1341     Like C<< $term->ROW_t >>, but returns an arrayref with rendition
1342     bitsets. Rendition bitsets contain information about colour, font, font
1343     styles and similar information. See also C<< $term->ROW_t >>.
1344    
1345     When setting rendition, the font mask will be ignored.
1346 root 1.12
1347 root 1.18 See the section on RENDITION, above.
1348 root 1.13
1349     =item $length = $term->ROW_l ($row_number[, $new_length])
1350    
1351 root 1.24 Returns the number of screen cells that are in use ("the line
1352     length"). Unlike the urxvt core, this returns C<< $term->ncol >> if the
1353     line is joined with the following one.
1354    
1355     =item $bool = $term->is_longer ($row_number)
1356    
1357     Returns true if the row is part of a multiple-row logical "line" (i.e.
1358     joined with the following row), which means all characters are in use
1359     and it is continued on the next row (and possibly a continuation of the
1360     previous row(s)).
1361    
1362     =item $line = $term->line ($row_number)
1363    
1364     Create and return a new C<urxvt::line> object that stores information
1365     about the logical line that row C<$row_number> is part of. It supports the
1366     following methods:
1367 root 1.12
1368 root 1.24 =over 4
1369    
1370 root 1.35 =item $text = $line->t ([$new_text])
1371 root 1.24
1372 root 1.35 Returns or replaces the full text of the line, similar to C<ROW_t>
1373 root 1.24
1374 root 1.35 =item $rend = $line->r ([$new_rend])
1375 root 1.24
1376 root 1.35 Returns or replaces the full rendition array of the line, similar to C<ROW_r>
1377 root 1.24
1378     =item $length = $line->l
1379    
1380     Returns the length of the line in cells, similar to C<ROW_l>.
1381    
1382     =item $rownum = $line->beg
1383    
1384     =item $rownum = $line->end
1385    
1386     Return the row number of the first/last row of the line, respectively.
1387    
1388     =item $offset = $line->offset_of ($row, $col)
1389    
1390     Returns the character offset of the given row|col pair within the logical
1391 root 1.85 line. Works for rows outside the line, too, and returns corresponding
1392     offsets outside the string.
1393 root 1.24
1394     =item ($row, $col) = $line->coord_of ($offset)
1395    
1396     Translates a string offset into terminal coordinates again.
1397    
1398     =back
1399    
1400     =cut
1401    
1402 root 1.55 sub line {
1403 root 1.24 my ($self, $row) = @_;
1404    
1405     my $maxrow = $self->nrow - 1;
1406    
1407     my ($beg, $end) = ($row, $row);
1408    
1409     --$beg while $self->ROW_is_longer ($beg - 1);
1410     ++$end while $self->ROW_is_longer ($end) && $end < $maxrow;
1411    
1412     bless {
1413     term => $self,
1414     beg => $beg,
1415     end => $end,
1416 root 1.34 ncol => $self->ncol,
1417 root 1.24 len => ($end - $beg) * $self->ncol + $self->ROW_l ($end),
1418     }, urxvt::line::
1419     }
1420    
1421     sub urxvt::line::t {
1422     my ($self) = @_;
1423    
1424 root 1.34 if (@_ > 1)
1425     {
1426     $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1427     for $self->{beg} .. $self->{end};
1428     }
1429    
1430     defined wantarray &&
1431     substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1432     0, $self->{len}
1433 root 1.24 }
1434    
1435     sub urxvt::line::r {
1436     my ($self) = @_;
1437    
1438 root 1.34 if (@_ > 1)
1439     {
1440     $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1441     for $self->{beg} .. $self->{end};
1442     }
1443    
1444     if (defined wantarray) {
1445     my $rend = [
1446     map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1447     ];
1448     $#$rend = $self->{len} - 1;
1449     return $rend;
1450     }
1451    
1452     ()
1453 root 1.24 }
1454    
1455     sub urxvt::line::beg { $_[0]{beg} }
1456     sub urxvt::line::end { $_[0]{end} }
1457     sub urxvt::line::l { $_[0]{len} }
1458    
1459     sub urxvt::line::offset_of {
1460     my ($self, $row, $col) = @_;
1461    
1462 root 1.34 ($row - $self->{beg}) * $self->{ncol} + $col
1463 root 1.24 }
1464    
1465     sub urxvt::line::coord_of {
1466     my ($self, $offset) = @_;
1467    
1468     use integer;
1469    
1470     (
1471 root 1.34 $offset / $self->{ncol} + $self->{beg},
1472     $offset % $self->{ncol}
1473 root 1.24 )
1474     }
1475    
1476 root 1.12 =item $text = $term->special_encode $string
1477    
1478     Converts a perl string into the special encoding used by rxvt-unicode,
1479     where one character corresponds to one screen cell. See
1480     C<< $term->ROW_t >> for details.
1481    
1482     =item $string = $term->special_decode $text
1483    
1484     Converts rxvt-unicodes text reprsentation into a perl string. See
1485     C<< $term->ROW_t >> for details.
1486 root 1.6
1487 root 1.61 =item $success = $term->grab_button ($button, $modifiermask)
1488    
1489 root 1.64 Registers a synchronous button grab. See the XGrabButton manpage.
1490 root 1.61
1491     =item $success = $term->grab ($eventtime[, $sync])
1492    
1493     Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1494     synchronous (C<$sync> is true). Also remembers the grab timestampe.
1495    
1496     =item $term->allow_events_async
1497    
1498     Calls XAllowEvents with AsyncBoth for the most recent grab.
1499    
1500     =item $term->allow_events_sync
1501    
1502     Calls XAllowEvents with SyncBoth for the most recent grab.
1503    
1504     =item $term->allow_events_replay
1505    
1506     Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1507     recent grab.
1508    
1509     =item $term->ungrab
1510    
1511     Calls XUngrab for the most recent grab. Is called automatically on
1512     evaluation errors, as it is better to lose the grab in the error case as
1513     the session.
1514    
1515 root 1.1 =back
1516    
1517 root 1.55 =cut
1518    
1519     package urxvt::popup;
1520    
1521 root 1.45 =head2 The C<urxvt::popup> Class
1522    
1523     =over 4
1524    
1525     =cut
1526    
1527     sub add_item {
1528     my ($self, $item) = @_;
1529    
1530 root 1.53 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1531     $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1532     $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1533    
1534     $item->{render} ||= sub { $_[0]{text} };
1535    
1536 root 1.45 push @{ $self->{item} }, $item;
1537     }
1538    
1539 root 1.76 =item $popup->add_title ($title)
1540    
1541     Adds a non-clickable title to the popup.
1542    
1543     =cut
1544    
1545     sub add_title {
1546     my ($self, $title) = @_;
1547    
1548     $self->add_item ({
1549     rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1550     text => $title,
1551     activate => sub { },
1552     });
1553     }
1554    
1555     =item $popup->add_separator ([$sepchr])
1556    
1557     Creates a separator, optionally using the character given as C<$sepchr>.
1558    
1559     =cut
1560    
1561 root 1.53 sub add_separator {
1562     my ($self, $sep) = @_;
1563    
1564 root 1.67 $sep ||= "=";
1565 root 1.53
1566     $self->add_item ({
1567     rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1568     text => "",
1569 root 1.65 render => sub { $sep x $self->{term}->ncol },
1570 root 1.53 activate => sub { },
1571     });
1572     }
1573    
1574 root 1.76 =item $popup->add_button ($text, $cb)
1575    
1576     Adds a clickable button to the popup. C<$cb> is called whenever it is
1577     selected.
1578 root 1.53
1579 root 1.76 =cut
1580 root 1.53
1581 root 1.45 sub add_button {
1582     my ($self, $text, $cb) = @_;
1583    
1584 root 1.64 $self->add_item ({ type => "button", text => $text, activate => $cb});
1585 root 1.48 }
1586    
1587 root 1.76 =item $popup->add_toggle ($text, $cb, $initial_value)
1588    
1589     Adds a toggle/checkbox item to the popup. Teh callback gets called
1590     whenever it gets toggled, with a boolean indicating its value as its first
1591     argument.
1592    
1593     =cut
1594    
1595 root 1.48 sub add_toggle {
1596     my ($self, $text, $cb, $value) = @_;
1597    
1598 root 1.49 my $item; $item = {
1599     type => "button",
1600     text => " $text",
1601     value => $value,
1602 root 1.58 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1603 root 1.76 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1604 root 1.49 };
1605    
1606     $self->add_item ($item);
1607 root 1.45 }
1608    
1609 root 1.76 =item $popup->show
1610    
1611     Displays the popup (which is initially hidden).
1612    
1613     =cut
1614    
1615 root 1.45 sub show {
1616     my ($self) = @_;
1617    
1618     local $urxvt::popup::self = $self;
1619    
1620 root 1.77 my $env = $self->{term}->env;
1621     # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1622     delete $env->{LC_ALL};
1623     $env->{LC_CTYPE} = $self->{term}->locale;
1624    
1625 root 1.103 urxvt::term->new ($env, "popup",
1626 root 1.105 "--perl-lib" => "", "--perl-ext-common" => "",
1627 root 1.106 "-pty-fd" => -1, "-sl" => 0,
1628     "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1629 root 1.77 "--transient-for" => $self->{term}->parent,
1630     "-display" => $self->{term}->display_id,
1631     "-pe" => "urxvt-popup")
1632 root 1.45 or die "unable to create popup window\n";
1633     }
1634    
1635     sub DESTROY {
1636     my ($self) = @_;
1637    
1638 root 1.58 delete $self->{term}{_destroy}{$self};
1639 root 1.45 $self->{term}->ungrab;
1640     }
1641    
1642 root 1.78 =back
1643    
1644 root 1.1 =head2 The C<urxvt::timer> Class
1645    
1646     This class implements timer watchers/events. Time is represented as a
1647     fractional number of seconds since the epoch. Example:
1648    
1649 root 1.20 $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
1650 root 1.1 $term->{timer} = urxvt::timer
1651     ->new
1652 root 1.20 ->interval (1)
1653 root 1.1 ->cb (sub {
1654 root 1.20 $term->{overlay}->set (0, 0,
1655     sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1656     });
1657 root 1.1
1658     =over 4
1659    
1660     =item $timer = new urxvt::timer
1661    
1662 root 1.20 Create a new timer object in started state. It is scheduled to fire
1663     immediately.
1664 root 1.1
1665     =item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1666    
1667     Set the callback to be called when the timer triggers.
1668    
1669     =item $tstamp = $timer->at
1670    
1671     Return the time this watcher will fire next.
1672    
1673     =item $timer = $timer->set ($tstamp)
1674    
1675     Set the time the event is generated to $tstamp.
1676    
1677 root 1.20 =item $timer = $timer->interval ($interval)
1678    
1679     Normally (and when C<$interval> is C<0>), the timer will automatically
1680     stop after it has fired once. If C<$interval> is non-zero, then the timer
1681     is automatically rescheduled at the given intervals.
1682    
1683 root 1.1 =item $timer = $timer->start
1684    
1685     Start the timer.
1686    
1687     =item $timer = $timer->start ($tstamp)
1688    
1689     Set the event trigger time to C<$tstamp> and start the timer.
1690    
1691 root 1.103 =item $timer = $timer->after ($delay)
1692    
1693     Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1694    
1695 root 1.1 =item $timer = $timer->stop
1696    
1697     Stop the timer.
1698    
1699     =back
1700    
1701     =head2 The C<urxvt::iow> Class
1702    
1703     This class implements io watchers/events. Example:
1704    
1705     $term->{socket} = ...
1706     $term->{iow} = urxvt::iow
1707     ->new
1708     ->fd (fileno $term->{socket})
1709 root 1.69 ->events (urxvt::EVENT_READ)
1710 root 1.1 ->start
1711     ->cb (sub {
1712     my ($iow, $revents) = @_;
1713     # $revents must be 1 here, no need to check
1714     sysread $term->{socket}, my $buf, 8192
1715     or end-of-file;
1716     });
1717    
1718    
1719     =over 4
1720    
1721     =item $iow = new urxvt::iow
1722    
1723     Create a new io watcher object in stopped state.
1724    
1725     =item $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
1726    
1727     Set the callback to be called when io events are triggered. C<$reventmask>
1728     is a bitset as described in the C<events> method.
1729    
1730     =item $iow = $iow->fd ($fd)
1731    
1732     Set the filedescriptor (not handle) to watch.
1733    
1734     =item $iow = $iow->events ($eventmask)
1735    
1736 root 1.69 Set the event mask to watch. The only allowed values are
1737     C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1738     together, or C<urxvt::EVENT_NONE>.
1739 root 1.1
1740     =item $iow = $iow->start
1741    
1742     Start watching for requested events on the given handle.
1743    
1744     =item $iow = $iow->stop
1745    
1746     Stop watching for events on the given filehandle.
1747    
1748     =back
1749    
1750 root 1.4 =head1 ENVIRONMENT
1751    
1752     =head2 URXVT_PERL_VERBOSITY
1753    
1754     This variable controls the verbosity level of the perl extension. Higher
1755     numbers indicate more verbose output.
1756    
1757     =over 4
1758    
1759 root 1.58 =item == 0 - fatal messages
1760 root 1.4
1761 root 1.58 =item >= 3 - script loading and management
1762 root 1.4
1763 root 1.85 =item >=10 - all called hooks
1764    
1765     =item >=11 - hook reutrn values
1766 root 1.4
1767     =back
1768    
1769 root 1.1 =head1 AUTHOR
1770    
1771     Marc Lehmann <pcg@goof.com>
1772     http://software.schmorp.de/pkg/rxvt-unicode
1773    
1774     =cut
1775    
1776     1