ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.129 by root, Wed Jan 25 15:11:31 2006 UTC vs.
Revision 1.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-selection 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_keyboard_command $term, $string 652=item on_user_command $term, $string
521 653
522Called whenever the user presses a key combination that has a 654Called whenever a user-configured event is being activated (e.g. via
523C<perl:string> action bound to it (see description of the B<keysym> 655a C<perl:string> action bound to a key, see description of the B<keysym>
524resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
657
658The event is simply the action string. This interface is assumed to change
659slightly in the future.
660
661=item on_resize_all_windows $term, $new_width, $new_height
662
663Called just after the new window size has been calculated, but before
664windows are actually being resized or hints are being set. If this hook
665returns TRUE, setting of the window hints is being skipped.
525 666
526=item on_x_event $term, $event 667=item on_x_event $term, $event
527 668
528Called 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
529windows). Should only be used as a last resort. Most event structure 670windows). Should only be used as a last resort. Most event structure
530members are not passed. 671members are not passed.
531 672
673=item on_root_event $term, $event
674
675Like C<on_x_event>, but is called for events on the root window.
676
532=item on_focus_in $term 677=item on_focus_in $term
533 678
534Called whenever the window gets the keyboard focus, before rxvt-unicode 679Called whenever the window gets the keyboard focus, before rxvt-unicode
535does focus in processing. 680does focus in processing.
536 681
537=item on_focus_out $term 682=item on_focus_out $term
538 683
539Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called whenever the window loses keyboard focus, before rxvt-unicode does
540focus out processing. 685focus out processing.
541 686
542=item on_configure_notify $term, $event 687=item on_configure_notify $term, $event
543 688
544=item on_property_notify $term, $event 689=item on_property_notify $term, $event
555 700
556=item on_map_notify $term, $event 701=item on_map_notify $term, $event
557 702
558=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
559 704
560Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
561the 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.
562 707
563The 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
564manpage), 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
565(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
566 711
575 720
576=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
577 722
578Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
579format=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.
580 729
581=back 730=back
582 731
583=cut 732=cut
584 733
627The current terminal. This variable stores the current C<urxvt::term> 776The current terminal. This variable stores the current C<urxvt::term>
628object, whenever a callback/hook is executing. 777object, whenever a callback/hook is executing.
629 778
630=item @urxvt::TERM_INIT 779=item @urxvt::TERM_INIT
631 780
632All 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
633created 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
634gets cleared before the codereferences that were in it are being executed, 783gets cleared before the code references that were in it are being executed,
635so coderefs can push themselves onto it again if they so desire. 784so references can push themselves onto it again if they so desire.
636 785
637This complements to the perl-eval commandline option, but gets executed 786This complements to the perl-eval command line option, but gets executed
638first. 787first.
639 788
640=item @urxvt::TERM_EXT 789=item @urxvt::TERM_EXT
641 790
642Works 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
649 798
650=over 4 799=over 4
651 800
652=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
653 802
654Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
655costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
656starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
657 807
658=item urxvt::warn $string 808=item urxvt::warn $string
659 809
660Calls 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
661newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
662that calls this function. 812that calls this function.
663 813
664Using 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
665correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
666 816
667Messages 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).
668 825
669=item $time = urxvt::NOW 826=item $time = urxvt::NOW
670 827
671Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
672 829
715 872
716=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
717 874
718Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
719 876
720=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
721 879
722Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
723underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
724the bitset. 882the bitset.
725 883
730Return the foreground/background colour index, respectively. 888Return the foreground/background colour index, respectively.
731 889
732=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 890=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
733 891
734=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
735 895
736Replace the foreground/background colour in the rendition mask with the 896Replace the foreground/background colour in the rendition mask with the
737specified one. 897specified one.
738 898
739=item $value = urxvt::GET_CUSTOM $rend 899=item $value = urxvt::GET_CUSTOM $rend
806 local $TERM = shift; 966 local $TERM = shift;
807 my $htype = shift; 967 my $htype = shift;
808 968
809 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
810 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
811 971
812 my %ext_arg; 972 my %ext_arg;
813 973
814 { 974 {
815 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
816 @TERM_INIT = (); 976 @TERM_INIT = ();
830 } else { 990 } else {
831 $ext_arg{$_} ||= []; 991 $ext_arg{$_} ||= [];
832 } 992 }
833 } 993 }
834 994
835 while (my ($ext, $argv) = each %ext_arg) { 995 for my $ext (sort keys %ext_arg) {
836 my @files = grep -f $_, map "$_/$ext", @dirs; 996 my @files = grep -f $_, map "$_/$ext", @dirs;
837 997
838 if (@files) { 998 if (@files) {
839 $TERM->register_package (extension_package $files[0], $argv); 999 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
840 } else { 1000 } else {
841 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";
842 } 1002 }
843 } 1003 }
844 1004
850 1010
851 if (my $cb = $TERM->{_hook}[$htype]) { 1011 if (my $cb = $TERM->{_hook}[$htype]) {
852 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1012 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
853 if $verbosity >= 10; 1013 if $verbosity >= 10;
854 1014
855 keys %$cb; 1015 for my $pkg (keys %$cb) {
856
857 while (my ($pkg, $cb) = each %$cb) {
858 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1016 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
859 $retval ||= $retval_; 1017 $retval ||= $retval_;
860 1018
861 if ($@) { 1019 if ($@) {
862 $TERM->ungrab; # better to lose the grab than the session 1020 $TERM->ungrab; # better to lose the grab than the session
863 warn $@; 1021 warn $@;
875 # clear package 1033 # clear package
876 %$TERM = (); 1034 %$TERM = ();
877 } 1035 }
878 1036
879 $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)
880} 1067}
881 1068
882# urxvt::term::extension 1069# urxvt::term::extension
883 1070
884package urxvt::term::extension; 1071package urxvt::term::extension;
955is 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
956work. 1143work.
957 1144
958=cut 1145=cut
959 1146
960our $VERSION = 1; 1147our $VERSION = '5.23';
961 1148
962$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
963push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
964 1151
965sub timer { 1152sub timer {
967 1154
968 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
969 1156
970 urxvt::timer 1157 urxvt::timer
971 ->new 1158 ->new
972 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
973 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
974 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
975 $cb->(); 1162 $cb->();
976 }) 1163 })
977} 1164}
978 1165
979sub io { 1166sub io {
980 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
981 1168
982 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
983 1172
984 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
985 ->new 1174 ->new
986 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
987 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
988 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
989 ->start 1178 ->start
990 ->cb (sub { 1179 ->cb ($cb)
991 $cb->(($_[1] & 1 ? 'r' : '')
992 . ($_[1] & 2 ? 'w' : ''));
993 })],
994 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 })
995} 1206}
996 1207
997sub DESTROY { 1208sub DESTROY {
998 $_[0][1]->stop; 1209 $_[0][1]->stop;
999} 1210}
1000 1211
1001sub condvar { 1212sub one_event {
1002 bless \my $flag, urxvt::anyevent::condvar::
1003}
1004
1005sub urxvt::anyevent::condvar::broadcast {
1006 ${$_[0]}++;
1007}
1008
1009sub urxvt::anyevent::condvar::wait {
1010 unless (${$_[0]}) {
1011 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1012 }
1013} 1214}
1014 1215
1015package urxvt::term; 1216package urxvt::term;
1016 1217
1017=head2 The C<urxvt::term> Class 1218=head2 The C<urxvt::term> Class
1053hash which defines the environment of the new terminal. 1254hash which defines the environment of the new terminal.
1054 1255
1055Croaks (and probably outputs an error message) if the new instance 1256Croaks (and probably outputs an error message) if the new instance
1056couldn'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
1057initialise perl, and the terminal object otherwise. The C<init> and 1258initialise perl, and the terminal object otherwise. The C<init> and
1058C<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).
1059 1261
1060=cut 1262=cut
1061 1263
1062sub new { 1264sub new {
1063 my ($class, $env, @args) = @_; 1265 my ($class, $env, @args) = @_;
1064 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
1065 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1270 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1066} 1271}
1067 1272
1068=item $term->destroy 1273=item $term->destroy
1069 1274
1070Destroy the terminal object (close the window, free resources 1275Destroy the terminal object (close the window, free resources
1100 1305
1101Returns true if the option specified by C<$optval> is enabled, and 1306Returns true if the option specified by C<$optval> is enabled, and
1102optionally 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
1103C<%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.
1104 1309
1105Here 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
1106source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1107 1312
1108 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess buffered console cursorBlink cursorUnderline hold iconic
1109 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1110 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1111 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1112 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1113 transparent tripleclickwords utmpInhibit visualBell 1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell
1114 1320
1115=item $value = $term->resource ($name[, $newval]) 1321=item $value = $term->resource ($name[, $newval])
1116 1322
1117Returns the current resource value associated with a given name and 1323Returns the current resource value associated with a given name and
1118optionally 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>
1127likely change). 1333likely change).
1128 1334
1129Please note that resource strings will currently only be freed when the 1335Please note that resource strings will currently only be freed when the
1130terminal is destroyed, so changing options frequently will eat memory. 1336terminal is destroyed, so changing options frequently will eat memory.
1131 1337
1132Here 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
1133are 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>
1134to see the actual list: 1340to see the actual list:
1135 1341
1136 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1342 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1137 borderLess color cursorBlink cursorUnderline cutchars delete_key 1343 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1138 display_name embed ext_bwidth fade font geometry hold iconName 1344 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1139 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
1140 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1347 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1141 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1348 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1142 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1349 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1143 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1350 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1144 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1351 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1145 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1352 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1146 secondaryScreen secondaryScroll selectstyle shade term_name title 1353 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1147 transient_for transparent transparent_all tripleclickwords utmpInhibit 1354 term_name title transient_for transparent tripleclickwords urgentOnBell
1148 visualBell 1355 utmpInhibit visualBell
1149 1356
1150=cut 1357=cut
1151 1358
1152sub resource($$;$) { 1359sub resource($$;$) {
1153 my ($self, $name) = (shift, shift); 1360 my ($self, $name) = (shift, shift);
1154 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1361 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1155 &urxvt::term::_resource 1362 goto &urxvt::term::_resource
1156} 1363}
1157 1364
1158=item $value = $term->x_resource ($pattern) 1365=item $value = $term->x_resource ($pattern)
1159 1366
1160Returns the X-Resource for the given pattern, excluding the program or 1367Returns the X-Resource for the given pattern, excluding the program or
1185 1392
1186=item ($row, $col) = $term->selection_beg ([$row, $col]) 1393=item ($row, $col) = $term->selection_beg ([$row, $col])
1187 1394
1188=item ($row, $col) = $term->selection_end ([$row, $col]) 1395=item ($row, $col) = $term->selection_end ([$row, $col])
1189 1396
1190Return the current values of the selection mark, begin or end positions, 1397Return the current values of the selection mark, begin or end positions.
1191and 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.
1192 1406
1193=item $term->selection_make ($eventtime[, $rectangular]) 1407=item $term->selection_make ($eventtime[, $rectangular])
1194 1408
1195Tries to make a selection as set by C<selection_beg> and 1409Tries to make a selection as set by C<selection_beg> and
1196C<selection_end>. If C<$rectangular> is true (default: false), a 1410C<selection_end>. If C<$rectangular> is true (default: false), a
1197rectangular selection will be made. This is the prefered function to make 1411rectangular selection will be made. This is the preferred function to make
1198a selection. 1412a selection.
1199 1413
1200=item $success = $term->selection_grab ($eventtime) 1414=item $success = $term->selection_grab ($eventtime[, $clipboard])
1201 1415
1202Try 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
1203set by the next method). No visual feedback will be given. This function 1418with the next method. No visual feedback will be given. This function
1204is mostly useful from within C<on_sel_grab> hooks. 1419is mostly useful from within C<on_sel_grab> hooks.
1205 1420
1206=item $oldtext = $term->selection ([$newtext]) 1421=item $oldtext = $term->selection ([$newtext, $clipboard])
1207 1422
1208Return 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.
1209 1429
1210=item $term->overlay_simple ($x, $y, $text) 1430=item $term->overlay_simple ($x, $y, $text)
1211 1431
1212Create 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.
1213 1433
1243 1463
1244The methods currently supported on C<urxvt::overlay> objects are: 1464The methods currently supported on C<urxvt::overlay> objects are:
1245 1465
1246=over 4 1466=over 4
1247 1467
1248=item $overlay->set ($x, $y, $text, $rend) 1468=item $overlay->set ($x, $y, $text[, $rend])
1249 1469
1250Similar 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
1251text 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
1252at 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.
1253 1475
1254=item $overlay->hide 1476=item $overlay->hide
1255 1477
1256If visible, hide the overlay, but do not destroy it. 1478If visible, hide the overlay, but do not destroy it.
1257 1479
1339locale-specific encoding of the terminal and can contain command sequences 1561locale-specific encoding of the terminal and can contain command sequences
1340(escape codes) that will be interpreted. 1562(escape codes) that will be interpreted.
1341 1563
1342=item $term->tt_write ($octets) 1564=item $term->tt_write ($octets)
1343 1565
1344Write 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
1345pass characters instead of octets, you should convert your strings first 1567pass characters instead of octets, you should convert your strings first
1346to 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.
1347 1575
1348=item $old_events = $term->pty_ev_events ([$new_events]) 1576=item $old_events = $term->pty_ev_events ([$new_events])
1349 1577
1350Replaces 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
1351be 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
1370Adds 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
1371to receive pointer events all the times: 1599to receive pointer events all the times:
1372 1600
1373 $term->vt_emask_add (urxvt::PointerMotionMask); 1601 $term->vt_emask_add (urxvt::PointerMotionMask);
1374 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
1375=item $window_width = $term->width 1613=item $window_width = $term->width
1376 1614
1377=item $window_height = $term->height 1615=item $window_height = $term->height
1378 1616
1379=item $font_width = $term->fwidth 1617=item $font_width = $term->fwidth
1409=item $env = $term->env 1647=item $env = $term->env
1410 1648
1411Returns 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
1412similar to C<\%ENV>. 1650similar to C<\%ENV>.
1413 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
1414=cut 1661=cut
1415 1662
1416sub env { 1663sub env {
1417 if (my $env = $_[0]->_env) {
1418 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1664 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1419 } else {
1420 +{ %ENV }
1421 }
1422} 1665}
1423 1666
1424=item $modifiermask = $term->ModLevel3Mask 1667=item $modifiermask = $term->ModLevel3Mask
1425 1668
1426=item $modifiermask = $term->ModMetaMask 1669=item $modifiermask = $term->ModMetaMask
1434 1677
1435Returns the currently displayed screen (0 primary, 1 secondary). 1678Returns the currently displayed screen (0 primary, 1 secondary).
1436 1679
1437=item $cursor_is_hidden = $term->hidden_cursor 1680=item $cursor_is_hidden = $term->hidden_cursor
1438 1681
1439Returns wether the cursor is currently hidden or not. 1682Returns whether the cursor is currently hidden or not.
1440 1683
1441=item $view_start = $term->view_start ([$newvalue]) 1684=item $view_start = $term->view_start ([$newvalue])
1442 1685
1443Returns the row number of the topmost displayed line. Maximum value is 1686Returns the row number of the topmost displayed line. Maximum value is
1444C<0>, which displays the normal terminal contents. Lower values scroll 1687C<0>, which displays the normal terminal contents. Lower values scroll
1452 1695
1453Used after changing terminal contents to display them. 1696Used after changing terminal contents to display them.
1454 1697
1455=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1698=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1456 1699
1457Returns 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 >>
1458is 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
1459terminal line. The scrollback buffer starts at line C<-1> and extends to
1460line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1702terminal line. Nothing will be returned if a nonexistent line
1461is requested. 1703is requested.
1462 1704
1463If 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
1464line, 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
1465to 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
1466automatically be updated. 1708automatically be updated.
1467 1709
1468C<$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
1469than 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)
1470characters. Characters with combining characters and other characters that 1712characters. Characters with combining characters and other characters that
1471do 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
1472in the private use area. 1714in the private use area.
1473 1715
1474You have to obey this encoding when changing text. The advantage is 1716You have to obey this encoding when changing text. The advantage is
1475that 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
1476characters. 1718characters.
1621where one character corresponds to one screen cell. See 1863where one character corresponds to one screen cell. See
1622C<< $term->ROW_t >> for details. 1864C<< $term->ROW_t >> for details.
1623 1865
1624=item $string = $term->special_decode $text 1866=item $string = $term->special_decode $text
1625 1867
1626Converts rxvt-unicodes text reprsentation into a perl string. See 1868Converts rxvt-unicodes text representation into a perl string. See
1627C<< $term->ROW_t >> for details. 1869C<< $term->ROW_t >> for details.
1628 1870
1629=item $success = $term->grab_button ($button, $modifiermask) 1871=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1630 1872
1873=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1874
1631Registers a synchronous button grab. See the XGrabButton manpage. 1875Register/unregister a synchronous button grab. See the XGrabButton
1876manpage.
1632 1877
1633=item $success = $term->grab ($eventtime[, $sync]) 1878=item $success = $term->grab ($eventtime[, $sync])
1634 1879
1635Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1880Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1636synchronous (C<$sync> is true). Also remembers the grab timestampe. 1881synchronous (C<$sync> is true). Also remembers the grab timestamp.
1637 1882
1638=item $term->allow_events_async 1883=item $term->allow_events_async
1639 1884
1640Calls XAllowEvents with AsyncBoth for the most recent grab. 1885Calls XAllowEvents with AsyncBoth for the most recent grab.
1641 1886
1648Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1893Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1649recent grab. 1894recent grab.
1650 1895
1651=item $term->ungrab 1896=item $term->ungrab
1652 1897
1653Calls XUngrab for the most recent grab. Is called automatically on 1898Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1654evaluation errors, as it is better to lose the grab in the error case as 1899evaluation errors, as it is better to lose the grab in the error case as
1655the session. 1900the session.
1656 1901
1657=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1902=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1658 1903
1660 1905
1661=item @atoms = $term->XListProperties ($window) 1906=item @atoms = $term->XListProperties ($window)
1662 1907
1663=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1908=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1664 1909
1665=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1910=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1666 1911
1667=item $term->XDeleteProperty ($window, $property) 1912=item $term->XDeleteProperty ($window, $property)
1668 1913
1669=item $window = $term->DefaultRootWindow 1914=item $window = $term->DefaultRootWindow
1670 1915
1680 1925
1681=item $term->XChangeInput ($window, $add_events[, $del_events]) 1926=item $term->XChangeInput ($window, $add_events[, $del_events])
1682 1927
1683Various 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
1684the source of the display, otherwise those functions map more-or-less 1929the source of the display, otherwise those functions map more-or-less
1685directory onto the X functions of the same name. 1930directly onto the X functions of the same name.
1686 1931
1687=back 1932=back
1688 1933
1689=cut 1934=cut
1690 1935
1754 my ($self, $text, $cb) = @_; 1999 my ($self, $text, $cb) = @_;
1755 2000
1756 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2001 $self->add_item ({ type => "button", text => $text, activate => $cb});
1757} 2002}
1758 2003
1759=item $popup->add_toggle ($text, $cb, $initial_value) 2004=item $popup->add_toggle ($text, $initial_value, $cb)
1760 2005
1761Adds a toggle/checkbox item to the popup. Teh callback gets called 2006Adds a toggle/checkbox item to the popup. The callback gets called
1762whenever 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
1763argument. 2008first argument.
1764 2009
1765=cut 2010=cut
1766 2011
1767sub add_toggle { 2012sub add_toggle {
1768 my ($self, $text, $cb, $value) = @_; 2013 my ($self, $text, $value, $cb) = @_;
1769 2014
1770 my $item; $item = { 2015 my $item; $item = {
1771 type => "button", 2016 type => "button",
1772 text => " $text", 2017 text => " $text",
1773 value => $value, 2018 value => $value,
1792 my $env = $self->{term}->env; 2037 my $env = $self->{term}->env;
1793 # 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.
1794 delete $env->{LC_ALL}; 2039 delete $env->{LC_ALL};
1795 $env->{LC_CTYPE} = $self->{term}->locale; 2040 $env->{LC_CTYPE} = $self->{term}->locale;
1796 2041
1797 urxvt::term->new ($env, "popup", 2042 my $term = urxvt::term->new (
2043 $env, "popup",
1798 "--perl-lib" => "", "--perl-ext-common" => "", 2044 "--perl-lib" => "", "--perl-ext-common" => "",
1799 "-pty-fd" => -1, "-sl" => 0, 2045 "-pty-fd" => -1, "-sl" => 0,
1800 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2046 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1801 "--transient-for" => $self->{term}->parent, 2047 "--transient-for" => $self->{term}->parent,
1802 "-display" => $self->{term}->display_id, 2048 "-display" => $self->{term}->display_id,
1803 "-pe" => "urxvt-popup") 2049 "-pe" => "urxvt-popup",
1804 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 }
1805} 2057}
1806 2058
1807sub DESTROY { 2059sub DESTROY {
1808 my ($self) = @_; 2060 my ($self) = @_;
1809 2061
1814=back 2066=back
1815 2067
1816=cut 2068=cut
1817 2069
1818package urxvt::watcher; 2070package urxvt::watcher;
1819
1820@urxvt::timer::ISA = __PACKAGE__;
1821@urxvt::iow::ISA = __PACKAGE__;
1822@urxvt::pw::ISA = __PACKAGE__;
1823@urxvt::iw::ISA = __PACKAGE__;
1824 2071
1825=head2 The C<urxvt::timer> Class 2072=head2 The C<urxvt::timer> Class
1826 2073
1827This class implements timer watchers/events. Time is represented as a 2074This class implements timer watchers/events. Time is represented as a
1828fractional number of seconds since the epoch. Example: 2075fractional number of seconds since the epoch. Example:
1832 ->new 2079 ->new
1833 ->interval (1) 2080 ->interval (1)
1834 ->cb (sub { 2081 ->cb (sub {
1835 $term->{overlay}->set (0, 0, 2082 $term->{overlay}->set (0, 0,
1836 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2083 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1837 }); 2084 });
1838 2085
1839=over 4 2086=over 4
1840 2087
1841=item $timer = new urxvt::timer 2088=item $timer = new urxvt::timer
1842 2089
1845 2092
1846=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2093=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1847 2094
1848Set the callback to be called when the timer triggers. 2095Set the callback to be called when the timer triggers.
1849 2096
1850=item $tstamp = $timer->at
1851
1852Return the time this watcher will fire next.
1853
1854=item $timer = $timer->set ($tstamp) 2097=item $timer = $timer->set ($tstamp[, $interval])
1855 2098
1856Set the time the event is generated to $tstamp. 2099Set the time the event is generated to $tstamp (and optionally specifies a
2100new $interval).
1857 2101
1858=item $timer = $timer->interval ($interval) 2102=item $timer = $timer->interval ($interval)
1859 2103
1860Normally (and when C<$interval> is C<0>), the timer will automatically 2104By default (and when C<$interval> is C<0>), the timer will automatically
1861stop after it has fired once. If C<$interval> is non-zero, then the timer 2105stop after it has fired once. If C<$interval> is non-zero, then the timer
1862is automatically rescheduled at the given intervals. 2106is automatically rescheduled at the given intervals.
1863 2107
1864=item $timer = $timer->start 2108=item $timer = $timer->start
1865 2109
1866Start the timer. 2110Start the timer.
1867 2111
1868=item $timer = $timer->start ($tstamp) 2112=item $timer = $timer->start ($tstamp[, $interval])
1869 2113
1870Set 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.
1871 2116
1872=item $timer = $timer->after ($delay) 2117=item $timer = $timer->after ($delay[, $interval])
1873 2118
1874Like 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>.
1875 2120
1876=item $timer = $timer->stop 2121=item $timer = $timer->stop
1877 2122
1885 2130
1886 $term->{socket} = ... 2131 $term->{socket} = ...
1887 $term->{iow} = urxvt::iow 2132 $term->{iow} = urxvt::iow
1888 ->new 2133 ->new
1889 ->fd (fileno $term->{socket}) 2134 ->fd (fileno $term->{socket})
1890 ->events (urxvt::EVENT_READ) 2135 ->events (urxvt::EV_READ)
1891 ->start 2136 ->start
1892 ->cb (sub { 2137 ->cb (sub {
1893 my ($iow, $revents) = @_; 2138 my ($iow, $revents) = @_;
1894 # $revents must be 1 here, no need to check 2139 # $revents must be 1 here, no need to check
1895 sysread $term->{socket}, my $buf, 8192 2140 sysread $term->{socket}, my $buf, 8192
1908Set 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>
1909is a bitset as described in the C<events> method. 2154is a bitset as described in the C<events> method.
1910 2155
1911=item $iow = $iow->fd ($fd) 2156=item $iow = $iow->fd ($fd)
1912 2157
1913Set the filedescriptor (not handle) to watch. 2158Set the file descriptor (not handle) to watch.
1914 2159
1915=item $iow = $iow->events ($eventmask) 2160=item $iow = $iow->events ($eventmask)
1916 2161
1917Set the event mask to watch. The only allowed values are 2162Set the event mask to watch. The only allowed values are
1918C<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
1919together, or C<urxvt::EVENT_NONE>. 2164together, or C<urxvt::EV_NONE>.
1920 2165
1921=item $iow = $iow->start 2166=item $iow = $iow->start
1922 2167
1923Start watching for requested events on the given handle. 2168Start watching for requested events on the given handle.
1924 2169
1925=item $iow = $iow->stop 2170=item $iow = $iow->stop
1926 2171
1927Stop watching for events on the given filehandle. 2172Stop watching for events on the given file handle.
1928 2173
1929=back 2174=back
1930 2175
1931=head2 The C<urxvt::iw> Class 2176=head2 The C<urxvt::iw> Class
1932 2177
1965 ->new 2210 ->new
1966 ->start ($pid) 2211 ->start ($pid)
1967 ->cb (sub { 2212 ->cb (sub {
1968 my ($pw, $exit_status) = @_; 2213 my ($pw, $exit_status) = @_;
1969 ... 2214 ...
1970 }); 2215 });
1971 2216
1972=over 4 2217=over 4
1973 2218
1974=item $pw = new urxvt::pw 2219=item $pw = new urxvt::pw
1975 2220
1979 2224
1980Set the callback to be called when the timer triggers. 2225Set the callback to be called when the timer triggers.
1981 2226
1982=item $pw = $timer->start ($pid) 2227=item $pw = $timer->start ($pid)
1983 2228
1984Tells the wqtcher to start watching for process C<$pid>. 2229Tells the watcher to start watching for process C<$pid>.
1985 2230
1986=item $pw = $pw->stop 2231=item $pw = $pw->stop
1987 2232
1988Stop the watcher. 2233Stop the watcher.
1989 2234
2002 2247
2003=item >= 3 - script loading and management 2248=item >= 3 - script loading and management
2004 2249
2005=item >=10 - all called hooks 2250=item >=10 - all called hooks
2006 2251
2007=item >=11 - hook reutrn values 2252=item >=11 - hook return values
2008 2253
2009=back 2254=back
2010 2255
2011=head1 AUTHOR 2256=head1 AUTHOR
2012 2257
2013 Marc Lehmann <pcg@goof.com> 2258 Marc Lehmann <schmorp@schmorp.de>
2014 http://software.schmorp.de/pkg/rxvt-unicode 2259 http://software.schmorp.de/pkg/rxvt-unicode
2015 2260
2016=cut 2261=cut
2017 2262
20181 22631
2264
2265# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines