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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines