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.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.253 by sf-exg, Fri Jan 16 20:13:01 2015 UTC

1=encoding utf8 1=encoding utf8
2 2
3=head1 NAME 3=head1 NAME
4 4
5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5urxvtperl - rxvt-unicode's embedded perl interpreter
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 # create a file grab_test in $HOME: 9 # create a file grab_test in $HOME:
10 10
11 sub on_sel_grab { 11 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
13 () 13 ()
14 } 14 }
15 15
16 # start a @@RXVT_NAME@@ using it: 16 # start a urxvt using it:
17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 urxvt --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in urxvtd, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36A number of extensions are delivered with this release. You can find them
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38F<< man urxvt-<EXTENSIONNAME> >>.
35 39
36You can activate them like this: 40You can activate them like this:
37 41
38 @@RXVT_NAME@@ -pe <extensionname> 42 urxvt -pe <extensionname>
39 43
40Or by adding them to the resource for extensions loaded by default: 44Or by adding them to the resource for extensions loaded by default:
41 45
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 46 URxvt.perl-ext-common: default,selection-autotransform
43 47
44=over 4 48Extensions may add additional resources and C<actions>, i.e., methods
45 49which can be bound to a key and invoked by the user. An extension can
46=item selection (enabled by default) 50define the resources it support using so called META comments,
47 51described below. Similarly to builtin resources, extension resources
48(More) intelligent selection. This extension tries to be more intelligent 52can also be specified on the command line as long options (with C<.>
49when the user extends selections (double-click and further clicks). Right 53replaced by C<->), in which case the corresponding extension is loaded
50now, it tries to select words, urls and complete shell-quoted 54automatically. For this to work the extension B<must> define META
51arguments, which is very convenient, too, if your F<ls> supports 55comments for its resources.
52C<--quoting-style=shell>.
53
54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end.
74
75This extension also offers following bindable keyboard commands:
76
77=over 4
78
79=item rot13
80
81Rot-13 the selection when activated. Used via keyboard trigger:
82
83 URxvt.keysym.C-M-r: perl:selection:rot13
84
85=back
86
87=item option-popup (enabled by default)
88
89Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90runtime.
91
92=item selection-popup (enabled by default)
93
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl
96evaluation, web-browser starting etc.), depending on content.
97
98Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the
100popup is displayed.
101
102It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not.
104It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>.
107
108The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any
110C<a>s:
111
112 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g }
114 : ()
115 };
116
117=item searchable-scrollback<hotkey> (enabled by default)
118
119Adds regex search functionality to the scrollback buffer, triggered
120by a hotkey (default: C<M-s>). While in search mode, normal terminal
121input/output is suspended and a regex is displayed at the bottom of the
122screen.
123
124Inputting characters appends them to the regex and continues incremental
125search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126search upwards/downwards in the scrollback buffer, C<End> jumps to the
127bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary
130selection.
131
132=item selection-autotransform
133
134This selection allows you to do automatic transforms on a selection
135whenever a selection is made.
136
137It works by specifying perl snippets (most useful is a single C<s///>
138operator) that modify C<$_> as resources:
139
140 URxvt.selection-autotransform.0: transform
141 URxvt.selection-autotransform.1: transform
142 ...
143
144For example, the following will transform selections of the form
145C<filename:number>, often seen in compiler messages, into C<vi +$filename
146$word>:
147
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
149
150And this example matches the same,but replaces it with vi-commands you can
151paste directly into your (vi :) editor:
152
153 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
154
155Of course, this can be modified to suit your needs and your editor :)
156
157To expand the example above to typical perl error messages ("XXX at
158FILENAME line YYY."), you need a slightly more elaborate solution:
159
160 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
161 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
162
163The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file.
166
167=item readline
168
169A support package that tries to make editing with readline easier. At the
170moment, it reacts to clicking with the left mouse button by trying to
171move the text cursor to this position. It does so by generating as many
172cursor-left or cursor-right keypresses as required (the this only works
173for programs that correctly support wide characters).
174
175It only works when clicking into the same line (possibly extended over
176multiple rows) as the text cursor and on the primary screen, to reduce the
177risk of misinterpreting. The normal selection isn't disabled, so quick
178successive clicks might interfere with selection creation in harmless
179ways.
180
181=item tabbed
182
183This transforms the terminal into a tabbar with additional terminals, that
184is, it implements what is commonly refered to as "tabbed terminal". The topmost line
185displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186button per tab.
187
188Clicking a button will activate that tab. Pressing B<Shift-Left> and
189B<Shift-Right> will switch to the tab left or right of the current one,
190while B<Shift-Down> creates a new tab.
191
192=item mark-urls
193
194Uses per-line display filtering (C<on_line_update>) to underline urls and
195make them clickable. When middle-clicked, the program specified in the
196resource C<urlLauncher> (default C<x-www-browser>) will be started with
197the URL as first argument.
198
199=item automove-background
200
201This is basically a one-line extension that dynamically changes the background pixmap offset
202to the window position, in effect creating the same effect as pseudo transparency with
203a custom pixmap. No scaling is supported in this mode. Exmaple:
204
205 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
206
207=item block-graphics-to-ascii
208
209A not very useful example of filtering all text output to the terminal,
210by replacing all line-drawing characters (U+2500 .. U+259F) by a
211similar-looking ascii character.
212
213=item digital-clock
214
215Displays a digital clock using the built-in overlay.
216
217=item example-refresh-hooks
218
219Displays a very simple digital clock in the upper right corner of the
220window. Illustrates overwriting the refresh callbacks to create your own
221overlays or changes.
222
223=item selection-pastebin
224
225This is a little rarely useful extension that Uploads the selection as
226textfile to a remote site (or does other things). (The implementation is
227not currently secure for use in a multiuser environment as it writes to
228F</tmp> directly.).
229
230It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
231i.e.
232
233 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
234
235Pressing this combination runs a command with C<%> replaced by the name of
236the textfile. This command can be set via a resource:
237
238 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
239
240And the default is likely not useful to anybody but the few people around
241here :)
242
243The name of the textfile is the hex encoded md5 sum of the selection, so
244the same content should lead to the same filename.
245
246After a successful upload the selection will be replaced by the text given
247in the C<selection-pastebin-url> resource (again, the % is the placeholder
248for the filename):
249
250 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
251
252=back
253 56
254=head1 API DOCUMENTATION 57=head1 API DOCUMENTATION
255 58
256=head2 General API Considerations 59=head2 General API Considerations
257 60
271 74
272=over 4 75=over 4
273 76
274=item $text 77=item $text
275 78
276Rxvt-unicodes special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
277always 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.
278 81
279=item $string 82=item $string
280 83
281A 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
285=item $octets 88=item $octets
286 89
287Either binary data or - more common - a text string encoded in a 90Either binary data or - more common - a text string encoded in a
288locale-specific way. 91locale-specific way.
289 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
290=back 99=back
291 100
292=head2 Extension Objects 101=head2 Extension Objects
293 102
294Very 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
295for 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,
296hooks. 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
297about 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
298begin with an underscore character C<_>: these are reserved for internal 108that begin with an underscore character C<_>: these are reserved for
299use. 109internal use.
300 110
301Although 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
302C<urxvt::term> class on this object. 112C<urxvt::term> class on this object.
303 113
304It 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:
305 123
306=over 4 124=over 4
307 125
308=item $urxvt_term = $self->{term} 126=item #:META:RESOURCE:name:type:desc
309 127
310Returns the C<urxvt::term> object associated with this instance of the 128The RESOURCE comment defines a resource used by the extension, where
311extension. This member I<must not> be changed in any way. 129C<name> is the resource name, C<type> is the resource type, C<boolean>
312 130or C<string>, and C<desc> is the resource description.
313=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
314
315Dynamically enable the given hooks (named without the C<on_> prefix) for
316this extension, replacing any previous hook. This is useful when you want
317to overwrite time-critical hooks only temporarily.
318
319=item $self->disable ($hook_name[, $hook_name..])
320
321Dynamically disable the given hooks.
322 131
323=back 132=back
324 133
325=head2 Hooks 134=head2 Hooks
326 135
327The following subroutines can be declared in extension files, and will be 136The following subroutines can be declared in extension files, and will be
328called whenever the relevant event happens. 137called whenever the relevant event happens.
329 138
330The 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
331the in the C<Extension Objects> section. 140the in the C<Extension Objects> section.
332 141
333B<All> of these hooks must return a boolean value. If any of the called 142B<All> of these hooks must return a boolean value. If any of the called
334hooks returns true, then the event counts as being I<consumed>, and the 143hooks returns true, then the event counts as being I<consumed>, and the
335relevant action might not be carried out by the C++ code. 144relevant action might not be carried out by the C++ code.
348place. 157place.
349 158
350=item on_start $term 159=item on_start $term
351 160
352Called at the very end of initialisation of a new terminal, just before 161Called at the very end of initialisation of a new terminal, just before
353trying to map (display) the toplevel and returning to the mainloop. 162trying to map (display) the toplevel and returning to the main loop.
354 163
355=item on_destroy $term 164=item on_destroy $term
356 165
357Called whenever something tries to destroy terminal, before doing anything 166Called whenever something tries to destroy terminal, when the terminal is
358yet. If this hook returns true, then destruction is skipped, but this is 167still fully functional (not for long, though).
359rarely a good idea.
360 168
361=item on_reset $term 169=item on_reset $term
362 170
363Called 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
364control 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
386 194
387Called whenever a selection has been copied, but before the selection is 195Called whenever a selection has been copied, but before the selection is
388requested from the server. The selection text can be queried and changed 196requested from the server. The selection text can be queried and changed
389by calling C<< $term->selection >>. 197by calling C<< $term->selection >>.
390 198
391Returning a true value aborts selection grabbing. It will still be hilighted. 199Returning a true value aborts selection grabbing. It will still be highlighted.
392 200
393=item on_sel_extend $term 201=item on_sel_extend $term
394 202
395Called 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
396click) and is either supposed to return false (normal operation), or 204click) and is either supposed to return false (normal operation), or
397should 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
398processing. This can happen multiple times, as long as the callback 206processing. This can happen multiple times, as long as the callback
399returns 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
400supposed to enlarge the selection more and more, if possible. 208supposed to enlarge the selection more and more, if possible.
401 209
402See the F<selection> example extension. 210See the F<selection> example extension.
403 211
404=item on_view_change $term, $offset 212=item on_view_change $term, $offset
405 213
406Called whenever the view offset changes, i..e the user or program 214Called whenever the view offset changes, i.e. the user or program
407scrolls. Offset C<0> means display the normal terminal, positive values 215scrolls. Offset C<0> means display the normal terminal, positive values
408show this many lines of scrollback. 216show this many lines of scrollback.
409 217
410=item on_scroll_back $term, $lines, $saved 218=item on_scroll_back $term, $lines, $saved
411 219
415 223
416It 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,
417$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
418number of lines that will be in the scrollback buffer. 226number of lines that will be in the scrollback buffer.
419 227
420=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
421 239
422Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 240Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
423operating system command) is processed. Cursor position and other state 241operating system command) is processed. Cursor position and other state
424information is up-to-date when this happens. For interoperability, the 242information is up-to-date when this happens. For interoperability, the
425string should start with the extension name and a colon, to distinguish 243string should start with the extension name (sans -osc) and a semicolon,
426it from commands for other extensions, and this might be enforced in the 244to distinguish it from commands for other extensions, and this might be
427future. 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 }
428 256
429Be 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,
430as 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
431other 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.
432 263
433=item on_add_lines $term, $string 264=item on_add_lines $term, $string
434 265
435Called 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
436can 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
441=item on_tt_write $term, $octets 272=item on_tt_write $term, $octets
442 273
443Called 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
444suppress or filter tty input. 275suppress or filter tty input.
445 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
446=item on_line_update $term, $row 284=item on_line_update $term, $row
447 285
448Called 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
449screen output (e.g. underline urls or other useless stuff). Only lines 287screen output (e.g. underline urls or other useless stuff). Only lines
450that are being shown will be filtered, and, due to performance reasons, 288that are being shown will be filtered, and, due to performance reasons,
457later 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
458you cannot just toggle rendition bits, but only set them. 296you cannot just toggle rendition bits, but only set them.
459 297
460=item on_refresh_begin $term 298=item on_refresh_begin $term
461 299
462Called just before the screen gets redrawn. Can be used for overlay 300Called just before the screen gets redrawn. Can be used for overlay or
463or similar effects by modify terminal contents in refresh_begin, and 301similar effects by modifying the terminal contents in refresh_begin, and
464restoring them in refresh_end. The built-in overlay and selection display 302restoring them in refresh_end. The built-in overlay and selection display
465code is run after this hook, and takes precedence. 303code is run after this hook, and takes precedence.
466 304
467=item on_refresh_end $term 305=item on_refresh_end $term
468 306
469Called just after the screen gets redrawn. See C<on_refresh_begin>. 307Called just after the screen gets redrawn. See C<on_refresh_begin>.
470 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
471=item on_keyboard_command $term, $string 317=item on_user_command $term, $string *DEPRECATED*
472 318
473Called whenever the user presses a key combination that has a 319Called whenever a user-configured event is being activated (e.g. via
474C<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>
475resource 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.
476 331
477=item on_x_event $term, $event 332=item on_x_event $term, $event
478 333
479Called 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
480windows). Should only be used as a last resort. Most event structure 335windows). Should only be used as a last resort. Most event structure
481members are not passed. 336members are not passed.
482 337
338=item on_root_event $term, $event
339
340Like C<on_x_event>, but is called for events on the root window.
341
483=item on_focus_in $term 342=item on_focus_in $term
484 343
485Called whenever the window gets the keyboard focus, before rxvt-unicode 344Called whenever the window gets the keyboard focus, before rxvt-unicode
486does focus in processing. 345does focus in processing.
487 346
488=item on_focus_out $term 347=item on_focus_out $term
489 348
490Called wheneever the window loses keyboard focus, before rxvt-unicode does 349Called whenever the window loses keyboard focus, before rxvt-unicode does
491focus out processing. 350focus out processing.
492 351
493=item on_configure_notify $term, $event 352=item on_configure_notify $term, $event
494 353
495=item on_property_notify $term, $event 354=item on_property_notify $term, $event
506 365
507=item on_map_notify $term, $event 366=item on_map_notify $term, $event
508 367
509=item on_unmap_notify $term, $event 368=item on_unmap_notify $term, $event
510 369
511Called whenever the corresponding X event is received for the terminal If 370Called whenever the corresponding X event is received for the terminal. If
512the 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.
513 372
514The 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
515manpage), with the additional members C<row> and C<col>, which are the 374manpage), with the additional members C<row> and C<col>, which are the
516(real, not screen-based) row and column under the mouse cursor. 375(real, not screen-based) row and column under the mouse cursor.
517 376
518C<on_key_press> additionally receives the string rxvt-unicode would 377C<on_key_press> additionally receives the string rxvt-unicode would
519output, if any, in locale-specific encoding. 378output, if any, in locale-specific encoding.
520 379
521subwindow.
522
523=item on_client_message $term, $event 380=item on_client_message $term, $event
524 381
525=item on_wm_protocols $term, $event 382=item on_wm_protocols $term, $event
526 383
527=item on_wm_delete_window $term, $event 384=item on_wm_delete_window $term, $event
528 385
529Called when various types of ClientMessage events are received (all with 386Called when various types of ClientMessage events are received (all with
530format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 387format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
531 388
389=item on_bell $term
390
391Called on receipt of a bell character.
392
532=back 393=back
533 394
534=cut 395=cut
535 396
536package urxvt; 397package urxvt;
537 398
538use utf8; 399use utf8;
539use strict; 400use strict 'vars';
540use Carp (); 401use Carp ();
541use Scalar::Util (); 402use Scalar::Util ();
542use List::Util (); 403use List::Util ();
543 404
544our $VERSION = 1; 405our $VERSION = 1;
545our $TERM; 406our $TERM;
546our @TERM_INIT; 407our @TERM_INIT; # should go, prevents async I/O etc.
547our @TERM_EXT; 408our @TERM_EXT; # should go, prevents async I/O etc.
548our @HOOKNAME; 409our @HOOKNAME;
549our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 410our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
550our %OPTION; 411our %OPTION;
551 412
552our $LIBDIR; 413our $LIBDIR;
553our $RESNAME; 414our $RESNAME;
554our $RESCLASS; 415our $RESCLASS;
555our $RXVTNAME; 416our $RXVTNAME;
556 417
557our $NOCHAR = chr 0xfffe; 418our $NOCHAR = chr 0xffff;
558 419
559=head2 Variables in the C<urxvt> Package 420=head2 Variables in the C<urxvt> Package
560 421
561=over 4 422=over 4
562 423
578The current terminal. This variable stores the current C<urxvt::term> 439The current terminal. This variable stores the current C<urxvt::term>
579object, whenever a callback/hook is executing. 440object, whenever a callback/hook is executing.
580 441
581=item @urxvt::TERM_INIT 442=item @urxvt::TERM_INIT
582 443
583All coderefs in this array will be called as methods of the next newly 444All code references in this array will be called as methods of the next newly
584created C<urxvt::term> object (during the C<on_init> phase). The array 445created C<urxvt::term> object (during the C<on_init> phase). The array
585gets cleared before the codereferences that were in it are being executed, 446gets cleared before the code references that were in it are being executed,
586so coderefs can push themselves onto it again if they so desire. 447so references can push themselves onto it again if they so desire.
587 448
588This complements to the perl-eval commandline option, but gets executed 449This complements to the perl-eval command line option, but gets executed
589first. 450first.
590 451
591=item @urxvt::TERM_EXT 452=item @urxvt::TERM_EXT
592 453
593Works similar to C<@TERM_INIT>, but contains perl package/class names, which 454Works similar to C<@TERM_INIT>, but contains perl package/class names, which
600 461
601=over 4 462=over 4
602 463
603=item urxvt::fatal $errormessage 464=item urxvt::fatal $errormessage
604 465
605Fatally aborts execution with the given error message. Avoid at all 466Fatally aborts execution with the given error message (which should
606costs! The only time this is acceptable is when the terminal process 467include a trailing newline). Avoid at all costs! The only time this
607starts up. 468is acceptable (and useful) is in the init hook, where it prevents the
469terminal from starting up.
608 470
609=item urxvt::warn $string 471=item urxvt::warn $string
610 472
611Calls 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
612newline. The module also overwrites the C<warn> builtin with a function 474newline. The module also overwrites the C<warn> builtin with a function
613that calls this function. 475that calls this function.
614 476
615Using 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
616correct place, e.g. on stderr of the connecting urxvtc client. 478correct place, e.g. on stderr of the connecting urxvtc client.
617 479
618Messages 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).
619 488
620=item $time = urxvt::NOW 489=item $time = urxvt::NOW
621 490
622Returns the "current time" (as per the event loop). 491Returns the "current time" (as per the event loop).
623 492
666 535
667=item $rend = urxvt::OVERLAY_RSTYLE 536=item $rend = urxvt::OVERLAY_RSTYLE
668 537
669Return the rendition mask used for overlays by default. 538Return the rendition mask used for overlays by default.
670 539
671=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
672 542
673Return the bit that enabled bold, italic, blink, reverse-video and 543Return the bit that enabled bold, italic, blink, reverse-video and
674underline, respectively. To enable such a style, just logically OR it into 544underline, respectively. To enable such a style, just logically OR it into
675the bitset. 545the bitset.
676 546
681Return the foreground/background colour index, respectively. 551Return the foreground/background colour index, respectively.
682 552
683=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 553=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
684 554
685=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
686 558
687Replace the foreground/background colour in the rendition mask with the 559Replace the foreground/background colour in the rendition mask with the
688specified one. 560specified one.
689 561
690=item $value = urxvt::GET_CUSTOM $rend 562=item $value = urxvt::GET_CUSTOM $rend
709 unless $msg =~ /\n$/; 581 unless $msg =~ /\n$/;
710 urxvt::warn ($msg); 582 urxvt::warn ($msg);
711 }; 583 };
712} 584}
713 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
714my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 650my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715 651
716sub verbose { 652sub verbose {
717 my ($level, $msg) = @_; 653 my ($level, $msg) = @_;
718 warn "$msg\n" if $level <= $verbosity; 654 warn "$msg\n" if $level <= $verbosity;
730 $pkg =~ s/[^[:word:]]/_/g; 666 $pkg =~ s/[^[:word:]]/_/g;
731 $pkg = "urxvt::ext::$pkg"; 667 $pkg = "urxvt::ext::$pkg";
732 668
733 verbose 3, "loading extension '$path' into package '$pkg'"; 669 verbose 3, "loading extension '$path' into package '$pkg'";
734 670
671 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
672
735 open my $fh, "<:raw", $path 673 open my $fh, "<:raw", $path
736 or die "$path: $!"; 674 or die "$path: $!";
737 675
738 my $source = 676 my $source =
739 "package $pkg; use strict; use utf8;\n" 677 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
740 . "#line 1 \"$path\"\n{\n" 678 . "#line 1 \"$path\"\n{\n"
741 . (do { local $/; <$fh> }) 679 . (do { local $/; <$fh> })
742 . "\n};\n1"; 680 . "\n};\n1";
743 681
744 eval $source 682 eval $source
753# called by the rxvt core 691# called by the rxvt core
754sub invoke { 692sub invoke {
755 local $TERM = shift; 693 local $TERM = shift;
756 my $htype = shift; 694 my $htype = shift;
757 695
758 if ($htype == 0) { # INIT 696 if ($htype == HOOK_INIT) {
759 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 697 my @dirs = $TERM->perl_libdirs;
760 698
699 $TERM->scan_extensions;
700
761 my %ext_arg; 701 my %ext_arg;
762 702
763 { 703 {
764 my @init = @TERM_INIT; 704 my @init = @TERM_INIT;
765 @TERM_INIT = (); 705 @TERM_INIT = ();
767 my @pkg = @TERM_EXT; 707 my @pkg = @TERM_EXT;
768 @TERM_EXT = (); 708 @TERM_EXT = ();
769 $TERM->register_package ($_) for @pkg; 709 $TERM->register_package ($_) for @pkg;
770 } 710 }
771 711
712 for (
772 for (grep $_, 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 ) {
773 if ($_ eq "default") { 716 if ($_ eq "default") {
717
718 $ext_arg{$_} = []
774 $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
775 } elsif (/^-(.*)$/) { 730 } elsif (/^-(.*)$/) {
776 delete $ext_arg{$1}; 731 delete $ext_arg{$1};
732
777 } elsif (/^([^<]+)<(.*)>$/) { 733 } elsif (/^([^<]+)<(.*)>$/) {
778 push @{ $ext_arg{$1} }, $2; 734 push @{ $ext_arg{$1} }, $2;
735
779 } else { 736 } else {
780 $ext_arg{$_} ||= []; 737 $ext_arg{$_} ||= [];
781 } 738 }
782 } 739 }
783 740
784 while (my ($ext, $argv) = each %ext_arg) { 741 for my $ext (sort keys %ext_arg) {
785 my @files = grep -f $_, map "$_/$ext", @dirs; 742 my @files = grep -f $_, map "$_/$ext", @dirs;
786 743
787 if (@files) { 744 if (@files) {
788 $TERM->register_package (extension_package $files[0], $argv); 745 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
789 } else { 746 } else {
790 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";
791 } 748 }
792 } 749 }
793 750
799 756
800 if (my $cb = $TERM->{_hook}[$htype]) { 757 if (my $cb = $TERM->{_hook}[$htype]) {
801 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 758 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
802 if $verbosity >= 10; 759 if $verbosity >= 10;
803 760
804 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";
805 767
806 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) {
807 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 775 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
808 $retval ||= $retval_; 776 $retval ||= $retval_;
809 777
810 if ($@) { 778 if ($@) {
811 $TERM->ungrab; # better to lose the grab than the session 779 $TERM->ungrab; # better to lose the grab than the session
812 warn $@; 780 warn $@;
815 783
816 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 784 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
817 if $verbosity >= 11; 785 if $verbosity >= 11;
818 } 786 }
819 787
820 if ($htype == 1) { # DESTROY 788 if ($htype == HOOK_DESTROY) {
821 # clear package objects 789 # clear package objects
822 %$_ = () for values %{ $TERM->{_pkg} }; 790 %$_ = () for values %{ $TERM->{_pkg} };
823 791
824 # clear package 792 # clear package
825 %$TERM = (); 793 %$TERM = ();
826 } 794 }
827 795
828 $retval 796 $retval
829} 797}
830 798
831# 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}
832 827
833package urxvt::term::extension; 828package urxvt::term::extension;
834 829
835sub enable { 830=head2 The C<urxvt::term::extension> class
836 my ($self, %hook) = @_;
837 my $pkg = $self->{_pkg};
838 831
839 while (my ($name, $cb) = each %hook) { 832Each extension attached to a terminal object is represented by
840 my $htype = $HOOKTYPE{uc $name}; 833a C<urxvt::term::extension> object.
841 defined $htype
842 or Carp::croak "unsupported hook type '$name'";
843 834
844 $self->set_should_invoke ($htype, +1) 835You can use these objects, which are passed to all callbacks to store any
845 unless exists $self->{term}{_hook}[$htype]{$pkg}; 836state related to the terminal and extension instance.
846 837
847 $self->{term}{_hook}[$htype]{$pkg} = $cb; 838The methods (And data members) documented below can be called on extension
848 } 839objects, in addition to call methods documented for the <urxvt::term>
849} 840class.
850 841
851sub disable { 842=over 4
852 my ($self, @hook) = @_;
853 my $pkg = $self->{_pkg};
854 843
855 for my $name (@hook) { 844=item $urxvt_term = $self->{term}
856 my $htype = $HOOKTYPE{uc $name};
857 defined $htype
858 or Carp::croak "unsupported hook type '$name'";
859 845
860 $self->set_should_invoke ($htype, -1) 846Returns the C<urxvt::term> object associated with this instance of the
861 if delete $self->{term}{_hook}[$htype]{$pkg}; 847extension. This member I<must not> be changed in any way.
862 } 848
863} 849=cut
864 850
865our $AUTOLOAD; 851our $AUTOLOAD;
866 852
867sub AUTOLOAD { 853sub AUTOLOAD {
868 $AUTOLOAD =~ /:([^:]+)$/ 854 $AUTOLOAD =~ /:([^:]+)$/
881 867
882sub DESTROY { 868sub DESTROY {
883 # nop 869 # nop
884} 870}
885 871
886# urxvt::destroy_hook 872# urxvt::destroy_hook (basically a cheap Guard:: implementation)
887 873
888sub urxvt::destroy_hook::DESTROY { 874sub urxvt::destroy_hook::DESTROY {
889 ${$_[0]}->(); 875 ${$_[0]}->();
890} 876}
891 877
892sub urxvt::destroy_hook(&) { 878sub urxvt::destroy_hook(&) {
893 bless \shift, urxvt::destroy_hook:: 879 bless \shift, urxvt::destroy_hook::
894} 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
895 1004
896package urxvt::anyevent; 1005package urxvt::anyevent;
897 1006
898=head2 The C<urxvt::anyevent> Class 1007=head2 The C<urxvt::anyevent> Class
899 1008
900The 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
901C<AnyEvent> module - any module using it will work inside urxvt without 1010C<AnyEvent> module - any module using it will work inside urxvt without
902further programming. The only exception is that you cannot wait on 1011further programming. The only exception is that you cannot wait on
903condition variables, but non-blocking condvar use is ok. What this means 1012condition variables, but non-blocking condvar use is ok.
904is that you cannot use blocking APIs, but the non-blocking variant should
905work.
906 1013
907=cut 1014In practical terms this means is that you cannot use blocking APIs, but
1015the non-blocking variant should work.
908 1016
1017=cut
1018
909our $VERSION = 1; 1019our $VERSION = '5.23';
910 1020
911$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1021$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
912push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1022push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
913 1023
914sub timer { 1024sub timer {
916 1026
917 my $cb = $arg{cb}; 1027 my $cb = $arg{cb};
918 1028
919 urxvt::timer 1029 urxvt::timer
920 ->new 1030 ->new
921 ->start (urxvt::NOW + $arg{after}) 1031 ->after ($arg{after}, $arg{interval})
922 ->cb (sub { 1032 ->cb ($arg{interval} ? $cb : sub {
923 $_[0]->stop; # need to cancel manually 1033 $_[0]->stop; # need to cancel manually
924 $cb->(); 1034 $cb->();
925 }) 1035 })
926} 1036}
927 1037
928sub io { 1038sub io {
929 my ($class, %arg) = @_; 1039 my ($class, %arg) = @_;
930 1040
931 my $cb = $arg{cb}; 1041 my $cb = $arg{cb};
1042 my $fd = fileno $arg{fh};
1043 defined $fd or $fd = $arg{fh};
932 1044
933 bless [$arg{fh}, urxvt::iow 1045 bless [$arg{fh}, urxvt::iow
934 ->new 1046 ->new
935 ->fd (fileno $arg{fh}) 1047 ->fd ($fd)
936 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1048 ->events (($arg{poll} =~ /r/ ? 1 : 0)
937 | ($arg{poll} =~ /w/ ? 2 : 0)) 1049 | ($arg{poll} =~ /w/ ? 2 : 0))
938 ->start 1050 ->start
939 ->cb (sub { 1051 ->cb ($cb)
940 $cb->(($_[1] & 1 ? 'r' : '')
941 . ($_[1] & 2 ? 'w' : ''));
942 })],
943 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 })
944} 1078}
945 1079
946sub DESTROY { 1080sub DESTROY {
947 $_[0][1]->stop; 1081 $_[0][1]->stop;
948} 1082}
949 1083
950sub condvar { 1084# only needed for AnyEvent < 6 compatibility
951 bless \my $flag, urxvt::anyevent::condvar:: 1085sub one_event {
952}
953
954sub urxvt::anyevent::condvar::broadcast {
955 ${$_[0]}++;
956}
957
958sub urxvt::anyevent::condvar::wait {
959 unless (${$_[0]}) {
960 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";
961 }
962} 1087}
963 1088
964package urxvt::term; 1089package urxvt::term;
965 1090
966=head2 The C<urxvt::term> Class 1091=head2 The C<urxvt::term> Class
979 urxvt::verbose 6, "register package $pkg to $self"; 1104 urxvt::verbose 6, "register package $pkg to $self";
980 1105
981 @{"$pkg\::ISA"} = urxvt::term::extension::; 1106 @{"$pkg\::ISA"} = urxvt::term::extension::;
982 1107
983 my $proxy = bless { 1108 my $proxy = bless {
984 _pkg => $pkg, 1109 _pkg => $pkg,
1110 _name => ${"$pkg\::_NAME"}, # hackish
985 argv => $argv, 1111 argv => $argv,
986 }, $pkg; 1112 }, $pkg;
987 Scalar::Util::weaken ($proxy->{term} = $self); 1113 Scalar::Util::weaken ($proxy->{term} = $self);
988 1114
989 $self->{_pkg}{$pkg} = $proxy; 1115 $self->{_pkg}{$pkg} = $proxy;
990 1116
993 $proxy->enable ($name => $ref); 1119 $proxy->enable ($name => $ref);
994 } 1120 }
995 } 1121 }
996} 1122}
997 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
998=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1199=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
999 1200
1000Creates 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
1001C<$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
1002hash which defines the environment of the new terminal. 1203hash which defines the environment of the new terminal.
1003 1204
1004Croaks (and probably outputs an error message) if the new instance 1205Croaks (and probably outputs an error message) if the new instance
1005couldn'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
1006initialise perl, and the terminal object otherwise. The C<init> and 1207initialise perl, and the terminal object otherwise. The C<init> and
1007C<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).
1008 1210
1009=cut 1211=cut
1010 1212
1011sub new { 1213sub new {
1012 my ($class, $env, @args) = @_; 1214 my ($class, $env, @args) = @_;
1013 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
1014 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1219 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1015} 1220}
1016 1221
1017=item $term->destroy 1222=item $term->destroy
1018 1223
1019Destroy the terminal object (close the window, free resources 1224Destroy the terminal object (close the window, free resources
1020etc.). 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
1021watchers (timers, io watchers) are still active. 1226watchers (timers, io watchers) are still active.
1022 1227
1023=item $term->exec_async ($cmd[, @args]) 1228=item $term->exec_async ($cmd[, @args])
1024 1229
1025Works 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
1049 1254
1050Returns true if the option specified by C<$optval> is enabled, and 1255Returns true if the option specified by C<$optval> is enabled, and
1051optionally 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
1052C<%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.
1053 1258
1054Here 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
1055source file F</src/optinc.h> to see the actual list: 1260source file F</src/optinc.h> to see the actual list:
1056 1261
1057 borderLess console cursorBlink cursorUnderline hold iconic insecure 1262 borderLess buffered console cursorBlink cursorUnderline hold iconic
1058 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1263 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1059 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1264 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1060 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1265 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1061 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1062 transparent tripleclickwords utmpInhibit visualBell 1267 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1268 urgentOnBell utmpInhibit visualBell
1063 1269
1064=item $value = $term->resource ($name[, $newval]) 1270=item $value = $term->resource ($name[, $newval])
1065 1271
1066Returns the current resource value associated with a given name and 1272Returns the current resource value associated with a given name and
1067optionally 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>
1076likely change). 1282likely change).
1077 1283
1078Please note that resource strings will currently only be freed when the 1284Please note that resource strings will currently only be freed when the
1079terminal is destroyed, so changing options frequently will eat memory. 1285terminal is destroyed, so changing options frequently will eat memory.
1080 1286
1081Here 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
1082are 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>
1083to see the actual list: 1289to see the actual list:
1084 1290
1085 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1291 answerbackstring backgroundPixmap backspace_key blurradius
1086 borderLess color cursorBlink cursorUnderline cutchars delete_key 1292 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1087 display_name embed ext_bwidth fade font geometry hold iconName 1293 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1088 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
1089 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1296 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1090 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1297 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1091 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1298 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1092 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1299 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1093 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1300 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1094 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1301 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1095 secondaryScreen secondaryScroll selectstyle shade term_name title 1302 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1096 transient_for transparent transparent_all tripleclickwords utmpInhibit 1303 term_name title transient_for transparent tripleclickwords urgentOnBell
1097 visualBell 1304 utmpInhibit visualBell
1098 1305
1099=cut 1306=cut
1100 1307
1101sub resource($$;$) { 1308sub resource($$;$) {
1102 my ($self, $name) = (shift, shift); 1309 my ($self, $name) = (shift, shift);
1103 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1310 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1104 &urxvt::term::_resource 1311 goto &urxvt::term::_resource
1105} 1312}
1106 1313
1107=item $value = $term->x_resource ($pattern) 1314=item $value = $term->x_resource ($pattern)
1108 1315
1109Returns the X-Resource for the given pattern, excluding the program or 1316Returns the X-Resource for the given pattern, excluding the program or
1110class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1317class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1111same 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
1112resource with that pattern exists. 1319resource with that pattern exists.
1113 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
1114This 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
1115only one resource database per display, and later invocations might return 1332only one resource database per display, and later invocations might return
1116the wrong resources. 1333the wrong resources.
1117 1334
1118=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1335=item $value = $term->x_resource_boolean ($pattern)
1119 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
1120Adds 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
1121C<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 }
1122 1370
1123=item $rend = $term->rstyle ([$new_rstyle]) 1371=item $rend = $term->rstyle ([$new_rstyle])
1124 1372
1125Return and optionally change the current rendition. Text that is output by 1373Return and optionally change the current rendition. Text that is output by
1126the terminal application will use this style. 1374the terminal application will use this style.
1134 1382
1135=item ($row, $col) = $term->selection_beg ([$row, $col]) 1383=item ($row, $col) = $term->selection_beg ([$row, $col])
1136 1384
1137=item ($row, $col) = $term->selection_end ([$row, $col]) 1385=item ($row, $col) = $term->selection_end ([$row, $col])
1138 1386
1139Return the current values of the selection mark, begin or end positions, 1387Return the current values of the selection mark, begin or end positions.
1140and 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.
1141 1396
1142=item $term->selection_make ($eventtime[, $rectangular]) 1397=item $term->selection_make ($eventtime[, $rectangular])
1143 1398
1144Tries to make a selection as set by C<selection_beg> and 1399Tries to make a selection as set by C<selection_beg> and
1145C<selection_end>. If C<$rectangular> is true (default: false), a 1400C<selection_end>. If C<$rectangular> is true (default: false), a
1146rectangular selection will be made. This is the prefered function to make 1401rectangular selection will be made. This is the preferred function to make
1147a selection. 1402a selection.
1148 1403
1149=item $success = $term->selection_grab ($eventtime) 1404=item $success = $term->selection_grab ($eventtime[, $clipboard])
1150 1405
1151Try 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
1152set by the next method). No visual feedback will be given. This function 1408with the next method. No visual feedback will be given. This function
1153is mostly useful from within C<on_sel_grab> hooks. 1409is mostly useful from within C<on_sel_grab> hooks.
1154 1410
1155=item $oldtext = $term->selection ([$newtext]) 1411=item $oldtext = $term->selection ([$newtext, $clipboard])
1156 1412
1157Return 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.
1158 1419
1159=item $term->overlay_simple ($x, $y, $text) 1420=item $term->overlay_simple ($x, $y, $text)
1160 1421
1161Create 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.
1162 1423
1192 1453
1193The methods currently supported on C<urxvt::overlay> objects are: 1454The methods currently supported on C<urxvt::overlay> objects are:
1194 1455
1195=over 4 1456=over 4
1196 1457
1197=item $overlay->set ($x, $y, $text, $rend) 1458=item $overlay->set ($x, $y, $text[, $rend])
1198 1459
1199Similar 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
1200text 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
1201at 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.
1202 1465
1203=item $overlay->hide 1466=item $overlay->hide
1204 1467
1205If visible, hide the overlay, but do not destroy it. 1468If visible, hide the overlay, but do not destroy it.
1206 1469
1269 1532
1270=item $term->scr_add_lines ($string) 1533=item $term->scr_add_lines ($string)
1271 1534
1272Write 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
1273running inside the terminal. It may not contain command sequences (escape 1536running inside the terminal. It may not contain command sequences (escape
1274codes), 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,
1275string 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.
1276 1540
1277Normally 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
1278confused by changes in cursor position or scrolling. Its useful inside a 1542confused by changes in cursor position or scrolling. Its useful inside a
1279C<on_add_lines> hook, though. 1543C<on_add_lines> hook, though.
1280 1544
1288locale-specific encoding of the terminal and can contain command sequences 1552locale-specific encoding of the terminal and can contain command sequences
1289(escape codes) that will be interpreted. 1553(escape codes) that will be interpreted.
1290 1554
1291=item $term->tt_write ($octets) 1555=item $term->tt_write ($octets)
1292 1556
1293Write 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
1294pass characters instead of octets, you should convert your strings first 1559characters instead of octets, you should convert your strings first to the
1295to 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.
1296 1575
1297=item $old_events = $term->pty_ev_events ([$new_events]) 1576=item $old_events = $term->pty_ev_events ([$new_events])
1298 1577
1299Replaces 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
1300be 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
1301description of C<< urxvt::timer->events >>. Make sure to always restore 1580description of C<< urxvt::timer->events >>. Make sure to always restore
1302the previous value. 1581the previous value.
1303 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
1304=item $windowid = $term->parent 1588=item $windowid = $term->parent
1305 1589
1306Return the window id of the toplevel window. 1590Return the window id of the toplevel window.
1307 1591
1308=item $windowid = $term->vt 1592=item $windowid = $term->vt
1314Adds 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
1315to receive pointer events all the times: 1599to receive pointer events all the times:
1316 1600
1317 $term->vt_emask_add (urxvt::PointerMotionMask); 1601 $term->vt_emask_add (urxvt::PointerMotionMask);
1318 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
1319=item $window_width = $term->width 1617=item $window_width = $term->width
1320 1618
1321=item $window_height = $term->height 1619=item $window_height = $term->height
1322 1620
1323=item $font_width = $term->fwidth 1621=item $font_width = $term->fwidth
1353=item $env = $term->env 1651=item $env = $term->env
1354 1652
1355Returns 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
1356similar to C<\%ENV>. 1654similar to C<\%ENV>.
1357 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
1358=cut 1665=cut
1359 1666
1360sub env { 1667sub env {
1361 if (my $env = $_[0]->_env) {
1362 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1668 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1363 } else {
1364 +{ %ENV }
1365 }
1366} 1669}
1367 1670
1368=item $modifiermask = $term->ModLevel3Mask 1671=item $modifiermask = $term->ModLevel3Mask
1369 1672
1370=item $modifiermask = $term->ModMetaMask 1673=item $modifiermask = $term->ModMetaMask
1375AltGr), 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.
1376 1679
1377=item $screen = $term->current_screen 1680=item $screen = $term->current_screen
1378 1681
1379Returns the currently displayed screen (0 primary, 1 secondary). 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.
1380 1687
1381=item $view_start = $term->view_start ([$newvalue]) 1688=item $view_start = $term->view_start ([$newvalue])
1382 1689
1383Returns the row number of the topmost displayed line. Maximum value is 1690Returns the row number of the topmost displayed line. Maximum value is
1384C<0>, which displays the normal terminal contents. Lower values scroll 1691C<0>, which displays the normal terminal contents. Lower values scroll
1390compare the on-screen display with its stored representation. If they 1697compare the on-screen display with its stored representation. If they
1391differ, it redraws the differences. 1698differ, it redraws the differences.
1392 1699
1393Used after changing terminal contents to display them. 1700Used after changing terminal contents to display them.
1394 1701
1702=item $term->refresh_check
1703
1704Checks if a refresh has been requested and, if so, schedules one.
1705
1395=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1706=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1396 1707
1397Returns the text of the entire row with number C<$row_number>. Row C<0> 1708Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1398is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1709is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1399terminal line. The scrollback buffer starts at line C<-1> and extends to
1400line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1710terminal line. Nothing will be returned if a nonexistent line
1401is requested. 1711is requested.
1402 1712
1403If C<$new_text> is specified, it will replace characters in the current 1713If C<$new_text> is specified, it will replace characters in the current
1404line, starting at column C<$start_col> (default C<0>), which is useful 1714line, starting at column C<$start_col> (default C<0>), which is useful
1405to replace only parts of a line. The font index in the rendition will 1715to replace only parts of a line. The font index in the rendition will
1406automatically be updated. 1716automatically be updated.
1407 1717
1408C<$text> is in a special encoding: tabs and wide characters that use 1718C<$text> is in a special encoding: tabs and wide characters that use more
1409more than one cell when displayed are padded with C<$urxvt::NOCHAR> 1719than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410characters. Characters with combining characters and other characters that 1720characters. Characters with combining characters and other characters that
1411do not fit into the normal tetx encoding will be replaced with characters 1721do not fit into the normal text encoding will be replaced with characters
1412in the private use area. 1722in the private use area.
1413 1723
1414You have to obey this encoding when changing text. The advantage is 1724You have to obey this encoding when changing text. The advantage is
1415that C<substr> and similar functions work on screen cells and not on 1725that C<substr> and similar functions work on screen cells and not on
1416characters. 1726characters.
1501} 1811}
1502 1812
1503sub urxvt::line::t { 1813sub urxvt::line::t {
1504 my ($self) = @_; 1814 my ($self) = @_;
1505 1815
1506 if (@_ > 1) 1816 if (@_ > 1) {
1507 {
1508 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1817 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1509 for $self->{beg} .. $self->{end}; 1818 for $self->{beg} .. $self->{end};
1510 } 1819 }
1511 1820
1512 defined wantarray && 1821 defined wantarray &&
1513 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1822 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1514 0, $self->{len} 1823 0, $self->{len}
1515} 1824}
1516 1825
1517sub urxvt::line::r { 1826sub urxvt::line::r {
1518 my ($self) = @_; 1827 my ($self) = @_;
1519 1828
1520 if (@_ > 1) 1829 if (@_ > 1) {
1521 {
1522 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1830 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1523 for $self->{beg} .. $self->{end}; 1831 for $self->{beg} .. $self->{end};
1524 } 1832 }
1525 1833
1526 if (defined wantarray) { 1834 if (defined wantarray) {
1527 my $rend = [ 1835 my $rend = [
1528 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1836 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1529 ]; 1837 ];
1561where one character corresponds to one screen cell. See 1869where one character corresponds to one screen cell. See
1562C<< $term->ROW_t >> for details. 1870C<< $term->ROW_t >> for details.
1563 1871
1564=item $string = $term->special_decode $text 1872=item $string = $term->special_decode $text
1565 1873
1566Converts rxvt-unicodes text reprsentation into a perl string. See 1874Converts rxvt-unicodes text representation into a perl string. See
1567C<< $term->ROW_t >> for details. 1875C<< $term->ROW_t >> for details.
1568 1876
1569=item $success = $term->grab_button ($button, $modifiermask) 1877=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1570 1878
1879=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1880
1571Registers a synchronous button grab. See the XGrabButton manpage. 1881Register/unregister a synchronous button grab. See the XGrabButton
1882manpage.
1572 1883
1573=item $success = $term->grab ($eventtime[, $sync]) 1884=item $success = $term->grab ($eventtime[, $sync])
1574 1885
1575Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1886Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576synchronous (C<$sync> is true). Also remembers the grab timestampe. 1887synchronous (C<$sync> is true). Also remembers the grab timestamp.
1577 1888
1578=item $term->allow_events_async 1889=item $term->allow_events_async
1579 1890
1580Calls XAllowEvents with AsyncBoth for the most recent grab. 1891Calls XAllowEvents with AsyncBoth for the most recent grab.
1581 1892
1588Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1899Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1589recent grab. 1900recent grab.
1590 1901
1591=item $term->ungrab 1902=item $term->ungrab
1592 1903
1593Calls XUngrab for the most recent grab. Is called automatically on 1904Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1594evaluation errors, as it is better to lose the grab in the error case as 1905evaluation errors, as it is better to lose the grab in the error case as
1595the session. 1906the session.
1596 1907
1597=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1908=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598 1909
1600 1911
1601=item @atoms = $term->XListProperties ($window) 1912=item @atoms = $term->XListProperties ($window)
1602 1913
1603=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1914=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604 1915
1605=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1916=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1606 1917
1607=item $term->XDeleteProperty ($window, $property) 1918=item $term->XDeleteProperty ($window, $property)
1608 1919
1609=item $window = $term->DefaultRootWindow 1920=item $window = $term->DefaultRootWindow
1610 1921
1617=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1928=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1618 1929
1619=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1930=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1620 1931
1621=item $term->XChangeInput ($window, $add_events[, $del_events]) 1932=item $term->XChangeInput ($window, $add_events[, $del_events])
1933
1934=item $keysym = $term->XStringToKeysym ($string)
1935
1936=item $string = $term->XKeysymToString ($keysym)
1622 1937
1623Various X or X-related functions. The C<$term> object only serves as 1938Various X or X-related functions. The C<$term> object only serves as
1624the source of the display, otherwise those functions map more-or-less 1939the source of the display, otherwise those functions map more-or-less
1625directory onto the X functions of the same name. 1940directly onto the X functions of the same name.
1626 1941
1627=back 1942=back
1628 1943
1629=cut 1944=cut
1630 1945
1694 my ($self, $text, $cb) = @_; 2009 my ($self, $text, $cb) = @_;
1695 2010
1696 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2011 $self->add_item ({ type => "button", text => $text, activate => $cb});
1697} 2012}
1698 2013
1699=item $popup->add_toggle ($text, $cb, $initial_value) 2014=item $popup->add_toggle ($text, $initial_value, $cb)
1700 2015
1701Adds a toggle/checkbox item to the popup. Teh callback gets called 2016Adds a toggle/checkbox item to the popup. The callback gets called
1702whenever it gets toggled, with a boolean indicating its value as its first 2017whenever it gets toggled, with a boolean indicating its new value as its
1703argument. 2018first argument.
1704 2019
1705=cut 2020=cut
1706 2021
1707sub add_toggle { 2022sub add_toggle {
1708 my ($self, $text, $cb, $value) = @_; 2023 my ($self, $text, $value, $cb) = @_;
1709 2024
1710 my $item; $item = { 2025 my $item; $item = {
1711 type => "button", 2026 type => "button",
1712 text => " $text", 2027 text => " $text",
1713 value => $value, 2028 value => $value,
1732 my $env = $self->{term}->env; 2047 my $env = $self->{term}->env;
1733 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2048 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1734 delete $env->{LC_ALL}; 2049 delete $env->{LC_ALL};
1735 $env->{LC_CTYPE} = $self->{term}->locale; 2050 $env->{LC_CTYPE} = $self->{term}->locale;
1736 2051
1737 urxvt::term->new ($env, "popup", 2052 my $term = urxvt::term->new (
2053 $env, "popup",
1738 "--perl-lib" => "", "--perl-ext-common" => "", 2054 "--perl-lib" => "", "--perl-ext-common" => "",
1739 "-pty-fd" => -1, "-sl" => 0, 2055 "-pty-fd" => -1, "-sl" => 0,
1740 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2056 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1741 "--transient-for" => $self->{term}->parent, 2057 "--transient-for" => $self->{term}->parent,
1742 "-display" => $self->{term}->display_id, 2058 "-display" => $self->{term}->display_id,
1743 "-pe" => "urxvt-popup") 2059 "-pe" => "urxvt-popup",
1744 or die "unable to create popup window\n"; 2060 ) or die "unable to create popup window\n";
2061
2062 unless (delete $term->{urxvt_popup_init_done}) {
2063 $term->ungrab;
2064 $term->destroy;
2065 die "unable to initialise popup window\n";
2066 }
1745} 2067}
1746 2068
1747sub DESTROY { 2069sub DESTROY {
1748 my ($self) = @_; 2070 my ($self) = @_;
1749 2071
1754=back 2076=back
1755 2077
1756=cut 2078=cut
1757 2079
1758package urxvt::watcher; 2080package urxvt::watcher;
1759
1760@urxvt::timer::ISA = __PACKAGE__;
1761@urxvt::iow::ISA = __PACKAGE__;
1762@urxvt::pw::ISA = __PACKAGE__;
1763@urxvt::iw::ISA = __PACKAGE__;
1764 2081
1765=head2 The C<urxvt::timer> Class 2082=head2 The C<urxvt::timer> Class
1766 2083
1767This class implements timer watchers/events. Time is represented as a 2084This class implements timer watchers/events. Time is represented as a
1768fractional number of seconds since the epoch. Example: 2085fractional number of seconds since the epoch. Example:
1772 ->new 2089 ->new
1773 ->interval (1) 2090 ->interval (1)
1774 ->cb (sub { 2091 ->cb (sub {
1775 $term->{overlay}->set (0, 0, 2092 $term->{overlay}->set (0, 0,
1776 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2093 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1777 }); 2094 });
1778 2095
1779=over 4 2096=over 4
1780 2097
1781=item $timer = new urxvt::timer 2098=item $timer = new urxvt::timer
1782 2099
1785 2102
1786=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2103=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1787 2104
1788Set the callback to be called when the timer triggers. 2105Set the callback to be called when the timer triggers.
1789 2106
1790=item $tstamp = $timer->at
1791
1792Return the time this watcher will fire next.
1793
1794=item $timer = $timer->set ($tstamp) 2107=item $timer = $timer->set ($tstamp[, $interval])
1795 2108
1796Set the time the event is generated to $tstamp. 2109Set the time the event is generated to $tstamp (and optionally specifies a
2110new $interval).
1797 2111
1798=item $timer = $timer->interval ($interval) 2112=item $timer = $timer->interval ($interval)
1799 2113
1800Normally (and when C<$interval> is C<0>), the timer will automatically 2114By default (and when C<$interval> is C<0>), the timer will automatically
1801stop after it has fired once. If C<$interval> is non-zero, then the timer 2115stop after it has fired once. If C<$interval> is non-zero, then the timer
1802is automatically rescheduled at the given intervals. 2116is automatically rescheduled at the given intervals.
1803 2117
1804=item $timer = $timer->start 2118=item $timer = $timer->start
1805 2119
1806Start the timer. 2120Start the timer.
1807 2121
1808=item $timer = $timer->start ($tstamp) 2122=item $timer = $timer->start ($tstamp[, $interval])
1809 2123
1810Set the event trigger time to C<$tstamp> and start the timer. 2124Set the event trigger time to C<$tstamp> and start the timer. Optionally
2125also replaces the interval.
1811 2126
1812=item $timer = $timer->after ($delay) 2127=item $timer = $timer->after ($delay[, $interval])
1813 2128
1814Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2129Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1815 2130
1816=item $timer = $timer->stop 2131=item $timer = $timer->stop
1817 2132
1825 2140
1826 $term->{socket} = ... 2141 $term->{socket} = ...
1827 $term->{iow} = urxvt::iow 2142 $term->{iow} = urxvt::iow
1828 ->new 2143 ->new
1829 ->fd (fileno $term->{socket}) 2144 ->fd (fileno $term->{socket})
1830 ->events (urxvt::EVENT_READ) 2145 ->events (urxvt::EV_READ)
1831 ->start 2146 ->start
1832 ->cb (sub { 2147 ->cb (sub {
1833 my ($iow, $revents) = @_; 2148 my ($iow, $revents) = @_;
1834 # $revents must be 1 here, no need to check 2149 # $revents must be 1 here, no need to check
1835 sysread $term->{socket}, my $buf, 8192 2150 sysread $term->{socket}, my $buf, 8192
1848Set the callback to be called when io events are triggered. C<$reventmask> 2163Set the callback to be called when io events are triggered. C<$reventmask>
1849is a bitset as described in the C<events> method. 2164is a bitset as described in the C<events> method.
1850 2165
1851=item $iow = $iow->fd ($fd) 2166=item $iow = $iow->fd ($fd)
1852 2167
1853Set the filedescriptor (not handle) to watch. 2168Set the file descriptor (not handle) to watch.
1854 2169
1855=item $iow = $iow->events ($eventmask) 2170=item $iow = $iow->events ($eventmask)
1856 2171
1857Set the event mask to watch. The only allowed values are 2172Set the event mask to watch. The only allowed values are
1858C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2173C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1859together, or C<urxvt::EVENT_NONE>. 2174together, or C<urxvt::EV_NONE>.
1860 2175
1861=item $iow = $iow->start 2176=item $iow = $iow->start
1862 2177
1863Start watching for requested events on the given handle. 2178Start watching for requested events on the given handle.
1864 2179
1865=item $iow = $iow->stop 2180=item $iow = $iow->stop
1866 2181
1867Stop watching for events on the given filehandle. 2182Stop watching for events on the given file handle.
1868 2183
1869=back 2184=back
1870 2185
1871=head2 The C<urxvt::iw> Class 2186=head2 The C<urxvt::iw> Class
1872 2187
1905 ->new 2220 ->new
1906 ->start ($pid) 2221 ->start ($pid)
1907 ->cb (sub { 2222 ->cb (sub {
1908 my ($pw, $exit_status) = @_; 2223 my ($pw, $exit_status) = @_;
1909 ... 2224 ...
1910 }); 2225 });
1911 2226
1912=over 4 2227=over 4
1913 2228
1914=item $pw = new urxvt::pw 2229=item $pw = new urxvt::pw
1915 2230
1919 2234
1920Set the callback to be called when the timer triggers. 2235Set the callback to be called when the timer triggers.
1921 2236
1922=item $pw = $timer->start ($pid) 2237=item $pw = $timer->start ($pid)
1923 2238
1924Tells the wqtcher to start watching for process C<$pid>. 2239Tells the watcher to start watching for process C<$pid>.
1925 2240
1926=item $pw = $pw->stop 2241=item $pw = $pw->stop
1927 2242
1928Stop the watcher. 2243Stop the watcher.
1929 2244
1942 2257
1943=item >= 3 - script loading and management 2258=item >= 3 - script loading and management
1944 2259
1945=item >=10 - all called hooks 2260=item >=10 - all called hooks
1946 2261
1947=item >=11 - hook reutrn values 2262=item >=11 - hook return values
1948 2263
1949=back 2264=back
1950 2265
1951=head1 AUTHOR 2266=head1 AUTHOR
1952 2267
1953 Marc Lehmann <pcg@goof.com> 2268 Marc Lehmann <schmorp@schmorp.de>
1954 http://software.schmorp.de/pkg/rxvt-unicode 2269 http://software.schmorp.de/pkg/rxvt-unicode
1955 2270
1956=cut 2271=cut
1957 2272
19581 22731
2274
2275# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines