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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines