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.152 by tpope, Tue Jan 9 16:18:56 2007 UTC vs.
Revision 1.196 by sf-exg, Wed Jun 29 22:46:48 2011 UTC

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
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 whether 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.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
166move 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
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
256The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
260 263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
261Example configuration: 267Example configuration:
262 268
263 URxvt.perl-ext: default,matcher 269 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser 270 URxvt.urlLauncher: sensible-browser
265 URxvt.keysym.C-Delete: perl:matcher 271 URxvt.keysym.C-Delete: perl:matcher
270 276
271=item xim-onthespot 277=item xim-onthespot
272 278
273This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
274not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
275OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
276kinput2. 282kinput2.
277 283
278You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
279C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
280 286
288will show or hide itself. Another press of the accelerator key will hide 294will show or hide itself. Another press of the accelerator key will hide
289or show it again. 295or show it again.
290 296
291Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
292 298
293This is useful if you need a single terminal thats not using any desktop 299This is useful if you need a single terminal that is not using any desktop
294space most of the time but is quickly available at the press of a key. 300space most of the time but is quickly available at the press of a key.
295 301
296The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
297extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
298 304
299If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
300(fvwm can do it). 306(fvwm can do it).
301 307
302=item automove-background 308=item overlay-osc
303 309
304This is basically a very small extension that dynamically changes the 310This extension implements some OSC commands to display timed popups on the
305background pixmap offset to the window position, in effect creating the 311screen - useful for status displays from within scripts. You have to read
306same effect as pseudo transparency with a custom pixmap. No scaling is 312the sources for more info.
307supported in this mode. Example:
308
309 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310 313
311=item block-graphics-to-ascii 314=item block-graphics-to-ascii
312 315
313A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
314by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
319Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
320 323
321=item remote-clipboard 324=item remote-clipboard
322 325
323Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
324selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
325selection somewhere and fetch it again. 328selection somewhere and fetch it again.
326 329
327We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
328means that one command uploads the file to a remote server, and another 331means that one command uploads the file to a remote server, and another
329reads it. 332reads it.
338 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
339 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
340 343
341=item selection-pastebin 344=item selection-pastebin
342 345
343This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
344textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
345not currently secure for use in a multiuser environment as it writes to 348not currently secure for use in a multiuser environment as it writes to
346F</tmp> directly.). 349F</tmp> directly.).
347 350
348It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
367 370
368 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
369 372
370I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
371the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
372which works regardless of wether xrdb is used to parse the resource file 375which works regardless of whether xrdb is used to parse the resource file
373or not. 376or not.
377
378=item macosx-clipboard and macosx-clipboard-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
374 391
375=item example-refresh-hooks 392=item example-refresh-hooks
376 393
377Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
378window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
379overlays or changes. 396overlays or changes.
397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
380 402
381=back 403=back
382 404
383=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
384 406
400 422
401=over 4 423=over 4
402 424
403=item $text 425=item $text
404 426
405Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
406always represents one screen cell. See L<ROW_t> for a discussion of this format. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
407 429
408=item $string 430=item $string
409 431
410A perl text string, with an emphasis on I<text>. It can store all unicode 432A perl text string, with an emphasis on I<text>. It can store all unicode
419=back 441=back
420 442
421=head2 Extension Objects 443=head2 Extension Objects
422 444
423Every perl extension is a perl class. A separate perl object is created 445Every perl extension is a perl class. A separate perl object is created
424for each terminal, and each terminal has its own set of extenion objects, 446for each terminal, and each terminal has its own set of extension objects,
425which are passed as the first parameter to hooks. So extensions can use 447which are passed as the first parameter to hooks. So extensions can use
426their C<$self> object without having to think about clashes with other 448their C<$self> object without having to think about clashes with other
427extensions or other terminals, with the exception of methods and members 449extensions or other terminals, with the exception of methods and members
428that begin with an underscore character C<_>: these are reserved for 450that begin with an underscore character C<_>: these are reserved for
429internal use. 451internal use.
544 566
545It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 567It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
546$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 568$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
547number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
548 570
549=item on_osc_seq $term, $op, $args 571=item on_osc_seq $term, $op, $args, $resp
550 572
551Called on every OSC sequence and can be used to suppress it or modify its 573Called on every OSC sequence and can be used to suppress it or modify its
552behaviour. The default should be to return an empty list. A true value 574behaviour. The default should be to return an empty list. A true value
553suppresses execution of the request completely. Make sure you don't get 575suppresses execution of the request completely. Make sure you don't get
554confused by recursive invocations when you output an osc sequence within 576confused by recursive invocations when you output an OSC sequence within
555this callback. 577this callback.
556 578
557C<on_osc_seq_perl> should be used for new behaviour. 579C<on_osc_seq_perl> should be used for new behaviour.
558 580
559=item on_osc_seq_perl $term, $string 581=item on_osc_seq_perl $term, $args, $resp
560 582
561Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
562operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
563information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
564string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
565it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
566future. 588enforced in the future.
589
590For example, C<overlay-osc> uses this:
591
592 sub on_osc_seq_perl {
593 my ($self, $osc, $resp) = @_;
594
595 return unless $osc =~ s/^overlay;//;
596
597 ... process remaining $osc string
598 }
567 599
568Be careful not ever to trust (in a security sense) the data you receive, 600Be careful not ever to trust (in a security sense) the data you receive,
569as its source can not easily be controlled (e-mail content, messages from 601as its source can not easily be controlled (e-mail content, messages from
570other users on the same system etc.). 602other users on the same system etc.).
603
604For responses, C<$resp> contains the end-of-args separator used by the
605sender.
571 606
572=item on_add_lines $term, $string 607=item on_add_lines $term, $string
573 608
574Called whenever text is about to be output, with the text as argument. You 609Called whenever text is about to be output, with the text as argument. You
575can filter/change and output the text yourself by returning a true value 610can filter/change and output the text yourself by returning a true value
580=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
581 616
582Called whenever some data is written to the tty/pty and can be used to 617Called whenever some data is written to the tty/pty and can be used to
583suppress or filter tty input. 618suppress or filter tty input.
584 619
620=item on_tt_paste $term, $octets
621
622Called whenever text is about to be pasted, with the text as argument. You
623can filter/change and paste the text yourself by returning a true value
624and calling C<< $term->tt_paste >> yourself. C<$octets> is
625locale-encoded.
626
585=item on_line_update $term, $row 627=item on_line_update $term, $row
586 628
587Called whenever a line was updated or changed. Can be used to filter 629Called whenever a line was updated or changed. Can be used to filter
588screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
589that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
596later with the already-modified line (e.g. if unrelated parts change), so 638later with the already-modified line (e.g. if unrelated parts change), so
597you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
598 640
599=item on_refresh_begin $term 641=item on_refresh_begin $term
600 642
601Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
602or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
603restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
604code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
605 647
606=item on_refresh_end $term 648=item on_refresh_end $term
607 649
614resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
615 657
616The event is simply the action string. This interface is assumed to change 658The event is simply the action string. This interface is assumed to change
617slightly in the future. 659slightly in the future.
618 660
619=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
620 662
621Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
622windows are actually being resized or hints are being set. If this hook 664windows are actually being resized or hints are being set. If this hook
623returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
624 666
658 700
659=item on_map_notify $term, $event 701=item on_map_notify $term, $event
660 702
661=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
662 704
663Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
664the hook returns true, then the even will be ignored by rxvt-unicode. 706the hook returns true, then the event will be ignored by rxvt-unicode.
665 707
666The event is a hash with most values as named by Xlib (see the XEvent 708The event is a hash with most values as named by Xlib (see the XEvent
667manpage), with the additional members C<row> and C<col>, which are the 709manpage), with the additional members C<row> and C<col>, which are the
668(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
669 711
678 720
679=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
680 722
681Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
682format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 724format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
725
726=item on_bell $term
727
728Called on receipt of a bell character.
683 729
684=back 730=back
685 731
686=cut 732=cut
687 733
752 798
753=over 4 799=over 4
754 800
755=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
756 802
757Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
758costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
759starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
760 807
761=item urxvt::warn $string 808=item urxvt::warn $string
762 809
763Calls C<rxvt_warn> with the given string which should not include a 810Calls C<rxvt_warn> with the given string which should include a trailing
764newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
765that calls this function. 812that calls this function.
766 813
767Using this function has the advantage that its output ends up in the 814Using this function has the advantage that its output ends up in the
768correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
772=item @terms = urxvt::termlist 819=item @terms = urxvt::termlist
773 820
774Returns all urxvt::term objects that exist in this process, regardless of 821Returns all urxvt::term objects that exist in this process, regardless of
775whether they are started, being destroyed etc., so be careful. Only term 822whether they are started, being destroyed etc., so be careful. Only term
776objects that have perl extensions attached will be returned (because there 823objects that have perl extensions attached will be returned (because there
777is no urxvt::term objet associated with others). 824is no urxvt::term object associated with others).
778 825
779=item $time = urxvt::NOW 826=item $time = urxvt::NOW
780 827
781Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
782 829
825 872
826=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
827 874
828Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
829 876
830=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 877=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
878urxvt::RS_RVid, urxvt::RS_Uline
831 879
832Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
833underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
834the bitset. 882the bitset.
835 883
918 local $TERM = shift; 966 local $TERM = shift;
919 my $htype = shift; 967 my $htype = shift;
920 968
921 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
922 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
923 971
924 my %ext_arg; 972 my %ext_arg;
925 973
926 { 974 {
927 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
928 @TERM_INIT = (); 976 @TERM_INIT = ();
1094is that you cannot use blocking APIs, but the non-blocking variant should 1142is that you cannot use blocking APIs, but the non-blocking variant should
1095work. 1143work.
1096 1144
1097=cut 1145=cut
1098 1146
1099our $VERSION = 1; 1147our $VERSION = '5.23';
1100 1148
1101$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1102push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1103 1151
1104sub timer { 1152sub timer {
1106 1154
1107 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1108 1156
1109 urxvt::timer 1157 urxvt::timer
1110 ->new 1158 ->new
1111 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
1112 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
1113 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
1114 $cb->(); 1162 $cb->();
1115 }) 1163 })
1116} 1164}
1117 1165
1118sub io { 1166sub io {
1119 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
1120 1168
1121 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
1122 1172
1123 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
1124 ->new 1174 ->new
1125 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
1126 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1127 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
1128 ->start 1178 ->start
1129 ->cb (sub { 1179 ->cb ($cb)
1130 $cb->(($_[1] & 1 ? 'r' : '')
1131 . ($_[1] & 2 ? 'w' : ''));
1132 })],
1133 urxvt::anyevent:: 1180 ], urxvt::anyevent::
1181}
1182
1183sub idle {
1184 my ($class, %arg) = @_;
1185
1186 my $cb = $arg{cb};
1187
1188 urxvt::iw
1189 ->new
1190 ->start
1191 ->cb ($cb)
1192}
1193
1194sub child {
1195 my ($class, %arg) = @_;
1196
1197 my $cb = $arg{cb};
1198
1199 urxvt::pw
1200 ->new
1201 ->start ($arg{pid})
1202 ->cb (sub {
1203 $_[0]->stop; # need to cancel manually
1204 $cb->($_[0]->rpid, $_[0]->rstatus);
1205 })
1134} 1206}
1135 1207
1136sub DESTROY { 1208sub DESTROY {
1137 $_[0][1]->stop; 1209 $_[0][1]->stop;
1138}
1139
1140sub condvar {
1141 bless \my $flag, urxvt::anyevent::
1142}
1143
1144sub broadcast {
1145 ${$_[0]}++;
1146}
1147
1148sub wait {
1149 unless (${$_[0]}) {
1150 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1151 }
1152} 1210}
1153 1211
1154sub one_event { 1212sub one_event {
1155 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1156} 1214}
1250C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1308C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1251 1309
1252Here is a likely non-exhaustive list of option names, please see the 1310Here is a likely non-exhaustive list of option names, please see the
1253source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1254 1312
1255 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess buffered console cursorBlink cursorUnderline hold iconic
1256 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1257 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1258 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1259 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1260 transparent tripleclickwords utmpInhibit visualBell 1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell
1261 1320
1262=item $value = $term->resource ($name[, $newval]) 1321=item $value = $term->resource ($name[, $newval])
1263 1322
1264Returns the current resource value associated with a given name and 1323Returns the current resource value associated with a given name and
1265optionally sets a new value. Setting values is most useful in the C<init> 1324optionally sets a new value. Setting values is most useful in the C<init>
1278 1337
1279Here is a likely non-exhaustive list of resource names, not all of which 1338Here is a likely non-exhaustive list of resource names, not all of which
1280are supported in every build, please see the source file F</src/rsinc.h> 1339are supported in every build, please see the source file F</src/rsinc.h>
1281to see the actual list: 1340to see the actual list:
1282 1341
1283 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1342 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1284 borderLess color cursorBlink cursorUnderline cutchars delete_key 1343 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1285 display_name embed ext_bwidth fade font geometry hold iconName 1344 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1286 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1345 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1346 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1287 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1347 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1288 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1348 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1289 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1349 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1290 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1350 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1291 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1351 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1292 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1352 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1293 secondaryScreen secondaryScroll selectstyle shade term_name title 1353 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1294 transient_for transparent transparent_all tripleclickwords utmpInhibit 1354 term_name title transient_for transparent tripleclickwords urgentOnBell
1295 visualBell 1355 utmpInhibit visualBell
1296 1356
1297=cut 1357=cut
1298 1358
1299sub resource($$;$) { 1359sub resource($$;$) {
1300 my ($self, $name) = (shift, shift); 1360 my ($self, $name) = (shift, shift);
1301 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1361 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1302 &urxvt::term::_resource 1362 goto &urxvt::term::_resource
1303} 1363}
1304 1364
1305=item $value = $term->x_resource ($pattern) 1365=item $value = $term->x_resource ($pattern)
1306 1366
1307Returns the X-Resource for the given pattern, excluding the program or 1367Returns the X-Resource for the given pattern, excluding the program or
1332 1392
1333=item ($row, $col) = $term->selection_beg ([$row, $col]) 1393=item ($row, $col) = $term->selection_beg ([$row, $col])
1334 1394
1335=item ($row, $col) = $term->selection_end ([$row, $col]) 1395=item ($row, $col) = $term->selection_end ([$row, $col])
1336 1396
1337Return the current values of the selection mark, begin or end positions, 1397Return the current values of the selection mark, begin or end positions.
1338and optionally set them to new values. 1398
1399When arguments are given, then the selection coordinates are set to
1400C<$row> and C<$col>, and the selection screen is set to the current
1401screen.
1402
1403=item $screen = $term->selection_screen ([$screen])
1404
1405Returns the current selection screen, and then optionally sets it.
1339 1406
1340=item $term->selection_make ($eventtime[, $rectangular]) 1407=item $term->selection_make ($eventtime[, $rectangular])
1341 1408
1342Tries to make a selection as set by C<selection_beg> and 1409Tries to make a selection as set by C<selection_beg> and
1343C<selection_end>. If C<$rectangular> is true (default: false), a 1410C<selection_end>. If C<$rectangular> is true (default: false), a
1344rectangular selection will be made. This is the prefered function to make 1411rectangular selection will be made. This is the preferred function to make
1345a selection. 1412a selection.
1346 1413
1347=item $success = $term->selection_grab ($eventtime) 1414=item $success = $term->selection_grab ($eventtime[, $clipboard])
1348 1415
1349Try to request the primary selection text from the server (for example, as 1416Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1417true) selection from the server. The corresponding text can be set
1350set by the next method). No visual feedback will be given. This function 1418with the next method. No visual feedback will be given. This function
1351is mostly useful from within C<on_sel_grab> hooks. 1419is mostly useful from within C<on_sel_grab> hooks.
1352 1420
1353=item $oldtext = $term->selection ([$newtext]) 1421=item $oldtext = $term->selection ([$newtext, $clipboard])
1354 1422
1355Return the current selection text and optionally replace it by C<$newtext>. 1423Return the current selection (clipboard if C<$clipboard> is true) text
1424and optionally replace it by C<$newtext>.
1425
1426=item $term->selection_clear ([$clipboard])
1427
1428Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1356 1429
1357=item $term->overlay_simple ($x, $y, $text) 1430=item $term->overlay_simple ($x, $y, $text)
1358 1431
1359Create a simple multi-line overlay box. See the next method for details. 1432Create a simple multi-line overlay box. See the next method for details.
1360 1433
1390 1463
1391The methods currently supported on C<urxvt::overlay> objects are: 1464The methods currently supported on C<urxvt::overlay> objects are:
1392 1465
1393=over 4 1466=over 4
1394 1467
1395=item $overlay->set ($x, $y, $text, $rend) 1468=item $overlay->set ($x, $y, $text[, $rend])
1396 1469
1397Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1470Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1398text in rxvt-unicode's special encoding and an array of rendition values 1471text in rxvt-unicode's special encoding and an array of rendition values
1399at a specific position inside the overlay. 1472at a specific position inside the overlay.
1473
1474If C<$rend> is missing, then the rendition will not be changed.
1400 1475
1401=item $overlay->hide 1476=item $overlay->hide
1402 1477
1403If visible, hide the overlay, but do not destroy it. 1478If visible, hide the overlay, but do not destroy it.
1404 1479
1486locale-specific encoding of the terminal and can contain command sequences 1561locale-specific encoding of the terminal and can contain command sequences
1487(escape codes) that will be interpreted. 1562(escape codes) that will be interpreted.
1488 1563
1489=item $term->tt_write ($octets) 1564=item $term->tt_write ($octets)
1490 1565
1491Write the octets given in C<$data> to the tty (i.e. as program input). To 1566Write the octets given in C<$octets> to the tty (i.e. as program input). To
1492pass characters instead of octets, you should convert your strings first 1567pass characters instead of octets, you should convert your strings first
1493to the locale-specific encoding using C<< $term->locale_encode >>. 1568to the locale-specific encoding using C<< $term->locale_encode >>.
1569
1570=item $term->tt_paste ($octets)
1571
1572Write the octets given in C<$octets> to the tty as a paste, converting NL to
1573CR and bracketing the data with control sequences if bracketed paste mode
1574is set.
1494 1575
1495=item $old_events = $term->pty_ev_events ([$new_events]) 1576=item $old_events = $term->pty_ev_events ([$new_events])
1496 1577
1497Replaces the event mask of the pty watcher by the given event mask. Can 1578Replaces the event mask of the pty watcher by the given event mask. Can
1498be used to suppress input and output handling to the pty/tty. See the 1579be used to suppress input and output handling to the pty/tty. See the
1614 1695
1615Used after changing terminal contents to display them. 1696Used after changing terminal contents to display them.
1616 1697
1617=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1698=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1618 1699
1619Returns the text of the entire row with number C<$row_number>. Row C<0> 1700Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1620is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1701is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1621terminal line. The scrollback buffer starts at line C<-1> and extends to
1622line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1702terminal line. Nothing will be returned if a nonexistent line
1623is requested. 1703is requested.
1624 1704
1625If C<$new_text> is specified, it will replace characters in the current 1705If C<$new_text> is specified, it will replace characters in the current
1626line, starting at column C<$start_col> (default C<0>), which is useful 1706line, starting at column C<$start_col> (default C<0>), which is useful
1627to replace only parts of a line. The font index in the rendition will 1707to replace only parts of a line. The font index in the rendition will
1628automatically be updated. 1708automatically be updated.
1629 1709
1630C<$text> is in a special encoding: tabs and wide characters that use more 1710C<$text> is in a special encoding: tabs and wide characters that use more
1631than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1711than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1632characters. Characters with combining characters and other characters that 1712characters. Characters with combining characters and other characters that
1633do not fit into the normal tetx encoding will be replaced with characters 1713do not fit into the normal text encoding will be replaced with characters
1634in the private use area. 1714in the private use area.
1635 1715
1636You have to obey this encoding when changing text. The advantage is 1716You have to obey this encoding when changing text. The advantage is
1637that C<substr> and similar functions work on screen cells and not on 1717that C<substr> and similar functions work on screen cells and not on
1638characters. 1718characters.
1813Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1893Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1814recent grab. 1894recent grab.
1815 1895
1816=item $term->ungrab 1896=item $term->ungrab
1817 1897
1818Calls XUngrab for the most recent grab. Is called automatically on 1898Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1819evaluation errors, as it is better to lose the grab in the error case as 1899evaluation errors, as it is better to lose the grab in the error case as
1820the session. 1900the session.
1821 1901
1822=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1902=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1823 1903
1825 1905
1826=item @atoms = $term->XListProperties ($window) 1906=item @atoms = $term->XListProperties ($window)
1827 1907
1828=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1908=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1829 1909
1830=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1910=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1831 1911
1832=item $term->XDeleteProperty ($window, $property) 1912=item $term->XDeleteProperty ($window, $property)
1833 1913
1834=item $window = $term->DefaultRootWindow 1914=item $window = $term->DefaultRootWindow
1835 1915
1845 1925
1846=item $term->XChangeInput ($window, $add_events[, $del_events]) 1926=item $term->XChangeInput ($window, $add_events[, $del_events])
1847 1927
1848Various X or X-related functions. The C<$term> object only serves as 1928Various X or X-related functions. The C<$term> object only serves as
1849the source of the display, otherwise those functions map more-or-less 1929the source of the display, otherwise those functions map more-or-less
1850directory onto the X functions of the same name. 1930directly onto the X functions of the same name.
1851 1931
1852=back 1932=back
1853 1933
1854=cut 1934=cut
1855 1935
1957 my $env = $self->{term}->env; 2037 my $env = $self->{term}->env;
1958 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2038 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1959 delete $env->{LC_ALL}; 2039 delete $env->{LC_ALL};
1960 $env->{LC_CTYPE} = $self->{term}->locale; 2040 $env->{LC_CTYPE} = $self->{term}->locale;
1961 2041
1962 urxvt::term->new ($env, "popup", 2042 my $term = urxvt::term->new (
2043 $env, "popup",
1963 "--perl-lib" => "", "--perl-ext-common" => "", 2044 "--perl-lib" => "", "--perl-ext-common" => "",
1964 "-pty-fd" => -1, "-sl" => 0, 2045 "-pty-fd" => -1, "-sl" => 0,
1965 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2046 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1966 "--transient-for" => $self->{term}->parent, 2047 "--transient-for" => $self->{term}->parent,
1967 "-display" => $self->{term}->display_id, 2048 "-display" => $self->{term}->display_id,
1968 "-pe" => "urxvt-popup") 2049 "-pe" => "urxvt-popup",
1969 or die "unable to create popup window\n"; 2050 ) or die "unable to create popup window\n";
2051
2052 unless (delete $term->{urxvt_popup_init_done}) {
2053 $term->ungrab;
2054 $term->destroy;
2055 die "unable to initialise popup window\n";
2056 }
1970} 2057}
1971 2058
1972sub DESTROY { 2059sub DESTROY {
1973 my ($self) = @_; 2060 my ($self) = @_;
1974 2061
1992 ->new 2079 ->new
1993 ->interval (1) 2080 ->interval (1)
1994 ->cb (sub { 2081 ->cb (sub {
1995 $term->{overlay}->set (0, 0, 2082 $term->{overlay}->set (0, 0,
1996 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2083 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1997 }); 2084 });
1998 2085
1999=over 4 2086=over 4
2000 2087
2001=item $timer = new urxvt::timer 2088=item $timer = new urxvt::timer
2002 2089
2005 2092
2006=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2093=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2007 2094
2008Set the callback to be called when the timer triggers. 2095Set the callback to be called when the timer triggers.
2009 2096
2010=item $tstamp = $timer->at
2011
2012Return the time this watcher will fire next.
2013
2014=item $timer = $timer->set ($tstamp) 2097=item $timer = $timer->set ($tstamp[, $interval])
2015 2098
2016Set the time the event is generated to $tstamp. 2099Set the time the event is generated to $tstamp (and optionally specifies a
2100new $interval).
2017 2101
2018=item $timer = $timer->interval ($interval) 2102=item $timer = $timer->interval ($interval)
2019 2103
2020Normally (and when C<$interval> is C<0>), the timer will automatically 2104By default (and when C<$interval> is C<0>), the timer will automatically
2021stop after it has fired once. If C<$interval> is non-zero, then the timer 2105stop after it has fired once. If C<$interval> is non-zero, then the timer
2022is automatically rescheduled at the given intervals. 2106is automatically rescheduled at the given intervals.
2023 2107
2024=item $timer = $timer->start 2108=item $timer = $timer->start
2025 2109
2026Start the timer. 2110Start the timer.
2027 2111
2028=item $timer = $timer->start ($tstamp) 2112=item $timer = $timer->start ($tstamp[, $interval])
2029 2113
2030Set the event trigger time to C<$tstamp> and start the timer. 2114Set the event trigger time to C<$tstamp> and start the timer. Optionally
2115also replaces the interval.
2031 2116
2032=item $timer = $timer->after ($delay) 2117=item $timer = $timer->after ($delay[, $interval])
2033 2118
2034Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2119Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2035 2120
2036=item $timer = $timer->stop 2121=item $timer = $timer->stop
2037 2122
2045 2130
2046 $term->{socket} = ... 2131 $term->{socket} = ...
2047 $term->{iow} = urxvt::iow 2132 $term->{iow} = urxvt::iow
2048 ->new 2133 ->new
2049 ->fd (fileno $term->{socket}) 2134 ->fd (fileno $term->{socket})
2050 ->events (urxvt::EVENT_READ) 2135 ->events (urxvt::EV_READ)
2051 ->start 2136 ->start
2052 ->cb (sub { 2137 ->cb (sub {
2053 my ($iow, $revents) = @_; 2138 my ($iow, $revents) = @_;
2054 # $revents must be 1 here, no need to check 2139 # $revents must be 1 here, no need to check
2055 sysread $term->{socket}, my $buf, 8192 2140 sysread $term->{socket}, my $buf, 8192
2073Set the file descriptor (not handle) to watch. 2158Set the file descriptor (not handle) to watch.
2074 2159
2075=item $iow = $iow->events ($eventmask) 2160=item $iow = $iow->events ($eventmask)
2076 2161
2077Set the event mask to watch. The only allowed values are 2162Set the event mask to watch. The only allowed values are
2078C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2163C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2079together, or C<urxvt::EVENT_NONE>. 2164together, or C<urxvt::EV_NONE>.
2080 2165
2081=item $iow = $iow->start 2166=item $iow = $iow->start
2082 2167
2083Start watching for requested events on the given handle. 2168Start watching for requested events on the given handle.
2084 2169
2125 ->new 2210 ->new
2126 ->start ($pid) 2211 ->start ($pid)
2127 ->cb (sub { 2212 ->cb (sub {
2128 my ($pw, $exit_status) = @_; 2213 my ($pw, $exit_status) = @_;
2129 ... 2214 ...
2130 }); 2215 });
2131 2216
2132=over 4 2217=over 4
2133 2218
2134=item $pw = new urxvt::pw 2219=item $pw = new urxvt::pw
2135 2220
2168 2253
2169=back 2254=back
2170 2255
2171=head1 AUTHOR 2256=head1 AUTHOR
2172 2257
2173 Marc Lehmann <pcg@goof.com> 2258 Marc Lehmann <schmorp@schmorp.de>
2174 http://software.schmorp.de/pkg/rxvt-unicode 2259 http://software.schmorp.de/pkg/rxvt-unicode
2175 2260
2176=cut 2261=cut
2177 2262
21781 22631

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines