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.70 by root, Mon Jan 9 23:00:07 2006 UTC vs.
Revision 1.227 by root, Sun Mar 31 20:30:32 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
264and calling C<< $term->scr_add_lines >> yourself. Please note that this 245and calling C<< $term->scr_add_lines >> yourself. Please note that this
265might be very slow, however, as your hook is called for B<all> text being 246might be very slow, however, as your hook is called for B<all> text being
266output. 247output.
267 248
249=item on_tt_write $term, $octets
250
251Called whenever some data is written to the tty/pty and can be used to
252suppress or filter tty input.
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
268=item on_line_update $term, $row 261=item on_line_update $term, $row
269 262
270Called 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
271screen output (e.g. underline urls or other useless stuff). Only lines 264screen output (e.g. underline urls or other useless stuff). Only lines
272that are being shown will be filtered, and, due to performance reasons, 265that are being shown will be filtered, and, due to performance reasons,
279later 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
280you cannot just toggle rendition bits, but only set them. 273you cannot just toggle rendition bits, but only set them.
281 274
282=item on_refresh_begin $term 275=item on_refresh_begin $term
283 276
284Called just before the screen gets redrawn. Can be used for overlay 277Called just before the screen gets redrawn. Can be used for overlay or
285or similar effects by modify terminal contents in refresh_begin, and 278similar effects by modifying the terminal contents in refresh_begin, and
286restoring them in refresh_end. The built-in overlay and selection display 279restoring them in refresh_end. The built-in overlay and selection display
287code is run after this hook, and takes precedence. 280code is run after this hook, and takes precedence.
288 281
289=item on_refresh_end $term 282=item on_refresh_end $term
290 283
291Called just after the screen gets redrawn. See C<on_refresh_begin>. 284Called just after the screen gets redrawn. See C<on_refresh_begin>.
292 285
293=item on_keyboard_command $term, $string 286=item on_user_command $term, $string
294 287
295Called whenever the user presses a key combination that has a 288Called whenever a user-configured event is being activated (e.g. via
296C<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>
297resource 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.
298 317
299=item on_focus_in $term 318=item on_focus_in $term
300 319
301Called whenever the window gets the keyboard focus, before rxvt-unicode 320Called whenever the window gets the keyboard focus, before rxvt-unicode
302does focus in processing. 321does focus in processing.
303 322
304=item on_focus_out $term 323=item on_focus_out $term
305 324
306Called wheneever the window loses keyboard focus, before rxvt-unicode does 325Called whenever the window loses keyboard focus, before rxvt-unicode does
307focus out processing. 326focus out processing.
308 327
328=item on_configure_notify $term, $event
329
330=item on_property_notify $term, $event
331
309=item on_key_press $term, $event, $keysym, $octets 332=item on_key_press $term, $event, $keysym, $octets
310 333
311=item on_key_release $term, $event, $keysym 334=item on_key_release $term, $event, $keysym
312 335
313=item on_button_press $term, $event 336=item on_button_press $term, $event
318 341
319=item on_map_notify $term, $event 342=item on_map_notify $term, $event
320 343
321=item on_unmap_notify $term, $event 344=item on_unmap_notify $term, $event
322 345
323Called whenever the corresponding X event is received for the terminal If 346Called whenever the corresponding X event is received for the terminal. If
324the 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.
325 348
326The 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
327manpage), 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
328and column under the mouse cursor. 351(real, not screen-based) row and column under the mouse cursor.
329 352
330C<on_key_press> additionally receives the string rxvt-unicode would 353C<on_key_press> additionally receives the string rxvt-unicode would
331output, if any, in locale-specific encoding. 354output, if any, in locale-specific encoding.
332 355
333subwindow. 356subwindow.
334 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
335=back 371=back
336 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
337=head2 Variables in the C<urxvt> Package 398=head2 Variables in the C<urxvt> Package
338 399
339=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>.
340 414
341=item $urxvt::TERM 415=item $urxvt::TERM
342 416
343The current terminal. This variable stores the current C<urxvt::term> 417The current terminal. This variable stores the current C<urxvt::term>
344object, whenever a callback/hook is executing. 418object, whenever a callback/hook is executing.
345 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
346=back 436=back
347 437
348=head2 Functions in the C<urxvt> Package 438=head2 Functions in the C<urxvt> Package
349 439
350=over 4 440=over 4
351 441
352=item $term = new urxvt [arg...]
353
354Creates a new terminal, very similar as if you had started it with
355C<system $binfile, arg...>. Croaks (and probably outputs an error message)
356if the new instance couldn't be created. Returns C<undef> if the new
357instance didn't initialise perl, and the terminal object otherwise. The
358C<init> and C<start> hooks will be called during the call.
359
360=item urxvt::fatal $errormessage 442=item urxvt::fatal $errormessage
361 443
362Fatally aborts execution with the given error message. Avoid at all 444Fatally aborts execution with the given error message (which should
363costs! The only time this is acceptable is when the terminal process 445include a trailing newline). Avoid at all costs! The only time this
364starts up. 446is acceptable (and useful) is in the init hook, where it prevents the
447terminal from starting up.
365 448
366=item urxvt::warn $string 449=item urxvt::warn $string
367 450
368Calls 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
369newline. The module also overwrites the C<warn> builtin with a function 452newline. The module also overwrites the C<warn> builtin with a function
370that calls this function. 453that calls this function.
371 454
372Using 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
373correct place, e.g. on stderr of the connecting urxvtc client. 456correct place, e.g. on stderr of the connecting urxvtc client.
374 457
375=item $is_safe = urxvt::safe 458Messages have a size limit of 1023 bytes currently.
376 459
377Returns true when it is safe to do potentially unsafe things, such as 460=item @terms = urxvt::termlist
378evaluating perl code specified by the user. This is true when urxvt was 461
379started 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).
380 466
381=item $time = urxvt::NOW 467=item $time = urxvt::NOW
382 468
383Returns the "current time" (as per the event loop). 469Returns the "current time" (as per the event loop).
384 470
385=item urxvt::CurrentTime 471=item urxvt::CurrentTime
386 472
387=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 473=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
388Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 474Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
389Button4Mask, 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
390 492
391Various constants for use in X calls and event processing. 493Various constants for use in X calls and event processing.
392 494
393=back 495=back
394 496
411 513
412=item $rend = urxvt::OVERLAY_RSTYLE 514=item $rend = urxvt::OVERLAY_RSTYLE
413 515
414Return the rendition mask used for overlays by default. 516Return the rendition mask used for overlays by default.
415 517
416=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
417 520
418Return the bit that enabled bold, italic, blink, reverse-video and 521Return the bit that enabled bold, italic, blink, reverse-video and
419underline, respectively. To enable such a style, just logically OR it into 522underline, respectively. To enable such a style, just logically OR it into
420the bitset. 523the bitset.
421 524
423 526
424=item $background = urxvt::GET_BASEBG $rend 527=item $background = urxvt::GET_BASEBG $rend
425 528
426Return the foreground/background colour index, respectively. 529Return the foreground/background colour index, respectively.
427 530
428=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 531=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
429 532
430=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
431 536
432Replace the foreground/background colour in the rendition mask with the 537Replace the foreground/background colour in the rendition mask with the
433specified one. 538specified one.
434 539
435=item $value = urxvt::GET_CUSTOM ($rend) 540=item $value = urxvt::GET_CUSTOM $rend
436 541
437Return the "custom" value: Every rendition has 5 bits for use by 542Return the "custom" value: Every rendition has 5 bits for use by
438extensions. 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
439zero. 544zero.
440 545
441=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 546=item $rend = urxvt::SET_CUSTOM $rend, $new_value
442 547
443Change the custom value. 548Change the custom value.
444 549
445=back 550=back
446 551
447=cut 552=cut
448 553
449package urxvt;
450
451use utf8;
452use strict;
453use Carp ();
454use Scalar::Util ();
455use List::Util ();
456
457our $VERSION = 1;
458our $TERM;
459our @HOOKNAME;
460our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461our %OPTION;
462our $LIBDIR;
463
464BEGIN { 554BEGIN {
465 urxvt->bootstrap;
466
467 # overwrite perl's warn 555 # overwrite perl's warn
468 *CORE::GLOBAL::warn = sub { 556 *CORE::GLOBAL::warn = sub {
469 my $msg = join "", @_; 557 my $msg = join "", @_;
470 $msg .= "\n" 558 $msg .= "\n"
471 unless $msg =~ /\n$/; 559 unless $msg =~ /\n$/;
472 urxvt::warn ($msg); 560 urxvt::warn ($msg);
473 }; 561 };
474
475 delete $ENV{IFS};
476 delete $ENV{CDPATH};
477 delete $ENV{BASH_ENV};
478 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
479} 562}
480 563
481my @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; # reste 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
482my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 626my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
483 627
484sub verbose { 628sub verbose {
485 my ($level, $msg) = @_; 629 my ($level, $msg) = @_;
486 warn "$msg\n" if $level <= $verbosity; 630 warn "$msg\n" if $level <= $verbosity;
487} 631}
488 632
489my $extension_pkg = "extension0000";
490my %extension_pkg; 633my %extension_pkg;
491 634
492# load a single script into its own package, once only 635# load a single script into its own package, once only
493sub extension_package($) { 636sub extension_package($) {
494 my ($path) = @_; 637 my ($path) = @_;
495 638
496 $extension_pkg{$path} ||= do { 639 $extension_pkg{$path} ||= do {
497 my $pkg = "urxvt::" . ($extension_pkg++); 640 $path =~ /([^\/\\]+)$/;
641 my $pkg = $1;
642 $pkg =~ s/[^[:word:]]/_/g;
643 $pkg = "urxvt::ext::$pkg";
498 644
499 verbose 3, "loading extension '$path' into package '$pkg'"; 645 verbose 3, "loading extension '$path' into package '$pkg'";
646
647 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
500 648
501 open my $fh, "<:raw", $path 649 open my $fh, "<:raw", $path
502 or die "$path: $!"; 650 or die "$path: $!";
503 651
504 my $source = untaint 652 my $source =
505 "package $pkg; use strict; use utf8;\n" 653 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
506 . "use base urxvt::term::proxy::;\n"
507 . "#line 1 \"$path\"\n{\n" 654 . "#line 1 \"$path\"\n{\n"
508 . (do { local $/; <$fh> }) 655 . (do { local $/; <$fh> })
509 . "\n};\n1"; 656 . "\n};\n1";
510 657
511 eval $source 658 eval $source
521sub invoke { 668sub invoke {
522 local $TERM = shift; 669 local $TERM = shift;
523 my $htype = shift; 670 my $htype = shift;
524 671
525 if ($htype == 0) { # INIT 672 if ($htype == 0) { # INIT
526 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 673 my @dirs = $TERM->perl_libdirs;
527 674
528 my %ext_arg; 675 my %ext_arg;
529 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} },
530 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 688 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689 ) {
531 if ($_ eq "default") { 690 if ($_ eq "default") {
532 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 691 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
533 } elsif (/^-(.*)$/) { 692 } elsif (/^-(.*)$/) {
534 delete $ext_arg{$1}; 693 delete $ext_arg{$1};
535 } elsif (/^([^<]+)<(.*)>$/) { 694 } elsif (/^([^<]+)<(.*)>$/) {
536 push @{ $ext_arg{$1} }, $2; 695 push @{ $ext_arg{$1} }, $2;
537 } else { 696 } else {
538 $ext_arg{$_} ||= []; 697 $ext_arg{$_} ||= [];
539 } 698 }
540 } 699 }
541 700
542 while (my ($ext, $argv) = each %ext_arg) { 701 for my $ext (sort keys %ext_arg) {
543 my @files = grep -f $_, map "$_/$ext", @dirs; 702 my @files = grep -f $_, map "$_/$ext", @dirs;
544 703
545 if (@files) { 704 if (@files) {
546 $TERM->register_package (extension_package $files[0], $argv); 705 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
547 } else { 706 } else {
548 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";
549 } 708 }
550 } 709 }
551 710
557 716
558 if (my $cb = $TERM->{_hook}[$htype]) { 717 if (my $cb = $TERM->{_hook}[$htype]) {
559 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
560 if $verbosity >= 10; 719 if $verbosity >= 10;
561 720
562 keys %$cb; 721 for my $pkg (keys %$cb) {
563
564 while (my ($pkg, $cb) = each %$cb) {
565 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
566 and last; 723 $retval ||= $retval_;
567 724
568 if ($@) { 725 if ($@) {
569 $TERM->ungrab; # better to lose the grab than the session 726 $TERM->ungrab; # better to lose the grab than the session
570 warn $@; 727 warn $@;
571 } 728 }
572 } 729 }
730
731 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732 if $verbosity >= 11;
573 } 733 }
574 734
575 if ($htype == 1) { # DESTROY 735 if ($htype == 1) { # DESTROY
576 if (my $hook = delete $TERM->{_hook}) {
577 for my $htype (0..$#$hook) {
578 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
579 or set_should_invoke $htype, 0;
580 }
581 }
582
583 # clear package objects 736 # clear package objects
584 %$_ = () for values %{ $TERM->{_pkg} }; 737 %$_ = () for values %{ $TERM->{_pkg} };
585 738
586 # clear package 739 # clear package
587 %$TERM = (); 740 %$TERM = ();
588 } 741 }
589 742
590 $retval 743 $retval
591} 744}
592 745
593# urxvt::term::proxy 746sub SET_COLOR($$$) {
747 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
748}
594 749
595package urxvt::term::proxy; 750sub rend2mask {
596 751 no strict 'refs';
597sub enable { 752 my ($str, $mask) = (@_, 0);
598 my ($self, %hook) = @_; 753 my %color = ( fg => undef, bg => undef );
599 my $pkg = $self->{_pkg}; 754 my @failed;
600 755 for my $spec ( split /\s+/, $str ) {
601 while (my ($name, $cb) = each %hook) { 756 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
602 my $htype = $HOOKTYPE{uc $name}; 757 $color{lc($1)} = $2;
603 defined $htype 758 } else {
604 or Carp::croak "unsupported hook type '$name'"; 759 my $neg = $spec =~ s/^[-^]//;
605 760 unless ( exists &{"RS_$spec"} ) {
606 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 761 push @failed, $spec;
607 $hook_count[$htype]++ 762 next;
608 or urxvt::set_should_invoke $htype, 1;
609 } 763 }
610 764 my $cur = &{"RS_$spec"};
611 $self->{term}{_hook}[$htype]{$pkg} = $cb; 765 if ( $neg ) {
612 } 766 $mask &= ~$cur;
613} 767 } else {
614 768 $mask |= $cur;
615sub disable { 769 }
616 my ($self, @hook) = @_;
617 my $pkg = $self->{_pkg};
618
619 for my $name (@hook) {
620 my $htype = $HOOKTYPE{uc $name};
621 defined $htype
622 or Carp::croak "unsupported hook type '$name'";
623
624 if (delete $self->{term}{_hook}[$htype]{$pkg}) {
625 --$hook_count[$htype]
626 or urxvt::set_should_invoke $htype, 0;
627 } 770 }
628 } 771 }
772 ($mask, @color{qw(fg bg)}, \@failed)
629} 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
630 797
631our $AUTOLOAD; 798our $AUTOLOAD;
632 799
633sub AUTOLOAD { 800sub AUTOLOAD {
634 $AUTOLOAD =~ /:([^:]+)$/ 801 $AUTOLOAD =~ /:([^:]+)$/
647 814
648sub DESTROY { 815sub DESTROY {
649 # nop 816 # nop
650} 817}
651 818
652# urxvt::destroy_hook 819# urxvt::destroy_hook (basically a cheap Guard:: implementation)
653 820
654sub urxvt::destroy_hook::DESTROY { 821sub urxvt::destroy_hook::DESTROY {
655 ${$_[0]}->(); 822 ${$_[0]}->();
656} 823}
657 824
658sub urxvt::destroy_hook(&) { 825sub urxvt::destroy_hook(&) {
659 bless \shift, urxvt::destroy_hook:: 826 bless \shift, urxvt::destroy_hook::
660} 827}
661 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
662package urxvt::anyevent; 940package urxvt::anyevent;
663 941
664=head2 The C<urxvt::anyevent> Class 942=head2 The C<urxvt::anyevent> Class
665 943
666The 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
667C<AnyEvent> module - any module using it will work inside urxvt without 945C<AnyEvent> module - any module using it will work inside urxvt without
668further work. The only exception is that you cannot wait on condition 946further programming. The only exception is that you cannot wait on
669variables, but non-blocking condvar use is ok. What this means is that you 947condition variables, but non-blocking condvar use is ok.
670cannot use blocking APIs, but the non-blocking variant should work.
671 948
672=cut 949In practical terms this means is that you cannot use blocking APIs, but
950the non-blocking variant should work.
673 951
952=cut
953
674our $VERSION = 1; 954our $VERSION = '5.23';
675 955
676$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 956$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
677push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 957push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
678 958
679sub timer { 959sub timer {
681 961
682 my $cb = $arg{cb}; 962 my $cb = $arg{cb};
683 963
684 urxvt::timer 964 urxvt::timer
685 ->new 965 ->new
686 ->start (urxvt::NOW + $arg{after}) 966 ->after ($arg{after}, $arg{interval})
687 ->cb (sub { 967 ->cb ($arg{interval} ? $cb : sub {
688 $_[0]->stop; # need to cancel manually 968 $_[0]->stop; # need to cancel manually
689 $cb->(); 969 $cb->();
690 }) 970 })
691} 971}
692 972
693sub io { 973sub io {
694 my ($class, %arg) = @_; 974 my ($class, %arg) = @_;
695 975
696 my $cb = $arg{cb}; 976 my $cb = $arg{cb};
977 my $fd = fileno $arg{fh};
978 defined $fd or $fd = $arg{fh};
697 979
698 bless [$arg{fh}, urxvt::iow 980 bless [$arg{fh}, urxvt::iow
699 ->new 981 ->new
700 ->fd (fileno $arg{fh}) 982 ->fd ($fd)
701 ->events (($arg{poll} =~ /r/ ? 1 : 0) 983 ->events (($arg{poll} =~ /r/ ? 1 : 0)
702 | ($arg{poll} =~ /w/ ? 2 : 0)) 984 | ($arg{poll} =~ /w/ ? 2 : 0))
703 ->start 985 ->start
704 ->cb (sub { 986 ->cb ($cb)
705 $cb->(($_[1] & 1 ? 'r' : '')
706 . ($_[1] & 2 ? 'w' : ''));
707 })],
708 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 })
709} 1013}
710 1014
711sub DESTROY { 1015sub DESTROY {
712 $_[0][1]->stop; 1016 $_[0][1]->stop;
713} 1017}
714 1018
715sub condvar { 1019# only needed for AnyEvent < 6 compatibility
716 bless \my $flag, urxvt::anyevent::condvar:: 1020sub one_event {
717}
718
719sub urxvt::anyevent::condvar::broadcast {
720 ${$_[0]}++;
721}
722
723sub urxvt::anyevent::condvar::wait {
724 unless (${$_[0]}) {
725 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";
726 }
727} 1022}
728 1023
729package urxvt::term; 1024package urxvt::term;
730 1025
731=head2 The C<urxvt::term> Class 1026=head2 The C<urxvt::term> Class
737# find on_xxx subs in the package and register them 1032# find on_xxx subs in the package and register them
738# as hooks 1033# as hooks
739sub register_package { 1034sub register_package {
740 my ($self, $pkg, $argv) = @_; 1035 my ($self, $pkg, $argv) = @_;
741 1036
1037 no strict 'refs';
1038
1039 urxvt::verbose 6, "register package $pkg to $self";
1040
1041 @{"$pkg\::ISA"} = urxvt::term::extension::;
1042
742 my $proxy = bless { 1043 my $proxy = bless {
743 _pkg => $pkg, 1044 _pkg => $pkg,
1045 _name => ${"$pkg\::_NAME"}, # hackish
744 argv => $argv, 1046 argv => $argv,
745 }, $pkg; 1047 }, $pkg;
746 Scalar::Util::weaken ($proxy->{term} = $self); 1048 Scalar::Util::weaken ($proxy->{term} = $self);
747 1049
748 $self->{_pkg}{$pkg} = $proxy; 1050 $self->{_pkg}{$pkg} = $proxy;
749 1051
752 $proxy->enable ($name => $ref); 1054 $proxy->enable ($name => $ref);
753 } 1055 }
754 } 1056 }
755} 1057}
756 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
757=item $term->destroy 1128=item $term->destroy
758 1129
759Destroy 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}
760 1158
761=item $isset = $term->option ($optval[, $set]) 1159=item $isset = $term->option ($optval[, $set])
762 1160
763Returns true if the option specified by C<$optval> is enabled, and 1161Returns true if the option specified by C<$optval> is enabled, and
764optionally 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
765C<%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.
766 1164
767Here 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
768source file F</src/optinc.h> to see the actual list: 1166source file F</src/optinc.h> to see the actual list:
769 1167
770 borderLess console cursorBlink cursorUnderline hold iconic insecure 1168 borderLess buffered console cursorBlink cursorUnderline hold iconic
771 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1169 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1170 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
772 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1171 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
773 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1172 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
774 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1173 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
775 tripleclickwords utmpInhibit visualBell 1174 urgentOnBell utmpInhibit visualBell
776 1175
777=item $value = $term->resource ($name[, $newval]) 1176=item $value = $term->resource ($name[, $newval])
778 1177
779Returns the current resource value associated with a given name and 1178Returns the current resource value associated with a given name and
780optionally 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>
789likely change). 1188likely change).
790 1189
791Please note that resource strings will currently only be freed when the 1190Please note that resource strings will currently only be freed when the
792terminal is destroyed, so changing options frequently will eat memory. 1191terminal is destroyed, so changing options frequently will eat memory.
793 1192
794Here 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
795are 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>
796to see the actual list: 1195to see the actual list:
797 1196
798 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1197 answerbackstring backgroundPixmap backspace_key blurradius
799 borderLess color cursorBlink cursorUnderline cutchars delete_key 1198 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
800 display_name embed ext_bwidth fade font geometry hold iconName 1199 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
801 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
802 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1202 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
803 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1203 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
804 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1204 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
805 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1205 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
806 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1206 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
807 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1207 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
808 shade term_name title transparent transparent_all tripleclickwords 1208 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1209 term_name title transient_for transparent tripleclickwords urgentOnBell
809 utmpInhibit visualBell 1210 utmpInhibit visualBell
810 1211
811=cut 1212=cut
812 1213
813sub resource($$;$) { 1214sub resource($$;$) {
814 my ($self, $name) = (shift, shift); 1215 my ($self, $name) = (shift, shift);
815 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1216 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
816 &urxvt::term::_resource 1217 goto &urxvt::term::_resource
817} 1218}
818 1219
819=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1220=item $value = $term->x_resource ($pattern)
820 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
821Adds a keymap translation exactly as specified via a resource. See the 1259Adds a key binding exactly as specified via a resource. See the
822C<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.
823 1268
824=item $rend = $term->rstyle ([$new_rstyle]) 1269=item $rend = $term->rstyle ([$new_rstyle])
825 1270
826Return and optionally change the current rendition. Text that is output by 1271Return and optionally change the current rendition. Text that is output by
827the terminal application will use this style. 1272the terminal application will use this style.
835 1280
836=item ($row, $col) = $term->selection_beg ([$row, $col]) 1281=item ($row, $col) = $term->selection_beg ([$row, $col])
837 1282
838=item ($row, $col) = $term->selection_end ([$row, $col]) 1283=item ($row, $col) = $term->selection_end ([$row, $col])
839 1284
840Return the current values of the selection mark, begin or end positions, 1285Return the current values of the selection mark, begin or end positions.
841and optionally set them to new values.
842 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
843=item $success = $term->selection_grab ($eventtime) 1302=item $success = $term->selection_grab ($eventtime[, $clipboard])
844 1303
845Try to request the primary selection from the server (for example, as set 1304Try to acquire ownership of the primary (clipboard if C<$clipboard> is
846by 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.
847 1308
848=item $oldtext = $term->selection ([$newtext]) 1309=item $oldtext = $term->selection ([$newtext, $clipboard])
849 1310
850Return 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.
851 1317
852=item $term->overlay_simple ($x, $y, $text) 1318=item $term->overlay_simple ($x, $y, $text)
853 1319
854Create 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.
855 1321
885 1351
886The methods currently supported on C<urxvt::overlay> objects are: 1352The methods currently supported on C<urxvt::overlay> objects are:
887 1353
888=over 4 1354=over 4
889 1355
890=item $overlay->set ($x, $y, $text, $rend) 1356=item $overlay->set ($x, $y, $text[, $rend])
891 1357
892Similar 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
893text 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
894at 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.
895 1363
896=item $overlay->hide 1364=item $overlay->hide
897 1365
898If visible, hide the overlay, but do not destroy it. 1366If visible, hide the overlay, but do not destroy it.
899 1367
944Convert the given locale-encoded octets into a perl string. 1412Convert the given locale-encoded octets into a perl string.
945 1413
946=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])
947 1415
948XORs the rendition values in the given span with the provided value 1416XORs the rendition values in the given span with the provided value
949(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
950to the selection. 1418refresh hooks to provide effects similar to the selection.
951 1419
952=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]])
953 1421
954Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1422Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
955whitespace will additionally be xored with the C<$rstyle2>, which defaults 1423whitespace will additionally be xored with the C<$rstyle2>, which defaults
956to 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
957it instead. 1425it instead. Both styles I<MUST NOT> contain font styles.
958 1426
959=item $term->scr_bell 1427=item $term->scr_bell
960 1428
961Ring the bell! 1429Ring the bell!
962 1430
969 1437
970Normally 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
971confused by changes in cursor position or scrolling. Its useful inside a 1439confused by changes in cursor position or scrolling. Its useful inside a
972C<on_add_lines> hook, though. 1440C<on_add_lines> hook, though.
973 1441
1442=item $term->scr_change_screen ($screen)
1443
1444Switch to given screen - 0 primary, 1 secondary.
1445
974=item $term->cmd_parse ($octets) 1446=item $term->cmd_parse ($octets)
975 1447
976Similar 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
977locale-specific encoding of the terminal and can contain command sequences 1449locale-specific encoding of the terminal and can contain command sequences
978(escape codes) that will be interpreted. 1450(escape codes) that will be interpreted.
979 1451
980=item $term->tt_write ($octets) 1452=item $term->tt_write ($octets)
981 1453
982Write 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
983pass characters instead of octets, you should convert your strings first 1455pass characters instead of octets, you should convert your strings first
984to 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.
985 1463
986=item $old_events = $term->pty_ev_events ([$new_events]) 1464=item $old_events = $term->pty_ev_events ([$new_events])
987 1465
988Replaces 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
989be 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
990description of C<< urxvt::timer->events >>. Make sure to always restore 1468description of C<< urxvt::timer->events >>. Make sure to always restore
991the previous value. 1469the previous value.
992 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
993=item $windowid = $term->parent 1476=item $windowid = $term->parent
994 1477
995Return the window id of the toplevel window. 1478Return the window id of the toplevel window.
996 1479
997=item $windowid = $term->vt 1480=item $windowid = $term->vt
998 1481
999Return the window id of the terminal window. 1482Return the window id of the terminal window.
1000 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
1001=item $window_width = $term->width 1505=item $window_width = $term->width
1002 1506
1003=item $window_height = $term->height 1507=item $window_height = $term->height
1004 1508
1005=item $font_width = $term->fwidth 1509=item $font_width = $term->fwidth
1018 1522
1019=item $max_scrollback = $term->saveLines 1523=item $max_scrollback = $term->saveLines
1020 1524
1021=item $nrow_plus_saveLines = $term->total_rows 1525=item $nrow_plus_saveLines = $term->total_rows
1022 1526
1023=item $lines_in_scrollback = $term->nsaved 1527=item $topmost_scrollback_row = $term->top_row
1024 1528
1025Return various integers describing terminal characteristics. 1529Return various integers describing terminal characteristics.
1026 1530
1531=item $x_display = $term->display_id
1532
1533Return the DISPLAY used by rxvt-unicode.
1534
1027=item $lc_ctype = $term->locale 1535=item $lc_ctype = $term->locale
1028 1536
1029Returns the LC_CTYPE category string used by this rxvt-unicode. 1537Returns the LC_CTYPE category string used by this rxvt-unicode.
1030 1538
1031=item $x_display = $term->display_id 1539=item $env = $term->env
1032 1540
1033Return 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}
1034 1558
1035=item $modifiermask = $term->ModLevel3Mask 1559=item $modifiermask = $term->ModLevel3Mask
1036 1560
1037=item $modifiermask = $term->ModMetaMask 1561=item $modifiermask = $term->ModMetaMask
1038 1562
1039=item $modifiermask = $term->ModNumLockMask 1563=item $modifiermask = $term->ModNumLockMask
1040 1564
1041Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1565Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1042AltGr), 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.
1043 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
1044=item $view_start = $term->view_start ([$newvalue]) 1576=item $view_start = $term->view_start ([$newvalue])
1045 1577
1046Returns the negative row number of the topmost line. Minimum value is 1578Returns the row number of the topmost displayed line. Maximum value is
1047C<0>, which displays the normal terminal contents. Larger values scroll 1579C<0>, which displays the normal terminal contents. Lower values scroll
1048this many lines into the scrollback buffer. 1580this many lines into the scrollback buffer.
1049 1581
1050=item $term->want_refresh 1582=item $term->want_refresh
1051 1583
1052Requests a screen refresh. At the next opportunity, rxvt-unicode will 1584Requests a screen refresh. At the next opportunity, rxvt-unicode will
1055 1587
1056Used after changing terminal contents to display them. 1588Used after changing terminal contents to display them.
1057 1589
1058=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1590=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1059 1591
1060Returns 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 >>
1061is 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
1062terminal line. The scrollback buffer starts at line C<-1> and extends to
1063line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1594terminal line. Nothing will be returned if a nonexistent line
1064is requested. 1595is requested.
1065 1596
1066If 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
1067line, 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
1068to 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
1069automatically be updated. 1600automatically be updated.
1070 1601
1071C<$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
1072than one cell when displayed are padded with urxvt::NOCHAR characters 1603than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1073(C<chr 65535>). Characters with combining characters and other characters 1604characters. Characters with combining characters and other characters that
1074that 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
1075characters in the private use area. 1606in the private use area.
1076 1607
1077You have to obey this encoding when changing text. The advantage is 1608You have to obey this encoding when changing text. The advantage is
1078that 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
1079characters. 1610characters.
1080 1611
1131Return 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.
1132 1663
1133=item $offset = $line->offset_of ($row, $col) 1664=item $offset = $line->offset_of ($row, $col)
1134 1665
1135Returns 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
1136line. 1667line. Works for rows outside the line, too, and returns corresponding
1668offsets outside the string.
1137 1669
1138=item ($row, $col) = $line->coord_of ($offset) 1670=item ($row, $col) = $line->coord_of ($offset)
1139 1671
1140Translates a string offset into terminal coordinates again. 1672Translates a string offset into terminal coordinates again.
1141 1673
1163} 1695}
1164 1696
1165sub urxvt::line::t { 1697sub urxvt::line::t {
1166 my ($self) = @_; 1698 my ($self) = @_;
1167 1699
1168 if (@_ > 1) 1700 if (@_ > 1) {
1169 {
1170 $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})
1171 for $self->{beg} .. $self->{end}; 1702 for $self->{beg} .. $self->{end};
1172 } 1703 }
1173 1704
1174 defined wantarray && 1705 defined wantarray &&
1175 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1706 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1176 0, $self->{len} 1707 0, $self->{len}
1177} 1708}
1178 1709
1179sub urxvt::line::r { 1710sub urxvt::line::r {
1180 my ($self) = @_; 1711 my ($self) = @_;
1181 1712
1182 if (@_ > 1) 1713 if (@_ > 1) {
1183 {
1184 $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})
1185 for $self->{beg} .. $self->{end}; 1715 for $self->{beg} .. $self->{end};
1186 } 1716 }
1187 1717
1188 if (defined wantarray) { 1718 if (defined wantarray) {
1189 my $rend = [ 1719 my $rend = [
1190 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1720 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1191 ]; 1721 ];
1223where one character corresponds to one screen cell. See 1753where one character corresponds to one screen cell. See
1224C<< $term->ROW_t >> for details. 1754C<< $term->ROW_t >> for details.
1225 1755
1226=item $string = $term->special_decode $text 1756=item $string = $term->special_decode $text
1227 1757
1228Converts rxvt-unicodes text reprsentation into a perl string. See 1758Converts rxvt-unicodes text representation into a perl string. See
1229C<< $term->ROW_t >> for details. 1759C<< $term->ROW_t >> for details.
1230 1760
1231=item $success = $term->grab_button ($button, $modifiermask) 1761=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1232 1762
1763=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1764
1233Registers a synchronous button grab. See the XGrabButton manpage. 1765Register/unregister a synchronous button grab. See the XGrabButton
1766manpage.
1234 1767
1235=item $success = $term->grab ($eventtime[, $sync]) 1768=item $success = $term->grab ($eventtime[, $sync])
1236 1769
1237Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1770Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1238synchronous (C<$sync> is true). Also remembers the grab timestampe. 1771synchronous (C<$sync> is true). Also remembers the grab timestamp.
1239 1772
1240=item $term->allow_events_async 1773=item $term->allow_events_async
1241 1774
1242Calls XAllowEvents with AsyncBoth for the most recent grab. 1775Calls XAllowEvents with AsyncBoth for the most recent grab.
1243 1776
1250Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1783Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1251recent grab. 1784recent grab.
1252 1785
1253=item $term->ungrab 1786=item $term->ungrab
1254 1787
1255Calls XUngrab for the most recent grab. Is called automatically on 1788Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1256evaluation 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
1257the 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.
1258 1825
1259=back 1826=back
1260 1827
1261=cut 1828=cut
1262 1829
1277 1844
1278 $item->{render} ||= sub { $_[0]{text} }; 1845 $item->{render} ||= sub { $_[0]{text} };
1279 1846
1280 push @{ $self->{item} }, $item; 1847 push @{ $self->{item} }, $item;
1281} 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
1282 1871
1283sub add_separator { 1872sub add_separator {
1284 my ($self, $sep) = @_; 1873 my ($self, $sep) = @_;
1285 1874
1286 $sep ||= "="; 1875 $sep ||= "=";
1291 render => sub { $sep x $self->{term}->ncol }, 1880 render => sub { $sep x $self->{term}->ncol },
1292 activate => sub { }, 1881 activate => sub { },
1293 }); 1882 });
1294} 1883}
1295 1884
1296sub add_title { 1885=item $popup->add_button ($text, $cb)
1297 my ($self, $title) = @_;
1298 1886
1299 $self->add_item ({ 1887Adds a clickable button to the popup. C<$cb> is called whenever it is
1300 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1888selected.
1301 text => $title, 1889
1302 activate => sub { }, 1890=cut
1303 });
1304}
1305 1891
1306sub add_button { 1892sub add_button {
1307 my ($self, $text, $cb) = @_; 1893 my ($self, $text, $cb) = @_;
1308 1894
1309 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1895 $self->add_item ({ type => "button", text => $text, activate => $cb});
1310} 1896}
1311 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
1312sub add_toggle { 1906sub add_toggle {
1313 my ($self, $text, $cb, $value) = @_; 1907 my ($self, $text, $value, $cb) = @_;
1314 1908
1315 my $item; $item = { 1909 my $item; $item = {
1316 type => "button", 1910 type => "button",
1317 text => " $text", 1911 text => " $text",
1318 value => $value, 1912 value => $value,
1319 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1913 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1914 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321 }; 1915 };
1322 1916
1323 $self->add_item ($item); 1917 $self->add_item ($item);
1324} 1918}
1919
1920=item $popup->show
1921
1922Displays the popup (which is initially hidden).
1923
1924=cut
1325 1925
1326sub show { 1926sub show {
1327 my ($self) = @_; 1927 my ($self) = @_;
1328 1928
1329 local $urxvt::popup::self = $self; 1929 local $urxvt::popup::self = $self;
1330 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};
1331 local $ENV{LC_ALL} = $self->{term}->locale; 1934 $env->{LC_CTYPE} = $self->{term}->locale;
1332 1935
1333 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",
1334 "--transient-for" => $self->{term}->parent, 1941 "--transient-for" => $self->{term}->parent,
1335 "-display" => $self->{term}->display_id, 1942 "-display" => $self->{term}->display_id,
1336 "-pe" => "urxvt-popup") 1943 "-pe" => "urxvt-popup",
1337 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 }
1338} 1951}
1339 1952
1340sub DESTROY { 1953sub DESTROY {
1341 my ($self) = @_; 1954 my ($self) = @_;
1342 1955
1343 delete $self->{term}{_destroy}{$self}; 1956 delete $self->{term}{_destroy}{$self};
1344 $self->{term}->ungrab; 1957 $self->{term}->ungrab;
1345} 1958}
1959
1960=back
1961
1962=cut
1963
1964package urxvt::watcher;
1346 1965
1347=head2 The C<urxvt::timer> Class 1966=head2 The C<urxvt::timer> Class
1348 1967
1349This class implements timer watchers/events. Time is represented as a 1968This class implements timer watchers/events. Time is represented as a
1350fractional number of seconds since the epoch. Example: 1969fractional number of seconds since the epoch. Example:
1354 ->new 1973 ->new
1355 ->interval (1) 1974 ->interval (1)
1356 ->cb (sub { 1975 ->cb (sub {
1357 $term->{overlay}->set (0, 0, 1976 $term->{overlay}->set (0, 0,
1358 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1977 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1359 }); 1978 });
1360 1979
1361=over 4 1980=over 4
1362 1981
1363=item $timer = new urxvt::timer 1982=item $timer = new urxvt::timer
1364 1983
1367 1986
1368=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1987=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1369 1988
1370Set the callback to be called when the timer triggers. 1989Set the callback to be called when the timer triggers.
1371 1990
1372=item $tstamp = $timer->at
1373
1374Return the time this watcher will fire next.
1375
1376=item $timer = $timer->set ($tstamp) 1991=item $timer = $timer->set ($tstamp[, $interval])
1377 1992
1378Set the time the event is generated to $tstamp. 1993Set the time the event is generated to $tstamp (and optionally specifies a
1994new $interval).
1379 1995
1380=item $timer = $timer->interval ($interval) 1996=item $timer = $timer->interval ($interval)
1381 1997
1382Normally (and when C<$interval> is C<0>), the timer will automatically 1998By default (and when C<$interval> is C<0>), the timer will automatically
1383stop 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
1384is automatically rescheduled at the given intervals. 2000is automatically rescheduled at the given intervals.
1385 2001
1386=item $timer = $timer->start 2002=item $timer = $timer->start
1387 2003
1388Start the timer. 2004Start the timer.
1389 2005
1390=item $timer = $timer->start ($tstamp) 2006=item $timer = $timer->start ($tstamp[, $interval])
1391 2007
1392Set 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>.
1393 2014
1394=item $timer = $timer->stop 2015=item $timer = $timer->stop
1395 2016
1396Stop the timer. 2017Stop the timer.
1397 2018
1403 2024
1404 $term->{socket} = ... 2025 $term->{socket} = ...
1405 $term->{iow} = urxvt::iow 2026 $term->{iow} = urxvt::iow
1406 ->new 2027 ->new
1407 ->fd (fileno $term->{socket}) 2028 ->fd (fileno $term->{socket})
1408 ->events (urxvt::EVENT_READ) 2029 ->events (urxvt::EV_READ)
1409 ->start 2030 ->start
1410 ->cb (sub { 2031 ->cb (sub {
1411 my ($iow, $revents) = @_; 2032 my ($iow, $revents) = @_;
1412 # $revents must be 1 here, no need to check 2033 # $revents must be 1 here, no need to check
1413 sysread $term->{socket}, my $buf, 8192 2034 sysread $term->{socket}, my $buf, 8192
1426Set 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>
1427is a bitset as described in the C<events> method. 2048is a bitset as described in the C<events> method.
1428 2049
1429=item $iow = $iow->fd ($fd) 2050=item $iow = $iow->fd ($fd)
1430 2051
1431Set the filedescriptor (not handle) to watch. 2052Set the file descriptor (not handle) to watch.
1432 2053
1433=item $iow = $iow->events ($eventmask) 2054=item $iow = $iow->events ($eventmask)
1434 2055
1435Set the event mask to watch. The only allowed values are 2056Set the event mask to watch. The only allowed values are
1436C<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
1437together, or C<urxvt::EVENT_NONE>. 2058together, or C<urxvt::EV_NONE>.
1438 2059
1439=item $iow = $iow->start 2060=item $iow = $iow->start
1440 2061
1441Start watching for requested events on the given handle. 2062Start watching for requested events on the given handle.
1442 2063
1443=item $iow = $iow->stop 2064=item $iow = $iow->stop
1444 2065
1445Stop 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.
1446 2128
1447=back 2129=back
1448 2130
1449=head1 ENVIRONMENT 2131=head1 ENVIRONMENT
1450 2132
1457 2139
1458=item == 0 - fatal messages 2140=item == 0 - fatal messages
1459 2141
1460=item >= 3 - script loading and management 2142=item >= 3 - script loading and management
1461 2143
1462=item >=10 - all events received 2144=item >=10 - all called hooks
2145
2146=item >=11 - hook return values
1463 2147
1464=back 2148=back
1465 2149
1466=head1 AUTHOR 2150=head1 AUTHOR
1467 2151
1468 Marc Lehmann <pcg@goof.com> 2152 Marc Lehmann <schmorp@schmorp.de>
1469 http://software.schmorp.de/pkg/rxvt-unicode 2153 http://software.schmorp.de/pkg/rxvt-unicode
1470 2154
1471=cut 2155=cut
1472 2156
14731 21571
2158
2159# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines