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.94 by root, Sun Jan 15 06:02:41 2006 UTC vs.
Revision 1.254 by sf-exg, Tue Mar 17 09:23:08 2015 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
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36A number of extensions are delivered with this release. You can find them
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 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
44(More) intelligent selection. This extension tries to be more intelligent 48Extensions may add additional resources and C<actions>, i.e., methods
45when the user extends selections (double-click and further clicks). Right 49which can be bound to a key and invoked by the user. An extension can
46now, it tries to select words, urls and complete shell-quoted 50define the resources it support using so called META comments,
47arguments, which is very convenient, too, if your F<ls> supports 51described below. Similarly to builtin resources, extension resources
48C<--quoting-style=shell>. 52can also be specified on the command line as long options (with C<.>
49 53replaced by C<->), in which case the corresponding extension is loaded
50A double-click usually selects the word under the cursor, further clicks 54automatically. For this to work the extension B<must> define META
51will enlarge the selection. 55comments for its resources.
52
53The selection works by trying to match a number of regexes and displaying
54them in increasing order of length. You can add your own regexes by
55specifying resources of the form:
56
57 URxvt.selection.pattern-0: perl-regex
58 URxvt.selection.pattern-1: perl-regex
59 ...
60
61The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything
64between two vertical bars:
65
66 URxvt.selection.pattern-0: \\|([^|]+)\\|
67
68You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end.
70
71This extension also offers the following bindable keyboard command:
72
73=over 4
74
75=item rot13
76
77Rot-13 the selection when activated. Used via keyboard trigger:
78
79 URxvt.keysym.C-M-r: perl:selection:rot13
80
81=back
82
83=item option-popup (enabled by default)
84
85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86runtime.
87
88=item selection-popup (enabled by default)
89
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content.
93
94=item searchable-scrollback<hotkey> (enabled by default)
95
96Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal
98input/output is suspended and a regex is displayed at the bottom of the
99screen.
100
101Inputting characters appends them to the regex and continues incremental
102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
108
109=item selection-autotransform
110
111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
124
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132Of course, this can be modified to suit your needs and your editor :)
133
134To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution:
136
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
139
140The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file.
143
144=item mark-urls
145
146Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument.
150
151=item block-graphics-to-ascii
152
153A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character.
156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
160
161=item example-refresh-hooks
162
163Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes.
166
167=back
168 56
169=head1 API DOCUMENTATION 57=head1 API DOCUMENTATION
170 58
171=head2 General API Considerations 59=head2 General API Considerations
172 60
186 74
187=over 4 75=over 4
188 76
189=item $text 77=item $text
190 78
191Rxvt-unicodes special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
192always represents one screen cell. See L<ROW_t> for a discussion of this format. 80always represents one screen cell. See L<ROW_t> for a discussion of this format.
193 81
194=item $string 82=item $string
195 83
196A perl text string, with an emphasis on I<text>. It can store all unicode 84A perl text string, with an emphasis on I<text>. It can store all unicode
200=item $octets 88=item $octets
201 89
202Either binary data or - more common - a text string encoded in a 90Either binary data or - more common - a text string encoded in a
203locale-specific way. 91locale-specific way.
204 92
93=item $keysym
94
95an integer that is a valid X11 keysym code. You can convert a string
96into a keysym and viceversa by using C<XStringToKeysym> and
97C<XKeysymToString>.
98
205=back 99=back
206 100
207=head2 Extension Objects 101=head2 Extension Objects
208 102
209Very perl extension is a perl class. A separate perl object is created 103Every perl extension is a perl class. A separate perl object is created
210for each terminal and each extension and passed as the first parameter to 104for each terminal, and each terminal has its own set of extension objects,
211hooks. So extensions can use their C<$self> object without having to think 105which are passed as the first parameter to hooks. So extensions can use
212about other extensions, with the exception of methods and members that 106their C<$self> object without having to think about clashes with other
107extensions or other terminals, with the exception of methods and members
213begin with an underscore character C<_>: these are reserved for internal 108that begin with an underscore character C<_>: these are reserved for
214use. 109internal use.
215 110
216Although it isn't a C<urxvt::term> object, you can call all methods of the 111Although it isn't a C<urxvt::term> object, you can call all methods of the
217C<urxvt::term> class on this object. 112C<urxvt::term> class on this object.
218 113
219It has the following methods and data members: 114Additional methods only supported for extension objects are described in
115the C<urxvt::extension> section below.
116
117=head2 META comments
118
119Rxvt-unicode recognizes special meta comments in extensions that define
120different types of metadata.
121
122Currently, it recognises only one such comment:
220 123
221=over 4 124=over 4
222 125
223=item $urxvt_term = $self->{term} 126=item #:META:RESOURCE:name:type:desc
224 127
225Returns the C<urxvt::term> object associated with this instance of the 128The RESOURCE comment defines a resource used by the extension, where
226extension. This member I<must not> be changed in any way. 129C<name> is the resource name, C<type> is the resource type, C<boolean>
227 130or C<string>, and C<desc> is the resource description.
228=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
229
230Dynamically enable the given hooks (named without the C<on_> prefix) for
231this extension, replacing any previous hook. This is useful when you want
232to overwrite time-critical hooks only temporarily.
233
234=item $self->disable ($hook_name[, $hook_name..])
235
236Dynamically disable the given hooks.
237 131
238=back 132=back
239 133
240=head2 Hooks 134=head2 Hooks
241 135
242The following subroutines can be declared in extension files, and will be 136The following subroutines can be declared in extension files, and will be
243called whenever the relevant event happens. 137called whenever the relevant event happens.
244 138
245The first argument passed to them is an extension oject as described in 139The first argument passed to them is an extension object as described in
246the in the C<Extension Objects> section. 140the in the C<Extension Objects> section.
247 141
248B<All> of these hooks must return a boolean value. If it is true, then the 142B<All> of these hooks must return a boolean value. If any of the called
249event counts as being I<consumed>, and the invocation of other hooks is 143hooks returns true, then the event counts as being I<consumed>, and the
250skipped, and the relevant action might not be carried out by the C++ code. 144relevant action might not be carried out by the C++ code.
251 145
252I<< When in doubt, return a false value (preferably C<()>). >> 146I<< When in doubt, return a false value (preferably C<()>). >>
253 147
254=over 4 148=over 4
255 149
256=item on_init $term 150=item on_init $term
257 151
258Called after a new terminal object has been initialized, but before 152Called after a new terminal object has been initialized, but before
259windows are created or the command gets run. Most methods are unsafe to 153windows are created or the command gets run. Most methods are unsafe to
260call or deliver senseless data, as terminal size and other characteristics 154call or deliver senseless data, as terminal size and other characteristics
261have not yet been determined. You can safely query and change resources, 155have not yet been determined. You can safely query and change resources
262though. 156and options, though. For many purposes the C<on_start> hook is a better
157place.
158
159=item on_start $term
160
161Called at the very end of initialisation of a new terminal, just before
162trying to map (display) the toplevel and returning to the main loop.
163
164=item on_destroy $term
165
166Called whenever something tries to destroy terminal, when the terminal is
167still fully functional (not for long, though).
263 168
264=item on_reset $term 169=item on_reset $term
265 170
266Called after the screen is "reset" for any reason, such as resizing or 171Called after the screen is "reset" for any reason, such as resizing or
267control sequences. Here is where you can react on changes to size-related 172control sequences. Here is where you can react on changes to size-related
268variables. 173variables.
269 174
270=item on_start $term 175=item on_child_start $term, $pid
271 176
272Called at the very end of initialisation of a new terminal, just before 177Called just after the child process has been C<fork>ed.
273returning to the mainloop. 178
179=item on_child_exit $term, $status
180
181Called just after the child process has exited. C<$status> is the status
182from C<waitpid>.
274 183
275=item on_sel_make $term, $eventtime 184=item on_sel_make $term, $eventtime
276 185
277Called whenever a selection has been made by the user, but before the 186Called whenever a selection has been made by the user, but before the
278selection text is copied, so changes to the beginning, end or type of the 187selection text is copied, so changes to the beginning, end or type of the
285 194
286Called whenever a selection has been copied, but before the selection is 195Called whenever a selection has been copied, but before the selection is
287requested from the server. The selection text can be queried and changed 196requested from the server. The selection text can be queried and changed
288by calling C<< $term->selection >>. 197by calling C<< $term->selection >>.
289 198
290Returning a true value aborts selection grabbing. It will still be hilighted. 199Returning a true value aborts selection grabbing. It will still be highlighted.
291 200
292=item on_sel_extend $term 201=item on_sel_extend $term
293 202
294Called whenever the user tries to extend the selection (e.g. with a double 203Called whenever the user tries to extend the selection (e.g. with a double
295click) and is either supposed to return false (normal operation), or 204click) and is either supposed to return false (normal operation), or
296should extend the selection itelf and return true to suppress the built-in 205should extend the selection itself and return true to suppress the built-in
297processing. This can happen multiple times, as long as the callback 206processing. This can happen multiple times, as long as the callback
298returns true, it will be called on every further click by the user and is 207returns true, it will be called on every further click by the user and is
299supposed to enlarge the selection more and more, if possible. 208supposed to enlarge the selection more and more, if possible.
300 209
301See the F<selection> example extension. 210See the F<selection> example extension.
302 211
303=item on_view_change $term, $offset 212=item on_view_change $term, $offset
304 213
305Called whenever the view offset changes, i..e the user or program 214Called whenever the view offset changes, i.e. the user or program
306scrolls. Offset C<0> means display the normal terminal, positive values 215scrolls. Offset C<0> means display the normal terminal, positive values
307show this many lines of scrollback. 216show this many lines of scrollback.
308 217
309=item on_scroll_back $term, $lines, $saved 218=item on_scroll_back $term, $lines, $saved
310 219
314 223
315It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 224It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
316$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 225$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
317number of lines that will be in the scrollback buffer. 226number of lines that will be in the scrollback buffer.
318 227
319=item on_osc_seq $term, $string 228=item on_osc_seq $term, $op, $args, $resp
229
230Called on every OSC sequence and can be used to suppress it or modify its
231behaviour. The default should be to return an empty list. A true value
232suppresses execution of the request completely. Make sure you don't get
233confused by recursive invocations when you output an OSC sequence within
234this callback.
235
236C<on_osc_seq_perl> should be used for new behaviour.
237
238=item on_osc_seq_perl $term, $args, $resp
320 239
321Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 240Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
322operating system command) is processed. Cursor position and other state 241operating system command) is processed. Cursor position and other state
323information is up-to-date when this happens. For interoperability, the 242information is up-to-date when this happens. For interoperability, the
324string should start with the extension name and a colon, to distinguish 243string should start with the extension name (sans -osc) and a semicolon,
325it from commands for other extensions, and this might be enforced in the 244to distinguish it from commands for other extensions, and this might be
326future. 245enforced in the future.
246
247For example, C<overlay-osc> uses this:
248
249 sub on_osc_seq_perl {
250 my ($self, $osc, $resp) = @_;
251
252 return unless $osc =~ s/^overlay;//;
253
254 ... process remaining $osc string
255 }
327 256
328Be careful not ever to trust (in a security sense) the data you receive, 257Be careful not ever to trust (in a security sense) the data you receive,
329as its source can not easily be controleld (e-mail content, messages from 258as its source can not easily be controlled (e-mail content, messages from
330other users on the same system etc.). 259other users on the same system etc.).
260
261For responses, C<$resp> contains the end-of-args separator used by the
262sender.
331 263
332=item on_add_lines $term, $string 264=item on_add_lines $term, $string
333 265
334Called whenever text is about to be output, with the text as argument. You 266Called whenever text is about to be output, with the text as argument. You
335can filter/change and output the text yourself by returning a true value 267can filter/change and output the text yourself by returning a true value
340=item on_tt_write $term, $octets 272=item on_tt_write $term, $octets
341 273
342Called whenever some data is written to the tty/pty and can be used to 274Called whenever some data is written to the tty/pty and can be used to
343suppress or filter tty input. 275suppress or filter tty input.
344 276
277=item on_tt_paste $term, $octets
278
279Called whenever text is about to be pasted, with the text as argument. You
280can filter/change and paste the text yourself by returning a true value
281and calling C<< $term->tt_paste >> yourself. C<$octets> is
282locale-encoded.
283
345=item on_line_update $term, $row 284=item on_line_update $term, $row
346 285
347Called whenever a line was updated or changed. Can be used to filter 286Called whenever a line was updated or changed. Can be used to filter
348screen output (e.g. underline urls or other useless stuff). Only lines 287screen output (e.g. underline urls or other useless stuff). Only lines
349that are being shown will be filtered, and, due to performance reasons, 288that are being shown will be filtered, and, due to performance reasons,
356later with the already-modified line (e.g. if unrelated parts change), so 295later with the already-modified line (e.g. if unrelated parts change), so
357you cannot just toggle rendition bits, but only set them. 296you cannot just toggle rendition bits, but only set them.
358 297
359=item on_refresh_begin $term 298=item on_refresh_begin $term
360 299
361Called just before the screen gets redrawn. Can be used for overlay 300Called just before the screen gets redrawn. Can be used for overlay or
362or similar effects by modify terminal contents in refresh_begin, and 301similar effects by modifying the terminal contents in refresh_begin, and
363restoring them in refresh_end. The built-in overlay and selection display 302restoring them in refresh_end. The built-in overlay and selection display
364code is run after this hook, and takes precedence. 303code is run after this hook, and takes precedence.
365 304
366=item on_refresh_end $term 305=item on_refresh_end $term
367 306
368Called just after the screen gets redrawn. See C<on_refresh_begin>. 307Called just after the screen gets redrawn. See C<on_refresh_begin>.
369 308
309=item on_action $term, $string
310
311Called whenever an action is invoked for the corresponding extension
312(e.g. via a C<extension:string> builtin action bound to a key, see
313description of the B<keysym> resource in the urxvt(1) manpage). The
314event is simply the action string. Note that an action event is always
315associated to a single extension.
316
370=item on_keyboard_command $term, $string 317=item on_user_command $term, $string *DEPRECATED*
371 318
372Called whenever the user presses a key combination that has a 319Called whenever a user-configured event is being activated (e.g. via
373C<perl:string> action bound to it (see description of the B<keysym> 320a C<perl:string> action bound to a key, see description of the B<keysym>
374resource in the @@RXVT_NAME@@(1) manpage). 321resource in the urxvt(1) manpage).
322
323The event is simply the action string. This interface is going away in
324preference to the C<on_action> hook.
325
326=item on_resize_all_windows $term, $new_width, $new_height
327
328Called just after the new window size has been calculated, but before
329windows are actually being resized or hints are being set. If this hook
330returns a true value, setting of the window hints is being skipped.
375 331
376=item on_x_event $term, $event 332=item on_x_event $term, $event
377 333
378Called on every X event received on the vt window (and possibly other 334Called on every X event received on the vt window (and possibly other
379windows). Should only be used as a last resort. Most event structure 335windows). Should only be used as a last resort. Most event structure
380members are not passed. 336members are not passed.
381 337
338=item on_root_event $term, $event
339
340Like C<on_x_event>, but is called for events on the root window.
341
382=item on_focus_in $term 342=item on_focus_in $term
383 343
384Called whenever the window gets the keyboard focus, before rxvt-unicode 344Called whenever the window gets the keyboard focus, before rxvt-unicode
385does focus in processing. 345does focus in processing.
386 346
387=item on_focus_out $term 347=item on_focus_out $term
388 348
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 349Called whenever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 350focus out processing.
391 351
352=item on_configure_notify $term, $event
353
354=item on_property_notify $term, $event
355
392=item on_key_press $term, $event, $keysym, $octets 356=item on_key_press $term, $event, $keysym, $octets
393 357
394=item on_key_release $term, $event, $keysym 358=item on_key_release $term, $event, $keysym
395 359
396=item on_button_press $term, $event 360=item on_button_press $term, $event
401 365
402=item on_map_notify $term, $event 366=item on_map_notify $term, $event
403 367
404=item on_unmap_notify $term, $event 368=item on_unmap_notify $term, $event
405 369
406Called whenever the corresponding X event is received for the terminal If 370Called whenever the corresponding X event is received for the terminal. If
407the hook returns true, then the even will be ignored by rxvt-unicode. 371the hook returns true, then the event will be ignored by rxvt-unicode.
408 372
409The event is a hash with most values as named by Xlib (see the XEvent 373The event is a hash with most values as named by Xlib (see the XEvent
410manpage), with the additional members C<row> and C<col>, which are the row 374manpage), with the additional members C<row> and C<col>, which are the
411and column under the mouse cursor. 375(real, not screen-based) row and column under the mouse cursor.
412 376
413C<on_key_press> additionally receives the string rxvt-unicode would 377C<on_key_press> additionally receives the string rxvt-unicode would
414output, if any, in locale-specific encoding. 378output, if any, in locale-specific encoding.
415 379
416subwindow. 380=item on_client_message $term, $event
381
382=item on_wm_protocols $term, $event
383
384=item on_wm_delete_window $term, $event
385
386Called when various types of ClientMessage events are received (all with
387format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
388
389=item on_bell $term
390
391Called on receipt of a bell character.
417 392
418=back 393=back
419 394
420=cut 395=cut
421 396
422package urxvt; 397package urxvt;
423 398
424use utf8; 399use utf8;
425use strict; 400use strict 'vars';
426use Carp (); 401use Carp ();
427use Scalar::Util (); 402use Scalar::Util ();
428use List::Util (); 403use List::Util ();
429 404
430our $VERSION = 1; 405our $VERSION = 1;
431our $TERM; 406our $TERM;
407our @TERM_INIT; # should go, prevents async I/O etc.
408our @TERM_EXT; # should go, prevents async I/O etc.
432our @HOOKNAME; 409our @HOOKNAME;
433our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 410our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434our %OPTION; 411our %OPTION;
435 412
436our $LIBDIR; 413our $LIBDIR;
437our $RESNAME; 414our $RESNAME;
438our $RESCLASS; 415our $RESCLASS;
439our $RXVTNAME; 416our $RXVTNAME;
440 417
418our $NOCHAR = chr 0xffff;
419
441=head2 Variables in the C<urxvt> Package 420=head2 Variables in the C<urxvt> Package
442 421
443=over 4 422=over 4
444 423
445=item $urxvt::LIBDIR 424=item $urxvt::LIBDIR
458=item $urxvt::TERM 437=item $urxvt::TERM
459 438
460The current terminal. This variable stores the current C<urxvt::term> 439The current terminal. This variable stores the current C<urxvt::term>
461object, whenever a callback/hook is executing. 440object, whenever a callback/hook is executing.
462 441
442=item @urxvt::TERM_INIT
443
444All code references in this array will be called as methods of the next newly
445created C<urxvt::term> object (during the C<on_init> phase). The array
446gets cleared before the code references that were in it are being executed,
447so references can push themselves onto it again if they so desire.
448
449This complements to the perl-eval command line option, but gets executed
450first.
451
452=item @urxvt::TERM_EXT
453
454Works similar to C<@TERM_INIT>, but contains perl package/class names, which
455get registered as normal extensions after calling the hooks in C<@TERM_INIT>
456but before other extensions. Gets cleared just like C<@TERM_INIT>.
457
463=back 458=back
464 459
465=head2 Functions in the C<urxvt> Package 460=head2 Functions in the C<urxvt> Package
466 461
467=over 4 462=over 4
468 463
469=item urxvt::fatal $errormessage 464=item urxvt::fatal $errormessage
470 465
471Fatally aborts execution with the given error message. Avoid at all 466Fatally aborts execution with the given error message (which should
472costs! The only time this is acceptable is when the terminal process 467include a trailing newline). Avoid at all costs! The only time this
473starts up. 468is acceptable (and useful) is in the init hook, where it prevents the
469terminal from starting up.
474 470
475=item urxvt::warn $string 471=item urxvt::warn $string
476 472
477Calls C<rxvt_warn> with the given string which should not include a 473Calls C<rxvt_warn> with the given string which should include a trailing
478newline. The module also overwrites the C<warn> builtin with a function 474newline. The module also overwrites the C<warn> builtin with a function
479that calls this function. 475that calls this function.
480 476
481Using this function has the advantage that its output ends up in the 477Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 478correct place, e.g. on stderr of the connecting urxvtc client.
483 479
484Messages have a size limit of 1023 bytes currently. 480Messages have a size limit of 1023 bytes currently.
485 481
486=item $is_safe = urxvt::safe 482=item @terms = urxvt::termlist
487 483
488Returns true when it is safe to do potentially unsafe things, such as 484Returns all urxvt::term objects that exist in this process, regardless of
489evaluating perl code specified by the user. This is true when urxvt was 485whether they are started, being destroyed etc., so be careful. Only term
490started setuid or setgid. 486objects that have perl extensions attached will be returned (because there
487is no urxvt::term object associated with others).
491 488
492=item $time = urxvt::NOW 489=item $time = urxvt::NOW
493 490
494Returns the "current time" (as per the event loop). 491Returns the "current time" (as per the event loop).
495 492
538 535
539=item $rend = urxvt::OVERLAY_RSTYLE 536=item $rend = urxvt::OVERLAY_RSTYLE
540 537
541Return the rendition mask used for overlays by default. 538Return the rendition mask used for overlays by default.
542 539
543=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 540=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
541urxvt::RS_RVid, urxvt::RS_Uline
544 542
545Return the bit that enabled bold, italic, blink, reverse-video and 543Return the bit that enabled bold, italic, blink, reverse-video and
546underline, respectively. To enable such a style, just logically OR it into 544underline, respectively. To enable such a style, just logically OR it into
547the bitset. 545the bitset.
548 546
554 552
555=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 553=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
556 554
557=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 555=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
558 556
557=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
558
559Replace the foreground/background colour in the rendition mask with the 559Replace the foreground/background colour in the rendition mask with the
560specified one. 560specified one.
561 561
562=item $value = urxvt::GET_CUSTOM $rend 562=item $value = urxvt::GET_CUSTOM $rend
563 563
572=back 572=back
573 573
574=cut 574=cut
575 575
576BEGIN { 576BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 577 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 578 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 579 my $msg = join "", @_;
582 $msg .= "\n" 580 $msg .= "\n"
583 unless $msg =~ /\n$/; 581 unless $msg =~ /\n$/;
584 urxvt::warn ($msg); 582 urxvt::warn ($msg);
585 }; 583 };
584}
586 585
587 # %ENV is the original startup environment 586no warnings 'utf8';
588 delete $ENV{IFS}; 587
589 delete $ENV{CDPATH}; 588sub parse_resource {
590 delete $ENV{BASH_ENV}; 589 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
591 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 590
591 $term->scan_extensions;
592
593 my $r = $term->{meta}{resource};
594 keys %$r; # reset iterator
595 while (my ($k, $v) = each %$r) {
596 my $pattern = $k;
597 $pattern =~ y/./-/ if $isarg;
598 my $prefix = $name;
599 my $suffix;
600 if ($pattern =~ /\-$/) {
601 $prefix = substr $name, 0, length $pattern;
602 $suffix = substr $name, length $pattern;
603 }
604 if ($pattern eq $prefix) {
605 $name = "$urxvt::RESCLASS.$k$suffix";
606
607 push @{ $term->{perl_ext_3} }, $v->[0];
608
609 if ($v->[1] eq "boolean") {
610 $term->put_option_db ($name, $flag ? "true" : "false");
611 return 1;
612 } else {
613 $term->put_option_db ($name, $value);
614 return 1 + 2;
615 }
616 }
617 }
618
619 0
620}
621
622sub usage {
623 my ($term, $usage_type) = @_;
624
625 $term->scan_extensions;
626
627 my $r = $term->{meta}{resource};
628
629 for my $pattern (sort keys %$r) {
630 my ($ext, $type, $desc) = @{ $r->{$pattern} };
631
632 $desc .= " (-pe $ext)";
633
634 if ($usage_type == 1) {
635 $pattern =~ y/./-/;
636 $pattern =~ s/-$/-.../g;
637
638 if ($type eq "boolean") {
639 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
640 } else {
641 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
642 }
643 } else {
644 $pattern =~ s/\.$/.*/g;
645 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
646 }
647 }
592} 648}
593 649
594my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 650my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595 651
596sub verbose { 652sub verbose {
597 my ($level, $msg) = @_; 653 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 654 warn "$msg\n" if $level <= $verbosity;
599} 655}
600 656
601my $extension_pkg = "extension0000";
602my %extension_pkg; 657my %extension_pkg;
603 658
604# load a single script into its own package, once only 659# load a single script into its own package, once only
605sub extension_package($) { 660sub extension_package($) {
606 my ($path) = @_; 661 my ($path) = @_;
607 662
608 $extension_pkg{$path} ||= do { 663 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 664 $path =~ /([^\/\\]+)$/;
665 my $pkg = $1;
666 $pkg =~ s/[^[:word:]]/_/g;
667 $pkg = "urxvt::ext::$pkg";
610 668
611 verbose 3, "loading extension '$path' into package '$pkg'"; 669 verbose 3, "loading extension '$path' into package '$pkg'";
670
671 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
612 672
613 open my $fh, "<:raw", $path 673 open my $fh, "<:raw", $path
614 or die "$path: $!"; 674 or die "$path: $!";
615 675
616 my $source = untaint 676 my $source =
617 "package $pkg; use strict; use utf8;\n" 677 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 678 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 679 . (do { local $/; <$fh> })
621 . "\n};\n1"; 680 . "\n};\n1";
622 681
623 eval $source 682 eval $source
632# called by the rxvt core 691# called by the rxvt core
633sub invoke { 692sub invoke {
634 local $TERM = shift; 693 local $TERM = shift;
635 my $htype = shift; 694 my $htype = shift;
636 695
637 if ($htype == 0) { # INIT 696 if ($htype == HOOK_INIT) {
638 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 697 my @dirs = $TERM->perl_libdirs;
639 698
699 $TERM->scan_extensions;
700
640 my %ext_arg; 701 my %ext_arg;
641 702
703 {
704 my @init = @TERM_INIT;
705 @TERM_INIT = ();
706 $_->($TERM) for @init;
707 my @pkg = @TERM_EXT;
708 @TERM_EXT = ();
709 $TERM->register_package ($_) for @pkg;
710 }
711
712 for (
642 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 713 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
714 @{ delete $TERM->{perl_ext_3} }
715 ) {
643 if ($_ eq "default") { 716 if ($_ eq "default") {
717
718 $ext_arg{$_} = []
644 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 719 for qw(selection option-popup selection-popup readline searchable-scrollback);
720
721 for ($TERM->_keysym_resources) {
722 next if /^(?:string|command|builtin|builtin-string|perl)/;
723 next unless /^([A-Za-z0-9_\-]+):/;
724
725 my $ext = $1;
726
727 $ext_arg{$ext} = [];
728 }
729
645 } elsif (/^-(.*)$/) { 730 } elsif (/^-(.*)$/) {
646 delete $ext_arg{$1}; 731 delete $ext_arg{$1};
732
647 } elsif (/^([^<]+)<(.*)>$/) { 733 } elsif (/^([^<]+)<(.*)>$/) {
648 push @{ $ext_arg{$1} }, $2; 734 push @{ $ext_arg{$1} }, $2;
735
649 } else { 736 } else {
650 $ext_arg{$_} ||= []; 737 $ext_arg{$_} ||= [];
651 } 738 }
652 } 739 }
653 740
654 while (my ($ext, $argv) = each %ext_arg) { 741 for my $ext (sort keys %ext_arg) {
655 my @files = grep -f $_, map "$_/$ext", @dirs; 742 my @files = grep -f $_, map "$_/$ext", @dirs;
656 743
657 if (@files) { 744 if (@files) {
658 $TERM->register_package (extension_package $files[0], $argv); 745 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
659 } else { 746 } else {
660 warn "perl extension '$ext' not found in perl library search path\n"; 747 warn "perl extension '$ext' not found in perl library search path\n";
661 } 748 }
662 } 749 }
663 750
669 756
670 if (my $cb = $TERM->{_hook}[$htype]) { 757 if (my $cb = $TERM->{_hook}[$htype]) {
671 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 758 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
672 if $verbosity >= 10; 759 if $verbosity >= 10;
673 760
674 keys %$cb; 761 if ($htype == HOOK_ACTION) {
762 # this hook is only sent to the extension with the name
763 # matching the first arg
764 my $pkg = shift;
765 $pkg =~ y/-/_/;
766 $pkg = "urxvt::ext::$pkg";
675 767
676 while (my ($pkg, $cb) = each %$cb) { 768 $cb = $cb->{$pkg}
769 or return undef; #TODO: maybe warn user?
770
771 $cb = { $pkg => $cb };
772 }
773
774 for my $pkg (keys %$cb) {
677 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 775 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
678 and last; 776 $retval ||= $retval_;
679 777
680 if ($@) { 778 if ($@) {
681 $TERM->ungrab; # better to lose the grab than the session 779 $TERM->ungrab; # better to lose the grab than the session
682 warn $@; 780 warn $@;
683 } 781 }
685 783
686 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 784 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
687 if $verbosity >= 11; 785 if $verbosity >= 11;
688 } 786 }
689 787
690 if ($htype == 1) { # DESTROY 788 if ($htype == HOOK_DESTROY) {
691 # clear package objects 789 # clear package objects
692 %$_ = () for values %{ $TERM->{_pkg} }; 790 %$_ = () for values %{ $TERM->{_pkg} };
693 791
694 # clear package 792 # clear package
695 %$TERM = (); 793 %$TERM = ();
696 } 794 }
697 795
698 $retval 796 $retval
699} 797}
700 798
701sub exec_async(@) { 799sub SET_COLOR($$$) {
702 my $pid = fork; 800 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
703
704 return
705 if !defined $pid or $pid;
706
707 %ENV = %{ $TERM->env };
708
709 exec @_;
710 _exit 255;
711} 801}
712 802
713# urxvt::term::extension 803sub rend2mask {
804 no strict 'refs';
805 my ($str, $mask) = (@_, 0);
806 my %color = ( fg => undef, bg => undef );
807 my @failed;
808 for my $spec ( split /\s+/, $str ) {
809 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
810 $color{lc($1)} = $2;
811 } else {
812 my $neg = $spec =~ s/^[-^]//;
813 unless ( exists &{"RS_$spec"} ) {
814 push @failed, $spec;
815 next;
816 }
817 my $cur = &{"RS_$spec"};
818 if ( $neg ) {
819 $mask &= ~$cur;
820 } else {
821 $mask |= $cur;
822 }
823 }
824 }
825 ($mask, @color{qw(fg bg)}, \@failed)
826}
714 827
715package urxvt::term::extension; 828package urxvt::term::extension;
716 829
717sub enable { 830=head2 The C<urxvt::term::extension> class
718 my ($self, %hook) = @_;
719 my $pkg = $self->{_pkg};
720 831
721 while (my ($name, $cb) = each %hook) { 832Each extension attached to a terminal object is represented by
722 my $htype = $HOOKTYPE{uc $name}; 833a C<urxvt::term::extension> object.
723 defined $htype
724 or Carp::croak "unsupported hook type '$name'";
725 834
726 $self->set_should_invoke ($htype, +1) 835You can use these objects, which are passed to all callbacks to store any
727 unless exists $self->{term}{_hook}[$htype]{$pkg}; 836state related to the terminal and extension instance.
728 837
729 $self->{term}{_hook}[$htype]{$pkg} = $cb; 838The methods (And data members) documented below can be called on extension
730 } 839objects, in addition to call methods documented for the <urxvt::term>
731} 840class.
732 841
733sub disable { 842=over 4
734 my ($self, @hook) = @_;
735 my $pkg = $self->{_pkg};
736 843
737 for my $name (@hook) { 844=item $urxvt_term = $self->{term}
738 my $htype = $HOOKTYPE{uc $name};
739 defined $htype
740 or Carp::croak "unsupported hook type '$name'";
741 845
742 $self->set_should_invoke ($htype, -1) 846Returns the C<urxvt::term> object associated with this instance of the
743 if delete $self->{term}{_hook}[$htype]{$pkg}; 847extension. This member I<must not> be changed in any way.
744 } 848
745} 849=cut
746 850
747our $AUTOLOAD; 851our $AUTOLOAD;
748 852
749sub AUTOLOAD { 853sub AUTOLOAD {
750 $AUTOLOAD =~ /:([^:]+)$/ 854 $AUTOLOAD =~ /:([^:]+)$/
763 867
764sub DESTROY { 868sub DESTROY {
765 # nop 869 # nop
766} 870}
767 871
768# urxvt::destroy_hook 872# urxvt::destroy_hook (basically a cheap Guard:: implementation)
769 873
770sub urxvt::destroy_hook::DESTROY { 874sub urxvt::destroy_hook::DESTROY {
771 ${$_[0]}->(); 875 ${$_[0]}->();
772} 876}
773 877
774sub urxvt::destroy_hook(&) { 878sub urxvt::destroy_hook(&) {
775 bless \shift, urxvt::destroy_hook:: 879 bless \shift, urxvt::destroy_hook::
776} 880}
881
882=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
883
884Dynamically enable the given hooks (named without the C<on_> prefix) for
885this extension, replacing any hook previously installed via C<enable> in
886this extension.
887
888This is useful when you want to overwrite time-critical hooks only
889temporarily.
890
891To install additional callbacks for the same hook, you can use the C<on>
892method of the C<urxvt::term> class.
893
894=item $self->disable ($hook_name[, $hook_name..])
895
896Dynamically disable the given hooks.
897
898=cut
899
900sub enable {
901 my ($self, %hook) = @_;
902 my $pkg = $self->{_pkg};
903
904 while (my ($name, $cb) = each %hook) {
905 my $htype = $HOOKTYPE{uc $name};
906 defined $htype
907 or Carp::croak "unsupported hook type '$name'";
908
909 $self->set_should_invoke ($htype, +1)
910 unless exists $self->{term}{_hook}[$htype]{$pkg};
911
912 $self->{term}{_hook}[$htype]{$pkg} = $cb;
913 }
914}
915
916sub disable {
917 my ($self, @hook) = @_;
918 my $pkg = $self->{_pkg};
919
920 for my $name (@hook) {
921 my $htype = $HOOKTYPE{uc $name};
922 defined $htype
923 or Carp::croak "unsupported hook type '$name'";
924
925 $self->set_should_invoke ($htype, -1)
926 if delete $self->{term}{_hook}[$htype]{$pkg};
927 }
928}
929
930=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
931
932Similar to the C<enable> enable, but installs additional callbacks for
933the given hook(s) (that is, it doesn't replace existing callbacks), and
934returns a guard object. When the guard object is destroyed the callbacks
935are disabled again.
936
937=cut
938
939sub urxvt::extension::on_disable::DESTROY {
940 my $disable = shift;
941
942 my $term = delete $disable->{""};
943
944 while (my ($htype, $id) = each %$disable) {
945 delete $term->{_hook}[$htype]{$id};
946 $term->set_should_invoke ($htype, -1);
947 }
948}
949
950sub on {
951 my ($self, %hook) = @_;
952
953 my $term = $self->{term};
954
955 my %disable = ( "" => $term );
956
957 while (my ($name, $cb) = each %hook) {
958 my $htype = $HOOKTYPE{uc $name};
959 defined $htype
960 or Carp::croak "unsupported hook type '$name'";
961
962 $term->set_should_invoke ($htype, +1);
963 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
964 = sub { shift; $cb->($self, @_) }; # very ugly indeed
965 }
966
967 bless \%disable, "urxvt::extension::on_disable"
968}
969
970=item $self->bind_action ($hotkey, $action)
971
972=item $self->x_resource ($pattern)
973
974=item $self->x_resource_boolean ($pattern)
975
976These methods support an additional C<%> prefix for C<$action> or
977C<$pattern> when called on an extension object, compared to the
978C<urxvt::term> methods of the same name - see the description of these
979methods in the C<urxvt::term> class for details.
980
981=cut
982
983sub bind_action {
984 my ($self, $hotkey, $action) = @_;
985 $action =~ s/^%:/$_[0]{_name}:/;
986 $self->{term}->bind_action ($hotkey, $action)
987}
988
989sub x_resource {
990 my ($self, $name) = @_;
991 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
992 $self->{term}->x_resource ($name)
993}
994
995sub x_resource_boolean {
996 my ($self, $name) = @_;
997 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
998 $self->{term}->x_resource_boolean ($name)
999}
1000
1001=back
1002
1003=cut
777 1004
778package urxvt::anyevent; 1005package urxvt::anyevent;
779 1006
780=head2 The C<urxvt::anyevent> Class 1007=head2 The C<urxvt::anyevent> Class
781 1008
782The sole purpose of this class is to deliver an interface to the 1009The sole purpose of this class is to deliver an interface to the
783C<AnyEvent> module - any module using it will work inside urxvt without 1010C<AnyEvent> module - any module using it will work inside urxvt without
784further programming. The only exception is that you cannot wait on 1011further programming. The only exception is that you cannot wait on
785condition variables, but non-blocking condvar use is ok. What this means 1012condition variables, but non-blocking condvar use is ok.
786is that you cannot use blocking APIs, but the non-blocking variant should
787work.
788 1013
789=cut 1014In practical terms this means is that you cannot use blocking APIs, but
1015the non-blocking variant should work.
790 1016
1017=cut
1018
791our $VERSION = 1; 1019our $VERSION = '5.23';
792 1020
793$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1021$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
794push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1022push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
795 1023
796sub timer { 1024sub timer {
798 1026
799 my $cb = $arg{cb}; 1027 my $cb = $arg{cb};
800 1028
801 urxvt::timer 1029 urxvt::timer
802 ->new 1030 ->new
803 ->start (urxvt::NOW + $arg{after}) 1031 ->after ($arg{after}, $arg{interval})
804 ->cb (sub { 1032 ->cb ($arg{interval} ? $cb : sub {
805 $_[0]->stop; # need to cancel manually 1033 $_[0]->stop; # need to cancel manually
806 $cb->(); 1034 $cb->();
807 }) 1035 })
808} 1036}
809 1037
810sub io { 1038sub io {
811 my ($class, %arg) = @_; 1039 my ($class, %arg) = @_;
812 1040
813 my $cb = $arg{cb}; 1041 my $cb = $arg{cb};
1042 my $fd = fileno $arg{fh};
1043 defined $fd or $fd = $arg{fh};
814 1044
815 bless [$arg{fh}, urxvt::iow 1045 bless [$arg{fh}, urxvt::iow
816 ->new 1046 ->new
817 ->fd (fileno $arg{fh}) 1047 ->fd ($fd)
818 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1048 ->events (($arg{poll} =~ /r/ ? 1 : 0)
819 | ($arg{poll} =~ /w/ ? 2 : 0)) 1049 | ($arg{poll} =~ /w/ ? 2 : 0))
820 ->start 1050 ->start
821 ->cb (sub { 1051 ->cb ($cb)
822 $cb->(($_[1] & 1 ? 'r' : '')
823 . ($_[1] & 2 ? 'w' : ''));
824 })],
825 urxvt::anyevent:: 1052 ], urxvt::anyevent::
1053}
1054
1055sub idle {
1056 my ($class, %arg) = @_;
1057
1058 my $cb = $arg{cb};
1059
1060 urxvt::iw
1061 ->new
1062 ->start
1063 ->cb ($cb)
1064}
1065
1066sub child {
1067 my ($class, %arg) = @_;
1068
1069 my $cb = $arg{cb};
1070
1071 urxvt::pw
1072 ->new
1073 ->start ($arg{pid})
1074 ->cb (sub {
1075 $_[0]->stop; # need to cancel manually
1076 $cb->($_[0]->rpid, $_[0]->rstatus);
1077 })
826} 1078}
827 1079
828sub DESTROY { 1080sub DESTROY {
829 $_[0][1]->stop; 1081 $_[0][1]->stop;
830} 1082}
831 1083
832sub condvar { 1084# only needed for AnyEvent < 6 compatibility
833 bless \my $flag, urxvt::anyevent::condvar:: 1085sub one_event {
834}
835
836sub urxvt::anyevent::condvar::broadcast {
837 ${$_[0]}++;
838}
839
840sub urxvt::anyevent::condvar::wait {
841 unless (${$_[0]}) {
842 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1086 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
843 }
844} 1087}
845 1088
846package urxvt::term; 1089package urxvt::term;
847 1090
848=head2 The C<urxvt::term> Class 1091=head2 The C<urxvt::term> Class
854# find on_xxx subs in the package and register them 1097# find on_xxx subs in the package and register them
855# as hooks 1098# as hooks
856sub register_package { 1099sub register_package {
857 my ($self, $pkg, $argv) = @_; 1100 my ($self, $pkg, $argv) = @_;
858 1101
1102 no strict 'refs';
1103
1104 urxvt::verbose 6, "register package $pkg to $self";
1105
1106 @{"$pkg\::ISA"} = urxvt::term::extension::;
1107
859 my $proxy = bless { 1108 my $proxy = bless {
860 _pkg => $pkg, 1109 _pkg => $pkg,
1110 _name => ${"$pkg\::_NAME"}, # hackish
861 argv => $argv, 1111 argv => $argv,
862 }, $pkg; 1112 }, $pkg;
863 Scalar::Util::weaken ($proxy->{term} = $self); 1113 Scalar::Util::weaken ($proxy->{term} = $self);
864 1114
865 $self->{_pkg}{$pkg} = $proxy; 1115 $self->{_pkg}{$pkg} = $proxy;
866 1116
869 $proxy->enable ($name => $ref); 1119 $proxy->enable ($name => $ref);
870 } 1120 }
871 } 1121 }
872} 1122}
873 1123
1124sub perl_libdirs {
1125 map { split /:/ }
1126 $_[0]->resource ("perl_lib"),
1127 $ENV{URXVT_PERL_LIB},
1128 "$ENV{HOME}/.urxvt/ext",
1129 "$LIBDIR/perl"
1130}
1131
1132# scan for available extensions and collect their metadata
1133sub scan_extensions {
1134 my ($self) = @_;
1135
1136 return if exists $self->{meta};
1137
1138 my @urxvtdirs = perl_libdirs $self;
1139# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1140
1141 $self->{meta} = \my %meta;
1142
1143 # first gather extensions
1144
1145 my $gather = sub {
1146 my ($dir, $core) = @_;
1147
1148 opendir my $fh, $dir
1149 or return;
1150
1151 for my $ext (readdir $fh) {
1152 $ext !~ /^\./
1153 or next;
1154
1155 open my $fh, "<", "$dir/$ext"
1156 or next;
1157
1158 -f $fh
1159 or next;
1160
1161 $ext =~ s/\.uext$// or $core
1162 or next;
1163
1164 my %ext = (dir => $dir);
1165
1166 while (<$fh>) {
1167 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1168 my ($pattern, $type, $desc) = split /:/, $1;
1169 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1170 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1171 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1172 } else {
1173 $ext{resource}{$pattern} = [$ext, $type, $desc];
1174 }
1175 } elsif (/^\s*(?:#|$)/) {
1176 # skip other comments and empty lines
1177 } else {
1178 last; # stop parsing on first non-empty non-comment line
1179 }
1180 }
1181
1182 $meta{ext}{$ext} = \%ext;
1183 }
1184 };
1185
1186# $gather->($_, 0) for @cpandirs;
1187 $gather->($_, 1) for @urxvtdirs;
1188
1189 # and now merge resources
1190
1191 $meta{resource} = \my %resource;
1192
1193 while (my ($k, $v) = each %{ $meta{ext} }) {
1194 #TODO: should check for extensions overriding each other
1195 %resource = (%resource, %{ $v->{resource} });
1196 }
1197}
1198
874=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1199=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
875 1200
876Creates a new terminal, very similar as if you had started it with system 1201Creates a new terminal, very similar as if you had started it with system
877C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1202C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
878hash which defines the environment of the new terminal. 1203hash which defines the environment of the new terminal.
879 1204
880Croaks (and probably outputs an error message) if the new instance 1205Croaks (and probably outputs an error message) if the new instance
881couldn't be created. Returns C<undef> if the new instance didn't 1206couldn't be created. Returns C<undef> if the new instance didn't
882initialise perl, and the terminal object otherwise. The C<init> and 1207initialise perl, and the terminal object otherwise. The C<init> and
883C<start> hooks will be called during this call. 1208C<start> hooks will be called before this call returns, and are free to
1209refer to global data (which is race free).
884 1210
885=cut 1211=cut
886 1212
887sub new { 1213sub new {
888 my ($class, $env, @args) = @_; 1214 my ($class, $env, @args) = @_;
889 1215
1216 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1217 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1218
890 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1219 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
891} 1220}
892 1221
893=item $term->destroy 1222=item $term->destroy
894 1223
895Destroy the terminal object (close the window, free resources 1224Destroy the terminal object (close the window, free resources
896etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1225etc.). Please note that urxvt will not exit as long as any event
897watchers (timers, io watchers) are still active. 1226watchers (timers, io watchers) are still active.
1227
1228=item $term->exec_async ($cmd[, @args])
1229
1230Works like the combination of the C<fork>/C<exec> builtins, which executes
1231("starts") programs in the background. This function takes care of setting
1232the user environment before exec'ing the command (e.g. C<PATH>) and should
1233be preferred over explicit calls to C<exec> or C<system>.
1234
1235Returns the pid of the subprocess or C<undef> on error.
1236
1237=cut
1238
1239sub exec_async {
1240 my $self = shift;
1241
1242 my $pid = fork;
1243
1244 return $pid
1245 if !defined $pid or $pid;
1246
1247 %ENV = %{ $self->env };
1248
1249 exec @_;
1250 urxvt::_exit 255;
1251}
898 1252
899=item $isset = $term->option ($optval[, $set]) 1253=item $isset = $term->option ($optval[, $set])
900 1254
901Returns true if the option specified by C<$optval> is enabled, and 1255Returns true if the option specified by C<$optval> is enabled, and
902optionally change it. All option values are stored by name in the hash 1256optionally change it. All option values are stored by name in the hash
903C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1257C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
904 1258
905Here is a a likely non-exhaustive list of option names, please see the 1259Here is a likely non-exhaustive list of option names, please see the
906source file F</src/optinc.h> to see the actual list: 1260source file F</src/optinc.h> to see the actual list:
907 1261
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 1262 borderLess buffered console cursorBlink cursorUnderline hold iconic
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1263 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1265 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1267 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
913 tripleclickwords utmpInhibit visualBell 1268 urgentOnBell utmpInhibit visualBell
914 1269
915=item $value = $term->resource ($name[, $newval]) 1270=item $value = $term->resource ($name[, $newval])
916 1271
917Returns the current resource value associated with a given name and 1272Returns the current resource value associated with a given name and
918optionally sets a new value. Setting values is most useful in the C<init> 1273optionally sets a new value. Setting values is most useful in the C<init>
927likely change). 1282likely change).
928 1283
929Please note that resource strings will currently only be freed when the 1284Please note that resource strings will currently only be freed when the
930terminal is destroyed, so changing options frequently will eat memory. 1285terminal is destroyed, so changing options frequently will eat memory.
931 1286
932Here is a a likely non-exhaustive list of resource names, not all of which 1287Here is a likely non-exhaustive list of resource names, not all of which
933are supported in every build, please see the source file F</src/rsinc.h> 1288are supported in every build, please see the source file F</src/rsinc.h>
934to see the actual list: 1289to see the actual list:
935 1290
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1291 answerbackstring backgroundPixmap backspace_key blurradius
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 1292 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
938 display_name embed ext_bwidth fade font geometry hold iconName 1293 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1294 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1295 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1296 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1297 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1298 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1299 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1300 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1301 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1302 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1303 term_name title transient_for transparent tripleclickwords urgentOnBell
947 utmpInhibit visualBell 1304 utmpInhibit visualBell
948 1305
949=cut 1306=cut
950 1307
951sub resource($$;$) { 1308sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1309 my ($self, $name) = (shift, shift);
953 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1310 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
954 &urxvt::term::_resource 1311 goto &urxvt::term::_resource
955} 1312}
956 1313
957=item $value = $term->x_resource ($pattern) 1314=item $value = $term->x_resource ($pattern)
958 1315
959Returns the X-Resource for the given pattern, excluding the program or 1316Returns the X-Resource for the given pattern, excluding the program or
960class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1317class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
961same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1318same value as used by this instance of rxvt-unicode. Returns C<undef> if no
962resource with that pattern exists. 1319resource with that pattern exists.
963 1320
1321Extensions that define extra resources also need to call this method
1322to access their values.
1323
1324If the method is called on an extension object (basically, from an
1325extension), then the special prefix C<%.> will be replaced by the name of
1326the extension and a dot, and the lone string C<%> will be replaced by the
1327extension name itself. This makes it possible to code extensions so you
1328can rename them and get a new set of resources without having to change
1329the actual code.
1330
964This method should only be called during the C<on_start> hook, as there is 1331This method should only be called during the C<on_start> hook, as there is
965only one resource database per display, and later invocations might return 1332only one resource database per display, and later invocations might return
966the wrong resources. 1333the wrong resources.
967 1334
968=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1335=item $value = $term->x_resource_boolean ($pattern)
969 1336
1337Like C<x_resource>, above, but interprets the string value as a boolean
1338and returns C<1> for true values, C<0> for false values and C<undef> if
1339the resource or option isn't specified.
1340
1341You should always use this method to parse boolean resources.
1342
1343=cut
1344
1345sub x_resource_boolean {
1346 my $res = &x_resource;
1347
1348 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1349}
1350
1351=item $action = $term->lookup_keysym ($keysym, $state)
1352
1353Returns the action bound to key combination C<($keysym, $state)>,
1354if a binding for it exists, and C<undef> otherwise.
1355
1356=item $success = $term->bind_action ($key, $action)
1357
970Adds a keymap translation exactly as specified via a resource. See the 1358Adds a key binding exactly as specified via a C<keysym> resource. See the
971C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1359C<keysym> resource in the urxvt(1) manpage.
1360
1361To add default bindings for actions, an extension should call C<<
1362->bind_action >> in its C<init> hook for every such binding. Doing it
1363in the C<init> hook allows users to override or remove the binding
1364again.
1365
1366Example: the C<searchable-scrollback> by default binds itself
1367on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1368$term->bind_action >>.
1369
1370 sub init {
1371 my ($self) = @_;
1372
1373 $self->bind_action ("M-s" => "%:start");
1374 }
972 1375
973=item $rend = $term->rstyle ([$new_rstyle]) 1376=item $rend = $term->rstyle ([$new_rstyle])
974 1377
975Return and optionally change the current rendition. Text that is output by 1378Return and optionally change the current rendition. Text that is output by
976the terminal application will use this style. 1379the terminal application will use this style.
984 1387
985=item ($row, $col) = $term->selection_beg ([$row, $col]) 1388=item ($row, $col) = $term->selection_beg ([$row, $col])
986 1389
987=item ($row, $col) = $term->selection_end ([$row, $col]) 1390=item ($row, $col) = $term->selection_end ([$row, $col])
988 1391
989Return the current values of the selection mark, begin or end positions, 1392Return the current values of the selection mark, begin or end positions.
990and optionally set them to new values. 1393
1394When arguments are given, then the selection coordinates are set to
1395C<$row> and C<$col>, and the selection screen is set to the current
1396screen.
1397
1398=item $screen = $term->selection_screen ([$screen])
1399
1400Returns the current selection screen, and then optionally sets it.
991 1401
992=item $term->selection_make ($eventtime[, $rectangular]) 1402=item $term->selection_make ($eventtime[, $rectangular])
993 1403
994Tries to make a selection as set by C<selection_beg> and 1404Tries to make a selection as set by C<selection_beg> and
995C<selection_end>. If C<$rectangular> is true (default: false), a 1405C<selection_end>. If C<$rectangular> is true (default: false), a
996rectangular selection will be made. This is the prefered function to make 1406rectangular selection will be made. This is the preferred function to make
997a selection. 1407a selection.
998 1408
999=item $success = $term->selection_grab ($eventtime) 1409=item $success = $term->selection_grab ($eventtime[, $clipboard])
1000 1410
1001Try to request the primary selection text from the server (for example, as 1411Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1412true) selection from the server. The corresponding text can be set
1002set by the next method). No visual feedback will be given. This function 1413with the next method. No visual feedback will be given. This function
1003is mostly useful from within C<on_sel_grab> hooks. 1414is mostly useful from within C<on_sel_grab> hooks.
1004 1415
1005=item $oldtext = $term->selection ([$newtext]) 1416=item $oldtext = $term->selection ([$newtext, $clipboard])
1006 1417
1007Return the current selection text and optionally replace it by C<$newtext>. 1418Return the current selection (clipboard if C<$clipboard> is true) text
1419and optionally replace it by C<$newtext>.
1420
1421=item $term->selection_clear ([$clipboard])
1422
1423Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1008 1424
1009=item $term->overlay_simple ($x, $y, $text) 1425=item $term->overlay_simple ($x, $y, $text)
1010 1426
1011Create a simple multi-line overlay box. See the next method for details. 1427Create a simple multi-line overlay box. See the next method for details.
1012 1428
1042 1458
1043The methods currently supported on C<urxvt::overlay> objects are: 1459The methods currently supported on C<urxvt::overlay> objects are:
1044 1460
1045=over 4 1461=over 4
1046 1462
1047=item $overlay->set ($x, $y, $text, $rend) 1463=item $overlay->set ($x, $y, $text[, $rend])
1048 1464
1049Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1465Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1050text in rxvt-unicode's special encoding and an array of rendition values 1466text in rxvt-unicode's special encoding and an array of rendition values
1051at a specific position inside the overlay. 1467at a specific position inside the overlay.
1468
1469If C<$rend> is missing, then the rendition will not be changed.
1052 1470
1053=item $overlay->hide 1471=item $overlay->hide
1054 1472
1055If visible, hide the overlay, but do not destroy it. 1473If visible, hide the overlay, but do not destroy it.
1056 1474
1119 1537
1120=item $term->scr_add_lines ($string) 1538=item $term->scr_add_lines ($string)
1121 1539
1122Write the given text string to the screen, as if output by the application 1540Write the given text string to the screen, as if output by the application
1123running inside the terminal. It may not contain command sequences (escape 1541running inside the terminal. It may not contain command sequences (escape
1124codes), but is free to use line feeds, carriage returns and tabs. The 1542codes - see C<cmd_parse> for that), but is free to use line feeds,
1125string is a normal text string, not in locale-dependent encoding. 1543carriage returns and tabs. The string is a normal text string, not in
1544locale-dependent encoding.
1126 1545
1127Normally its not a good idea to use this function, as programs might be 1546Normally its not a good idea to use this function, as programs might be
1128confused by changes in cursor position or scrolling. Its useful inside a 1547confused by changes in cursor position or scrolling. Its useful inside a
1129C<on_add_lines> hook, though. 1548C<on_add_lines> hook, though.
1130 1549
1550=item $term->scr_change_screen ($screen)
1551
1552Switch to given screen - 0 primary, 1 secondary.
1553
1131=item $term->cmd_parse ($octets) 1554=item $term->cmd_parse ($octets)
1132 1555
1133Similar to C<scr_add_lines>, but the argument must be in the 1556Similar to C<scr_add_lines>, but the argument must be in the
1134locale-specific encoding of the terminal and can contain command sequences 1557locale-specific encoding of the terminal and can contain command sequences
1135(escape codes) that will be interpreted. 1558(escape codes) that will be interpreted.
1136 1559
1137=item $term->tt_write ($octets) 1560=item $term->tt_write ($octets)
1138 1561
1139Write the octets given in C<$data> to the tty (i.e. as program input). To 1562Write the octets given in C<$octets> to the tty (i.e. as user input
1563to the program, see C<cmd_parse> for the opposite direction). To pass
1140pass characters instead of octets, you should convert your strings first 1564characters instead of octets, you should convert your strings first to the
1141to the locale-specific encoding using C<< $term->locale_encode >>. 1565locale-specific encoding using C<< $term->locale_encode >>.
1566
1567=item $term->tt_write_user_input ($octets)
1568
1569Like C<tt_write>, but should be used when writing strings in response to
1570the user pressing a key, to invoke the additional actions requested by
1571the user for that case (C<tt_write> doesn't do that).
1572
1573The typical use case would be inside C<on_action> hooks.
1574
1575=item $term->tt_paste ($octets)
1576
1577Write the octets given in C<$octets> to the tty as a paste, converting NL to
1578CR and bracketing the data with control sequences if bracketed paste mode
1579is set.
1142 1580
1143=item $old_events = $term->pty_ev_events ([$new_events]) 1581=item $old_events = $term->pty_ev_events ([$new_events])
1144 1582
1145Replaces the event mask of the pty watcher by the given event mask. Can 1583Replaces the event mask of the pty watcher by the given event mask. Can
1146be used to suppress input and output handling to the pty/tty. See the 1584be used to suppress input and output handling to the pty/tty. See the
1147description of C<< urxvt::timer->events >>. Make sure to always restore 1585description of C<< urxvt::timer->events >>. Make sure to always restore
1148the previous value. 1586the previous value.
1149 1587
1588=item $fd = $term->pty_fd
1589
1590Returns the master file descriptor for the pty in use, or C<-1> if no pty
1591is used.
1592
1150=item $windowid = $term->parent 1593=item $windowid = $term->parent
1151 1594
1152Return the window id of the toplevel window. 1595Return the window id of the toplevel window.
1153 1596
1154=item $windowid = $term->vt 1597=item $windowid = $term->vt
1160Adds the specified events to the vt event mask. Useful e.g. when you want 1603Adds the specified events to the vt event mask. Useful e.g. when you want
1161to receive pointer events all the times: 1604to receive pointer events all the times:
1162 1605
1163 $term->vt_emask_add (urxvt::PointerMotionMask); 1606 $term->vt_emask_add (urxvt::PointerMotionMask);
1164 1607
1608=item $term->set_urgency ($set)
1609
1610Enable/disable the urgency hint on the toplevel window.
1611
1612=item $term->focus_in
1613
1614=item $term->focus_out
1615
1616=item $term->key_press ($state, $keycode[, $time])
1617
1618=item $term->key_release ($state, $keycode[, $time])
1619
1620Deliver various fake events to to terminal.
1621
1165=item $window_width = $term->width 1622=item $window_width = $term->width
1166 1623
1167=item $window_height = $term->height 1624=item $window_height = $term->height
1168 1625
1169=item $font_width = $term->fwidth 1626=item $font_width = $term->fwidth
1199=item $env = $term->env 1656=item $env = $term->env
1200 1657
1201Returns a copy of the environment in effect for the terminal as a hashref 1658Returns a copy of the environment in effect for the terminal as a hashref
1202similar to C<\%ENV>. 1659similar to C<\%ENV>.
1203 1660
1661=item @envv = $term->envv
1662
1663Returns the environment as array of strings of the form C<VAR=VALUE>.
1664
1665=item @argv = $term->argv
1666
1667Return the argument vector as this terminal, similar to @ARGV, but
1668includes the program name as first element.
1669
1204=cut 1670=cut
1205 1671
1206sub env { 1672sub env {
1207 if (my $env = $_[0]->_env) {
1208 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1673 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1209 } else {
1210 +{ %ENV }
1211 }
1212} 1674}
1213 1675
1214=item $modifiermask = $term->ModLevel3Mask 1676=item $modifiermask = $term->ModLevel3Mask
1215 1677
1216=item $modifiermask = $term->ModMetaMask 1678=item $modifiermask = $term->ModMetaMask
1217 1679
1218=item $modifiermask = $term->ModNumLockMask 1680=item $modifiermask = $term->ModNumLockMask
1219 1681
1220Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1682Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1221AltGr), the meta key (often Alt) and the num lock key, if applicable. 1683AltGr), the meta key (often Alt) and the num lock key, if applicable.
1684
1685=item $screen = $term->current_screen
1686
1687Returns the currently displayed screen (0 primary, 1 secondary).
1688
1689=item $cursor_is_hidden = $term->hidden_cursor
1690
1691Returns whether the cursor is currently hidden or not.
1222 1692
1223=item $view_start = $term->view_start ([$newvalue]) 1693=item $view_start = $term->view_start ([$newvalue])
1224 1694
1225Returns the row number of the topmost displayed line. Maximum value is 1695Returns the row number of the topmost displayed line. Maximum value is
1226C<0>, which displays the normal terminal contents. Lower values scroll 1696C<0>, which displays the normal terminal contents. Lower values scroll
1232compare the on-screen display with its stored representation. If they 1702compare the on-screen display with its stored representation. If they
1233differ, it redraws the differences. 1703differ, it redraws the differences.
1234 1704
1235Used after changing terminal contents to display them. 1705Used after changing terminal contents to display them.
1236 1706
1707=item $term->refresh_check
1708
1709Checks if a refresh has been requested and, if so, schedules one.
1710
1237=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1711=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1238 1712
1239Returns the text of the entire row with number C<$row_number>. Row C<0> 1713Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1240is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1714is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1241terminal line. The scrollback buffer starts at line C<-1> and extends to
1242line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1715terminal line. Nothing will be returned if a nonexistent line
1243is requested. 1716is requested.
1244 1717
1245If C<$new_text> is specified, it will replace characters in the current 1718If C<$new_text> is specified, it will replace characters in the current
1246line, starting at column C<$start_col> (default C<0>), which is useful 1719line, starting at column C<$start_col> (default C<0>), which is useful
1247to replace only parts of a line. The font index in the rendition will 1720to replace only parts of a line. The font index in the rendition will
1248automatically be updated. 1721automatically be updated.
1249 1722
1250C<$text> is in a special encoding: tabs and wide characters that use more 1723C<$text> is in a special encoding: tabs and wide characters that use more
1251than one cell when displayed are padded with urxvt::NOCHAR characters 1724than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1252(C<chr 65535>). Characters with combining characters and other characters 1725characters. Characters with combining characters and other characters that
1253that do not fit into the normal tetx encoding will be replaced with 1726do not fit into the normal text encoding will be replaced with characters
1254characters in the private use area. 1727in the private use area.
1255 1728
1256You have to obey this encoding when changing text. The advantage is 1729You have to obey this encoding when changing text. The advantage is
1257that C<substr> and similar functions work on screen cells and not on 1730that C<substr> and similar functions work on screen cells and not on
1258characters. 1731characters.
1259 1732
1343} 1816}
1344 1817
1345sub urxvt::line::t { 1818sub urxvt::line::t {
1346 my ($self) = @_; 1819 my ($self) = @_;
1347 1820
1348 if (@_ > 1) 1821 if (@_ > 1) {
1349 {
1350 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1822 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1351 for $self->{beg} .. $self->{end}; 1823 for $self->{beg} .. $self->{end};
1352 } 1824 }
1353 1825
1354 defined wantarray && 1826 defined wantarray &&
1355 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1827 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1356 0, $self->{len} 1828 0, $self->{len}
1357} 1829}
1358 1830
1359sub urxvt::line::r { 1831sub urxvt::line::r {
1360 my ($self) = @_; 1832 my ($self) = @_;
1361 1833
1362 if (@_ > 1) 1834 if (@_ > 1) {
1363 {
1364 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1835 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1365 for $self->{beg} .. $self->{end}; 1836 for $self->{beg} .. $self->{end};
1366 } 1837 }
1367 1838
1368 if (defined wantarray) { 1839 if (defined wantarray) {
1369 my $rend = [ 1840 my $rend = [
1370 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1841 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1371 ]; 1842 ];
1403where one character corresponds to one screen cell. See 1874where one character corresponds to one screen cell. See
1404C<< $term->ROW_t >> for details. 1875C<< $term->ROW_t >> for details.
1405 1876
1406=item $string = $term->special_decode $text 1877=item $string = $term->special_decode $text
1407 1878
1408Converts rxvt-unicodes text reprsentation into a perl string. See 1879Converts rxvt-unicodes text representation into a perl string. See
1409C<< $term->ROW_t >> for details. 1880C<< $term->ROW_t >> for details.
1410 1881
1411=item $success = $term->grab_button ($button, $modifiermask) 1882=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1412 1883
1884=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1885
1413Registers a synchronous button grab. See the XGrabButton manpage. 1886Register/unregister a synchronous button grab. See the XGrabButton
1887manpage.
1414 1888
1415=item $success = $term->grab ($eventtime[, $sync]) 1889=item $success = $term->grab ($eventtime[, $sync])
1416 1890
1417Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1891Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1418synchronous (C<$sync> is true). Also remembers the grab timestampe. 1892synchronous (C<$sync> is true). Also remembers the grab timestamp.
1419 1893
1420=item $term->allow_events_async 1894=item $term->allow_events_async
1421 1895
1422Calls XAllowEvents with AsyncBoth for the most recent grab. 1896Calls XAllowEvents with AsyncBoth for the most recent grab.
1423 1897
1430Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1904Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1431recent grab. 1905recent grab.
1432 1906
1433=item $term->ungrab 1907=item $term->ungrab
1434 1908
1435Calls XUngrab for the most recent grab. Is called automatically on 1909Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1436evaluation errors, as it is better to lose the grab in the error case as 1910evaluation errors, as it is better to lose the grab in the error case as
1437the session. 1911the session.
1912
1913=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1914
1915=item $atom_name = $term->XGetAtomName ($atom)
1916
1917=item @atoms = $term->XListProperties ($window)
1918
1919=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1920
1921=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1922
1923=item $term->XDeleteProperty ($window, $property)
1924
1925=item $window = $term->DefaultRootWindow
1926
1927=item $term->XReparentWindow ($window, $parent, [$x, $y])
1928
1929=item $term->XMapWindow ($window)
1930
1931=item $term->XUnmapWindow ($window)
1932
1933=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1934
1935=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1936
1937=item $term->XChangeInput ($window, $add_events[, $del_events])
1938
1939=item $keysym = $term->XStringToKeysym ($string)
1940
1941=item $string = $term->XKeysymToString ($keysym)
1942
1943Various X or X-related functions. The C<$term> object only serves as
1944the source of the display, otherwise those functions map more-or-less
1945directly onto the X functions of the same name.
1438 1946
1439=back 1947=back
1440 1948
1441=cut 1949=cut
1442 1950
1506 my ($self, $text, $cb) = @_; 2014 my ($self, $text, $cb) = @_;
1507 2015
1508 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2016 $self->add_item ({ type => "button", text => $text, activate => $cb});
1509} 2017}
1510 2018
1511=item $popup->add_toggle ($text, $cb, $initial_value) 2019=item $popup->add_toggle ($text, $initial_value, $cb)
1512 2020
1513Adds a toggle/checkbox item to the popup. Teh callback gets called 2021Adds a toggle/checkbox item to the popup. The callback gets called
1514whenever it gets toggled, with a boolean indicating its value as its first 2022whenever it gets toggled, with a boolean indicating its new value as its
1515argument. 2023first argument.
1516 2024
1517=cut 2025=cut
1518 2026
1519sub add_toggle { 2027sub add_toggle {
1520 my ($self, $text, $cb, $value) = @_; 2028 my ($self, $text, $value, $cb) = @_;
1521 2029
1522 my $item; $item = { 2030 my $item; $item = {
1523 type => "button", 2031 type => "button",
1524 text => " $text", 2032 text => " $text",
1525 value => $value, 2033 value => $value,
1544 my $env = $self->{term}->env; 2052 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2053 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL}; 2054 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 2055 $env->{LC_CTYPE} = $self->{term}->locale;
1548 2056
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 2057 my $term = urxvt::term->new (
1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 2058 $env, "popup",
2059 "--perl-lib" => "", "--perl-ext-common" => "",
2060 "-pty-fd" => -1, "-sl" => 0,
2061 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551 "--transient-for" => $self->{term}->parent, 2062 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 2063 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 2064 "-pe" => "urxvt-popup",
1554 or die "unable to create popup window\n"; 2065 ) or die "unable to create popup window\n";
2066
2067 unless (delete $term->{urxvt_popup_init_done}) {
2068 $term->ungrab;
2069 $term->destroy;
2070 die "unable to initialise popup window\n";
2071 }
1555} 2072}
1556 2073
1557sub DESTROY { 2074sub DESTROY {
1558 my ($self) = @_; 2075 my ($self) = @_;
1559 2076
1560 delete $self->{term}{_destroy}{$self}; 2077 delete $self->{term}{_destroy}{$self};
1561 $self->{term}->ungrab; 2078 $self->{term}->ungrab;
1562} 2079}
1563 2080
1564=back 2081=back
2082
2083=cut
2084
2085package urxvt::watcher;
1565 2086
1566=head2 The C<urxvt::timer> Class 2087=head2 The C<urxvt::timer> Class
1567 2088
1568This class implements timer watchers/events. Time is represented as a 2089This class implements timer watchers/events. Time is represented as a
1569fractional number of seconds since the epoch. Example: 2090fractional number of seconds since the epoch. Example:
1573 ->new 2094 ->new
1574 ->interval (1) 2095 ->interval (1)
1575 ->cb (sub { 2096 ->cb (sub {
1576 $term->{overlay}->set (0, 0, 2097 $term->{overlay}->set (0, 0,
1577 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2098 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1578 }); 2099 });
1579 2100
1580=over 4 2101=over 4
1581 2102
1582=item $timer = new urxvt::timer 2103=item $timer = new urxvt::timer
1583 2104
1586 2107
1587=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2108=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1588 2109
1589Set the callback to be called when the timer triggers. 2110Set the callback to be called when the timer triggers.
1590 2111
1591=item $tstamp = $timer->at
1592
1593Return the time this watcher will fire next.
1594
1595=item $timer = $timer->set ($tstamp) 2112=item $timer = $timer->set ($tstamp[, $interval])
1596 2113
1597Set the time the event is generated to $tstamp. 2114Set the time the event is generated to $tstamp (and optionally specifies a
2115new $interval).
1598 2116
1599=item $timer = $timer->interval ($interval) 2117=item $timer = $timer->interval ($interval)
1600 2118
1601Normally (and when C<$interval> is C<0>), the timer will automatically 2119By default (and when C<$interval> is C<0>), the timer will automatically
1602stop after it has fired once. If C<$interval> is non-zero, then the timer 2120stop after it has fired once. If C<$interval> is non-zero, then the timer
1603is automatically rescheduled at the given intervals. 2121is automatically rescheduled at the given intervals.
1604 2122
1605=item $timer = $timer->start 2123=item $timer = $timer->start
1606 2124
1607Start the timer. 2125Start the timer.
1608 2126
1609=item $timer = $timer->start ($tstamp) 2127=item $timer = $timer->start ($tstamp[, $interval])
1610 2128
1611Set the event trigger time to C<$tstamp> and start the timer. 2129Set the event trigger time to C<$tstamp> and start the timer. Optionally
2130also replaces the interval.
2131
2132=item $timer = $timer->after ($delay[, $interval])
2133
2134Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612 2135
1613=item $timer = $timer->stop 2136=item $timer = $timer->stop
1614 2137
1615Stop the timer. 2138Stop the timer.
1616 2139
1622 2145
1623 $term->{socket} = ... 2146 $term->{socket} = ...
1624 $term->{iow} = urxvt::iow 2147 $term->{iow} = urxvt::iow
1625 ->new 2148 ->new
1626 ->fd (fileno $term->{socket}) 2149 ->fd (fileno $term->{socket})
1627 ->events (urxvt::EVENT_READ) 2150 ->events (urxvt::EV_READ)
1628 ->start 2151 ->start
1629 ->cb (sub { 2152 ->cb (sub {
1630 my ($iow, $revents) = @_; 2153 my ($iow, $revents) = @_;
1631 # $revents must be 1 here, no need to check 2154 # $revents must be 1 here, no need to check
1632 sysread $term->{socket}, my $buf, 8192 2155 sysread $term->{socket}, my $buf, 8192
1645Set the callback to be called when io events are triggered. C<$reventmask> 2168Set the callback to be called when io events are triggered. C<$reventmask>
1646is a bitset as described in the C<events> method. 2169is a bitset as described in the C<events> method.
1647 2170
1648=item $iow = $iow->fd ($fd) 2171=item $iow = $iow->fd ($fd)
1649 2172
1650Set the filedescriptor (not handle) to watch. 2173Set the file descriptor (not handle) to watch.
1651 2174
1652=item $iow = $iow->events ($eventmask) 2175=item $iow = $iow->events ($eventmask)
1653 2176
1654Set the event mask to watch. The only allowed values are 2177Set the event mask to watch. The only allowed values are
1655C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2178C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1656together, or C<urxvt::EVENT_NONE>. 2179together, or C<urxvt::EV_NONE>.
1657 2180
1658=item $iow = $iow->start 2181=item $iow = $iow->start
1659 2182
1660Start watching for requested events on the given handle. 2183Start watching for requested events on the given handle.
1661 2184
1662=item $iow = $iow->stop 2185=item $iow = $iow->stop
1663 2186
1664Stop watching for events on the given filehandle. 2187Stop watching for events on the given file handle.
2188
2189=back
2190
2191=head2 The C<urxvt::iw> Class
2192
2193This class implements idle watchers, that get called automatically when
2194the process is idle. They should return as fast as possible, after doing
2195some useful work.
2196
2197=over 4
2198
2199=item $iw = new urxvt::iw
2200
2201Create a new idle watcher object in stopped state.
2202
2203=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2204
2205Set the callback to be called when the watcher triggers.
2206
2207=item $timer = $timer->start
2208
2209Start the watcher.
2210
2211=item $timer = $timer->stop
2212
2213Stop the watcher.
2214
2215=back
2216
2217=head2 The C<urxvt::pw> Class
2218
2219This class implements process watchers. They create an event whenever a
2220process exits, after which they stop automatically.
2221
2222 my $pid = fork;
2223 ...
2224 $term->{pw} = urxvt::pw
2225 ->new
2226 ->start ($pid)
2227 ->cb (sub {
2228 my ($pw, $exit_status) = @_;
2229 ...
2230 });
2231
2232=over 4
2233
2234=item $pw = new urxvt::pw
2235
2236Create a new process watcher in stopped state.
2237
2238=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2239
2240Set the callback to be called when the timer triggers.
2241
2242=item $pw = $timer->start ($pid)
2243
2244Tells the watcher to start watching for process C<$pid>.
2245
2246=item $pw = $pw->stop
2247
2248Stop the watcher.
1665 2249
1666=back 2250=back
1667 2251
1668=head1 ENVIRONMENT 2252=head1 ENVIRONMENT
1669 2253
1678 2262
1679=item >= 3 - script loading and management 2263=item >= 3 - script loading and management
1680 2264
1681=item >=10 - all called hooks 2265=item >=10 - all called hooks
1682 2266
1683=item >=11 - hook reutrn values 2267=item >=11 - hook return values
1684 2268
1685=back 2269=back
1686 2270
1687=head1 AUTHOR 2271=head1 AUTHOR
1688 2272
1689 Marc Lehmann <pcg@goof.com> 2273 Marc Lehmann <schmorp@schmorp.de>
1690 http://software.schmorp.de/pkg/rxvt-unicode 2274 http://software.schmorp.de/pkg/rxvt-unicode
1691 2275
1692=cut 2276=cut
1693 2277
16941 22781
2279
2280# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines