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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines