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.129 by root, Wed Jan 25 15:11:31 2006 UTC vs.
Revision 1.247 by root, Fri Dec 26 19:19:30 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines