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.131 by root, Sun Jan 29 20:51:28 2006 UTC vs.
Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 2011 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: \\|([^|]+)\\|
71 74
72Another example: Programs I use often output "absolute path: " at the 75Another example: Programs I use often output "absolute path: " at the
94=item option-popup (enabled by default) 97=item option-popup (enabled by default)
95 98
96Binds 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
97runtime. 100runtime.
98 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 };
118
99=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
100 120
101Binds 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
102text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
103evaluation, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
104 124
105Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107popup is displayed. 127popup is being displayed.
108 128
109It'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
110is 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.
111It 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
112string 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
113when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
114 134
115The 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
116the 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
117C<a>s: 137C<a>s:
118 138
119 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
120 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
121 : () 141 : ()
122 }; 142 };
123 143
124=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
125 145
132search. 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>
133search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
134bottom. 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
135was 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
136additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
137selection. 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.
138 164
139=item readline (enabled by default) 165=item readline (enabled by default)
140 166
141A support package that tries to make editing with readline easier. At the 167A support package that tries to make editing with readline easier. At
142moment, 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
143move 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
144cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
145for programs that correctly support wide characters). 171for programs that correctly support wide characters).
146 172
147To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
148 174
149=over 4 175=over 4
197the message into vi commands to load the file. 223the message into vi commands to load the file.
198 224
199=item tabbed 225=item tabbed
200 226
201This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
202is, 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
203displays 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
204button per tab. 230button per tab.
205 231
206Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking 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, 233B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab. 234while B<Shift-Down> creates a new tab.
209 235
210=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):
211 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
212Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
213make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
214resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
215the 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.
258
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.
263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
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
216 276
217=item xim-onthespot 277=item xim-onthespot
218 278
219This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
220not work perfectly, and some input methods don't seem to work well with 280not 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 281OnTheSpot editing in general, but it seems to work at least for SCIM and
222kinput2. 282kinput2.
223 283
224You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
225C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
226 286
227 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228 288
229=item automove-background 289=item kuake<hotkey>
230 290
231This is basically a one-line extension that dynamically changes the background pixmap offset 291A very primitive quake-console-like extension. It was inspired by a
232to the window position, in effect creating the same effect as pseudo transparency with 292description of how the programs C<kuake> and C<yakuake> work: Whenever the
233a custom pixmap. No scaling is supported in this mode. Exmaple: 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.
234 296
235 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 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.
236 313
237=item block-graphics-to-ascii 314=item block-graphics-to-ascii
238 315
239A 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
240by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
241similar-looking ascii character. 318similar-looking ascii character.
242 319
243=item digital-clock 320=item digital-clock
244 321
245Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
246 323
247=item remote-clipboard 324=item remote-clipboard
248 325
249Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
250selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
251selection somewhere and fetch it again. 328selection somewhere and fetch it again.
252 329
253We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
254means that one command uploads the file to a remote server, and another 331means that one command uploads the file to a remote server, and another
255reads it. 332reads it.
264 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266 343
267=item selection-pastebin 344=item selection-pastebin
268 345
269This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
270textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
271not currently secure for use in a multiuser environment as it writes to 348not currently secure for use in a multiuser environment as it writes to
272F</tmp> directly.). 349F</tmp> directly.).
273 350
274It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
291in the C<selection-pastebin-url> resource (again, the % is the placeholder 368in the C<selection-pastebin-url> resource (again, the % is the placeholder
292for the filename): 369for the filename):
293 370
294 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295 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.
391
296=item example-refresh-hooks 392=item example-refresh-hooks
297 393
298Displays 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
299window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
300overlays or changes. 396overlays or changes.
397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
301 402
302=back 403=back
303 404
304=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
305 406
321 422
322=over 4 423=over 4
323 424
324=item $text 425=item $text
325 426
326Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-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. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
328 429
329=item $string 430=item $string
330 431
331A 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
339 440
340=back 441=back
341 442
342=head2 Extension Objects 443=head2 Extension Objects
343 444
344Very 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
345for each terminal and each extension and passed as the first parameter to 446for 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 447which are passed as the first parameter to hooks. So extensions can use
347about 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
348begin with an underscore character C<_>: these are reserved for internal 450that begin with an underscore character C<_>: these are reserved for
349use. 451internal use.
350 452
351Although 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
352C<urxvt::term> class on this object. 454C<urxvt::term> class on this object.
353 455
354It has the following methods and data members: 456It has the following methods and data members:
375=head2 Hooks 477=head2 Hooks
376 478
377The following subroutines can be declared in extension files, and will be 479The following subroutines can be declared in extension files, and will be
378called whenever the relevant event happens. 480called whenever the relevant event happens.
379 481
380The 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
381the in the C<Extension Objects> section. 483the in the C<Extension Objects> section.
382 484
383B<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
384hooks 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
385relevant action might not be carried out by the C++ code. 487relevant action might not be carried out by the C++ code.
398place. 500place.
399 501
400=item on_start $term 502=item on_start $term
401 503
402Called 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
403trying to map (display) the toplevel and returning to the mainloop. 505trying to map (display) the toplevel and returning to the main loop.
404 506
405=item on_destroy $term 507=item on_destroy $term
406 508
407Called whenever something tries to destroy terminal, when the terminal is 509Called whenever something tries to destroy terminal, when the terminal is
408still fully functional (not for long, though). 510still fully functional (not for long, though).
435 537
436Called whenever a selection has been copied, but before the selection is 538Called whenever a selection has been copied, but before the selection is
437requested from the server. The selection text can be queried and changed 539requested from the server. The selection text can be queried and changed
438by calling C<< $term->selection >>. 540by calling C<< $term->selection >>.
439 541
440Returning a true value aborts selection grabbing. It will still be hilighted. 542Returning a true value aborts selection grabbing. It will still be highlighted.
441 543
442=item on_sel_extend $term 544=item on_sel_extend $term
443 545
444Called 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
445click) and is either supposed to return false (normal operation), or 547click) and is either supposed to return false (normal operation), or
446should 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
447processing. This can happen multiple times, as long as the callback 549processing. 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 550returns true, it will be called on every further click by the user and is
449supposed to enlarge the selection more and more, if possible. 551supposed to enlarge the selection more and more, if possible.
450 552
451See the F<selection> example extension. 553See the F<selection> example extension.
452 554
453=item on_view_change $term, $offset 555=item on_view_change $term, $offset
454 556
455Called whenever the view offset changes, i..e the user or program 557Called whenever the view offset changes, i.e. the user or program
456scrolls. Offset C<0> means display the normal terminal, positive values 558scrolls. Offset C<0> means display the normal terminal, positive values
457show this many lines of scrollback. 559show this many lines of scrollback.
458 560
459=item on_scroll_back $term, $lines, $saved 561=item on_scroll_back $term, $lines, $saved
460 562
464 566
465It 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,
466$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
467number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
468 570
469=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
470 582
471Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
472operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
473information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
474string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
475it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
476future. 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 }
477 599
478Be 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,
479as 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
480other 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.
481 606
482=item on_add_lines $term, $string 607=item on_add_lines $term, $string
483 608
484Called 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
485can 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
490=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
491 616
492Called 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
493suppress or filter tty input. 618suppress or filter tty input.
494 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
495=item on_line_update $term, $row 627=item on_line_update $term, $row
496 628
497Called 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
498screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
499that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
506later 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
507you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
508 640
509=item on_refresh_begin $term 641=item on_refresh_begin $term
510 642
511Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
512or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
513restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
514code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
515 647
516=item on_refresh_end $term 648=item on_refresh_end $term
517 649
518Called just after the screen gets redrawn. See C<on_refresh_begin>. 650Called just after the screen gets redrawn. See C<on_refresh_begin>.
519 651
520=item on_user_command $term, $string 652=item on_user_command $term, $string
521 653
522Called whenever the a user-configured event is being activated (e.g. via 654Called whenever a user-configured event is being activated (e.g. via
523a C<perl:string> action bound to a key, see description of the B<keysym> 655a C<perl:string> action bound to a key, see description of the B<keysym>
524resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
525 657
526The event is simply the action string. This interface is assumed to change 658The event is simply the action string. This interface is assumed to change
527slightly in the future. 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.
528 666
529=item on_x_event $term, $event 667=item on_x_event $term, $event
530 668
531Called 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
532windows). Should only be used as a last resort. Most event structure 670windows). Should only be used as a last resort. Most event structure
533members are not passed. 671members are not passed.
534 672
673=item on_root_event $term, $event
674
675Like C<on_x_event>, but is called for events on the root window.
676
535=item on_focus_in $term 677=item on_focus_in $term
536 678
537Called whenever the window gets the keyboard focus, before rxvt-unicode 679Called whenever the window gets the keyboard focus, before rxvt-unicode
538does focus in processing. 680does focus in processing.
539 681
540=item on_focus_out $term 682=item on_focus_out $term
541 683
542Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called whenever the window loses keyboard focus, before rxvt-unicode does
543focus out processing. 685focus out processing.
544 686
545=item on_configure_notify $term, $event 687=item on_configure_notify $term, $event
546 688
547=item on_property_notify $term, $event 689=item on_property_notify $term, $event
558 700
559=item on_map_notify $term, $event 701=item on_map_notify $term, $event
560 702
561=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
562 704
563Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
564the 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.
565 707
566The 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
567manpage), 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
568(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
569 711
578 720
579=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
580 722
581Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
582format=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.
583 729
584=back 730=back
585 731
586=cut 732=cut
587 733
630The current terminal. This variable stores the current C<urxvt::term> 776The current terminal. This variable stores the current C<urxvt::term>
631object, whenever a callback/hook is executing. 777object, whenever a callback/hook is executing.
632 778
633=item @urxvt::TERM_INIT 779=item @urxvt::TERM_INIT
634 780
635All 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
636created 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
637gets cleared before the codereferences that were in it are being executed, 783gets cleared before the code references that were in it are being executed,
638so coderefs can push themselves onto it again if they so desire. 784so references can push themselves onto it again if they so desire.
639 785
640This complements to the perl-eval commandline option, but gets executed 786This complements to the perl-eval command line option, but gets executed
641first. 787first.
642 788
643=item @urxvt::TERM_EXT 789=item @urxvt::TERM_EXT
644 790
645Works 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
652 798
653=over 4 799=over 4
654 800
655=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
656 802
657Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
658costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
659starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
660 807
661=item urxvt::warn $string 808=item urxvt::warn $string
662 809
663Calls C<rxvt_warn> with the given string which should not include a 810Calls C<rxvt_warn> with the given string which should include a trailing
664newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
665that calls this function. 812that calls this function.
666 813
667Using this function has the advantage that its output ends up in the 814Using this function has the advantage that its output ends up in the
668correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
670Messages have a size limit of 1023 bytes currently. 817Messages have a size limit of 1023 bytes currently.
671 818
672=item @terms = urxvt::termlist 819=item @terms = urxvt::termlist
673 820
674Returns all urxvt::term objects that exist in this process, regardless of 821Returns all urxvt::term objects that exist in this process, regardless of
675wether they are started, being destroyed etc., so be careful. Only term 822whether they are started, being destroyed etc., so be careful. Only term
676objects that have perl extensions attached will be returned (because there 823objects that have perl extensions attached will be returned (because there
677is no urxvt::term objet associated with others). 824is no urxvt::term object associated with others).
678 825
679=item $time = urxvt::NOW 826=item $time = urxvt::NOW
680 827
681Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
682 829
725 872
726=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
727 874
728Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
729 876
730=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 877=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
878urxvt::RS_RVid, urxvt::RS_Uline
731 879
732Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
733underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
734the bitset. 882the bitset.
735 883
740Return the foreground/background colour index, respectively. 888Return the foreground/background colour index, respectively.
741 889
742=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 890=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
743 891
744=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 892=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
893
894=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
745 895
746Replace the foreground/background colour in the rendition mask with the 896Replace the foreground/background colour in the rendition mask with the
747specified one. 897specified one.
748 898
749=item $value = urxvt::GET_CUSTOM $rend 899=item $value = urxvt::GET_CUSTOM $rend
816 local $TERM = shift; 966 local $TERM = shift;
817 my $htype = shift; 967 my $htype = shift;
818 968
819 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
820 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
821 971
822 my %ext_arg; 972 my %ext_arg;
823 973
824 { 974 {
825 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
826 @TERM_INIT = (); 976 @TERM_INIT = ();
840 } else { 990 } else {
841 $ext_arg{$_} ||= []; 991 $ext_arg{$_} ||= [];
842 } 992 }
843 } 993 }
844 994
845 while (my ($ext, $argv) = each %ext_arg) { 995 for my $ext (sort keys %ext_arg) {
846 my @files = grep -f $_, map "$_/$ext", @dirs; 996 my @files = grep -f $_, map "$_/$ext", @dirs;
847 997
848 if (@files) { 998 if (@files) {
849 $TERM->register_package (extension_package $files[0], $argv); 999 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
850 } else { 1000 } else {
851 warn "perl extension '$ext' not found in perl library search path\n"; 1001 warn "perl extension '$ext' not found in perl library search path\n";
852 } 1002 }
853 } 1003 }
854 1004
860 1010
861 if (my $cb = $TERM->{_hook}[$htype]) { 1011 if (my $cb = $TERM->{_hook}[$htype]) {
862 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1012 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
863 if $verbosity >= 10; 1013 if $verbosity >= 10;
864 1014
865 keys %$cb; 1015 for my $pkg (keys %$cb) {
866
867 while (my ($pkg, $cb) = each %$cb) {
868 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1016 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
869 $retval ||= $retval_; 1017 $retval ||= $retval_;
870 1018
871 if ($@) { 1019 if ($@) {
872 $TERM->ungrab; # better to lose the grab than the session 1020 $TERM->ungrab; # better to lose the grab than the session
873 warn $@; 1021 warn $@;
885 # clear package 1033 # clear package
886 %$TERM = (); 1034 %$TERM = ();
887 } 1035 }
888 1036
889 $retval 1037 $retval
1038}
1039
1040sub SET_COLOR($$$) {
1041 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1042}
1043
1044sub rend2mask {
1045 no strict 'refs';
1046 my ($str, $mask) = (@_, 0);
1047 my %color = ( fg => undef, bg => undef );
1048 my @failed;
1049 for my $spec ( split /\s+/, $str ) {
1050 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1051 $color{lc($1)} = $2;
1052 } else {
1053 my $neg = $spec =~ s/^[-^]//;
1054 unless ( exists &{"RS_$spec"} ) {
1055 push @failed, $spec;
1056 next;
1057 }
1058 my $cur = &{"RS_$spec"};
1059 if ( $neg ) {
1060 $mask &= ~$cur;
1061 } else {
1062 $mask |= $cur;
1063 }
1064 }
1065 }
1066 ($mask, @color{qw(fg bg)}, \@failed)
890} 1067}
891 1068
892# urxvt::term::extension 1069# urxvt::term::extension
893 1070
894package urxvt::term::extension; 1071package urxvt::term::extension;
965is that you cannot use blocking APIs, but the non-blocking variant should 1142is that you cannot use blocking APIs, but the non-blocking variant should
966work. 1143work.
967 1144
968=cut 1145=cut
969 1146
970our $VERSION = 1; 1147our $VERSION = '5.23';
971 1148
972$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
973push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
974 1151
975sub timer { 1152sub timer {
977 1154
978 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
979 1156
980 urxvt::timer 1157 urxvt::timer
981 ->new 1158 ->new
982 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
983 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
984 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
985 $cb->(); 1162 $cb->();
986 }) 1163 })
987} 1164}
988 1165
989sub io { 1166sub io {
990 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
991 1168
992 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
993 1172
994 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
995 ->new 1174 ->new
996 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
997 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
998 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
999 ->start 1178 ->start
1000 ->cb (sub { 1179 ->cb ($cb)
1001 $cb->(($_[1] & 1 ? 'r' : '')
1002 . ($_[1] & 2 ? 'w' : ''));
1003 })],
1004 urxvt::anyevent:: 1180 ], urxvt::anyevent::
1181}
1182
1183sub idle {
1184 my ($class, %arg) = @_;
1185
1186 my $cb = $arg{cb};
1187
1188 urxvt::iw
1189 ->new
1190 ->start
1191 ->cb ($cb)
1192}
1193
1194sub child {
1195 my ($class, %arg) = @_;
1196
1197 my $cb = $arg{cb};
1198
1199 urxvt::pw
1200 ->new
1201 ->start ($arg{pid})
1202 ->cb (sub {
1203 $_[0]->stop; # need to cancel manually
1204 $cb->($_[0]->rpid, $_[0]->rstatus);
1205 })
1005} 1206}
1006 1207
1007sub DESTROY { 1208sub DESTROY {
1008 $_[0][1]->stop; 1209 $_[0][1]->stop;
1009} 1210}
1010 1211
1011sub condvar { 1212sub one_event {
1012 bless \my $flag, urxvt::anyevent::condvar::
1013}
1014
1015sub urxvt::anyevent::condvar::broadcast {
1016 ${$_[0]}++;
1017}
1018
1019sub urxvt::anyevent::condvar::wait {
1020 unless (${$_[0]}) {
1021 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1022 }
1023} 1214}
1024 1215
1025package urxvt::term; 1216package urxvt::term;
1026 1217
1027=head2 The C<urxvt::term> Class 1218=head2 The C<urxvt::term> Class
1114 1305
1115Returns true if the option specified by C<$optval> is enabled, and 1306Returns true if the option specified by C<$optval> is enabled, and
1116optionally change it. All option values are stored by name in the hash 1307optionally change it. All option values are stored by name in the hash
1117C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1308C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1118 1309
1119Here is a a likely non-exhaustive list of option names, please see the 1310Here is a likely non-exhaustive list of option names, please see the
1120source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1121 1312
1122 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess buffered console cursorBlink cursorUnderline hold iconic
1123 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1124 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1125 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1126 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1127 transparent tripleclickwords utmpInhibit visualBell 1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell
1128 1320
1129=item $value = $term->resource ($name[, $newval]) 1321=item $value = $term->resource ($name[, $newval])
1130 1322
1131Returns the current resource value associated with a given name and 1323Returns the current resource value associated with a given name and
1132optionally sets a new value. Setting values is most useful in the C<init> 1324optionally sets a new value. Setting values is most useful in the C<init>
1141likely change). 1333likely change).
1142 1334
1143Please note that resource strings will currently only be freed when the 1335Please note that resource strings will currently only be freed when the
1144terminal is destroyed, so changing options frequently will eat memory. 1336terminal is destroyed, so changing options frequently will eat memory.
1145 1337
1146Here is a a likely non-exhaustive list of resource names, not all of which 1338Here is a likely non-exhaustive list of resource names, not all of which
1147are supported in every build, please see the source file F</src/rsinc.h> 1339are supported in every build, please see the source file F</src/rsinc.h>
1148to see the actual list: 1340to see the actual list:
1149 1341
1150 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1342 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1151 borderLess color cursorBlink cursorUnderline cutchars delete_key 1343 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1152 display_name embed ext_bwidth fade font geometry hold iconName 1344 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1153 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1345 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1346 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1154 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1347 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1155 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1348 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1156 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1349 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1157 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1350 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1158 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1351 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1159 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1352 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1160 secondaryScreen secondaryScroll selectstyle shade term_name title 1353 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1161 transient_for transparent transparent_all tripleclickwords utmpInhibit 1354 term_name title transient_for transparent tripleclickwords urgentOnBell
1162 visualBell 1355 utmpInhibit visualBell
1163 1356
1164=cut 1357=cut
1165 1358
1166sub resource($$;$) { 1359sub resource($$;$) {
1167 my ($self, $name) = (shift, shift); 1360 my ($self, $name) = (shift, shift);
1168 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1361 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1169 &urxvt::term::_resource 1362 goto &urxvt::term::_resource
1170} 1363}
1171 1364
1172=item $value = $term->x_resource ($pattern) 1365=item $value = $term->x_resource ($pattern)
1173 1366
1174Returns the X-Resource for the given pattern, excluding the program or 1367Returns the X-Resource for the given pattern, excluding the program or
1199 1392
1200=item ($row, $col) = $term->selection_beg ([$row, $col]) 1393=item ($row, $col) = $term->selection_beg ([$row, $col])
1201 1394
1202=item ($row, $col) = $term->selection_end ([$row, $col]) 1395=item ($row, $col) = $term->selection_end ([$row, $col])
1203 1396
1204Return the current values of the selection mark, begin or end positions, 1397Return the current values of the selection mark, begin or end positions.
1205and optionally set them to new values. 1398
1399When arguments are given, then the selection coordinates are set to
1400C<$row> and C<$col>, and the selection screen is set to the current
1401screen.
1402
1403=item $screen = $term->selection_screen ([$screen])
1404
1405Returns the current selection screen, and then optionally sets it.
1206 1406
1207=item $term->selection_make ($eventtime[, $rectangular]) 1407=item $term->selection_make ($eventtime[, $rectangular])
1208 1408
1209Tries to make a selection as set by C<selection_beg> and 1409Tries to make a selection as set by C<selection_beg> and
1210C<selection_end>. If C<$rectangular> is true (default: false), a 1410C<selection_end>. If C<$rectangular> is true (default: false), a
1211rectangular selection will be made. This is the prefered function to make 1411rectangular selection will be made. This is the preferred function to make
1212a selection. 1412a selection.
1213 1413
1214=item $success = $term->selection_grab ($eventtime) 1414=item $success = $term->selection_grab ($eventtime[, $clipboard])
1215 1415
1216Try to request the primary selection text from the server (for example, as 1416Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1417true) selection from the server. The corresponding text can be set
1217set by the next method). No visual feedback will be given. This function 1418with the next method. No visual feedback will be given. This function
1218is mostly useful from within C<on_sel_grab> hooks. 1419is mostly useful from within C<on_sel_grab> hooks.
1219 1420
1220=item $oldtext = $term->selection ([$newtext]) 1421=item $oldtext = $term->selection ([$newtext, $clipboard])
1221 1422
1222Return the current selection text and optionally replace it by C<$newtext>. 1423Return the current selection (clipboard if C<$clipboard> is true) text
1424and optionally replace it by C<$newtext>.
1425
1426=item $term->selection_clear ([$clipboard])
1427
1428Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1223 1429
1224=item $term->overlay_simple ($x, $y, $text) 1430=item $term->overlay_simple ($x, $y, $text)
1225 1431
1226Create a simple multi-line overlay box. See the next method for details. 1432Create a simple multi-line overlay box. See the next method for details.
1227 1433
1257 1463
1258The methods currently supported on C<urxvt::overlay> objects are: 1464The methods currently supported on C<urxvt::overlay> objects are:
1259 1465
1260=over 4 1466=over 4
1261 1467
1262=item $overlay->set ($x, $y, $text, $rend) 1468=item $overlay->set ($x, $y, $text[, $rend])
1263 1469
1264Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1470Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1265text in rxvt-unicode's special encoding and an array of rendition values 1471text in rxvt-unicode's special encoding and an array of rendition values
1266at a specific position inside the overlay. 1472at a specific position inside the overlay.
1473
1474If C<$rend> is missing, then the rendition will not be changed.
1267 1475
1268=item $overlay->hide 1476=item $overlay->hide
1269 1477
1270If visible, hide the overlay, but do not destroy it. 1478If visible, hide the overlay, but do not destroy it.
1271 1479
1353locale-specific encoding of the terminal and can contain command sequences 1561locale-specific encoding of the terminal and can contain command sequences
1354(escape codes) that will be interpreted. 1562(escape codes) that will be interpreted.
1355 1563
1356=item $term->tt_write ($octets) 1564=item $term->tt_write ($octets)
1357 1565
1358Write the octets given in C<$data> to the tty (i.e. as program input). To 1566Write the octets given in C<$octets> to the tty (i.e. as program input). To
1359pass characters instead of octets, you should convert your strings first 1567pass characters instead of octets, you should convert your strings first
1360to the locale-specific encoding using C<< $term->locale_encode >>. 1568to the locale-specific encoding using C<< $term->locale_encode >>.
1569
1570=item $term->tt_paste ($octets)
1571
1572Write the octets given in C<$octets> to the tty as a paste, converting NL to
1573CR and bracketing the data with control sequences if bracketed paste mode
1574is set.
1361 1575
1362=item $old_events = $term->pty_ev_events ([$new_events]) 1576=item $old_events = $term->pty_ev_events ([$new_events])
1363 1577
1364Replaces the event mask of the pty watcher by the given event mask. Can 1578Replaces the event mask of the pty watcher by the given event mask. Can
1365be used to suppress input and output handling to the pty/tty. See the 1579be used to suppress input and output handling to the pty/tty. See the
1384Adds the specified events to the vt event mask. Useful e.g. when you want 1598Adds the specified events to the vt event mask. Useful e.g. when you want
1385to receive pointer events all the times: 1599to receive pointer events all the times:
1386 1600
1387 $term->vt_emask_add (urxvt::PointerMotionMask); 1601 $term->vt_emask_add (urxvt::PointerMotionMask);
1388 1602
1603=item $term->focus_in
1604
1605=item $term->focus_out
1606
1607=item $term->key_press ($state, $keycode[, $time])
1608
1609=item $term->key_release ($state, $keycode[, $time])
1610
1611Deliver various fake events to to terminal.
1612
1389=item $window_width = $term->width 1613=item $window_width = $term->width
1390 1614
1391=item $window_height = $term->height 1615=item $window_height = $term->height
1392 1616
1393=item $font_width = $term->fwidth 1617=item $font_width = $term->fwidth
1423=item $env = $term->env 1647=item $env = $term->env
1424 1648
1425Returns a copy of the environment in effect for the terminal as a hashref 1649Returns a copy of the environment in effect for the terminal as a hashref
1426similar to C<\%ENV>. 1650similar to C<\%ENV>.
1427 1651
1652=item @envv = $term->envv
1653
1654Returns the environment as array of strings of the form C<VAR=VALUE>.
1655
1656=item @argv = $term->argv
1657
1658Return the argument vector as this terminal, similar to @ARGV, but
1659includes the program name as first element.
1660
1428=cut 1661=cut
1429 1662
1430sub env { 1663sub env {
1431 if (my $env = $_[0]->_env) {
1432 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1664 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1433 } else {
1434 +{ %ENV }
1435 }
1436} 1665}
1437 1666
1438=item $modifiermask = $term->ModLevel3Mask 1667=item $modifiermask = $term->ModLevel3Mask
1439 1668
1440=item $modifiermask = $term->ModMetaMask 1669=item $modifiermask = $term->ModMetaMask
1448 1677
1449Returns the currently displayed screen (0 primary, 1 secondary). 1678Returns the currently displayed screen (0 primary, 1 secondary).
1450 1679
1451=item $cursor_is_hidden = $term->hidden_cursor 1680=item $cursor_is_hidden = $term->hidden_cursor
1452 1681
1453Returns wether the cursor is currently hidden or not. 1682Returns whether the cursor is currently hidden or not.
1454 1683
1455=item $view_start = $term->view_start ([$newvalue]) 1684=item $view_start = $term->view_start ([$newvalue])
1456 1685
1457Returns the row number of the topmost displayed line. Maximum value is 1686Returns the row number of the topmost displayed line. Maximum value is
1458C<0>, which displays the normal terminal contents. Lower values scroll 1687C<0>, which displays the normal terminal contents. Lower values scroll
1466 1695
1467Used after changing terminal contents to display them. 1696Used after changing terminal contents to display them.
1468 1697
1469=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1698=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1470 1699
1471Returns the text of the entire row with number C<$row_number>. Row C<0> 1700Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1472is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1701is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1473terminal line. The scrollback buffer starts at line C<-1> and extends to
1474line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1702terminal line. Nothing will be returned if a nonexistent line
1475is requested. 1703is requested.
1476 1704
1477If C<$new_text> is specified, it will replace characters in the current 1705If C<$new_text> is specified, it will replace characters in the current
1478line, starting at column C<$start_col> (default C<0>), which is useful 1706line, starting at column C<$start_col> (default C<0>), which is useful
1479to replace only parts of a line. The font index in the rendition will 1707to replace only parts of a line. The font index in the rendition will
1480automatically be updated. 1708automatically be updated.
1481 1709
1482C<$text> is in a special encoding: tabs and wide characters that use more 1710C<$text> is in a special encoding: tabs and wide characters that use more
1483than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1711than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1484characters. Characters with combining characters and other characters that 1712characters. Characters with combining characters and other characters that
1485do not fit into the normal tetx encoding will be replaced with characters 1713do not fit into the normal text encoding will be replaced with characters
1486in the private use area. 1714in the private use area.
1487 1715
1488You have to obey this encoding when changing text. The advantage is 1716You have to obey this encoding when changing text. The advantage is
1489that C<substr> and similar functions work on screen cells and not on 1717that C<substr> and similar functions work on screen cells and not on
1490characters. 1718characters.
1635where one character corresponds to one screen cell. See 1863where one character corresponds to one screen cell. See
1636C<< $term->ROW_t >> for details. 1864C<< $term->ROW_t >> for details.
1637 1865
1638=item $string = $term->special_decode $text 1866=item $string = $term->special_decode $text
1639 1867
1640Converts rxvt-unicodes text reprsentation into a perl string. See 1868Converts rxvt-unicodes text representation into a perl string. See
1641C<< $term->ROW_t >> for details. 1869C<< $term->ROW_t >> for details.
1642 1870
1643=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1871=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1644 1872
1645=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1873=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1648manpage. 1876manpage.
1649 1877
1650=item $success = $term->grab ($eventtime[, $sync]) 1878=item $success = $term->grab ($eventtime[, $sync])
1651 1879
1652Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1880Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1653synchronous (C<$sync> is true). Also remembers the grab timestampe. 1881synchronous (C<$sync> is true). Also remembers the grab timestamp.
1654 1882
1655=item $term->allow_events_async 1883=item $term->allow_events_async
1656 1884
1657Calls XAllowEvents with AsyncBoth for the most recent grab. 1885Calls XAllowEvents with AsyncBoth for the most recent grab.
1658 1886
1665Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1893Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1666recent grab. 1894recent grab.
1667 1895
1668=item $term->ungrab 1896=item $term->ungrab
1669 1897
1670Calls XUngrab for the most recent grab. Is called automatically on 1898Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1671evaluation 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
1672the session. 1900the session.
1673 1901
1674=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1902=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1675 1903
1677 1905
1678=item @atoms = $term->XListProperties ($window) 1906=item @atoms = $term->XListProperties ($window)
1679 1907
1680=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1908=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1681 1909
1682=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1910=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1683 1911
1684=item $term->XDeleteProperty ($window, $property) 1912=item $term->XDeleteProperty ($window, $property)
1685 1913
1686=item $window = $term->DefaultRootWindow 1914=item $window = $term->DefaultRootWindow
1687 1915
1697 1925
1698=item $term->XChangeInput ($window, $add_events[, $del_events]) 1926=item $term->XChangeInput ($window, $add_events[, $del_events])
1699 1927
1700Various X or X-related functions. The C<$term> object only serves as 1928Various X or X-related functions. The C<$term> object only serves as
1701the source of the display, otherwise those functions map more-or-less 1929the source of the display, otherwise those functions map more-or-less
1702directory onto the X functions of the same name. 1930directly onto the X functions of the same name.
1703 1931
1704=back 1932=back
1705 1933
1706=cut 1934=cut
1707 1935
1771 my ($self, $text, $cb) = @_; 1999 my ($self, $text, $cb) = @_;
1772 2000
1773 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2001 $self->add_item ({ type => "button", text => $text, activate => $cb});
1774} 2002}
1775 2003
1776=item $popup->add_toggle ($text, $cb, $initial_value) 2004=item $popup->add_toggle ($text, $initial_value, $cb)
1777 2005
1778Adds a toggle/checkbox item to the popup. Teh callback gets called 2006Adds a toggle/checkbox item to the popup. The callback gets called
1779whenever it gets toggled, with a boolean indicating its value as its first 2007whenever it gets toggled, with a boolean indicating its new value as its
1780argument. 2008first argument.
1781 2009
1782=cut 2010=cut
1783 2011
1784sub add_toggle { 2012sub add_toggle {
1785 my ($self, $text, $cb, $value) = @_; 2013 my ($self, $text, $value, $cb) = @_;
1786 2014
1787 my $item; $item = { 2015 my $item; $item = {
1788 type => "button", 2016 type => "button",
1789 text => " $text", 2017 text => " $text",
1790 value => $value, 2018 value => $value,
1809 my $env = $self->{term}->env; 2037 my $env = $self->{term}->env;
1810 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2038 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1811 delete $env->{LC_ALL}; 2039 delete $env->{LC_ALL};
1812 $env->{LC_CTYPE} = $self->{term}->locale; 2040 $env->{LC_CTYPE} = $self->{term}->locale;
1813 2041
1814 urxvt::term->new ($env, "popup", 2042 my $term = urxvt::term->new (
2043 $env, "popup",
1815 "--perl-lib" => "", "--perl-ext-common" => "", 2044 "--perl-lib" => "", "--perl-ext-common" => "",
1816 "-pty-fd" => -1, "-sl" => 0, 2045 "-pty-fd" => -1, "-sl" => 0,
1817 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2046 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1818 "--transient-for" => $self->{term}->parent, 2047 "--transient-for" => $self->{term}->parent,
1819 "-display" => $self->{term}->display_id, 2048 "-display" => $self->{term}->display_id,
1820 "-pe" => "urxvt-popup") 2049 "-pe" => "urxvt-popup",
1821 or die "unable to create popup window\n"; 2050 ) or die "unable to create popup window\n";
2051
2052 unless (delete $term->{urxvt_popup_init_done}) {
2053 $term->ungrab;
2054 $term->destroy;
2055 die "unable to initialise popup window\n";
2056 }
1822} 2057}
1823 2058
1824sub DESTROY { 2059sub DESTROY {
1825 my ($self) = @_; 2060 my ($self) = @_;
1826 2061
1831=back 2066=back
1832 2067
1833=cut 2068=cut
1834 2069
1835package urxvt::watcher; 2070package urxvt::watcher;
1836
1837@urxvt::timer::ISA = __PACKAGE__;
1838@urxvt::iow::ISA = __PACKAGE__;
1839@urxvt::pw::ISA = __PACKAGE__;
1840@urxvt::iw::ISA = __PACKAGE__;
1841 2071
1842=head2 The C<urxvt::timer> Class 2072=head2 The C<urxvt::timer> Class
1843 2073
1844This class implements timer watchers/events. Time is represented as a 2074This class implements timer watchers/events. Time is represented as a
1845fractional number of seconds since the epoch. Example: 2075fractional number of seconds since the epoch. Example:
1849 ->new 2079 ->new
1850 ->interval (1) 2080 ->interval (1)
1851 ->cb (sub { 2081 ->cb (sub {
1852 $term->{overlay}->set (0, 0, 2082 $term->{overlay}->set (0, 0,
1853 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2083 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1854 }); 2084 });
1855 2085
1856=over 4 2086=over 4
1857 2087
1858=item $timer = new urxvt::timer 2088=item $timer = new urxvt::timer
1859 2089
1862 2092
1863=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2093=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1864 2094
1865Set the callback to be called when the timer triggers. 2095Set the callback to be called when the timer triggers.
1866 2096
1867=item $tstamp = $timer->at
1868
1869Return the time this watcher will fire next.
1870
1871=item $timer = $timer->set ($tstamp) 2097=item $timer = $timer->set ($tstamp[, $interval])
1872 2098
1873Set the time the event is generated to $tstamp. 2099Set the time the event is generated to $tstamp (and optionally specifies a
2100new $interval).
1874 2101
1875=item $timer = $timer->interval ($interval) 2102=item $timer = $timer->interval ($interval)
1876 2103
1877Normally (and when C<$interval> is C<0>), the timer will automatically 2104By default (and when C<$interval> is C<0>), the timer will automatically
1878stop after it has fired once. If C<$interval> is non-zero, then the timer 2105stop after it has fired once. If C<$interval> is non-zero, then the timer
1879is automatically rescheduled at the given intervals. 2106is automatically rescheduled at the given intervals.
1880 2107
1881=item $timer = $timer->start 2108=item $timer = $timer->start
1882 2109
1883Start the timer. 2110Start the timer.
1884 2111
1885=item $timer = $timer->start ($tstamp) 2112=item $timer = $timer->start ($tstamp[, $interval])
1886 2113
1887Set the event trigger time to C<$tstamp> and start the timer. 2114Set the event trigger time to C<$tstamp> and start the timer. Optionally
2115also replaces the interval.
1888 2116
1889=item $timer = $timer->after ($delay) 2117=item $timer = $timer->after ($delay[, $interval])
1890 2118
1891Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2119Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1892 2120
1893=item $timer = $timer->stop 2121=item $timer = $timer->stop
1894 2122
1902 2130
1903 $term->{socket} = ... 2131 $term->{socket} = ...
1904 $term->{iow} = urxvt::iow 2132 $term->{iow} = urxvt::iow
1905 ->new 2133 ->new
1906 ->fd (fileno $term->{socket}) 2134 ->fd (fileno $term->{socket})
1907 ->events (urxvt::EVENT_READ) 2135 ->events (urxvt::EV_READ)
1908 ->start 2136 ->start
1909 ->cb (sub { 2137 ->cb (sub {
1910 my ($iow, $revents) = @_; 2138 my ($iow, $revents) = @_;
1911 # $revents must be 1 here, no need to check 2139 # $revents must be 1 here, no need to check
1912 sysread $term->{socket}, my $buf, 8192 2140 sysread $term->{socket}, my $buf, 8192
1925Set the callback to be called when io events are triggered. C<$reventmask> 2153Set the callback to be called when io events are triggered. C<$reventmask>
1926is a bitset as described in the C<events> method. 2154is a bitset as described in the C<events> method.
1927 2155
1928=item $iow = $iow->fd ($fd) 2156=item $iow = $iow->fd ($fd)
1929 2157
1930Set the filedescriptor (not handle) to watch. 2158Set the file descriptor (not handle) to watch.
1931 2159
1932=item $iow = $iow->events ($eventmask) 2160=item $iow = $iow->events ($eventmask)
1933 2161
1934Set the event mask to watch. The only allowed values are 2162Set the event mask to watch. The only allowed values are
1935C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2163C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1936together, or C<urxvt::EVENT_NONE>. 2164together, or C<urxvt::EV_NONE>.
1937 2165
1938=item $iow = $iow->start 2166=item $iow = $iow->start
1939 2167
1940Start watching for requested events on the given handle. 2168Start watching for requested events on the given handle.
1941 2169
1942=item $iow = $iow->stop 2170=item $iow = $iow->stop
1943 2171
1944Stop watching for events on the given filehandle. 2172Stop watching for events on the given file handle.
1945 2173
1946=back 2174=back
1947 2175
1948=head2 The C<urxvt::iw> Class 2176=head2 The C<urxvt::iw> Class
1949 2177
1982 ->new 2210 ->new
1983 ->start ($pid) 2211 ->start ($pid)
1984 ->cb (sub { 2212 ->cb (sub {
1985 my ($pw, $exit_status) = @_; 2213 my ($pw, $exit_status) = @_;
1986 ... 2214 ...
1987 }); 2215 });
1988 2216
1989=over 4 2217=over 4
1990 2218
1991=item $pw = new urxvt::pw 2219=item $pw = new urxvt::pw
1992 2220
1996 2224
1997Set the callback to be called when the timer triggers. 2225Set the callback to be called when the timer triggers.
1998 2226
1999=item $pw = $timer->start ($pid) 2227=item $pw = $timer->start ($pid)
2000 2228
2001Tells the wqtcher to start watching for process C<$pid>. 2229Tells the watcher to start watching for process C<$pid>.
2002 2230
2003=item $pw = $pw->stop 2231=item $pw = $pw->stop
2004 2232
2005Stop the watcher. 2233Stop the watcher.
2006 2234
2019 2247
2020=item >= 3 - script loading and management 2248=item >= 3 - script loading and management
2021 2249
2022=item >=10 - all called hooks 2250=item >=10 - all called hooks
2023 2251
2024=item >=11 - hook reutrn values 2252=item >=11 - hook return values
2025 2253
2026=back 2254=back
2027 2255
2028=head1 AUTHOR 2256=head1 AUTHOR
2029 2257
2030 Marc Lehmann <pcg@goof.com> 2258 Marc Lehmann <schmorp@schmorp.de>
2031 http://software.schmorp.de/pkg/rxvt-unicode 2259 http://software.schmorp.de/pkg/rxvt-unicode
2032 2260
2033=cut 2261=cut
2034 2262
20351 22631
2264
2265# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines