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.197 by sf-tpope, Fri Aug 19 23:08:35 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 or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
268Example configuration:
269
270 URxvt.perl-ext: default,matcher
271 URxvt.urlLauncher: sensible-browser
272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
274 URxvt.matcher.button: 1
275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277 URxvt.matcher.launcher.2: gvim +$2 $1
216 278
217=item xim-onthespot 279=item xim-onthespot
218 280
219This (experimental) perl extension implements OnTheSpot editing. It does 281This (experimental) perl extension implements OnTheSpot editing. It does
220not work perfectly, and some input methods don't seem to work well with 282not 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 283OnTheSpot editing in general, but it seems to work at least for SCIM and
222kinput2. 284kinput2.
223 285
224You enable it by specifying this extension and a preedit style of 286You enable it by specifying this extension and a preedit style of
225C<OnTheSpot>, i.e.: 287C<OnTheSpot>, i.e.:
226 288
227 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228 290
229=item automove-background 291=item kuake<hotkey>
230 292
231This is basically a one-line extension that dynamically changes the background pixmap offset 293A 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 294description of how the programs C<kuake> and C<yakuake> work: Whenever the
233a custom pixmap. No scaling is supported in this mode. Exmaple: 295user presses a global accelerator key (by default C<F10>), the terminal
296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
234 298
235 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 299Initially, the window will not be shown when using this extension.
300
301This is useful if you need a single terminal that is not using any desktop
302space most of the time but is quickly available at the press of a key.
303
304The accelerator key is grabbed regardless of any modifiers, so this
305extension will actually grab a physical key just for this function.
306
307If you want a quake-like animation, tell your window manager to do so
308(fvwm can do it).
309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
236 315
237=item block-graphics-to-ascii 316=item block-graphics-to-ascii
238 317
239A not very useful example of filtering all text output to the terminal, 318A not very useful example of filtering all text output to the terminal
240by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
241similar-looking ascii character. 320similar-looking ascii character.
242 321
243=item digital-clock 322=item digital-clock
244 323
245Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
246 325
247=item remote-selection 326=item remote-clipboard
248 327
249Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
250selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
251selection somewhere and fetch it again. 330selection somewhere and fetch it again.
252 331
253We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
254means that one command uploads the file to a remote server, and another 333means that one command uploads the file to a remote server, and another
255reads it. 334reads it.
264 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
265 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
266 345
267=item selection-pastebin 346=item selection-pastebin
268 347
269This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
270textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
271not currently secure for use in a multiuser environment as it writes to 350not currently secure for use in a multiuser environment as it writes to
272F</tmp> directly.). 351F</tmp> directly.).
273 352
274It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
291in the C<selection-pastebin-url> resource (again, the % is the placeholder 370in the C<selection-pastebin-url> resource (again, the % is the placeholder
292for the filename): 371for the filename):
293 372
294 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
295 374
375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376the double C</> characters as comment start. Use C<\057\057> instead,
377which works regardless of whether xrdb is used to parse the resource file
378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
393
296=item example-refresh-hooks 394=item example-refresh-hooks
297 395
298Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
299window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
300overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
301 404
302=back 405=back
303 406
304=head1 API DOCUMENTATION 407=head1 API DOCUMENTATION
305 408
321 424
322=over 4 425=over 4
323 426
324=item $text 427=item $text
325 428
326Rxvt-unicodes special way of encoding text, where one "unicode" character 429Rxvt-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. 430always represents one screen cell. See L<ROW_t> for a discussion of this format.
328 431
329=item $string 432=item $string
330 433
331A perl text string, with an emphasis on I<text>. It can store all unicode 434A perl text string, with an emphasis on I<text>. It can store all unicode
339 442
340=back 443=back
341 444
342=head2 Extension Objects 445=head2 Extension Objects
343 446
344Very perl extension is a perl class. A separate perl object is created 447Every 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 448for 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 449which are passed as the first parameter to hooks. So extensions can use
347about other extensions, with the exception of methods and members that 450their C<$self> object without having to think about clashes with other
451extensions or other terminals, with the exception of methods and members
348begin with an underscore character C<_>: these are reserved for internal 452that begin with an underscore character C<_>: these are reserved for
349use. 453internal use.
350 454
351Although it isn't a C<urxvt::term> object, you can call all methods of the 455Although it isn't a C<urxvt::term> object, you can call all methods of the
352C<urxvt::term> class on this object. 456C<urxvt::term> class on this object.
353 457
354It has the following methods and data members: 458It has the following methods and data members:
375=head2 Hooks 479=head2 Hooks
376 480
377The following subroutines can be declared in extension files, and will be 481The following subroutines can be declared in extension files, and will be
378called whenever the relevant event happens. 482called whenever the relevant event happens.
379 483
380The first argument passed to them is an extension oject as described in 484The first argument passed to them is an extension object as described in
381the in the C<Extension Objects> section. 485the in the C<Extension Objects> section.
382 486
383B<All> of these hooks must return a boolean value. If any of the called 487B<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 488hooks returns true, then the event counts as being I<consumed>, and the
385relevant action might not be carried out by the C++ code. 489relevant action might not be carried out by the C++ code.
398place. 502place.
399 503
400=item on_start $term 504=item on_start $term
401 505
402Called at the very end of initialisation of a new terminal, just before 506Called at the very end of initialisation of a new terminal, just before
403trying to map (display) the toplevel and returning to the mainloop. 507trying to map (display) the toplevel and returning to the main loop.
404 508
405=item on_destroy $term 509=item on_destroy $term
406 510
407Called whenever something tries to destroy terminal, when the terminal is 511Called whenever something tries to destroy terminal, when the terminal is
408still fully functional (not for long, though). 512still fully functional (not for long, though).
435 539
436Called whenever a selection has been copied, but before the selection is 540Called whenever a selection has been copied, but before the selection is
437requested from the server. The selection text can be queried and changed 541requested from the server. The selection text can be queried and changed
438by calling C<< $term->selection >>. 542by calling C<< $term->selection >>.
439 543
440Returning a true value aborts selection grabbing. It will still be hilighted. 544Returning a true value aborts selection grabbing. It will still be highlighted.
441 545
442=item on_sel_extend $term 546=item on_sel_extend $term
443 547
444Called whenever the user tries to extend the selection (e.g. with a double 548Called whenever the user tries to extend the selection (e.g. with a double
445click) and is either supposed to return false (normal operation), or 549click) and is either supposed to return false (normal operation), or
446should extend the selection itelf and return true to suppress the built-in 550should extend the selection itself and return true to suppress the built-in
447processing. This can happen multiple times, as long as the callback 551processing. 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 552returns true, it will be called on every further click by the user and is
449supposed to enlarge the selection more and more, if possible. 553supposed to enlarge the selection more and more, if possible.
450 554
451See the F<selection> example extension. 555See the F<selection> example extension.
452 556
453=item on_view_change $term, $offset 557=item on_view_change $term, $offset
454 558
455Called whenever the view offset changes, i..e the user or program 559Called whenever the view offset changes, i.e. the user or program
456scrolls. Offset C<0> means display the normal terminal, positive values 560scrolls. Offset C<0> means display the normal terminal, positive values
457show this many lines of scrollback. 561show this many lines of scrollback.
458 562
459=item on_scroll_back $term, $lines, $saved 563=item on_scroll_back $term, $lines, $saved
460 564
464 568
465It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 569It 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 570$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
467number of lines that will be in the scrollback buffer. 571number of lines that will be in the scrollback buffer.
468 572
469=item on_osc_seq $term, $string 573=item on_osc_seq $term, $op, $args, $resp
574
575Called on every OSC sequence and can be used to suppress it or modify its
576behaviour. The default should be to return an empty list. A true value
577suppresses execution of the request completely. Make sure you don't get
578confused by recursive invocations when you output an OSC sequence within
579this callback.
580
581C<on_osc_seq_perl> should be used for new behaviour.
582
583=item on_osc_seq_perl $term, $args, $resp
470 584
471Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 585Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
472operating system command) is processed. Cursor position and other state 586operating system command) is processed. Cursor position and other state
473information is up-to-date when this happens. For interoperability, the 587information is up-to-date when this happens. For interoperability, the
474string should start with the extension name and a colon, to distinguish 588string should start with the extension name (sans -osc) and a semicolon,
475it from commands for other extensions, and this might be enforced in the 589to distinguish it from commands for other extensions, and this might be
476future. 590enforced in the future.
591
592For example, C<overlay-osc> uses this:
593
594 sub on_osc_seq_perl {
595 my ($self, $osc, $resp) = @_;
596
597 return unless $osc =~ s/^overlay;//;
598
599 ... process remaining $osc string
600 }
477 601
478Be careful not ever to trust (in a security sense) the data you receive, 602Be 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 603as its source can not easily be controlled (e-mail content, messages from
480other users on the same system etc.). 604other users on the same system etc.).
605
606For responses, C<$resp> contains the end-of-args separator used by the
607sender.
481 608
482=item on_add_lines $term, $string 609=item on_add_lines $term, $string
483 610
484Called whenever text is about to be output, with the text as argument. You 611Called 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 612can filter/change and output the text yourself by returning a true value
490=item on_tt_write $term, $octets 617=item on_tt_write $term, $octets
491 618
492Called whenever some data is written to the tty/pty and can be used to 619Called whenever some data is written to the tty/pty and can be used to
493suppress or filter tty input. 620suppress or filter tty input.
494 621
622=item on_tt_paste $term, $octets
623
624Called whenever text is about to be pasted, with the text as argument. You
625can filter/change and paste the text yourself by returning a true value
626and calling C<< $term->tt_paste >> yourself. C<$octets> is
627locale-encoded.
628
495=item on_line_update $term, $row 629=item on_line_update $term, $row
496 630
497Called whenever a line was updated or changed. Can be used to filter 631Called whenever a line was updated or changed. Can be used to filter
498screen output (e.g. underline urls or other useless stuff). Only lines 632screen output (e.g. underline urls or other useless stuff). Only lines
499that are being shown will be filtered, and, due to performance reasons, 633that are being shown will be filtered, and, due to performance reasons,
506later with the already-modified line (e.g. if unrelated parts change), so 640later with the already-modified line (e.g. if unrelated parts change), so
507you cannot just toggle rendition bits, but only set them. 641you cannot just toggle rendition bits, but only set them.
508 642
509=item on_refresh_begin $term 643=item on_refresh_begin $term
510 644
511Called just before the screen gets redrawn. Can be used for overlay 645Called just before the screen gets redrawn. Can be used for overlay or
512or similar effects by modify terminal contents in refresh_begin, and 646similar effects by modifying the terminal contents in refresh_begin, and
513restoring them in refresh_end. The built-in overlay and selection display 647restoring them in refresh_end. The built-in overlay and selection display
514code is run after this hook, and takes precedence. 648code is run after this hook, and takes precedence.
515 649
516=item on_refresh_end $term 650=item on_refresh_end $term
517 651
518Called just after the screen gets redrawn. See C<on_refresh_begin>. 652Called just after the screen gets redrawn. See C<on_refresh_begin>.
519 653
520=item on_keyboard_command $term, $string 654=item on_user_command $term, $string
521 655
522Called whenever the user presses a key combination that has a 656Called whenever a user-configured event is being activated (e.g. via
523C<perl:string> action bound to it (see description of the B<keysym> 657a C<perl:string> action bound to a key, see description of the B<keysym>
524resource in the @@RXVT_NAME@@(1) manpage). 658resource in the @@RXVT_NAME@@(1) manpage).
659
660The event is simply the action string. This interface is assumed to change
661slightly in the future.
662
663=item on_resize_all_windows $term, $new_width, $new_height
664
665Called just after the new window size has been calculated, but before
666windows are actually being resized or hints are being set. If this hook
667returns TRUE, setting of the window hints is being skipped.
525 668
526=item on_x_event $term, $event 669=item on_x_event $term, $event
527 670
528Called on every X event received on the vt window (and possibly other 671Called on every X event received on the vt window (and possibly other
529windows). Should only be used as a last resort. Most event structure 672windows). Should only be used as a last resort. Most event structure
530members are not passed. 673members are not passed.
531 674
675=item on_root_event $term, $event
676
677Like C<on_x_event>, but is called for events on the root window.
678
532=item on_focus_in $term 679=item on_focus_in $term
533 680
534Called whenever the window gets the keyboard focus, before rxvt-unicode 681Called whenever the window gets the keyboard focus, before rxvt-unicode
535does focus in processing. 682does focus in processing.
536 683
537=item on_focus_out $term 684=item on_focus_out $term
538 685
539Called wheneever the window loses keyboard focus, before rxvt-unicode does 686Called whenever the window loses keyboard focus, before rxvt-unicode does
540focus out processing. 687focus out processing.
541 688
542=item on_configure_notify $term, $event 689=item on_configure_notify $term, $event
543 690
544=item on_property_notify $term, $event 691=item on_property_notify $term, $event
555 702
556=item on_map_notify $term, $event 703=item on_map_notify $term, $event
557 704
558=item on_unmap_notify $term, $event 705=item on_unmap_notify $term, $event
559 706
560Called whenever the corresponding X event is received for the terminal If 707Called whenever the corresponding X event is received for the terminal. If
561the hook returns true, then the even will be ignored by rxvt-unicode. 708the hook returns true, then the event will be ignored by rxvt-unicode.
562 709
563The event is a hash with most values as named by Xlib (see the XEvent 710The 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 711manpage), with the additional members C<row> and C<col>, which are the
565(real, not screen-based) row and column under the mouse cursor. 712(real, not screen-based) row and column under the mouse cursor.
566 713
575 722
576=item on_wm_delete_window $term, $event 723=item on_wm_delete_window $term, $event
577 724
578Called when various types of ClientMessage events are received (all with 725Called when various types of ClientMessage events are received (all with
579format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 726format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
727
728=item on_bell $term
729
730Called on receipt of a bell character.
580 731
581=back 732=back
582 733
583=cut 734=cut
584 735
627The current terminal. This variable stores the current C<urxvt::term> 778The current terminal. This variable stores the current C<urxvt::term>
628object, whenever a callback/hook is executing. 779object, whenever a callback/hook is executing.
629 780
630=item @urxvt::TERM_INIT 781=item @urxvt::TERM_INIT
631 782
632All coderefs in this array will be called as methods of the next newly 783All 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 784created C<urxvt::term> object (during the C<on_init> phase). The array
634gets cleared before the codereferences that were in it are being executed, 785gets cleared before the code references that were in it are being executed,
635so coderefs can push themselves onto it again if they so desire. 786so references can push themselves onto it again if they so desire.
636 787
637This complements to the perl-eval commandline option, but gets executed 788This complements to the perl-eval command line option, but gets executed
638first. 789first.
639 790
640=item @urxvt::TERM_EXT 791=item @urxvt::TERM_EXT
641 792
642Works similar to C<@TERM_INIT>, but contains perl package/class names, which 793Works similar to C<@TERM_INIT>, but contains perl package/class names, which
649 800
650=over 4 801=over 4
651 802
652=item urxvt::fatal $errormessage 803=item urxvt::fatal $errormessage
653 804
654Fatally aborts execution with the given error message. Avoid at all 805Fatally aborts execution with the given error message (which should
655costs! The only time this is acceptable is when the terminal process 806include a trailing newline). Avoid at all costs! The only time this
656starts up. 807is acceptable (and useful) is in the init hook, where it prevents the
808terminal from starting up.
657 809
658=item urxvt::warn $string 810=item urxvt::warn $string
659 811
660Calls C<rxvt_warn> with the given string which should not include a 812Calls C<rxvt_warn> with the given string which should include a trailing
661newline. The module also overwrites the C<warn> builtin with a function 813newline. The module also overwrites the C<warn> builtin with a function
662that calls this function. 814that calls this function.
663 815
664Using this function has the advantage that its output ends up in the 816Using this function has the advantage that its output ends up in the
665correct place, e.g. on stderr of the connecting urxvtc client. 817correct place, e.g. on stderr of the connecting urxvtc client.
666 818
667Messages have a size limit of 1023 bytes currently. 819Messages have a size limit of 1023 bytes currently.
820
821=item @terms = urxvt::termlist
822
823Returns all urxvt::term objects that exist in this process, regardless of
824whether they are started, being destroyed etc., so be careful. Only term
825objects that have perl extensions attached will be returned (because there
826is no urxvt::term object associated with others).
668 827
669=item $time = urxvt::NOW 828=item $time = urxvt::NOW
670 829
671Returns the "current time" (as per the event loop). 830Returns the "current time" (as per the event loop).
672 831
715 874
716=item $rend = urxvt::OVERLAY_RSTYLE 875=item $rend = urxvt::OVERLAY_RSTYLE
717 876
718Return the rendition mask used for overlays by default. 877Return the rendition mask used for overlays by default.
719 878
720=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 879=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
880urxvt::RS_RVid, urxvt::RS_Uline
721 881
722Return the bit that enabled bold, italic, blink, reverse-video and 882Return the bit that enabled bold, italic, blink, reverse-video and
723underline, respectively. To enable such a style, just logically OR it into 883underline, respectively. To enable such a style, just logically OR it into
724the bitset. 884the bitset.
725 885
730Return the foreground/background colour index, respectively. 890Return the foreground/background colour index, respectively.
731 891
732=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 892=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
733 893
734=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 894=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
895
896=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
735 897
736Replace the foreground/background colour in the rendition mask with the 898Replace the foreground/background colour in the rendition mask with the
737specified one. 899specified one.
738 900
739=item $value = urxvt::GET_CUSTOM $rend 901=item $value = urxvt::GET_CUSTOM $rend
806 local $TERM = shift; 968 local $TERM = shift;
807 my $htype = shift; 969 my $htype = shift;
808 970
809 if ($htype == 0) { # INIT 971 if ($htype == 0) { # INIT
810 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 972 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
811 973
812 my %ext_arg; 974 my %ext_arg;
813 975
814 { 976 {
815 my @init = @TERM_INIT; 977 my @init = @TERM_INIT;
816 @TERM_INIT = (); 978 @TERM_INIT = ();
830 } else { 992 } else {
831 $ext_arg{$_} ||= []; 993 $ext_arg{$_} ||= [];
832 } 994 }
833 } 995 }
834 996
835 while (my ($ext, $argv) = each %ext_arg) { 997 for my $ext (sort keys %ext_arg) {
836 my @files = grep -f $_, map "$_/$ext", @dirs; 998 my @files = grep -f $_, map "$_/$ext", @dirs;
837 999
838 if (@files) { 1000 if (@files) {
839 $TERM->register_package (extension_package $files[0], $argv); 1001 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
840 } else { 1002 } else {
841 warn "perl extension '$ext' not found in perl library search path\n"; 1003 warn "perl extension '$ext' not found in perl library search path\n";
842 } 1004 }
843 } 1005 }
844 1006
850 1012
851 if (my $cb = $TERM->{_hook}[$htype]) { 1013 if (my $cb = $TERM->{_hook}[$htype]) {
852 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1014 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
853 if $verbosity >= 10; 1015 if $verbosity >= 10;
854 1016
855 keys %$cb; 1017 for my $pkg (keys %$cb) {
856
857 while (my ($pkg, $cb) = each %$cb) {
858 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1018 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
859 $retval ||= $retval_; 1019 $retval ||= $retval_;
860 1020
861 if ($@) { 1021 if ($@) {
862 $TERM->ungrab; # better to lose the grab than the session 1022 $TERM->ungrab; # better to lose the grab than the session
863 warn $@; 1023 warn $@;
875 # clear package 1035 # clear package
876 %$TERM = (); 1036 %$TERM = ();
877 } 1037 }
878 1038
879 $retval 1039 $retval
1040}
1041
1042sub SET_COLOR($$$) {
1043 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1044}
1045
1046sub rend2mask {
1047 no strict 'refs';
1048 my ($str, $mask) = (@_, 0);
1049 my %color = ( fg => undef, bg => undef );
1050 my @failed;
1051 for my $spec ( split /\s+/, $str ) {
1052 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1053 $color{lc($1)} = $2;
1054 } else {
1055 my $neg = $spec =~ s/^[-^]//;
1056 unless ( exists &{"RS_$spec"} ) {
1057 push @failed, $spec;
1058 next;
1059 }
1060 my $cur = &{"RS_$spec"};
1061 if ( $neg ) {
1062 $mask &= ~$cur;
1063 } else {
1064 $mask |= $cur;
1065 }
1066 }
1067 }
1068 ($mask, @color{qw(fg bg)}, \@failed)
880} 1069}
881 1070
882# urxvt::term::extension 1071# urxvt::term::extension
883 1072
884package urxvt::term::extension; 1073package urxvt::term::extension;
955is that you cannot use blocking APIs, but the non-blocking variant should 1144is that you cannot use blocking APIs, but the non-blocking variant should
956work. 1145work.
957 1146
958=cut 1147=cut
959 1148
960our $VERSION = 1; 1149our $VERSION = '5.23';
961 1150
962$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1151$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
963push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1152push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
964 1153
965sub timer { 1154sub timer {
967 1156
968 my $cb = $arg{cb}; 1157 my $cb = $arg{cb};
969 1158
970 urxvt::timer 1159 urxvt::timer
971 ->new 1160 ->new
972 ->start (urxvt::NOW + $arg{after}) 1161 ->after ($arg{after}, $arg{interval})
973 ->cb (sub { 1162 ->cb ($arg{interval} ? $cb : sub {
974 $_[0]->stop; # need to cancel manually 1163 $_[0]->stop; # need to cancel manually
975 $cb->(); 1164 $cb->();
976 }) 1165 })
977} 1166}
978 1167
979sub io { 1168sub io {
980 my ($class, %arg) = @_; 1169 my ($class, %arg) = @_;
981 1170
982 my $cb = $arg{cb}; 1171 my $cb = $arg{cb};
1172 my $fd = fileno $arg{fh};
1173 defined $fd or $fd = $arg{fh};
983 1174
984 bless [$arg{fh}, urxvt::iow 1175 bless [$arg{fh}, urxvt::iow
985 ->new 1176 ->new
986 ->fd (fileno $arg{fh}) 1177 ->fd ($fd)
987 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1178 ->events (($arg{poll} =~ /r/ ? 1 : 0)
988 | ($arg{poll} =~ /w/ ? 2 : 0)) 1179 | ($arg{poll} =~ /w/ ? 2 : 0))
989 ->start 1180 ->start
990 ->cb (sub { 1181 ->cb ($cb)
991 $cb->(($_[1] & 1 ? 'r' : '')
992 . ($_[1] & 2 ? 'w' : ''));
993 })],
994 urxvt::anyevent:: 1182 ], urxvt::anyevent::
1183}
1184
1185sub idle {
1186 my ($class, %arg) = @_;
1187
1188 my $cb = $arg{cb};
1189
1190 urxvt::iw
1191 ->new
1192 ->start
1193 ->cb ($cb)
1194}
1195
1196sub child {
1197 my ($class, %arg) = @_;
1198
1199 my $cb = $arg{cb};
1200
1201 urxvt::pw
1202 ->new
1203 ->start ($arg{pid})
1204 ->cb (sub {
1205 $_[0]->stop; # need to cancel manually
1206 $cb->($_[0]->rpid, $_[0]->rstatus);
1207 })
995} 1208}
996 1209
997sub DESTROY { 1210sub DESTROY {
998 $_[0][1]->stop; 1211 $_[0][1]->stop;
999} 1212}
1000 1213
1001sub condvar { 1214sub 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"; 1215 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1012 }
1013} 1216}
1014 1217
1015package urxvt::term; 1218package urxvt::term;
1016 1219
1017=head2 The C<urxvt::term> Class 1220=head2 The C<urxvt::term> Class
1053hash which defines the environment of the new terminal. 1256hash which defines the environment of the new terminal.
1054 1257
1055Croaks (and probably outputs an error message) if the new instance 1258Croaks (and probably outputs an error message) if the new instance
1056couldn't be created. Returns C<undef> if the new instance didn't 1259couldn't be created. Returns C<undef> if the new instance didn't
1057initialise perl, and the terminal object otherwise. The C<init> and 1260initialise perl, and the terminal object otherwise. The C<init> and
1058C<start> hooks will be called during this call. 1261C<start> hooks will be called before this call returns, and are free to
1262refer to global data (which is race free).
1059 1263
1060=cut 1264=cut
1061 1265
1062sub new { 1266sub new {
1063 my ($class, $env, @args) = @_; 1267 my ($class, $env, @args) = @_;
1064 1268
1269 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1270 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1271
1065 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1272 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1066} 1273}
1067 1274
1068=item $term->destroy 1275=item $term->destroy
1069 1276
1070Destroy the terminal object (close the window, free resources 1277Destroy the terminal object (close the window, free resources
1100 1307
1101Returns true if the option specified by C<$optval> is enabled, and 1308Returns true if the option specified by C<$optval> is enabled, and
1102optionally change it. All option values are stored by name in the hash 1309optionally 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. 1310C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1104 1311
1105Here is a a likely non-exhaustive list of option names, please see the 1312Here is a likely non-exhaustive list of option names, please see the
1106source file F</src/optinc.h> to see the actual list: 1313source file F</src/optinc.h> to see the actual list:
1107 1314
1108 borderLess console cursorBlink cursorUnderline hold iconic insecure 1315 borderLess buffered console cursorBlink cursorUnderline hold iconic
1109 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1316 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1110 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1317 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1111 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1318 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1112 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1319 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1113 transparent tripleclickwords utmpInhibit visualBell 1320 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1321 urgentOnBell utmpInhibit visualBell
1114 1322
1115=item $value = $term->resource ($name[, $newval]) 1323=item $value = $term->resource ($name[, $newval])
1116 1324
1117Returns the current resource value associated with a given name and 1325Returns the current resource value associated with a given name and
1118optionally sets a new value. Setting values is most useful in the C<init> 1326optionally sets a new value. Setting values is most useful in the C<init>
1127likely change). 1335likely change).
1128 1336
1129Please note that resource strings will currently only be freed when the 1337Please note that resource strings will currently only be freed when the
1130terminal is destroyed, so changing options frequently will eat memory. 1338terminal is destroyed, so changing options frequently will eat memory.
1131 1339
1132Here is a a likely non-exhaustive list of resource names, not all of which 1340Here 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> 1341are supported in every build, please see the source file F</src/rsinc.h>
1134to see the actual list: 1342to see the actual list:
1135 1343
1136 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1344 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1137 borderLess color cursorBlink cursorUnderline cutchars delete_key 1345 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1138 display_name embed ext_bwidth fade font geometry hold iconName 1346 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1139 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1347 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1348 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1140 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1349 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1141 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1350 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1142 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1351 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1143 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1352 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1144 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1353 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1145 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1354 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1146 secondaryScreen secondaryScroll selectstyle shade term_name title 1355 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1147 transient_for transparent transparent_all tripleclickwords utmpInhibit 1356 term_name title transient_for transparent tripleclickwords urgentOnBell
1148 visualBell 1357 utmpInhibit visualBell
1149 1358
1150=cut 1359=cut
1151 1360
1152sub resource($$;$) { 1361sub resource($$;$) {
1153 my ($self, $name) = (shift, shift); 1362 my ($self, $name) = (shift, shift);
1154 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1363 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1155 &urxvt::term::_resource 1364 goto &urxvt::term::_resource
1156} 1365}
1157 1366
1158=item $value = $term->x_resource ($pattern) 1367=item $value = $term->x_resource ($pattern)
1159 1368
1160Returns the X-Resource for the given pattern, excluding the program or 1369Returns the X-Resource for the given pattern, excluding the program or
1185 1394
1186=item ($row, $col) = $term->selection_beg ([$row, $col]) 1395=item ($row, $col) = $term->selection_beg ([$row, $col])
1187 1396
1188=item ($row, $col) = $term->selection_end ([$row, $col]) 1397=item ($row, $col) = $term->selection_end ([$row, $col])
1189 1398
1190Return the current values of the selection mark, begin or end positions, 1399Return the current values of the selection mark, begin or end positions.
1191and optionally set them to new values. 1400
1401When arguments are given, then the selection coordinates are set to
1402C<$row> and C<$col>, and the selection screen is set to the current
1403screen.
1404
1405=item $screen = $term->selection_screen ([$screen])
1406
1407Returns the current selection screen, and then optionally sets it.
1192 1408
1193=item $term->selection_make ($eventtime[, $rectangular]) 1409=item $term->selection_make ($eventtime[, $rectangular])
1194 1410
1195Tries to make a selection as set by C<selection_beg> and 1411Tries to make a selection as set by C<selection_beg> and
1196C<selection_end>. If C<$rectangular> is true (default: false), a 1412C<selection_end>. If C<$rectangular> is true (default: false), a
1197rectangular selection will be made. This is the prefered function to make 1413rectangular selection will be made. This is the preferred function to make
1198a selection. 1414a selection.
1199 1415
1200=item $success = $term->selection_grab ($eventtime) 1416=item $success = $term->selection_grab ($eventtime[, $clipboard])
1201 1417
1202Try to request the primary selection text from the server (for example, as 1418Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1419true) selection from the server. The corresponding text can be set
1203set by the next method). No visual feedback will be given. This function 1420with the next method. No visual feedback will be given. This function
1204is mostly useful from within C<on_sel_grab> hooks. 1421is mostly useful from within C<on_sel_grab> hooks.
1205 1422
1206=item $oldtext = $term->selection ([$newtext]) 1423=item $oldtext = $term->selection ([$newtext, $clipboard])
1207 1424
1208Return the current selection text and optionally replace it by C<$newtext>. 1425Return the current selection (clipboard if C<$clipboard> is true) text
1426and optionally replace it by C<$newtext>.
1427
1428=item $term->selection_clear ([$clipboard])
1429
1430Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1209 1431
1210=item $term->overlay_simple ($x, $y, $text) 1432=item $term->overlay_simple ($x, $y, $text)
1211 1433
1212Create a simple multi-line overlay box. See the next method for details. 1434Create a simple multi-line overlay box. See the next method for details.
1213 1435
1243 1465
1244The methods currently supported on C<urxvt::overlay> objects are: 1466The methods currently supported on C<urxvt::overlay> objects are:
1245 1467
1246=over 4 1468=over 4
1247 1469
1248=item $overlay->set ($x, $y, $text, $rend) 1470=item $overlay->set ($x, $y, $text[, $rend])
1249 1471
1250Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1472Similar 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 1473text in rxvt-unicode's special encoding and an array of rendition values
1252at a specific position inside the overlay. 1474at a specific position inside the overlay.
1475
1476If C<$rend> is missing, then the rendition will not be changed.
1253 1477
1254=item $overlay->hide 1478=item $overlay->hide
1255 1479
1256If visible, hide the overlay, but do not destroy it. 1480If visible, hide the overlay, but do not destroy it.
1257 1481
1339locale-specific encoding of the terminal and can contain command sequences 1563locale-specific encoding of the terminal and can contain command sequences
1340(escape codes) that will be interpreted. 1564(escape codes) that will be interpreted.
1341 1565
1342=item $term->tt_write ($octets) 1566=item $term->tt_write ($octets)
1343 1567
1344Write the octets given in C<$data> to the tty (i.e. as program input). To 1568Write 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 1569pass characters instead of octets, you should convert your strings first
1346to the locale-specific encoding using C<< $term->locale_encode >>. 1570to the locale-specific encoding using C<< $term->locale_encode >>.
1571
1572=item $term->tt_paste ($octets)
1573
1574Write the octets given in C<$octets> to the tty as a paste, converting NL to
1575CR and bracketing the data with control sequences if bracketed paste mode
1576is set.
1347 1577
1348=item $old_events = $term->pty_ev_events ([$new_events]) 1578=item $old_events = $term->pty_ev_events ([$new_events])
1349 1579
1350Replaces the event mask of the pty watcher by the given event mask. Can 1580Replaces 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 1581be 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 1600Adds the specified events to the vt event mask. Useful e.g. when you want
1371to receive pointer events all the times: 1601to receive pointer events all the times:
1372 1602
1373 $term->vt_emask_add (urxvt::PointerMotionMask); 1603 $term->vt_emask_add (urxvt::PointerMotionMask);
1374 1604
1605=item $term->focus_in
1606
1607=item $term->focus_out
1608
1609=item $term->key_press ($state, $keycode[, $time])
1610
1611=item $term->key_release ($state, $keycode[, $time])
1612
1613Deliver various fake events to to terminal.
1614
1375=item $window_width = $term->width 1615=item $window_width = $term->width
1376 1616
1377=item $window_height = $term->height 1617=item $window_height = $term->height
1378 1618
1379=item $font_width = $term->fwidth 1619=item $font_width = $term->fwidth
1409=item $env = $term->env 1649=item $env = $term->env
1410 1650
1411Returns a copy of the environment in effect for the terminal as a hashref 1651Returns a copy of the environment in effect for the terminal as a hashref
1412similar to C<\%ENV>. 1652similar to C<\%ENV>.
1413 1653
1654=item @envv = $term->envv
1655
1656Returns the environment as array of strings of the form C<VAR=VALUE>.
1657
1658=item @argv = $term->argv
1659
1660Return the argument vector as this terminal, similar to @ARGV, but
1661includes the program name as first element.
1662
1414=cut 1663=cut
1415 1664
1416sub env { 1665sub env {
1417 if (my $env = $_[0]->_env) {
1418 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1666 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1419 } else {
1420 +{ %ENV }
1421 }
1422} 1667}
1423 1668
1424=item $modifiermask = $term->ModLevel3Mask 1669=item $modifiermask = $term->ModLevel3Mask
1425 1670
1426=item $modifiermask = $term->ModMetaMask 1671=item $modifiermask = $term->ModMetaMask
1434 1679
1435Returns the currently displayed screen (0 primary, 1 secondary). 1680Returns the currently displayed screen (0 primary, 1 secondary).
1436 1681
1437=item $cursor_is_hidden = $term->hidden_cursor 1682=item $cursor_is_hidden = $term->hidden_cursor
1438 1683
1439Returns wether the cursor is currently hidden or not. 1684Returns whether the cursor is currently hidden or not.
1440 1685
1441=item $view_start = $term->view_start ([$newvalue]) 1686=item $view_start = $term->view_start ([$newvalue])
1442 1687
1443Returns the row number of the topmost displayed line. Maximum value is 1688Returns the row number of the topmost displayed line. Maximum value is
1444C<0>, which displays the normal terminal contents. Lower values scroll 1689C<0>, which displays the normal terminal contents. Lower values scroll
1452 1697
1453Used after changing terminal contents to display them. 1698Used after changing terminal contents to display them.
1454 1699
1455=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1700=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1456 1701
1457Returns the text of the entire row with number C<$row_number>. Row C<0> 1702Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1458is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1703is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1459terminal line. The scrollback buffer starts at line C<-1> and extends to
1460line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1704terminal line. Nothing will be returned if a nonexistent line
1461is requested. 1705is requested.
1462 1706
1463If C<$new_text> is specified, it will replace characters in the current 1707If C<$new_text> is specified, it will replace characters in the current
1464line, starting at column C<$start_col> (default C<0>), which is useful 1708line, starting at column C<$start_col> (default C<0>), which is useful
1465to replace only parts of a line. The font index in the rendition will 1709to replace only parts of a line. The font index in the rendition will
1466automatically be updated. 1710automatically be updated.
1467 1711
1468C<$text> is in a special encoding: tabs and wide characters that use more 1712C<$text> is in a special encoding: tabs and wide characters that use more
1469than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1713than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1470characters. Characters with combining characters and other characters that 1714characters. Characters with combining characters and other characters that
1471do not fit into the normal tetx encoding will be replaced with characters 1715do not fit into the normal text encoding will be replaced with characters
1472in the private use area. 1716in the private use area.
1473 1717
1474You have to obey this encoding when changing text. The advantage is 1718You have to obey this encoding when changing text. The advantage is
1475that C<substr> and similar functions work on screen cells and not on 1719that C<substr> and similar functions work on screen cells and not on
1476characters. 1720characters.
1621where one character corresponds to one screen cell. See 1865where one character corresponds to one screen cell. See
1622C<< $term->ROW_t >> for details. 1866C<< $term->ROW_t >> for details.
1623 1867
1624=item $string = $term->special_decode $text 1868=item $string = $term->special_decode $text
1625 1869
1626Converts rxvt-unicodes text reprsentation into a perl string. See 1870Converts rxvt-unicodes text representation into a perl string. See
1627C<< $term->ROW_t >> for details. 1871C<< $term->ROW_t >> for details.
1628 1872
1629=item $success = $term->grab_button ($button, $modifiermask) 1873=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1630 1874
1875=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1876
1631Registers a synchronous button grab. See the XGrabButton manpage. 1877Register/unregister a synchronous button grab. See the XGrabButton
1878manpage.
1632 1879
1633=item $success = $term->grab ($eventtime[, $sync]) 1880=item $success = $term->grab ($eventtime[, $sync])
1634 1881
1635Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1882Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1636synchronous (C<$sync> is true). Also remembers the grab timestampe. 1883synchronous (C<$sync> is true). Also remembers the grab timestamp.
1637 1884
1638=item $term->allow_events_async 1885=item $term->allow_events_async
1639 1886
1640Calls XAllowEvents with AsyncBoth for the most recent grab. 1887Calls XAllowEvents with AsyncBoth for the most recent grab.
1641 1888
1648Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1895Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1649recent grab. 1896recent grab.
1650 1897
1651=item $term->ungrab 1898=item $term->ungrab
1652 1899
1653Calls XUngrab for the most recent grab. Is called automatically on 1900Calls 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 1901evaluation errors, as it is better to lose the grab in the error case as
1655the session. 1902the session.
1656 1903
1657=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1904=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1658 1905
1660 1907
1661=item @atoms = $term->XListProperties ($window) 1908=item @atoms = $term->XListProperties ($window)
1662 1909
1663=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1910=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1664 1911
1665=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1912=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1666 1913
1667=item $term->XDeleteProperty ($window, $property) 1914=item $term->XDeleteProperty ($window, $property)
1668 1915
1669=item $window = $term->DefaultRootWindow 1916=item $window = $term->DefaultRootWindow
1670 1917
1680 1927
1681=item $term->XChangeInput ($window, $add_events[, $del_events]) 1928=item $term->XChangeInput ($window, $add_events[, $del_events])
1682 1929
1683Various X or X-related functions. The C<$term> object only serves as 1930Various X or X-related functions. The C<$term> object only serves as
1684the source of the display, otherwise those functions map more-or-less 1931the source of the display, otherwise those functions map more-or-less
1685directory onto the X functions of the same name. 1932directly onto the X functions of the same name.
1686 1933
1687=back 1934=back
1688 1935
1689=cut 1936=cut
1690 1937
1754 my ($self, $text, $cb) = @_; 2001 my ($self, $text, $cb) = @_;
1755 2002
1756 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2003 $self->add_item ({ type => "button", text => $text, activate => $cb});
1757} 2004}
1758 2005
1759=item $popup->add_toggle ($text, $cb, $initial_value) 2006=item $popup->add_toggle ($text, $initial_value, $cb)
1760 2007
1761Adds a toggle/checkbox item to the popup. Teh callback gets called 2008Adds a toggle/checkbox item to the popup. The callback gets called
1762whenever it gets toggled, with a boolean indicating its value as its first 2009whenever it gets toggled, with a boolean indicating its new value as its
1763argument. 2010first argument.
1764 2011
1765=cut 2012=cut
1766 2013
1767sub add_toggle { 2014sub add_toggle {
1768 my ($self, $text, $cb, $value) = @_; 2015 my ($self, $text, $value, $cb) = @_;
1769 2016
1770 my $item; $item = { 2017 my $item; $item = {
1771 type => "button", 2018 type => "button",
1772 text => " $text", 2019 text => " $text",
1773 value => $value, 2020 value => $value,
1792 my $env = $self->{term}->env; 2039 my $env = $self->{term}->env;
1793 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2040 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1794 delete $env->{LC_ALL}; 2041 delete $env->{LC_ALL};
1795 $env->{LC_CTYPE} = $self->{term}->locale; 2042 $env->{LC_CTYPE} = $self->{term}->locale;
1796 2043
1797 urxvt::term->new ($env, "popup", 2044 my $term = urxvt::term->new (
2045 $env, "popup",
1798 "--perl-lib" => "", "--perl-ext-common" => "", 2046 "--perl-lib" => "", "--perl-ext-common" => "",
1799 "-pty-fd" => -1, "-sl" => 0, 2047 "-pty-fd" => -1, "-sl" => 0,
1800 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2048 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1801 "--transient-for" => $self->{term}->parent, 2049 "--transient-for" => $self->{term}->parent,
1802 "-display" => $self->{term}->display_id, 2050 "-display" => $self->{term}->display_id,
1803 "-pe" => "urxvt-popup") 2051 "-pe" => "urxvt-popup",
1804 or die "unable to create popup window\n"; 2052 ) or die "unable to create popup window\n";
2053
2054 unless (delete $term->{urxvt_popup_init_done}) {
2055 $term->ungrab;
2056 $term->destroy;
2057 die "unable to initialise popup window\n";
2058 }
1805} 2059}
1806 2060
1807sub DESTROY { 2061sub DESTROY {
1808 my ($self) = @_; 2062 my ($self) = @_;
1809 2063
1814=back 2068=back
1815 2069
1816=cut 2070=cut
1817 2071
1818package urxvt::watcher; 2072package urxvt::watcher;
1819
1820@urxvt::timer::ISA = __PACKAGE__;
1821@urxvt::iow::ISA = __PACKAGE__;
1822@urxvt::pw::ISA = __PACKAGE__;
1823@urxvt::iw::ISA = __PACKAGE__;
1824 2073
1825=head2 The C<urxvt::timer> Class 2074=head2 The C<urxvt::timer> Class
1826 2075
1827This class implements timer watchers/events. Time is represented as a 2076This class implements timer watchers/events. Time is represented as a
1828fractional number of seconds since the epoch. Example: 2077fractional number of seconds since the epoch. Example:
1832 ->new 2081 ->new
1833 ->interval (1) 2082 ->interval (1)
1834 ->cb (sub { 2083 ->cb (sub {
1835 $term->{overlay}->set (0, 0, 2084 $term->{overlay}->set (0, 0,
1836 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2085 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1837 }); 2086 });
1838 2087
1839=over 4 2088=over 4
1840 2089
1841=item $timer = new urxvt::timer 2090=item $timer = new urxvt::timer
1842 2091
1845 2094
1846=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2095=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1847 2096
1848Set the callback to be called when the timer triggers. 2097Set the callback to be called when the timer triggers.
1849 2098
1850=item $tstamp = $timer->at
1851
1852Return the time this watcher will fire next.
1853
1854=item $timer = $timer->set ($tstamp) 2099=item $timer = $timer->set ($tstamp[, $interval])
1855 2100
1856Set the time the event is generated to $tstamp. 2101Set the time the event is generated to $tstamp (and optionally specifies a
2102new $interval).
1857 2103
1858=item $timer = $timer->interval ($interval) 2104=item $timer = $timer->interval ($interval)
1859 2105
1860Normally (and when C<$interval> is C<0>), the timer will automatically 2106By 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 2107stop after it has fired once. If C<$interval> is non-zero, then the timer
1862is automatically rescheduled at the given intervals. 2108is automatically rescheduled at the given intervals.
1863 2109
1864=item $timer = $timer->start 2110=item $timer = $timer->start
1865 2111
1866Start the timer. 2112Start the timer.
1867 2113
1868=item $timer = $timer->start ($tstamp) 2114=item $timer = $timer->start ($tstamp[, $interval])
1869 2115
1870Set the event trigger time to C<$tstamp> and start the timer. 2116Set the event trigger time to C<$tstamp> and start the timer. Optionally
2117also replaces the interval.
1871 2118
1872=item $timer = $timer->after ($delay) 2119=item $timer = $timer->after ($delay[, $interval])
1873 2120
1874Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2121Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1875 2122
1876=item $timer = $timer->stop 2123=item $timer = $timer->stop
1877 2124
1885 2132
1886 $term->{socket} = ... 2133 $term->{socket} = ...
1887 $term->{iow} = urxvt::iow 2134 $term->{iow} = urxvt::iow
1888 ->new 2135 ->new
1889 ->fd (fileno $term->{socket}) 2136 ->fd (fileno $term->{socket})
1890 ->events (urxvt::EVENT_READ) 2137 ->events (urxvt::EV_READ)
1891 ->start 2138 ->start
1892 ->cb (sub { 2139 ->cb (sub {
1893 my ($iow, $revents) = @_; 2140 my ($iow, $revents) = @_;
1894 # $revents must be 1 here, no need to check 2141 # $revents must be 1 here, no need to check
1895 sysread $term->{socket}, my $buf, 8192 2142 sysread $term->{socket}, my $buf, 8192
1908Set the callback to be called when io events are triggered. C<$reventmask> 2155Set the callback to be called when io events are triggered. C<$reventmask>
1909is a bitset as described in the C<events> method. 2156is a bitset as described in the C<events> method.
1910 2157
1911=item $iow = $iow->fd ($fd) 2158=item $iow = $iow->fd ($fd)
1912 2159
1913Set the filedescriptor (not handle) to watch. 2160Set the file descriptor (not handle) to watch.
1914 2161
1915=item $iow = $iow->events ($eventmask) 2162=item $iow = $iow->events ($eventmask)
1916 2163
1917Set the event mask to watch. The only allowed values are 2164Set the event mask to watch. The only allowed values are
1918C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2165C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1919together, or C<urxvt::EVENT_NONE>. 2166together, or C<urxvt::EV_NONE>.
1920 2167
1921=item $iow = $iow->start 2168=item $iow = $iow->start
1922 2169
1923Start watching for requested events on the given handle. 2170Start watching for requested events on the given handle.
1924 2171
1925=item $iow = $iow->stop 2172=item $iow = $iow->stop
1926 2173
1927Stop watching for events on the given filehandle. 2174Stop watching for events on the given file handle.
1928 2175
1929=back 2176=back
1930 2177
1931=head2 The C<urxvt::iw> Class 2178=head2 The C<urxvt::iw> Class
1932 2179
1965 ->new 2212 ->new
1966 ->start ($pid) 2213 ->start ($pid)
1967 ->cb (sub { 2214 ->cb (sub {
1968 my ($pw, $exit_status) = @_; 2215 my ($pw, $exit_status) = @_;
1969 ... 2216 ...
1970 }); 2217 });
1971 2218
1972=over 4 2219=over 4
1973 2220
1974=item $pw = new urxvt::pw 2221=item $pw = new urxvt::pw
1975 2222
1979 2226
1980Set the callback to be called when the timer triggers. 2227Set the callback to be called when the timer triggers.
1981 2228
1982=item $pw = $timer->start ($pid) 2229=item $pw = $timer->start ($pid)
1983 2230
1984Tells the wqtcher to start watching for process C<$pid>. 2231Tells the watcher to start watching for process C<$pid>.
1985 2232
1986=item $pw = $pw->stop 2233=item $pw = $pw->stop
1987 2234
1988Stop the watcher. 2235Stop the watcher.
1989 2236
2002 2249
2003=item >= 3 - script loading and management 2250=item >= 3 - script loading and management
2004 2251
2005=item >=10 - all called hooks 2252=item >=10 - all called hooks
2006 2253
2007=item >=11 - hook reutrn values 2254=item >=11 - hook return values
2008 2255
2009=back 2256=back
2010 2257
2011=head1 AUTHOR 2258=head1 AUTHOR
2012 2259
2013 Marc Lehmann <pcg@goof.com> 2260 Marc Lehmann <schmorp@schmorp.de>
2014 http://software.schmorp.de/pkg/rxvt-unicode 2261 http://software.schmorp.de/pkg/rxvt-unicode
2015 2262
2016=cut 2263=cut
2017 2264
20181 22651
2266
2267# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines