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.148 by root, Tue Oct 3 21:41:07 2006 UTC vs.
Revision 1.192 by root, Mon Feb 21 07:41:04 2011 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
109The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
110C<$self->{myoption}>: 113C<< $self->{myoption} >>:
111 114
112 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 }; 117 };
115 118
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide whether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 157selection if the C<Shift> modifier is active.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
166move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
256The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
260 263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
261Example configuration: 267Example configuration:
262 268
263 URxvt.perl-ext: default,matcher 269 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser 270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
265 URxvt.matcher.button: 1 272 URxvt.matcher.button: 1
266 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
268 URxvt.matcher.launcher.2: gvim +$2 $1 275 URxvt.matcher.launcher.2: gvim +$2 $1
269 276
270=item xim-onthespot 277=item xim-onthespot
271 278
272This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
273not 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
274OnTheSpot 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
275kinput2. 282kinput2.
276 283
277You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
278C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
279 286
287will 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
288or show it again. 295or show it again.
289 296
290Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
291 298
292This 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
293space 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.
294 301
295The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
296extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
297 304
298If 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
299(fvwm can do it). 306(fvwm can do it).
300 307
301=item automove-background 308=item overlay-osc
302 309
303This is basically a very small extension that dynamically changes the 310This extension implements some OSC commands to display timed popups on the
304background pixmap offset to the window position, in effect creating the 311screen - useful for status displays from within scripts. You have to read
305same effect as pseudo transparency with a custom pixmap. No scaling is 312the sources for more info.
306supported in this mode. Example:
307
308 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309 313
310=item block-graphics-to-ascii 314=item block-graphics-to-ascii
311 315
312A 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
313by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
318Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
319 323
320=item remote-clipboard 324=item remote-clipboard
321 325
322Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
323selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
324selection somewhere and fetch it again. 328selection somewhere and fetch it again.
325 329
326We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
327means 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
328reads it. 332reads it.
337 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339 343
340=item selection-pastebin 344=item selection-pastebin
341 345
342This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
343textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
344not 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
345F</tmp> directly.). 349F</tmp> directly.).
346 350
347It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
366 370
367 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368 372
369I<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
370the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
371which 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
372or 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.
373 391
374=item example-refresh-hooks 392=item example-refresh-hooks
375 393
376Displays 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
377window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
378overlays 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.
379 402
380=back 403=back
381 404
382=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
383 406
399 422
400=over 4 423=over 4
401 424
402=item $text 425=item $text
403 426
404Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
405always 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.
406 429
407=item $string 430=item $string
408 431
409A 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
543 566
544It 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,
545$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
546number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
547 570
548=item on_osc_seq $term, $op, $args 571=item on_osc_seq $term, $op, $args, $resp
549 572
550Called 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
551behaviour. 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
552suppresses execution of the request completely. Make sure you don't get 575suppresses execution of the request completely. Make sure you don't get
553confused by recursive invocations when you output an osc sequence within 576confused by recursive invocations when you output an OSC sequence within
554this callback. 577this callback.
555 578
556C<on_osc_seq_perl> should be used for new behaviour. 579C<on_osc_seq_perl> should be used for new behaviour.
557 580
558=item on_osc_seq_perl $term, $string 581=item on_osc_seq_perl $term, $args, $resp
559 582
560Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
561operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
562information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
563string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
564it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
565future. 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 }
566 599
567Be 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,
568as 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
569other 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.
570 606
571=item on_add_lines $term, $string 607=item on_add_lines $term, $string
572 608
573Called 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
574can 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
579=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
580 616
581Called 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
582suppress or filter tty input. 618suppress or filter tty input.
583 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
584=item on_line_update $term, $row 627=item on_line_update $term, $row
585 628
586Called 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
587screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
588that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
595later 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
596you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
597 640
598=item on_refresh_begin $term 641=item on_refresh_begin $term
599 642
600Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
601or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
602restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
603code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
604 647
605=item on_refresh_end $term 648=item on_refresh_end $term
606 649
613resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
614 657
615The 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
616slightly in the future. 659slightly in the future.
617 660
618=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
619 662
620Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
621windows 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
622returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
623 666
657 700
658=item on_map_notify $term, $event 701=item on_map_notify $term, $event
659 702
660=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
661 704
662Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
663the 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.
664 707
665The 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
666manpage), 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
667(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
668 711
677 720
678=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
679 722
680Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
681format=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.
682 729
683=back 730=back
684 731
685=cut 732=cut
686 733
751 798
752=over 4 799=over 4
753 800
754=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
755 802
756Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
757costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
758starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
759 807
760=item urxvt::warn $string 808=item urxvt::warn $string
761 809
762Calls 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
763newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
764that calls this function. 812that calls this function.
765 813
766Using 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
767correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
824 872
825=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
826 874
827Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
828 876
829=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
830 879
831Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
832underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
833the bitset. 882the bitset.
834 883
917 local $TERM = shift; 966 local $TERM = shift;
918 my $htype = shift; 967 my $htype = shift;
919 968
920 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
921 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
922 971
923 my %ext_arg; 972 my %ext_arg;
924 973
925 { 974 {
926 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
927 @TERM_INIT = (); 976 @TERM_INIT = ();
990 1039
991sub SET_COLOR($$$) { 1040sub SET_COLOR($$$) {
992 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1041 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993} 1042}
994 1043
1044sub rend2mask {
1045 no strict 'refs';
1046 my ($str, $mask) = (@_, 0);
1047 my %color = ( fg => undef, bg => undef );
1048 my @failed;
1049 for my $spec ( split /\s+/, $str ) {
1050 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1051 $color{lc($1)} = $2;
1052 } else {
1053 my $neg = $spec =~ s/^[-^]//;
1054 unless ( exists &{"RS_$spec"} ) {
1055 push @failed, $spec;
1056 next;
1057 }
1058 my $cur = &{"RS_$spec"};
1059 if ( $neg ) {
1060 $mask &= ~$cur;
1061 } else {
1062 $mask |= $cur;
1063 }
1064 }
1065 }
1066 ($mask, @color{qw(fg bg)}, \@failed)
1067}
1068
995# urxvt::term::extension 1069# urxvt::term::extension
996 1070
997package urxvt::term::extension; 1071package urxvt::term::extension;
998 1072
999sub enable { 1073sub enable {
1068is 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
1069work. 1143work.
1070 1144
1071=cut 1145=cut
1072 1146
1073our $VERSION = 1; 1147our $VERSION = '5.23';
1074 1148
1075$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1076push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1077 1151
1078sub timer { 1152sub timer {
1080 1154
1081 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1082 1156
1083 urxvt::timer 1157 urxvt::timer
1084 ->new 1158 ->new
1085 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
1086 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
1087 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
1088 $cb->(); 1162 $cb->();
1089 }) 1163 })
1090} 1164}
1091 1165
1092sub io { 1166sub io {
1093 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
1094 1168
1095 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
1096 1172
1097 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
1098 ->new 1174 ->new
1099 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
1100 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1101 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
1102 ->start 1178 ->start
1103 ->cb (sub { 1179 ->cb ($cb)
1104 $cb->(($_[1] & 1 ? 'r' : '')
1105 . ($_[1] & 2 ? 'w' : ''));
1106 })],
1107 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 })
1108} 1206}
1109 1207
1110sub DESTROY { 1208sub DESTROY {
1111 $_[0][1]->stop; 1209 $_[0][1]->stop;
1112} 1210}
1113 1211
1114sub condvar { 1212sub one_event {
1115 bless \my $flag, urxvt::anyevent::condvar::
1116}
1117
1118sub urxvt::anyevent::condvar::broadcast {
1119 ${$_[0]}++;
1120}
1121
1122sub urxvt::anyevent::condvar::wait {
1123 unless (${$_[0]}) {
1124 Carp::croak "AnyEvent->condvar 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";
1125 }
1126} 1214}
1127 1215
1128package urxvt::term; 1216package urxvt::term;
1129 1217
1130=head2 The C<urxvt::term> Class 1218=head2 The C<urxvt::term> Class
1249Here is a likely non-exhaustive list of resource names, not all of which 1337Here is a likely non-exhaustive list of resource names, not all of which
1250are supported in every build, please see the source file F</src/rsinc.h> 1338are supported in every build, please see the source file F</src/rsinc.h>
1251to see the actual list: 1339to see the actual list:
1252 1340
1253 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1254 borderLess color cursorBlink cursorUnderline cutchars delete_key 1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1255 display_name embed ext_bwidth fade font geometry hold iconName 1343 display_name embed ext_bwidth fade font geometry hold iconName
1256 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1257 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1258 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1259 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1260 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1261 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1262 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1263 secondaryScreen secondaryScroll selectstyle shade term_name title 1351 secondaryScreen secondaryScroll shade term_name title
1264 transient_for transparent transparent_all tripleclickwords utmpInhibit 1352 transient_for transparent transparent_all tripleclickwords utmpInhibit
1265 visualBell 1353 visualBell
1266 1354
1267=cut 1355=cut
1268 1356
1269sub resource($$;$) { 1357sub resource($$;$) {
1270 my ($self, $name) = (shift, shift); 1358 my ($self, $name) = (shift, shift);
1271 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1359 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1272 &urxvt::term::_resource 1360 goto &urxvt::term::_resource
1273} 1361}
1274 1362
1275=item $value = $term->x_resource ($pattern) 1363=item $value = $term->x_resource ($pattern)
1276 1364
1277Returns the X-Resource for the given pattern, excluding the program or 1365Returns the X-Resource for the given pattern, excluding the program or
1302 1390
1303=item ($row, $col) = $term->selection_beg ([$row, $col]) 1391=item ($row, $col) = $term->selection_beg ([$row, $col])
1304 1392
1305=item ($row, $col) = $term->selection_end ([$row, $col]) 1393=item ($row, $col) = $term->selection_end ([$row, $col])
1306 1394
1307Return the current values of the selection mark, begin or end positions, 1395Return the current values of the selection mark, begin or end positions.
1308and optionally set them to new values. 1396
1397When arguments are given, then the selection coordinates are set to
1398C<$row> and C<$col>, and the selection screen is set to the current
1399screen.
1400
1401=item $screen = $term->selection_screen ([$screen])
1402
1403Returns the current selection screen, and then optionally sets it.
1309 1404
1310=item $term->selection_make ($eventtime[, $rectangular]) 1405=item $term->selection_make ($eventtime[, $rectangular])
1311 1406
1312Tries to make a selection as set by C<selection_beg> and 1407Tries to make a selection as set by C<selection_beg> and
1313C<selection_end>. If C<$rectangular> is true (default: false), a 1408C<selection_end>. If C<$rectangular> is true (default: false), a
1314rectangular selection will be made. This is the prefered function to make 1409rectangular selection will be made. This is the preferred function to make
1315a selection. 1410a selection.
1316 1411
1317=item $success = $term->selection_grab ($eventtime) 1412=item $success = $term->selection_grab ($eventtime[, $clipboard])
1318 1413
1319Try to request the primary selection text from the server (for example, as 1414Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1415true) selection from the server. The corresponding text can be set
1320set by the next method). No visual feedback will be given. This function 1416with the next method. No visual feedback will be given. This function
1321is mostly useful from within C<on_sel_grab> hooks. 1417is mostly useful from within C<on_sel_grab> hooks.
1322 1418
1323=item $oldtext = $term->selection ([$newtext]) 1419=item $oldtext = $term->selection ([$newtext, $clipboard])
1324 1420
1325Return the current selection text and optionally replace it by C<$newtext>. 1421Return the current selection (clipboard if C<$clipboard> is true) text
1422and optionally replace it by C<$newtext>.
1423
1424=item $term->selection_clear ([$clipboard])
1425
1426Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1326 1427
1327=item $term->overlay_simple ($x, $y, $text) 1428=item $term->overlay_simple ($x, $y, $text)
1328 1429
1329Create a simple multi-line overlay box. See the next method for details. 1430Create a simple multi-line overlay box. See the next method for details.
1330 1431
1360 1461
1361The methods currently supported on C<urxvt::overlay> objects are: 1462The methods currently supported on C<urxvt::overlay> objects are:
1362 1463
1363=over 4 1464=over 4
1364 1465
1365=item $overlay->set ($x, $y, $text, $rend) 1466=item $overlay->set ($x, $y, $text[, $rend])
1366 1467
1367Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1468Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1368text in rxvt-unicode's special encoding and an array of rendition values 1469text in rxvt-unicode's special encoding and an array of rendition values
1369at a specific position inside the overlay. 1470at a specific position inside the overlay.
1471
1472If C<$rend> is missing, then the rendition will not be changed.
1370 1473
1371=item $overlay->hide 1474=item $overlay->hide
1372 1475
1373If visible, hide the overlay, but do not destroy it. 1476If visible, hide the overlay, but do not destroy it.
1374 1477
1456locale-specific encoding of the terminal and can contain command sequences 1559locale-specific encoding of the terminal and can contain command sequences
1457(escape codes) that will be interpreted. 1560(escape codes) that will be interpreted.
1458 1561
1459=item $term->tt_write ($octets) 1562=item $term->tt_write ($octets)
1460 1563
1461Write the octets given in C<$data> to the tty (i.e. as program input). To 1564Write the octets given in C<$octets> to the tty (i.e. as program input). To
1462pass characters instead of octets, you should convert your strings first 1565pass characters instead of octets, you should convert your strings first
1463to the locale-specific encoding using C<< $term->locale_encode >>. 1566to the locale-specific encoding using C<< $term->locale_encode >>.
1567
1568=item $term->tt_paste ($octets)
1569
1570Write the octets given in C<$octets> to the tty as a paste, converting NL to
1571CR and bracketing the data with control sequences if bracketed paste mode
1572is set.
1464 1573
1465=item $old_events = $term->pty_ev_events ([$new_events]) 1574=item $old_events = $term->pty_ev_events ([$new_events])
1466 1575
1467Replaces the event mask of the pty watcher by the given event mask. Can 1576Replaces the event mask of the pty watcher by the given event mask. Can
1468be used to suppress input and output handling to the pty/tty. See the 1577be used to suppress input and output handling to the pty/tty. See the
1584 1693
1585Used after changing terminal contents to display them. 1694Used after changing terminal contents to display them.
1586 1695
1587=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1696=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1588 1697
1589Returns the text of the entire row with number C<$row_number>. Row C<0> 1698Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1590is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1699is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1591terminal line. The scrollback buffer starts at line C<-1> and extends to
1592line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1700terminal line. Nothing will be returned if a nonexistent line
1593is requested. 1701is requested.
1594 1702
1595If C<$new_text> is specified, it will replace characters in the current 1703If C<$new_text> is specified, it will replace characters in the current
1596line, starting at column C<$start_col> (default C<0>), which is useful 1704line, starting at column C<$start_col> (default C<0>), which is useful
1597to replace only parts of a line. The font index in the rendition will 1705to replace only parts of a line. The font index in the rendition will
1598automatically be updated. 1706automatically be updated.
1599 1707
1600C<$text> is in a special encoding: tabs and wide characters that use more 1708C<$text> is in a special encoding: tabs and wide characters that use more
1601than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1709than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1602characters. Characters with combining characters and other characters that 1710characters. Characters with combining characters and other characters that
1603do not fit into the normal tetx encoding will be replaced with characters 1711do not fit into the normal text encoding will be replaced with characters
1604in the private use area. 1712in the private use area.
1605 1713
1606You have to obey this encoding when changing text. The advantage is 1714You have to obey this encoding when changing text. The advantage is
1607that C<substr> and similar functions work on screen cells and not on 1715that C<substr> and similar functions work on screen cells and not on
1608characters. 1716characters.
1783Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1891Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1784recent grab. 1892recent grab.
1785 1893
1786=item $term->ungrab 1894=item $term->ungrab
1787 1895
1788Calls XUngrab for the most recent grab. Is called automatically on 1896Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1789evaluation errors, as it is better to lose the grab in the error case as 1897evaluation errors, as it is better to lose the grab in the error case as
1790the session. 1898the session.
1791 1899
1792=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1900=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1793 1901
1795 1903
1796=item @atoms = $term->XListProperties ($window) 1904=item @atoms = $term->XListProperties ($window)
1797 1905
1798=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1906=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1799 1907
1800=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1908=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1801 1909
1802=item $term->XDeleteProperty ($window, $property) 1910=item $term->XDeleteProperty ($window, $property)
1803 1911
1804=item $window = $term->DefaultRootWindow 1912=item $window = $term->DefaultRootWindow
1805 1913
1815 1923
1816=item $term->XChangeInput ($window, $add_events[, $del_events]) 1924=item $term->XChangeInput ($window, $add_events[, $del_events])
1817 1925
1818Various X or X-related functions. The C<$term> object only serves as 1926Various X or X-related functions. The C<$term> object only serves as
1819the source of the display, otherwise those functions map more-or-less 1927the source of the display, otherwise those functions map more-or-less
1820directory onto the X functions of the same name. 1928directly onto the X functions of the same name.
1821 1929
1822=back 1930=back
1823 1931
1824=cut 1932=cut
1825 1933
1927 my $env = $self->{term}->env; 2035 my $env = $self->{term}->env;
1928 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2036 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1929 delete $env->{LC_ALL}; 2037 delete $env->{LC_ALL};
1930 $env->{LC_CTYPE} = $self->{term}->locale; 2038 $env->{LC_CTYPE} = $self->{term}->locale;
1931 2039
1932 urxvt::term->new ($env, "popup", 2040 my $term = urxvt::term->new (
2041 $env, "popup",
1933 "--perl-lib" => "", "--perl-ext-common" => "", 2042 "--perl-lib" => "", "--perl-ext-common" => "",
1934 "-pty-fd" => -1, "-sl" => 0, 2043 "-pty-fd" => -1, "-sl" => 0,
1935 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2044 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1936 "--transient-for" => $self->{term}->parent, 2045 "--transient-for" => $self->{term}->parent,
1937 "-display" => $self->{term}->display_id, 2046 "-display" => $self->{term}->display_id,
1938 "-pe" => "urxvt-popup") 2047 "-pe" => "urxvt-popup",
1939 or die "unable to create popup window\n"; 2048 ) or die "unable to create popup window\n";
2049
2050 unless (delete $term->{urxvt_popup_init_done}) {
2051 $term->ungrab;
2052 $term->destroy;
2053 die "unable to initialise popup window\n";
2054 }
1940} 2055}
1941 2056
1942sub DESTROY { 2057sub DESTROY {
1943 my ($self) = @_; 2058 my ($self) = @_;
1944 2059
1949=back 2064=back
1950 2065
1951=cut 2066=cut
1952 2067
1953package urxvt::watcher; 2068package urxvt::watcher;
1954
1955@urxvt::timer::ISA = __PACKAGE__;
1956@urxvt::iow::ISA = __PACKAGE__;
1957@urxvt::pw::ISA = __PACKAGE__;
1958@urxvt::iw::ISA = __PACKAGE__;
1959 2069
1960=head2 The C<urxvt::timer> Class 2070=head2 The C<urxvt::timer> Class
1961 2071
1962This class implements timer watchers/events. Time is represented as a 2072This class implements timer watchers/events. Time is represented as a
1963fractional number of seconds since the epoch. Example: 2073fractional number of seconds since the epoch. Example:
1967 ->new 2077 ->new
1968 ->interval (1) 2078 ->interval (1)
1969 ->cb (sub { 2079 ->cb (sub {
1970 $term->{overlay}->set (0, 0, 2080 $term->{overlay}->set (0, 0,
1971 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2081 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1972 }); 2082 });
1973 2083
1974=over 4 2084=over 4
1975 2085
1976=item $timer = new urxvt::timer 2086=item $timer = new urxvt::timer
1977 2087
1980 2090
1981=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2091=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1982 2092
1983Set the callback to be called when the timer triggers. 2093Set the callback to be called when the timer triggers.
1984 2094
1985=item $tstamp = $timer->at
1986
1987Return the time this watcher will fire next.
1988
1989=item $timer = $timer->set ($tstamp) 2095=item $timer = $timer->set ($tstamp[, $interval])
1990 2096
1991Set the time the event is generated to $tstamp. 2097Set the time the event is generated to $tstamp (and optionally specifies a
2098new $interval).
1992 2099
1993=item $timer = $timer->interval ($interval) 2100=item $timer = $timer->interval ($interval)
1994 2101
1995Normally (and when C<$interval> is C<0>), the timer will automatically 2102By default (and when C<$interval> is C<0>), the timer will automatically
1996stop after it has fired once. If C<$interval> is non-zero, then the timer 2103stop after it has fired once. If C<$interval> is non-zero, then the timer
1997is automatically rescheduled at the given intervals. 2104is automatically rescheduled at the given intervals.
1998 2105
1999=item $timer = $timer->start 2106=item $timer = $timer->start
2000 2107
2001Start the timer. 2108Start the timer.
2002 2109
2003=item $timer = $timer->start ($tstamp) 2110=item $timer = $timer->start ($tstamp[, $interval])
2004 2111
2005Set the event trigger time to C<$tstamp> and start the timer. 2112Set the event trigger time to C<$tstamp> and start the timer. Optionally
2113also replaces the interval.
2006 2114
2007=item $timer = $timer->after ($delay) 2115=item $timer = $timer->after ($delay[, $interval])
2008 2116
2009Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2117Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2010 2118
2011=item $timer = $timer->stop 2119=item $timer = $timer->stop
2012 2120
2020 2128
2021 $term->{socket} = ... 2129 $term->{socket} = ...
2022 $term->{iow} = urxvt::iow 2130 $term->{iow} = urxvt::iow
2023 ->new 2131 ->new
2024 ->fd (fileno $term->{socket}) 2132 ->fd (fileno $term->{socket})
2025 ->events (urxvt::EVENT_READ) 2133 ->events (urxvt::EV_READ)
2026 ->start 2134 ->start
2027 ->cb (sub { 2135 ->cb (sub {
2028 my ($iow, $revents) = @_; 2136 my ($iow, $revents) = @_;
2029 # $revents must be 1 here, no need to check 2137 # $revents must be 1 here, no need to check
2030 sysread $term->{socket}, my $buf, 8192 2138 sysread $term->{socket}, my $buf, 8192
2048Set the file descriptor (not handle) to watch. 2156Set the file descriptor (not handle) to watch.
2049 2157
2050=item $iow = $iow->events ($eventmask) 2158=item $iow = $iow->events ($eventmask)
2051 2159
2052Set the event mask to watch. The only allowed values are 2160Set the event mask to watch. The only allowed values are
2053C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2161C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2054together, or C<urxvt::EVENT_NONE>. 2162together, or C<urxvt::EV_NONE>.
2055 2163
2056=item $iow = $iow->start 2164=item $iow = $iow->start
2057 2165
2058Start watching for requested events on the given handle. 2166Start watching for requested events on the given handle.
2059 2167
2100 ->new 2208 ->new
2101 ->start ($pid) 2209 ->start ($pid)
2102 ->cb (sub { 2210 ->cb (sub {
2103 my ($pw, $exit_status) = @_; 2211 my ($pw, $exit_status) = @_;
2104 ... 2212 ...
2105 }); 2213 });
2106 2214
2107=over 4 2215=over 4
2108 2216
2109=item $pw = new urxvt::pw 2217=item $pw = new urxvt::pw
2110 2218
2143 2251
2144=back 2252=back
2145 2253
2146=head1 AUTHOR 2254=head1 AUTHOR
2147 2255
2148 Marc Lehmann <pcg@goof.com> 2256 Marc Lehmann <schmorp@schmorp.de>
2149 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
2150 2258
2151=cut 2259=cut
2152 2260
21531 22611
2262
2263# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines