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.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.228 by sf-exg, Tue Oct 29 14:12:58 2013 UTC

1=encoding utf8 1=encoding utf8
2 2
3=head1 NAME 3=head1 NAME
4 4
5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5urxvtperl - rxvt-unicode's embedded perl interpreter
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 # create a file grab_test in $HOME: 9 # create a file grab_test in $HOME:
10 10
11 sub on_sel_grab { 11 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
13 () 13 ()
14 } 14 }
15 15
16 # start a @@RXVT_NAME@@ using it: 16 # start a urxvt using it:
17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 urxvt --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<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 "vars"' 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 urxvtd, 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 31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
32 33
33This section describes the extensiosn delivered with this version. You can 34=head1 PREPACKAGED EXTENSIONS
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 35
36A number of extensions are delivered with this release. You can find them
37in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38F<< man urxvt-<EXTENSIONNAME> >>.
35 39
36You can activate them like this: 40You can activate them like this:
37 41
38 @@RXVT_NAME@@ -pe <extensionname> 42 urxvt -pe <extensionname>
39 43
40=over 4 44Or by adding them to the resource for extensions loaded by default:
41 45
42=item selection (enabled by default) 46 URxvt.perl-ext-common: default,selection-autotransform
43 47
44Intelligent selection. This extension tries to be more intelligent when 48Extensions that add command line parameters or resources on their own are
45the user extends selections (double-click). Right now, it tries to select 49loaded automatically when used.
46urls and complete shell-quoted arguments, which is very convenient, too,
47if your F<ls> supports C<--quoting-style=shell>.
48 50
49It also offers the following bindable event: 51=head1 API DOCUMENTATION
50
51=over 4
52
53=item rot13
54
55Rot-13 the selection when activated. Used via keyboard trigger:
56
57 URxvt.keysym.C-M-r: perl:selection:rot13
58
59=back
60
61=item option-popup (enabled by default)
62
63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime.
65
66=item selection-popup (enabled by default)
67
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action.
70
71=item searchable-scrollback (enabled by default)
72
73Adds regex search functionality to the scrollback buffer, triggered by a
74hotkey (default: C<M-s>). When in search mode, terminal input/output is
75suspended, C</> starts an incremental regex search, C<n> searches further,
76C<p> jumps to the previous match. C<enter> leaves search mode at the
77current position and C<escape> returns to the original position.
78
79=item digital-clock
80
81Displays a digital clock using the built-in overlay.
82
83=item mark-urls
84
85Uses per-line display filtering (C<on_line_update>) to underline urls.
86
87=item block-graphics-to-ascii
88
89A not very useful example of filtering all text output to the terminal,
90by replacing all line-drawing characters (U+2500 .. U+259F) by a
91similar-looking ascii character.
92
93=item example-refresh-hooks
94
95Displays a very simple digital clock in the upper right corner of the
96window. Illustrates overwriting the refresh callbacks to create your own
97overlays or changes.
98
99=back
100 52
101=head2 General API Considerations 53=head2 General API Considerations
102 54
103All objects (such as terminals, time watchers etc.) are typical 55All objects (such as terminals, time watchers etc.) are typical
104reference-to-hash objects. The hash can be used to store anything you 56reference-to-hash objects. The hash can be used to store anything you
116 68
117=over 4 69=over 4
118 70
119=item $text 71=item $text
120 72
121Rxvt-unicodes special way of encoding text, where one "unicode" character 73Rxvt-unicode's special way of encoding text, where one "unicode" character
122always represents one screen cell. See L<row_t> for a discussion of this format. 74always represents one screen cell. See L<ROW_t> for a discussion of this format.
123 75
124=item $string 76=item $string
125 77
126A perl text string, with an emphasis on I<text>. It can store all unicode 78A perl text string, with an emphasis on I<text>. It can store all unicode
127characters and is to be distinguished with text encoded in a specific 79characters and is to be distinguished with text encoded in a specific
130=item $octets 82=item $octets
131 83
132Either binary data or - more common - a text string encoded in a 84Either binary data or - more common - a text string encoded in a
133locale-specific way. 85locale-specific way.
134 86
87=item $keysym
88
89an integer that is a valid X11 keysym code. You can convert a string
90into a keysym and viceversa by using C<XStringToKeysym> and
91C<XKeysymToString>.
92
135=back 93=back
136 94
137=head2 Extension Objects 95=head2 Extension Objects
138 96
139Very perl extension is a perl class. A separate perl object is created 97Every perl extension is a perl class. A separate perl object is created
140for each terminal and each extension and passed as the first parameter to 98for each terminal, and each terminal has its own set of extension objects,
141hooks. So extensions can use their C<$self> object without having to think 99which are passed as the first parameter to hooks. So extensions can use
142about other extensions, with the exception of methods and members that 100their C<$self> object without having to think about clashes with other
101extensions or other terminals, with the exception of methods and members
143begin with an underscore character C<_>: these are reserved for internal 102that begin with an underscore character C<_>: these are reserved for
144use. 103internal use.
145 104
146Although it isn't a C<urxvt::term> object, you can call all methods of the 105Although it isn't a C<urxvt::term> object, you can call all methods of the
147C<urxvt::term> class on this object. 106C<urxvt::term> class on this object.
148 107
149It has the following methods and data members: 108Additional methods only supported for extension objects are described in
150 109the C<urxvt::extension> section below.
151=over 4
152
153=item $urxvt_term = $self->{term}
154
155Returns the C<urxvt::term> object associated with this instance of the
156extension. This member I<must not> be changed in any way.
157
158=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
159
160Dynamically enable the given hooks (named without the C<on_> prefix) for
161this extension, replacing any previous hook. This is useful when you want
162to overwrite time-critical hooks only temporarily.
163
164=item $self->disable ($hook_name[, $hook_name..])
165
166Dynamically disable the given hooks.
167
168=back
169 110
170=head2 Hooks 111=head2 Hooks
171 112
172The following subroutines can be declared in extension files, and will be 113The following subroutines can be declared in extension files, and will be
173called whenever the relevant event happens. 114called whenever the relevant event happens.
174 115
175The first argument passed to them is an extension oject as described in 116The first argument passed to them is an extension object as described in
176the in the C<Extension Objects> section. 117the in the C<Extension Objects> section.
177 118
178B<All> of these hooks must return a boolean value. If it is true, then the 119B<All> of these hooks must return a boolean value. If any of the called
179event counts as being I<consumed>, and the invocation of other hooks is 120hooks returns true, then the event counts as being I<consumed>, and the
180skipped, and the relevant action might not be carried out by the C++ code. 121relevant action might not be carried out by the C++ code.
181 122
182I<< When in doubt, return a false value (preferably C<()>). >> 123I<< When in doubt, return a false value (preferably C<()>). >>
183 124
184=over 4 125=over 4
185 126
186=item on_init $term 127=item on_init $term
187 128
188Called after a new terminal object has been initialized, but before 129Called after a new terminal object has been initialized, but before
189windows are created or the command gets run. Most methods are unsafe to 130windows are created or the command gets run. Most methods are unsafe to
190call or deliver senseless data, as terminal size and other characteristics 131call or deliver senseless data, as terminal size and other characteristics
191have not yet been determined. You can safely query and change resources, 132have not yet been determined. You can safely query and change resources
192though. 133and options, though. For many purposes the C<on_start> hook is a better
134place.
135
136=item on_start $term
137
138Called at the very end of initialisation of a new terminal, just before
139trying to map (display) the toplevel and returning to the main loop.
140
141=item on_destroy $term
142
143Called whenever something tries to destroy terminal, when the terminal is
144still fully functional (not for long, though).
193 145
194=item on_reset $term 146=item on_reset $term
195 147
196Called after the screen is "reset" for any reason, such as resizing or 148Called after the screen is "reset" for any reason, such as resizing or
197control sequences. Here is where you can react on changes to size-related 149control sequences. Here is where you can react on changes to size-related
198variables. 150variables.
199 151
200=item on_start $term 152=item on_child_start $term, $pid
201 153
202Called at the very end of initialisation of a new terminal, just before 154Called just after the child process has been C<fork>ed.
203returning to the mainloop. 155
156=item on_child_exit $term, $status
157
158Called just after the child process has exited. C<$status> is the status
159from C<waitpid>.
204 160
205=item on_sel_make $term, $eventtime 161=item on_sel_make $term, $eventtime
206 162
207Called whenever a selection has been made by the user, but before the 163Called whenever a selection has been made by the user, but before the
208selection text is copied, so changes to the beginning, end or type of the 164selection text is copied, so changes to the beginning, end or type of the
215 171
216Called whenever a selection has been copied, but before the selection is 172Called whenever a selection has been copied, but before the selection is
217requested from the server. The selection text can be queried and changed 173requested from the server. The selection text can be queried and changed
218by calling C<< $term->selection >>. 174by calling C<< $term->selection >>.
219 175
220Returning a true value aborts selection grabbing. It will still be hilighted. 176Returning a true value aborts selection grabbing. It will still be highlighted.
221 177
222=item on_sel_extend $term 178=item on_sel_extend $term
223 179
224Called whenever the user tries to extend the selection (e.g. with a double 180Called whenever the user tries to extend the selection (e.g. with a double
225click) and is either supposed to return false (normal operation), or 181click) and is either supposed to return false (normal operation), or
226should extend the selection itelf and return true to suppress the built-in 182should extend the selection itself and return true to suppress the built-in
227processing. 183processing. This can happen multiple times, as long as the callback
184returns true, it will be called on every further click by the user and is
185supposed to enlarge the selection more and more, if possible.
228 186
229See the F<selection> example extension. 187See the F<selection> example extension.
230 188
231=item on_view_change $term, $offset 189=item on_view_change $term, $offset
232 190
233Called whenever the view offset changes, i..e the user or program 191Called whenever the view offset changes, i.e. the user or program
234scrolls. Offset C<0> means display the normal terminal, positive values 192scrolls. Offset C<0> means display the normal terminal, positive values
235show this many lines of scrollback. 193show this many lines of scrollback.
236 194
237=item on_scroll_back $term, $lines, $saved 195=item on_scroll_back $term, $lines, $saved
238 196
242 200
243It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 201It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
244$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 202$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
245number of lines that will be in the scrollback buffer. 203number of lines that will be in the scrollback buffer.
246 204
247=item on_osc_seq $term, $string 205=item on_osc_seq $term, $op, $args, $resp
206
207Called on every OSC sequence and can be used to suppress it or modify its
208behaviour. The default should be to return an empty list. A true value
209suppresses execution of the request completely. Make sure you don't get
210confused by recursive invocations when you output an OSC sequence within
211this callback.
212
213C<on_osc_seq_perl> should be used for new behaviour.
214
215=item on_osc_seq_perl $term, $args, $resp
248 216
249Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 217Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
250operating system command) is processed. Cursor position and other state 218operating system command) is processed. Cursor position and other state
251information is up-to-date when this happens. For interoperability, the 219information is up-to-date when this happens. For interoperability, the
252string should start with the extension name and a colon, to distinguish 220string should start with the extension name (sans -osc) and a semicolon,
253it from commands for other extensions, and this might be enforced in the 221to distinguish it from commands for other extensions, and this might be
254future. 222enforced in the future.
223
224For example, C<overlay-osc> uses this:
225
226 sub on_osc_seq_perl {
227 my ($self, $osc, $resp) = @_;
228
229 return unless $osc =~ s/^overlay;//;
230
231 ... process remaining $osc string
232 }
255 233
256Be careful not ever to trust (in a security sense) the data you receive, 234Be careful not ever to trust (in a security sense) the data you receive,
257as its source can not easily be controleld (e-mail content, messages from 235as its source can not easily be controlled (e-mail content, messages from
258other users on the same system etc.). 236other users on the same system etc.).
237
238For responses, C<$resp> contains the end-of-args separator used by the
239sender.
259 240
260=item on_add_lines $term, $string 241=item on_add_lines $term, $string
261 242
262Called whenever text is about to be output, with the text as argument. You 243Called whenever text is about to be output, with the text as argument. You
263can filter/change and output the text yourself by returning a true value 244can filter/change and output the text yourself by returning a true value
268=item on_tt_write $term, $octets 249=item on_tt_write $term, $octets
269 250
270Called whenever some data is written to the tty/pty and can be used to 251Called whenever some data is written to the tty/pty and can be used to
271suppress or filter tty input. 252suppress or filter tty input.
272 253
254=item on_tt_paste $term, $octets
255
256Called whenever text is about to be pasted, with the text as argument. You
257can filter/change and paste the text yourself by returning a true value
258and calling C<< $term->tt_paste >> yourself. C<$octets> is
259locale-encoded.
260
273=item on_line_update $term, $row 261=item on_line_update $term, $row
274 262
275Called whenever a line was updated or changed. Can be used to filter 263Called whenever a line was updated or changed. Can be used to filter
276screen output (e.g. underline urls or other useless stuff). Only lines 264screen output (e.g. underline urls or other useless stuff). Only lines
277that are being shown will be filtered, and, due to performance reasons, 265that are being shown will be filtered, and, due to performance reasons,
284later with the already-modified line (e.g. if unrelated parts change), so 272later with the already-modified line (e.g. if unrelated parts change), so
285you cannot just toggle rendition bits, but only set them. 273you cannot just toggle rendition bits, but only set them.
286 274
287=item on_refresh_begin $term 275=item on_refresh_begin $term
288 276
289Called just before the screen gets redrawn. Can be used for overlay 277Called just before the screen gets redrawn. Can be used for overlay or
290or similar effects by modify terminal contents in refresh_begin, and 278similar effects by modifying the terminal contents in refresh_begin, and
291restoring them in refresh_end. The built-in overlay and selection display 279restoring them in refresh_end. The built-in overlay and selection display
292code is run after this hook, and takes precedence. 280code is run after this hook, and takes precedence.
293 281
294=item on_refresh_end $term 282=item on_refresh_end $term
295 283
296Called just after the screen gets redrawn. See C<on_refresh_begin>. 284Called just after the screen gets redrawn. See C<on_refresh_begin>.
297 285
298=item on_keyboard_command $term, $string 286=item on_user_command $term, $string
299 287
300Called whenever the user presses a key combination that has a 288Called whenever a user-configured event is being activated (e.g. via
301C<perl:string> action bound to it (see description of the B<keysym> 289a C<perl:string> action bound to a key, see description of the B<keysym>
302resource in the @@RXVT_NAME@@(1) manpage). 290resource in the urxvt(1) manpage).
291
292The event is simply the action string. This interface is assumed to change
293slightly in the future.
294
295=item on_register_command $term, $keysym, $modifiermask, $string
296
297Called after parsing a keysym resource but before registering the
298associated binding. If this hook returns TRUE the binding is not
299registered. It can be used to modify a binding by calling
300C<register_command>.
301
302=item on_resize_all_windows $term, $new_width, $new_height
303
304Called just after the new window size has been calculated, but before
305windows are actually being resized or hints are being set. If this hook
306returns TRUE, setting of the window hints is being skipped.
307
308=item on_x_event $term, $event
309
310Called on every X event received on the vt window (and possibly other
311windows). Should only be used as a last resort. Most event structure
312members are not passed.
313
314=item on_root_event $term, $event
315
316Like C<on_x_event>, but is called for events on the root window.
303 317
304=item on_focus_in $term 318=item on_focus_in $term
305 319
306Called whenever the window gets the keyboard focus, before rxvt-unicode 320Called whenever the window gets the keyboard focus, before rxvt-unicode
307does focus in processing. 321does focus in processing.
308 322
309=item on_focus_out $term 323=item on_focus_out $term
310 324
311Called wheneever the window loses keyboard focus, before rxvt-unicode does 325Called whenever the window loses keyboard focus, before rxvt-unicode does
312focus out processing. 326focus out processing.
313 327
328=item on_configure_notify $term, $event
329
330=item on_property_notify $term, $event
331
314=item on_key_press $term, $event, $keysym, $octets 332=item on_key_press $term, $event, $keysym, $octets
315 333
316=item on_key_release $term, $event, $keysym 334=item on_key_release $term, $event, $keysym
317 335
318=item on_button_press $term, $event 336=item on_button_press $term, $event
323 341
324=item on_map_notify $term, $event 342=item on_map_notify $term, $event
325 343
326=item on_unmap_notify $term, $event 344=item on_unmap_notify $term, $event
327 345
328Called whenever the corresponding X event is received for the terminal If 346Called whenever the corresponding X event is received for the terminal. If
329the hook returns true, then the even will be ignored by rxvt-unicode. 347the hook returns true, then the event will be ignored by rxvt-unicode.
330 348
331The event is a hash with most values as named by Xlib (see the XEvent 349The event is a hash with most values as named by Xlib (see the XEvent
332manpage), with the additional members C<row> and C<col>, which are the row 350manpage), with the additional members C<row> and C<col>, which are the
333and column under the mouse cursor. 351(real, not screen-based) row and column under the mouse cursor.
334 352
335C<on_key_press> additionally receives the string rxvt-unicode would 353C<on_key_press> additionally receives the string rxvt-unicode would
336output, if any, in locale-specific encoding. 354output, if any, in locale-specific encoding.
337 355
338subwindow. 356subwindow.
339 357
358=item on_client_message $term, $event
359
360=item on_wm_protocols $term, $event
361
362=item on_wm_delete_window $term, $event
363
364Called when various types of ClientMessage events are received (all with
365format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
366
367=item on_bell $term
368
369Called on receipt of a bell character.
370
340=back 371=back
341 372
373=cut
374
375package urxvt;
376
377use utf8;
378use strict 'vars';
379use Carp ();
380use Scalar::Util ();
381use List::Util ();
382
383our $VERSION = 1;
384our $TERM;
385our @TERM_INIT; # should go, prevents async I/O etc.
386our @TERM_EXT; # should go, prevents async I/O etc.
387our @HOOKNAME;
388our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
389our %OPTION;
390
391our $LIBDIR;
392our $RESNAME;
393our $RESCLASS;
394our $RXVTNAME;
395
396our $NOCHAR = chr 0xffff;
397
342=head2 Variables in the C<urxvt> Package 398=head2 Variables in the C<urxvt> Package
343 399
344=over 4 400=over 4
401
402=item $urxvt::LIBDIR
403
404The rxvt-unicode library directory, where, among other things, the perl
405modules and scripts are stored.
406
407=item $urxvt::RESCLASS, $urxvt::RESCLASS
408
409The resource class and name rxvt-unicode uses to look up X resources.
410
411=item $urxvt::RXVTNAME
412
413The basename of the installed binaries, usually C<urxvt>.
345 414
346=item $urxvt::TERM 415=item $urxvt::TERM
347 416
348The current terminal. This variable stores the current C<urxvt::term> 417The current terminal. This variable stores the current C<urxvt::term>
349object, whenever a callback/hook is executing. 418object, whenever a callback/hook is executing.
350 419
420=item @urxvt::TERM_INIT
421
422All code references in this array will be called as methods of the next newly
423created C<urxvt::term> object (during the C<on_init> phase). The array
424gets cleared before the code references that were in it are being executed,
425so references can push themselves onto it again if they so desire.
426
427This complements to the perl-eval command line option, but gets executed
428first.
429
430=item @urxvt::TERM_EXT
431
432Works similar to C<@TERM_INIT>, but contains perl package/class names, which
433get registered as normal extensions after calling the hooks in C<@TERM_INIT>
434but before other extensions. Gets cleared just like C<@TERM_INIT>.
435
351=back 436=back
352 437
353=head2 Functions in the C<urxvt> Package 438=head2 Functions in the C<urxvt> Package
354 439
355=over 4 440=over 4
356 441
357=item $term = new urxvt [arg...]
358
359Creates a new terminal, very similar as if you had started it with
360C<system $binfile, arg...>. Croaks (and probably outputs an error message)
361if the new instance couldn't be created. Returns C<undef> if the new
362instance didn't initialise perl, and the terminal object otherwise. The
363C<init> and C<start> hooks will be called during the call.
364
365=item urxvt::fatal $errormessage 442=item urxvt::fatal $errormessage
366 443
367Fatally aborts execution with the given error message. Avoid at all 444Fatally aborts execution with the given error message (which should
368costs! The only time this is acceptable is when the terminal process 445include a trailing newline). Avoid at all costs! The only time this
369starts up. 446is acceptable (and useful) is in the init hook, where it prevents the
447terminal from starting up.
370 448
371=item urxvt::warn $string 449=item urxvt::warn $string
372 450
373Calls C<rxvt_warn> with the given string which should not include a 451Calls C<rxvt_warn> with the given string which should include a trailing
374newline. The module also overwrites the C<warn> builtin with a function 452newline. The module also overwrites the C<warn> builtin with a function
375that calls this function. 453that calls this function.
376 454
377Using this function has the advantage that its output ends up in the 455Using this function has the advantage that its output ends up in the
378correct place, e.g. on stderr of the connecting urxvtc client. 456correct place, e.g. on stderr of the connecting urxvtc client.
379 457
380=item $is_safe = urxvt::safe 458Messages have a size limit of 1023 bytes currently.
381 459
382Returns true when it is safe to do potentially unsafe things, such as 460=item @terms = urxvt::termlist
383evaluating perl code specified by the user. This is true when urxvt was 461
384started setuid or setgid. 462Returns all urxvt::term objects that exist in this process, regardless of
463whether they are started, being destroyed etc., so be careful. Only term
464objects that have perl extensions attached will be returned (because there
465is no urxvt::term object associated with others).
385 466
386=item $time = urxvt::NOW 467=item $time = urxvt::NOW
387 468
388Returns the "current time" (as per the event loop). 469Returns the "current time" (as per the event loop).
389 470
390=item urxvt::CurrentTime 471=item urxvt::CurrentTime
391 472
392=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 473=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
393Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 474Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
394Button4Mask, Button5Mask, AnyModifier 475Button4Mask, Button5Mask, AnyModifier
476
477=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
478ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
479PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
480Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
481KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
482ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
483FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
484
485=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
486EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
487GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
488UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
489ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
490CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
491SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
395 492
396Various constants for use in X calls and event processing. 493Various constants for use in X calls and event processing.
397 494
398=back 495=back
399 496
416 513
417=item $rend = urxvt::OVERLAY_RSTYLE 514=item $rend = urxvt::OVERLAY_RSTYLE
418 515
419Return the rendition mask used for overlays by default. 516Return the rendition mask used for overlays by default.
420 517
421=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 518=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
519urxvt::RS_RVid, urxvt::RS_Uline
422 520
423Return the bit that enabled bold, italic, blink, reverse-video and 521Return the bit that enabled bold, italic, blink, reverse-video and
424underline, respectively. To enable such a style, just logically OR it into 522underline, respectively. To enable such a style, just logically OR it into
425the bitset. 523the bitset.
426 524
428 526
429=item $background = urxvt::GET_BASEBG $rend 527=item $background = urxvt::GET_BASEBG $rend
430 528
431Return the foreground/background colour index, respectively. 529Return the foreground/background colour index, respectively.
432 530
433=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 531=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
434 532
435=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 533=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
534
535=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
436 536
437Replace the foreground/background colour in the rendition mask with the 537Replace the foreground/background colour in the rendition mask with the
438specified one. 538specified one.
439 539
440=item $value = urxvt::GET_CUSTOM ($rend) 540=item $value = urxvt::GET_CUSTOM $rend
441 541
442Return the "custom" value: Every rendition has 5 bits for use by 542Return the "custom" value: Every rendition has 5 bits for use by
443extensions. They can be set and changed as you like and are initially 543extensions. They can be set and changed as you like and are initially
444zero. 544zero.
445 545
446=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 546=item $rend = urxvt::SET_CUSTOM $rend, $new_value
447 547
448Change the custom value. 548Change the custom value.
449 549
450=back 550=back
451 551
452=cut 552=cut
453 553
454package urxvt;
455
456use utf8;
457use strict;
458use Carp ();
459use Scalar::Util ();
460use List::Util ();
461
462our $VERSION = 1;
463our $TERM;
464our @HOOKNAME;
465our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
466our %OPTION;
467our $LIBDIR;
468
469BEGIN { 554BEGIN {
470 urxvt->bootstrap;
471
472 # overwrite perl's warn 555 # overwrite perl's warn
473 *CORE::GLOBAL::warn = sub { 556 *CORE::GLOBAL::warn = sub {
474 my $msg = join "", @_; 557 my $msg = join "", @_;
475 $msg .= "\n" 558 $msg .= "\n"
476 unless $msg =~ /\n$/; 559 unless $msg =~ /\n$/;
477 urxvt::warn ($msg); 560 urxvt::warn ($msg);
478 }; 561 };
479
480 delete $ENV{IFS};
481 delete $ENV{CDPATH};
482 delete $ENV{BASH_ENV};
483 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
484} 562}
485 563
486my @hook_count; 564no warnings 'utf8';
565
566sub parse_resource {
567 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568
569 $name =~ y/-/./ if $isarg;
570
571 $term->scan_meta;
572
573 my $r = $term->{meta}{resource};
574 keys %$r; # reset iterator
575 while (my ($pattern, $v) = each %$r) {
576 if (
577 $pattern =~ /\.$/
578 ? $pattern eq substr $name, 0, length $pattern
579 : $pattern eq $name
580 ) {
581 $name = "$urxvt::RESCLASS.$name";
582
583 push @{ $term->{perl_ext_3} }, $v->[0];
584
585 if ($v->[1] eq "boolean") {
586 $term->put_option_db ($name, $flag ? "true" : "false");
587 return 1;
588 } else {
589 $term->put_option_db ($name, $value);
590 return 1 + 2;
591 }
592 }
593 }
594
595 0
596}
597
598sub usage {
599 my ($term, $usage_type) = @_;
600
601 $term->scan_meta;
602
603 my $r = $term->{meta}{resource};
604
605 for my $pattern (sort keys %$r) {
606 my ($ext, $type, $desc) = @{ $r->{$pattern} };
607
608 $desc .= " (-pe $ext)";
609
610 if ($usage_type == 1) {
611 $pattern =~ y/./-/;
612 $pattern =~ s/-$/-.../g;
613
614 if ($type eq "boolean") {
615 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
616 } else {
617 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
618 }
619 } else {
620 $pattern =~ s/\.$/.*/g;
621 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
622 }
623 }
624}
625
487my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 626my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
488 627
489sub verbose { 628sub verbose {
490 my ($level, $msg) = @_; 629 my ($level, $msg) = @_;
491 warn "$msg\n" if $level <= $verbosity; 630 warn "$msg\n" if $level <= $verbosity;
492} 631}
493 632
494my $extension_pkg = "extension0000";
495my %extension_pkg; 633my %extension_pkg;
496 634
497# load a single script into its own package, once only 635# load a single script into its own package, once only
498sub extension_package($) { 636sub extension_package($) {
499 my ($path) = @_; 637 my ($path) = @_;
500 638
501 $extension_pkg{$path} ||= do { 639 $extension_pkg{$path} ||= do {
502 my $pkg = "urxvt::" . ($extension_pkg++); 640 $path =~ /([^\/\\]+)$/;
641 my $pkg = $1;
642 $pkg =~ s/[^[:word:]]/_/g;
643 $pkg = "urxvt::ext::$pkg";
503 644
504 verbose 3, "loading extension '$path' into package '$pkg'"; 645 verbose 3, "loading extension '$path' into package '$pkg'";
646
647 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
505 648
506 open my $fh, "<:raw", $path 649 open my $fh, "<:raw", $path
507 or die "$path: $!"; 650 or die "$path: $!";
508 651
509 my $source = untaint 652 my $source =
510 "package $pkg; use strict; use utf8;\n" 653 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
511 . "use base urxvt::term::extension::;\n"
512 . "#line 1 \"$path\"\n{\n" 654 . "#line 1 \"$path\"\n{\n"
513 . (do { local $/; <$fh> }) 655 . (do { local $/; <$fh> })
514 . "\n};\n1"; 656 . "\n};\n1";
515 657
516 eval $source 658 eval $source
526sub invoke { 668sub invoke {
527 local $TERM = shift; 669 local $TERM = shift;
528 my $htype = shift; 670 my $htype = shift;
529 671
530 if ($htype == 0) { # INIT 672 if ($htype == 0) { # INIT
531 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 673 my @dirs = $TERM->perl_libdirs;
532 674
533 my %ext_arg; 675 my %ext_arg;
534 676
677 {
678 my @init = @TERM_INIT;
679 @TERM_INIT = ();
680 $_->($TERM) for @init;
681 my @pkg = @TERM_EXT;
682 @TERM_EXT = ();
683 $TERM->register_package ($_) for @pkg;
684 }
685
686 for (
687 @{ delete $TERM->{perl_ext_3} },
535 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 688 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689 ) {
536 if ($_ eq "default") { 690 if ($_ eq "default") {
537 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 691 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
538 } elsif (/^-(.*)$/) { 692 } elsif (/^-(.*)$/) {
539 delete $ext_arg{$1}; 693 delete $ext_arg{$1};
540 } elsif (/^([^<]+)<(.*)>$/) { 694 } elsif (/^([^<]+)<(.*)>$/) {
541 push @{ $ext_arg{$1} }, $2; 695 push @{ $ext_arg{$1} }, $2;
542 } else { 696 } else {
543 $ext_arg{$_} ||= []; 697 $ext_arg{$_} ||= [];
544 } 698 }
545 } 699 }
546 700
547 while (my ($ext, $argv) = each %ext_arg) { 701 for my $ext (sort keys %ext_arg) {
548 my @files = grep -f $_, map "$_/$ext", @dirs; 702 my @files = grep -f $_, map "$_/$ext", @dirs;
549 703
550 if (@files) { 704 if (@files) {
551 $TERM->register_package (extension_package $files[0], $argv); 705 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
552 } else { 706 } else {
553 warn "perl extension '$ext' not found in perl library search path\n"; 707 warn "perl extension '$ext' not found in perl library search path\n";
554 } 708 }
555 } 709 }
556 710
562 716
563 if (my $cb = $TERM->{_hook}[$htype]) { 717 if (my $cb = $TERM->{_hook}[$htype]) {
564 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
565 if $verbosity >= 10; 719 if $verbosity >= 10;
566 720
567 keys %$cb; 721 for my $pkg (keys %$cb) {
568
569 while (my ($pkg, $cb) = each %$cb) {
570 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
571 and last; 723 $retval ||= $retval_;
572 724
573 if ($@) { 725 if ($@) {
574 $TERM->ungrab; # better to lose the grab than the session 726 $TERM->ungrab; # better to lose the grab than the session
575 warn $@; 727 warn $@;
576 } 728 }
577 } 729 }
730
731 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732 if $verbosity >= 11;
578 } 733 }
579 734
580 if ($htype == 1) { # DESTROY 735 if ($htype == 1) { # DESTROY
581 if (my $hook = delete $TERM->{_hook}) {
582 for my $htype (0..$#$hook) {
583 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
584 or set_should_invoke $htype, 0;
585 }
586 }
587
588 # clear package objects 736 # clear package objects
589 %$_ = () for values %{ $TERM->{_pkg} }; 737 %$_ = () for values %{ $TERM->{_pkg} };
590 738
591 # clear package 739 # clear package
592 %$TERM = (); 740 %$TERM = ();
593 } 741 }
594 742
595 $retval 743 $retval
596} 744}
597 745
598# urxvt::term::extension 746sub SET_COLOR($$$) {
747 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
748}
599 749
600package urxvt::term::extension; 750sub rend2mask {
601 751 no strict 'refs';
602sub enable { 752 my ($str, $mask) = (@_, 0);
603 my ($self, %hook) = @_; 753 my %color = ( fg => undef, bg => undef );
604 my $pkg = $self->{_pkg}; 754 my @failed;
605 755 for my $spec ( split /\s+/, $str ) {
606 while (my ($name, $cb) = each %hook) { 756 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
607 my $htype = $HOOKTYPE{uc $name}; 757 $color{lc($1)} = $2;
608 defined $htype 758 } else {
609 or Carp::croak "unsupported hook type '$name'"; 759 my $neg = $spec =~ s/^[-^]//;
610 760 unless ( exists &{"RS_$spec"} ) {
611 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 761 push @failed, $spec;
612 $hook_count[$htype]++ 762 next;
613 or urxvt::set_should_invoke $htype, 1;
614 } 763 }
615 764 my $cur = &{"RS_$spec"};
616 $self->{term}{_hook}[$htype]{$pkg} = $cb; 765 if ( $neg ) {
617 } 766 $mask &= ~$cur;
618} 767 } else {
619 768 $mask |= $cur;
620sub disable { 769 }
621 my ($self, @hook) = @_;
622 my $pkg = $self->{_pkg};
623
624 for my $name (@hook) {
625 my $htype = $HOOKTYPE{uc $name};
626 defined $htype
627 or Carp::croak "unsupported hook type '$name'";
628
629 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
630 --$hook_count[$htype]
631 or urxvt::set_should_invoke $htype, 0;
632 } 770 }
633 } 771 }
772 ($mask, @color{qw(fg bg)}, \@failed)
634} 773}
774
775package urxvt::term::extension;
776
777=head2 The C<urxvt::term::extension> class
778
779Each extension attached to a terminal object is represented by
780a C<urxvt::term::extension> object.
781
782You can use these objects, which are passed to all callbacks to store any
783state related to the terminal and extension instance.
784
785The methods (And data members) documented below can be called on extension
786objects, in addition to call methods documented for the <urxvt::term>
787class.
788
789=over 4
790
791=item $urxvt_term = $self->{term}
792
793Returns the C<urxvt::term> object associated with this instance of the
794extension. This member I<must not> be changed in any way.
795
796=cut
635 797
636our $AUTOLOAD; 798our $AUTOLOAD;
637 799
638sub AUTOLOAD { 800sub AUTOLOAD {
639 $AUTOLOAD =~ /:([^:]+)$/ 801 $AUTOLOAD =~ /:([^:]+)$/
652 814
653sub DESTROY { 815sub DESTROY {
654 # nop 816 # nop
655} 817}
656 818
657# urxvt::destroy_hook 819# urxvt::destroy_hook (basically a cheap Guard:: implementation)
658 820
659sub urxvt::destroy_hook::DESTROY { 821sub urxvt::destroy_hook::DESTROY {
660 ${$_[0]}->(); 822 ${$_[0]}->();
661} 823}
662 824
663sub urxvt::destroy_hook(&) { 825sub urxvt::destroy_hook(&) {
664 bless \shift, urxvt::destroy_hook:: 826 bless \shift, urxvt::destroy_hook::
665} 827}
666 828
829=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830
831Dynamically enable the given hooks (named without the C<on_> prefix) for
832this extension, replacing any previous hook. This is useful when you want
833to overwrite time-critical hooks only temporarily.
834
835To install additional callbacks for the same hook, you can use the C<on>
836method of the C<urxvt::term> class.
837
838=item $self->disable ($hook_name[, $hook_name..])
839
840Dynamically disable the given hooks.
841
842=cut
843
844sub enable {
845 my ($self, %hook) = @_;
846 my $pkg = $self->{_pkg};
847
848 while (my ($name, $cb) = each %hook) {
849 my $htype = $HOOKTYPE{uc $name};
850 defined $htype
851 or Carp::croak "unsupported hook type '$name'";
852
853 $self->set_should_invoke ($htype, +1)
854 unless exists $self->{term}{_hook}[$htype]{$pkg};
855
856 $self->{term}{_hook}[$htype]{$pkg} = $cb;
857 }
858}
859
860sub disable {
861 my ($self, @hook) = @_;
862 my $pkg = $self->{_pkg};
863
864 for my $name (@hook) {
865 my $htype = $HOOKTYPE{uc $name};
866 defined $htype
867 or Carp::croak "unsupported hook type '$name'";
868
869 $self->set_should_invoke ($htype, -1)
870 if delete $self->{term}{_hook}[$htype]{$pkg};
871 }
872}
873
874=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
875
876Similar to the C<enable> enable, but installs additional callbacks for
877the given hook(s) (that is, it doesn't replace existing callbacks), and
878returns a guard object. When the guard object is destroyed the callbacks
879are disabled again.
880
881=cut
882
883sub urxvt::extension::on_disable::DESTROY {
884 my $disable = shift;
885
886 my $term = delete $disable->{""};
887
888 while (my ($htype, $id) = each %$disable) {
889 delete $term->{_hook}[$htype]{$id};
890 $term->set_should_invoke ($htype, -1);
891 }
892}
893
894sub on {
895 my ($self, %hook) = @_;
896
897 my $term = $self->{term};
898
899 my %disable = ( "" => $term );
900
901 while (my ($name, $cb) = each %hook) {
902 my $htype = $HOOKTYPE{uc $name};
903 defined $htype
904 or Carp::croak "unsupported hook type '$name'";
905
906 $term->set_should_invoke ($htype, +1);
907 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908 = sub { shift; $cb->($self, @_) }; # very ugly indeed
909 }
910
911 bless \%disable, "urxvt::extension::on_disable"
912}
913
914=item $self->x_resource ($pattern)
915
916=item $self->x_resource_boolean ($pattern)
917
918These methods support an additional C<%> prefix when called on an
919extension object - see the description of these methods in the
920C<urxvt::term> class for details.
921
922=cut
923
924sub x_resource {
925 my ($self, $name) = @_;
926 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
927 $self->{term}->x_resource ($name)
928}
929
930sub x_resource_boolean {
931 my ($self, $name) = @_;
932 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
933 $self->{term}->x_resource_boolean ($name)
934}
935
936=back
937
938=cut
939
667package urxvt::anyevent; 940package urxvt::anyevent;
668 941
669=head2 The C<urxvt::anyevent> Class 942=head2 The C<urxvt::anyevent> Class
670 943
671The sole purpose of this class is to deliver an interface to the 944The sole purpose of this class is to deliver an interface to the
672C<AnyEvent> module - any module using it will work inside urxvt without 945C<AnyEvent> module - any module using it will work inside urxvt without
673further work. The only exception is that you cannot wait on condition 946further programming. The only exception is that you cannot wait on
674variables, but non-blocking condvar use is ok. What this means is that you 947condition variables, but non-blocking condvar use is ok.
675cannot use blocking APIs, but the non-blocking variant should work.
676 948
677=cut 949In practical terms this means is that you cannot use blocking APIs, but
950the non-blocking variant should work.
678 951
952=cut
953
679our $VERSION = 1; 954our $VERSION = '5.23';
680 955
681$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 956$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
682push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 957push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
683 958
684sub timer { 959sub timer {
686 961
687 my $cb = $arg{cb}; 962 my $cb = $arg{cb};
688 963
689 urxvt::timer 964 urxvt::timer
690 ->new 965 ->new
691 ->start (urxvt::NOW + $arg{after}) 966 ->after ($arg{after}, $arg{interval})
692 ->cb (sub { 967 ->cb ($arg{interval} ? $cb : sub {
693 $_[0]->stop; # need to cancel manually 968 $_[0]->stop; # need to cancel manually
694 $cb->(); 969 $cb->();
695 }) 970 })
696} 971}
697 972
698sub io { 973sub io {
699 my ($class, %arg) = @_; 974 my ($class, %arg) = @_;
700 975
701 my $cb = $arg{cb}; 976 my $cb = $arg{cb};
977 my $fd = fileno $arg{fh};
978 defined $fd or $fd = $arg{fh};
702 979
703 bless [$arg{fh}, urxvt::iow 980 bless [$arg{fh}, urxvt::iow
704 ->new 981 ->new
705 ->fd (fileno $arg{fh}) 982 ->fd ($fd)
706 ->events (($arg{poll} =~ /r/ ? 1 : 0) 983 ->events (($arg{poll} =~ /r/ ? 1 : 0)
707 | ($arg{poll} =~ /w/ ? 2 : 0)) 984 | ($arg{poll} =~ /w/ ? 2 : 0))
708 ->start 985 ->start
709 ->cb (sub { 986 ->cb ($cb)
710 $cb->(($_[1] & 1 ? 'r' : '')
711 . ($_[1] & 2 ? 'w' : ''));
712 })],
713 urxvt::anyevent:: 987 ], urxvt::anyevent::
988}
989
990sub idle {
991 my ($class, %arg) = @_;
992
993 my $cb = $arg{cb};
994
995 urxvt::iw
996 ->new
997 ->start
998 ->cb ($cb)
999}
1000
1001sub child {
1002 my ($class, %arg) = @_;
1003
1004 my $cb = $arg{cb};
1005
1006 urxvt::pw
1007 ->new
1008 ->start ($arg{pid})
1009 ->cb (sub {
1010 $_[0]->stop; # need to cancel manually
1011 $cb->($_[0]->rpid, $_[0]->rstatus);
1012 })
714} 1013}
715 1014
716sub DESTROY { 1015sub DESTROY {
717 $_[0][1]->stop; 1016 $_[0][1]->stop;
718} 1017}
719 1018
720sub condvar { 1019# only needed for AnyEvent < 6 compatibility
721 bless \my $flag, urxvt::anyevent::condvar:: 1020sub one_event {
722}
723
724sub urxvt::anyevent::condvar::broadcast {
725 ${$_[0]}++;
726}
727
728sub urxvt::anyevent::condvar::wait {
729 unless (${$_[0]}) {
730 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1021 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
731 }
732} 1022}
733 1023
734package urxvt::term; 1024package urxvt::term;
735 1025
736=head2 The C<urxvt::term> Class 1026=head2 The C<urxvt::term> Class
742# find on_xxx subs in the package and register them 1032# find on_xxx subs in the package and register them
743# as hooks 1033# as hooks
744sub register_package { 1034sub register_package {
745 my ($self, $pkg, $argv) = @_; 1035 my ($self, $pkg, $argv) = @_;
746 1036
1037 no strict 'refs';
1038
1039 urxvt::verbose 6, "register package $pkg to $self";
1040
1041 @{"$pkg\::ISA"} = urxvt::term::extension::;
1042
747 my $proxy = bless { 1043 my $proxy = bless {
748 _pkg => $pkg, 1044 _pkg => $pkg,
1045 _name => ${"$pkg\::_NAME"}, # hackish
749 argv => $argv, 1046 argv => $argv,
750 }, $pkg; 1047 }, $pkg;
751 Scalar::Util::weaken ($proxy->{term} = $self); 1048 Scalar::Util::weaken ($proxy->{term} = $self);
752 1049
753 $self->{_pkg}{$pkg} = $proxy; 1050 $self->{_pkg}{$pkg} = $proxy;
754 1051
757 $proxy->enable ($name => $ref); 1054 $proxy->enable ($name => $ref);
758 } 1055 }
759 } 1056 }
760} 1057}
761 1058
1059sub perl_libdirs {
1060 map { split /:/ }
1061 $_[0]->resource ("perl_lib"),
1062 $ENV{URXVT_PERL_LIB},
1063 "$ENV{HOME}/.urxvt/ext",
1064 "$LIBDIR/perl"
1065}
1066
1067sub scan_meta {
1068 my ($self) = @_;
1069 my @libdirs = perl_libdirs $self;
1070
1071 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1072
1073 my %meta;
1074
1075 $self->{meta_libdirs} = join "\x00", @libdirs;
1076 $self->{meta} = \%meta;
1077
1078 for my $dir (reverse @libdirs) {
1079 opendir my $fh, $dir
1080 or next;
1081 for my $ext (readdir $fh) {
1082 $ext !~ /^\./
1083 and open my $fh, "<", "$dir/$ext"
1084 or next;
1085
1086 while (<$fh>) {
1087 if (/^#:META:X_RESOURCE:(.*)/) {
1088 my ($pattern, $type, $desc) = split /:/, $1;
1089 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1090 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1091 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1092 } else {
1093 $meta{resource}{$pattern} = [$ext, $type, $desc];
1094 }
1095 } elsif (/^\s*(?:#|$)/) {
1096 # skip other comments and empty lines
1097 } else {
1098 last; # stop parsing on first non-empty non-comment line
1099 }
1100 }
1101 }
1102 }
1103}
1104
1105=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1106
1107Creates a new terminal, very similar as if you had started it with system
1108C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1109hash which defines the environment of the new terminal.
1110
1111Croaks (and probably outputs an error message) if the new instance
1112couldn't be created. Returns C<undef> if the new instance didn't
1113initialise perl, and the terminal object otherwise. The C<init> and
1114C<start> hooks will be called before this call returns, and are free to
1115refer to global data (which is race free).
1116
1117=cut
1118
1119sub new {
1120 my ($class, $env, @args) = @_;
1121
1122 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1123 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1124
1125 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1126}
1127
762=item $term->destroy 1128=item $term->destroy
763 1129
764Destroy the terminal object (close the window, free resources etc.). 1130Destroy the terminal object (close the window, free resources
1131etc.). Please note that urxvt will not exit as long as any event
1132watchers (timers, io watchers) are still active.
1133
1134=item $term->exec_async ($cmd[, @args])
1135
1136Works like the combination of the C<fork>/C<exec> builtins, which executes
1137("starts") programs in the background. This function takes care of setting
1138the user environment before exec'ing the command (e.g. C<PATH>) and should
1139be preferred over explicit calls to C<exec> or C<system>.
1140
1141Returns the pid of the subprocess or C<undef> on error.
1142
1143=cut
1144
1145sub exec_async {
1146 my $self = shift;
1147
1148 my $pid = fork;
1149
1150 return $pid
1151 if !defined $pid or $pid;
1152
1153 %ENV = %{ $self->env };
1154
1155 exec @_;
1156 urxvt::_exit 255;
1157}
765 1158
766=item $isset = $term->option ($optval[, $set]) 1159=item $isset = $term->option ($optval[, $set])
767 1160
768Returns true if the option specified by C<$optval> is enabled, and 1161Returns true if the option specified by C<$optval> is enabled, and
769optionally change it. All option values are stored by name in the hash 1162optionally change it. All option values are stored by name in the hash
770C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1163C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
771 1164
772Here is a a likely non-exhaustive list of option names, please see the 1165Here is a likely non-exhaustive list of option names, please see the
773source file F</src/optinc.h> to see the actual list: 1166source file F</src/optinc.h> to see the actual list:
774 1167
775 borderLess console cursorBlink cursorUnderline hold iconic insecure 1168 borderLess buffered console cursorBlink cursorUnderline hold iconic
776 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1169 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1170 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
777 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1171 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
778 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1172 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
779 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1173 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
780 tripleclickwords utmpInhibit visualBell 1174 urgentOnBell utmpInhibit visualBell
781 1175
782=item $value = $term->resource ($name[, $newval]) 1176=item $value = $term->resource ($name[, $newval])
783 1177
784Returns the current resource value associated with a given name and 1178Returns the current resource value associated with a given name and
785optionally sets a new value. Setting values is most useful in the C<init> 1179optionally sets a new value. Setting values is most useful in the C<init>
794likely change). 1188likely change).
795 1189
796Please note that resource strings will currently only be freed when the 1190Please note that resource strings will currently only be freed when the
797terminal is destroyed, so changing options frequently will eat memory. 1191terminal is destroyed, so changing options frequently will eat memory.
798 1192
799Here is a a likely non-exhaustive list of resource names, not all of which 1193Here is a likely non-exhaustive list of resource names, not all of which
800are supported in every build, please see the source file F</src/rsinc.h> 1194are supported in every build, please see the source file F</src/rsinc.h>
801to see the actual list: 1195to see the actual list:
802 1196
803 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1197 answerbackstring backgroundPixmap backspace_key blurradius
804 borderLess color cursorBlink cursorUnderline cutchars delete_key 1198 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
805 display_name embed ext_bwidth fade font geometry hold iconName 1199 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
806 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1200 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1201 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
807 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1202 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
808 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1203 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
809 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1204 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
810 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1205 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
811 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1206 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
812 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1207 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
813 shade term_name title transparent transparent_all tripleclickwords 1208 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1209 term_name title transient_for transparent tripleclickwords urgentOnBell
814 utmpInhibit visualBell 1210 utmpInhibit visualBell
815 1211
816=cut 1212=cut
817 1213
818sub resource($$;$) { 1214sub resource($$;$) {
819 my ($self, $name) = (shift, shift); 1215 my ($self, $name) = (shift, shift);
820 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1216 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
821 &urxvt::term::_resource 1217 goto &urxvt::term::_resource
822} 1218}
823 1219
824=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1220=item $value = $term->x_resource ($pattern)
825 1221
1222Returns the X-Resource for the given pattern, excluding the program or
1223class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1224same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1225resource with that pattern exists.
1226
1227Extensions that define extra resource or command line arguments also need
1228to call this method to access their values.
1229
1230If the method is called on an extension object (basically, from an
1231extension), then the special prefix C<%.> will be replaced by the name of
1232the extension and a dot, and the lone string C<%> will be replaced by the
1233extension name itself. This makes it possible to code extensions so you
1234can rename them and get a new set of commandline switches and resources
1235without having to change the actual code.
1236
1237This method should only be called during the C<on_start> hook, as there is
1238only one resource database per display, and later invocations might return
1239the wrong resources.
1240
1241=item $value = $term->x_resource_boolean ($pattern)
1242
1243Like C<x_resource>, above, but interprets the string value as a boolean
1244and returns C<1> for true values, C<0> for false values and C<undef> if
1245the resource or option isn't specified.
1246
1247You should always use this method to parse boolean resources.
1248
1249=cut
1250
1251sub x_resource_boolean {
1252 my $res = &x_resource;
1253
1254 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1255}
1256
1257=item $success = $term->parse_keysym ($key, $octets)
1258
826Adds a keymap translation exactly as specified via a resource. See the 1259Adds a key binding exactly as specified via a resource. See the
827C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1260C<keysym> resource in the urxvt(1) manpage.
1261
1262=item $term->register_command ($keysym, $modifiermask, $string)
1263
1264Adds a key binding. This is a lower level api compared to
1265C<parse_keysym>, as it expects a parsed key description, and can be
1266used only inside either the C<on_init> hook, to add a binding, or the
1267C<on_register_command> hook, to modify a parsed binding.
828 1268
829=item $rend = $term->rstyle ([$new_rstyle]) 1269=item $rend = $term->rstyle ([$new_rstyle])
830 1270
831Return and optionally change the current rendition. Text that is output by 1271Return and optionally change the current rendition. Text that is output by
832the terminal application will use this style. 1272the terminal application will use this style.
840 1280
841=item ($row, $col) = $term->selection_beg ([$row, $col]) 1281=item ($row, $col) = $term->selection_beg ([$row, $col])
842 1282
843=item ($row, $col) = $term->selection_end ([$row, $col]) 1283=item ($row, $col) = $term->selection_end ([$row, $col])
844 1284
845Return the current values of the selection mark, begin or end positions, 1285Return the current values of the selection mark, begin or end positions.
846and optionally set them to new values.
847 1286
1287When arguments are given, then the selection coordinates are set to
1288C<$row> and C<$col>, and the selection screen is set to the current
1289screen.
1290
1291=item $screen = $term->selection_screen ([$screen])
1292
1293Returns the current selection screen, and then optionally sets it.
1294
1295=item $term->selection_make ($eventtime[, $rectangular])
1296
1297Tries to make a selection as set by C<selection_beg> and
1298C<selection_end>. If C<$rectangular> is true (default: false), a
1299rectangular selection will be made. This is the preferred function to make
1300a selection.
1301
848=item $success = $term->selection_grab ($eventtime) 1302=item $success = $term->selection_grab ($eventtime[, $clipboard])
849 1303
850Try to request the primary selection from the server (for example, as set 1304Try to acquire ownership of the primary (clipboard if C<$clipboard> is
851by the next method). 1305true) selection from the server. The corresponding text can be set
1306with the next method. No visual feedback will be given. This function
1307is mostly useful from within C<on_sel_grab> hooks.
852 1308
853=item $oldtext = $term->selection ([$newtext]) 1309=item $oldtext = $term->selection ([$newtext, $clipboard])
854 1310
855Return the current selection text and optionally replace it by C<$newtext>. 1311Return the current selection (clipboard if C<$clipboard> is true) text
1312and optionally replace it by C<$newtext>.
1313
1314=item $term->selection_clear ([$clipboard])
1315
1316Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
856 1317
857=item $term->overlay_simple ($x, $y, $text) 1318=item $term->overlay_simple ($x, $y, $text)
858 1319
859Create a simple multi-line overlay box. See the next method for details. 1320Create a simple multi-line overlay box. See the next method for details.
860 1321
890 1351
891The methods currently supported on C<urxvt::overlay> objects are: 1352The methods currently supported on C<urxvt::overlay> objects are:
892 1353
893=over 4 1354=over 4
894 1355
895=item $overlay->set ($x, $y, $text, $rend) 1356=item $overlay->set ($x, $y, $text[, $rend])
896 1357
897Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1358Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
898text in rxvt-unicode's special encoding and an array of rendition values 1359text in rxvt-unicode's special encoding and an array of rendition values
899at a specific position inside the overlay. 1360at a specific position inside the overlay.
1361
1362If C<$rend> is missing, then the rendition will not be changed.
900 1363
901=item $overlay->hide 1364=item $overlay->hide
902 1365
903If visible, hide the overlay, but do not destroy it. 1366If visible, hide the overlay, but do not destroy it.
904 1367
949Convert the given locale-encoded octets into a perl string. 1412Convert the given locale-encoded octets into a perl string.
950 1413
951=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1414=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
952 1415
953XORs the rendition values in the given span with the provided value 1416XORs the rendition values in the given span with the provided value
954(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1417(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
955to the selection. 1418refresh hooks to provide effects similar to the selection.
956 1419
957=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1420=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
958 1421
959Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1422Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
960whitespace will additionally be xored with the C<$rstyle2>, which defaults 1423whitespace will additionally be xored with the C<$rstyle2>, which defaults
961to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1424to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
962it instead. 1425it instead. Both styles I<MUST NOT> contain font styles.
963 1426
964=item $term->scr_bell 1427=item $term->scr_bell
965 1428
966Ring the bell! 1429Ring the bell!
967 1430
974 1437
975Normally its not a good idea to use this function, as programs might be 1438Normally its not a good idea to use this function, as programs might be
976confused by changes in cursor position or scrolling. Its useful inside a 1439confused by changes in cursor position or scrolling. Its useful inside a
977C<on_add_lines> hook, though. 1440C<on_add_lines> hook, though.
978 1441
1442=item $term->scr_change_screen ($screen)
1443
1444Switch to given screen - 0 primary, 1 secondary.
1445
979=item $term->cmd_parse ($octets) 1446=item $term->cmd_parse ($octets)
980 1447
981Similar to C<scr_add_lines>, but the argument must be in the 1448Similar to C<scr_add_lines>, but the argument must be in the
982locale-specific encoding of the terminal and can contain command sequences 1449locale-specific encoding of the terminal and can contain command sequences
983(escape codes) that will be interpreted. 1450(escape codes) that will be interpreted.
984 1451
985=item $term->tt_write ($octets) 1452=item $term->tt_write ($octets)
986 1453
987Write the octets given in C<$data> to the tty (i.e. as program input). To 1454Write the octets given in C<$octets> to the tty (i.e. as program input). To
988pass characters instead of octets, you should convert your strings first 1455pass characters instead of octets, you should convert your strings first
989to the locale-specific encoding using C<< $term->locale_encode >>. 1456to the locale-specific encoding using C<< $term->locale_encode >>.
1457
1458=item $term->tt_paste ($octets)
1459
1460Write the octets given in C<$octets> to the tty as a paste, converting NL to
1461CR and bracketing the data with control sequences if bracketed paste mode
1462is set.
990 1463
991=item $old_events = $term->pty_ev_events ([$new_events]) 1464=item $old_events = $term->pty_ev_events ([$new_events])
992 1465
993Replaces the event mask of the pty watcher by the given event mask. Can 1466Replaces the event mask of the pty watcher by the given event mask. Can
994be used to suppress input and output handling to the pty/tty. See the 1467be used to suppress input and output handling to the pty/tty. See the
995description of C<< urxvt::timer->events >>. Make sure to always restore 1468description of C<< urxvt::timer->events >>. Make sure to always restore
996the previous value. 1469the previous value.
997 1470
1471=item $fd = $term->pty_fd
1472
1473Returns the master file descriptor for the pty in use, or C<-1> if no pty
1474is used.
1475
998=item $windowid = $term->parent 1476=item $windowid = $term->parent
999 1477
1000Return the window id of the toplevel window. 1478Return the window id of the toplevel window.
1001 1479
1002=item $windowid = $term->vt 1480=item $windowid = $term->vt
1003 1481
1004Return the window id of the terminal window. 1482Return the window id of the terminal window.
1005 1483
1484=item $term->vt_emask_add ($x_event_mask)
1485
1486Adds the specified events to the vt event mask. Useful e.g. when you want
1487to receive pointer events all the times:
1488
1489 $term->vt_emask_add (urxvt::PointerMotionMask);
1490
1491=item $term->set_urgency ($set)
1492
1493Enable/disable the urgency hint on the toplevel window.
1494
1495=item $term->focus_in
1496
1497=item $term->focus_out
1498
1499=item $term->key_press ($state, $keycode[, $time])
1500
1501=item $term->key_release ($state, $keycode[, $time])
1502
1503Deliver various fake events to to terminal.
1504
1006=item $window_width = $term->width 1505=item $window_width = $term->width
1007 1506
1008=item $window_height = $term->height 1507=item $window_height = $term->height
1009 1508
1010=item $font_width = $term->fwidth 1509=item $font_width = $term->fwidth
1023 1522
1024=item $max_scrollback = $term->saveLines 1523=item $max_scrollback = $term->saveLines
1025 1524
1026=item $nrow_plus_saveLines = $term->total_rows 1525=item $nrow_plus_saveLines = $term->total_rows
1027 1526
1028=item $lines_in_scrollback = $term->nsaved 1527=item $topmost_scrollback_row = $term->top_row
1029 1528
1030Return various integers describing terminal characteristics. 1529Return various integers describing terminal characteristics.
1031 1530
1531=item $x_display = $term->display_id
1532
1533Return the DISPLAY used by rxvt-unicode.
1534
1032=item $lc_ctype = $term->locale 1535=item $lc_ctype = $term->locale
1033 1536
1034Returns the LC_CTYPE category string used by this rxvt-unicode. 1537Returns the LC_CTYPE category string used by this rxvt-unicode.
1035 1538
1036=item $x_display = $term->display_id 1539=item $env = $term->env
1037 1540
1038Return the DISPLAY used by rxvt-unicode. 1541Returns a copy of the environment in effect for the terminal as a hashref
1542similar to C<\%ENV>.
1543
1544=item @envv = $term->envv
1545
1546Returns the environment as array of strings of the form C<VAR=VALUE>.
1547
1548=item @argv = $term->argv
1549
1550Return the argument vector as this terminal, similar to @ARGV, but
1551includes the program name as first element.
1552
1553=cut
1554
1555sub env {
1556 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1557}
1039 1558
1040=item $modifiermask = $term->ModLevel3Mask 1559=item $modifiermask = $term->ModLevel3Mask
1041 1560
1042=item $modifiermask = $term->ModMetaMask 1561=item $modifiermask = $term->ModMetaMask
1043 1562
1044=item $modifiermask = $term->ModNumLockMask 1563=item $modifiermask = $term->ModNumLockMask
1045 1564
1046Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1565Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1047AltGr), the meta key (often Alt) and the num lock key, if applicable. 1566AltGr), the meta key (often Alt) and the num lock key, if applicable.
1048 1567
1568=item $screen = $term->current_screen
1569
1570Returns the currently displayed screen (0 primary, 1 secondary).
1571
1572=item $cursor_is_hidden = $term->hidden_cursor
1573
1574Returns whether the cursor is currently hidden or not.
1575
1049=item $view_start = $term->view_start ([$newvalue]) 1576=item $view_start = $term->view_start ([$newvalue])
1050 1577
1051Returns the negative row number of the topmost line. Minimum value is 1578Returns the row number of the topmost displayed line. Maximum value is
1052C<0>, which displays the normal terminal contents. Larger values scroll 1579C<0>, which displays the normal terminal contents. Lower values scroll
1053this many lines into the scrollback buffer. 1580this many lines into the scrollback buffer.
1054 1581
1055=item $term->want_refresh 1582=item $term->want_refresh
1056 1583
1057Requests a screen refresh. At the next opportunity, rxvt-unicode will 1584Requests a screen refresh. At the next opportunity, rxvt-unicode will
1060 1587
1061Used after changing terminal contents to display them. 1588Used after changing terminal contents to display them.
1062 1589
1063=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1590=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1064 1591
1065Returns the text of the entire row with number C<$row_number>. Row C<0> 1592Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1066is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1593is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1067terminal line. The scrollback buffer starts at line C<-1> and extends to
1068line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1594terminal line. Nothing will be returned if a nonexistent line
1069is requested. 1595is requested.
1070 1596
1071If C<$new_text> is specified, it will replace characters in the current 1597If C<$new_text> is specified, it will replace characters in the current
1072line, starting at column C<$start_col> (default C<0>), which is useful 1598line, starting at column C<$start_col> (default C<0>), which is useful
1073to replace only parts of a line. The font index in the rendition will 1599to replace only parts of a line. The font index in the rendition will
1074automatically be updated. 1600automatically be updated.
1075 1601
1076C<$text> is in a special encoding: tabs and wide characters that use more 1602C<$text> is in a special encoding: tabs and wide characters that use more
1077than one cell when displayed are padded with urxvt::NOCHAR characters 1603than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1078(C<chr 65535>). Characters with combining characters and other characters 1604characters. Characters with combining characters and other characters that
1079that do not fit into the normal tetx encoding will be replaced with 1605do not fit into the normal text encoding will be replaced with characters
1080characters in the private use area. 1606in the private use area.
1081 1607
1082You have to obey this encoding when changing text. The advantage is 1608You have to obey this encoding when changing text. The advantage is
1083that C<substr> and similar functions work on screen cells and not on 1609that C<substr> and similar functions work on screen cells and not on
1084characters. 1610characters.
1085 1611
1136Return the row number of the first/last row of the line, respectively. 1662Return the row number of the first/last row of the line, respectively.
1137 1663
1138=item $offset = $line->offset_of ($row, $col) 1664=item $offset = $line->offset_of ($row, $col)
1139 1665
1140Returns the character offset of the given row|col pair within the logical 1666Returns the character offset of the given row|col pair within the logical
1141line. 1667line. Works for rows outside the line, too, and returns corresponding
1668offsets outside the string.
1142 1669
1143=item ($row, $col) = $line->coord_of ($offset) 1670=item ($row, $col) = $line->coord_of ($offset)
1144 1671
1145Translates a string offset into terminal coordinates again. 1672Translates a string offset into terminal coordinates again.
1146 1673
1168} 1695}
1169 1696
1170sub urxvt::line::t { 1697sub urxvt::line::t {
1171 my ($self) = @_; 1698 my ($self) = @_;
1172 1699
1173 if (@_ > 1) 1700 if (@_ > 1) {
1174 {
1175 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1701 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1176 for $self->{beg} .. $self->{end}; 1702 for $self->{beg} .. $self->{end};
1177 } 1703 }
1178 1704
1179 defined wantarray && 1705 defined wantarray &&
1180 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1706 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1181 0, $self->{len} 1707 0, $self->{len}
1182} 1708}
1183 1709
1184sub urxvt::line::r { 1710sub urxvt::line::r {
1185 my ($self) = @_; 1711 my ($self) = @_;
1186 1712
1187 if (@_ > 1) 1713 if (@_ > 1) {
1188 {
1189 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1714 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1190 for $self->{beg} .. $self->{end}; 1715 for $self->{beg} .. $self->{end};
1191 } 1716 }
1192 1717
1193 if (defined wantarray) { 1718 if (defined wantarray) {
1194 my $rend = [ 1719 my $rend = [
1195 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1720 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1196 ]; 1721 ];
1228where one character corresponds to one screen cell. See 1753where one character corresponds to one screen cell. See
1229C<< $term->ROW_t >> for details. 1754C<< $term->ROW_t >> for details.
1230 1755
1231=item $string = $term->special_decode $text 1756=item $string = $term->special_decode $text
1232 1757
1233Converts rxvt-unicodes text reprsentation into a perl string. See 1758Converts rxvt-unicodes text representation into a perl string. See
1234C<< $term->ROW_t >> for details. 1759C<< $term->ROW_t >> for details.
1235 1760
1236=item $success = $term->grab_button ($button, $modifiermask) 1761=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1237 1762
1763=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1764
1238Registers a synchronous button grab. See the XGrabButton manpage. 1765Register/unregister a synchronous button grab. See the XGrabButton
1766manpage.
1239 1767
1240=item $success = $term->grab ($eventtime[, $sync]) 1768=item $success = $term->grab ($eventtime[, $sync])
1241 1769
1242Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1770Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1243synchronous (C<$sync> is true). Also remembers the grab timestampe. 1771synchronous (C<$sync> is true). Also remembers the grab timestamp.
1244 1772
1245=item $term->allow_events_async 1773=item $term->allow_events_async
1246 1774
1247Calls XAllowEvents with AsyncBoth for the most recent grab. 1775Calls XAllowEvents with AsyncBoth for the most recent grab.
1248 1776
1255Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1783Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1256recent grab. 1784recent grab.
1257 1785
1258=item $term->ungrab 1786=item $term->ungrab
1259 1787
1260Calls XUngrab for the most recent grab. Is called automatically on 1788Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1261evaluation errors, as it is better to lose the grab in the error case as 1789evaluation errors, as it is better to lose the grab in the error case as
1262the session. 1790the session.
1791
1792=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1793
1794=item $atom_name = $term->XGetAtomName ($atom)
1795
1796=item @atoms = $term->XListProperties ($window)
1797
1798=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1799
1800=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1801
1802=item $term->XDeleteProperty ($window, $property)
1803
1804=item $window = $term->DefaultRootWindow
1805
1806=item $term->XReparentWindow ($window, $parent, [$x, $y])
1807
1808=item $term->XMapWindow ($window)
1809
1810=item $term->XUnmapWindow ($window)
1811
1812=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1813
1814=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1815
1816=item $term->XChangeInput ($window, $add_events[, $del_events])
1817
1818=item $keysym = $term->XStringToKeysym ($string)
1819
1820=item $string = $term->XKeysymToString ($keysym)
1821
1822Various X or X-related functions. The C<$term> object only serves as
1823the source of the display, otherwise those functions map more-or-less
1824directly onto the X functions of the same name.
1263 1825
1264=back 1826=back
1265 1827
1266=cut 1828=cut
1267 1829
1282 1844
1283 $item->{render} ||= sub { $_[0]{text} }; 1845 $item->{render} ||= sub { $_[0]{text} };
1284 1846
1285 push @{ $self->{item} }, $item; 1847 push @{ $self->{item} }, $item;
1286} 1848}
1849
1850=item $popup->add_title ($title)
1851
1852Adds a non-clickable title to the popup.
1853
1854=cut
1855
1856sub add_title {
1857 my ($self, $title) = @_;
1858
1859 $self->add_item ({
1860 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1861 text => $title,
1862 activate => sub { },
1863 });
1864}
1865
1866=item $popup->add_separator ([$sepchr])
1867
1868Creates a separator, optionally using the character given as C<$sepchr>.
1869
1870=cut
1287 1871
1288sub add_separator { 1872sub add_separator {
1289 my ($self, $sep) = @_; 1873 my ($self, $sep) = @_;
1290 1874
1291 $sep ||= "="; 1875 $sep ||= "=";
1296 render => sub { $sep x $self->{term}->ncol }, 1880 render => sub { $sep x $self->{term}->ncol },
1297 activate => sub { }, 1881 activate => sub { },
1298 }); 1882 });
1299} 1883}
1300 1884
1301sub add_title { 1885=item $popup->add_button ($text, $cb)
1302 my ($self, $title) = @_;
1303 1886
1304 $self->add_item ({ 1887Adds a clickable button to the popup. C<$cb> is called whenever it is
1305 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1888selected.
1306 text => $title, 1889
1307 activate => sub { }, 1890=cut
1308 });
1309}
1310 1891
1311sub add_button { 1892sub add_button {
1312 my ($self, $text, $cb) = @_; 1893 my ($self, $text, $cb) = @_;
1313 1894
1314 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1895 $self->add_item ({ type => "button", text => $text, activate => $cb});
1315} 1896}
1316 1897
1898=item $popup->add_toggle ($text, $initial_value, $cb)
1899
1900Adds a toggle/checkbox item to the popup. The callback gets called
1901whenever it gets toggled, with a boolean indicating its new value as its
1902first argument.
1903
1904=cut
1905
1317sub add_toggle { 1906sub add_toggle {
1318 my ($self, $text, $cb, $value) = @_; 1907 my ($self, $text, $value, $cb) = @_;
1319 1908
1320 my $item; $item = { 1909 my $item; $item = {
1321 type => "button", 1910 type => "button",
1322 text => " $text", 1911 text => " $text",
1323 value => $value, 1912 value => $value,
1324 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1913 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1325 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1914 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1326 }; 1915 };
1327 1916
1328 $self->add_item ($item); 1917 $self->add_item ($item);
1329} 1918}
1919
1920=item $popup->show
1921
1922Displays the popup (which is initially hidden).
1923
1924=cut
1330 1925
1331sub show { 1926sub show {
1332 my ($self) = @_; 1927 my ($self) = @_;
1333 1928
1334 local $urxvt::popup::self = $self; 1929 local $urxvt::popup::self = $self;
1335 1930
1931 my $env = $self->{term}->env;
1932 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1933 delete $env->{LC_ALL};
1336 local $ENV{LC_ALL} = $self->{term}->locale; 1934 $env->{LC_CTYPE} = $self->{term}->locale;
1337 1935
1338 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1936 my $term = urxvt::term->new (
1937 $env, "popup",
1938 "--perl-lib" => "", "--perl-ext-common" => "",
1939 "-pty-fd" => -1, "-sl" => 0,
1940 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1339 "--transient-for" => $self->{term}->parent, 1941 "--transient-for" => $self->{term}->parent,
1340 "-display" => $self->{term}->display_id, 1942 "-display" => $self->{term}->display_id,
1341 "-pe" => "urxvt-popup") 1943 "-pe" => "urxvt-popup",
1342 or die "unable to create popup window\n"; 1944 ) or die "unable to create popup window\n";
1945
1946 unless (delete $term->{urxvt_popup_init_done}) {
1947 $term->ungrab;
1948 $term->destroy;
1949 die "unable to initialise popup window\n";
1950 }
1343} 1951}
1344 1952
1345sub DESTROY { 1953sub DESTROY {
1346 my ($self) = @_; 1954 my ($self) = @_;
1347 1955
1348 delete $self->{term}{_destroy}{$self}; 1956 delete $self->{term}{_destroy}{$self};
1349 $self->{term}->ungrab; 1957 $self->{term}->ungrab;
1350} 1958}
1959
1960=back
1961
1962=cut
1963
1964package urxvt::watcher;
1351 1965
1352=head2 The C<urxvt::timer> Class 1966=head2 The C<urxvt::timer> Class
1353 1967
1354This class implements timer watchers/events. Time is represented as a 1968This class implements timer watchers/events. Time is represented as a
1355fractional number of seconds since the epoch. Example: 1969fractional number of seconds since the epoch. Example:
1359 ->new 1973 ->new
1360 ->interval (1) 1974 ->interval (1)
1361 ->cb (sub { 1975 ->cb (sub {
1362 $term->{overlay}->set (0, 0, 1976 $term->{overlay}->set (0, 0,
1363 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1977 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1364 }); 1978 });
1365 1979
1366=over 4 1980=over 4
1367 1981
1368=item $timer = new urxvt::timer 1982=item $timer = new urxvt::timer
1369 1983
1372 1986
1373=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1987=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1374 1988
1375Set the callback to be called when the timer triggers. 1989Set the callback to be called when the timer triggers.
1376 1990
1377=item $tstamp = $timer->at
1378
1379Return the time this watcher will fire next.
1380
1381=item $timer = $timer->set ($tstamp) 1991=item $timer = $timer->set ($tstamp[, $interval])
1382 1992
1383Set the time the event is generated to $tstamp. 1993Set the time the event is generated to $tstamp (and optionally specifies a
1994new $interval).
1384 1995
1385=item $timer = $timer->interval ($interval) 1996=item $timer = $timer->interval ($interval)
1386 1997
1387Normally (and when C<$interval> is C<0>), the timer will automatically 1998By default (and when C<$interval> is C<0>), the timer will automatically
1388stop after it has fired once. If C<$interval> is non-zero, then the timer 1999stop after it has fired once. If C<$interval> is non-zero, then the timer
1389is automatically rescheduled at the given intervals. 2000is automatically rescheduled at the given intervals.
1390 2001
1391=item $timer = $timer->start 2002=item $timer = $timer->start
1392 2003
1393Start the timer. 2004Start the timer.
1394 2005
1395=item $timer = $timer->start ($tstamp) 2006=item $timer = $timer->start ($tstamp[, $interval])
1396 2007
1397Set the event trigger time to C<$tstamp> and start the timer. 2008Set the event trigger time to C<$tstamp> and start the timer. Optionally
2009also replaces the interval.
2010
2011=item $timer = $timer->after ($delay[, $interval])
2012
2013Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1398 2014
1399=item $timer = $timer->stop 2015=item $timer = $timer->stop
1400 2016
1401Stop the timer. 2017Stop the timer.
1402 2018
1408 2024
1409 $term->{socket} = ... 2025 $term->{socket} = ...
1410 $term->{iow} = urxvt::iow 2026 $term->{iow} = urxvt::iow
1411 ->new 2027 ->new
1412 ->fd (fileno $term->{socket}) 2028 ->fd (fileno $term->{socket})
1413 ->events (urxvt::EVENT_READ) 2029 ->events (urxvt::EV_READ)
1414 ->start 2030 ->start
1415 ->cb (sub { 2031 ->cb (sub {
1416 my ($iow, $revents) = @_; 2032 my ($iow, $revents) = @_;
1417 # $revents must be 1 here, no need to check 2033 # $revents must be 1 here, no need to check
1418 sysread $term->{socket}, my $buf, 8192 2034 sysread $term->{socket}, my $buf, 8192
1431Set the callback to be called when io events are triggered. C<$reventmask> 2047Set the callback to be called when io events are triggered. C<$reventmask>
1432is a bitset as described in the C<events> method. 2048is a bitset as described in the C<events> method.
1433 2049
1434=item $iow = $iow->fd ($fd) 2050=item $iow = $iow->fd ($fd)
1435 2051
1436Set the filedescriptor (not handle) to watch. 2052Set the file descriptor (not handle) to watch.
1437 2053
1438=item $iow = $iow->events ($eventmask) 2054=item $iow = $iow->events ($eventmask)
1439 2055
1440Set the event mask to watch. The only allowed values are 2056Set the event mask to watch. The only allowed values are
1441C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2057C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1442together, or C<urxvt::EVENT_NONE>. 2058together, or C<urxvt::EV_NONE>.
1443 2059
1444=item $iow = $iow->start 2060=item $iow = $iow->start
1445 2061
1446Start watching for requested events on the given handle. 2062Start watching for requested events on the given handle.
1447 2063
1448=item $iow = $iow->stop 2064=item $iow = $iow->stop
1449 2065
1450Stop watching for events on the given filehandle. 2066Stop watching for events on the given file handle.
2067
2068=back
2069
2070=head2 The C<urxvt::iw> Class
2071
2072This class implements idle watchers, that get called automatically when
2073the process is idle. They should return as fast as possible, after doing
2074some useful work.
2075
2076=over 4
2077
2078=item $iw = new urxvt::iw
2079
2080Create a new idle watcher object in stopped state.
2081
2082=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2083
2084Set the callback to be called when the watcher triggers.
2085
2086=item $timer = $timer->start
2087
2088Start the watcher.
2089
2090=item $timer = $timer->stop
2091
2092Stop the watcher.
2093
2094=back
2095
2096=head2 The C<urxvt::pw> Class
2097
2098This class implements process watchers. They create an event whenever a
2099process exits, after which they stop automatically.
2100
2101 my $pid = fork;
2102 ...
2103 $term->{pw} = urxvt::pw
2104 ->new
2105 ->start ($pid)
2106 ->cb (sub {
2107 my ($pw, $exit_status) = @_;
2108 ...
2109 });
2110
2111=over 4
2112
2113=item $pw = new urxvt::pw
2114
2115Create a new process watcher in stopped state.
2116
2117=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2118
2119Set the callback to be called when the timer triggers.
2120
2121=item $pw = $timer->start ($pid)
2122
2123Tells the watcher to start watching for process C<$pid>.
2124
2125=item $pw = $pw->stop
2126
2127Stop the watcher.
1451 2128
1452=back 2129=back
1453 2130
1454=head1 ENVIRONMENT 2131=head1 ENVIRONMENT
1455 2132
1462 2139
1463=item == 0 - fatal messages 2140=item == 0 - fatal messages
1464 2141
1465=item >= 3 - script loading and management 2142=item >= 3 - script loading and management
1466 2143
1467=item >=10 - all events received 2144=item >=10 - all called hooks
2145
2146=item >=11 - hook return values
1468 2147
1469=back 2148=back
1470 2149
1471=head1 AUTHOR 2150=head1 AUTHOR
1472 2151
1473 Marc Lehmann <pcg@goof.com> 2152 Marc Lehmann <schmorp@schmorp.de>
1474 http://software.schmorp.de/pkg/rxvt-unicode 2153 http://software.schmorp.de/pkg/rxvt-unicode
1475 2154
1476=cut 2155=cut
1477 2156
14781 21571
2158
2159# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines