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.133 by root, Mon Feb 6 06:14:08 2006 UTC vs.
Revision 1.256 by sf-exg, Thu Jul 14 05:10:06 2016 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
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
79You can look at the source of the selection extension to see more
80interesting uses, such as parsing a line from beginning to end.
81
82This extension also offers following bindable keyboard commands:
83
84=over 4
85
86=item rot13
87
88Rot-13 the selection when activated. Used via keyboard trigger:
89
90 URxvt.keysym.C-M-r: perl:selection:rot13
91
92=back
93
94=item option-popup (enabled by default)
95
96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97runtime.
98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
115
116=item selection-popup (enabled by default)
117
118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119text into various other formats/action (such as uri unescaping, perl
120evaluation, web-browser starting etc.), depending on content.
121
122Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed.
125
126It's sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide wether to add something or not.
128It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>.
131
132The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any
134C<a>s:
135
136 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g }
138 : ()
139 };
140
141=item searchable-scrollback<hotkey> (enabled by default)
142
143Adds regex search functionality to the scrollback buffer, triggered
144by a hotkey (default: C<M-s>). While in search mode, normal terminal
145input/output is suspended and a regex is displayed at the bottom of the
146screen.
147
148Inputting characters appends them to the regex and continues incremental
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary
154selection.
155
156=item readline (enabled by default)
157
158A support package that tries to make editing with readline easier. At the
159moment, it reacts to clicking with the left mouse button by trying to
160move the text cursor to this position. It does so by generating as many
161cursor-left or cursor-right keypresses as required (the this only works
162for programs that correctly support wide characters).
163
164To avoid too many false positives, this is only done when:
165
166=over 4
167
168=item - the tty is in ICANON state.
169
170=item - the text cursor is visible.
171
172=item - the primary screen is currently being displayed.
173
174=item - the mouse is on the same (multi-row-) line as the text cursor.
175
176=back
177
178The normal selection mechanism isn't disabled, so quick successive clicks
179might interfere with selection creation in harmless ways.
180
181=item selection-autotransform
182
183This selection allows you to do automatic transforms on a selection
184whenever a selection is made.
185
186It works by specifying perl snippets (most useful is a single C<s///>
187operator) that modify C<$_> as resources:
188
189 URxvt.selection-autotransform.0: transform
190 URxvt.selection-autotransform.1: transform
191 ...
192
193For example, the following will transform selections of the form
194C<filename:number>, often seen in compiler messages, into C<vi +$filename
195$word>:
196
197 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
198
199And this example matches the same,but replaces it with vi-commands you can
200paste directly into your (vi :) editor:
201
202 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
203
204Of course, this can be modified to suit your needs and your editor :)
205
206To expand the example above to typical perl error messages ("XXX at
207FILENAME line YYY."), you need a slightly more elaborate solution:
208
209 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
210 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
211
212The first line tells the selection code to treat the unchanging part of
213every error message as a selection pattern, and the second line transforms
214the message into vi commands to load the file.
215
216=item tabbed
217
218This transforms the terminal into a tabbar with additional terminals, that
219is, it implements what is commonly refered to as "tabbed terminal". The topmost line
220displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221button per tab.
222
223Clicking a button will activate that tab. Pressing B<Shift-Left> and
224B<Shift-Right> will switch to the tab left or right of the current one,
225while B<Shift-Down> creates a new tab.
226
227The tabbar itself can be configured similarly to a normal terminal, but
228with a resource class of C<URxvt.tabbed>. In addition, it supports the
229following four resources (shown with defaults):
230
231 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
232 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
233 URxvt.tabbed.tab-fg: <colour-index, default 0>
234 URxvt.tabbed.tab-bg: <colour-index, default 1>
235
236See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237indices.
238
239=item mark-urls
240
241Uses per-line display filtering (C<on_line_update>) to underline urls and
242make them clickable. When middle-clicked, the program specified in the
243resource C<urlLauncher> (default C<x-www-browser>) will be started with
244the URL as first argument.
245
246=item xim-onthespot
247
248This (experimental) perl extension implements OnTheSpot editing. It does
249not work perfectly, and some input methods don't seem to work well with
250OnTheSpot editing in general, but it seems to work at leats for SCIM and
251kinput2.
252
253You enable it by specifying this extension and a preedit style of
254C<OnTheSpot>, i.e.:
255
256 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257
258=item automove-background
259
260This is basically a one-line extension that dynamically changes the background pixmap offset
261to the window position, in effect creating the same effect as pseudo transparency with
262a custom pixmap. No scaling is supported in this mode. Exmaple:
263
264 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
265
266=item block-graphics-to-ascii
267
268A not very useful example of filtering all text output to the terminal,
269by replacing all line-drawing characters (U+2500 .. U+259F) by a
270similar-looking ascii character.
271
272=item digital-clock
273
274Displays a digital clock using the built-in overlay.
275
276=item remote-clipboard
277
278Somewhat of a misnomer, this extension adds two menu entries to the
279selection popup that allows one ti run external commands to store the
280selection somewhere and fetch it again.
281
282We use it to implement a "distributed selection mechanism", which just
283means that one command uploads the file to a remote server, and another
284reads it.
285
286The commands can be set using the C<URxvt.remote-selection.store> and
287C<URxvt.remote-selection.fetch> resources. The first should read the
288selection to store from STDIN (always in UTF-8), the second should provide
289the selection data on STDOUT (also in UTF-8).
290
291The defaults (which are likely useless to you) use rsh and cat:
292
293 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295
296=item selection-pastebin
297
298This is a little rarely useful extension that Uploads the selection as
299textfile to a remote site (or does other things). (The implementation is
300not currently secure for use in a multiuser environment as it writes to
301F</tmp> directly.).
302
303It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
304i.e.
305
306 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
307
308Pressing this combination runs a command with C<%> replaced by the name of
309the textfile. This command can be set via a resource:
310
311 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
312
313And the default is likely not useful to anybody but the few people around
314here :)
315
316The name of the textfile is the hex encoded md5 sum of the selection, so
317the same content should lead to the same filename.
318
319After a successful upload the selection will be replaced by the text given
320in the C<selection-pastebin-url> resource (again, the % is the placeholder
321for the filename):
322
323 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324
325=item example-refresh-hooks
326
327Displays a very simple digital clock in the upper right corner of the
328window. Illustrates overwriting the refresh callbacks to create your own
329overlays or changes.
330
331=back
332 56
333=head1 API DOCUMENTATION 57=head1 API DOCUMENTATION
334 58
335=head2 General API Considerations 59=head2 General API Considerations
336 60
350 74
351=over 4 75=over 4
352 76
353=item $text 77=item $text
354 78
355Rxvt-unicodes special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
356always 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.
357 81
358=item $string 82=item $string
359 83
360A 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
364=item $octets 88=item $octets
365 89
366Either binary data or - more common - a text string encoded in a 90Either binary data or - more common - a text string encoded in a
367locale-specific way. 91locale-specific way.
368 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
369=back 99=back
370 100
371=head2 Extension Objects 101=head2 Extension Objects
372 102
373Very 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
374for 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,
375hooks. 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
376about 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
377begin with an underscore character C<_>: these are reserved for internal 108that begin with an underscore character C<_>: these are reserved for
378use. 109internal use.
379 110
380Although 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
381C<urxvt::term> class on this object. 112C<urxvt::term> class on this object.
382 113
383It 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:
384 123
385=over 4 124=over 4
386 125
387=item $urxvt_term = $self->{term} 126=item #:META:RESOURCE:name:type:desc
388 127
389Returns the C<urxvt::term> object associated with this instance of the 128The RESOURCE comment defines a resource used by the extension, where
390extension. This member I<must not> be changed in any way. 129C<name> is the resource name, C<type> is the resource type, C<boolean>
391 130or C<string>, and C<desc> is the resource description.
392=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
393
394Dynamically enable the given hooks (named without the C<on_> prefix) for
395this extension, replacing any previous hook. This is useful when you want
396to overwrite time-critical hooks only temporarily.
397
398=item $self->disable ($hook_name[, $hook_name..])
399
400Dynamically disable the given hooks.
401 131
402=back 132=back
403 133
404=head2 Hooks 134=head2 Hooks
405 135
406The following subroutines can be declared in extension files, and will be 136The following subroutines can be declared in extension files, and will be
407called whenever the relevant event happens. 137called whenever the relevant event happens.
408 138
409The 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
410the in the C<Extension Objects> section. 140the in the C<Extension Objects> section.
411 141
412B<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
413hooks 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
414relevant action might not be carried out by the C++ code. 144relevant action might not be carried out by the C++ code.
427place. 157place.
428 158
429=item on_start $term 159=item on_start $term
430 160
431Called 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
432trying to map (display) the toplevel and returning to the mainloop. 162trying to map (display) the toplevel and returning to the main loop.
433 163
434=item on_destroy $term 164=item on_destroy $term
435 165
436Called whenever something tries to destroy terminal, when the terminal is 166Called whenever something tries to destroy terminal, when the terminal is
437still fully functional (not for long, though). 167still fully functional (not for long, though).
464 194
465Called whenever a selection has been copied, but before the selection is 195Called whenever a selection has been copied, but before the selection is
466requested from the server. The selection text can be queried and changed 196requested from the server. The selection text can be queried and changed
467by calling C<< $term->selection >>. 197by calling C<< $term->selection >>.
468 198
469Returning a true value aborts selection grabbing. It will still be hilighted. 199Returning a true value aborts selection grabbing. It will still be highlighted.
470 200
471=item on_sel_extend $term 201=item on_sel_extend $term
472 202
473Called 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
474click) and is either supposed to return false (normal operation), or 204click) and is either supposed to return false (normal operation), or
475should 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
476processing. This can happen multiple times, as long as the callback 206processing. This can happen multiple times, as long as the callback
477returns 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
478supposed to enlarge the selection more and more, if possible. 208supposed to enlarge the selection more and more, if possible.
479 209
480See the F<selection> example extension. 210See the F<selection> example extension.
481 211
482=item on_view_change $term, $offset 212=item on_view_change $term, $offset
483 213
484Called whenever the view offset changes, i..e the user or program 214Called whenever the view offset changes, i.e. the user or program
485scrolls. Offset C<0> means display the normal terminal, positive values 215scrolls. Offset C<0> means display the normal terminal, positive values
486show this many lines of scrollback. 216show this many lines of scrollback.
487 217
488=item on_scroll_back $term, $lines, $saved 218=item on_scroll_back $term, $lines, $saved
489 219
493 223
494It 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,
495$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
496number of lines that will be in the scrollback buffer. 226number of lines that will be in the scrollback buffer.
497 227
498=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
499 239
500Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 240Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501operating system command) is processed. Cursor position and other state 241operating system command) is processed. Cursor position and other state
502information is up-to-date when this happens. For interoperability, the 242information is up-to-date when this happens. For interoperability, the
503string should start with the extension name and a colon, to distinguish 243string should start with the extension name (sans -osc) and a semicolon,
504it from commands for other extensions, and this might be enforced in the 244to distinguish it from commands for other extensions, and this might be
505future. 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 }
506 256
507Be 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,
508as 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
509other 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.
510 263
511=item on_add_lines $term, $string 264=item on_add_lines $term, $string
512 265
513Called 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
514can 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
519=item on_tt_write $term, $octets 272=item on_tt_write $term, $octets
520 273
521Called 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
522suppress or filter tty input. 275suppress or filter tty input.
523 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
524=item on_line_update $term, $row 284=item on_line_update $term, $row
525 285
526Called 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
527screen output (e.g. underline urls or other useless stuff). Only lines 287screen output (e.g. underline urls or other useless stuff). Only lines
528that are being shown will be filtered, and, due to performance reasons, 288that are being shown will be filtered, and, due to performance reasons,
535later 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
536you cannot just toggle rendition bits, but only set them. 296you cannot just toggle rendition bits, but only set them.
537 297
538=item on_refresh_begin $term 298=item on_refresh_begin $term
539 299
540Called just before the screen gets redrawn. Can be used for overlay 300Called just before the screen gets redrawn. Can be used for overlay or
541or similar effects by modify terminal contents in refresh_begin, and 301similar effects by modifying the terminal contents in refresh_begin, and
542restoring them in refresh_end. The built-in overlay and selection display 302restoring them in refresh_end. The built-in overlay and selection display
543code is run after this hook, and takes precedence. 303code is run after this hook, and takes precedence.
544 304
545=item on_refresh_end $term 305=item on_refresh_end $term
546 306
547Called just after the screen gets redrawn. See C<on_refresh_begin>. 307Called just after the screen gets redrawn. See C<on_refresh_begin>.
548 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
549=item on_user_command $term, $string 317=item on_user_command $term, $string *DEPRECATED*
550 318
551Called whenever the a user-configured event is being activated (e.g. via 319Called whenever a user-configured event is being activated (e.g. via
552a C<perl:string> action bound to a key, see description of the B<keysym> 320a C<perl:string> action bound to a key, see description of the B<keysym>
553resource in the @@RXVT_NAME@@(1) manpage). 321resource in the urxvt(1) manpage).
554 322
555The event is simply the action string. This interface is assumed to change 323The event is simply the action string. This interface is going away in
556slightly in the future. 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.
557 331
558=item on_x_event $term, $event 332=item on_x_event $term, $event
559 333
560Called 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
561windows). Should only be used as a last resort. Most event structure 335windows). Should only be used as a last resort. Most event structure
562members are not passed. 336members are not passed.
563 337
338=item on_root_event $term, $event
339
340Like C<on_x_event>, but is called for events on the root window.
341
564=item on_focus_in $term 342=item on_focus_in $term
565 343
566Called whenever the window gets the keyboard focus, before rxvt-unicode 344Called whenever the window gets the keyboard focus, before rxvt-unicode
567does focus in processing. 345does focus in processing.
568 346
569=item on_focus_out $term 347=item on_focus_out $term
570 348
571Called wheneever the window loses keyboard focus, before rxvt-unicode does 349Called whenever the window loses keyboard focus, before rxvt-unicode does
572focus out processing. 350focus out processing.
573 351
574=item on_configure_notify $term, $event 352=item on_configure_notify $term, $event
575 353
576=item on_property_notify $term, $event 354=item on_property_notify $term, $event
587 365
588=item on_map_notify $term, $event 366=item on_map_notify $term, $event
589 367
590=item on_unmap_notify $term, $event 368=item on_unmap_notify $term, $event
591 369
592Called whenever the corresponding X event is received for the terminal If 370Called whenever the corresponding X event is received for the terminal. If
593the 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.
594 372
595The 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
596manpage), 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
597(real, not screen-based) row and column under the mouse cursor. 375(real, not screen-based) row and column under the mouse cursor.
598 376
599C<on_key_press> additionally receives the string rxvt-unicode would 377C<on_key_press> additionally receives the string rxvt-unicode would
600output, if any, in locale-specific encoding. 378output, if any, in locale-specific encoding.
601 379
602subwindow.
603
604=item on_client_message $term, $event 380=item on_client_message $term, $event
605 381
606=item on_wm_protocols $term, $event 382=item on_wm_protocols $term, $event
607 383
608=item on_wm_delete_window $term, $event 384=item on_wm_delete_window $term, $event
609 385
610Called when various types of ClientMessage events are received (all with 386Called when various types of ClientMessage events are received (all with
611format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 387format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
612 388
389=item on_bell $term
390
391Called on receipt of a bell character.
392
613=back 393=back
614 394
615=cut 395=cut
616 396
617package urxvt; 397package urxvt;
618 398
619use utf8; 399use utf8;
620use strict; 400use strict 'vars';
621use Carp (); 401use Carp ();
622use Scalar::Util (); 402use Scalar::Util ();
623use List::Util (); 403use List::Util ();
624 404
625our $VERSION = 1; 405our $VERSION = 1;
626our $TERM; 406our $TERM;
627our @TERM_INIT; 407our @TERM_INIT; # should go, prevents async I/O etc.
628our @TERM_EXT; 408our @TERM_EXT; # should go, prevents async I/O etc.
629our @HOOKNAME; 409our @HOOKNAME;
630our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 410our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
631our %OPTION; 411our %OPTION;
632 412
633our $LIBDIR; 413our $LIBDIR;
659The current terminal. This variable stores the current C<urxvt::term> 439The current terminal. This variable stores the current C<urxvt::term>
660object, whenever a callback/hook is executing. 440object, whenever a callback/hook is executing.
661 441
662=item @urxvt::TERM_INIT 442=item @urxvt::TERM_INIT
663 443
664All 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
665created 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
666gets cleared before the codereferences that were in it are being executed, 446gets cleared before the code references that were in it are being executed,
667so coderefs can push themselves onto it again if they so desire. 447so references can push themselves onto it again if they so desire.
668 448
669This complements to the perl-eval commandline option, but gets executed 449This complements to the perl-eval command line option, but gets executed
670first. 450first.
671 451
672=item @urxvt::TERM_EXT 452=item @urxvt::TERM_EXT
673 453
674Works 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
681 461
682=over 4 462=over 4
683 463
684=item urxvt::fatal $errormessage 464=item urxvt::fatal $errormessage
685 465
686Fatally aborts execution with the given error message. Avoid at all 466Fatally aborts execution with the given error message (which should
687costs! The only time this is acceptable is when the terminal process 467include a trailing newline). Avoid at all costs! The only time this
688starts up. 468is acceptable (and useful) is in the init hook, where it prevents the
469terminal from starting up.
689 470
690=item urxvt::warn $string 471=item urxvt::warn $string
691 472
692Calls 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
693newline. The module also overwrites the C<warn> builtin with a function 474newline. The module also overwrites the C<warn> builtin with a function
694that calls this function. 475that calls this function.
695 476
696Using 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
697correct place, e.g. on stderr of the connecting urxvtc client. 478correct place, e.g. on stderr of the connecting urxvtc client.
699Messages have a size limit of 1023 bytes currently. 480Messages have a size limit of 1023 bytes currently.
700 481
701=item @terms = urxvt::termlist 482=item @terms = urxvt::termlist
702 483
703Returns all urxvt::term objects that exist in this process, regardless of 484Returns all urxvt::term objects that exist in this process, regardless of
704wether they are started, being destroyed etc., so be careful. Only term 485whether they are started, being destroyed etc., so be careful. Only term
705objects that have perl extensions attached will be returned (because there 486objects that have perl extensions attached will be returned (because there
706is no urxvt::term objet associated with others). 487is no urxvt::term object associated with others).
707 488
708=item $time = urxvt::NOW 489=item $time = urxvt::NOW
709 490
710Returns the "current time" (as per the event loop). 491Returns the "current time" (as per the event loop).
711 492
754 535
755=item $rend = urxvt::OVERLAY_RSTYLE 536=item $rend = urxvt::OVERLAY_RSTYLE
756 537
757Return the rendition mask used for overlays by default. 538Return the rendition mask used for overlays by default.
758 539
759=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
760 542
761Return the bit that enabled bold, italic, blink, reverse-video and 543Return the bit that enabled bold, italic, blink, reverse-video and
762underline, respectively. To enable such a style, just logically OR it into 544underline, respectively. To enable such a style, just logically OR it into
763the bitset. 545the bitset.
764 546
801 }; 583 };
802} 584}
803 585
804no warnings 'utf8'; 586no warnings 'utf8';
805 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 return 1 unless $isarg;
610
611 if ($v->[1] eq "boolean") {
612 $term->put_option_db ($name, $flag ? "true" : "false");
613 return 1;
614 } else {
615 $term->put_option_db ($name, $value);
616 return 1 + 2;
617 }
618 }
619 }
620
621 0
622}
623
624sub usage {
625 my ($term, $usage_type) = @_;
626
627 $term->scan_extensions;
628
629 my $r = $term->{meta}{resource};
630
631 for my $pattern (sort keys %$r) {
632 my ($ext, $type, $desc) = @{ $r->{$pattern} };
633
634 $desc .= " (-pe $ext)";
635
636 if ($usage_type == 1) {
637 $pattern =~ y/./-/;
638 $pattern =~ s/-$/-.../g;
639
640 if ($type eq "boolean") {
641 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
642 } else {
643 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
644 }
645 } else {
646 $pattern =~ s/\.$/.*/g;
647 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
648 }
649 }
650}
651
806my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 652my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
807 653
808sub verbose { 654sub verbose {
809 my ($level, $msg) = @_; 655 my ($level, $msg) = @_;
810 warn "$msg\n" if $level <= $verbosity; 656 warn "$msg\n" if $level <= $verbosity;
822 $pkg =~ s/[^[:word:]]/_/g; 668 $pkg =~ s/[^[:word:]]/_/g;
823 $pkg = "urxvt::ext::$pkg"; 669 $pkg = "urxvt::ext::$pkg";
824 670
825 verbose 3, "loading extension '$path' into package '$pkg'"; 671 verbose 3, "loading extension '$path' into package '$pkg'";
826 672
673 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
674
827 open my $fh, "<:raw", $path 675 open my $fh, "<:raw", $path
828 or die "$path: $!"; 676 or die "$path: $!";
829 677
830 my $source = 678 my $source =
831 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 679 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
832 . "#line 1 \"$path\"\n{\n" 680 . "#line 1 \"$path\"\n{\n"
833 . (do { local $/; <$fh> }) 681 . (do { local $/; <$fh> })
834 . "\n};\n1"; 682 . "\n};\n1";
835 683
836 eval $source 684 eval $source
845# called by the rxvt core 693# called by the rxvt core
846sub invoke { 694sub invoke {
847 local $TERM = shift; 695 local $TERM = shift;
848 my $htype = shift; 696 my $htype = shift;
849 697
850 if ($htype == 0) { # INIT 698 if ($htype == HOOK_INIT) {
851 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 699 my @dirs = $TERM->perl_libdirs;
852 700
701 $TERM->scan_extensions;
702
853 my %ext_arg; 703 my %ext_arg;
854 704
855 { 705 {
856 my @init = @TERM_INIT; 706 my @init = @TERM_INIT;
857 @TERM_INIT = (); 707 @TERM_INIT = ();
859 my @pkg = @TERM_EXT; 709 my @pkg = @TERM_EXT;
860 @TERM_EXT = (); 710 @TERM_EXT = ();
861 $TERM->register_package ($_) for @pkg; 711 $TERM->register_package ($_) for @pkg;
862 } 712 }
863 713
714 for (
864 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 715 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
716 @{ delete $TERM->{perl_ext_3} }
717 ) {
865 if ($_ eq "default") { 718 if ($_ eq "default") {
719
720 $ext_arg{$_} = []
866 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 721 for qw(selection option-popup selection-popup readline searchable-scrollback);
722
723 for ($TERM->_keysym_resources) {
724 next if /^(?:string|command|builtin|builtin-string|perl)/;
725 next unless /^([A-Za-z0-9_\-]+):/;
726
727 my $ext = $1;
728
729 $ext_arg{$ext} = [];
730 }
731
867 } elsif (/^-(.*)$/) { 732 } elsif (/^-(.*)$/) {
868 delete $ext_arg{$1}; 733 delete $ext_arg{$1};
734
869 } elsif (/^([^<]+)<(.*)>$/) { 735 } elsif (/^([^<]+)<(.*)>$/) {
870 push @{ $ext_arg{$1} }, $2; 736 push @{ $ext_arg{$1} }, $2;
737
871 } else { 738 } else {
872 $ext_arg{$_} ||= []; 739 $ext_arg{$_} ||= [];
873 } 740 }
874 } 741 }
875 742
891 758
892 if (my $cb = $TERM->{_hook}[$htype]) { 759 if (my $cb = $TERM->{_hook}[$htype]) {
893 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 760 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
894 if $verbosity >= 10; 761 if $verbosity >= 10;
895 762
896 keys %$cb; 763 if ($htype == HOOK_ACTION) {
764 # this hook is only sent to the extension with the name
765 # matching the first arg
766 my $pkg = shift;
767 $pkg =~ y/-/_/;
768 $pkg = "urxvt::ext::$pkg";
897 769
898 while (my ($pkg, $cb) = each %$cb) { 770 $cb = $cb->{$pkg}
771 or return undef; #TODO: maybe warn user?
772
773 $cb = { $pkg => $cb };
774 }
775
776 for my $pkg (keys %$cb) {
899 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 777 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
900 $retval ||= $retval_; 778 $retval ||= $retval_;
901 779
902 if ($@) { 780 if ($@) {
903 $TERM->ungrab; # better to lose the grab than the session 781 $TERM->ungrab; # better to lose the grab than the session
904 warn $@; 782 warn $@;
907 785
908 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 786 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
909 if $verbosity >= 11; 787 if $verbosity >= 11;
910 } 788 }
911 789
912 if ($htype == 1) { # DESTROY 790 if ($htype == HOOK_DESTROY) {
913 # clear package objects 791 # clear package objects
914 %$_ = () for values %{ $TERM->{_pkg} }; 792 %$_ = () for values %{ $TERM->{_pkg} };
915 793
916 # clear package 794 # clear package
917 %$TERM = (); 795 %$TERM = ();
922 800
923sub SET_COLOR($$$) { 801sub SET_COLOR($$$) {
924 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 802 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
925} 803}
926 804
927# urxvt::term::extension 805sub rend2mask {
806 no strict 'refs';
807 my ($str, $mask) = (@_, 0);
808 my %color = ( fg => undef, bg => undef );
809 my @failed;
810 for my $spec ( split /\s+/, $str ) {
811 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
812 $color{lc($1)} = $2;
813 } else {
814 my $neg = $spec =~ s/^[-^]//;
815 unless ( exists &{"RS_$spec"} ) {
816 push @failed, $spec;
817 next;
818 }
819 my $cur = &{"RS_$spec"};
820 if ( $neg ) {
821 $mask &= ~$cur;
822 } else {
823 $mask |= $cur;
824 }
825 }
826 }
827 ($mask, @color{qw(fg bg)}, \@failed)
828}
928 829
929package urxvt::term::extension; 830package urxvt::term::extension;
930 831
931sub enable { 832=head2 The C<urxvt::term::extension> class
932 my ($self, %hook) = @_;
933 my $pkg = $self->{_pkg};
934 833
935 while (my ($name, $cb) = each %hook) { 834Each extension attached to a terminal object is represented by
936 my $htype = $HOOKTYPE{uc $name}; 835a C<urxvt::term::extension> object.
937 defined $htype
938 or Carp::croak "unsupported hook type '$name'";
939 836
940 $self->set_should_invoke ($htype, +1) 837You can use these objects, which are passed to all callbacks to store any
941 unless exists $self->{term}{_hook}[$htype]{$pkg}; 838state related to the terminal and extension instance.
942 839
943 $self->{term}{_hook}[$htype]{$pkg} = $cb; 840The methods (And data members) documented below can be called on extension
944 } 841objects, in addition to call methods documented for the <urxvt::term>
945} 842class.
946 843
947sub disable { 844=over 4
948 my ($self, @hook) = @_;
949 my $pkg = $self->{_pkg};
950 845
951 for my $name (@hook) { 846=item $urxvt_term = $self->{term}
952 my $htype = $HOOKTYPE{uc $name};
953 defined $htype
954 or Carp::croak "unsupported hook type '$name'";
955 847
956 $self->set_should_invoke ($htype, -1) 848Returns the C<urxvt::term> object associated with this instance of the
957 if delete $self->{term}{_hook}[$htype]{$pkg}; 849extension. This member I<must not> be changed in any way.
958 } 850
959} 851=cut
960 852
961our $AUTOLOAD; 853our $AUTOLOAD;
962 854
963sub AUTOLOAD { 855sub AUTOLOAD {
964 $AUTOLOAD =~ /:([^:]+)$/ 856 $AUTOLOAD =~ /:([^:]+)$/
977 869
978sub DESTROY { 870sub DESTROY {
979 # nop 871 # nop
980} 872}
981 873
982# urxvt::destroy_hook 874# urxvt::destroy_hook (basically a cheap Guard:: implementation)
983 875
984sub urxvt::destroy_hook::DESTROY { 876sub urxvt::destroy_hook::DESTROY {
985 ${$_[0]}->(); 877 ${$_[0]}->();
986} 878}
987 879
988sub urxvt::destroy_hook(&) { 880sub urxvt::destroy_hook(&) {
989 bless \shift, urxvt::destroy_hook:: 881 bless \shift, urxvt::destroy_hook::
990} 882}
883
884=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
885
886Dynamically enable the given hooks (named without the C<on_> prefix) for
887this extension, replacing any hook previously installed via C<enable> in
888this extension.
889
890This is useful when you want to overwrite time-critical hooks only
891temporarily.
892
893To install additional callbacks for the same hook, you can use the C<on>
894method of the C<urxvt::term> class.
895
896=item $self->disable ($hook_name[, $hook_name..])
897
898Dynamically disable the given hooks.
899
900=cut
901
902sub enable {
903 my ($self, %hook) = @_;
904 my $pkg = $self->{_pkg};
905
906 while (my ($name, $cb) = each %hook) {
907 my $htype = $HOOKTYPE{uc $name};
908 defined $htype
909 or Carp::croak "unsupported hook type '$name'";
910
911 $self->set_should_invoke ($htype, +1)
912 unless exists $self->{term}{_hook}[$htype]{$pkg};
913
914 $self->{term}{_hook}[$htype]{$pkg} = $cb;
915 }
916}
917
918sub disable {
919 my ($self, @hook) = @_;
920 my $pkg = $self->{_pkg};
921
922 for my $name (@hook) {
923 my $htype = $HOOKTYPE{uc $name};
924 defined $htype
925 or Carp::croak "unsupported hook type '$name'";
926
927 $self->set_should_invoke ($htype, -1)
928 if delete $self->{term}{_hook}[$htype]{$pkg};
929 }
930}
931
932=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
933
934Similar to the C<enable> enable, but installs additional callbacks for
935the given hook(s) (that is, it doesn't replace existing callbacks), and
936returns a guard object. When the guard object is destroyed the callbacks
937are disabled again.
938
939=cut
940
941sub urxvt::extension::on_disable::DESTROY {
942 my $disable = shift;
943
944 my $term = delete $disable->{""};
945
946 while (my ($htype, $id) = each %$disable) {
947 delete $term->{_hook}[$htype]{$id};
948 $term->set_should_invoke ($htype, -1);
949 }
950}
951
952sub on {
953 my ($self, %hook) = @_;
954
955 my $term = $self->{term};
956
957 my %disable = ( "" => $term );
958
959 while (my ($name, $cb) = each %hook) {
960 my $htype = $HOOKTYPE{uc $name};
961 defined $htype
962 or Carp::croak "unsupported hook type '$name'";
963
964 $term->set_should_invoke ($htype, +1);
965 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
966 = sub { shift; $cb->($self, @_) }; # very ugly indeed
967 }
968
969 bless \%disable, "urxvt::extension::on_disable"
970}
971
972=item $self->bind_action ($hotkey, $action)
973
974=item $self->x_resource ($pattern)
975
976=item $self->x_resource_boolean ($pattern)
977
978These methods support an additional C<%> prefix for C<$action> or
979C<$pattern> when called on an extension object, compared to the
980C<urxvt::term> methods of the same name - see the description of these
981methods in the C<urxvt::term> class for details.
982
983=cut
984
985sub bind_action {
986 my ($self, $hotkey, $action) = @_;
987 $action =~ s/^%:/$_[0]{_name}:/;
988 $self->{term}->bind_action ($hotkey, $action)
989}
990
991sub x_resource {
992 my ($self, $name) = @_;
993 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
994 $self->{term}->x_resource ($name)
995}
996
997sub x_resource_boolean {
998 my ($self, $name) = @_;
999 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1000 $self->{term}->x_resource_boolean ($name)
1001}
1002
1003=back
1004
1005=cut
991 1006
992package urxvt::anyevent; 1007package urxvt::anyevent;
993 1008
994=head2 The C<urxvt::anyevent> Class 1009=head2 The C<urxvt::anyevent> Class
995 1010
996The sole purpose of this class is to deliver an interface to the 1011The sole purpose of this class is to deliver an interface to the
997C<AnyEvent> module - any module using it will work inside urxvt without 1012C<AnyEvent> module - any module using it will work inside urxvt without
998further programming. The only exception is that you cannot wait on 1013further programming. The only exception is that you cannot wait on
999condition variables, but non-blocking condvar use is ok. What this means 1014condition variables, but non-blocking condvar use is ok.
1000is that you cannot use blocking APIs, but the non-blocking variant should
1001work.
1002 1015
1003=cut 1016In practical terms this means is that you cannot use blocking APIs, but
1017the non-blocking variant should work.
1004 1018
1019=cut
1020
1005our $VERSION = 1; 1021our $VERSION = '5.23';
1006 1022
1007$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1023$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1008push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1024push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1009 1025
1010sub timer { 1026sub timer {
1012 1028
1013 my $cb = $arg{cb}; 1029 my $cb = $arg{cb};
1014 1030
1015 urxvt::timer 1031 urxvt::timer
1016 ->new 1032 ->new
1017 ->start (urxvt::NOW + $arg{after}) 1033 ->after ($arg{after}, $arg{interval})
1018 ->cb (sub { 1034 ->cb ($arg{interval} ? $cb : sub {
1019 $_[0]->stop; # need to cancel manually 1035 $_[0]->stop; # need to cancel manually
1020 $cb->(); 1036 $cb->();
1021 }) 1037 })
1022} 1038}
1023 1039
1024sub io { 1040sub io {
1025 my ($class, %arg) = @_; 1041 my ($class, %arg) = @_;
1026 1042
1027 my $cb = $arg{cb}; 1043 my $cb = $arg{cb};
1044 my $fd = fileno $arg{fh};
1045 defined $fd or $fd = $arg{fh};
1028 1046
1029 bless [$arg{fh}, urxvt::iow 1047 bless [$arg{fh}, urxvt::iow
1030 ->new 1048 ->new
1031 ->fd (fileno $arg{fh}) 1049 ->fd ($fd)
1032 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1050 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1033 | ($arg{poll} =~ /w/ ? 2 : 0)) 1051 | ($arg{poll} =~ /w/ ? 2 : 0))
1034 ->start 1052 ->start
1035 ->cb (sub { 1053 ->cb ($cb)
1036 $cb->(($_[1] & 1 ? 'r' : '')
1037 . ($_[1] & 2 ? 'w' : ''));
1038 })],
1039 urxvt::anyevent:: 1054 ], urxvt::anyevent::
1055}
1056
1057sub idle {
1058 my ($class, %arg) = @_;
1059
1060 my $cb = $arg{cb};
1061
1062 urxvt::iw
1063 ->new
1064 ->start
1065 ->cb ($cb)
1066}
1067
1068sub child {
1069 my ($class, %arg) = @_;
1070
1071 my $cb = $arg{cb};
1072
1073 urxvt::pw
1074 ->new
1075 ->start ($arg{pid})
1076 ->cb (sub {
1077 $_[0]->stop; # need to cancel manually
1078 $cb->($_[0]->rpid, $_[0]->rstatus);
1079 })
1040} 1080}
1041 1081
1042sub DESTROY { 1082sub DESTROY {
1043 $_[0][1]->stop; 1083 $_[0][1]->stop;
1044} 1084}
1045 1085
1046sub condvar { 1086# only needed for AnyEvent < 6 compatibility
1047 bless \my $flag, urxvt::anyevent::condvar:: 1087sub one_event {
1048}
1049
1050sub urxvt::anyevent::condvar::broadcast {
1051 ${$_[0]}++;
1052}
1053
1054sub urxvt::anyevent::condvar::wait {
1055 unless (${$_[0]}) {
1056 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1088 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1057 }
1058} 1089}
1059 1090
1060package urxvt::term; 1091package urxvt::term;
1061 1092
1062=head2 The C<urxvt::term> Class 1093=head2 The C<urxvt::term> Class
1075 urxvt::verbose 6, "register package $pkg to $self"; 1106 urxvt::verbose 6, "register package $pkg to $self";
1076 1107
1077 @{"$pkg\::ISA"} = urxvt::term::extension::; 1108 @{"$pkg\::ISA"} = urxvt::term::extension::;
1078 1109
1079 my $proxy = bless { 1110 my $proxy = bless {
1080 _pkg => $pkg, 1111 _pkg => $pkg,
1112 _name => ${"$pkg\::_NAME"}, # hackish
1081 argv => $argv, 1113 argv => $argv,
1082 }, $pkg; 1114 }, $pkg;
1083 Scalar::Util::weaken ($proxy->{term} = $self); 1115 Scalar::Util::weaken ($proxy->{term} = $self);
1084 1116
1085 $self->{_pkg}{$pkg} = $proxy; 1117 $self->{_pkg}{$pkg} = $proxy;
1086 1118
1089 $proxy->enable ($name => $ref); 1121 $proxy->enable ($name => $ref);
1090 } 1122 }
1091 } 1123 }
1092} 1124}
1093 1125
1126sub perl_libdirs {
1127 map { split /:/ }
1128 $_[0]->resource ("perl_lib"),
1129 $ENV{URXVT_PERL_LIB},
1130 "$ENV{HOME}/.urxvt/ext",
1131 "$LIBDIR/perl"
1132}
1133
1134# scan for available extensions and collect their metadata
1135sub scan_extensions {
1136 my ($self) = @_;
1137
1138 return if exists $self->{meta};
1139
1140 my @urxvtdirs = perl_libdirs $self;
1141# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1142
1143 $self->{meta} = \my %meta;
1144
1145 # first gather extensions
1146
1147 my $gather = sub {
1148 my ($dir, $core) = @_;
1149
1150 opendir my $fh, $dir
1151 or return;
1152
1153 for my $ext (readdir $fh) {
1154 $ext !~ /^\./
1155 or next;
1156
1157 open my $fh, "<", "$dir/$ext"
1158 or next;
1159
1160 -f $fh
1161 or next;
1162
1163 $ext =~ s/\.uext$// or $core
1164 or next;
1165
1166 my %ext = (dir => $dir);
1167
1168 while (<$fh>) {
1169 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1170 my ($pattern, $type, $desc) = split /:/, $1;
1171 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1172 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1173 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1174 } else {
1175 $ext{resource}{$pattern} = [$ext, $type, $desc];
1176 }
1177 } elsif (/^\s*(?:#|$)/) {
1178 # skip other comments and empty lines
1179 } else {
1180 last; # stop parsing on first non-empty non-comment line
1181 }
1182 }
1183
1184 $meta{ext}{$ext} = \%ext;
1185 }
1186 };
1187
1188# $gather->($_, 0) for @cpandirs;
1189 $gather->($_, 1) for @urxvtdirs;
1190
1191 # and now merge resources
1192
1193 $meta{resource} = \my %resource;
1194
1195 while (my ($k, $v) = each %{ $meta{ext} }) {
1196 #TODO: should check for extensions overriding each other
1197 %resource = (%resource, %{ $v->{resource} });
1198 }
1199}
1200
1094=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1201=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1095 1202
1096Creates a new terminal, very similar as if you had started it with system 1203Creates a new terminal, very similar as if you had started it with system
1097C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1204C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1098hash which defines the environment of the new terminal. 1205hash which defines the environment of the new terminal.
1115} 1222}
1116 1223
1117=item $term->destroy 1224=item $term->destroy
1118 1225
1119Destroy the terminal object (close the window, free resources 1226Destroy the terminal object (close the window, free resources
1120etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1227etc.). Please note that urxvt will not exit as long as any event
1121watchers (timers, io watchers) are still active. 1228watchers (timers, io watchers) are still active.
1122 1229
1123=item $term->exec_async ($cmd[, @args]) 1230=item $term->exec_async ($cmd[, @args])
1124 1231
1125Works like the combination of the C<fork>/C<exec> builtins, which executes 1232Works like the combination of the C<fork>/C<exec> builtins, which executes
1149 1256
1150Returns true if the option specified by C<$optval> is enabled, and 1257Returns true if the option specified by C<$optval> is enabled, and
1151optionally change it. All option values are stored by name in the hash 1258optionally change it. All option values are stored by name in the hash
1152C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1259C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1153 1260
1154Here is a a likely non-exhaustive list of option names, please see the 1261Here is a likely non-exhaustive list of option names, please see the
1155source file F</src/optinc.h> to see the actual list: 1262source file F</src/optinc.h> to see the actual list:
1156 1263
1157 borderLess console cursorBlink cursorUnderline hold iconic insecure 1264 borderLess buffered console cursorBlink cursorUnderline hold iconic
1158 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1265 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1159 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1266 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1160 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1267 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1161 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1268 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1162 transparent tripleclickwords utmpInhibit visualBell 1269 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1270 urgentOnBell utmpInhibit visualBell
1163 1271
1164=item $value = $term->resource ($name[, $newval]) 1272=item $value = $term->resource ($name[, $newval])
1165 1273
1166Returns the current resource value associated with a given name and 1274Returns the current resource value associated with a given name and
1167optionally sets a new value. Setting values is most useful in the C<init> 1275optionally sets a new value. Setting values is most useful in the C<init>
1176likely change). 1284likely change).
1177 1285
1178Please note that resource strings will currently only be freed when the 1286Please note that resource strings will currently only be freed when the
1179terminal is destroyed, so changing options frequently will eat memory. 1287terminal is destroyed, so changing options frequently will eat memory.
1180 1288
1181Here is a a likely non-exhaustive list of resource names, not all of which 1289Here is a likely non-exhaustive list of resource names, not all of which
1182are supported in every build, please see the source file F</src/rsinc.h> 1290are supported in every build, please see the source file F</src/rsinc.h>
1183to see the actual list: 1291to see the actual list:
1184 1292
1185 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1293 answerbackstring backgroundPixmap backspace_key blurradius
1186 borderLess color cursorBlink cursorUnderline cutchars delete_key 1294 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1187 display_name embed ext_bwidth fade font geometry hold iconName 1295 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1188 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1296 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1297 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1189 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1298 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1190 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1299 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1191 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1300 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1192 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1301 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1193 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1302 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1194 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1303 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1195 secondaryScreen secondaryScroll selectstyle shade term_name title 1304 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1196 transient_for transparent transparent_all tripleclickwords utmpInhibit 1305 term_name title transient_for transparent tripleclickwords urgentOnBell
1197 visualBell 1306 utmpInhibit visualBell
1198 1307
1199=cut 1308=cut
1200 1309
1201sub resource($$;$) { 1310sub resource($$;$) {
1202 my ($self, $name) = (shift, shift); 1311 my ($self, $name) = (shift, shift);
1203 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1312 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1204 &urxvt::term::_resource 1313 goto &urxvt::term::_resource
1205} 1314}
1206 1315
1207=item $value = $term->x_resource ($pattern) 1316=item $value = $term->x_resource ($pattern)
1208 1317
1209Returns the X-Resource for the given pattern, excluding the program or 1318Returns the X-Resource for the given pattern, excluding the program or
1210class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1319class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1211same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1320same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1212resource with that pattern exists. 1321resource with that pattern exists.
1213 1322
1323Extensions that define extra resources also need to call this method
1324to access their values.
1325
1326If the method is called on an extension object (basically, from an
1327extension), then the special prefix C<%.> will be replaced by the name of
1328the extension and a dot, and the lone string C<%> will be replaced by the
1329extension name itself. This makes it possible to code extensions so you
1330can rename them and get a new set of resources without having to change
1331the actual code.
1332
1214This method should only be called during the C<on_start> hook, as there is 1333This method should only be called during the C<on_start> hook, as there is
1215only one resource database per display, and later invocations might return 1334only one resource database per display, and later invocations might return
1216the wrong resources. 1335the wrong resources.
1217 1336
1218=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1337=item $value = $term->x_resource_boolean ($pattern)
1219 1338
1339Like C<x_resource>, above, but interprets the string value as a boolean
1340and returns C<1> for true values, C<0> for false values and C<undef> if
1341the resource or option isn't specified.
1342
1343You should always use this method to parse boolean resources.
1344
1345=cut
1346
1347sub x_resource_boolean {
1348 my $res = &x_resource;
1349
1350 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1351}
1352
1353=item $action = $term->lookup_keysym ($keysym, $state)
1354
1355Returns the action bound to key combination C<($keysym, $state)>,
1356if a binding for it exists, and C<undef> otherwise.
1357
1358=item $success = $term->bind_action ($key, $action)
1359
1220Adds a keymap translation exactly as specified via a resource. See the 1360Adds a key binding exactly as specified via a C<keysym> resource. See the
1221C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1361C<keysym> resource in the urxvt(1) manpage.
1362
1363To add default bindings for actions, an extension should call C<<
1364->bind_action >> in its C<init> hook for every such binding. Doing it
1365in the C<init> hook allows users to override or remove the binding
1366again.
1367
1368Example: the C<searchable-scrollback> by default binds itself
1369on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1370$term->bind_action >>.
1371
1372 sub init {
1373 my ($self) = @_;
1374
1375 $self->bind_action ("M-s" => "%:start");
1376 }
1222 1377
1223=item $rend = $term->rstyle ([$new_rstyle]) 1378=item $rend = $term->rstyle ([$new_rstyle])
1224 1379
1225Return and optionally change the current rendition. Text that is output by 1380Return and optionally change the current rendition. Text that is output by
1226the terminal application will use this style. 1381the terminal application will use this style.
1234 1389
1235=item ($row, $col) = $term->selection_beg ([$row, $col]) 1390=item ($row, $col) = $term->selection_beg ([$row, $col])
1236 1391
1237=item ($row, $col) = $term->selection_end ([$row, $col]) 1392=item ($row, $col) = $term->selection_end ([$row, $col])
1238 1393
1239Return the current values of the selection mark, begin or end positions, 1394Return the current values of the selection mark, begin or end positions.
1240and optionally set them to new values. 1395
1396When arguments are given, then the selection coordinates are set to
1397C<$row> and C<$col>, and the selection screen is set to the current
1398screen.
1399
1400=item $screen = $term->selection_screen ([$screen])
1401
1402Returns the current selection screen, and then optionally sets it.
1241 1403
1242=item $term->selection_make ($eventtime[, $rectangular]) 1404=item $term->selection_make ($eventtime[, $rectangular])
1243 1405
1244Tries to make a selection as set by C<selection_beg> and 1406Tries to make a selection as set by C<selection_beg> and
1245C<selection_end>. If C<$rectangular> is true (default: false), a 1407C<selection_end>. If C<$rectangular> is true (default: false), a
1246rectangular selection will be made. This is the prefered function to make 1408rectangular selection will be made. This is the preferred function to make
1247a selection. 1409a selection.
1248 1410
1249=item $success = $term->selection_grab ($eventtime) 1411=item $success = $term->selection_grab ($eventtime[, $clipboard])
1250 1412
1251Try to request the primary selection text from the server (for example, as 1413Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1414true) selection from the server. The corresponding text can be set
1252set by the next method). No visual feedback will be given. This function 1415with the next method. No visual feedback will be given. This function
1253is mostly useful from within C<on_sel_grab> hooks. 1416is mostly useful from within C<on_sel_grab> hooks.
1254 1417
1255=item $oldtext = $term->selection ([$newtext]) 1418=item $oldtext = $term->selection ([$newtext, $clipboard])
1256 1419
1257Return the current selection text and optionally replace it by C<$newtext>. 1420Return the current selection (clipboard if C<$clipboard> is true) text
1421and optionally replace it by C<$newtext>.
1422
1423=item $term->selection_clear ([$clipboard])
1424
1425Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1258 1426
1259=item $term->overlay_simple ($x, $y, $text) 1427=item $term->overlay_simple ($x, $y, $text)
1260 1428
1261Create a simple multi-line overlay box. See the next method for details. 1429Create a simple multi-line overlay box. See the next method for details.
1262 1430
1292 1460
1293The methods currently supported on C<urxvt::overlay> objects are: 1461The methods currently supported on C<urxvt::overlay> objects are:
1294 1462
1295=over 4 1463=over 4
1296 1464
1297=item $overlay->set ($x, $y, $text, $rend) 1465=item $overlay->set ($x, $y, $text[, $rend])
1298 1466
1299Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1467Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1300text in rxvt-unicode's special encoding and an array of rendition values 1468text in rxvt-unicode's special encoding and an array of rendition values
1301at a specific position inside the overlay. 1469at a specific position inside the overlay.
1470
1471If C<$rend> is missing, then the rendition will not be changed.
1302 1472
1303=item $overlay->hide 1473=item $overlay->hide
1304 1474
1305If visible, hide the overlay, but do not destroy it. 1475If visible, hide the overlay, but do not destroy it.
1306 1476
1369 1539
1370=item $term->scr_add_lines ($string) 1540=item $term->scr_add_lines ($string)
1371 1541
1372Write the given text string to the screen, as if output by the application 1542Write the given text string to the screen, as if output by the application
1373running inside the terminal. It may not contain command sequences (escape 1543running inside the terminal. It may not contain command sequences (escape
1374codes), but is free to use line feeds, carriage returns and tabs. The 1544codes - see C<cmd_parse> for that), but is free to use line feeds,
1375string is a normal text string, not in locale-dependent encoding. 1545carriage returns and tabs. The string is a normal text string, not in
1546locale-dependent encoding.
1376 1547
1377Normally its not a good idea to use this function, as programs might be 1548Normally its not a good idea to use this function, as programs might be
1378confused by changes in cursor position or scrolling. Its useful inside a 1549confused by changes in cursor position or scrolling. Its useful inside a
1379C<on_add_lines> hook, though. 1550C<on_add_lines> hook, though.
1380 1551
1388locale-specific encoding of the terminal and can contain command sequences 1559locale-specific encoding of the terminal and can contain command sequences
1389(escape codes) that will be interpreted. 1560(escape codes) that will be interpreted.
1390 1561
1391=item $term->tt_write ($octets) 1562=item $term->tt_write ($octets)
1392 1563
1393Write the octets given in C<$data> to the tty (i.e. as program input). To 1564Write the octets given in C<$octets> to the tty (i.e. as user input
1565to the program, see C<cmd_parse> for the opposite direction). To pass
1394pass characters instead of octets, you should convert your strings first 1566characters instead of octets, you should convert your strings first to the
1395to the locale-specific encoding using C<< $term->locale_encode >>. 1567locale-specific encoding using C<< $term->locale_encode >>.
1568
1569=item $term->tt_write_user_input ($octets)
1570
1571Like C<tt_write>, but should be used when writing strings in response to
1572the user pressing a key, to invoke the additional actions requested by
1573the user for that case (C<tt_write> doesn't do that).
1574
1575The typical use case would be inside C<on_action> hooks.
1576
1577=item $term->tt_paste ($octets)
1578
1579Write the octets given in C<$octets> to the tty as a paste, converting NL to
1580CR and bracketing the data with control sequences if bracketed paste mode
1581is set.
1396 1582
1397=item $old_events = $term->pty_ev_events ([$new_events]) 1583=item $old_events = $term->pty_ev_events ([$new_events])
1398 1584
1399Replaces the event mask of the pty watcher by the given event mask. Can 1585Replaces the event mask of the pty watcher by the given event mask. Can
1400be used to suppress input and output handling to the pty/tty. See the 1586be used to suppress input and output handling to the pty/tty. See the
1419Adds the specified events to the vt event mask. Useful e.g. when you want 1605Adds the specified events to the vt event mask. Useful e.g. when you want
1420to receive pointer events all the times: 1606to receive pointer events all the times:
1421 1607
1422 $term->vt_emask_add (urxvt::PointerMotionMask); 1608 $term->vt_emask_add (urxvt::PointerMotionMask);
1423 1609
1610=item $term->set_urgency ($set)
1611
1612Enable/disable the urgency hint on the toplevel window.
1613
1424=item $term->focus_in 1614=item $term->focus_in
1425 1615
1426=item $term->focus_out 1616=item $term->focus_out
1427 1617
1428=item $term->key_press ($state, $keycode[, $time]) 1618=item $term->key_press ($state, $keycode[, $time])
1429 1619
1430=item $term->key_release ($state, $keycode[, $time]) 1620=item $term->key_release ($state, $keycode[, $time])
1431 1621
1432Deliver various fake events to to terminal. 1622Deliver various fake events to to terminal.
1433 1623
1434=item $window_width = $term->width 1624=item $window_width = $term->width ([$new_value])
1435 1625
1436=item $window_height = $term->height 1626=item $window_height = $term->height ([$new_value])
1437 1627
1438=item $font_width = $term->fwidth 1628=item $font_width = $term->fwidth ([$new_value])
1439 1629
1440=item $font_height = $term->fheight 1630=item $font_height = $term->fheight ([$new_value])
1441 1631
1442=item $font_ascent = $term->fbase 1632=item $font_ascent = $term->fbase ([$new_value])
1443 1633
1444=item $terminal_rows = $term->nrow 1634=item $terminal_rows = $term->nrow ([$new_value])
1445 1635
1446=item $terminal_columns = $term->ncol 1636=item $terminal_columns = $term->ncol ([$new_value])
1447 1637
1448=item $has_focus = $term->focus 1638=item $has_focus = $term->focus ([$new_value])
1449 1639
1450=item $is_mapped = $term->mapped 1640=item $is_mapped = $term->mapped ([$new_value])
1451 1641
1452=item $max_scrollback = $term->saveLines 1642=item $max_scrollback = $term->saveLines ([$new_value])
1453 1643
1454=item $nrow_plus_saveLines = $term->total_rows 1644=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1455 1645
1456=item $topmost_scrollback_row = $term->top_row 1646=item $topmost_scrollback_row = $term->top_row ([$new_value])
1457 1647
1458Return various integers describing terminal characteristics. 1648Return various integers describing terminal characteristics. If an
1649argument is given, changes the value and returns the previous one.
1459 1650
1460=item $x_display = $term->display_id 1651=item $x_display = $term->display_id
1461 1652
1462Return the DISPLAY used by rxvt-unicode. 1653Return the DISPLAY used by rxvt-unicode.
1463 1654
1468=item $env = $term->env 1659=item $env = $term->env
1469 1660
1470Returns a copy of the environment in effect for the terminal as a hashref 1661Returns a copy of the environment in effect for the terminal as a hashref
1471similar to C<\%ENV>. 1662similar to C<\%ENV>.
1472 1663
1664=item @envv = $term->envv
1665
1666Returns the environment as array of strings of the form C<VAR=VALUE>.
1667
1668=item @argv = $term->argv
1669
1670Return the argument vector as this terminal, similar to @ARGV, but
1671includes the program name as first element.
1672
1473=cut 1673=cut
1474 1674
1475sub env { 1675sub env {
1476 if (my $env = $_[0]->_env) {
1477 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1676 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1478 } else {
1479 +{ %ENV }
1480 }
1481} 1677}
1482 1678
1483=item $modifiermask = $term->ModLevel3Mask 1679=item $modifiermask = $term->ModLevel3Mask
1484 1680
1485=item $modifiermask = $term->ModMetaMask 1681=item $modifiermask = $term->ModMetaMask
1493 1689
1494Returns the currently displayed screen (0 primary, 1 secondary). 1690Returns the currently displayed screen (0 primary, 1 secondary).
1495 1691
1496=item $cursor_is_hidden = $term->hidden_cursor 1692=item $cursor_is_hidden = $term->hidden_cursor
1497 1693
1498Returns wether the cursor is currently hidden or not. 1694Returns whether the cursor is currently hidden or not.
1499 1695
1500=item $view_start = $term->view_start ([$newvalue]) 1696=item $view_start = $term->view_start ([$newvalue])
1501 1697
1502Returns the row number of the topmost displayed line. Maximum value is 1698Returns the row number of the topmost displayed line. Maximum value is
1503C<0>, which displays the normal terminal contents. Lower values scroll 1699C<0>, which displays the normal terminal contents. Lower values scroll
1509compare the on-screen display with its stored representation. If they 1705compare the on-screen display with its stored representation. If they
1510differ, it redraws the differences. 1706differ, it redraws the differences.
1511 1707
1512Used after changing terminal contents to display them. 1708Used after changing terminal contents to display them.
1513 1709
1710=item $term->refresh_check
1711
1712Checks if a refresh has been requested and, if so, schedules one.
1713
1514=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1714=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1515 1715
1516Returns the text of the entire row with number C<$row_number>. Row C<0> 1716Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1517is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1717is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1518terminal line. The scrollback buffer starts at line C<-1> and extends to
1519line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1718terminal line. Nothing will be returned if a nonexistent line
1520is requested. 1719is requested.
1521 1720
1522If C<$new_text> is specified, it will replace characters in the current 1721If C<$new_text> is specified, it will replace characters in the current
1523line, starting at column C<$start_col> (default C<0>), which is useful 1722line, starting at column C<$start_col> (default C<0>), which is useful
1524to replace only parts of a line. The font index in the rendition will 1723to replace only parts of a line. The font index in the rendition will
1525automatically be updated. 1724automatically be updated.
1526 1725
1527C<$text> is in a special encoding: tabs and wide characters that use more 1726C<$text> is in a special encoding: tabs and wide characters that use more
1528than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1727than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1529characters. Characters with combining characters and other characters that 1728characters. Characters with combining characters and other characters that
1530do not fit into the normal tetx encoding will be replaced with characters 1729do not fit into the normal text encoding will be replaced with characters
1531in the private use area. 1730in the private use area.
1532 1731
1533You have to obey this encoding when changing text. The advantage is 1732You have to obey this encoding when changing text. The advantage is
1534that C<substr> and similar functions work on screen cells and not on 1733that C<substr> and similar functions work on screen cells and not on
1535characters. 1734characters.
1620} 1819}
1621 1820
1622sub urxvt::line::t { 1821sub urxvt::line::t {
1623 my ($self) = @_; 1822 my ($self) = @_;
1624 1823
1625 if (@_ > 1) 1824 if (@_ > 1) {
1626 {
1627 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1825 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1628 for $self->{beg} .. $self->{end}; 1826 for $self->{beg} .. $self->{end};
1629 } 1827 }
1630 1828
1631 defined wantarray && 1829 defined wantarray &&
1632 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1830 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1633 0, $self->{len} 1831 0, $self->{len}
1634} 1832}
1635 1833
1636sub urxvt::line::r { 1834sub urxvt::line::r {
1637 my ($self) = @_; 1835 my ($self) = @_;
1638 1836
1639 if (@_ > 1) 1837 if (@_ > 1) {
1640 {
1641 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1838 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1642 for $self->{beg} .. $self->{end}; 1839 for $self->{beg} .. $self->{end};
1643 } 1840 }
1644 1841
1645 if (defined wantarray) { 1842 if (defined wantarray) {
1646 my $rend = [ 1843 my $rend = [
1647 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1844 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1648 ]; 1845 ];
1680where one character corresponds to one screen cell. See 1877where one character corresponds to one screen cell. See
1681C<< $term->ROW_t >> for details. 1878C<< $term->ROW_t >> for details.
1682 1879
1683=item $string = $term->special_decode $text 1880=item $string = $term->special_decode $text
1684 1881
1685Converts rxvt-unicodes text reprsentation into a perl string. See 1882Converts rxvt-unicodes text representation into a perl string. See
1686C<< $term->ROW_t >> for details. 1883C<< $term->ROW_t >> for details.
1687 1884
1688=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1885=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1689 1886
1690=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1887=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1693manpage. 1890manpage.
1694 1891
1695=item $success = $term->grab ($eventtime[, $sync]) 1892=item $success = $term->grab ($eventtime[, $sync])
1696 1893
1697Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1894Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1698synchronous (C<$sync> is true). Also remembers the grab timestampe. 1895synchronous (C<$sync> is true). Also remembers the grab timestamp.
1699 1896
1700=item $term->allow_events_async 1897=item $term->allow_events_async
1701 1898
1702Calls XAllowEvents with AsyncBoth for the most recent grab. 1899Calls XAllowEvents with AsyncBoth for the most recent grab.
1703 1900
1710Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1907Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1711recent grab. 1908recent grab.
1712 1909
1713=item $term->ungrab 1910=item $term->ungrab
1714 1911
1715Calls XUngrab for the most recent grab. Is called automatically on 1912Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1716evaluation errors, as it is better to lose the grab in the error case as 1913evaluation errors, as it is better to lose the grab in the error case as
1717the session. 1914the session.
1718 1915
1719=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1916=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1720 1917
1722 1919
1723=item @atoms = $term->XListProperties ($window) 1920=item @atoms = $term->XListProperties ($window)
1724 1921
1725=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1922=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1726 1923
1727=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1924=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1728 1925
1729=item $term->XDeleteProperty ($window, $property) 1926=item $term->XDeleteProperty ($window, $property)
1730 1927
1731=item $window = $term->DefaultRootWindow 1928=item $window = $term->DefaultRootWindow
1732 1929
1739=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1936=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1740 1937
1741=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1938=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1742 1939
1743=item $term->XChangeInput ($window, $add_events[, $del_events]) 1940=item $term->XChangeInput ($window, $add_events[, $del_events])
1941
1942=item $keysym = $term->XStringToKeysym ($string)
1943
1944=item $string = $term->XKeysymToString ($keysym)
1744 1945
1745Various X or X-related functions. The C<$term> object only serves as 1946Various X or X-related functions. The C<$term> object only serves as
1746the source of the display, otherwise those functions map more-or-less 1947the source of the display, otherwise those functions map more-or-less
1747directory onto the X functions of the same name. 1948directly onto the X functions of the same name.
1748 1949
1749=back 1950=back
1750 1951
1751=cut 1952=cut
1752 1953
1854 my $env = $self->{term}->env; 2055 my $env = $self->{term}->env;
1855 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2056 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1856 delete $env->{LC_ALL}; 2057 delete $env->{LC_ALL};
1857 $env->{LC_CTYPE} = $self->{term}->locale; 2058 $env->{LC_CTYPE} = $self->{term}->locale;
1858 2059
1859 urxvt::term->new ($env, "popup", 2060 my $term = urxvt::term->new (
2061 $env, "popup",
1860 "--perl-lib" => "", "--perl-ext-common" => "", 2062 "--perl-lib" => "", "--perl-ext-common" => "",
1861 "-pty-fd" => -1, "-sl" => 0, 2063 "-pty-fd" => -1, "-sl" => 0,
1862 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2064 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1863 "--transient-for" => $self->{term}->parent, 2065 "--transient-for" => $self->{term}->parent,
1864 "-display" => $self->{term}->display_id, 2066 "-display" => $self->{term}->display_id,
1865 "-pe" => "urxvt-popup") 2067 "-pe" => "urxvt-popup",
1866 or die "unable to create popup window\n"; 2068 ) or die "unable to create popup window\n";
2069
2070 unless (delete $term->{urxvt_popup_init_done}) {
2071 $term->ungrab;
2072 $term->destroy;
2073 die "unable to initialise popup window\n";
2074 }
1867} 2075}
1868 2076
1869sub DESTROY { 2077sub DESTROY {
1870 my ($self) = @_; 2078 my ($self) = @_;
1871 2079
1876=back 2084=back
1877 2085
1878=cut 2086=cut
1879 2087
1880package urxvt::watcher; 2088package urxvt::watcher;
1881
1882@urxvt::timer::ISA = __PACKAGE__;
1883@urxvt::iow::ISA = __PACKAGE__;
1884@urxvt::pw::ISA = __PACKAGE__;
1885@urxvt::iw::ISA = __PACKAGE__;
1886 2089
1887=head2 The C<urxvt::timer> Class 2090=head2 The C<urxvt::timer> Class
1888 2091
1889This class implements timer watchers/events. Time is represented as a 2092This class implements timer watchers/events. Time is represented as a
1890fractional number of seconds since the epoch. Example: 2093fractional number of seconds since the epoch. Example:
1894 ->new 2097 ->new
1895 ->interval (1) 2098 ->interval (1)
1896 ->cb (sub { 2099 ->cb (sub {
1897 $term->{overlay}->set (0, 0, 2100 $term->{overlay}->set (0, 0,
1898 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2101 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1899 }); 2102 });
1900 2103
1901=over 4 2104=over 4
1902 2105
1903=item $timer = new urxvt::timer 2106=item $timer = new urxvt::timer
1904 2107
1907 2110
1908=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2111=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1909 2112
1910Set the callback to be called when the timer triggers. 2113Set the callback to be called when the timer triggers.
1911 2114
1912=item $tstamp = $timer->at
1913
1914Return the time this watcher will fire next.
1915
1916=item $timer = $timer->set ($tstamp) 2115=item $timer = $timer->set ($tstamp[, $interval])
1917 2116
1918Set the time the event is generated to $tstamp. 2117Set the time the event is generated to $tstamp (and optionally specifies a
2118new $interval).
1919 2119
1920=item $timer = $timer->interval ($interval) 2120=item $timer = $timer->interval ($interval)
1921 2121
1922Normally (and when C<$interval> is C<0>), the timer will automatically 2122By default (and when C<$interval> is C<0>), the timer will automatically
1923stop after it has fired once. If C<$interval> is non-zero, then the timer 2123stop after it has fired once. If C<$interval> is non-zero, then the timer
1924is automatically rescheduled at the given intervals. 2124is automatically rescheduled at the given intervals.
1925 2125
1926=item $timer = $timer->start 2126=item $timer = $timer->start
1927 2127
1928Start the timer. 2128Start the timer.
1929 2129
1930=item $timer = $timer->start ($tstamp) 2130=item $timer = $timer->start ($tstamp[, $interval])
1931 2131
1932Set the event trigger time to C<$tstamp> and start the timer. 2132Set the event trigger time to C<$tstamp> and start the timer. Optionally
2133also replaces the interval.
1933 2134
1934=item $timer = $timer->after ($delay) 2135=item $timer = $timer->after ($delay[, $interval])
1935 2136
1936Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2137Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1937 2138
1938=item $timer = $timer->stop 2139=item $timer = $timer->stop
1939 2140
1947 2148
1948 $term->{socket} = ... 2149 $term->{socket} = ...
1949 $term->{iow} = urxvt::iow 2150 $term->{iow} = urxvt::iow
1950 ->new 2151 ->new
1951 ->fd (fileno $term->{socket}) 2152 ->fd (fileno $term->{socket})
1952 ->events (urxvt::EVENT_READ) 2153 ->events (urxvt::EV_READ)
1953 ->start 2154 ->start
1954 ->cb (sub { 2155 ->cb (sub {
1955 my ($iow, $revents) = @_; 2156 my ($iow, $revents) = @_;
1956 # $revents must be 1 here, no need to check 2157 # $revents must be 1 here, no need to check
1957 sysread $term->{socket}, my $buf, 8192 2158 sysread $term->{socket}, my $buf, 8192
1970Set the callback to be called when io events are triggered. C<$reventmask> 2171Set the callback to be called when io events are triggered. C<$reventmask>
1971is a bitset as described in the C<events> method. 2172is a bitset as described in the C<events> method.
1972 2173
1973=item $iow = $iow->fd ($fd) 2174=item $iow = $iow->fd ($fd)
1974 2175
1975Set the filedescriptor (not handle) to watch. 2176Set the file descriptor (not handle) to watch.
1976 2177
1977=item $iow = $iow->events ($eventmask) 2178=item $iow = $iow->events ($eventmask)
1978 2179
1979Set the event mask to watch. The only allowed values are 2180Set the event mask to watch. The only allowed values are
1980C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2181C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1981together, or C<urxvt::EVENT_NONE>. 2182together, or C<urxvt::EV_NONE>.
1982 2183
1983=item $iow = $iow->start 2184=item $iow = $iow->start
1984 2185
1985Start watching for requested events on the given handle. 2186Start watching for requested events on the given handle.
1986 2187
1987=item $iow = $iow->stop 2188=item $iow = $iow->stop
1988 2189
1989Stop watching for events on the given filehandle. 2190Stop watching for events on the given file handle.
1990 2191
1991=back 2192=back
1992 2193
1993=head2 The C<urxvt::iw> Class 2194=head2 The C<urxvt::iw> Class
1994 2195
2027 ->new 2228 ->new
2028 ->start ($pid) 2229 ->start ($pid)
2029 ->cb (sub { 2230 ->cb (sub {
2030 my ($pw, $exit_status) = @_; 2231 my ($pw, $exit_status) = @_;
2031 ... 2232 ...
2032 }); 2233 });
2033 2234
2034=over 4 2235=over 4
2035 2236
2036=item $pw = new urxvt::pw 2237=item $pw = new urxvt::pw
2037 2238
2041 2242
2042Set the callback to be called when the timer triggers. 2243Set the callback to be called when the timer triggers.
2043 2244
2044=item $pw = $timer->start ($pid) 2245=item $pw = $timer->start ($pid)
2045 2246
2046Tells the wqtcher to start watching for process C<$pid>. 2247Tells the watcher to start watching for process C<$pid>.
2047 2248
2048=item $pw = $pw->stop 2249=item $pw = $pw->stop
2049 2250
2050Stop the watcher. 2251Stop the watcher.
2051 2252
2064 2265
2065=item >= 3 - script loading and management 2266=item >= 3 - script loading and management
2066 2267
2067=item >=10 - all called hooks 2268=item >=10 - all called hooks
2068 2269
2069=item >=11 - hook reutrn values 2270=item >=11 - hook return values
2070 2271
2071=back 2272=back
2072 2273
2073=head1 AUTHOR 2274=head1 AUTHOR
2074 2275
2075 Marc Lehmann <pcg@goof.com> 2276 Marc Lehmann <schmorp@schmorp.de>
2076 http://software.schmorp.de/pkg/rxvt-unicode 2277 http://software.schmorp.de/pkg/rxvt-unicode
2077 2278
2078=cut 2279=cut
2079 2280
20801 22811
2282
2283# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines