ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.108 by root, Thu Jan 19 09:47:15 2006 UTC vs.
Revision 1.249 by root, Fri Dec 26 21:26:37 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines