ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.32 by root, Wed Jan 4 21:37:55 2006 UTC vs.
Revision 1.127 by root, Wed Jan 25 00:42:21 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines