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.198 by root, Tue Oct 4 22:25:14 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 or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
264Example configuration: 268Example configuration:
265 269
266 URxvt.perl-ext: default,matcher 270 URxvt.perl-ext: default,matcher
267 URxvt.urlLauncher: sensible-browser 271 URxvt.urlLauncher: sensible-browser
268 URxvt.keysym.C-Delete: perl:matcher 272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
269 URxvt.matcher.button: 1 274 URxvt.matcher.button: 1
270 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
271 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
272 URxvt.matcher.launcher.2: gvim +$2 $1 277 URxvt.matcher.launcher.2: gvim +$2 $1
273 278
274=item xim-onthespot 279=item xim-onthespot
275 280
276This (experimental) perl extension implements OnTheSpot editing. It does 281This (experimental) perl extension implements OnTheSpot editing. It does
277not work perfectly, and some input methods don't seem to work well with 282not work perfectly, and some input methods don't seem to work well with
278OnTheSpot editing in general, but it seems to work at leats for SCIM and 283OnTheSpot editing in general, but it seems to work at least for SCIM and
279kinput2. 284kinput2.
280 285
281You enable it by specifying this extension and a preedit style of 286You enable it by specifying this extension and a preedit style of
282C<OnTheSpot>, i.e.: 287C<OnTheSpot>, i.e.:
283 288
291will show or hide itself. Another press of the accelerator key will hide 296will show or hide itself. Another press of the accelerator key will hide
292or show it again. 297or show it again.
293 298
294Initially, the window will not be shown when using this extension. 299Initially, the window will not be shown when using this extension.
295 300
296This is useful if you need a single terminal thats not using any desktop 301This 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. 302space most of the time but is quickly available at the press of a key.
298 303
299The accelerator key is grabbed regardless of any modifiers, so this 304The accelerator key is grabbed regardless of any modifiers, so this
300extension will actually grab a physical key just for this function. 305extension will actually grab a physical key just for this function.
301 306
302If you want a quake-like animation, tell your window manager to do so 307If you want a quake-like animation, tell your window manager to do so
303(fvwm can do it). 308(fvwm can do it).
304 309
305=item automove-background 310=item overlay-osc
306 311
307This is basically a very small extension that dynamically changes the 312This extension implements some OSC commands to display timed popups on the
308background pixmap offset to the window position, in effect creating the 313screen - useful for status displays from within scripts. You have to read
309same effect as pseudo transparency with a custom pixmap. No scaling is 314the 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 315
318=item block-graphics-to-ascii 316=item block-graphics-to-ascii
319 317
320A not very useful example of filtering all text output to the terminal 318A not very useful example of filtering all text output to the terminal
321by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
326Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
327 325
328=item remote-clipboard 326=item remote-clipboard
329 327
330Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
331selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
332selection somewhere and fetch it again. 330selection somewhere and fetch it again.
333 331
334We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
335means that one command uploads the file to a remote server, and another 333means that one command uploads the file to a remote server, and another
336reads it. 334reads it.
345 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
346 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
347 345
348=item selection-pastebin 346=item selection-pastebin
349 347
350This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
351textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
352not currently secure for use in a multiuser environment as it writes to 350not currently secure for use in a multiuser environment as it writes to
353F</tmp> directly.). 351F</tmp> directly.).
354 352
355It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
374 372
375 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
376 374
377I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
378the double C</> characters as comment start. Use C<\057\057> instead, 376the double C</> characters as comment start. Use C<\057\057> instead,
379which works regardless of wether xrdb is used to parse the resource file 377which works regardless of whether xrdb is used to parse the resource file
380or not. 378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
381 393
382=item example-refresh-hooks 394=item example-refresh-hooks
383 395
384Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
385window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
386overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
387 404
388=back 405=back
389 406
390=head1 API DOCUMENTATION 407=head1 API DOCUMENTATION
391 408
407 424
408=over 4 425=over 4
409 426
410=item $text 427=item $text
411 428
412Rxvt-unicodes special way of encoding text, where one "unicode" character 429Rxvt-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. 430always represents one screen cell. See L<ROW_t> for a discussion of this format.
414 431
415=item $string 432=item $string
416 433
417A perl text string, with an emphasis on I<text>. It can store all unicode 434A perl text string, with an emphasis on I<text>. It can store all unicode
426=back 443=back
427 444
428=head2 Extension Objects 445=head2 Extension Objects
429 446
430Every perl extension is a perl class. A separate perl object is created 447Every perl extension is a perl class. A separate perl object is created
431for each terminal, and each terminal has its own set of extenion objects, 448for 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 449which are passed as the first parameter to hooks. So extensions can use
433their C<$self> object without having to think about clashes with other 450their C<$self> object without having to think about clashes with other
434extensions or other terminals, with the exception of methods and members 451extensions or other terminals, with the exception of methods and members
435that begin with an underscore character C<_>: these are reserved for 452that begin with an underscore character C<_>: these are reserved for
436internal use. 453internal use.
551 568
552It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 569It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
553$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 570$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
554number of lines that will be in the scrollback buffer. 571number of lines that will be in the scrollback buffer.
555 572
556=item on_osc_seq $term, $op, $args 573=item on_osc_seq $term, $op, $args, $resp
557 574
558Called on every OSC sequence and can be used to suppress it or modify its 575Called 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 576behaviour. The default should be to return an empty list. A true value
560suppresses execution of the request completely. Make sure you don't get 577suppresses execution of the request completely. Make sure you don't get
561confused by recursive invocations when you output an osc sequence within 578confused by recursive invocations when you output an OSC sequence within
562this callback. 579this callback.
563 580
564C<on_osc_seq_perl> should be used for new behaviour. 581C<on_osc_seq_perl> should be used for new behaviour.
565 582
566=item on_osc_seq_perl $term, $string 583=item on_osc_seq_perl $term, $args, $resp
567 584
568Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 585Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
569operating system command) is processed. Cursor position and other state 586operating system command) is processed. Cursor position and other state
570information is up-to-date when this happens. For interoperability, the 587information is up-to-date when this happens. For interoperability, the
571string should start with the extension name and a colon, to distinguish 588string should start with the extension name (sans -osc) and a semicolon,
572it from commands for other extensions, and this might be enforced in the 589to distinguish it from commands for other extensions, and this might be
573future. 590enforced in the future.
591
592For example, C<overlay-osc> uses this:
593
594 sub on_osc_seq_perl {
595 my ($self, $osc, $resp) = @_;
596
597 return unless $osc =~ s/^overlay;//;
598
599 ... process remaining $osc string
600 }
574 601
575Be careful not ever to trust (in a security sense) the data you receive, 602Be careful not ever to trust (in a security sense) the data you receive,
576as its source can not easily be controlled (e-mail content, messages from 603as its source can not easily be controlled (e-mail content, messages from
577other users on the same system etc.). 604other users on the same system etc.).
605
606For responses, C<$resp> contains the end-of-args separator used by the
607sender.
578 608
579=item on_add_lines $term, $string 609=item on_add_lines $term, $string
580 610
581Called whenever text is about to be output, with the text as argument. You 611Called whenever text is about to be output, with the text as argument. You
582can filter/change and output the text yourself by returning a true value 612can filter/change and output the text yourself by returning a true value
587=item on_tt_write $term, $octets 617=item on_tt_write $term, $octets
588 618
589Called whenever some data is written to the tty/pty and can be used to 619Called whenever some data is written to the tty/pty and can be used to
590suppress or filter tty input. 620suppress or filter tty input.
591 621
622=item on_tt_paste $term, $octets
623
624Called whenever text is about to be pasted, with the text as argument. You
625can filter/change and paste the text yourself by returning a true value
626and calling C<< $term->tt_paste >> yourself. C<$octets> is
627locale-encoded.
628
592=item on_line_update $term, $row 629=item on_line_update $term, $row
593 630
594Called whenever a line was updated or changed. Can be used to filter 631Called whenever a line was updated or changed. Can be used to filter
595screen output (e.g. underline urls or other useless stuff). Only lines 632screen output (e.g. underline urls or other useless stuff). Only lines
596that are being shown will be filtered, and, due to performance reasons, 633that are being shown will be filtered, and, due to performance reasons,
603later with the already-modified line (e.g. if unrelated parts change), so 640later with the already-modified line (e.g. if unrelated parts change), so
604you cannot just toggle rendition bits, but only set them. 641you cannot just toggle rendition bits, but only set them.
605 642
606=item on_refresh_begin $term 643=item on_refresh_begin $term
607 644
608Called just before the screen gets redrawn. Can be used for overlay 645Called just before the screen gets redrawn. Can be used for overlay or
609or similar effects by modify terminal contents in refresh_begin, and 646similar effects by modifying the terminal contents in refresh_begin, and
610restoring them in refresh_end. The built-in overlay and selection display 647restoring them in refresh_end. The built-in overlay and selection display
611code is run after this hook, and takes precedence. 648code is run after this hook, and takes precedence.
612 649
613=item on_refresh_end $term 650=item on_refresh_end $term
614 651
621resource in the @@RXVT_NAME@@(1) manpage). 658resource in the @@RXVT_NAME@@(1) manpage).
622 659
623The event is simply the action string. This interface is assumed to change 660The event is simply the action string. This interface is assumed to change
624slightly in the future. 661slightly in the future.
625 662
626=item on_resize_all_windows $tern, $new_width, $new_height 663=item on_resize_all_windows $term, $new_width, $new_height
627 664
628Called just after the new window size has been calculated, but before 665Called just after the new window size has been calculated, but before
629windows are actually being resized or hints are being set. If this hook 666windows are actually being resized or hints are being set. If this hook
630returns TRUE, setting of the window hints is being skipped. 667returns TRUE, setting of the window hints is being skipped.
631 668
665 702
666=item on_map_notify $term, $event 703=item on_map_notify $term, $event
667 704
668=item on_unmap_notify $term, $event 705=item on_unmap_notify $term, $event
669 706
670Called whenever the corresponding X event is received for the terminal If 707Called whenever the corresponding X event is received for the terminal. If
671the hook returns true, then the even will be ignored by rxvt-unicode. 708the hook returns true, then the event will be ignored by rxvt-unicode.
672 709
673The event is a hash with most values as named by Xlib (see the XEvent 710The event is a hash with most values as named by Xlib (see the XEvent
674manpage), with the additional members C<row> and C<col>, which are the 711manpage), with the additional members C<row> and C<col>, which are the
675(real, not screen-based) row and column under the mouse cursor. 712(real, not screen-based) row and column under the mouse cursor.
676 713
685 722
686=item on_wm_delete_window $term, $event 723=item on_wm_delete_window $term, $event
687 724
688Called when various types of ClientMessage events are received (all with 725Called when various types of ClientMessage events are received (all with
689format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 726format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
727
728=item on_bell $term
729
730Called on receipt of a bell character.
690 731
691=back 732=back
692 733
693=cut 734=cut
694 735
759 800
760=over 4 801=over 4
761 802
762=item urxvt::fatal $errormessage 803=item urxvt::fatal $errormessage
763 804
764Fatally aborts execution with the given error message. Avoid at all 805Fatally aborts execution with the given error message (which should
765costs! The only time this is acceptable is when the terminal process 806include a trailing newline). Avoid at all costs! The only time this
766starts up. 807is acceptable (and useful) is in the init hook, where it prevents the
808terminal from starting up.
767 809
768=item urxvt::warn $string 810=item urxvt::warn $string
769 811
770Calls C<rxvt_warn> with the given string which should not include a 812Calls C<rxvt_warn> with the given string which should include a trailing
771newline. The module also overwrites the C<warn> builtin with a function 813newline. The module also overwrites the C<warn> builtin with a function
772that calls this function. 814that calls this function.
773 815
774Using this function has the advantage that its output ends up in the 816Using this function has the advantage that its output ends up in the
775correct place, e.g. on stderr of the connecting urxvtc client. 817correct place, e.g. on stderr of the connecting urxvtc client.
779=item @terms = urxvt::termlist 821=item @terms = urxvt::termlist
780 822
781Returns all urxvt::term objects that exist in this process, regardless of 823Returns all urxvt::term objects that exist in this process, regardless of
782whether they are started, being destroyed etc., so be careful. Only term 824whether they are started, being destroyed etc., so be careful. Only term
783objects that have perl extensions attached will be returned (because there 825objects that have perl extensions attached will be returned (because there
784is no urxvt::term objet associated with others). 826is no urxvt::term object associated with others).
785 827
786=item $time = urxvt::NOW 828=item $time = urxvt::NOW
787 829
788Returns the "current time" (as per the event loop). 830Returns the "current time" (as per the event loop).
789 831
832 874
833=item $rend = urxvt::OVERLAY_RSTYLE 875=item $rend = urxvt::OVERLAY_RSTYLE
834 876
835Return the rendition mask used for overlays by default. 877Return the rendition mask used for overlays by default.
836 878
837=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 879=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
880urxvt::RS_RVid, urxvt::RS_Uline
838 881
839Return the bit that enabled bold, italic, blink, reverse-video and 882Return the bit that enabled bold, italic, blink, reverse-video and
840underline, respectively. To enable such a style, just logically OR it into 883underline, respectively. To enable such a style, just logically OR it into
841the bitset. 884the bitset.
842 885
925 local $TERM = shift; 968 local $TERM = shift;
926 my $htype = shift; 969 my $htype = shift;
927 970
928 if ($htype == 0) { # INIT 971 if ($htype == 0) { # INIT
929 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 972 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
930 973
931 my %ext_arg; 974 my %ext_arg;
932 975
933 { 976 {
934 my @init = @TERM_INIT; 977 my @init = @TERM_INIT;
935 @TERM_INIT = (); 978 @TERM_INIT = ();
1101is that you cannot use blocking APIs, but the non-blocking variant should 1144is that you cannot use blocking APIs, but the non-blocking variant should
1102work. 1145work.
1103 1146
1104=cut 1147=cut
1105 1148
1106our $VERSION = 1; 1149our $VERSION = '5.23';
1107 1150
1108$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1151$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1109push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1152push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1110 1153
1111sub timer { 1154sub timer {
1113 1156
1114 my $cb = $arg{cb}; 1157 my $cb = $arg{cb};
1115 1158
1116 urxvt::timer 1159 urxvt::timer
1117 ->new 1160 ->new
1118 ->start (urxvt::NOW + $arg{after}) 1161 ->after ($arg{after}, $arg{interval})
1119 ->cb (sub { 1162 ->cb ($arg{interval} ? $cb : sub {
1120 $_[0]->stop; # need to cancel manually 1163 $_[0]->stop; # need to cancel manually
1121 $cb->(); 1164 $cb->();
1122 }) 1165 })
1123} 1166}
1124 1167
1125sub io { 1168sub io {
1126 my ($class, %arg) = @_; 1169 my ($class, %arg) = @_;
1127 1170
1128 my $cb = $arg{cb}; 1171 my $cb = $arg{cb};
1172 my $fd = fileno $arg{fh};
1173 defined $fd or $fd = $arg{fh};
1129 1174
1130 bless [$arg{fh}, urxvt::iow 1175 bless [$arg{fh}, urxvt::iow
1131 ->new 1176 ->new
1132 ->fd (fileno $arg{fh}) 1177 ->fd ($fd)
1133 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1178 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1134 | ($arg{poll} =~ /w/ ? 2 : 0)) 1179 | ($arg{poll} =~ /w/ ? 2 : 0))
1135 ->start 1180 ->start
1136 ->cb (sub { 1181 ->cb ($cb)
1137 $cb->(($_[1] & 1 ? 'r' : '')
1138 . ($_[1] & 2 ? 'w' : ''));
1139 })],
1140 urxvt::anyevent:: 1182 ], urxvt::anyevent::
1183}
1184
1185sub idle {
1186 my ($class, %arg) = @_;
1187
1188 my $cb = $arg{cb};
1189
1190 urxvt::iw
1191 ->new
1192 ->start
1193 ->cb ($cb)
1194}
1195
1196sub child {
1197 my ($class, %arg) = @_;
1198
1199 my $cb = $arg{cb};
1200
1201 urxvt::pw
1202 ->new
1203 ->start ($arg{pid})
1204 ->cb (sub {
1205 $_[0]->stop; # need to cancel manually
1206 $cb->($_[0]->rpid, $_[0]->rstatus);
1207 })
1141} 1208}
1142 1209
1143sub DESTROY { 1210sub DESTROY {
1144 $_[0][1]->stop; 1211 $_[0][1]->stop;
1145} 1212}
1146 1213
1147sub condvar { 1214# only needed for AnyEvent < 6 compatibility
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}
1160
1161sub one_event { 1215sub one_event {
1162 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1216 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1163} 1217}
1164 1218
1165package urxvt::term; 1219package urxvt::term;
1257C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1311C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1258 1312
1259Here is a likely non-exhaustive list of option names, please see the 1313Here is a likely non-exhaustive list of option names, please see the
1260source file F</src/optinc.h> to see the actual list: 1314source file F</src/optinc.h> to see the actual list:
1261 1315
1262 borderLess console cursorBlink cursorUnderline hold iconic insecure 1316 borderLess buffered console cursorBlink cursorUnderline hold iconic
1263 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1317 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1318 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1265 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1319 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1320 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267 transparent tripleclickwords utmpInhibit visualBell 1321 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1322 urgentOnBell utmpInhibit visualBell
1268 1323
1269=item $value = $term->resource ($name[, $newval]) 1324=item $value = $term->resource ($name[, $newval])
1270 1325
1271Returns the current resource value associated with a given name and 1326Returns the current resource value associated with a given name and
1272optionally sets a new value. Setting values is most useful in the C<init> 1327optionally sets a new value. Setting values is most useful in the C<init>
1285 1340
1286Here is a likely non-exhaustive list of resource names, not all of which 1341Here 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> 1342are supported in every build, please see the source file F</src/rsinc.h>
1288to see the actual list: 1343to see the actual list:
1289 1344
1290 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1345 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1291 borderLess color cursorBlink cursorUnderline cutchars delete_key 1346 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1292 display_name embed ext_bwidth fade font geometry hold iconName 1347 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1293 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1348 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1349 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1294 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1350 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1295 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1351 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1296 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1352 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1297 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1353 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1298 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1354 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1299 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1355 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1300 secondaryScreen secondaryScroll selectstyle shade term_name title 1356 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1301 transient_for transparent transparent_all tripleclickwords utmpInhibit 1357 term_name title transient_for transparent tripleclickwords urgentOnBell
1302 visualBell 1358 utmpInhibit visualBell
1303 1359
1304=cut 1360=cut
1305 1361
1306sub resource($$;$) { 1362sub resource($$;$) {
1307 my ($self, $name) = (shift, shift); 1363 my ($self, $name) = (shift, shift);
1308 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1364 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1309 &urxvt::term::_resource 1365 goto &urxvt::term::_resource
1310} 1366}
1311 1367
1312=item $value = $term->x_resource ($pattern) 1368=item $value = $term->x_resource ($pattern)
1313 1369
1314Returns the X-Resource for the given pattern, excluding the program or 1370Returns the X-Resource for the given pattern, excluding the program or
1339 1395
1340=item ($row, $col) = $term->selection_beg ([$row, $col]) 1396=item ($row, $col) = $term->selection_beg ([$row, $col])
1341 1397
1342=item ($row, $col) = $term->selection_end ([$row, $col]) 1398=item ($row, $col) = $term->selection_end ([$row, $col])
1343 1399
1344Return the current values of the selection mark, begin or end positions, 1400Return the current values of the selection mark, begin or end positions.
1345and optionally set them to new values. 1401
1402When arguments are given, then the selection coordinates are set to
1403C<$row> and C<$col>, and the selection screen is set to the current
1404screen.
1405
1406=item $screen = $term->selection_screen ([$screen])
1407
1408Returns the current selection screen, and then optionally sets it.
1346 1409
1347=item $term->selection_make ($eventtime[, $rectangular]) 1410=item $term->selection_make ($eventtime[, $rectangular])
1348 1411
1349Tries to make a selection as set by C<selection_beg> and 1412Tries to make a selection as set by C<selection_beg> and
1350C<selection_end>. If C<$rectangular> is true (default: false), a 1413C<selection_end>. If C<$rectangular> is true (default: false), a
1351rectangular selection will be made. This is the prefered function to make 1414rectangular selection will be made. This is the preferred function to make
1352a selection. 1415a selection.
1353 1416
1354=item $success = $term->selection_grab ($eventtime) 1417=item $success = $term->selection_grab ($eventtime[, $clipboard])
1355 1418
1356Try to request the primary selection text from the server (for example, as 1419Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1420true) selection from the server. The corresponding text can be set
1357set by the next method). No visual feedback will be given. This function 1421with the next method. No visual feedback will be given. This function
1358is mostly useful from within C<on_sel_grab> hooks. 1422is mostly useful from within C<on_sel_grab> hooks.
1359 1423
1360=item $oldtext = $term->selection ([$newtext]) 1424=item $oldtext = $term->selection ([$newtext, $clipboard])
1361 1425
1362Return the current selection text and optionally replace it by C<$newtext>. 1426Return the current selection (clipboard if C<$clipboard> is true) text
1427and optionally replace it by C<$newtext>.
1428
1429=item $term->selection_clear ([$clipboard])
1430
1431Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1363 1432
1364=item $term->overlay_simple ($x, $y, $text) 1433=item $term->overlay_simple ($x, $y, $text)
1365 1434
1366Create a simple multi-line overlay box. See the next method for details. 1435Create a simple multi-line overlay box. See the next method for details.
1367 1436
1397 1466
1398The methods currently supported on C<urxvt::overlay> objects are: 1467The methods currently supported on C<urxvt::overlay> objects are:
1399 1468
1400=over 4 1469=over 4
1401 1470
1402=item $overlay->set ($x, $y, $text, $rend) 1471=item $overlay->set ($x, $y, $text[, $rend])
1403 1472
1404Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1473Similar 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 1474text in rxvt-unicode's special encoding and an array of rendition values
1406at a specific position inside the overlay. 1475at a specific position inside the overlay.
1476
1477If C<$rend> is missing, then the rendition will not be changed.
1407 1478
1408=item $overlay->hide 1479=item $overlay->hide
1409 1480
1410If visible, hide the overlay, but do not destroy it. 1481If visible, hide the overlay, but do not destroy it.
1411 1482
1493locale-specific encoding of the terminal and can contain command sequences 1564locale-specific encoding of the terminal and can contain command sequences
1494(escape codes) that will be interpreted. 1565(escape codes) that will be interpreted.
1495 1566
1496=item $term->tt_write ($octets) 1567=item $term->tt_write ($octets)
1497 1568
1498Write the octets given in C<$data> to the tty (i.e. as program input). To 1569Write 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 1570pass characters instead of octets, you should convert your strings first
1500to the locale-specific encoding using C<< $term->locale_encode >>. 1571to the locale-specific encoding using C<< $term->locale_encode >>.
1572
1573=item $term->tt_paste ($octets)
1574
1575Write the octets given in C<$octets> to the tty as a paste, converting NL to
1576CR and bracketing the data with control sequences if bracketed paste mode
1577is set.
1501 1578
1502=item $old_events = $term->pty_ev_events ([$new_events]) 1579=item $old_events = $term->pty_ev_events ([$new_events])
1503 1580
1504Replaces the event mask of the pty watcher by the given event mask. Can 1581Replaces 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 1582be used to suppress input and output handling to the pty/tty. See the
1621 1698
1622Used after changing terminal contents to display them. 1699Used after changing terminal contents to display them.
1623 1700
1624=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1701=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1625 1702
1626Returns the text of the entire row with number C<$row_number>. Row C<0> 1703Returns 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 1704is 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 1705terminal line. Nothing will be returned if a nonexistent line
1630is requested. 1706is requested.
1631 1707
1632If C<$new_text> is specified, it will replace characters in the current 1708If 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 1709line, 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 1710to replace only parts of a line. The font index in the rendition will
1635automatically be updated. 1711automatically be updated.
1636 1712
1637C<$text> is in a special encoding: tabs and wide characters that use more 1713C<$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) 1714than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1639characters. Characters with combining characters and other characters that 1715characters. Characters with combining characters and other characters that
1640do not fit into the normal tetx encoding will be replaced with characters 1716do not fit into the normal text encoding will be replaced with characters
1641in the private use area. 1717in the private use area.
1642 1718
1643You have to obey this encoding when changing text. The advantage is 1719You have to obey this encoding when changing text. The advantage is
1644that C<substr> and similar functions work on screen cells and not on 1720that C<substr> and similar functions work on screen cells and not on
1645characters. 1721characters.
1820Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1896Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1821recent grab. 1897recent grab.
1822 1898
1823=item $term->ungrab 1899=item $term->ungrab
1824 1900
1825Calls XUngrab for the most recent grab. Is called automatically on 1901Calls 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 1902evaluation errors, as it is better to lose the grab in the error case as
1827the session. 1903the session.
1828 1904
1829=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1905=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1830 1906
1832 1908
1833=item @atoms = $term->XListProperties ($window) 1909=item @atoms = $term->XListProperties ($window)
1834 1910
1835=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1911=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1836 1912
1837=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1913=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1838 1914
1839=item $term->XDeleteProperty ($window, $property) 1915=item $term->XDeleteProperty ($window, $property)
1840 1916
1841=item $window = $term->DefaultRootWindow 1917=item $window = $term->DefaultRootWindow
1842 1918
1852 1928
1853=item $term->XChangeInput ($window, $add_events[, $del_events]) 1929=item $term->XChangeInput ($window, $add_events[, $del_events])
1854 1930
1855Various X or X-related functions. The C<$term> object only serves as 1931Various X or X-related functions. The C<$term> object only serves as
1856the source of the display, otherwise those functions map more-or-less 1932the source of the display, otherwise those functions map more-or-less
1857directory onto the X functions of the same name. 1933directly onto the X functions of the same name.
1858 1934
1859=back 1935=back
1860 1936
1861=cut 1937=cut
1862 1938
1964 my $env = $self->{term}->env; 2040 my $env = $self->{term}->env;
1965 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2041 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1966 delete $env->{LC_ALL}; 2042 delete $env->{LC_ALL};
1967 $env->{LC_CTYPE} = $self->{term}->locale; 2043 $env->{LC_CTYPE} = $self->{term}->locale;
1968 2044
1969 urxvt::term->new ($env, "popup", 2045 my $term = urxvt::term->new (
2046 $env, "popup",
1970 "--perl-lib" => "", "--perl-ext-common" => "", 2047 "--perl-lib" => "", "--perl-ext-common" => "",
1971 "-pty-fd" => -1, "-sl" => 0, 2048 "-pty-fd" => -1, "-sl" => 0,
1972 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2049 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1973 "--transient-for" => $self->{term}->parent, 2050 "--transient-for" => $self->{term}->parent,
1974 "-display" => $self->{term}->display_id, 2051 "-display" => $self->{term}->display_id,
1975 "-pe" => "urxvt-popup") 2052 "-pe" => "urxvt-popup",
1976 or die "unable to create popup window\n"; 2053 ) or die "unable to create popup window\n";
2054
2055 unless (delete $term->{urxvt_popup_init_done}) {
2056 $term->ungrab;
2057 $term->destroy;
2058 die "unable to initialise popup window\n";
2059 }
1977} 2060}
1978 2061
1979sub DESTROY { 2062sub DESTROY {
1980 my ($self) = @_; 2063 my ($self) = @_;
1981 2064
1999 ->new 2082 ->new
2000 ->interval (1) 2083 ->interval (1)
2001 ->cb (sub { 2084 ->cb (sub {
2002 $term->{overlay}->set (0, 0, 2085 $term->{overlay}->set (0, 0,
2003 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2086 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2004 }); 2087 });
2005 2088
2006=over 4 2089=over 4
2007 2090
2008=item $timer = new urxvt::timer 2091=item $timer = new urxvt::timer
2009 2092
2012 2095
2013=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2096=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2014 2097
2015Set the callback to be called when the timer triggers. 2098Set the callback to be called when the timer triggers.
2016 2099
2017=item $tstamp = $timer->at
2018
2019Return the time this watcher will fire next.
2020
2021=item $timer = $timer->set ($tstamp) 2100=item $timer = $timer->set ($tstamp[, $interval])
2022 2101
2023Set the time the event is generated to $tstamp. 2102Set the time the event is generated to $tstamp (and optionally specifies a
2103new $interval).
2024 2104
2025=item $timer = $timer->interval ($interval) 2105=item $timer = $timer->interval ($interval)
2026 2106
2027Normally (and when C<$interval> is C<0>), the timer will automatically 2107By 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 2108stop after it has fired once. If C<$interval> is non-zero, then the timer
2029is automatically rescheduled at the given intervals. 2109is automatically rescheduled at the given intervals.
2030 2110
2031=item $timer = $timer->start 2111=item $timer = $timer->start
2032 2112
2033Start the timer. 2113Start the timer.
2034 2114
2035=item $timer = $timer->start ($tstamp) 2115=item $timer = $timer->start ($tstamp[, $interval])
2036 2116
2037Set the event trigger time to C<$tstamp> and start the timer. 2117Set the event trigger time to C<$tstamp> and start the timer. Optionally
2118also replaces the interval.
2038 2119
2039=item $timer = $timer->after ($delay) 2120=item $timer = $timer->after ($delay[, $interval])
2040 2121
2041Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2122Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2042 2123
2043=item $timer = $timer->stop 2124=item $timer = $timer->stop
2044 2125
2052 2133
2053 $term->{socket} = ... 2134 $term->{socket} = ...
2054 $term->{iow} = urxvt::iow 2135 $term->{iow} = urxvt::iow
2055 ->new 2136 ->new
2056 ->fd (fileno $term->{socket}) 2137 ->fd (fileno $term->{socket})
2057 ->events (urxvt::EVENT_READ) 2138 ->events (urxvt::EV_READ)
2058 ->start 2139 ->start
2059 ->cb (sub { 2140 ->cb (sub {
2060 my ($iow, $revents) = @_; 2141 my ($iow, $revents) = @_;
2061 # $revents must be 1 here, no need to check 2142 # $revents must be 1 here, no need to check
2062 sysread $term->{socket}, my $buf, 8192 2143 sysread $term->{socket}, my $buf, 8192
2080Set the file descriptor (not handle) to watch. 2161Set the file descriptor (not handle) to watch.
2081 2162
2082=item $iow = $iow->events ($eventmask) 2163=item $iow = $iow->events ($eventmask)
2083 2164
2084Set the event mask to watch. The only allowed values are 2165Set the event mask to watch. The only allowed values are
2085C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2166C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2086together, or C<urxvt::EVENT_NONE>. 2167together, or C<urxvt::EV_NONE>.
2087 2168
2088=item $iow = $iow->start 2169=item $iow = $iow->start
2089 2170
2090Start watching for requested events on the given handle. 2171Start watching for requested events on the given handle.
2091 2172
2132 ->new 2213 ->new
2133 ->start ($pid) 2214 ->start ($pid)
2134 ->cb (sub { 2215 ->cb (sub {
2135 my ($pw, $exit_status) = @_; 2216 my ($pw, $exit_status) = @_;
2136 ... 2217 ...
2137 }); 2218 });
2138 2219
2139=over 4 2220=over 4
2140 2221
2141=item $pw = new urxvt::pw 2222=item $pw = new urxvt::pw
2142 2223
2175 2256
2176=back 2257=back
2177 2258
2178=head1 AUTHOR 2259=head1 AUTHOR
2179 2260
2180 Marc Lehmann <pcg@goof.com> 2261 Marc Lehmann <schmorp@schmorp.de>
2181 http://software.schmorp.de/pkg/rxvt-unicode 2262 http://software.schmorp.de/pkg/rxvt-unicode
2182 2263
2183=cut 2264=cut
2184 2265
21851 22661

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines