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.134 by root, Sat Feb 11 02:31:13 2006 UTC vs.
Revision 1.204 by sf-exg, Mon Dec 5 12:52:57 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
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
109The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
110C<$self->{myoption}>: 113C<< $self->{myoption} >>:
111 114
112 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 }; 117 };
115 118
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It'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
127is 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.
128It 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
129string 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
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The 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
133the 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
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. 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>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. 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
152was 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
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 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.
155 164
156=item readline (enabled by default) 165=item readline (enabled by default)
157 166
158A support package that tries to make editing with readline easier. At the 167A support package that tries to make editing with readline easier. At
159moment, 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
160move 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
161cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
162for programs that correctly support wide characters). 171for programs that correctly support wide characters).
163 172
164To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
165 174
166=over 4 175=over 4
214the message into vi commands to load the file. 223the message into vi commands to load the file.
215 224
216=item tabbed 225=item tabbed
217 226
218This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
219is, 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
220displays 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
221button per tab. 230button per tab.
222 231
223Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
224B<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,
234 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
235 244
236See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid 245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237indices. 246indices.
238 247
239=item mark-urls 248=item matcher
240 249
241Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
242make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
243resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
244the 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
245 278
246=item xim-onthespot 279=item xim-onthespot
247 280
248This (experimental) perl extension implements OnTheSpot editing. It does 281This (experimental) perl extension implements OnTheSpot editing. It does
249not 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
250OnTheSpot 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
251kinput2. 284kinput2.
252 285
253You enable it by specifying this extension and a preedit style of 286You enable it by specifying this extension and a preedit style of
254C<OnTheSpot>, i.e.: 287C<OnTheSpot>, i.e.:
255 288
256 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257 290
258=item automove-background 291=item kuake<hotkey>
259 292
260This 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
261to 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
262a 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.
263 298
264 @@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.
265 315
266=item block-graphics-to-ascii 316=item block-graphics-to-ascii
267 317
268A 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
269by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
270similar-looking ascii character. 320similar-looking ascii character.
271 321
272=item digital-clock 322=item digital-clock
273 323
274Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
275 325
276=item remote-clipboard 326=item remote-clipboard
277 327
278Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
279selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
280selection somewhere and fetch it again. 330selection somewhere and fetch it again.
281 331
282We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
283means 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
284reads it. 334reads it.
293 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295 345
296=item selection-pastebin 346=item selection-pastebin
297 347
298This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
299textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
300not 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
301F</tmp> directly.). 351F</tmp> directly.).
302 352
303It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
320in the C<selection-pastebin-url> resource (again, the % is the placeholder 370in the C<selection-pastebin-url> resource (again, the % is the placeholder
321for the filename): 371for the filename):
322 372
323 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324 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
325=item example-refresh-hooks 394=item example-refresh-hooks
326 395
327Displays 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
328window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
329overlays 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.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
330 412
331=back 413=back
332 414
333=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
334 416
350 432
351=over 4 433=over 4
352 434
353=item $text 435=item $text
354 436
355Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
356always represents one screen cell. See L<ROW_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
357 439
358=item $string 440=item $string
359 441
360A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
364=item $octets 446=item $octets
365 447
366Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
367locale-specific way. 449locale-specific way.
368 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
369=back 457=back
370 458
371=head2 Extension Objects 459=head2 Extension Objects
372 460
373Very perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
374for each terminal and each extension and passed as the first parameter to 462for each terminal, and each terminal has its own set of extension objects,
375hooks. So extensions can use their C<$self> object without having to think 463which are passed as the first parameter to hooks. So extensions can use
376about other extensions, with the exception of methods and members that 464their C<$self> object without having to think about clashes with other
465extensions or other terminals, with the exception of methods and members
377begin with an underscore character C<_>: these are reserved for internal 466that begin with an underscore character C<_>: these are reserved for
378use. 467internal use.
379 468
380Although it isn't a C<urxvt::term> object, you can call all methods of the 469Although it isn't a C<urxvt::term> object, you can call all methods of the
381C<urxvt::term> class on this object. 470C<urxvt::term> class on this object.
382 471
383It has the following methods and data members: 472It has the following methods and data members:
404=head2 Hooks 493=head2 Hooks
405 494
406The following subroutines can be declared in extension files, and will be 495The following subroutines can be declared in extension files, and will be
407called whenever the relevant event happens. 496called whenever the relevant event happens.
408 497
409The first argument passed to them is an extension oject as described in 498The first argument passed to them is an extension object as described in
410the in the C<Extension Objects> section. 499the in the C<Extension Objects> section.
411 500
412B<All> of these hooks must return a boolean value. If any of the called 501B<All> of these hooks must return a boolean value. If any of the called
413hooks returns true, then the event counts as being I<consumed>, and the 502hooks returns true, then the event counts as being I<consumed>, and the
414relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
427place. 516place.
428 517
429=item on_start $term 518=item on_start $term
430 519
431Called at the very end of initialisation of a new terminal, just before 520Called at the very end of initialisation of a new terminal, just before
432trying to map (display) the toplevel and returning to the mainloop. 521trying to map (display) the toplevel and returning to the main loop.
433 522
434=item on_destroy $term 523=item on_destroy $term
435 524
436Called whenever something tries to destroy terminal, when the terminal is 525Called whenever something tries to destroy terminal, when the terminal is
437still fully functional (not for long, though). 526still fully functional (not for long, though).
464 553
465Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
466requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
467by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
468 557
469Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
470 559
471=item on_sel_extend $term 560=item on_sel_extend $term
472 561
473Called whenever the user tries to extend the selection (e.g. with a double 562Called whenever the user tries to extend the selection (e.g. with a double
474click) and is either supposed to return false (normal operation), or 563click) and is either supposed to return false (normal operation), or
475should extend the selection itelf and return true to suppress the built-in 564should extend the selection itself and return true to suppress the built-in
476processing. This can happen multiple times, as long as the callback 565processing. This can happen multiple times, as long as the callback
477returns true, it will be called on every further click by the user and is 566returns true, it will be called on every further click by the user and is
478supposed to enlarge the selection more and more, if possible. 567supposed to enlarge the selection more and more, if possible.
479 568
480See the F<selection> example extension. 569See the F<selection> example extension.
481 570
482=item on_view_change $term, $offset 571=item on_view_change $term, $offset
483 572
484Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
485scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
486show this many lines of scrollback. 575show this many lines of scrollback.
487 576
488=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
489 578
493 582
494It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 583It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
495$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 584$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
496number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
497 586
498=item on_osc_seq $term, $string 587=item on_osc_seq $term, $op, $args, $resp
588
589Called on every OSC sequence and can be used to suppress it or modify its
590behaviour. The default should be to return an empty list. A true value
591suppresses execution of the request completely. Make sure you don't get
592confused by recursive invocations when you output an OSC sequence within
593this callback.
594
595C<on_osc_seq_perl> should be used for new behaviour.
596
597=item on_osc_seq_perl $term, $args, $resp
499 598
500Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
502information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
503string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
504it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
505future. 604enforced in the future.
605
606For example, C<overlay-osc> uses this:
607
608 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_;
610
611 return unless $osc =~ s/^overlay;//;
612
613 ... process remaining $osc string
614 }
506 615
507Be careful not ever to trust (in a security sense) the data you receive, 616Be careful not ever to trust (in a security sense) the data you receive,
508as its source can not easily be controleld (e-mail content, messages from 617as its source can not easily be controlled (e-mail content, messages from
509other users on the same system etc.). 618other users on the same system etc.).
619
620For responses, C<$resp> contains the end-of-args separator used by the
621sender.
510 622
511=item on_add_lines $term, $string 623=item on_add_lines $term, $string
512 624
513Called whenever text is about to be output, with the text as argument. You 625Called whenever text is about to be output, with the text as argument. You
514can filter/change and output the text yourself by returning a true value 626can filter/change and output the text yourself by returning a true value
519=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
520 632
521Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
522suppress or filter tty input. 634suppress or filter tty input.
523 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
524=item on_line_update $term, $row 643=item on_line_update $term, $row
525 644
526Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
527screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
528that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
535later with the already-modified line (e.g. if unrelated parts change), so 654later with the already-modified line (e.g. if unrelated parts change), so
536you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
537 656
538=item on_refresh_begin $term 657=item on_refresh_begin $term
539 658
540Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
541or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
542restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
543code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
544 663
545=item on_refresh_end $term 664=item on_refresh_end $term
546 665
547Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
548 667
549=item on_user_command $term, $string 668=item on_user_command $term, $string
550 669
551Called whenever the a user-configured event is being activated (e.g. via 670Called whenever a user-configured event is being activated (e.g. via
552a C<perl:string> action bound to a key, see description of the B<keysym> 671a C<perl:string> action bound to a key, see description of the B<keysym>
553resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
554 673
555The event is simply the action string. This interface is assumed to change 674The event is simply the action string. This interface is assumed to change
556slightly in the future. 675slightly in the future.
557 676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
558=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
559 685
560Called just after the new window size has been calculcated, but before 686Called just after the new window size has been calculated, but before
561windows are actually being resized or hints are being set. If this hook 687windows are actually being resized or hints are being set. If this hook
562returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
563 689
564=item on_x_event $term, $event 690=item on_x_event $term, $event
565 691
566Called on every X event received on the vt window (and possibly other 692Called on every X event received on the vt window (and possibly other
567windows). Should only be used as a last resort. Most event structure 693windows). Should only be used as a last resort. Most event structure
568members are not passed. 694members are not passed.
569 695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
699
570=item on_focus_in $term 700=item on_focus_in $term
571 701
572Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
573does focus in processing. 703does focus in processing.
574 704
575=item on_focus_out $term 705=item on_focus_out $term
576 706
577Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
578focus out processing. 708focus out processing.
579 709
580=item on_configure_notify $term, $event 710=item on_configure_notify $term, $event
581 711
582=item on_property_notify $term, $event 712=item on_property_notify $term, $event
593 723
594=item on_map_notify $term, $event 724=item on_map_notify $term, $event
595 725
596=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
597 727
598Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
599the hook returns true, then the even will be ignored by rxvt-unicode. 729the hook returns true, then the event will be ignored by rxvt-unicode.
600 730
601The event is a hash with most values as named by Xlib (see the XEvent 731The event is a hash with most values as named by Xlib (see the XEvent
602manpage), with the additional members C<row> and C<col>, which are the 732manpage), with the additional members C<row> and C<col>, which are the
603(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
604 734
613 743
614=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
615 745
616Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
617format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
748
749=item on_bell $term
750
751Called on receipt of a bell character.
618 752
619=back 753=back
620 754
621=cut 755=cut
622 756
665The current terminal. This variable stores the current C<urxvt::term> 799The current terminal. This variable stores the current C<urxvt::term>
666object, whenever a callback/hook is executing. 800object, whenever a callback/hook is executing.
667 801
668=item @urxvt::TERM_INIT 802=item @urxvt::TERM_INIT
669 803
670All coderefs in this array will be called as methods of the next newly 804All code references in this array will be called as methods of the next newly
671created C<urxvt::term> object (during the C<on_init> phase). The array 805created C<urxvt::term> object (during the C<on_init> phase). The array
672gets cleared before the codereferences that were in it are being executed, 806gets cleared before the code references that were in it are being executed,
673so coderefs can push themselves onto it again if they so desire. 807so references can push themselves onto it again if they so desire.
674 808
675This complements to the perl-eval commandline option, but gets executed 809This complements to the perl-eval command line option, but gets executed
676first. 810first.
677 811
678=item @urxvt::TERM_EXT 812=item @urxvt::TERM_EXT
679 813
680Works similar to C<@TERM_INIT>, but contains perl package/class names, which 814Works similar to C<@TERM_INIT>, but contains perl package/class names, which
687 821
688=over 4 822=over 4
689 823
690=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
691 825
692Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
693costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
694starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
695 830
696=item urxvt::warn $string 831=item urxvt::warn $string
697 832
698Calls C<rxvt_warn> with the given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
699newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
700that calls this function. 835that calls this function.
701 836
702Using this function has the advantage that its output ends up in the 837Using this function has the advantage that its output ends up in the
703correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
705Messages have a size limit of 1023 bytes currently. 840Messages have a size limit of 1023 bytes currently.
706 841
707=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
708 843
709Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
710wether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
711objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
712is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
713 848
714=item $time = urxvt::NOW 849=item $time = urxvt::NOW
715 850
716Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
717 852
760 895
761=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
762 897
763Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
764 899
765=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
766 902
767Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
768underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
769the bitset. 905the bitset.
770 906
852sub invoke { 988sub invoke {
853 local $TERM = shift; 989 local $TERM = shift;
854 my $htype = shift; 990 my $htype = shift;
855 991
856 if ($htype == 0) { # INIT 992 if ($htype == 0) { # INIT
857 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 993 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
858 994
859 my %ext_arg; 995 my %ext_arg;
860 996
861 { 997 {
862 my @init = @TERM_INIT; 998 my @init = @TERM_INIT;
863 @TERM_INIT = (); 999 @TERM_INIT = ();
897 1033
898 if (my $cb = $TERM->{_hook}[$htype]) { 1034 if (my $cb = $TERM->{_hook}[$htype]) {
899 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1035 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
900 if $verbosity >= 10; 1036 if $verbosity >= 10;
901 1037
902 keys %$cb; 1038 for my $pkg (keys %$cb) {
903
904 while (my ($pkg, $cb) = each %$cb) {
905 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1039 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
906 $retval ||= $retval_; 1040 $retval ||= $retval_;
907 1041
908 if ($@) { 1042 if ($@) {
909 $TERM->ungrab; # better to lose the grab than the session 1043 $TERM->ungrab; # better to lose the grab than the session
910 warn $@; 1044 warn $@;
926 $retval 1060 $retval
927} 1061}
928 1062
929sub SET_COLOR($$$) { 1063sub SET_COLOR($$$) {
930 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1064 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1065}
1066
1067sub rend2mask {
1068 no strict 'refs';
1069 my ($str, $mask) = (@_, 0);
1070 my %color = ( fg => undef, bg => undef );
1071 my @failed;
1072 for my $spec ( split /\s+/, $str ) {
1073 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1074 $color{lc($1)} = $2;
1075 } else {
1076 my $neg = $spec =~ s/^[-^]//;
1077 unless ( exists &{"RS_$spec"} ) {
1078 push @failed, $spec;
1079 next;
1080 }
1081 my $cur = &{"RS_$spec"};
1082 if ( $neg ) {
1083 $mask &= ~$cur;
1084 } else {
1085 $mask |= $cur;
1086 }
1087 }
1088 }
1089 ($mask, @color{qw(fg bg)}, \@failed)
931} 1090}
932 1091
933# urxvt::term::extension 1092# urxvt::term::extension
934 1093
935package urxvt::term::extension; 1094package urxvt::term::extension;
1006is that you cannot use blocking APIs, but the non-blocking variant should 1165is that you cannot use blocking APIs, but the non-blocking variant should
1007work. 1166work.
1008 1167
1009=cut 1168=cut
1010 1169
1011our $VERSION = 1; 1170our $VERSION = '5.23';
1012 1171
1013$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1172$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1014push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1173push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1015 1174
1016sub timer { 1175sub timer {
1018 1177
1019 my $cb = $arg{cb}; 1178 my $cb = $arg{cb};
1020 1179
1021 urxvt::timer 1180 urxvt::timer
1022 ->new 1181 ->new
1023 ->start (urxvt::NOW + $arg{after}) 1182 ->after ($arg{after}, $arg{interval})
1024 ->cb (sub { 1183 ->cb ($arg{interval} ? $cb : sub {
1025 $_[0]->stop; # need to cancel manually 1184 $_[0]->stop; # need to cancel manually
1026 $cb->(); 1185 $cb->();
1027 }) 1186 })
1028} 1187}
1029 1188
1030sub io { 1189sub io {
1031 my ($class, %arg) = @_; 1190 my ($class, %arg) = @_;
1032 1191
1033 my $cb = $arg{cb}; 1192 my $cb = $arg{cb};
1193 my $fd = fileno $arg{fh};
1194 defined $fd or $fd = $arg{fh};
1034 1195
1035 bless [$arg{fh}, urxvt::iow 1196 bless [$arg{fh}, urxvt::iow
1036 ->new 1197 ->new
1037 ->fd (fileno $arg{fh}) 1198 ->fd ($fd)
1038 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1199 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1039 | ($arg{poll} =~ /w/ ? 2 : 0)) 1200 | ($arg{poll} =~ /w/ ? 2 : 0))
1040 ->start 1201 ->start
1041 ->cb (sub { 1202 ->cb ($cb)
1042 $cb->(($_[1] & 1 ? 'r' : '')
1043 . ($_[1] & 2 ? 'w' : ''));
1044 })],
1045 urxvt::anyevent:: 1203 ], urxvt::anyevent::
1204}
1205
1206sub idle {
1207 my ($class, %arg) = @_;
1208
1209 my $cb = $arg{cb};
1210
1211 urxvt::iw
1212 ->new
1213 ->start
1214 ->cb ($cb)
1215}
1216
1217sub child {
1218 my ($class, %arg) = @_;
1219
1220 my $cb = $arg{cb};
1221
1222 urxvt::pw
1223 ->new
1224 ->start ($arg{pid})
1225 ->cb (sub {
1226 $_[0]->stop; # need to cancel manually
1227 $cb->($_[0]->rpid, $_[0]->rstatus);
1228 })
1046} 1229}
1047 1230
1048sub DESTROY { 1231sub DESTROY {
1049 $_[0][1]->stop; 1232 $_[0][1]->stop;
1050} 1233}
1051 1234
1052sub condvar { 1235# only needed for AnyEvent < 6 compatibility
1053 bless \my $flag, urxvt::anyevent::condvar:: 1236sub one_event {
1054}
1055
1056sub urxvt::anyevent::condvar::broadcast {
1057 ${$_[0]}++;
1058}
1059
1060sub urxvt::anyevent::condvar::wait {
1061 unless (${$_[0]}) {
1062 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1237 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1063 }
1064} 1238}
1065 1239
1066package urxvt::term; 1240package urxvt::term;
1067 1241
1068=head2 The C<urxvt::term> Class 1242=head2 The C<urxvt::term> Class
1155 1329
1156Returns true if the option specified by C<$optval> is enabled, and 1330Returns true if the option specified by C<$optval> is enabled, and
1157optionally change it. All option values are stored by name in the hash 1331optionally change it. All option values are stored by name in the hash
1158C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1332C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1159 1333
1160Here is a a likely non-exhaustive list of option names, please see the 1334Here is a likely non-exhaustive list of option names, please see the
1161source file F</src/optinc.h> to see the actual list: 1335source file F</src/optinc.h> to see the actual list:
1162 1336
1163 borderLess console cursorBlink cursorUnderline hold iconic insecure 1337 borderLess buffered console cursorBlink cursorUnderline hold iconic
1164 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1338 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1165 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1339 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1166 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1340 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1167 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1341 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1168 transparent tripleclickwords utmpInhibit visualBell 1342 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1343 urgentOnBell utmpInhibit visualBell
1169 1344
1170=item $value = $term->resource ($name[, $newval]) 1345=item $value = $term->resource ($name[, $newval])
1171 1346
1172Returns the current resource value associated with a given name and 1347Returns the current resource value associated with a given name and
1173optionally sets a new value. Setting values is most useful in the C<init> 1348optionally sets a new value. Setting values is most useful in the C<init>
1182likely change). 1357likely change).
1183 1358
1184Please note that resource strings will currently only be freed when the 1359Please note that resource strings will currently only be freed when the
1185terminal is destroyed, so changing options frequently will eat memory. 1360terminal is destroyed, so changing options frequently will eat memory.
1186 1361
1187Here is a a likely non-exhaustive list of resource names, not all of which 1362Here is a likely non-exhaustive list of resource names, not all of which
1188are supported in every build, please see the source file F</src/rsinc.h> 1363are supported in every build, please see the source file F</src/rsinc.h>
1189to see the actual list: 1364to see the actual list:
1190 1365
1191 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1366 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1192 borderLess color cursorBlink cursorUnderline cutchars delete_key 1367 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1193 display_name embed ext_bwidth fade font geometry hold iconName 1368 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1194 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1369 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1370 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1195 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1371 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1196 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1372 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1197 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1373 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1198 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1374 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1199 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1375 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1200 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1376 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1201 secondaryScreen secondaryScroll selectstyle shade term_name title 1377 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1202 transient_for transparent transparent_all tripleclickwords utmpInhibit 1378 term_name title transient_for transparent tripleclickwords urgentOnBell
1203 visualBell 1379 utmpInhibit visualBell
1204 1380
1205=cut 1381=cut
1206 1382
1207sub resource($$;$) { 1383sub resource($$;$) {
1208 my ($self, $name) = (shift, shift); 1384 my ($self, $name) = (shift, shift);
1209 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1385 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1210 &urxvt::term::_resource 1386 goto &urxvt::term::_resource
1211} 1387}
1212 1388
1213=item $value = $term->x_resource ($pattern) 1389=item $value = $term->x_resource ($pattern)
1214 1390
1215Returns the X-Resource for the given pattern, excluding the program or 1391Returns the X-Resource for the given pattern, excluding the program or
1219 1395
1220This method should only be called during the C<on_start> hook, as there is 1396This method should only be called during the C<on_start> hook, as there is
1221only one resource database per display, and later invocations might return 1397only one resource database per display, and later invocations might return
1222the wrong resources. 1398the wrong resources.
1223 1399
1224=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1400=item $success = $term->parse_keysym ($key, $octets)
1225 1401
1226Adds a keymap translation exactly as specified via a resource. See the 1402Adds a key binding exactly as specified via a resource. See the
1227C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1403C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1404
1405=item $term->register_command ($keysym, $modifiermask, $string)
1406
1407Adds a key binding. This is a lower level api compared to
1408C<parse_keysym>, as it expects a parsed key description, and can be
1409used only inside either the C<on_init> hook, to add a binding, or the
1410C<on_register_command> hook, to modify a parsed binding.
1228 1411
1229=item $rend = $term->rstyle ([$new_rstyle]) 1412=item $rend = $term->rstyle ([$new_rstyle])
1230 1413
1231Return and optionally change the current rendition. Text that is output by 1414Return and optionally change the current rendition. Text that is output by
1232the terminal application will use this style. 1415the terminal application will use this style.
1240 1423
1241=item ($row, $col) = $term->selection_beg ([$row, $col]) 1424=item ($row, $col) = $term->selection_beg ([$row, $col])
1242 1425
1243=item ($row, $col) = $term->selection_end ([$row, $col]) 1426=item ($row, $col) = $term->selection_end ([$row, $col])
1244 1427
1245Return the current values of the selection mark, begin or end positions, 1428Return the current values of the selection mark, begin or end positions.
1246and optionally set them to new values. 1429
1430When arguments are given, then the selection coordinates are set to
1431C<$row> and C<$col>, and the selection screen is set to the current
1432screen.
1433
1434=item $screen = $term->selection_screen ([$screen])
1435
1436Returns the current selection screen, and then optionally sets it.
1247 1437
1248=item $term->selection_make ($eventtime[, $rectangular]) 1438=item $term->selection_make ($eventtime[, $rectangular])
1249 1439
1250Tries to make a selection as set by C<selection_beg> and 1440Tries to make a selection as set by C<selection_beg> and
1251C<selection_end>. If C<$rectangular> is true (default: false), a 1441C<selection_end>. If C<$rectangular> is true (default: false), a
1252rectangular selection will be made. This is the prefered function to make 1442rectangular selection will be made. This is the preferred function to make
1253a selection. 1443a selection.
1254 1444
1255=item $success = $term->selection_grab ($eventtime) 1445=item $success = $term->selection_grab ($eventtime[, $clipboard])
1256 1446
1257Try to request the primary selection text from the server (for example, as 1447Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1448true) selection from the server. The corresponding text can be set
1258set by the next method). No visual feedback will be given. This function 1449with the next method. No visual feedback will be given. This function
1259is mostly useful from within C<on_sel_grab> hooks. 1450is mostly useful from within C<on_sel_grab> hooks.
1260 1451
1261=item $oldtext = $term->selection ([$newtext]) 1452=item $oldtext = $term->selection ([$newtext, $clipboard])
1262 1453
1263Return the current selection text and optionally replace it by C<$newtext>. 1454Return the current selection (clipboard if C<$clipboard> is true) text
1455and optionally replace it by C<$newtext>.
1456
1457=item $term->selection_clear ([$clipboard])
1458
1459Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1264 1460
1265=item $term->overlay_simple ($x, $y, $text) 1461=item $term->overlay_simple ($x, $y, $text)
1266 1462
1267Create a simple multi-line overlay box. See the next method for details. 1463Create a simple multi-line overlay box. See the next method for details.
1268 1464
1298 1494
1299The methods currently supported on C<urxvt::overlay> objects are: 1495The methods currently supported on C<urxvt::overlay> objects are:
1300 1496
1301=over 4 1497=over 4
1302 1498
1303=item $overlay->set ($x, $y, $text, $rend) 1499=item $overlay->set ($x, $y, $text[, $rend])
1304 1500
1305Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1501Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1306text in rxvt-unicode's special encoding and an array of rendition values 1502text in rxvt-unicode's special encoding and an array of rendition values
1307at a specific position inside the overlay. 1503at a specific position inside the overlay.
1504
1505If C<$rend> is missing, then the rendition will not be changed.
1308 1506
1309=item $overlay->hide 1507=item $overlay->hide
1310 1508
1311If visible, hide the overlay, but do not destroy it. 1509If visible, hide the overlay, but do not destroy it.
1312 1510
1394locale-specific encoding of the terminal and can contain command sequences 1592locale-specific encoding of the terminal and can contain command sequences
1395(escape codes) that will be interpreted. 1593(escape codes) that will be interpreted.
1396 1594
1397=item $term->tt_write ($octets) 1595=item $term->tt_write ($octets)
1398 1596
1399Write the octets given in C<$data> to the tty (i.e. as program input). To 1597Write the octets given in C<$octets> to the tty (i.e. as program input). To
1400pass characters instead of octets, you should convert your strings first 1598pass characters instead of octets, you should convert your strings first
1401to the locale-specific encoding using C<< $term->locale_encode >>. 1599to the locale-specific encoding using C<< $term->locale_encode >>.
1600
1601=item $term->tt_paste ($octets)
1602
1603Write the octets given in C<$octets> to the tty as a paste, converting NL to
1604CR and bracketing the data with control sequences if bracketed paste mode
1605is set.
1402 1606
1403=item $old_events = $term->pty_ev_events ([$new_events]) 1607=item $old_events = $term->pty_ev_events ([$new_events])
1404 1608
1405Replaces the event mask of the pty watcher by the given event mask. Can 1609Replaces the event mask of the pty watcher by the given event mask. Can
1406be used to suppress input and output handling to the pty/tty. See the 1610be used to suppress input and output handling to the pty/tty. See the
1425Adds the specified events to the vt event mask. Useful e.g. when you want 1629Adds the specified events to the vt event mask. Useful e.g. when you want
1426to receive pointer events all the times: 1630to receive pointer events all the times:
1427 1631
1428 $term->vt_emask_add (urxvt::PointerMotionMask); 1632 $term->vt_emask_add (urxvt::PointerMotionMask);
1429 1633
1634=item $term->set_urgency ($set)
1635
1636Enable/disable the urgency hint on the toplevel window.
1637
1430=item $term->focus_in 1638=item $term->focus_in
1431 1639
1432=item $term->focus_out 1640=item $term->focus_out
1433 1641
1434=item $term->key_press ($state, $keycode[, $time]) 1642=item $term->key_press ($state, $keycode[, $time])
1474=item $env = $term->env 1682=item $env = $term->env
1475 1683
1476Returns a copy of the environment in effect for the terminal as a hashref 1684Returns a copy of the environment in effect for the terminal as a hashref
1477similar to C<\%ENV>. 1685similar to C<\%ENV>.
1478 1686
1687=item @envv = $term->envv
1688
1689Returns the environment as array of strings of the form C<VAR=VALUE>.
1690
1691=item @argv = $term->argv
1692
1693Return the argument vector as this terminal, similar to @ARGV, but
1694includes the program name as first element.
1695
1479=cut 1696=cut
1480 1697
1481sub env { 1698sub env {
1482 if (my $env = $_[0]->_env) {
1483 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1699 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1484 } else {
1485 +{ %ENV }
1486 }
1487} 1700}
1488 1701
1489=item $modifiermask = $term->ModLevel3Mask 1702=item $modifiermask = $term->ModLevel3Mask
1490 1703
1491=item $modifiermask = $term->ModMetaMask 1704=item $modifiermask = $term->ModMetaMask
1499 1712
1500Returns the currently displayed screen (0 primary, 1 secondary). 1713Returns the currently displayed screen (0 primary, 1 secondary).
1501 1714
1502=item $cursor_is_hidden = $term->hidden_cursor 1715=item $cursor_is_hidden = $term->hidden_cursor
1503 1716
1504Returns wether the cursor is currently hidden or not. 1717Returns whether the cursor is currently hidden or not.
1505 1718
1506=item $view_start = $term->view_start ([$newvalue]) 1719=item $view_start = $term->view_start ([$newvalue])
1507 1720
1508Returns the row number of the topmost displayed line. Maximum value is 1721Returns the row number of the topmost displayed line. Maximum value is
1509C<0>, which displays the normal terminal contents. Lower values scroll 1722C<0>, which displays the normal terminal contents. Lower values scroll
1517 1730
1518Used after changing terminal contents to display them. 1731Used after changing terminal contents to display them.
1519 1732
1520=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1733=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1521 1734
1522Returns the text of the entire row with number C<$row_number>. Row C<0> 1735Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1523is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1736is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1524terminal line. The scrollback buffer starts at line C<-1> and extends to
1525line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1737terminal line. Nothing will be returned if a nonexistent line
1526is requested. 1738is requested.
1527 1739
1528If C<$new_text> is specified, it will replace characters in the current 1740If C<$new_text> is specified, it will replace characters in the current
1529line, starting at column C<$start_col> (default C<0>), which is useful 1741line, starting at column C<$start_col> (default C<0>), which is useful
1530to replace only parts of a line. The font index in the rendition will 1742to replace only parts of a line. The font index in the rendition will
1531automatically be updated. 1743automatically be updated.
1532 1744
1533C<$text> is in a special encoding: tabs and wide characters that use more 1745C<$text> is in a special encoding: tabs and wide characters that use more
1534than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1746than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1535characters. Characters with combining characters and other characters that 1747characters. Characters with combining characters and other characters that
1536do not fit into the normal tetx encoding will be replaced with characters 1748do not fit into the normal text encoding will be replaced with characters
1537in the private use area. 1749in the private use area.
1538 1750
1539You have to obey this encoding when changing text. The advantage is 1751You have to obey this encoding when changing text. The advantage is
1540that C<substr> and similar functions work on screen cells and not on 1752that C<substr> and similar functions work on screen cells and not on
1541characters. 1753characters.
1686where one character corresponds to one screen cell. See 1898where one character corresponds to one screen cell. See
1687C<< $term->ROW_t >> for details. 1899C<< $term->ROW_t >> for details.
1688 1900
1689=item $string = $term->special_decode $text 1901=item $string = $term->special_decode $text
1690 1902
1691Converts rxvt-unicodes text reprsentation into a perl string. See 1903Converts rxvt-unicodes text representation into a perl string. See
1692C<< $term->ROW_t >> for details. 1904C<< $term->ROW_t >> for details.
1693 1905
1694=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1906=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1695 1907
1696=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1908=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1699manpage. 1911manpage.
1700 1912
1701=item $success = $term->grab ($eventtime[, $sync]) 1913=item $success = $term->grab ($eventtime[, $sync])
1702 1914
1703Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1915Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1704synchronous (C<$sync> is true). Also remembers the grab timestampe. 1916synchronous (C<$sync> is true). Also remembers the grab timestamp.
1705 1917
1706=item $term->allow_events_async 1918=item $term->allow_events_async
1707 1919
1708Calls XAllowEvents with AsyncBoth for the most recent grab. 1920Calls XAllowEvents with AsyncBoth for the most recent grab.
1709 1921
1716Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1928Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1717recent grab. 1929recent grab.
1718 1930
1719=item $term->ungrab 1931=item $term->ungrab
1720 1932
1721Calls XUngrab for the most recent grab. Is called automatically on 1933Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1722evaluation errors, as it is better to lose the grab in the error case as 1934evaluation errors, as it is better to lose the grab in the error case as
1723the session. 1935the session.
1724 1936
1725=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1937=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1726 1938
1728 1940
1729=item @atoms = $term->XListProperties ($window) 1941=item @atoms = $term->XListProperties ($window)
1730 1942
1731=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1943=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1732 1944
1733=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1945=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1734 1946
1735=item $term->XDeleteProperty ($window, $property) 1947=item $term->XDeleteProperty ($window, $property)
1736 1948
1737=item $window = $term->DefaultRootWindow 1949=item $window = $term->DefaultRootWindow
1738 1950
1745=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1957=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1746 1958
1747=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1959=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1748 1960
1749=item $term->XChangeInput ($window, $add_events[, $del_events]) 1961=item $term->XChangeInput ($window, $add_events[, $del_events])
1962
1963=item $keysym = $term->XStringToKeysym ($string)
1964
1965=item $string = $term->XKeysymToString ($keysym)
1750 1966
1751Various X or X-related functions. The C<$term> object only serves as 1967Various X or X-related functions. The C<$term> object only serves as
1752the source of the display, otherwise those functions map more-or-less 1968the source of the display, otherwise those functions map more-or-less
1753directory onto the X functions of the same name. 1969directly onto the X functions of the same name.
1754 1970
1755=back 1971=back
1756 1972
1757=cut 1973=cut
1758 1974
1860 my $env = $self->{term}->env; 2076 my $env = $self->{term}->env;
1861 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2077 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1862 delete $env->{LC_ALL}; 2078 delete $env->{LC_ALL};
1863 $env->{LC_CTYPE} = $self->{term}->locale; 2079 $env->{LC_CTYPE} = $self->{term}->locale;
1864 2080
1865 urxvt::term->new ($env, "popup", 2081 my $term = urxvt::term->new (
2082 $env, "popup",
1866 "--perl-lib" => "", "--perl-ext-common" => "", 2083 "--perl-lib" => "", "--perl-ext-common" => "",
1867 "-pty-fd" => -1, "-sl" => 0, 2084 "-pty-fd" => -1, "-sl" => 0,
1868 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2085 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1869 "--transient-for" => $self->{term}->parent, 2086 "--transient-for" => $self->{term}->parent,
1870 "-display" => $self->{term}->display_id, 2087 "-display" => $self->{term}->display_id,
1871 "-pe" => "urxvt-popup") 2088 "-pe" => "urxvt-popup",
1872 or die "unable to create popup window\n"; 2089 ) or die "unable to create popup window\n";
2090
2091 unless (delete $term->{urxvt_popup_init_done}) {
2092 $term->ungrab;
2093 $term->destroy;
2094 die "unable to initialise popup window\n";
2095 }
1873} 2096}
1874 2097
1875sub DESTROY { 2098sub DESTROY {
1876 my ($self) = @_; 2099 my ($self) = @_;
1877 2100
1882=back 2105=back
1883 2106
1884=cut 2107=cut
1885 2108
1886package urxvt::watcher; 2109package urxvt::watcher;
1887
1888@urxvt::timer::ISA = __PACKAGE__;
1889@urxvt::iow::ISA = __PACKAGE__;
1890@urxvt::pw::ISA = __PACKAGE__;
1891@urxvt::iw::ISA = __PACKAGE__;
1892 2110
1893=head2 The C<urxvt::timer> Class 2111=head2 The C<urxvt::timer> Class
1894 2112
1895This class implements timer watchers/events. Time is represented as a 2113This class implements timer watchers/events. Time is represented as a
1896fractional number of seconds since the epoch. Example: 2114fractional number of seconds since the epoch. Example:
1900 ->new 2118 ->new
1901 ->interval (1) 2119 ->interval (1)
1902 ->cb (sub { 2120 ->cb (sub {
1903 $term->{overlay}->set (0, 0, 2121 $term->{overlay}->set (0, 0,
1904 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2122 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1905 }); 2123 });
1906 2124
1907=over 4 2125=over 4
1908 2126
1909=item $timer = new urxvt::timer 2127=item $timer = new urxvt::timer
1910 2128
1913 2131
1914=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2132=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1915 2133
1916Set the callback to be called when the timer triggers. 2134Set the callback to be called when the timer triggers.
1917 2135
1918=item $tstamp = $timer->at
1919
1920Return the time this watcher will fire next.
1921
1922=item $timer = $timer->set ($tstamp) 2136=item $timer = $timer->set ($tstamp[, $interval])
1923 2137
1924Set the time the event is generated to $tstamp. 2138Set the time the event is generated to $tstamp (and optionally specifies a
2139new $interval).
1925 2140
1926=item $timer = $timer->interval ($interval) 2141=item $timer = $timer->interval ($interval)
1927 2142
1928Normally (and when C<$interval> is C<0>), the timer will automatically 2143By default (and when C<$interval> is C<0>), the timer will automatically
1929stop after it has fired once. If C<$interval> is non-zero, then the timer 2144stop after it has fired once. If C<$interval> is non-zero, then the timer
1930is automatically rescheduled at the given intervals. 2145is automatically rescheduled at the given intervals.
1931 2146
1932=item $timer = $timer->start 2147=item $timer = $timer->start
1933 2148
1934Start the timer. 2149Start the timer.
1935 2150
1936=item $timer = $timer->start ($tstamp) 2151=item $timer = $timer->start ($tstamp[, $interval])
1937 2152
1938Set the event trigger time to C<$tstamp> and start the timer. 2153Set the event trigger time to C<$tstamp> and start the timer. Optionally
2154also replaces the interval.
1939 2155
1940=item $timer = $timer->after ($delay) 2156=item $timer = $timer->after ($delay[, $interval])
1941 2157
1942Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2158Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1943 2159
1944=item $timer = $timer->stop 2160=item $timer = $timer->stop
1945 2161
1953 2169
1954 $term->{socket} = ... 2170 $term->{socket} = ...
1955 $term->{iow} = urxvt::iow 2171 $term->{iow} = urxvt::iow
1956 ->new 2172 ->new
1957 ->fd (fileno $term->{socket}) 2173 ->fd (fileno $term->{socket})
1958 ->events (urxvt::EVENT_READ) 2174 ->events (urxvt::EV_READ)
1959 ->start 2175 ->start
1960 ->cb (sub { 2176 ->cb (sub {
1961 my ($iow, $revents) = @_; 2177 my ($iow, $revents) = @_;
1962 # $revents must be 1 here, no need to check 2178 # $revents must be 1 here, no need to check
1963 sysread $term->{socket}, my $buf, 8192 2179 sysread $term->{socket}, my $buf, 8192
1976Set the callback to be called when io events are triggered. C<$reventmask> 2192Set the callback to be called when io events are triggered. C<$reventmask>
1977is a bitset as described in the C<events> method. 2193is a bitset as described in the C<events> method.
1978 2194
1979=item $iow = $iow->fd ($fd) 2195=item $iow = $iow->fd ($fd)
1980 2196
1981Set the filedescriptor (not handle) to watch. 2197Set the file descriptor (not handle) to watch.
1982 2198
1983=item $iow = $iow->events ($eventmask) 2199=item $iow = $iow->events ($eventmask)
1984 2200
1985Set the event mask to watch. The only allowed values are 2201Set the event mask to watch. The only allowed values are
1986C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2202C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1987together, or C<urxvt::EVENT_NONE>. 2203together, or C<urxvt::EV_NONE>.
1988 2204
1989=item $iow = $iow->start 2205=item $iow = $iow->start
1990 2206
1991Start watching for requested events on the given handle. 2207Start watching for requested events on the given handle.
1992 2208
1993=item $iow = $iow->stop 2209=item $iow = $iow->stop
1994 2210
1995Stop watching for events on the given filehandle. 2211Stop watching for events on the given file handle.
1996 2212
1997=back 2213=back
1998 2214
1999=head2 The C<urxvt::iw> Class 2215=head2 The C<urxvt::iw> Class
2000 2216
2033 ->new 2249 ->new
2034 ->start ($pid) 2250 ->start ($pid)
2035 ->cb (sub { 2251 ->cb (sub {
2036 my ($pw, $exit_status) = @_; 2252 my ($pw, $exit_status) = @_;
2037 ... 2253 ...
2038 }); 2254 });
2039 2255
2040=over 4 2256=over 4
2041 2257
2042=item $pw = new urxvt::pw 2258=item $pw = new urxvt::pw
2043 2259
2047 2263
2048Set the callback to be called when the timer triggers. 2264Set the callback to be called when the timer triggers.
2049 2265
2050=item $pw = $timer->start ($pid) 2266=item $pw = $timer->start ($pid)
2051 2267
2052Tells the wqtcher to start watching for process C<$pid>. 2268Tells the watcher to start watching for process C<$pid>.
2053 2269
2054=item $pw = $pw->stop 2270=item $pw = $pw->stop
2055 2271
2056Stop the watcher. 2272Stop the watcher.
2057 2273
2070 2286
2071=item >= 3 - script loading and management 2287=item >= 3 - script loading and management
2072 2288
2073=item >=10 - all called hooks 2289=item >=10 - all called hooks
2074 2290
2075=item >=11 - hook reutrn values 2291=item >=11 - hook return values
2076 2292
2077=back 2293=back
2078 2294
2079=head1 AUTHOR 2295=head1 AUTHOR
2080 2296
2081 Marc Lehmann <pcg@goof.com> 2297 Marc Lehmann <schmorp@schmorp.de>
2082 http://software.schmorp.de/pkg/rxvt-unicode 2298 http://software.schmorp.de/pkg/rxvt-unicode
2083 2299
2084=cut 2300=cut
2085 2301
20861 23021
2303
2304# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines