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.98 by root, Tue Jan 17 17:01:54 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
94=item searchable-scrollback<hotkey> (enabled by default)
95
96Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal
98input/output is suspended and a regex is displayed at the bottom of the
99screen.
100
101Inputting characters appends them to the regex and continues incremental
102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary
107selection.
108
109=item selection-autotransform
110
111This selection allows you to do automatic transforms on a selection
112whenever a selection is made.
113
114It works by specifying perl snippets (most useful is a single C<s///>
115operator) that modify C<$_> as resources:
116
117 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform
119 ...
120
121For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>:
124
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126
127And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor:
129
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/
131
132Of course, this can be modified to suit your needs and your editor :)
133
134To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution:
136
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.)
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/
139
140The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file.
143
144=item mark-urls
145
146Uses per-line display filtering (C<on_line_update>) to underline urls and
147make them clickable. When middle-clicked, the program specified in the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with
149the URL as first argument.
150
151=item block-graphics-to-ascii
152
153A not very useful example of filtering all text output to the terminal,
154by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character.
156
157=item digital-clock
158
159Displays a digital clock using the built-in overlay.
160
161=item example-refresh-hooks
162
163Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own
165overlays or changes.
166
167=item selection-pastebin
168
169This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things).
171
172It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173i.e.
174
175 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
176
177Pressing this combination runs a command with C<%> replaced by the name of
178the textfile. This command can be set via a resource:
179
180 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
181
182And the default is likely not useful to anybody but the few people around
183here :)
184
185The name of the textfile is the hex encoded md5 sum of the selection, so
186the same content should lead to the same filename.
187
188After a successful upload the selection will be replaced by the text given
189in the C<selection-pastebin-url> resource (again, the % is the placeholder
190for the filename):
191
192 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
193
194=back
195 57
196=head1 API DOCUMENTATION 58=head1 API DOCUMENTATION
197 59
198=head2 General API Considerations 60=head2 General API Considerations
199 61
213 75
214=over 4 76=over 4
215 77
216=item $text 78=item $text
217 79
218Rxvt-unicodes special way of encoding text, where one "unicode" character 80Rxvt-unicode's special way of encoding text, where one "unicode" character
219always 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.
220 82
221=item $string 83=item $string
222 84
223A 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
227=item $octets 89=item $octets
228 90
229Either binary data or - more common - a text string encoded in a 91Either binary data or - more common - a text string encoded in a
230locale-specific way. 92locale-specific way.
231 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
232=back 100=back
233 101
234=head2 Extension Objects 102=head2 Extension Objects
235 103
236Very 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
237for 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,
238hooks. 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
239about 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
240begin with an underscore character C<_>: these are reserved for internal 109that begin with an underscore character C<_>: these are reserved for
241use. 110internal use.
242 111
243Although 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
244C<urxvt::term> class on this object. 113C<urxvt::term> class on this object.
245 114
246It 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:
247 122
248=over 4 123=over 4
249 124
250=item $urxvt_term = $self->{term} 125=item #:META:RESOURCE:name:type:desc
251 126
252Returns the C<urxvt::term> object associated with this instance of the 127The RESOURCE comment defines a resource used by the extension, where
253extension. 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.
254 130
255=item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) 131=item #:META:BINDING:sym:action
256 132
257Dynamically enable the given hooks (named without the C<on_> prefix) for 133The BINDING comment defines a default binding for an action provided
258this extension, replacing any previous hook. This is useful when you want 134by the extension, where C<sym> is the key combination that triggers
259to overwrite time-critical hooks only temporarily. 135the action, whose format is defined in the description of the
260 136B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
261=item $self->disable ($hook_name[, $hook_name..]) 137of the action method.
262
263Dynamically disable the given hooks.
264 138
265=back 139=back
266 140
267=head2 Hooks 141=head2 Hooks
268 142
269The following subroutines can be declared in extension files, and will be 143The following subroutines can be declared in extension files, and will be
270called whenever the relevant event happens. 144called whenever the relevant event happens.
271 145
272The 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
273the in the C<Extension Objects> section. 147the in the C<Extension Objects> section.
274 148
275B<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
276event 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
277skipped, and the relevant action might not be carried out by the C++ code. 151relevant action might not be carried out by the C++ code.
278 152
279I<< When in doubt, return a false value (preferably C<()>). >> 153I<< When in doubt, return a false value (preferably C<()>). >>
280 154
281=over 4 155=over 4
282 156
283=item on_init $term 157=item on_init $term
284 158
285Called after a new terminal object has been initialized, but before 159Called after a new terminal object has been initialized, but before
286windows 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
287call or deliver senseless data, as terminal size and other characteristics 161call or deliver senseless data, as terminal size and other characteristics
288have not yet been determined. You can safely query and change resources, 162have not yet been determined. You can safely query and change resources
289though. 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).
290 175
291=item on_reset $term 176=item on_reset $term
292 177
293Called 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
294control 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
295variables. 180variables.
296 181
297=item on_start $term 182=item on_child_start $term, $pid
298 183
299Called at the very end of initialisation of a new terminal, just before 184Called just after the child process has been C<fork>ed.
300returning to the mainloop. 185
186=item on_child_exit $term, $status
187
188Called just after the child process has exited. C<$status> is the status
189from C<waitpid>.
301 190
302=item on_sel_make $term, $eventtime 191=item on_sel_make $term, $eventtime
303 192
304Called whenever a selection has been made by the user, but before the 193Called whenever a selection has been made by the user, but before the
305selection text is copied, so changes to the beginning, end or type of the 194selection text is copied, so changes to the beginning, end or type of the
312 201
313Called whenever a selection has been copied, but before the selection is 202Called whenever a selection has been copied, but before the selection is
314requested from the server. The selection text can be queried and changed 203requested from the server. The selection text can be queried and changed
315by calling C<< $term->selection >>. 204by calling C<< $term->selection >>.
316 205
317Returning a true value aborts selection grabbing. It will still be hilighted. 206Returning a true value aborts selection grabbing. It will still be highlighted.
318 207
319=item on_sel_extend $term 208=item on_sel_extend $term
320 209
321Called 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
322click) and is either supposed to return false (normal operation), or 211click) and is either supposed to return false (normal operation), or
323should 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
324processing. This can happen multiple times, as long as the callback 213processing. This can happen multiple times, as long as the callback
325returns 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
326supposed to enlarge the selection more and more, if possible. 215supposed to enlarge the selection more and more, if possible.
327 216
328See the F<selection> example extension. 217See the F<selection> example extension.
329 218
330=item on_view_change $term, $offset 219=item on_view_change $term, $offset
331 220
332Called whenever the view offset changes, i..e the user or program 221Called whenever the view offset changes, i.e. the user or program
333scrolls. Offset C<0> means display the normal terminal, positive values 222scrolls. Offset C<0> means display the normal terminal, positive values
334show this many lines of scrollback. 223show this many lines of scrollback.
335 224
336=item on_scroll_back $term, $lines, $saved 225=item on_scroll_back $term, $lines, $saved
337 226
341 230
342It 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,
343$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
344number of lines that will be in the scrollback buffer. 233number of lines that will be in the scrollback buffer.
345 234
346=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
347 246
348Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 247Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
349operating system command) is processed. Cursor position and other state 248operating system command) is processed. Cursor position and other state
350information is up-to-date when this happens. For interoperability, the 249information is up-to-date when this happens. For interoperability, the
351string should start with the extension name and a colon, to distinguish 250string should start with the extension name (sans -osc) and a semicolon,
352it from commands for other extensions, and this might be enforced in the 251to distinguish it from commands for other extensions, and this might be
353future. 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 }
354 263
355Be 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,
356as 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
357other 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.
358 270
359=item on_add_lines $term, $string 271=item on_add_lines $term, $string
360 272
361Called 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
362can 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
367=item on_tt_write $term, $octets 279=item on_tt_write $term, $octets
368 280
369Called 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
370suppress or filter tty input. 282suppress or filter tty input.
371 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
372=item on_line_update $term, $row 291=item on_line_update $term, $row
373 292
374Called 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
375screen output (e.g. underline urls or other useless stuff). Only lines 294screen output (e.g. underline urls or other useless stuff). Only lines
376that are being shown will be filtered, and, due to performance reasons, 295that are being shown will be filtered, and, due to performance reasons,
383later 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
384you cannot just toggle rendition bits, but only set them. 303you cannot just toggle rendition bits, but only set them.
385 304
386=item on_refresh_begin $term 305=item on_refresh_begin $term
387 306
388Called just before the screen gets redrawn. Can be used for overlay 307Called just before the screen gets redrawn. Can be used for overlay or
389or similar effects by modify terminal contents in refresh_begin, and 308similar effects by modifying the terminal contents in refresh_begin, and
390restoring them in refresh_end. The built-in overlay and selection display 309restoring them in refresh_end. The built-in overlay and selection display
391code is run after this hook, and takes precedence. 310code is run after this hook, and takes precedence.
392 311
393=item on_refresh_end $term 312=item on_refresh_end $term
394 313
395Called just after the screen gets redrawn. See C<on_refresh_begin>. 314Called just after the screen gets redrawn. See C<on_refresh_begin>.
396 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
397=item on_keyboard_command $term, $string 324=item on_user_command $term, $string *DEPRECATED*
398 325
399Called whenever the user presses a key combination that has a 326Called whenever a user-configured event is being activated (e.g. via
400C<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>
401resource 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.
402 338
403=item on_x_event $term, $event 339=item on_x_event $term, $event
404 340
405Called 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
406windows). Should only be used as a last resort. Most event structure 342windows). Should only be used as a last resort. Most event structure
407members are not passed. 343members are not passed.
408 344
345=item on_root_event $term, $event
346
347Like C<on_x_event>, but is called for events on the root window.
348
409=item on_focus_in $term 349=item on_focus_in $term
410 350
411Called whenever the window gets the keyboard focus, before rxvt-unicode 351Called whenever the window gets the keyboard focus, before rxvt-unicode
412does focus in processing. 352does focus in processing.
413 353
414=item on_focus_out $term 354=item on_focus_out $term
415 355
416Called wheneever the window loses keyboard focus, before rxvt-unicode does 356Called whenever the window loses keyboard focus, before rxvt-unicode does
417focus out processing. 357focus out processing.
418 358
359=item on_configure_notify $term, $event
360
361=item on_property_notify $term, $event
362
419=item on_key_press $term, $event, $keysym, $octets 363=item on_key_press $term, $event, $keysym, $octets
420 364
421=item on_key_release $term, $event, $keysym 365=item on_key_release $term, $event, $keysym
422 366
423=item on_button_press $term, $event 367=item on_button_press $term, $event
428 372
429=item on_map_notify $term, $event 373=item on_map_notify $term, $event
430 374
431=item on_unmap_notify $term, $event 375=item on_unmap_notify $term, $event
432 376
433Called whenever the corresponding X event is received for the terminal If 377Called whenever the corresponding X event is received for the terminal. If
434the 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.
435 379
436The 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
437manpage), 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
438and column under the mouse cursor. 382(real, not screen-based) row and column under the mouse cursor.
439 383
440C<on_key_press> additionally receives the string rxvt-unicode would 384C<on_key_press> additionally receives the string rxvt-unicode would
441output, if any, in locale-specific encoding. 385output, if any, in locale-specific encoding.
442 386
443subwindow. 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.
444 399
445=back 400=back
446 401
447=cut 402=cut
448 403
449package urxvt; 404package urxvt;
450 405
451use utf8; 406use utf8;
452use strict; 407use strict 'vars';
453use Carp (); 408use Carp ();
454use Scalar::Util (); 409use Scalar::Util ();
455use List::Util (); 410use List::Util ();
456 411
457our $VERSION = 1; 412our $VERSION = 1;
458our $TERM; 413our $TERM;
414our @TERM_INIT; # should go, prevents async I/O etc.
415our @TERM_EXT; # should go, prevents async I/O etc.
459our @HOOKNAME; 416our @HOOKNAME;
460our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 417our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461our %OPTION; 418our %OPTION;
462 419
463our $LIBDIR; 420our $LIBDIR;
464our $RESNAME; 421our $RESNAME;
465our $RESCLASS; 422our $RESCLASS;
466our $RXVTNAME; 423our $RXVTNAME;
467 424
425our $NOCHAR = chr 0xffff;
426
468=head2 Variables in the C<urxvt> Package 427=head2 Variables in the C<urxvt> Package
469 428
470=over 4 429=over 4
471 430
472=item $urxvt::LIBDIR 431=item $urxvt::LIBDIR
485=item $urxvt::TERM 444=item $urxvt::TERM
486 445
487The current terminal. This variable stores the current C<urxvt::term> 446The current terminal. This variable stores the current C<urxvt::term>
488object, whenever a callback/hook is executing. 447object, whenever a callback/hook is executing.
489 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
490=back 465=back
491 466
492=head2 Functions in the C<urxvt> Package 467=head2 Functions in the C<urxvt> Package
493 468
494=over 4 469=over 4
495 470
496=item urxvt::fatal $errormessage 471=item urxvt::fatal $errormessage
497 472
498Fatally aborts execution with the given error message. Avoid at all 473Fatally aborts execution with the given error message (which should
499costs! The only time this is acceptable is when the terminal process 474include a trailing newline). Avoid at all costs! The only time this
500starts up. 475is acceptable (and useful) is in the init hook, where it prevents the
476terminal from starting up.
501 477
502=item urxvt::warn $string 478=item urxvt::warn $string
503 479
504Calls 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
505newline. The module also overwrites the C<warn> builtin with a function 481newline. The module also overwrites the C<warn> builtin with a function
506that calls this function. 482that calls this function.
507 483
508Using 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
509correct place, e.g. on stderr of the connecting urxvtc client. 485correct place, e.g. on stderr of the connecting urxvtc client.
510 486
511Messages 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).
512 495
513=item $time = urxvt::NOW 496=item $time = urxvt::NOW
514 497
515Returns the "current time" (as per the event loop). 498Returns the "current time" (as per the event loop).
516 499
559 542
560=item $rend = urxvt::OVERLAY_RSTYLE 543=item $rend = urxvt::OVERLAY_RSTYLE
561 544
562Return the rendition mask used for overlays by default. 545Return the rendition mask used for overlays by default.
563 546
564=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
565 549
566Return the bit that enabled bold, italic, blink, reverse-video and 550Return the bit that enabled bold, italic, blink, reverse-video and
567underline, respectively. To enable such a style, just logically OR it into 551underline, respectively. To enable such a style, just logically OR it into
568the bitset. 552the bitset.
569 553
575 559
576=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 560=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
577 561
578=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 562=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
579 563
564=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
565
580Replace the foreground/background colour in the rendition mask with the 566Replace the foreground/background colour in the rendition mask with the
581specified one. 567specified one.
582 568
583=item $value = urxvt::GET_CUSTOM $rend 569=item $value = urxvt::GET_CUSTOM $rend
584 570
593=back 579=back
594 580
595=cut 581=cut
596 582
597BEGIN { 583BEGIN {
598 urxvt->bootstrap;
599
600 # overwrite perl's warn 584 # overwrite perl's warn
601 *CORE::GLOBAL::warn = sub { 585 *CORE::GLOBAL::warn = sub {
602 my $msg = join "", @_; 586 my $msg = join "", @_;
603 $msg .= "\n" 587 $msg .= "\n"
604 unless $msg =~ /\n$/; 588 unless $msg =~ /\n$/;
605 urxvt::warn ($msg); 589 urxvt::warn ($msg);
606 }; 590 };
591}
607 592
608 # %ENV is the original startup environment 593no warnings 'utf8';
609 delete $ENV{IFS}; 594
610 delete $ENV{CDPATH}; 595sub parse_resource {
611 delete $ENV{BASH_ENV}; 596 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
612 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 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 }
613} 655}
614 656
615my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 657my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616 658
617sub verbose { 659sub verbose {
618 my ($level, $msg) = @_; 660 my ($level, $msg) = @_;
619 warn "$msg\n" if $level <= $verbosity; 661 warn "$msg\n" if $level <= $verbosity;
620} 662}
621 663
622my $extension_pkg = "extension0000";
623my %extension_pkg; 664my %extension_pkg;
624 665
625# load a single script into its own package, once only 666# load a single script into its own package, once only
626sub extension_package($) { 667sub extension_package($) {
627 my ($path) = @_; 668 my ($path) = @_;
628 669
629 $extension_pkg{$path} ||= do { 670 $extension_pkg{$path} ||= do {
630 my $pkg = "urxvt::" . ($extension_pkg++); 671 $path =~ /([^\/\\]+)$/;
672 my $pkg = $1;
673 $pkg =~ s/[^[:word:]]/_/g;
674 $pkg = "urxvt::ext::$pkg";
631 675
632 verbose 3, "loading extension '$path' into package '$pkg'"; 676 verbose 3, "loading extension '$path' into package '$pkg'";
677
678 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
633 679
634 open my $fh, "<:raw", $path 680 open my $fh, "<:raw", $path
635 or die "$path: $!"; 681 or die "$path: $!";
636 682
637 my $source = 683 my $source =
638 "package $pkg; use strict; use utf8;\n" 684 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
639 . "use base urxvt::term::extension::;\n"
640 . "#line 1 \"$path\"\n{\n" 685 . "#line 1 \"$path\"\n{\n"
641 . (do { local $/; <$fh> }) 686 . (do { local $/; <$fh> })
642 . "\n};\n1"; 687 . "\n};\n1";
643 688
644 eval $source 689 eval $source
653# called by the rxvt core 698# called by the rxvt core
654sub invoke { 699sub invoke {
655 local $TERM = shift; 700 local $TERM = shift;
656 my $htype = shift; 701 my $htype = shift;
657 702
658 if ($htype == 0) { # INIT 703 if ($htype == HOOK_INIT) {
659 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 704 my @dirs = $TERM->perl_libdirs;
660 705
706 $TERM->scan_extensions;
707
661 my %ext_arg; 708 my %ext_arg;
662 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 (
663 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 ) {
664 if ($_ eq "default") { 723 if ($_ eq "default") {
724
725 $ext_arg{$_} = []
726 for
665 $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
666 } elsif (/^-(.*)$/) { 739 } elsif (/^-(.*)$/) {
667 delete $ext_arg{$1}; 740 delete $ext_arg{$1};
741
668 } elsif (/^([^<]+)<(.*)>$/) { 742 } elsif (/^([^<]+)<(.*)>$/) {
669 push @{ $ext_arg{$1} }, $2; 743 push @{ $ext_arg{$1} }, $2;
744
670 } else { 745 } else {
671 $ext_arg{$_} ||= []; 746 $ext_arg{$_} ||= [];
672 } 747 }
673 } 748 }
674 749
675 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) {
676 my @files = grep -f $_, map "$_/$ext", @dirs; 758 my @files = grep -f $_, map "$_/$ext", @dirs;
677 759
678 if (@files) { 760 if (@files) {
679 $TERM->register_package (extension_package $files[0], $argv); 761 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
680 } else { 762 } else {
681 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";
682 } 764 }
683 } 765 }
684 766
690 772
691 if (my $cb = $TERM->{_hook}[$htype]) { 773 if (my $cb = $TERM->{_hook}[$htype]) {
692 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 774 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
693 if $verbosity >= 10; 775 if $verbosity >= 10;
694 776
695 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";
696 783
697 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) {
698 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 791 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
699 and last; 792 $retval ||= $retval_;
700 793
701 if ($@) { 794 if ($@) {
702 $TERM->ungrab; # better to lose the grab than the session 795 $TERM->ungrab; # better to lose the grab than the session
703 warn $@; 796 warn $@;
704 } 797 }
706 799
707 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 800 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
708 if $verbosity >= 11; 801 if $verbosity >= 11;
709 } 802 }
710 803
711 if ($htype == 1) { # DESTROY 804 if ($htype == HOOK_DESTROY) {
712 # clear package objects 805 # clear package objects
713 %$_ = () for values %{ $TERM->{_pkg} }; 806 %$_ = () for values %{ $TERM->{_pkg} };
714 807
715 # clear package 808 # clear package
716 %$TERM = (); 809 %$TERM = ();
717 } 810 }
718 811
719 $retval 812 $retval
720} 813}
721 814
722sub exec_async(@) { 815sub SET_COLOR($$$) {
723 my $pid = fork; 816 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
724
725 return
726 if !defined $pid or $pid;
727
728 %ENV = %{ $TERM->env };
729
730 exec @_;
731 _exit 255;
732} 817}
733 818
734# urxvt::term::extension 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}
735 843
736package urxvt::term::extension; 844package urxvt::term::extension;
737 845
738sub enable { 846=head2 The C<urxvt::term::extension> class
739 my ($self, %hook) = @_;
740 my $pkg = $self->{_pkg};
741 847
742 while (my ($name, $cb) = each %hook) { 848Each extension attached to a terminal object is represented by
743 my $htype = $HOOKTYPE{uc $name}; 849a C<urxvt::term::extension> object.
744 defined $htype
745 or Carp::croak "unsupported hook type '$name'";
746 850
747 $self->set_should_invoke ($htype, +1) 851You can use these objects, which are passed to all callbacks to store any
748 unless exists $self->{term}{_hook}[$htype]{$pkg}; 852state related to the terminal and extension instance.
749 853
750 $self->{term}{_hook}[$htype]{$pkg} = $cb; 854The methods (And data members) documented below can be called on extension
751 } 855objects, in addition to call methods documented for the <urxvt::term>
752} 856class.
753 857
754sub disable { 858=over 4
755 my ($self, @hook) = @_;
756 my $pkg = $self->{_pkg};
757 859
758 for my $name (@hook) { 860=item $urxvt_term = $self->{term}
759 my $htype = $HOOKTYPE{uc $name};
760 defined $htype
761 or Carp::croak "unsupported hook type '$name'";
762 861
763 $self->set_should_invoke ($htype, -1) 862Returns the C<urxvt::term> object associated with this instance of the
764 if delete $self->{term}{_hook}[$htype]{$pkg}; 863extension. This member I<must not> be changed in any way.
765 } 864
766} 865=cut
767 866
768our $AUTOLOAD; 867our $AUTOLOAD;
769 868
770sub AUTOLOAD { 869sub AUTOLOAD {
771 $AUTOLOAD =~ /:([^:]+)$/ 870 $AUTOLOAD =~ /:([^:]+)$/
784 883
785sub DESTROY { 884sub DESTROY {
786 # nop 885 # nop
787} 886}
788 887
789# urxvt::destroy_hook 888# urxvt::destroy_hook (basically a cheap Guard:: implementation)
790 889
791sub urxvt::destroy_hook::DESTROY { 890sub urxvt::destroy_hook::DESTROY {
792 ${$_[0]}->(); 891 ${$_[0]}->();
793} 892}
794 893
795sub urxvt::destroy_hook(&) { 894sub urxvt::destroy_hook(&) {
796 bless \shift, urxvt::destroy_hook:: 895 bless \shift, urxvt::destroy_hook::
797} 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
798 1011
799package urxvt::anyevent; 1012package urxvt::anyevent;
800 1013
801=head2 The C<urxvt::anyevent> Class 1014=head2 The C<urxvt::anyevent> Class
802 1015
803The 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
804C<AnyEvent> module - any module using it will work inside urxvt without 1017C<AnyEvent> module - any module using it will work inside urxvt without
805further programming. The only exception is that you cannot wait on 1018further programming. The only exception is that you cannot wait on
806condition variables, but non-blocking condvar use is ok. What this means 1019condition variables, but non-blocking condvar use is ok.
807is that you cannot use blocking APIs, but the non-blocking variant should
808work.
809 1020
810=cut 1021In practical terms this means is that you cannot use blocking APIs, but
1022the non-blocking variant should work.
811 1023
1024=cut
1025
812our $VERSION = 1; 1026our $VERSION = '5.23';
813 1027
814$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1028$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
815push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1029push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
816 1030
817sub timer { 1031sub timer {
819 1033
820 my $cb = $arg{cb}; 1034 my $cb = $arg{cb};
821 1035
822 urxvt::timer 1036 urxvt::timer
823 ->new 1037 ->new
824 ->start (urxvt::NOW + $arg{after}) 1038 ->after ($arg{after}, $arg{interval})
825 ->cb (sub { 1039 ->cb ($arg{interval} ? $cb : sub {
826 $_[0]->stop; # need to cancel manually 1040 $_[0]->stop; # need to cancel manually
827 $cb->(); 1041 $cb->();
828 }) 1042 })
829} 1043}
830 1044
831sub io { 1045sub io {
832 my ($class, %arg) = @_; 1046 my ($class, %arg) = @_;
833 1047
834 my $cb = $arg{cb}; 1048 my $cb = $arg{cb};
1049 my $fd = fileno $arg{fh};
1050 defined $fd or $fd = $arg{fh};
835 1051
836 bless [$arg{fh}, urxvt::iow 1052 bless [$arg{fh}, urxvt::iow
837 ->new 1053 ->new
838 ->fd (fileno $arg{fh}) 1054 ->fd ($fd)
839 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1055 ->events (($arg{poll} =~ /r/ ? 1 : 0)
840 | ($arg{poll} =~ /w/ ? 2 : 0)) 1056 | ($arg{poll} =~ /w/ ? 2 : 0))
841 ->start 1057 ->start
842 ->cb (sub { 1058 ->cb ($cb)
843 $cb->(($_[1] & 1 ? 'r' : '')
844 . ($_[1] & 2 ? 'w' : ''));
845 })],
846 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 })
847} 1085}
848 1086
849sub DESTROY { 1087sub DESTROY {
850 $_[0][1]->stop; 1088 $_[0][1]->stop;
851} 1089}
852 1090
853sub condvar { 1091# only needed for AnyEvent < 6 compatibility
854 bless \my $flag, urxvt::anyevent::condvar:: 1092sub one_event {
855}
856
857sub urxvt::anyevent::condvar::broadcast {
858 ${$_[0]}++;
859}
860
861sub urxvt::anyevent::condvar::wait {
862 unless (${$_[0]}) {
863 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";
864 }
865} 1094}
866 1095
867package urxvt::term; 1096package urxvt::term;
868 1097
869=head2 The C<urxvt::term> Class 1098=head2 The C<urxvt::term> Class
875# find on_xxx subs in the package and register them 1104# find on_xxx subs in the package and register them
876# as hooks 1105# as hooks
877sub register_package { 1106sub register_package {
878 my ($self, $pkg, $argv) = @_; 1107 my ($self, $pkg, $argv) = @_;
879 1108
1109 no strict 'refs';
1110
1111 urxvt::verbose 6, "register package $pkg to $self";
1112
1113 @{"$pkg\::ISA"} = urxvt::term::extension::;
1114
880 my $proxy = bless { 1115 my $proxy = bless {
881 _pkg => $pkg, 1116 _pkg => $pkg,
1117 _name => ${"$pkg\::_NAME"}, # hackish
882 argv => $argv, 1118 argv => $argv,
883 }, $pkg; 1119 }, $pkg;
884 Scalar::Util::weaken ($proxy->{term} = $self); 1120 Scalar::Util::weaken ($proxy->{term} = $self);
885 1121
886 $self->{_pkg}{$pkg} = $proxy; 1122 $self->{_pkg}{$pkg} = $proxy;
887 1123
890 $proxy->enable ($name => $ref); 1126 $proxy->enable ($name => $ref);
891 } 1127 }
892 } 1128 }
893} 1129}
894 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
895=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1194=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
896 1195
897Creates 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
898C<$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
899hash which defines the environment of the new terminal. 1198hash which defines the environment of the new terminal.
900 1199
901Croaks (and probably outputs an error message) if the new instance 1200Croaks (and probably outputs an error message) if the new instance
902couldn'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
903initialise perl, and the terminal object otherwise. The C<init> and 1202initialise perl, and the terminal object otherwise. The C<init> and
904C<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).
905 1205
906=cut 1206=cut
907 1207
908sub new { 1208sub new {
909 my ($class, $env, @args) = @_; 1209 my ($class, $env, @args) = @_;
910 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
911 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1214 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
912} 1215}
913 1216
914=item $term->destroy 1217=item $term->destroy
915 1218
916Destroy the terminal object (close the window, free resources 1219Destroy the terminal object (close the window, free resources
917etc.). 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
918watchers (timers, io watchers) are still active. 1221watchers (timers, io watchers) are still active.
1222
1223=item $term->exec_async ($cmd[, @args])
1224
1225Works like the combination of the C<fork>/C<exec> builtins, which executes
1226("starts") programs in the background. This function takes care of setting
1227the user environment before exec'ing the command (e.g. C<PATH>) and should
1228be preferred over explicit calls to C<exec> or C<system>.
1229
1230Returns the pid of the subprocess or C<undef> on error.
1231
1232=cut
1233
1234sub exec_async {
1235 my $self = shift;
1236
1237 my $pid = fork;
1238
1239 return $pid
1240 if !defined $pid or $pid;
1241
1242 %ENV = %{ $self->env };
1243
1244 exec @_;
1245 urxvt::_exit 255;
1246}
919 1247
920=item $isset = $term->option ($optval[, $set]) 1248=item $isset = $term->option ($optval[, $set])
921 1249
922Returns true if the option specified by C<$optval> is enabled, and 1250Returns true if the option specified by C<$optval> is enabled, and
923optionally 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
924C<%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.
925 1253
926Here 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
927source file F</src/optinc.h> to see the actual list: 1255source file F</src/optinc.h> to see the actual list:
928 1256
929 borderLess console cursorBlink cursorUnderline hold iconic insecure 1257 borderLess buffered console cursorBlink cursorUnderline hold iconic
930 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1258 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1259 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
931 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1260 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
932 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1261 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
933 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1262 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
934 tripleclickwords utmpInhibit visualBell 1263 urgentOnBell utmpInhibit visualBell
935 1264
936=item $value = $term->resource ($name[, $newval]) 1265=item $value = $term->resource ($name[, $newval])
937 1266
938Returns the current resource value associated with a given name and 1267Returns the current resource value associated with a given name and
939optionally 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>
948likely change). 1277likely change).
949 1278
950Please note that resource strings will currently only be freed when the 1279Please note that resource strings will currently only be freed when the
951terminal is destroyed, so changing options frequently will eat memory. 1280terminal is destroyed, so changing options frequently will eat memory.
952 1281
953Here 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
954are 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>
955to see the actual list: 1284to see the actual list:
956 1285
957 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1286 answerbackstring backgroundPixmap backspace_key blurradius
958 borderLess color cursorBlink cursorUnderline cutchars delete_key 1287 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
959 display_name embed ext_bwidth fade font geometry hold iconName 1288 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
960 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
961 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1291 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
962 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1292 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1293 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1294 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1295 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1296 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967 shade term_name title transparent transparent_all tripleclickwords 1297 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1298 term_name title transient_for transparent tripleclickwords urgentOnBell
968 utmpInhibit visualBell 1299 utmpInhibit visualBell
969 1300
970=cut 1301=cut
971 1302
972sub resource($$;$) { 1303sub resource($$;$) {
973 my ($self, $name) = (shift, shift); 1304 my ($self, $name) = (shift, shift);
974 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1305 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
975 &urxvt::term::_resource 1306 goto &urxvt::term::_resource
976} 1307}
977 1308
978=item $value = $term->x_resource ($pattern) 1309=item $value = $term->x_resource ($pattern)
979 1310
980Returns the X-Resource for the given pattern, excluding the program or 1311Returns the X-Resource for the given pattern, excluding the program or
981class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1312class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
982same 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
983resource with that pattern exists. 1314resource with that pattern exists.
984 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
985This 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
986only one resource database per display, and later invocations might return 1327only one resource database per display, and later invocations might return
987the wrong resources. 1328the wrong resources.
988 1329
989=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1330=item $value = $term->x_resource_boolean ($pattern)
990 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
991Adds 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
992C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1349C<keysym> resource in the urxvt(1) manpage.
993 1350
994=item $rend = $term->rstyle ([$new_rstyle]) 1351=item $rend = $term->rstyle ([$new_rstyle])
995 1352
996Return and optionally change the current rendition. Text that is output by 1353Return and optionally change the current rendition. Text that is output by
997the terminal application will use this style. 1354the terminal application will use this style.
1005 1362
1006=item ($row, $col) = $term->selection_beg ([$row, $col]) 1363=item ($row, $col) = $term->selection_beg ([$row, $col])
1007 1364
1008=item ($row, $col) = $term->selection_end ([$row, $col]) 1365=item ($row, $col) = $term->selection_end ([$row, $col])
1009 1366
1010Return the current values of the selection mark, begin or end positions, 1367Return the current values of the selection mark, begin or end positions.
1011and 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.
1012 1376
1013=item $term->selection_make ($eventtime[, $rectangular]) 1377=item $term->selection_make ($eventtime[, $rectangular])
1014 1378
1015Tries to make a selection as set by C<selection_beg> and 1379Tries to make a selection as set by C<selection_beg> and
1016C<selection_end>. If C<$rectangular> is true (default: false), a 1380C<selection_end>. If C<$rectangular> is true (default: false), a
1017rectangular selection will be made. This is the prefered function to make 1381rectangular selection will be made. This is the preferred function to make
1018a selection. 1382a selection.
1019 1383
1020=item $success = $term->selection_grab ($eventtime) 1384=item $success = $term->selection_grab ($eventtime[, $clipboard])
1021 1385
1022Try 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
1023set by the next method). No visual feedback will be given. This function 1388with the next method. No visual feedback will be given. This function
1024is mostly useful from within C<on_sel_grab> hooks. 1389is mostly useful from within C<on_sel_grab> hooks.
1025 1390
1026=item $oldtext = $term->selection ([$newtext]) 1391=item $oldtext = $term->selection ([$newtext, $clipboard])
1027 1392
1028Return 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.
1029 1399
1030=item $term->overlay_simple ($x, $y, $text) 1400=item $term->overlay_simple ($x, $y, $text)
1031 1401
1032Create 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.
1033 1403
1063 1433
1064The methods currently supported on C<urxvt::overlay> objects are: 1434The methods currently supported on C<urxvt::overlay> objects are:
1065 1435
1066=over 4 1436=over 4
1067 1437
1068=item $overlay->set ($x, $y, $text, $rend) 1438=item $overlay->set ($x, $y, $text[, $rend])
1069 1439
1070Similar 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
1071text 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
1072at 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.
1073 1445
1074=item $overlay->hide 1446=item $overlay->hide
1075 1447
1076If visible, hide the overlay, but do not destroy it. 1448If visible, hide the overlay, but do not destroy it.
1077 1449
1140 1512
1141=item $term->scr_add_lines ($string) 1513=item $term->scr_add_lines ($string)
1142 1514
1143Write 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
1144running inside the terminal. It may not contain command sequences (escape 1516running inside the terminal. It may not contain command sequences (escape
1145codes), 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,
1146string 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.
1147 1520
1148Normally 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
1149confused by changes in cursor position or scrolling. Its useful inside a 1522confused by changes in cursor position or scrolling. Its useful inside a
1150C<on_add_lines> hook, though. 1523C<on_add_lines> hook, though.
1151 1524
1525=item $term->scr_change_screen ($screen)
1526
1527Switch to given screen - 0 primary, 1 secondary.
1528
1152=item $term->cmd_parse ($octets) 1529=item $term->cmd_parse ($octets)
1153 1530
1154Similar 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
1155locale-specific encoding of the terminal and can contain command sequences 1532locale-specific encoding of the terminal and can contain command sequences
1156(escape codes) that will be interpreted. 1533(escape codes) that will be interpreted.
1157 1534
1158=item $term->tt_write ($octets) 1535=item $term->tt_write ($octets)
1159 1536
1160Write 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
1161pass characters instead of octets, you should convert your strings first 1539characters instead of octets, you should convert your strings first to the
1162to 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.
1163 1555
1164=item $old_events = $term->pty_ev_events ([$new_events]) 1556=item $old_events = $term->pty_ev_events ([$new_events])
1165 1557
1166Replaces 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
1167be 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
1168description of C<< urxvt::timer->events >>. Make sure to always restore 1560description of C<< urxvt::timer->events >>. Make sure to always restore
1169the previous value. 1561the previous value.
1170 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
1171=item $windowid = $term->parent 1568=item $windowid = $term->parent
1172 1569
1173Return the window id of the toplevel window. 1570Return the window id of the toplevel window.
1174 1571
1175=item $windowid = $term->vt 1572=item $windowid = $term->vt
1181Adds 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
1182to receive pointer events all the times: 1579to receive pointer events all the times:
1183 1580
1184 $term->vt_emask_add (urxvt::PointerMotionMask); 1581 $term->vt_emask_add (urxvt::PointerMotionMask);
1185 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
1186=item $window_width = $term->width 1597=item $window_width = $term->width
1187 1598
1188=item $window_height = $term->height 1599=item $window_height = $term->height
1189 1600
1190=item $font_width = $term->fwidth 1601=item $font_width = $term->fwidth
1220=item $env = $term->env 1631=item $env = $term->env
1221 1632
1222Returns 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
1223similar to C<\%ENV>. 1634similar to C<\%ENV>.
1224 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
1225=cut 1645=cut
1226 1646
1227sub env { 1647sub env {
1228 if (my $env = $_[0]->_env) {
1229 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1648 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1230 } else {
1231 +{ %ENV }
1232 }
1233} 1649}
1234 1650
1235=item $modifiermask = $term->ModLevel3Mask 1651=item $modifiermask = $term->ModLevel3Mask
1236 1652
1237=item $modifiermask = $term->ModMetaMask 1653=item $modifiermask = $term->ModMetaMask
1238 1654
1239=item $modifiermask = $term->ModNumLockMask 1655=item $modifiermask = $term->ModNumLockMask
1240 1656
1241Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1657Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1242AltGr), 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.
1243 1667
1244=item $view_start = $term->view_start ([$newvalue]) 1668=item $view_start = $term->view_start ([$newvalue])
1245 1669
1246Returns the row number of the topmost displayed line. Maximum value is 1670Returns the row number of the topmost displayed line. Maximum value is
1247C<0>, which displays the normal terminal contents. Lower values scroll 1671C<0>, which displays the normal terminal contents. Lower values scroll
1255 1679
1256Used after changing terminal contents to display them. 1680Used after changing terminal contents to display them.
1257 1681
1258=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1682=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1259 1683
1260Returns 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 >>
1261is 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
1262terminal line. The scrollback buffer starts at line C<-1> and extends to
1263line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1686terminal line. Nothing will be returned if a nonexistent line
1264is requested. 1687is requested.
1265 1688
1266If 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
1267line, 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
1268to 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
1269automatically be updated. 1692automatically be updated.
1270 1693
1271C<$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
1272than one cell when displayed are padded with urxvt::NOCHAR characters 1695than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1273(C<chr 65535>). Characters with combining characters and other characters 1696characters. Characters with combining characters and other characters that
1274that 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
1275characters in the private use area. 1698in the private use area.
1276 1699
1277You have to obey this encoding when changing text. The advantage is 1700You have to obey this encoding when changing text. The advantage is
1278that 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
1279characters. 1702characters.
1280 1703
1364} 1787}
1365 1788
1366sub urxvt::line::t { 1789sub urxvt::line::t {
1367 my ($self) = @_; 1790 my ($self) = @_;
1368 1791
1369 if (@_ > 1) 1792 if (@_ > 1) {
1370 {
1371 $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})
1372 for $self->{beg} .. $self->{end}; 1794 for $self->{beg} .. $self->{end};
1373 } 1795 }
1374 1796
1375 defined wantarray && 1797 defined wantarray &&
1376 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1798 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1377 0, $self->{len} 1799 0, $self->{len}
1378} 1800}
1379 1801
1380sub urxvt::line::r { 1802sub urxvt::line::r {
1381 my ($self) = @_; 1803 my ($self) = @_;
1382 1804
1383 if (@_ > 1) 1805 if (@_ > 1) {
1384 {
1385 $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})
1386 for $self->{beg} .. $self->{end}; 1807 for $self->{beg} .. $self->{end};
1387 } 1808 }
1388 1809
1389 if (defined wantarray) { 1810 if (defined wantarray) {
1390 my $rend = [ 1811 my $rend = [
1391 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1812 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1392 ]; 1813 ];
1424where one character corresponds to one screen cell. See 1845where one character corresponds to one screen cell. See
1425C<< $term->ROW_t >> for details. 1846C<< $term->ROW_t >> for details.
1426 1847
1427=item $string = $term->special_decode $text 1848=item $string = $term->special_decode $text
1428 1849
1429Converts rxvt-unicodes text reprsentation into a perl string. See 1850Converts rxvt-unicodes text representation into a perl string. See
1430C<< $term->ROW_t >> for details. 1851C<< $term->ROW_t >> for details.
1431 1852
1432=item $success = $term->grab_button ($button, $modifiermask) 1853=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1433 1854
1855=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1856
1434Registers a synchronous button grab. See the XGrabButton manpage. 1857Register/unregister a synchronous button grab. See the XGrabButton
1858manpage.
1435 1859
1436=item $success = $term->grab ($eventtime[, $sync]) 1860=item $success = $term->grab ($eventtime[, $sync])
1437 1861
1438Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1862Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1439synchronous (C<$sync> is true). Also remembers the grab timestampe. 1863synchronous (C<$sync> is true). Also remembers the grab timestamp.
1440 1864
1441=item $term->allow_events_async 1865=item $term->allow_events_async
1442 1866
1443Calls XAllowEvents with AsyncBoth for the most recent grab. 1867Calls XAllowEvents with AsyncBoth for the most recent grab.
1444 1868
1451Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1875Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1452recent grab. 1876recent grab.
1453 1877
1454=item $term->ungrab 1878=item $term->ungrab
1455 1879
1456Calls XUngrab for the most recent grab. Is called automatically on 1880Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1457evaluation 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
1458the 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.
1459 1917
1460=back 1918=back
1461 1919
1462=cut 1920=cut
1463 1921
1527 my ($self, $text, $cb) = @_; 1985 my ($self, $text, $cb) = @_;
1528 1986
1529 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1987 $self->add_item ({ type => "button", text => $text, activate => $cb});
1530} 1988}
1531 1989
1532=item $popup->add_toggle ($text, $cb, $initial_value) 1990=item $popup->add_toggle ($text, $initial_value, $cb)
1533 1991
1534Adds a toggle/checkbox item to the popup. Teh callback gets called 1992Adds a toggle/checkbox item to the popup. The callback gets called
1535whenever 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
1536argument. 1994first argument.
1537 1995
1538=cut 1996=cut
1539 1997
1540sub add_toggle { 1998sub add_toggle {
1541 my ($self, $text, $cb, $value) = @_; 1999 my ($self, $text, $value, $cb) = @_;
1542 2000
1543 my $item; $item = { 2001 my $item; $item = {
1544 type => "button", 2002 type => "button",
1545 text => " $text", 2003 text => " $text",
1546 value => $value, 2004 value => $value,
1565 my $env = $self->{term}->env; 2023 my $env = $self->{term}->env;
1566 # 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.
1567 delete $env->{LC_ALL}; 2025 delete $env->{LC_ALL};
1568 $env->{LC_CTYPE} = $self->{term}->locale; 2026 $env->{LC_CTYPE} = $self->{term}->locale;
1569 2027
1570 urxvt::term->new ($env, $self->{term}->resource ("name"), 2028 my $term = urxvt::term->new (
1571 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 2029 $env, "popup",
2030 "--perl-lib" => "", "--perl-ext-common" => "",
2031 "-pty-fd" => -1, "-sl" => 0,
2032 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572 "--transient-for" => $self->{term}->parent, 2033 "--transient-for" => $self->{term}->parent,
1573 "-display" => $self->{term}->display_id, 2034 "-display" => $self->{term}->display_id,
1574 "-pe" => "urxvt-popup") 2035 "-pe" => "urxvt-popup",
1575 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 }
1576} 2043}
1577 2044
1578sub DESTROY { 2045sub DESTROY {
1579 my ($self) = @_; 2046 my ($self) = @_;
1580 2047
1581 delete $self->{term}{_destroy}{$self}; 2048 delete $self->{term}{_destroy}{$self};
1582 $self->{term}->ungrab; 2049 $self->{term}->ungrab;
1583} 2050}
1584 2051
1585=back 2052=back
2053
2054=cut
2055
2056package urxvt::watcher;
1586 2057
1587=head2 The C<urxvt::timer> Class 2058=head2 The C<urxvt::timer> Class
1588 2059
1589This class implements timer watchers/events. Time is represented as a 2060This class implements timer watchers/events. Time is represented as a
1590fractional number of seconds since the epoch. Example: 2061fractional number of seconds since the epoch. Example:
1594 ->new 2065 ->new
1595 ->interval (1) 2066 ->interval (1)
1596 ->cb (sub { 2067 ->cb (sub {
1597 $term->{overlay}->set (0, 0, 2068 $term->{overlay}->set (0, 0,
1598 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2069 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1599 }); 2070 });
1600 2071
1601=over 4 2072=over 4
1602 2073
1603=item $timer = new urxvt::timer 2074=item $timer = new urxvt::timer
1604 2075
1607 2078
1608=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2079=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1609 2080
1610Set the callback to be called when the timer triggers. 2081Set the callback to be called when the timer triggers.
1611 2082
1612=item $tstamp = $timer->at
1613
1614Return the time this watcher will fire next.
1615
1616=item $timer = $timer->set ($tstamp) 2083=item $timer = $timer->set ($tstamp[, $interval])
1617 2084
1618Set the time the event is generated to $tstamp. 2085Set the time the event is generated to $tstamp (and optionally specifies a
2086new $interval).
1619 2087
1620=item $timer = $timer->interval ($interval) 2088=item $timer = $timer->interval ($interval)
1621 2089
1622Normally (and when C<$interval> is C<0>), the timer will automatically 2090By default (and when C<$interval> is C<0>), the timer will automatically
1623stop 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
1624is automatically rescheduled at the given intervals. 2092is automatically rescheduled at the given intervals.
1625 2093
1626=item $timer = $timer->start 2094=item $timer = $timer->start
1627 2095
1628Start the timer. 2096Start the timer.
1629 2097
1630=item $timer = $timer->start ($tstamp) 2098=item $timer = $timer->start ($tstamp[, $interval])
1631 2099
1632Set 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.
2102
2103=item $timer = $timer->after ($delay[, $interval])
2104
2105Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633 2106
1634=item $timer = $timer->stop 2107=item $timer = $timer->stop
1635 2108
1636Stop the timer. 2109Stop the timer.
1637 2110
1643 2116
1644 $term->{socket} = ... 2117 $term->{socket} = ...
1645 $term->{iow} = urxvt::iow 2118 $term->{iow} = urxvt::iow
1646 ->new 2119 ->new
1647 ->fd (fileno $term->{socket}) 2120 ->fd (fileno $term->{socket})
1648 ->events (urxvt::EVENT_READ) 2121 ->events (urxvt::EV_READ)
1649 ->start 2122 ->start
1650 ->cb (sub { 2123 ->cb (sub {
1651 my ($iow, $revents) = @_; 2124 my ($iow, $revents) = @_;
1652 # $revents must be 1 here, no need to check 2125 # $revents must be 1 here, no need to check
1653 sysread $term->{socket}, my $buf, 8192 2126 sysread $term->{socket}, my $buf, 8192
1666Set 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>
1667is a bitset as described in the C<events> method. 2140is a bitset as described in the C<events> method.
1668 2141
1669=item $iow = $iow->fd ($fd) 2142=item $iow = $iow->fd ($fd)
1670 2143
1671Set the filedescriptor (not handle) to watch. 2144Set the file descriptor (not handle) to watch.
1672 2145
1673=item $iow = $iow->events ($eventmask) 2146=item $iow = $iow->events ($eventmask)
1674 2147
1675Set the event mask to watch. The only allowed values are 2148Set the event mask to watch. The only allowed values are
1676C<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
1677together, or C<urxvt::EVENT_NONE>. 2150together, or C<urxvt::EV_NONE>.
1678 2151
1679=item $iow = $iow->start 2152=item $iow = $iow->start
1680 2153
1681Start watching for requested events on the given handle. 2154Start watching for requested events on the given handle.
1682 2155
1683=item $iow = $iow->stop 2156=item $iow = $iow->stop
1684 2157
1685Stop 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.
1686 2220
1687=back 2221=back
1688 2222
1689=head1 ENVIRONMENT 2223=head1 ENVIRONMENT
1690 2224
1699 2233
1700=item >= 3 - script loading and management 2234=item >= 3 - script loading and management
1701 2235
1702=item >=10 - all called hooks 2236=item >=10 - all called hooks
1703 2237
1704=item >=11 - hook reutrn values 2238=item >=11 - hook return values
1705 2239
1706=back 2240=back
1707 2241
1708=head1 AUTHOR 2242=head1 AUTHOR
1709 2243
1710 Marc Lehmann <pcg@goof.com> 2244 Marc Lehmann <schmorp@schmorp.de>
1711 http://software.schmorp.de/pkg/rxvt-unicode 2245 http://software.schmorp.de/pkg/rxvt-unicode
1712 2246
1713=cut 2247=cut
1714 2248
17151 22491
2250
2251# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines