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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines