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.125 by root, Sun Jan 22 20:39:47 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --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' 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 @@RXVT_NAME@@d, 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 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
62 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
63 ... 66 ...
64 67
65The index number (0, 1...) must not have any holes, and each regex must 68The 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 69contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
68between two vertical bars: 71between two vertical bars:
69 72
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
71 81
72You can look at the source of the selection extension to see more 82You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end. 83interesting uses, such as parsing a line from beginning to end.
74 84
75This extension also offers following bindable keyboard commands: 85This extension also offers following bindable keyboard commands:
86 96
87=item option-popup (enabled by default) 97=item option-popup (enabled by default)
88 98
89Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90runtime. 100runtime.
101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<< $self->{myoption} >>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
91 118
92=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
93 120
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
96evaluation, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
97 124
98Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100popup is displayed. 127popup is being displayed.
101 128
102It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
104It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
107 134
108The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
110C<a>s: 137C<a>s:
111 138
112 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
114 : () 141 : ()
115 }; 142 };
116 143
117=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
118 145
125search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
127bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
130selection. 157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
131 164
132=item readline (enabled by default) 165=item readline (enabled by default)
133 166
134A support package that tries to make editing with readline easier. At the 167A support package that tries to make editing with readline easier. At
135moment, it reacts to clicking with the left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
136move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
137cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
138for programs that correctly support wide characters). 171for programs that correctly support wide characters).
139 172
140To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
141 174
142=over 4 175=over 4
190the message into vi commands to load the file. 223the message into vi commands to load the file.
191 224
192=item tabbed 225=item tabbed
193 226
194This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
195is, it implements what is commonly refered to as "tabbed terminal". The topmost line 228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
196displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one 229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
197button per tab. 230button per tab.
198 231
199Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
200B<Shift-Right> will switch to the tab left or right of the current one, 233B<Shift-Right> will switch to the tab left or right of the current one,
201while B<Shift-Down> creates a new tab. 234while B<Shift-Down> creates a new tab.
202 235
203=item mark-urls 236The tabbar itself can be configured similarly to a normal terminal, but
237with a resource class of C<URxvt.tabbed>. In addition, it supports the
238following four resources (shown with defaults):
204 239
240 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242 URxvt.tabbed.tab-fg: <colour-index, default 0>
243 URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246indices.
247
248=item matcher
249
205Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
206make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
207resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
208the URL as first argument. 253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
209 258
210=item automove-background 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
211 263
212This is basically a one-line extension that dynamically changes the background pixmap offset 264It is possible to activate the most recently seen match from the keyboard.
213to the window position, in effect creating the same effect as pseudo transparency with 265Simply bind a keysym to "perl:matcher" as seen in the example below.
214a custom pixmap. No scaling is supported in this mode. Exmaple:
215 266
216 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
276
277=item xim-onthespot
278
279This (experimental) perl extension implements OnTheSpot editing. It does
280not work perfectly, and some input methods don't seem to work well with
281OnTheSpot editing in general, but it seems to work at least for SCIM and
282kinput2.
283
284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.:
286
287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289=item kuake<hotkey>
290
291A very primitive quake-console-like extension. It was inspired by a
292description of how the programs C<kuake> and C<yakuake> work: Whenever the
293user presses a global accelerator key (by default C<F10>), the terminal
294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
296
297Initially, the window will not be shown when using this extension.
298
299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key.
301
302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function.
304
305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it).
307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
217 313
218=item block-graphics-to-ascii 314=item block-graphics-to-ascii
219 315
220A not very useful example of filtering all text output to the terminal, 316A not very useful example of filtering all text output to the terminal
221by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
222similar-looking ascii character. 318similar-looking ascii character.
223 319
224=item digital-clock 320=item digital-clock
225 321
226Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
323
324=item remote-clipboard
325
326Somewhat of a misnomer, this extension adds two menu entries to the
327selection popup that allows one to run external commands to store the
328selection somewhere and fetch it again.
329
330We use it to implement a "distributed selection mechanism", which just
331means that one command uploads the file to a remote server, and another
332reads it.
333
334The commands can be set using the C<URxvt.remote-selection.store> and
335C<URxvt.remote-selection.fetch> resources. The first should read the
336selection to store from STDIN (always in UTF-8), the second should provide
337the selection data on STDOUT (also in UTF-8).
338
339The defaults (which are likely useless to you) use rsh and cat:
340
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343
344=item selection-pastebin
345
346This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.).
350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
352i.e.
353
354 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
355
356Pressing this combination runs a command with C<%> replaced by the name of
357the textfile. This command can be set via a resource:
358
359 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
360
361And the default is likely not useful to anybody but the few people around
362here :)
363
364The name of the textfile is the hex encoded md5 sum of the selection, so
365the same content should lead to the same filename.
366
367After a successful upload the selection will be replaced by the text given
368in the C<selection-pastebin-url> resource (again, the % is the placeholder
369for the filename):
370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of whether xrdb is used to parse the resource file
376or not.
377
378=item macosx-clipboard and macosx-clipboard-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
227 391
228=item example-refresh-hooks 392=item example-refresh-hooks
229 393
230Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
231window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
232overlays or changes. 396overlays or changes.
233 397
234=item selection-pastebin 398=item confirm-paste
235 399
236This is a little rarely useful extension that Uploads the selection as 400Displays a confirmation dialog when a paste containing at least a full
237textfile to a remote site (or does other things). (The implementation is 401line is detected.
238not currently secure for use in a multiuser environment as it writes to
239F</tmp> directly.).
240
241It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
242i.e.
243
244 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
245
246Pressing this combination runs a command with C<%> replaced by the name of
247the textfile. This command can be set via a resource:
248
249 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
250
251And the default is likely not useful to anybody but the few people around
252here :)
253
254The name of the textfile is the hex encoded md5 sum of the selection, so
255the same content should lead to the same filename.
256
257After a successful upload the selection will be replaced by the text given
258in the C<selection-pastebin-url> resource (again, the % is the placeholder
259for the filename):
260
261 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
262 402
263=back 403=back
264 404
265=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
266 406
282 422
283=over 4 423=over 4
284 424
285=item $text 425=item $text
286 426
287Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
288always represents one screen cell. See L<ROW_t> for a discussion of this format. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
289 429
290=item $string 430=item $string
291 431
292A perl text string, with an emphasis on I<text>. It can store all unicode 432A perl text string, with an emphasis on I<text>. It can store all unicode
300 440
301=back 441=back
302 442
303=head2 Extension Objects 443=head2 Extension Objects
304 444
305Very perl extension is a perl class. A separate perl object is created 445Every perl extension is a perl class. A separate perl object is created
306for each terminal and each extension and passed as the first parameter to 446for each terminal, and each terminal has its own set of extenion objects,
307hooks. So extensions can use their C<$self> object without having to think 447which are passed as the first parameter to hooks. So extensions can use
308about other extensions, with the exception of methods and members that 448their C<$self> object without having to think about clashes with other
449extensions or other terminals, with the exception of methods and members
309begin with an underscore character C<_>: these are reserved for internal 450that begin with an underscore character C<_>: these are reserved for
310use. 451internal use.
311 452
312Although it isn't a C<urxvt::term> object, you can call all methods of the 453Although it isn't a C<urxvt::term> object, you can call all methods of the
313C<urxvt::term> class on this object. 454C<urxvt::term> class on this object.
314 455
315It has the following methods and data members: 456It has the following methods and data members:
336=head2 Hooks 477=head2 Hooks
337 478
338The following subroutines can be declared in extension files, and will be 479The following subroutines can be declared in extension files, and will be
339called whenever the relevant event happens. 480called whenever the relevant event happens.
340 481
341The first argument passed to them is an extension oject as described in 482The first argument passed to them is an extension object as described in
342the in the C<Extension Objects> section. 483the in the C<Extension Objects> section.
343 484
344B<All> of these hooks must return a boolean value. If any of the called 485B<All> of these hooks must return a boolean value. If any of the called
345hooks returns true, then the event counts as being I<consumed>, and the 486hooks returns true, then the event counts as being I<consumed>, and the
346relevant action might not be carried out by the C++ code. 487relevant action might not be carried out by the C++ code.
359place. 500place.
360 501
361=item on_start $term 502=item on_start $term
362 503
363Called at the very end of initialisation of a new terminal, just before 504Called at the very end of initialisation of a new terminal, just before
364trying to map (display) the toplevel and returning to the mainloop. 505trying to map (display) the toplevel and returning to the main loop.
365 506
366=item on_destroy $term 507=item on_destroy $term
367 508
368Called whenever something tries to destroy terminal, before doing anything 509Called whenever something tries to destroy terminal, when the terminal is
369yet. If this hook returns true, then destruction is skipped, but this is 510still fully functional (not for long, though).
370rarely a good idea.
371 511
372=item on_reset $term 512=item on_reset $term
373 513
374Called after the screen is "reset" for any reason, such as resizing or 514Called after the screen is "reset" for any reason, such as resizing or
375control sequences. Here is where you can react on changes to size-related 515control sequences. Here is where you can react on changes to size-related
397 537
398Called whenever a selection has been copied, but before the selection is 538Called whenever a selection has been copied, but before the selection is
399requested from the server. The selection text can be queried and changed 539requested from the server. The selection text can be queried and changed
400by calling C<< $term->selection >>. 540by calling C<< $term->selection >>.
401 541
402Returning a true value aborts selection grabbing. It will still be hilighted. 542Returning a true value aborts selection grabbing. It will still be highlighted.
403 543
404=item on_sel_extend $term 544=item on_sel_extend $term
405 545
406Called whenever the user tries to extend the selection (e.g. with a double 546Called whenever the user tries to extend the selection (e.g. with a double
407click) and is either supposed to return false (normal operation), or 547click) and is either supposed to return false (normal operation), or
408should extend the selection itelf and return true to suppress the built-in 548should extend the selection itself and return true to suppress the built-in
409processing. This can happen multiple times, as long as the callback 549processing. This can happen multiple times, as long as the callback
410returns true, it will be called on every further click by the user and is 550returns true, it will be called on every further click by the user and is
411supposed to enlarge the selection more and more, if possible. 551supposed to enlarge the selection more and more, if possible.
412 552
413See the F<selection> example extension. 553See the F<selection> example extension.
414 554
415=item on_view_change $term, $offset 555=item on_view_change $term, $offset
416 556
417Called whenever the view offset changes, i..e the user or program 557Called whenever the view offset changes, i.e. the user or program
418scrolls. Offset C<0> means display the normal terminal, positive values 558scrolls. Offset C<0> means display the normal terminal, positive values
419show this many lines of scrollback. 559show this many lines of scrollback.
420 560
421=item on_scroll_back $term, $lines, $saved 561=item on_scroll_back $term, $lines, $saved
422 562
426 566
427It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 567It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
428$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 568$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
429number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
430 570
431=item on_osc_seq $term, $string 571=item on_osc_seq $term, $op, $args, $resp
572
573Called on every OSC sequence and can be used to suppress it or modify its
574behaviour. The default should be to return an empty list. A true value
575suppresses execution of the request completely. Make sure you don't get
576confused by recursive invocations when you output an OSC sequence within
577this callback.
578
579C<on_osc_seq_perl> should be used for new behaviour.
580
581=item on_osc_seq_perl $term, $args, $resp
432 582
433Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
434operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
435information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
436string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
437it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
438future. 588enforced in the future.
589
590For example, C<overlay-osc> uses this:
591
592 sub on_osc_seq_perl {
593 my ($self, $osc, $resp) = @_;
594
595 return unless $osc =~ s/^overlay;//;
596
597 ... process remaining $osc string
598 }
439 599
440Be careful not ever to trust (in a security sense) the data you receive, 600Be careful not ever to trust (in a security sense) the data you receive,
441as its source can not easily be controleld (e-mail content, messages from 601as its source can not easily be controlled (e-mail content, messages from
442other users on the same system etc.). 602other users on the same system etc.).
603
604For responses, C<$resp> contains the end-of-args separator used by the
605sender.
443 606
444=item on_add_lines $term, $string 607=item on_add_lines $term, $string
445 608
446Called whenever text is about to be output, with the text as argument. You 609Called whenever text is about to be output, with the text as argument. You
447can filter/change and output the text yourself by returning a true value 610can filter/change and output the text yourself by returning a true value
452=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
453 616
454Called whenever some data is written to the tty/pty and can be used to 617Called whenever some data is written to the tty/pty and can be used to
455suppress or filter tty input. 618suppress or filter tty input.
456 619
620=item on_tt_paste $term, $octets
621
622Called whenever text is about to be pasted, with the text as argument. You
623can filter/change and paste the text yourself by returning a true value
624and calling C<< $term->tt_paste >> yourself. C<$octets> is
625locale-encoded.
626
457=item on_line_update $term, $row 627=item on_line_update $term, $row
458 628
459Called whenever a line was updated or changed. Can be used to filter 629Called whenever a line was updated or changed. Can be used to filter
460screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
461that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
468later with the already-modified line (e.g. if unrelated parts change), so 638later with the already-modified line (e.g. if unrelated parts change), so
469you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
470 640
471=item on_refresh_begin $term 641=item on_refresh_begin $term
472 642
473Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
474or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
475restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
476code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
477 647
478=item on_refresh_end $term 648=item on_refresh_end $term
479 649
480Called just after the screen gets redrawn. See C<on_refresh_begin>. 650Called just after the screen gets redrawn. See C<on_refresh_begin>.
481 651
482=item on_keyboard_command $term, $string 652=item on_user_command $term, $string
483 653
484Called whenever the user presses a key combination that has a 654Called whenever a user-configured event is being activated (e.g. via
485C<perl:string> action bound to it (see description of the B<keysym> 655a C<perl:string> action bound to a key, see description of the B<keysym>
486resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
657
658The event is simply the action string. This interface is assumed to change
659slightly in the future.
660
661=item on_resize_all_windows $term, $new_width, $new_height
662
663Called just after the new window size has been calculated, but before
664windows are actually being resized or hints are being set. If this hook
665returns TRUE, setting of the window hints is being skipped.
487 666
488=item on_x_event $term, $event 667=item on_x_event $term, $event
489 668
490Called on every X event received on the vt window (and possibly other 669Called on every X event received on the vt window (and possibly other
491windows). Should only be used as a last resort. Most event structure 670windows). Should only be used as a last resort. Most event structure
492members are not passed. 671members are not passed.
493 672
673=item on_root_event $term, $event
674
675Like C<on_x_event>, but is called for events on the root window.
676
494=item on_focus_in $term 677=item on_focus_in $term
495 678
496Called whenever the window gets the keyboard focus, before rxvt-unicode 679Called whenever the window gets the keyboard focus, before rxvt-unicode
497does focus in processing. 680does focus in processing.
498 681
499=item on_focus_out $term 682=item on_focus_out $term
500 683
501Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called whenever the window loses keyboard focus, before rxvt-unicode does
502focus out processing. 685focus out processing.
503 686
504=item on_configure_notify $term, $event 687=item on_configure_notify $term, $event
505 688
506=item on_property_notify $term, $event 689=item on_property_notify $term, $event
517 700
518=item on_map_notify $term, $event 701=item on_map_notify $term, $event
519 702
520=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
521 704
522Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
523the hook returns true, then the even will be ignored by rxvt-unicode. 706the hook returns true, then the event will be ignored by rxvt-unicode.
524 707
525The event is a hash with most values as named by Xlib (see the XEvent 708The event is a hash with most values as named by Xlib (see the XEvent
526manpage), with the additional members C<row> and C<col>, which are the 709manpage), with the additional members C<row> and C<col>, which are the
527(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
528 711
537 720
538=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
539 722
540Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
541format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 724format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
725
726=item on_bell $term
727
728Called on receipt of a bell character.
542 729
543=back 730=back
544 731
545=cut 732=cut
546 733
589The current terminal. This variable stores the current C<urxvt::term> 776The current terminal. This variable stores the current C<urxvt::term>
590object, whenever a callback/hook is executing. 777object, whenever a callback/hook is executing.
591 778
592=item @urxvt::TERM_INIT 779=item @urxvt::TERM_INIT
593 780
594All coderefs in this array will be called as methods of the next newly 781All code references in this array will be called as methods of the next newly
595created C<urxvt::term> object (during the C<on_init> phase). The array 782created C<urxvt::term> object (during the C<on_init> phase). The array
596gets cleared before the codereferences that were in it are being executed, 783gets cleared before the code references that were in it are being executed,
597so coderefs can push themselves onto it again if they so desire. 784so references can push themselves onto it again if they so desire.
598 785
599This complements to the perl-eval commandline option, but gets executed 786This complements to the perl-eval command line option, but gets executed
600first. 787first.
601 788
602=item @urxvt::TERM_EXT 789=item @urxvt::TERM_EXT
603 790
604Works similar to C<@TERM_INIT>, but contains perl package/class names, which 791Works similar to C<@TERM_INIT>, but contains perl package/class names, which
625 812
626Using this function has the advantage that its output ends up in the 813Using this function has the advantage that its output ends up in the
627correct place, e.g. on stderr of the connecting urxvtc client. 814correct place, e.g. on stderr of the connecting urxvtc client.
628 815
629Messages have a size limit of 1023 bytes currently. 816Messages have a size limit of 1023 bytes currently.
817
818=item @terms = urxvt::termlist
819
820Returns all urxvt::term objects that exist in this process, regardless of
821whether they are started, being destroyed etc., so be careful. Only term
822objects that have perl extensions attached will be returned (because there
823is no urxvt::term objet associated with others).
630 824
631=item $time = urxvt::NOW 825=item $time = urxvt::NOW
632 826
633Returns the "current time" (as per the event loop). 827Returns the "current time" (as per the event loop).
634 828
677 871
678=item $rend = urxvt::OVERLAY_RSTYLE 872=item $rend = urxvt::OVERLAY_RSTYLE
679 873
680Return the rendition mask used for overlays by default. 874Return the rendition mask used for overlays by default.
681 875
682=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 876=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
877urxvt::RS_RVid, urxvt::RS_Uline
683 878
684Return the bit that enabled bold, italic, blink, reverse-video and 879Return the bit that enabled bold, italic, blink, reverse-video and
685underline, respectively. To enable such a style, just logically OR it into 880underline, respectively. To enable such a style, just logically OR it into
686the bitset. 881the bitset.
687 882
692Return the foreground/background colour index, respectively. 887Return the foreground/background colour index, respectively.
693 888
694=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 889=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
695 890
696=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 891=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
892
893=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
697 894
698Replace the foreground/background colour in the rendition mask with the 895Replace the foreground/background colour in the rendition mask with the
699specified one. 896specified one.
700 897
701=item $value = urxvt::GET_CUSTOM $rend 898=item $value = urxvt::GET_CUSTOM $rend
768 local $TERM = shift; 965 local $TERM = shift;
769 my $htype = shift; 966 my $htype = shift;
770 967
771 if ($htype == 0) { # INIT 968 if ($htype == 0) { # INIT
772 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 969 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
773 970
774 my %ext_arg; 971 my %ext_arg;
775 972
776 { 973 {
777 my @init = @TERM_INIT; 974 my @init = @TERM_INIT;
778 @TERM_INIT = (); 975 @TERM_INIT = ();
792 } else { 989 } else {
793 $ext_arg{$_} ||= []; 990 $ext_arg{$_} ||= [];
794 } 991 }
795 } 992 }
796 993
797 while (my ($ext, $argv) = each %ext_arg) { 994 for my $ext (sort keys %ext_arg) {
798 my @files = grep -f $_, map "$_/$ext", @dirs; 995 my @files = grep -f $_, map "$_/$ext", @dirs;
799 996
800 if (@files) { 997 if (@files) {
801 $TERM->register_package (extension_package $files[0], $argv); 998 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
802 } else { 999 } else {
803 warn "perl extension '$ext' not found in perl library search path\n"; 1000 warn "perl extension '$ext' not found in perl library search path\n";
804 } 1001 }
805 } 1002 }
806 1003
812 1009
813 if (my $cb = $TERM->{_hook}[$htype]) { 1010 if (my $cb = $TERM->{_hook}[$htype]) {
814 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1011 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
815 if $verbosity >= 10; 1012 if $verbosity >= 10;
816 1013
817 keys %$cb; 1014 for my $pkg (keys %$cb) {
818
819 while (my ($pkg, $cb) = each %$cb) {
820 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1015 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
821 $retval ||= $retval_; 1016 $retval ||= $retval_;
822 1017
823 if ($@) { 1018 if ($@) {
824 $TERM->ungrab; # better to lose the grab than the session 1019 $TERM->ungrab; # better to lose the grab than the session
825 warn $@; 1020 warn $@;
837 # clear package 1032 # clear package
838 %$TERM = (); 1033 %$TERM = ();
839 } 1034 }
840 1035
841 $retval 1036 $retval
1037}
1038
1039sub SET_COLOR($$$) {
1040 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1041}
1042
1043sub rend2mask {
1044 no strict 'refs';
1045 my ($str, $mask) = (@_, 0);
1046 my %color = ( fg => undef, bg => undef );
1047 my @failed;
1048 for my $spec ( split /\s+/, $str ) {
1049 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1050 $color{lc($1)} = $2;
1051 } else {
1052 my $neg = $spec =~ s/^[-^]//;
1053 unless ( exists &{"RS_$spec"} ) {
1054 push @failed, $spec;
1055 next;
1056 }
1057 my $cur = &{"RS_$spec"};
1058 if ( $neg ) {
1059 $mask &= ~$cur;
1060 } else {
1061 $mask |= $cur;
1062 }
1063 }
1064 }
1065 ($mask, @color{qw(fg bg)}, \@failed)
842} 1066}
843 1067
844# urxvt::term::extension 1068# urxvt::term::extension
845 1069
846package urxvt::term::extension; 1070package urxvt::term::extension;
917is that you cannot use blocking APIs, but the non-blocking variant should 1141is that you cannot use blocking APIs, but the non-blocking variant should
918work. 1142work.
919 1143
920=cut 1144=cut
921 1145
922our $VERSION = 1; 1146our $VERSION = '5.23';
923 1147
924$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1148$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
925push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1149push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
926 1150
927sub timer { 1151sub timer {
929 1153
930 my $cb = $arg{cb}; 1154 my $cb = $arg{cb};
931 1155
932 urxvt::timer 1156 urxvt::timer
933 ->new 1157 ->new
934 ->start (urxvt::NOW + $arg{after}) 1158 ->after ($arg{after}, $arg{interval})
935 ->cb (sub { 1159 ->cb ($arg{interval} ? $cb : sub {
936 $_[0]->stop; # need to cancel manually 1160 $_[0]->stop; # need to cancel manually
937 $cb->(); 1161 $cb->();
938 }) 1162 })
939} 1163}
940 1164
941sub io { 1165sub io {
942 my ($class, %arg) = @_; 1166 my ($class, %arg) = @_;
943 1167
944 my $cb = $arg{cb}; 1168 my $cb = $arg{cb};
1169 my $fd = fileno $arg{fh};
1170 defined $fd or $fd = $arg{fh};
945 1171
946 bless [$arg{fh}, urxvt::iow 1172 bless [$arg{fh}, urxvt::iow
947 ->new 1173 ->new
948 ->fd (fileno $arg{fh}) 1174 ->fd ($fd)
949 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1175 ->events (($arg{poll} =~ /r/ ? 1 : 0)
950 | ($arg{poll} =~ /w/ ? 2 : 0)) 1176 | ($arg{poll} =~ /w/ ? 2 : 0))
951 ->start 1177 ->start
952 ->cb (sub { 1178 ->cb ($cb)
953 $cb->(($_[1] & 1 ? 'r' : '')
954 . ($_[1] & 2 ? 'w' : ''));
955 })],
956 urxvt::anyevent:: 1179 ], urxvt::anyevent::
1180}
1181
1182sub idle {
1183 my ($class, %arg) = @_;
1184
1185 my $cb = $arg{cb};
1186
1187 urxvt::iw
1188 ->new
1189 ->start
1190 ->cb ($cb)
1191}
1192
1193sub child {
1194 my ($class, %arg) = @_;
1195
1196 my $cb = $arg{cb};
1197
1198 urxvt::pw
1199 ->new
1200 ->start ($arg{pid})
1201 ->cb (sub {
1202 $_[0]->stop; # need to cancel manually
1203 $cb->($_[0]->rpid, $_[0]->rstatus);
1204 })
957} 1205}
958 1206
959sub DESTROY { 1207sub DESTROY {
960 $_[0][1]->stop; 1208 $_[0][1]->stop;
961} 1209}
962 1210
963sub condvar { 1211sub one_event {
964 bless \my $flag, urxvt::anyevent::condvar::
965}
966
967sub urxvt::anyevent::condvar::broadcast {
968 ${$_[0]}++;
969}
970
971sub urxvt::anyevent::condvar::wait {
972 unless (${$_[0]}) {
973 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1212 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
974 }
975} 1213}
976 1214
977package urxvt::term; 1215package urxvt::term;
978 1216
979=head2 The C<urxvt::term> Class 1217=head2 The C<urxvt::term> Class
1015hash which defines the environment of the new terminal. 1253hash which defines the environment of the new terminal.
1016 1254
1017Croaks (and probably outputs an error message) if the new instance 1255Croaks (and probably outputs an error message) if the new instance
1018couldn't be created. Returns C<undef> if the new instance didn't 1256couldn't be created. Returns C<undef> if the new instance didn't
1019initialise perl, and the terminal object otherwise. The C<init> and 1257initialise perl, and the terminal object otherwise. The C<init> and
1020C<start> hooks will be called during this call. 1258C<start> hooks will be called before this call returns, and are free to
1259refer to global data (which is race free).
1021 1260
1022=cut 1261=cut
1023 1262
1024sub new { 1263sub new {
1025 my ($class, $env, @args) = @_; 1264 my ($class, $env, @args) = @_;
1026 1265
1266 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1267 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1268
1027 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1269 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1028} 1270}
1029 1271
1030=item $term->destroy 1272=item $term->destroy
1031 1273
1032Destroy the terminal object (close the window, free resources 1274Destroy the terminal object (close the window, free resources
1062 1304
1063Returns true if the option specified by C<$optval> is enabled, and 1305Returns true if the option specified by C<$optval> is enabled, and
1064optionally change it. All option values are stored by name in the hash 1306optionally change it. All option values are stored by name in the hash
1065C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1307C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1066 1308
1067Here is a a likely non-exhaustive list of option names, please see the 1309Here is a likely non-exhaustive list of option names, please see the
1068source file F</src/optinc.h> to see the actual list: 1310source file F</src/optinc.h> to see the actual list:
1069 1311
1070 borderLess console cursorBlink cursorUnderline hold iconic insecure 1312 borderLess console cursorBlink cursorUnderline hold iconic insecure
1071 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1313 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1072 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1314 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1089likely change). 1331likely change).
1090 1332
1091Please note that resource strings will currently only be freed when the 1333Please note that resource strings will currently only be freed when the
1092terminal is destroyed, so changing options frequently will eat memory. 1334terminal is destroyed, so changing options frequently will eat memory.
1093 1335
1094Here is a a likely non-exhaustive list of resource names, not all of which 1336Here is a likely non-exhaustive list of resource names, not all of which
1095are supported in every build, please see the source file F</src/rsinc.h> 1337are supported in every build, please see the source file F</src/rsinc.h>
1096to see the actual list: 1338to see the actual list:
1097 1339
1098 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1340 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1099 borderLess color cursorBlink cursorUnderline cutchars delete_key 1341 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1100 display_name embed ext_bwidth fade font geometry hold iconName 1342 display_name embed ext_bwidth fade font geometry hold iconName
1101 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1343 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1102 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1344 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1103 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1345 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1104 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1346 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1105 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1347 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1106 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1348 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1107 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1349 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1108 secondaryScreen secondaryScroll selectstyle shade term_name title 1350 secondaryScreen secondaryScroll shade term_name title
1109 transient_for transparent transparent_all tripleclickwords utmpInhibit 1351 transient_for transparent transparent_all tripleclickwords utmpInhibit
1110 visualBell 1352 visualBell
1111 1353
1112=cut 1354=cut
1113 1355
1114sub resource($$;$) { 1356sub resource($$;$) {
1115 my ($self, $name) = (shift, shift); 1357 my ($self, $name) = (shift, shift);
1116 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1358 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1117 &urxvt::term::_resource 1359 goto &urxvt::term::_resource
1118} 1360}
1119 1361
1120=item $value = $term->x_resource ($pattern) 1362=item $value = $term->x_resource ($pattern)
1121 1363
1122Returns the X-Resource for the given pattern, excluding the program or 1364Returns the X-Resource for the given pattern, excluding the program or
1147 1389
1148=item ($row, $col) = $term->selection_beg ([$row, $col]) 1390=item ($row, $col) = $term->selection_beg ([$row, $col])
1149 1391
1150=item ($row, $col) = $term->selection_end ([$row, $col]) 1392=item ($row, $col) = $term->selection_end ([$row, $col])
1151 1393
1152Return the current values of the selection mark, begin or end positions, 1394Return the current values of the selection mark, begin or end positions.
1153and optionally set them to new values. 1395
1396When arguments are given, then the selection coordinates are set to
1397C<$row> and C<$col>, and the selection screen is set to the current
1398screen.
1399
1400=item $screen = $term->selection_screen ([$screen])
1401
1402Returns the current selection screen, and then optionally sets it.
1154 1403
1155=item $term->selection_make ($eventtime[, $rectangular]) 1404=item $term->selection_make ($eventtime[, $rectangular])
1156 1405
1157Tries to make a selection as set by C<selection_beg> and 1406Tries to make a selection as set by C<selection_beg> and
1158C<selection_end>. If C<$rectangular> is true (default: false), a 1407C<selection_end>. If C<$rectangular> is true (default: false), a
1159rectangular selection will be made. This is the prefered function to make 1408rectangular selection will be made. This is the preferred function to make
1160a selection. 1409a selection.
1161 1410
1162=item $success = $term->selection_grab ($eventtime) 1411=item $success = $term->selection_grab ($eventtime[, $clipboard])
1163 1412
1164Try to request the primary selection text from the server (for example, as 1413Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1414true) selection from the server. The corresponding text can be set
1165set by the next method). No visual feedback will be given. This function 1415with the next method. No visual feedback will be given. This function
1166is mostly useful from within C<on_sel_grab> hooks. 1416is mostly useful from within C<on_sel_grab> hooks.
1167 1417
1168=item $oldtext = $term->selection ([$newtext]) 1418=item $oldtext = $term->selection ([$newtext, $clipboard])
1169 1419
1170Return the current selection text and optionally replace it by C<$newtext>. 1420Return the current selection (clipboard if C<$clipboard> is true) text
1421and optionally replace it by C<$newtext>.
1422
1423=item $term->selection_clear ([$clipboard])
1424
1425Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1171 1426
1172=item $term->overlay_simple ($x, $y, $text) 1427=item $term->overlay_simple ($x, $y, $text)
1173 1428
1174Create a simple multi-line overlay box. See the next method for details. 1429Create a simple multi-line overlay box. See the next method for details.
1175 1430
1205 1460
1206The methods currently supported on C<urxvt::overlay> objects are: 1461The methods currently supported on C<urxvt::overlay> objects are:
1207 1462
1208=over 4 1463=over 4
1209 1464
1210=item $overlay->set ($x, $y, $text, $rend) 1465=item $overlay->set ($x, $y, $text[, $rend])
1211 1466
1212Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1467Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1213text in rxvt-unicode's special encoding and an array of rendition values 1468text in rxvt-unicode's special encoding and an array of rendition values
1214at a specific position inside the overlay. 1469at a specific position inside the overlay.
1470
1471If C<$rend> is missing, then the rendition will not be changed.
1215 1472
1216=item $overlay->hide 1473=item $overlay->hide
1217 1474
1218If visible, hide the overlay, but do not destroy it. 1475If visible, hide the overlay, but do not destroy it.
1219 1476
1301locale-specific encoding of the terminal and can contain command sequences 1558locale-specific encoding of the terminal and can contain command sequences
1302(escape codes) that will be interpreted. 1559(escape codes) that will be interpreted.
1303 1560
1304=item $term->tt_write ($octets) 1561=item $term->tt_write ($octets)
1305 1562
1306Write the octets given in C<$data> to the tty (i.e. as program input). To 1563Write the octets given in C<$octets> to the tty (i.e. as program input). To
1307pass characters instead of octets, you should convert your strings first 1564pass characters instead of octets, you should convert your strings first
1308to the locale-specific encoding using C<< $term->locale_encode >>. 1565to the locale-specific encoding using C<< $term->locale_encode >>.
1566
1567=item $term->tt_paste ($octets)
1568
1569Write the octets given in C<$octets> to the tty as a paste, converting NL to
1570CR and bracketing the data with control sequences if bracketed paste mode
1571is set.
1309 1572
1310=item $old_events = $term->pty_ev_events ([$new_events]) 1573=item $old_events = $term->pty_ev_events ([$new_events])
1311 1574
1312Replaces the event mask of the pty watcher by the given event mask. Can 1575Replaces the event mask of the pty watcher by the given event mask. Can
1313be used to suppress input and output handling to the pty/tty. See the 1576be used to suppress input and output handling to the pty/tty. See the
1332Adds the specified events to the vt event mask. Useful e.g. when you want 1595Adds the specified events to the vt event mask. Useful e.g. when you want
1333to receive pointer events all the times: 1596to receive pointer events all the times:
1334 1597
1335 $term->vt_emask_add (urxvt::PointerMotionMask); 1598 $term->vt_emask_add (urxvt::PointerMotionMask);
1336 1599
1600=item $term->focus_in
1601
1602=item $term->focus_out
1603
1604=item $term->key_press ($state, $keycode[, $time])
1605
1606=item $term->key_release ($state, $keycode[, $time])
1607
1608Deliver various fake events to to terminal.
1609
1337=item $window_width = $term->width 1610=item $window_width = $term->width
1338 1611
1339=item $window_height = $term->height 1612=item $window_height = $term->height
1340 1613
1341=item $font_width = $term->fwidth 1614=item $font_width = $term->fwidth
1371=item $env = $term->env 1644=item $env = $term->env
1372 1645
1373Returns a copy of the environment in effect for the terminal as a hashref 1646Returns a copy of the environment in effect for the terminal as a hashref
1374similar to C<\%ENV>. 1647similar to C<\%ENV>.
1375 1648
1649=item @envv = $term->envv
1650
1651Returns the environment as array of strings of the form C<VAR=VALUE>.
1652
1653=item @argv = $term->argv
1654
1655Return the argument vector as this terminal, similar to @ARGV, but
1656includes the program name as first element.
1657
1376=cut 1658=cut
1377 1659
1378sub env { 1660sub env {
1379 if (my $env = $_[0]->_env) {
1380 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1661 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1381 } else {
1382 +{ %ENV }
1383 }
1384} 1662}
1385 1663
1386=item $modifiermask = $term->ModLevel3Mask 1664=item $modifiermask = $term->ModLevel3Mask
1387 1665
1388=item $modifiermask = $term->ModMetaMask 1666=item $modifiermask = $term->ModMetaMask
1396 1674
1397Returns the currently displayed screen (0 primary, 1 secondary). 1675Returns the currently displayed screen (0 primary, 1 secondary).
1398 1676
1399=item $cursor_is_hidden = $term->hidden_cursor 1677=item $cursor_is_hidden = $term->hidden_cursor
1400 1678
1401Returns wether the cursor is currently hidden or not. 1679Returns whether the cursor is currently hidden or not.
1402 1680
1403=item $view_start = $term->view_start ([$newvalue]) 1681=item $view_start = $term->view_start ([$newvalue])
1404 1682
1405Returns the row number of the topmost displayed line. Maximum value is 1683Returns the row number of the topmost displayed line. Maximum value is
1406C<0>, which displays the normal terminal contents. Lower values scroll 1684C<0>, which displays the normal terminal contents. Lower values scroll
1414 1692
1415Used after changing terminal contents to display them. 1693Used after changing terminal contents to display them.
1416 1694
1417=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1695=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1418 1696
1419Returns the text of the entire row with number C<$row_number>. Row C<0> 1697Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1420is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1698is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1421terminal line. The scrollback buffer starts at line C<-1> and extends to
1422line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1699terminal line. Nothing will be returned if a nonexistent line
1423is requested. 1700is requested.
1424 1701
1425If C<$new_text> is specified, it will replace characters in the current 1702If C<$new_text> is specified, it will replace characters in the current
1426line, starting at column C<$start_col> (default C<0>), which is useful 1703line, starting at column C<$start_col> (default C<0>), which is useful
1427to replace only parts of a line. The font index in the rendition will 1704to replace only parts of a line. The font index in the rendition will
1428automatically be updated. 1705automatically be updated.
1429 1706
1430C<$text> is in a special encoding: tabs and wide characters that use more 1707C<$text> is in a special encoding: tabs and wide characters that use more
1431than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1708than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1432characters. Characters with combining characters and other characters that 1709characters. Characters with combining characters and other characters that
1433do not fit into the normal tetx encoding will be replaced with characters 1710do not fit into the normal text encoding will be replaced with characters
1434in the private use area. 1711in the private use area.
1435 1712
1436You have to obey this encoding when changing text. The advantage is 1713You have to obey this encoding when changing text. The advantage is
1437that C<substr> and similar functions work on screen cells and not on 1714that C<substr> and similar functions work on screen cells and not on
1438characters. 1715characters.
1583where one character corresponds to one screen cell. See 1860where one character corresponds to one screen cell. See
1584C<< $term->ROW_t >> for details. 1861C<< $term->ROW_t >> for details.
1585 1862
1586=item $string = $term->special_decode $text 1863=item $string = $term->special_decode $text
1587 1864
1588Converts rxvt-unicodes text reprsentation into a perl string. See 1865Converts rxvt-unicodes text representation into a perl string. See
1589C<< $term->ROW_t >> for details. 1866C<< $term->ROW_t >> for details.
1590 1867
1591=item $success = $term->grab_button ($button, $modifiermask) 1868=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1592 1869
1870=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1871
1593Registers a synchronous button grab. See the XGrabButton manpage. 1872Register/unregister a synchronous button grab. See the XGrabButton
1873manpage.
1594 1874
1595=item $success = $term->grab ($eventtime[, $sync]) 1875=item $success = $term->grab ($eventtime[, $sync])
1596 1876
1597Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1877Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1598synchronous (C<$sync> is true). Also remembers the grab timestampe. 1878synchronous (C<$sync> is true). Also remembers the grab timestamp.
1599 1879
1600=item $term->allow_events_async 1880=item $term->allow_events_async
1601 1881
1602Calls XAllowEvents with AsyncBoth for the most recent grab. 1882Calls XAllowEvents with AsyncBoth for the most recent grab.
1603 1883
1610Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1890Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1611recent grab. 1891recent grab.
1612 1892
1613=item $term->ungrab 1893=item $term->ungrab
1614 1894
1615Calls XUngrab for the most recent grab. Is called automatically on 1895Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1616evaluation errors, as it is better to lose the grab in the error case as 1896evaluation errors, as it is better to lose the grab in the error case as
1617the session. 1897the session.
1618 1898
1619=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1899=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1620 1900
1622 1902
1623=item @atoms = $term->XListProperties ($window) 1903=item @atoms = $term->XListProperties ($window)
1624 1904
1625=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1905=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1626 1906
1627=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1907=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1628 1908
1629=item $term->XDeleteProperty ($window, $property) 1909=item $term->XDeleteProperty ($window, $property)
1630 1910
1631=item $window = $term->DefaultRootWindow 1911=item $window = $term->DefaultRootWindow
1632 1912
1642 1922
1643=item $term->XChangeInput ($window, $add_events[, $del_events]) 1923=item $term->XChangeInput ($window, $add_events[, $del_events])
1644 1924
1645Various X or X-related functions. The C<$term> object only serves as 1925Various X or X-related functions. The C<$term> object only serves as
1646the source of the display, otherwise those functions map more-or-less 1926the source of the display, otherwise those functions map more-or-less
1647directory onto the X functions of the same name. 1927directly onto the X functions of the same name.
1648 1928
1649=back 1929=back
1650 1930
1651=cut 1931=cut
1652 1932
1716 my ($self, $text, $cb) = @_; 1996 my ($self, $text, $cb) = @_;
1717 1997
1718 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1998 $self->add_item ({ type => "button", text => $text, activate => $cb});
1719} 1999}
1720 2000
1721=item $popup->add_toggle ($text, $cb, $initial_value) 2001=item $popup->add_toggle ($text, $initial_value, $cb)
1722 2002
1723Adds a toggle/checkbox item to the popup. Teh callback gets called 2003Adds a toggle/checkbox item to the popup. The callback gets called
1724whenever it gets toggled, with a boolean indicating its value as its first 2004whenever it gets toggled, with a boolean indicating its new value as its
1725argument. 2005first argument.
1726 2006
1727=cut 2007=cut
1728 2008
1729sub add_toggle { 2009sub add_toggle {
1730 my ($self, $text, $cb, $value) = @_; 2010 my ($self, $text, $value, $cb) = @_;
1731 2011
1732 my $item; $item = { 2012 my $item; $item = {
1733 type => "button", 2013 type => "button",
1734 text => " $text", 2014 text => " $text",
1735 value => $value, 2015 value => $value,
1754 my $env = $self->{term}->env; 2034 my $env = $self->{term}->env;
1755 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2035 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1756 delete $env->{LC_ALL}; 2036 delete $env->{LC_ALL};
1757 $env->{LC_CTYPE} = $self->{term}->locale; 2037 $env->{LC_CTYPE} = $self->{term}->locale;
1758 2038
1759 urxvt::term->new ($env, "popup", 2039 my $term = urxvt::term->new (
2040 $env, "popup",
1760 "--perl-lib" => "", "--perl-ext-common" => "", 2041 "--perl-lib" => "", "--perl-ext-common" => "",
1761 "-pty-fd" => -1, "-sl" => 0, 2042 "-pty-fd" => -1, "-sl" => 0,
1762 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2043 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1763 "--transient-for" => $self->{term}->parent, 2044 "--transient-for" => $self->{term}->parent,
1764 "-display" => $self->{term}->display_id, 2045 "-display" => $self->{term}->display_id,
1765 "-pe" => "urxvt-popup") 2046 "-pe" => "urxvt-popup",
1766 or die "unable to create popup window\n"; 2047 ) or die "unable to create popup window\n";
2048
2049 unless (delete $term->{urxvt_popup_init_done}) {
2050 $term->ungrab;
2051 $term->destroy;
2052 die "unable to initialise popup window\n";
2053 }
1767} 2054}
1768 2055
1769sub DESTROY { 2056sub DESTROY {
1770 my ($self) = @_; 2057 my ($self) = @_;
1771 2058
1776=back 2063=back
1777 2064
1778=cut 2065=cut
1779 2066
1780package urxvt::watcher; 2067package urxvt::watcher;
1781
1782@urxvt::timer::ISA = __PACKAGE__;
1783@urxvt::iow::ISA = __PACKAGE__;
1784@urxvt::pw::ISA = __PACKAGE__;
1785@urxvt::iw::ISA = __PACKAGE__;
1786 2068
1787=head2 The C<urxvt::timer> Class 2069=head2 The C<urxvt::timer> Class
1788 2070
1789This class implements timer watchers/events. Time is represented as a 2071This class implements timer watchers/events. Time is represented as a
1790fractional number of seconds since the epoch. Example: 2072fractional number of seconds since the epoch. Example:
1794 ->new 2076 ->new
1795 ->interval (1) 2077 ->interval (1)
1796 ->cb (sub { 2078 ->cb (sub {
1797 $term->{overlay}->set (0, 0, 2079 $term->{overlay}->set (0, 0,
1798 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2080 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1799 }); 2081 });
1800 2082
1801=over 4 2083=over 4
1802 2084
1803=item $timer = new urxvt::timer 2085=item $timer = new urxvt::timer
1804 2086
1807 2089
1808=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2090=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1809 2091
1810Set the callback to be called when the timer triggers. 2092Set the callback to be called when the timer triggers.
1811 2093
1812=item $tstamp = $timer->at
1813
1814Return the time this watcher will fire next.
1815
1816=item $timer = $timer->set ($tstamp) 2094=item $timer = $timer->set ($tstamp[, $interval])
1817 2095
1818Set the time the event is generated to $tstamp. 2096Set the time the event is generated to $tstamp (and optionally specifies a
2097new $interval).
1819 2098
1820=item $timer = $timer->interval ($interval) 2099=item $timer = $timer->interval ($interval)
1821 2100
1822Normally (and when C<$interval> is C<0>), the timer will automatically 2101By default (and when C<$interval> is C<0>), the timer will automatically
1823stop after it has fired once. If C<$interval> is non-zero, then the timer 2102stop after it has fired once. If C<$interval> is non-zero, then the timer
1824is automatically rescheduled at the given intervals. 2103is automatically rescheduled at the given intervals.
1825 2104
1826=item $timer = $timer->start 2105=item $timer = $timer->start
1827 2106
1828Start the timer. 2107Start the timer.
1829 2108
1830=item $timer = $timer->start ($tstamp) 2109=item $timer = $timer->start ($tstamp[, $interval])
1831 2110
1832Set the event trigger time to C<$tstamp> and start the timer. 2111Set the event trigger time to C<$tstamp> and start the timer. Optionally
2112also replaces the interval.
1833 2113
1834=item $timer = $timer->after ($delay) 2114=item $timer = $timer->after ($delay[, $interval])
1835 2115
1836Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2116Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1837 2117
1838=item $timer = $timer->stop 2118=item $timer = $timer->stop
1839 2119
1847 2127
1848 $term->{socket} = ... 2128 $term->{socket} = ...
1849 $term->{iow} = urxvt::iow 2129 $term->{iow} = urxvt::iow
1850 ->new 2130 ->new
1851 ->fd (fileno $term->{socket}) 2131 ->fd (fileno $term->{socket})
1852 ->events (urxvt::EVENT_READ) 2132 ->events (urxvt::EV_READ)
1853 ->start 2133 ->start
1854 ->cb (sub { 2134 ->cb (sub {
1855 my ($iow, $revents) = @_; 2135 my ($iow, $revents) = @_;
1856 # $revents must be 1 here, no need to check 2136 # $revents must be 1 here, no need to check
1857 sysread $term->{socket}, my $buf, 8192 2137 sysread $term->{socket}, my $buf, 8192
1870Set the callback to be called when io events are triggered. C<$reventmask> 2150Set the callback to be called when io events are triggered. C<$reventmask>
1871is a bitset as described in the C<events> method. 2151is a bitset as described in the C<events> method.
1872 2152
1873=item $iow = $iow->fd ($fd) 2153=item $iow = $iow->fd ($fd)
1874 2154
1875Set the filedescriptor (not handle) to watch. 2155Set the file descriptor (not handle) to watch.
1876 2156
1877=item $iow = $iow->events ($eventmask) 2157=item $iow = $iow->events ($eventmask)
1878 2158
1879Set the event mask to watch. The only allowed values are 2159Set the event mask to watch. The only allowed values are
1880C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2160C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1881together, or C<urxvt::EVENT_NONE>. 2161together, or C<urxvt::EV_NONE>.
1882 2162
1883=item $iow = $iow->start 2163=item $iow = $iow->start
1884 2164
1885Start watching for requested events on the given handle. 2165Start watching for requested events on the given handle.
1886 2166
1887=item $iow = $iow->stop 2167=item $iow = $iow->stop
1888 2168
1889Stop watching for events on the given filehandle. 2169Stop watching for events on the given file handle.
1890 2170
1891=back 2171=back
1892 2172
1893=head2 The C<urxvt::iw> Class 2173=head2 The C<urxvt::iw> Class
1894 2174
1927 ->new 2207 ->new
1928 ->start ($pid) 2208 ->start ($pid)
1929 ->cb (sub { 2209 ->cb (sub {
1930 my ($pw, $exit_status) = @_; 2210 my ($pw, $exit_status) = @_;
1931 ... 2211 ...
1932 }); 2212 });
1933 2213
1934=over 4 2214=over 4
1935 2215
1936=item $pw = new urxvt::pw 2216=item $pw = new urxvt::pw
1937 2217
1941 2221
1942Set the callback to be called when the timer triggers. 2222Set the callback to be called when the timer triggers.
1943 2223
1944=item $pw = $timer->start ($pid) 2224=item $pw = $timer->start ($pid)
1945 2225
1946Tells the wqtcher to start watching for process C<$pid>. 2226Tells the watcher to start watching for process C<$pid>.
1947 2227
1948=item $pw = $pw->stop 2228=item $pw = $pw->stop
1949 2229
1950Stop the watcher. 2230Stop the watcher.
1951 2231
1964 2244
1965=item >= 3 - script loading and management 2245=item >= 3 - script loading and management
1966 2246
1967=item >=10 - all called hooks 2247=item >=10 - all called hooks
1968 2248
1969=item >=11 - hook reutrn values 2249=item >=11 - hook return values
1970 2250
1971=back 2251=back
1972 2252
1973=head1 AUTHOR 2253=head1 AUTHOR
1974 2254
1976 http://software.schmorp.de/pkg/rxvt-unicode 2256 http://software.schmorp.de/pkg/rxvt-unicode
1977 2257
1978=cut 2258=cut
1979 2259
19801 22601
2261
2262# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines