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.130 by root, Wed Jan 25 15:32:48 2006 UTC vs.
Revision 1.194 by sf-exg, Wed Jun 29 21:59:36 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.
669 816
670Messages have a size limit of 1023 bytes currently. 817Messages have a size limit of 1023 bytes currently.
818
819=item @terms = urxvt::termlist
820
821Returns all urxvt::term objects that exist in this process, regardless of
822whether they are started, being destroyed etc., so be careful. Only term
823objects that have perl extensions attached will be returned (because there
824is no urxvt::term object associated with others).
671 825
672=item $time = urxvt::NOW 826=item $time = urxvt::NOW
673 827
674Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
675 829
718 872
719=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
720 874
721Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
722 876
723=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
724 879
725Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
726underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
727the bitset. 882the bitset.
728 883
733Return the foreground/background colour index, respectively. 888Return the foreground/background colour index, respectively.
734 889
735=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 890=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
736 891
737=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
738 895
739Replace the foreground/background colour in the rendition mask with the 896Replace the foreground/background colour in the rendition mask with the
740specified one. 897specified one.
741 898
742=item $value = urxvt::GET_CUSTOM $rend 899=item $value = urxvt::GET_CUSTOM $rend
809 local $TERM = shift; 966 local $TERM = shift;
810 my $htype = shift; 967 my $htype = shift;
811 968
812 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
813 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
814 971
815 my %ext_arg; 972 my %ext_arg;
816 973
817 { 974 {
818 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
819 @TERM_INIT = (); 976 @TERM_INIT = ();
833 } else { 990 } else {
834 $ext_arg{$_} ||= []; 991 $ext_arg{$_} ||= [];
835 } 992 }
836 } 993 }
837 994
838 while (my ($ext, $argv) = each %ext_arg) { 995 for my $ext (sort keys %ext_arg) {
839 my @files = grep -f $_, map "$_/$ext", @dirs; 996 my @files = grep -f $_, map "$_/$ext", @dirs;
840 997
841 if (@files) { 998 if (@files) {
842 $TERM->register_package (extension_package $files[0], $argv); 999 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
843 } else { 1000 } else {
844 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";
845 } 1002 }
846 } 1003 }
847 1004
853 1010
854 if (my $cb = $TERM->{_hook}[$htype]) { 1011 if (my $cb = $TERM->{_hook}[$htype]) {
855 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1012 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
856 if $verbosity >= 10; 1013 if $verbosity >= 10;
857 1014
858 keys %$cb; 1015 for my $pkg (keys %$cb) {
859
860 while (my ($pkg, $cb) = each %$cb) {
861 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1016 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
862 $retval ||= $retval_; 1017 $retval ||= $retval_;
863 1018
864 if ($@) { 1019 if ($@) {
865 $TERM->ungrab; # better to lose the grab than the session 1020 $TERM->ungrab; # better to lose the grab than the session
866 warn $@; 1021 warn $@;
878 # clear package 1033 # clear package
879 %$TERM = (); 1034 %$TERM = ();
880 } 1035 }
881 1036
882 $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)
883} 1067}
884 1068
885# urxvt::term::extension 1069# urxvt::term::extension
886 1070
887package urxvt::term::extension; 1071package urxvt::term::extension;
958is 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
959work. 1143work.
960 1144
961=cut 1145=cut
962 1146
963our $VERSION = 1; 1147our $VERSION = '5.23';
964 1148
965$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
966push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
967 1151
968sub timer { 1152sub timer {
970 1154
971 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
972 1156
973 urxvt::timer 1157 urxvt::timer
974 ->new 1158 ->new
975 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
976 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
977 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
978 $cb->(); 1162 $cb->();
979 }) 1163 })
980} 1164}
981 1165
982sub io { 1166sub io {
983 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
984 1168
985 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
986 1172
987 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
988 ->new 1174 ->new
989 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
990 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
991 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
992 ->start 1178 ->start
993 ->cb (sub { 1179 ->cb ($cb)
994 $cb->(($_[1] & 1 ? 'r' : '')
995 . ($_[1] & 2 ? 'w' : ''));
996 })],
997 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 })
998} 1206}
999 1207
1000sub DESTROY { 1208sub DESTROY {
1001 $_[0][1]->stop; 1209 $_[0][1]->stop;
1002} 1210}
1003 1211
1004sub condvar { 1212sub one_event {
1005 bless \my $flag, urxvt::anyevent::condvar::
1006}
1007
1008sub urxvt::anyevent::condvar::broadcast {
1009 ${$_[0]}++;
1010}
1011
1012sub urxvt::anyevent::condvar::wait {
1013 unless (${$_[0]}) {
1014 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";
1015 }
1016} 1214}
1017 1215
1018package urxvt::term; 1216package urxvt::term;
1019 1217
1020=head2 The C<urxvt::term> Class 1218=head2 The C<urxvt::term> Class
1056hash which defines the environment of the new terminal. 1254hash which defines the environment of the new terminal.
1057 1255
1058Croaks (and probably outputs an error message) if the new instance 1256Croaks (and probably outputs an error message) if the new instance
1059couldn't be created. Returns C<undef> if the new instance didn't 1257couldn't be created. Returns C<undef> if the new instance didn't
1060initialise perl, and the terminal object otherwise. The C<init> and 1258initialise perl, and the terminal object otherwise. The C<init> and
1061C<start> hooks will be called during this call. 1259C<start> hooks will be called before this call returns, and are free to
1260refer to global data (which is race free).
1062 1261
1063=cut 1262=cut
1064 1263
1065sub new { 1264sub new {
1066 my ($class, $env, @args) = @_; 1265 my ($class, $env, @args) = @_;
1067 1266
1267 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1268 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1269
1068 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1270 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1069} 1271}
1070 1272
1071=item $term->destroy 1273=item $term->destroy
1072 1274
1073Destroy the terminal object (close the window, free resources 1275Destroy the terminal object (close the window, free resources
1103 1305
1104Returns true if the option specified by C<$optval> is enabled, and 1306Returns true if the option specified by C<$optval> is enabled, and
1105optionally 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
1106C<%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.
1107 1309
1108Here 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
1109source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1110 1312
1111 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess console cursorBlink cursorUnderline hold iconic insecure
1112 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1113 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1130likely change). 1332likely change).
1131 1333
1132Please note that resource strings will currently only be freed when the 1334Please note that resource strings will currently only be freed when the
1133terminal is destroyed, so changing options frequently will eat memory. 1335terminal is destroyed, so changing options frequently will eat memory.
1134 1336
1135Here is a a likely non-exhaustive list of resource names, not all of which 1337Here is a likely non-exhaustive list of resource names, not all of which
1136are supported in every build, please see the source file F</src/rsinc.h> 1338are supported in every build, please see the source file F</src/rsinc.h>
1137to see the actual list: 1339to see the actual list:
1138 1340
1139 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1341 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1140 borderLess color cursorBlink cursorUnderline cutchars delete_key 1342 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1141 display_name embed ext_bwidth fade font geometry hold iconName 1343 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1142 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1344 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1345 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1143 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1346 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1144 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1347 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1145 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1348 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1146 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1349 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1147 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1350 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1148 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1351 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1149 secondaryScreen secondaryScroll selectstyle shade term_name title 1352 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1150 transient_for transparent transparent_all tripleclickwords utmpInhibit 1353 term_name title transient_for transparent tripleclickwords urgentOnBell
1151 visualBell 1354 utmpInhibit visualBell
1152 1355
1153=cut 1356=cut
1154 1357
1155sub resource($$;$) { 1358sub resource($$;$) {
1156 my ($self, $name) = (shift, shift); 1359 my ($self, $name) = (shift, shift);
1157 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1360 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1158 &urxvt::term::_resource 1361 goto &urxvt::term::_resource
1159} 1362}
1160 1363
1161=item $value = $term->x_resource ($pattern) 1364=item $value = $term->x_resource ($pattern)
1162 1365
1163Returns the X-Resource for the given pattern, excluding the program or 1366Returns the X-Resource for the given pattern, excluding the program or
1188 1391
1189=item ($row, $col) = $term->selection_beg ([$row, $col]) 1392=item ($row, $col) = $term->selection_beg ([$row, $col])
1190 1393
1191=item ($row, $col) = $term->selection_end ([$row, $col]) 1394=item ($row, $col) = $term->selection_end ([$row, $col])
1192 1395
1193Return the current values of the selection mark, begin or end positions, 1396Return the current values of the selection mark, begin or end positions.
1194and optionally set them to new values. 1397
1398When arguments are given, then the selection coordinates are set to
1399C<$row> and C<$col>, and the selection screen is set to the current
1400screen.
1401
1402=item $screen = $term->selection_screen ([$screen])
1403
1404Returns the current selection screen, and then optionally sets it.
1195 1405
1196=item $term->selection_make ($eventtime[, $rectangular]) 1406=item $term->selection_make ($eventtime[, $rectangular])
1197 1407
1198Tries to make a selection as set by C<selection_beg> and 1408Tries to make a selection as set by C<selection_beg> and
1199C<selection_end>. If C<$rectangular> is true (default: false), a 1409C<selection_end>. If C<$rectangular> is true (default: false), a
1200rectangular selection will be made. This is the prefered function to make 1410rectangular selection will be made. This is the preferred function to make
1201a selection. 1411a selection.
1202 1412
1203=item $success = $term->selection_grab ($eventtime) 1413=item $success = $term->selection_grab ($eventtime[, $clipboard])
1204 1414
1205Try to request the primary selection text from the server (for example, as 1415Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1416true) selection from the server. The corresponding text can be set
1206set by the next method). No visual feedback will be given. This function 1417with the next method. No visual feedback will be given. This function
1207is mostly useful from within C<on_sel_grab> hooks. 1418is mostly useful from within C<on_sel_grab> hooks.
1208 1419
1209=item $oldtext = $term->selection ([$newtext]) 1420=item $oldtext = $term->selection ([$newtext, $clipboard])
1210 1421
1211Return the current selection text and optionally replace it by C<$newtext>. 1422Return the current selection (clipboard if C<$clipboard> is true) text
1423and optionally replace it by C<$newtext>.
1424
1425=item $term->selection_clear ([$clipboard])
1426
1427Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1212 1428
1213=item $term->overlay_simple ($x, $y, $text) 1429=item $term->overlay_simple ($x, $y, $text)
1214 1430
1215Create a simple multi-line overlay box. See the next method for details. 1431Create a simple multi-line overlay box. See the next method for details.
1216 1432
1246 1462
1247The methods currently supported on C<urxvt::overlay> objects are: 1463The methods currently supported on C<urxvt::overlay> objects are:
1248 1464
1249=over 4 1465=over 4
1250 1466
1251=item $overlay->set ($x, $y, $text, $rend) 1467=item $overlay->set ($x, $y, $text[, $rend])
1252 1468
1253Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1469Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1254text in rxvt-unicode's special encoding and an array of rendition values 1470text in rxvt-unicode's special encoding and an array of rendition values
1255at a specific position inside the overlay. 1471at a specific position inside the overlay.
1472
1473If C<$rend> is missing, then the rendition will not be changed.
1256 1474
1257=item $overlay->hide 1475=item $overlay->hide
1258 1476
1259If visible, hide the overlay, but do not destroy it. 1477If visible, hide the overlay, but do not destroy it.
1260 1478
1342locale-specific encoding of the terminal and can contain command sequences 1560locale-specific encoding of the terminal and can contain command sequences
1343(escape codes) that will be interpreted. 1561(escape codes) that will be interpreted.
1344 1562
1345=item $term->tt_write ($octets) 1563=item $term->tt_write ($octets)
1346 1564
1347Write the octets given in C<$data> to the tty (i.e. as program input). To 1565Write the octets given in C<$octets> to the tty (i.e. as program input). To
1348pass characters instead of octets, you should convert your strings first 1566pass characters instead of octets, you should convert your strings first
1349to the locale-specific encoding using C<< $term->locale_encode >>. 1567to the locale-specific encoding using C<< $term->locale_encode >>.
1568
1569=item $term->tt_paste ($octets)
1570
1571Write the octets given in C<$octets> to the tty as a paste, converting NL to
1572CR and bracketing the data with control sequences if bracketed paste mode
1573is set.
1350 1574
1351=item $old_events = $term->pty_ev_events ([$new_events]) 1575=item $old_events = $term->pty_ev_events ([$new_events])
1352 1576
1353Replaces the event mask of the pty watcher by the given event mask. Can 1577Replaces the event mask of the pty watcher by the given event mask. Can
1354be used to suppress input and output handling to the pty/tty. See the 1578be used to suppress input and output handling to the pty/tty. See the
1373Adds the specified events to the vt event mask. Useful e.g. when you want 1597Adds the specified events to the vt event mask. Useful e.g. when you want
1374to receive pointer events all the times: 1598to receive pointer events all the times:
1375 1599
1376 $term->vt_emask_add (urxvt::PointerMotionMask); 1600 $term->vt_emask_add (urxvt::PointerMotionMask);
1377 1601
1602=item $term->focus_in
1603
1604=item $term->focus_out
1605
1606=item $term->key_press ($state, $keycode[, $time])
1607
1608=item $term->key_release ($state, $keycode[, $time])
1609
1610Deliver various fake events to to terminal.
1611
1378=item $window_width = $term->width 1612=item $window_width = $term->width
1379 1613
1380=item $window_height = $term->height 1614=item $window_height = $term->height
1381 1615
1382=item $font_width = $term->fwidth 1616=item $font_width = $term->fwidth
1412=item $env = $term->env 1646=item $env = $term->env
1413 1647
1414Returns a copy of the environment in effect for the terminal as a hashref 1648Returns a copy of the environment in effect for the terminal as a hashref
1415similar to C<\%ENV>. 1649similar to C<\%ENV>.
1416 1650
1651=item @envv = $term->envv
1652
1653Returns the environment as array of strings of the form C<VAR=VALUE>.
1654
1655=item @argv = $term->argv
1656
1657Return the argument vector as this terminal, similar to @ARGV, but
1658includes the program name as first element.
1659
1417=cut 1660=cut
1418 1661
1419sub env { 1662sub env {
1420 if (my $env = $_[0]->_env) {
1421 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1663 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1422 } else {
1423 +{ %ENV }
1424 }
1425} 1664}
1426 1665
1427=item $modifiermask = $term->ModLevel3Mask 1666=item $modifiermask = $term->ModLevel3Mask
1428 1667
1429=item $modifiermask = $term->ModMetaMask 1668=item $modifiermask = $term->ModMetaMask
1437 1676
1438Returns the currently displayed screen (0 primary, 1 secondary). 1677Returns the currently displayed screen (0 primary, 1 secondary).
1439 1678
1440=item $cursor_is_hidden = $term->hidden_cursor 1679=item $cursor_is_hidden = $term->hidden_cursor
1441 1680
1442Returns wether the cursor is currently hidden or not. 1681Returns whether the cursor is currently hidden or not.
1443 1682
1444=item $view_start = $term->view_start ([$newvalue]) 1683=item $view_start = $term->view_start ([$newvalue])
1445 1684
1446Returns the row number of the topmost displayed line. Maximum value is 1685Returns the row number of the topmost displayed line. Maximum value is
1447C<0>, which displays the normal terminal contents. Lower values scroll 1686C<0>, which displays the normal terminal contents. Lower values scroll
1455 1694
1456Used after changing terminal contents to display them. 1695Used after changing terminal contents to display them.
1457 1696
1458=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1697=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1459 1698
1460Returns the text of the entire row with number C<$row_number>. Row C<0> 1699Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1461is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1700is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1462terminal line. The scrollback buffer starts at line C<-1> and extends to
1463line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1701terminal line. Nothing will be returned if a nonexistent line
1464is requested. 1702is requested.
1465 1703
1466If C<$new_text> is specified, it will replace characters in the current 1704If C<$new_text> is specified, it will replace characters in the current
1467line, starting at column C<$start_col> (default C<0>), which is useful 1705line, starting at column C<$start_col> (default C<0>), which is useful
1468to replace only parts of a line. The font index in the rendition will 1706to replace only parts of a line. The font index in the rendition will
1469automatically be updated. 1707automatically be updated.
1470 1708
1471C<$text> is in a special encoding: tabs and wide characters that use more 1709C<$text> is in a special encoding: tabs and wide characters that use more
1472than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1710than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1473characters. Characters with combining characters and other characters that 1711characters. Characters with combining characters and other characters that
1474do not fit into the normal tetx encoding will be replaced with characters 1712do not fit into the normal text encoding will be replaced with characters
1475in the private use area. 1713in the private use area.
1476 1714
1477You have to obey this encoding when changing text. The advantage is 1715You have to obey this encoding when changing text. The advantage is
1478that C<substr> and similar functions work on screen cells and not on 1716that C<substr> and similar functions work on screen cells and not on
1479characters. 1717characters.
1624where one character corresponds to one screen cell. See 1862where one character corresponds to one screen cell. See
1625C<< $term->ROW_t >> for details. 1863C<< $term->ROW_t >> for details.
1626 1864
1627=item $string = $term->special_decode $text 1865=item $string = $term->special_decode $text
1628 1866
1629Converts rxvt-unicodes text reprsentation into a perl string. See 1867Converts rxvt-unicodes text representation into a perl string. See
1630C<< $term->ROW_t >> for details. 1868C<< $term->ROW_t >> for details.
1631 1869
1632=item $success = $term->grab_button ($button, $modifiermask) 1870=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1633 1871
1872=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1873
1634Registers a synchronous button grab. See the XGrabButton manpage. 1874Register/unregister a synchronous button grab. See the XGrabButton
1875manpage.
1635 1876
1636=item $success = $term->grab ($eventtime[, $sync]) 1877=item $success = $term->grab ($eventtime[, $sync])
1637 1878
1638Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1879Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1639synchronous (C<$sync> is true). Also remembers the grab timestampe. 1880synchronous (C<$sync> is true). Also remembers the grab timestamp.
1640 1881
1641=item $term->allow_events_async 1882=item $term->allow_events_async
1642 1883
1643Calls XAllowEvents with AsyncBoth for the most recent grab. 1884Calls XAllowEvents with AsyncBoth for the most recent grab.
1644 1885
1651Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1892Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1652recent grab. 1893recent grab.
1653 1894
1654=item $term->ungrab 1895=item $term->ungrab
1655 1896
1656Calls XUngrab for the most recent grab. Is called automatically on 1897Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1657evaluation errors, as it is better to lose the grab in the error case as 1898evaluation errors, as it is better to lose the grab in the error case as
1658the session. 1899the session.
1659 1900
1660=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1901=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1661 1902
1663 1904
1664=item @atoms = $term->XListProperties ($window) 1905=item @atoms = $term->XListProperties ($window)
1665 1906
1666=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1907=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1667 1908
1668=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1909=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1669 1910
1670=item $term->XDeleteProperty ($window, $property) 1911=item $term->XDeleteProperty ($window, $property)
1671 1912
1672=item $window = $term->DefaultRootWindow 1913=item $window = $term->DefaultRootWindow
1673 1914
1683 1924
1684=item $term->XChangeInput ($window, $add_events[, $del_events]) 1925=item $term->XChangeInput ($window, $add_events[, $del_events])
1685 1926
1686Various X or X-related functions. The C<$term> object only serves as 1927Various X or X-related functions. The C<$term> object only serves as
1687the source of the display, otherwise those functions map more-or-less 1928the source of the display, otherwise those functions map more-or-less
1688directory onto the X functions of the same name. 1929directly onto the X functions of the same name.
1689 1930
1690=back 1931=back
1691 1932
1692=cut 1933=cut
1693 1934
1757 my ($self, $text, $cb) = @_; 1998 my ($self, $text, $cb) = @_;
1758 1999
1759 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2000 $self->add_item ({ type => "button", text => $text, activate => $cb});
1760} 2001}
1761 2002
1762=item $popup->add_toggle ($text, $cb, $initial_value) 2003=item $popup->add_toggle ($text, $initial_value, $cb)
1763 2004
1764Adds a toggle/checkbox item to the popup. Teh callback gets called 2005Adds a toggle/checkbox item to the popup. The callback gets called
1765whenever it gets toggled, with a boolean indicating its value as its first 2006whenever it gets toggled, with a boolean indicating its new value as its
1766argument. 2007first argument.
1767 2008
1768=cut 2009=cut
1769 2010
1770sub add_toggle { 2011sub add_toggle {
1771 my ($self, $text, $cb, $value) = @_; 2012 my ($self, $text, $value, $cb) = @_;
1772 2013
1773 my $item; $item = { 2014 my $item; $item = {
1774 type => "button", 2015 type => "button",
1775 text => " $text", 2016 text => " $text",
1776 value => $value, 2017 value => $value,
1795 my $env = $self->{term}->env; 2036 my $env = $self->{term}->env;
1796 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2037 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1797 delete $env->{LC_ALL}; 2038 delete $env->{LC_ALL};
1798 $env->{LC_CTYPE} = $self->{term}->locale; 2039 $env->{LC_CTYPE} = $self->{term}->locale;
1799 2040
1800 urxvt::term->new ($env, "popup", 2041 my $term = urxvt::term->new (
2042 $env, "popup",
1801 "--perl-lib" => "", "--perl-ext-common" => "", 2043 "--perl-lib" => "", "--perl-ext-common" => "",
1802 "-pty-fd" => -1, "-sl" => 0, 2044 "-pty-fd" => -1, "-sl" => 0,
1803 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2045 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1804 "--transient-for" => $self->{term}->parent, 2046 "--transient-for" => $self->{term}->parent,
1805 "-display" => $self->{term}->display_id, 2047 "-display" => $self->{term}->display_id,
1806 "-pe" => "urxvt-popup") 2048 "-pe" => "urxvt-popup",
1807 or die "unable to create popup window\n"; 2049 ) or die "unable to create popup window\n";
2050
2051 unless (delete $term->{urxvt_popup_init_done}) {
2052 $term->ungrab;
2053 $term->destroy;
2054 die "unable to initialise popup window\n";
2055 }
1808} 2056}
1809 2057
1810sub DESTROY { 2058sub DESTROY {
1811 my ($self) = @_; 2059 my ($self) = @_;
1812 2060
1817=back 2065=back
1818 2066
1819=cut 2067=cut
1820 2068
1821package urxvt::watcher; 2069package urxvt::watcher;
1822
1823@urxvt::timer::ISA = __PACKAGE__;
1824@urxvt::iow::ISA = __PACKAGE__;
1825@urxvt::pw::ISA = __PACKAGE__;
1826@urxvt::iw::ISA = __PACKAGE__;
1827 2070
1828=head2 The C<urxvt::timer> Class 2071=head2 The C<urxvt::timer> Class
1829 2072
1830This class implements timer watchers/events. Time is represented as a 2073This class implements timer watchers/events. Time is represented as a
1831fractional number of seconds since the epoch. Example: 2074fractional number of seconds since the epoch. Example:
1835 ->new 2078 ->new
1836 ->interval (1) 2079 ->interval (1)
1837 ->cb (sub { 2080 ->cb (sub {
1838 $term->{overlay}->set (0, 0, 2081 $term->{overlay}->set (0, 0,
1839 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2082 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1840 }); 2083 });
1841 2084
1842=over 4 2085=over 4
1843 2086
1844=item $timer = new urxvt::timer 2087=item $timer = new urxvt::timer
1845 2088
1848 2091
1849=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2092=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1850 2093
1851Set the callback to be called when the timer triggers. 2094Set the callback to be called when the timer triggers.
1852 2095
1853=item $tstamp = $timer->at
1854
1855Return the time this watcher will fire next.
1856
1857=item $timer = $timer->set ($tstamp) 2096=item $timer = $timer->set ($tstamp[, $interval])
1858 2097
1859Set the time the event is generated to $tstamp. 2098Set the time the event is generated to $tstamp (and optionally specifies a
2099new $interval).
1860 2100
1861=item $timer = $timer->interval ($interval) 2101=item $timer = $timer->interval ($interval)
1862 2102
1863Normally (and when C<$interval> is C<0>), the timer will automatically 2103By default (and when C<$interval> is C<0>), the timer will automatically
1864stop after it has fired once. If C<$interval> is non-zero, then the timer 2104stop after it has fired once. If C<$interval> is non-zero, then the timer
1865is automatically rescheduled at the given intervals. 2105is automatically rescheduled at the given intervals.
1866 2106
1867=item $timer = $timer->start 2107=item $timer = $timer->start
1868 2108
1869Start the timer. 2109Start the timer.
1870 2110
1871=item $timer = $timer->start ($tstamp) 2111=item $timer = $timer->start ($tstamp[, $interval])
1872 2112
1873Set the event trigger time to C<$tstamp> and start the timer. 2113Set the event trigger time to C<$tstamp> and start the timer. Optionally
2114also replaces the interval.
1874 2115
1875=item $timer = $timer->after ($delay) 2116=item $timer = $timer->after ($delay[, $interval])
1876 2117
1877Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2118Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1878 2119
1879=item $timer = $timer->stop 2120=item $timer = $timer->stop
1880 2121
1888 2129
1889 $term->{socket} = ... 2130 $term->{socket} = ...
1890 $term->{iow} = urxvt::iow 2131 $term->{iow} = urxvt::iow
1891 ->new 2132 ->new
1892 ->fd (fileno $term->{socket}) 2133 ->fd (fileno $term->{socket})
1893 ->events (urxvt::EVENT_READ) 2134 ->events (urxvt::EV_READ)
1894 ->start 2135 ->start
1895 ->cb (sub { 2136 ->cb (sub {
1896 my ($iow, $revents) = @_; 2137 my ($iow, $revents) = @_;
1897 # $revents must be 1 here, no need to check 2138 # $revents must be 1 here, no need to check
1898 sysread $term->{socket}, my $buf, 8192 2139 sysread $term->{socket}, my $buf, 8192
1911Set the callback to be called when io events are triggered. C<$reventmask> 2152Set the callback to be called when io events are triggered. C<$reventmask>
1912is a bitset as described in the C<events> method. 2153is a bitset as described in the C<events> method.
1913 2154
1914=item $iow = $iow->fd ($fd) 2155=item $iow = $iow->fd ($fd)
1915 2156
1916Set the filedescriptor (not handle) to watch. 2157Set the file descriptor (not handle) to watch.
1917 2158
1918=item $iow = $iow->events ($eventmask) 2159=item $iow = $iow->events ($eventmask)
1919 2160
1920Set the event mask to watch. The only allowed values are 2161Set the event mask to watch. The only allowed values are
1921C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2162C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1922together, or C<urxvt::EVENT_NONE>. 2163together, or C<urxvt::EV_NONE>.
1923 2164
1924=item $iow = $iow->start 2165=item $iow = $iow->start
1925 2166
1926Start watching for requested events on the given handle. 2167Start watching for requested events on the given handle.
1927 2168
1928=item $iow = $iow->stop 2169=item $iow = $iow->stop
1929 2170
1930Stop watching for events on the given filehandle. 2171Stop watching for events on the given file handle.
1931 2172
1932=back 2173=back
1933 2174
1934=head2 The C<urxvt::iw> Class 2175=head2 The C<urxvt::iw> Class
1935 2176
1968 ->new 2209 ->new
1969 ->start ($pid) 2210 ->start ($pid)
1970 ->cb (sub { 2211 ->cb (sub {
1971 my ($pw, $exit_status) = @_; 2212 my ($pw, $exit_status) = @_;
1972 ... 2213 ...
1973 }); 2214 });
1974 2215
1975=over 4 2216=over 4
1976 2217
1977=item $pw = new urxvt::pw 2218=item $pw = new urxvt::pw
1978 2219
1982 2223
1983Set the callback to be called when the timer triggers. 2224Set the callback to be called when the timer triggers.
1984 2225
1985=item $pw = $timer->start ($pid) 2226=item $pw = $timer->start ($pid)
1986 2227
1987Tells the wqtcher to start watching for process C<$pid>. 2228Tells the watcher to start watching for process C<$pid>.
1988 2229
1989=item $pw = $pw->stop 2230=item $pw = $pw->stop
1990 2231
1991Stop the watcher. 2232Stop the watcher.
1992 2233
2005 2246
2006=item >= 3 - script loading and management 2247=item >= 3 - script loading and management
2007 2248
2008=item >=10 - all called hooks 2249=item >=10 - all called hooks
2009 2250
2010=item >=11 - hook reutrn values 2251=item >=11 - hook return values
2011 2252
2012=back 2253=back
2013 2254
2014=head1 AUTHOR 2255=head1 AUTHOR
2015 2256
2016 Marc Lehmann <pcg@goof.com> 2257 Marc Lehmann <schmorp@schmorp.de>
2017 http://software.schmorp.de/pkg/rxvt-unicode 2258 http://software.schmorp.de/pkg/rxvt-unicode
2018 2259
2019=cut 2260=cut
2020 2261
20211 22621
2263
2264# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines