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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines