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.154 by root, Sat Jun 2 06:43:02 2007 UTC vs.
Revision 1.195 by sf-exg, Wed Jun 29 22:18:11 2011 UTC

40 40
41 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42 42
43Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
44 44
45 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
46 46
47=over 4 47=over 4
48 48
49=item selection (enabled by default) 49=item selection (enabled by default)
50 50
101 101
102Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed. 104popup is being displayed.
105 105
106It'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
107either 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
108reference. 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
109will 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
110first argument. 110first argument.
111 111
112The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>: 113C<< $self->{myoption} >>:
114 114
115 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 }; 117 };
118 118
124 124
125Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed. 127popup is being displayed.
128 128
129It'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
130is 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.
131It 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
132string 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
133when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
134 134
135The 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
136the 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
137C<a>s: 137C<a>s:
138 138
139 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : () 141 : ()
142 }; 142 };
143 143
144=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
145 145
152search. 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>
153search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
154bottom. 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
155was 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
156additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
157selection. 157selection if the C<Shift> modifier is active.
158 158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To 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> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
162 162
165=item readline (enabled by default) 165=item readline (enabled by default)
166 166
167A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
168the 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
169move 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
170cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters). 171for programs that correctly support wide characters).
172 172
173To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
174 174
175=over 4 175=over 4
259The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
263 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
264Example configuration: 267Example configuration:
265 268
266 URxvt.perl-ext: default,matcher 269 URxvt.perl-ext: default,matcher
267 URxvt.urlLauncher: sensible-browser 270 URxvt.urlLauncher: sensible-browser
268 URxvt.keysym.C-Delete: perl:matcher 271 URxvt.keysym.C-Delete: perl:matcher
273 276
274=item xim-onthespot 277=item xim-onthespot
275 278
276This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
277not 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
278OnTheSpot 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
279kinput2. 282kinput2.
280 283
281You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
282C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
283 286
291will 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
292or show it again. 295or show it again.
293 296
294Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
295 298
296This 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
297space 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.
298 301
299The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
300extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
301 304
302If 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
303(fvwm can do it). 306(fvwm can do it).
304 307
305=item automove-background 308=item overlay-osc
306 309
307This is basically a very small extension that dynamically changes the 310This extension implements some OSC commands to display timed popups on the
308background pixmap offset to the window position, in effect creating the 311screen - useful for status displays from within scripts. You have to read
309same effect as pseudo transparency with a custom pixmap. No scaling is 312the sources for more info.
310supported in this mode. Example:
311
312 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
313
314L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
315shows how this extension can be used to implement an automatically blurred
316transparent background.
317 313
318=item block-graphics-to-ascii 314=item block-graphics-to-ascii
319 315
320A 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
321by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
326Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
327 323
328=item remote-clipboard 324=item remote-clipboard
329 325
330Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
331selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
332selection somewhere and fetch it again. 328selection somewhere and fetch it again.
333 329
334We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
335means 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
336reads it. 332reads it.
345 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
346 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
347 343
348=item selection-pastebin 344=item selection-pastebin
349 345
350This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
351textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
352not 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
353F</tmp> directly.). 349F</tmp> directly.).
354 350
355It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
374 370
375 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
376 372
377I<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
378the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
379which 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
380or 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.
381 391
382=item example-refresh-hooks 392=item example-refresh-hooks
383 393
384Displays 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
385window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
386overlays 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.
387 402
388=back 403=back
389 404
390=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
391 406
407 422
408=over 4 423=over 4
409 424
410=item $text 425=item $text
411 426
412Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
413always 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.
414 429
415=item $string 430=item $string
416 431
417A 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
426=back 441=back
427 442
428=head2 Extension Objects 443=head2 Extension Objects
429 444
430Every 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
431for 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,
432which 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
433their C<$self> object without having to think about clashes with other 448their C<$self> object without having to think about clashes with other
434extensions or other terminals, with the exception of methods and members 449extensions or other terminals, with the exception of methods and members
435that begin with an underscore character C<_>: these are reserved for 450that begin with an underscore character C<_>: these are reserved for
436internal use. 451internal use.
551 566
552It 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,
553$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
554number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
555 570
556=item on_osc_seq $term, $op, $args 571=item on_osc_seq $term, $op, $args, $resp
557 572
558Called 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
559behaviour. 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
560suppresses execution of the request completely. Make sure you don't get 575suppresses execution of the request completely. Make sure you don't get
561confused by recursive invocations when you output an osc sequence within 576confused by recursive invocations when you output an OSC sequence within
562this callback. 577this callback.
563 578
564C<on_osc_seq_perl> should be used for new behaviour. 579C<on_osc_seq_perl> should be used for new behaviour.
565 580
566=item on_osc_seq_perl $term, $string 581=item on_osc_seq_perl $term, $args, $resp
567 582
568Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
569operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
570information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
571string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
572it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
573future. 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 }
574 599
575Be 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,
576as 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
577other 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.
578 606
579=item on_add_lines $term, $string 607=item on_add_lines $term, $string
580 608
581Called 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
582can 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
587=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
588 616
589Called 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
590suppress or filter tty input. 618suppress or filter tty input.
591 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
592=item on_line_update $term, $row 627=item on_line_update $term, $row
593 628
594Called 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
595screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
596that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
603later 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
604you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
605 640
606=item on_refresh_begin $term 641=item on_refresh_begin $term
607 642
608Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
609or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
610restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
611code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
612 647
613=item on_refresh_end $term 648=item on_refresh_end $term
614 649
621resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
622 657
623The 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
624slightly in the future. 659slightly in the future.
625 660
626=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
627 662
628Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
629windows 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
630returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
631 666
665 700
666=item on_map_notify $term, $event 701=item on_map_notify $term, $event
667 702
668=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
669 704
670Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
671the 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.
672 707
673The 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
674manpage), 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
675(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
676 711
685 720
686=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
687 722
688Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
689format=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.
690 729
691=back 730=back
692 731
693=cut 732=cut
694 733
759 798
760=over 4 799=over 4
761 800
762=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
763 802
764Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
765costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
766starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
767 807
768=item urxvt::warn $string 808=item urxvt::warn $string
769 809
770Calls 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
771newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
772that calls this function. 812that calls this function.
773 813
774Using 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
775correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
779=item @terms = urxvt::termlist 819=item @terms = urxvt::termlist
780 820
781Returns all urxvt::term objects that exist in this process, regardless of 821Returns all urxvt::term objects that exist in this process, regardless of
782whether they are started, being destroyed etc., so be careful. Only term 822whether they are started, being destroyed etc., so be careful. Only term
783objects that have perl extensions attached will be returned (because there 823objects that have perl extensions attached will be returned (because there
784is no urxvt::term objet associated with others). 824is no urxvt::term object associated with others).
785 825
786=item $time = urxvt::NOW 826=item $time = urxvt::NOW
787 827
788Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
789 829
832 872
833=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
834 874
835Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
836 876
837=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
838 879
839Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
840underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
841the bitset. 882the bitset.
842 883
925 local $TERM = shift; 966 local $TERM = shift;
926 my $htype = shift; 967 my $htype = shift;
927 968
928 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
929 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
930 971
931 my %ext_arg; 972 my %ext_arg;
932 973
933 { 974 {
934 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
935 @TERM_INIT = (); 976 @TERM_INIT = ();
1101is 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
1102work. 1143work.
1103 1144
1104=cut 1145=cut
1105 1146
1106our $VERSION = 1; 1147our $VERSION = '5.23';
1107 1148
1108$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1109push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1110 1151
1111sub timer { 1152sub timer {
1113 1154
1114 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1115 1156
1116 urxvt::timer 1157 urxvt::timer
1117 ->new 1158 ->new
1118 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
1119 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
1120 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
1121 $cb->(); 1162 $cb->();
1122 }) 1163 })
1123} 1164}
1124 1165
1125sub io { 1166sub io {
1126 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
1127 1168
1128 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
1129 1172
1130 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
1131 ->new 1174 ->new
1132 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
1133 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1134 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
1135 ->start 1178 ->start
1136 ->cb (sub { 1179 ->cb ($cb)
1137 $cb->(($_[1] & 1 ? 'r' : '')
1138 . ($_[1] & 2 ? 'w' : ''));
1139 })],
1140 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 })
1141} 1206}
1142 1207
1143sub DESTROY { 1208sub DESTROY {
1144 $_[0][1]->stop; 1209 $_[0][1]->stop;
1145}
1146
1147sub condvar {
1148 bless \my $flag, urxvt::anyevent::
1149}
1150
1151sub broadcast {
1152 ${$_[0]}++;
1153}
1154
1155sub wait {
1156 unless (${$_[0]}) {
1157 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1158 }
1159} 1210}
1160 1211
1161sub one_event { 1212sub one_event {
1162 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";
1163} 1214}
1257C<%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.
1258 1309
1259Here 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
1260source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1261 1312
1262 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess buffered console cursorBlink cursorUnderline hold iconic
1263 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 mapAlert meta8 mouseWheelScrollPage override-redirect pastableTabs
1265 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1316 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1317 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267 transparent tripleclickwords utmpInhibit visualBell 1318 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1319 urgentOnBell utmpInhibit visualBell
1268 1320
1269=item $value = $term->resource ($name[, $newval]) 1321=item $value = $term->resource ($name[, $newval])
1270 1322
1271Returns the current resource value associated with a given name and 1323Returns the current resource value associated with a given name and
1272optionally 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>
1285 1337
1286Here 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
1287are 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>
1288to see the actual list: 1340to see the actual list:
1289 1341
1290 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1342 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1291 borderLess color cursorBlink cursorUnderline cutchars delete_key 1343 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1292 display_name embed ext_bwidth fade font geometry hold iconName 1344 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1293 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
1294 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1347 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1295 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1348 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1296 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1349 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1297 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1350 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1298 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1351 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1299 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1352 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1300 secondaryScreen secondaryScroll selectstyle shade term_name title 1353 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1301 transient_for transparent transparent_all tripleclickwords utmpInhibit 1354 term_name title transient_for transparent tripleclickwords urgentOnBell
1302 visualBell 1355 utmpInhibit visualBell
1303 1356
1304=cut 1357=cut
1305 1358
1306sub resource($$;$) { 1359sub resource($$;$) {
1307 my ($self, $name) = (shift, shift); 1360 my ($self, $name) = (shift, shift);
1308 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1361 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1309 &urxvt::term::_resource 1362 goto &urxvt::term::_resource
1310} 1363}
1311 1364
1312=item $value = $term->x_resource ($pattern) 1365=item $value = $term->x_resource ($pattern)
1313 1366
1314Returns the X-Resource for the given pattern, excluding the program or 1367Returns the X-Resource for the given pattern, excluding the program or
1339 1392
1340=item ($row, $col) = $term->selection_beg ([$row, $col]) 1393=item ($row, $col) = $term->selection_beg ([$row, $col])
1341 1394
1342=item ($row, $col) = $term->selection_end ([$row, $col]) 1395=item ($row, $col) = $term->selection_end ([$row, $col])
1343 1396
1344Return the current values of the selection mark, begin or end positions, 1397Return the current values of the selection mark, begin or end positions.
1345and 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.
1346 1406
1347=item $term->selection_make ($eventtime[, $rectangular]) 1407=item $term->selection_make ($eventtime[, $rectangular])
1348 1408
1349Tries to make a selection as set by C<selection_beg> and 1409Tries to make a selection as set by C<selection_beg> and
1350C<selection_end>. If C<$rectangular> is true (default: false), a 1410C<selection_end>. If C<$rectangular> is true (default: false), a
1351rectangular selection will be made. This is the prefered function to make 1411rectangular selection will be made. This is the preferred function to make
1352a selection. 1412a selection.
1353 1413
1354=item $success = $term->selection_grab ($eventtime) 1414=item $success = $term->selection_grab ($eventtime[, $clipboard])
1355 1415
1356Try 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
1357set by the next method). No visual feedback will be given. This function 1418with the next method. No visual feedback will be given. This function
1358is mostly useful from within C<on_sel_grab> hooks. 1419is mostly useful from within C<on_sel_grab> hooks.
1359 1420
1360=item $oldtext = $term->selection ([$newtext]) 1421=item $oldtext = $term->selection ([$newtext, $clipboard])
1361 1422
1362Return 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.
1363 1429
1364=item $term->overlay_simple ($x, $y, $text) 1430=item $term->overlay_simple ($x, $y, $text)
1365 1431
1366Create 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.
1367 1433
1397 1463
1398The methods currently supported on C<urxvt::overlay> objects are: 1464The methods currently supported on C<urxvt::overlay> objects are:
1399 1465
1400=over 4 1466=over 4
1401 1467
1402=item $overlay->set ($x, $y, $text, $rend) 1468=item $overlay->set ($x, $y, $text[, $rend])
1403 1469
1404Similar 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
1405text 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
1406at 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.
1407 1475
1408=item $overlay->hide 1476=item $overlay->hide
1409 1477
1410If visible, hide the overlay, but do not destroy it. 1478If visible, hide the overlay, but do not destroy it.
1411 1479
1493locale-specific encoding of the terminal and can contain command sequences 1561locale-specific encoding of the terminal and can contain command sequences
1494(escape codes) that will be interpreted. 1562(escape codes) that will be interpreted.
1495 1563
1496=item $term->tt_write ($octets) 1564=item $term->tt_write ($octets)
1497 1565
1498Write 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
1499pass characters instead of octets, you should convert your strings first 1567pass characters instead of octets, you should convert your strings first
1500to 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.
1501 1575
1502=item $old_events = $term->pty_ev_events ([$new_events]) 1576=item $old_events = $term->pty_ev_events ([$new_events])
1503 1577
1504Replaces 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
1505be 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
1621 1695
1622Used after changing terminal contents to display them. 1696Used after changing terminal contents to display them.
1623 1697
1624=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1698=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1625 1699
1626Returns 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 >>
1627is 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
1628terminal line. The scrollback buffer starts at line C<-1> and extends to
1629line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1702terminal line. Nothing will be returned if a nonexistent line
1630is requested. 1703is requested.
1631 1704
1632If 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
1633line, 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
1634to 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
1635automatically be updated. 1708automatically be updated.
1636 1709
1637C<$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
1638than 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)
1639characters. Characters with combining characters and other characters that 1712characters. Characters with combining characters and other characters that
1640do 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
1641in the private use area. 1714in the private use area.
1642 1715
1643You have to obey this encoding when changing text. The advantage is 1716You have to obey this encoding when changing text. The advantage is
1644that 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
1645characters. 1718characters.
1820Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1893Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1821recent grab. 1894recent grab.
1822 1895
1823=item $term->ungrab 1896=item $term->ungrab
1824 1897
1825Calls XUngrab for the most recent grab. Is called automatically on 1898Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1826evaluation 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
1827the session. 1900the session.
1828 1901
1829=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1902=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1830 1903
1832 1905
1833=item @atoms = $term->XListProperties ($window) 1906=item @atoms = $term->XListProperties ($window)
1834 1907
1835=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1908=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1836 1909
1837=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1910=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1838 1911
1839=item $term->XDeleteProperty ($window, $property) 1912=item $term->XDeleteProperty ($window, $property)
1840 1913
1841=item $window = $term->DefaultRootWindow 1914=item $window = $term->DefaultRootWindow
1842 1915
1852 1925
1853=item $term->XChangeInput ($window, $add_events[, $del_events]) 1926=item $term->XChangeInput ($window, $add_events[, $del_events])
1854 1927
1855Various 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
1856the source of the display, otherwise those functions map more-or-less 1929the source of the display, otherwise those functions map more-or-less
1857directory onto the X functions of the same name. 1930directly onto the X functions of the same name.
1858 1931
1859=back 1932=back
1860 1933
1861=cut 1934=cut
1862 1935
1964 my $env = $self->{term}->env; 2037 my $env = $self->{term}->env;
1965 # 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.
1966 delete $env->{LC_ALL}; 2039 delete $env->{LC_ALL};
1967 $env->{LC_CTYPE} = $self->{term}->locale; 2040 $env->{LC_CTYPE} = $self->{term}->locale;
1968 2041
1969 urxvt::term->new ($env, "popup", 2042 my $term = urxvt::term->new (
2043 $env, "popup",
1970 "--perl-lib" => "", "--perl-ext-common" => "", 2044 "--perl-lib" => "", "--perl-ext-common" => "",
1971 "-pty-fd" => -1, "-sl" => 0, 2045 "-pty-fd" => -1, "-sl" => 0,
1972 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2046 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1973 "--transient-for" => $self->{term}->parent, 2047 "--transient-for" => $self->{term}->parent,
1974 "-display" => $self->{term}->display_id, 2048 "-display" => $self->{term}->display_id,
1975 "-pe" => "urxvt-popup") 2049 "-pe" => "urxvt-popup",
1976 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 }
1977} 2057}
1978 2058
1979sub DESTROY { 2059sub DESTROY {
1980 my ($self) = @_; 2060 my ($self) = @_;
1981 2061
1999 ->new 2079 ->new
2000 ->interval (1) 2080 ->interval (1)
2001 ->cb (sub { 2081 ->cb (sub {
2002 $term->{overlay}->set (0, 0, 2082 $term->{overlay}->set (0, 0,
2003 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2083 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2004 }); 2084 });
2005 2085
2006=over 4 2086=over 4
2007 2087
2008=item $timer = new urxvt::timer 2088=item $timer = new urxvt::timer
2009 2089
2012 2092
2013=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2093=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2014 2094
2015Set the callback to be called when the timer triggers. 2095Set the callback to be called when the timer triggers.
2016 2096
2017=item $tstamp = $timer->at
2018
2019Return the time this watcher will fire next.
2020
2021=item $timer = $timer->set ($tstamp) 2097=item $timer = $timer->set ($tstamp[, $interval])
2022 2098
2023Set the time the event is generated to $tstamp. 2099Set the time the event is generated to $tstamp (and optionally specifies a
2100new $interval).
2024 2101
2025=item $timer = $timer->interval ($interval) 2102=item $timer = $timer->interval ($interval)
2026 2103
2027Normally (and when C<$interval> is C<0>), the timer will automatically 2104By default (and when C<$interval> is C<0>), the timer will automatically
2028stop 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
2029is automatically rescheduled at the given intervals. 2106is automatically rescheduled at the given intervals.
2030 2107
2031=item $timer = $timer->start 2108=item $timer = $timer->start
2032 2109
2033Start the timer. 2110Start the timer.
2034 2111
2035=item $timer = $timer->start ($tstamp) 2112=item $timer = $timer->start ($tstamp[, $interval])
2036 2113
2037Set 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.
2038 2116
2039=item $timer = $timer->after ($delay) 2117=item $timer = $timer->after ($delay[, $interval])
2040 2118
2041Like 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>.
2042 2120
2043=item $timer = $timer->stop 2121=item $timer = $timer->stop
2044 2122
2052 2130
2053 $term->{socket} = ... 2131 $term->{socket} = ...
2054 $term->{iow} = urxvt::iow 2132 $term->{iow} = urxvt::iow
2055 ->new 2133 ->new
2056 ->fd (fileno $term->{socket}) 2134 ->fd (fileno $term->{socket})
2057 ->events (urxvt::EVENT_READ) 2135 ->events (urxvt::EV_READ)
2058 ->start 2136 ->start
2059 ->cb (sub { 2137 ->cb (sub {
2060 my ($iow, $revents) = @_; 2138 my ($iow, $revents) = @_;
2061 # $revents must be 1 here, no need to check 2139 # $revents must be 1 here, no need to check
2062 sysread $term->{socket}, my $buf, 8192 2140 sysread $term->{socket}, my $buf, 8192
2080Set the file descriptor (not handle) to watch. 2158Set the file descriptor (not handle) to watch.
2081 2159
2082=item $iow = $iow->events ($eventmask) 2160=item $iow = $iow->events ($eventmask)
2083 2161
2084Set the event mask to watch. The only allowed values are 2162Set the event mask to watch. The only allowed values are
2085C<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
2086together, or C<urxvt::EVENT_NONE>. 2164together, or C<urxvt::EV_NONE>.
2087 2165
2088=item $iow = $iow->start 2166=item $iow = $iow->start
2089 2167
2090Start watching for requested events on the given handle. 2168Start watching for requested events on the given handle.
2091 2169
2132 ->new 2210 ->new
2133 ->start ($pid) 2211 ->start ($pid)
2134 ->cb (sub { 2212 ->cb (sub {
2135 my ($pw, $exit_status) = @_; 2213 my ($pw, $exit_status) = @_;
2136 ... 2214 ...
2137 }); 2215 });
2138 2216
2139=over 4 2217=over 4
2140 2218
2141=item $pw = new urxvt::pw 2219=item $pw = new urxvt::pw
2142 2220
2175 2253
2176=back 2254=back
2177 2255
2178=head1 AUTHOR 2256=head1 AUTHOR
2179 2257
2180 Marc Lehmann <pcg@goof.com> 2258 Marc Lehmann <schmorp@schmorp.de>
2181 http://software.schmorp.de/pkg/rxvt-unicode 2259 http://software.schmorp.de/pkg/rxvt-unicode
2182 2260
2183=cut 2261=cut
2184 2262
21851 22631

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines