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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines