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.146 by root, Thu Aug 17 21:56:11 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 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
240 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
241 244
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid 245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices. 246indices.
244 247
245=item mark-urls 248=item matcher
246 249
247Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
248make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
249resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
250the URL as first argument. 253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
251 276
252=item xim-onthespot 277=item xim-onthespot
253 278
254This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
255not 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
256OnTheSpot 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
257kinput2. 282kinput2.
258 283
259You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
261 286
269will 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
270or show it again. 295or show it again.
271 296
272Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
273 298
274This 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
275space 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.
276 301
277The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
278extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
279 304
280If 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
281(fvwm can do it). 306(fvwm can do it).
282 307
283=item automove-background 308=item overlay-osc
284 309
285This is basically a very small extension that dynamically changes the 310This extension implements some OSC commands to display timed popups on the
286background pixmap offset to the window position, in effect creating the 311screen - useful for status displays from within scripts. You have to read
287same effect as pseudo transparency with a custom pixmap. No scaling is 312the sources for more info.
288supported in this mode. Example:
289
290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291 313
292=item block-graphics-to-ascii 314=item block-graphics-to-ascii
293 315
294A 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
295by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
300Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
301 323
302=item remote-clipboard 324=item remote-clipboard
303 325
304Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
305selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
306selection somewhere and fetch it again. 328selection somewhere and fetch it again.
307 329
308We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
309means 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
310reads it. 332reads it.
319 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321 343
322=item selection-pastebin 344=item selection-pastebin
323 345
324This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
325textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
326not 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
327F</tmp> directly.). 349F</tmp> directly.).
328 350
329It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
348 370
349 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350 372
351I<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
352the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
353which 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
354or 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.
355 391
356=item example-refresh-hooks 392=item example-refresh-hooks
357 393
358Displays 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
359window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
360overlays 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.
361 402
362=back 403=back
363 404
364=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
365 406
381 422
382=over 4 423=over 4
383 424
384=item $text 425=item $text
385 426
386Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
387always 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.
388 429
389=item $string 430=item $string
390 431
391A 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
525 566
526It 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,
527$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
528number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
529 570
530=item on_osc_seq $term, $op, $args 571=item on_osc_seq $term, $op, $args, $resp
531 572
532Called 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
533behaviour. 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
534suppresses execution of the request completely. Make sure you don't get 575suppresses execution of the request completely. Make sure you don't get
535confused by recursive invocations when you output an osc sequence within 576confused by recursive invocations when you output an OSC sequence within
536this callback. 577this callback.
537 578
538C<on_osc_seq_perl> should be used for new behaviour. 579C<on_osc_seq_perl> should be used for new behaviour.
539 580
540=item on_osc_seq_perl $term, $string 581=item on_osc_seq_perl $term, $args, $resp
541 582
542Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
543operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
544information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
545string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
546it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
547future. 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 }
548 599
549Be 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,
550as 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
551other 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.
552 606
553=item on_add_lines $term, $string 607=item on_add_lines $term, $string
554 608
555Called 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
556can 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
561=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
562 616
563Called 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
564suppress or filter tty input. 618suppress or filter tty input.
565 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
566=item on_line_update $term, $row 627=item on_line_update $term, $row
567 628
568Called 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
569screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
570that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
577later 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
578you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
579 640
580=item on_refresh_begin $term 641=item on_refresh_begin $term
581 642
582Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
583or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
584restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
585code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
586 647
587=item on_refresh_end $term 648=item on_refresh_end $term
588 649
595resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
596 657
597The 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
598slightly in the future. 659slightly in the future.
599 660
600=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
601 662
602Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
603windows 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
604returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
605 666
639 700
640=item on_map_notify $term, $event 701=item on_map_notify $term, $event
641 702
642=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
643 704
644Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
645the 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.
646 707
647The 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
648manpage), 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
649(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
650 711
659 720
660=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
661 722
662Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
663format=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.
664 729
665=back 730=back
666 731
667=cut 732=cut
668 733
806 871
807=item $rend = urxvt::OVERLAY_RSTYLE 872=item $rend = urxvt::OVERLAY_RSTYLE
808 873
809Return the rendition mask used for overlays by default. 874Return the rendition mask used for overlays by default.
810 875
811=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 876=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
877urxvt::RS_RVid, urxvt::RS_Uline
812 878
813Return the bit that enabled bold, italic, blink, reverse-video and 879Return the bit that enabled bold, italic, blink, reverse-video and
814underline, respectively. To enable such a style, just logically OR it into 880underline, respectively. To enable such a style, just logically OR it into
815the bitset. 881the bitset.
816 882
899 local $TERM = shift; 965 local $TERM = shift;
900 my $htype = shift; 966 my $htype = shift;
901 967
902 if ($htype == 0) { # INIT 968 if ($htype == 0) { # INIT
903 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 969 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
904 970
905 my %ext_arg; 971 my %ext_arg;
906 972
907 { 973 {
908 my @init = @TERM_INIT; 974 my @init = @TERM_INIT;
909 @TERM_INIT = (); 975 @TERM_INIT = ();
972 1038
973sub SET_COLOR($$$) { 1039sub SET_COLOR($$$) {
974 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1040 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975} 1041}
976 1042
1043sub rend2mask {
1044 no strict 'refs';
1045 my ($str, $mask) = (@_, 0);
1046 my %color = ( fg => undef, bg => undef );
1047 my @failed;
1048 for my $spec ( split /\s+/, $str ) {
1049 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1050 $color{lc($1)} = $2;
1051 } else {
1052 my $neg = $spec =~ s/^[-^]//;
1053 unless ( exists &{"RS_$spec"} ) {
1054 push @failed, $spec;
1055 next;
1056 }
1057 my $cur = &{"RS_$spec"};
1058 if ( $neg ) {
1059 $mask &= ~$cur;
1060 } else {
1061 $mask |= $cur;
1062 }
1063 }
1064 }
1065 ($mask, @color{qw(fg bg)}, \@failed)
1066}
1067
977# urxvt::term::extension 1068# urxvt::term::extension
978 1069
979package urxvt::term::extension; 1070package urxvt::term::extension;
980 1071
981sub enable { 1072sub enable {
1050is that you cannot use blocking APIs, but the non-blocking variant should 1141is that you cannot use blocking APIs, but the non-blocking variant should
1051work. 1142work.
1052 1143
1053=cut 1144=cut
1054 1145
1055our $VERSION = 1; 1146our $VERSION = '5.23';
1056 1147
1057$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1148$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1058push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1149push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1059 1150
1060sub timer { 1151sub timer {
1062 1153
1063 my $cb = $arg{cb}; 1154 my $cb = $arg{cb};
1064 1155
1065 urxvt::timer 1156 urxvt::timer
1066 ->new 1157 ->new
1067 ->start (urxvt::NOW + $arg{after}) 1158 ->after ($arg{after}, $arg{interval})
1068 ->cb (sub { 1159 ->cb ($arg{interval} ? $cb : sub {
1069 $_[0]->stop; # need to cancel manually 1160 $_[0]->stop; # need to cancel manually
1070 $cb->(); 1161 $cb->();
1071 }) 1162 })
1072} 1163}
1073 1164
1074sub io { 1165sub io {
1075 my ($class, %arg) = @_; 1166 my ($class, %arg) = @_;
1076 1167
1077 my $cb = $arg{cb}; 1168 my $cb = $arg{cb};
1169 my $fd = fileno $arg{fh};
1170 defined $fd or $fd = $arg{fh};
1078 1171
1079 bless [$arg{fh}, urxvt::iow 1172 bless [$arg{fh}, urxvt::iow
1080 ->new 1173 ->new
1081 ->fd (fileno $arg{fh}) 1174 ->fd ($fd)
1082 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1175 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1083 | ($arg{poll} =~ /w/ ? 2 : 0)) 1176 | ($arg{poll} =~ /w/ ? 2 : 0))
1084 ->start 1177 ->start
1085 ->cb (sub { 1178 ->cb ($cb)
1086 $cb->(($_[1] & 1 ? 'r' : '')
1087 . ($_[1] & 2 ? 'w' : ''));
1088 })],
1089 urxvt::anyevent:: 1179 ], urxvt::anyevent::
1180}
1181
1182sub idle {
1183 my ($class, %arg) = @_;
1184
1185 my $cb = $arg{cb};
1186
1187 urxvt::iw
1188 ->new
1189 ->start
1190 ->cb ($cb)
1191}
1192
1193sub child {
1194 my ($class, %arg) = @_;
1195
1196 my $cb = $arg{cb};
1197
1198 urxvt::pw
1199 ->new
1200 ->start ($arg{pid})
1201 ->cb (sub {
1202 $_[0]->stop; # need to cancel manually
1203 $cb->($_[0]->rpid, $_[0]->rstatus);
1204 })
1090} 1205}
1091 1206
1092sub DESTROY { 1207sub DESTROY {
1093 $_[0][1]->stop; 1208 $_[0][1]->stop;
1094} 1209}
1095 1210
1096sub condvar { 1211sub one_event {
1097 bless \my $flag, urxvt::anyevent::condvar::
1098}
1099
1100sub urxvt::anyevent::condvar::broadcast {
1101 ${$_[0]}++;
1102}
1103
1104sub urxvt::anyevent::condvar::wait {
1105 unless (${$_[0]}) {
1106 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1212 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1107 }
1108} 1213}
1109 1214
1110package urxvt::term; 1215package urxvt::term;
1111 1216
1112=head2 The C<urxvt::term> Class 1217=head2 The C<urxvt::term> Class
1231Here is a likely non-exhaustive list of resource names, not all of which 1336Here is a likely non-exhaustive list of resource names, not all of which
1232are supported in every build, please see the source file F</src/rsinc.h> 1337are supported in every build, please see the source file F</src/rsinc.h>
1233to see the actual list: 1338to see the actual list:
1234 1339
1235 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1340 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1236 borderLess color cursorBlink cursorUnderline cutchars delete_key 1341 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1237 display_name embed ext_bwidth fade font geometry hold iconName 1342 display_name embed ext_bwidth fade font geometry hold iconName
1238 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1343 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1239 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1344 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1240 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1345 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1241 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1346 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1242 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1347 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1243 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1348 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1244 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1349 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1245 secondaryScreen secondaryScroll selectstyle shade term_name title 1350 secondaryScreen secondaryScroll shade term_name title
1246 transient_for transparent transparent_all tripleclickwords utmpInhibit 1351 transient_for transparent transparent_all tripleclickwords utmpInhibit
1247 visualBell 1352 visualBell
1248 1353
1249=cut 1354=cut
1250 1355
1251sub resource($$;$) { 1356sub resource($$;$) {
1252 my ($self, $name) = (shift, shift); 1357 my ($self, $name) = (shift, shift);
1253 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1358 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1254 &urxvt::term::_resource 1359 goto &urxvt::term::_resource
1255} 1360}
1256 1361
1257=item $value = $term->x_resource ($pattern) 1362=item $value = $term->x_resource ($pattern)
1258 1363
1259Returns the X-Resource for the given pattern, excluding the program or 1364Returns the X-Resource for the given pattern, excluding the program or
1284 1389
1285=item ($row, $col) = $term->selection_beg ([$row, $col]) 1390=item ($row, $col) = $term->selection_beg ([$row, $col])
1286 1391
1287=item ($row, $col) = $term->selection_end ([$row, $col]) 1392=item ($row, $col) = $term->selection_end ([$row, $col])
1288 1393
1289Return the current values of the selection mark, begin or end positions, 1394Return the current values of the selection mark, begin or end positions.
1290and optionally set them to new values. 1395
1396When arguments are given, then the selection coordinates are set to
1397C<$row> and C<$col>, and the selection screen is set to the current
1398screen.
1399
1400=item $screen = $term->selection_screen ([$screen])
1401
1402Returns the current selection screen, and then optionally sets it.
1291 1403
1292=item $term->selection_make ($eventtime[, $rectangular]) 1404=item $term->selection_make ($eventtime[, $rectangular])
1293 1405
1294Tries to make a selection as set by C<selection_beg> and 1406Tries to make a selection as set by C<selection_beg> and
1295C<selection_end>. If C<$rectangular> is true (default: false), a 1407C<selection_end>. If C<$rectangular> is true (default: false), a
1296rectangular selection will be made. This is the prefered function to make 1408rectangular selection will be made. This is the preferred function to make
1297a selection. 1409a selection.
1298 1410
1299=item $success = $term->selection_grab ($eventtime) 1411=item $success = $term->selection_grab ($eventtime[, $clipboard])
1300 1412
1301Try to request the primary selection text from the server (for example, as 1413Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1414true) selection from the server. The corresponding text can be set
1302set by the next method). No visual feedback will be given. This function 1415with the next method. No visual feedback will be given. This function
1303is mostly useful from within C<on_sel_grab> hooks. 1416is mostly useful from within C<on_sel_grab> hooks.
1304 1417
1305=item $oldtext = $term->selection ([$newtext]) 1418=item $oldtext = $term->selection ([$newtext, $clipboard])
1306 1419
1307Return the current selection text and optionally replace it by C<$newtext>. 1420Return the current selection (clipboard if C<$clipboard> is true) text
1421and optionally replace it by C<$newtext>.
1422
1423=item $term->selection_clear ([$clipboard])
1424
1425Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1308 1426
1309=item $term->overlay_simple ($x, $y, $text) 1427=item $term->overlay_simple ($x, $y, $text)
1310 1428
1311Create a simple multi-line overlay box. See the next method for details. 1429Create a simple multi-line overlay box. See the next method for details.
1312 1430
1342 1460
1343The methods currently supported on C<urxvt::overlay> objects are: 1461The methods currently supported on C<urxvt::overlay> objects are:
1344 1462
1345=over 4 1463=over 4
1346 1464
1347=item $overlay->set ($x, $y, $text, $rend) 1465=item $overlay->set ($x, $y, $text[, $rend])
1348 1466
1349Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1467Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1350text in rxvt-unicode's special encoding and an array of rendition values 1468text in rxvt-unicode's special encoding and an array of rendition values
1351at a specific position inside the overlay. 1469at a specific position inside the overlay.
1470
1471If C<$rend> is missing, then the rendition will not be changed.
1352 1472
1353=item $overlay->hide 1473=item $overlay->hide
1354 1474
1355If visible, hide the overlay, but do not destroy it. 1475If visible, hide the overlay, but do not destroy it.
1356 1476
1438locale-specific encoding of the terminal and can contain command sequences 1558locale-specific encoding of the terminal and can contain command sequences
1439(escape codes) that will be interpreted. 1559(escape codes) that will be interpreted.
1440 1560
1441=item $term->tt_write ($octets) 1561=item $term->tt_write ($octets)
1442 1562
1443Write the octets given in C<$data> to the tty (i.e. as program input). To 1563Write the octets given in C<$octets> to the tty (i.e. as program input). To
1444pass characters instead of octets, you should convert your strings first 1564pass characters instead of octets, you should convert your strings first
1445to the locale-specific encoding using C<< $term->locale_encode >>. 1565to the locale-specific encoding using C<< $term->locale_encode >>.
1566
1567=item $term->tt_paste ($octets)
1568
1569Write the octets given in C<$octets> to the tty as a paste, converting NL to
1570CR and bracketing the data with control sequences if bracketed paste mode
1571is set.
1446 1572
1447=item $old_events = $term->pty_ev_events ([$new_events]) 1573=item $old_events = $term->pty_ev_events ([$new_events])
1448 1574
1449Replaces the event mask of the pty watcher by the given event mask. Can 1575Replaces the event mask of the pty watcher by the given event mask. Can
1450be used to suppress input and output handling to the pty/tty. See the 1576be used to suppress input and output handling to the pty/tty. See the
1566 1692
1567Used after changing terminal contents to display them. 1693Used after changing terminal contents to display them.
1568 1694
1569=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1695=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1570 1696
1571Returns the text of the entire row with number C<$row_number>. Row C<0> 1697Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1572is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1698is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1573terminal line. The scrollback buffer starts at line C<-1> and extends to
1574line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1699terminal line. Nothing will be returned if a nonexistent line
1575is requested. 1700is requested.
1576 1701
1577If C<$new_text> is specified, it will replace characters in the current 1702If C<$new_text> is specified, it will replace characters in the current
1578line, starting at column C<$start_col> (default C<0>), which is useful 1703line, starting at column C<$start_col> (default C<0>), which is useful
1579to replace only parts of a line. The font index in the rendition will 1704to replace only parts of a line. The font index in the rendition will
1580automatically be updated. 1705automatically be updated.
1581 1706
1582C<$text> is in a special encoding: tabs and wide characters that use more 1707C<$text> is in a special encoding: tabs and wide characters that use more
1583than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1708than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1584characters. Characters with combining characters and other characters that 1709characters. Characters with combining characters and other characters that
1585do not fit into the normal tetx encoding will be replaced with characters 1710do not fit into the normal text encoding will be replaced with characters
1586in the private use area. 1711in the private use area.
1587 1712
1588You have to obey this encoding when changing text. The advantage is 1713You have to obey this encoding when changing text. The advantage is
1589that C<substr> and similar functions work on screen cells and not on 1714that C<substr> and similar functions work on screen cells and not on
1590characters. 1715characters.
1765Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1890Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1766recent grab. 1891recent grab.
1767 1892
1768=item $term->ungrab 1893=item $term->ungrab
1769 1894
1770Calls XUngrab for the most recent grab. Is called automatically on 1895Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1771evaluation errors, as it is better to lose the grab in the error case as 1896evaluation errors, as it is better to lose the grab in the error case as
1772the session. 1897the session.
1773 1898
1774=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1899=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775 1900
1777 1902
1778=item @atoms = $term->XListProperties ($window) 1903=item @atoms = $term->XListProperties ($window)
1779 1904
1780=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1905=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781 1906
1782=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1907=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1783 1908
1784=item $term->XDeleteProperty ($window, $property) 1909=item $term->XDeleteProperty ($window, $property)
1785 1910
1786=item $window = $term->DefaultRootWindow 1911=item $window = $term->DefaultRootWindow
1787 1912
1797 1922
1798=item $term->XChangeInput ($window, $add_events[, $del_events]) 1923=item $term->XChangeInput ($window, $add_events[, $del_events])
1799 1924
1800Various X or X-related functions. The C<$term> object only serves as 1925Various X or X-related functions. The C<$term> object only serves as
1801the source of the display, otherwise those functions map more-or-less 1926the source of the display, otherwise those functions map more-or-less
1802directory onto the X functions of the same name. 1927directly onto the X functions of the same name.
1803 1928
1804=back 1929=back
1805 1930
1806=cut 1931=cut
1807 1932
1909 my $env = $self->{term}->env; 2034 my $env = $self->{term}->env;
1910 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2035 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1911 delete $env->{LC_ALL}; 2036 delete $env->{LC_ALL};
1912 $env->{LC_CTYPE} = $self->{term}->locale; 2037 $env->{LC_CTYPE} = $self->{term}->locale;
1913 2038
1914 urxvt::term->new ($env, "popup", 2039 my $term = urxvt::term->new (
2040 $env, "popup",
1915 "--perl-lib" => "", "--perl-ext-common" => "", 2041 "--perl-lib" => "", "--perl-ext-common" => "",
1916 "-pty-fd" => -1, "-sl" => 0, 2042 "-pty-fd" => -1, "-sl" => 0,
1917 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2043 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1918 "--transient-for" => $self->{term}->parent, 2044 "--transient-for" => $self->{term}->parent,
1919 "-display" => $self->{term}->display_id, 2045 "-display" => $self->{term}->display_id,
1920 "-pe" => "urxvt-popup") 2046 "-pe" => "urxvt-popup",
1921 or die "unable to create popup window\n"; 2047 ) or die "unable to create popup window\n";
2048
2049 unless (delete $term->{urxvt_popup_init_done}) {
2050 $term->ungrab;
2051 $term->destroy;
2052 die "unable to initialise popup window\n";
2053 }
1922} 2054}
1923 2055
1924sub DESTROY { 2056sub DESTROY {
1925 my ($self) = @_; 2057 my ($self) = @_;
1926 2058
1931=back 2063=back
1932 2064
1933=cut 2065=cut
1934 2066
1935package urxvt::watcher; 2067package urxvt::watcher;
1936
1937@urxvt::timer::ISA = __PACKAGE__;
1938@urxvt::iow::ISA = __PACKAGE__;
1939@urxvt::pw::ISA = __PACKAGE__;
1940@urxvt::iw::ISA = __PACKAGE__;
1941 2068
1942=head2 The C<urxvt::timer> Class 2069=head2 The C<urxvt::timer> Class
1943 2070
1944This class implements timer watchers/events. Time is represented as a 2071This class implements timer watchers/events. Time is represented as a
1945fractional number of seconds since the epoch. Example: 2072fractional number of seconds since the epoch. Example:
1949 ->new 2076 ->new
1950 ->interval (1) 2077 ->interval (1)
1951 ->cb (sub { 2078 ->cb (sub {
1952 $term->{overlay}->set (0, 0, 2079 $term->{overlay}->set (0, 0,
1953 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2080 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954 }); 2081 });
1955 2082
1956=over 4 2083=over 4
1957 2084
1958=item $timer = new urxvt::timer 2085=item $timer = new urxvt::timer
1959 2086
1962 2089
1963=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2090=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1964 2091
1965Set the callback to be called when the timer triggers. 2092Set the callback to be called when the timer triggers.
1966 2093
1967=item $tstamp = $timer->at
1968
1969Return the time this watcher will fire next.
1970
1971=item $timer = $timer->set ($tstamp) 2094=item $timer = $timer->set ($tstamp[, $interval])
1972 2095
1973Set the time the event is generated to $tstamp. 2096Set the time the event is generated to $tstamp (and optionally specifies a
2097new $interval).
1974 2098
1975=item $timer = $timer->interval ($interval) 2099=item $timer = $timer->interval ($interval)
1976 2100
1977Normally (and when C<$interval> is C<0>), the timer will automatically 2101By default (and when C<$interval> is C<0>), the timer will automatically
1978stop after it has fired once. If C<$interval> is non-zero, then the timer 2102stop after it has fired once. If C<$interval> is non-zero, then the timer
1979is automatically rescheduled at the given intervals. 2103is automatically rescheduled at the given intervals.
1980 2104
1981=item $timer = $timer->start 2105=item $timer = $timer->start
1982 2106
1983Start the timer. 2107Start the timer.
1984 2108
1985=item $timer = $timer->start ($tstamp) 2109=item $timer = $timer->start ($tstamp[, $interval])
1986 2110
1987Set the event trigger time to C<$tstamp> and start the timer. 2111Set the event trigger time to C<$tstamp> and start the timer. Optionally
2112also replaces the interval.
1988 2113
1989=item $timer = $timer->after ($delay) 2114=item $timer = $timer->after ($delay[, $interval])
1990 2115
1991Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2116Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1992 2117
1993=item $timer = $timer->stop 2118=item $timer = $timer->stop
1994 2119
2002 2127
2003 $term->{socket} = ... 2128 $term->{socket} = ...
2004 $term->{iow} = urxvt::iow 2129 $term->{iow} = urxvt::iow
2005 ->new 2130 ->new
2006 ->fd (fileno $term->{socket}) 2131 ->fd (fileno $term->{socket})
2007 ->events (urxvt::EVENT_READ) 2132 ->events (urxvt::EV_READ)
2008 ->start 2133 ->start
2009 ->cb (sub { 2134 ->cb (sub {
2010 my ($iow, $revents) = @_; 2135 my ($iow, $revents) = @_;
2011 # $revents must be 1 here, no need to check 2136 # $revents must be 1 here, no need to check
2012 sysread $term->{socket}, my $buf, 8192 2137 sysread $term->{socket}, my $buf, 8192
2030Set the file descriptor (not handle) to watch. 2155Set the file descriptor (not handle) to watch.
2031 2156
2032=item $iow = $iow->events ($eventmask) 2157=item $iow = $iow->events ($eventmask)
2033 2158
2034Set the event mask to watch. The only allowed values are 2159Set the event mask to watch. The only allowed values are
2035C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2160C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2036together, or C<urxvt::EVENT_NONE>. 2161together, or C<urxvt::EV_NONE>.
2037 2162
2038=item $iow = $iow->start 2163=item $iow = $iow->start
2039 2164
2040Start watching for requested events on the given handle. 2165Start watching for requested events on the given handle.
2041 2166
2082 ->new 2207 ->new
2083 ->start ($pid) 2208 ->start ($pid)
2084 ->cb (sub { 2209 ->cb (sub {
2085 my ($pw, $exit_status) = @_; 2210 my ($pw, $exit_status) = @_;
2086 ... 2211 ...
2087 }); 2212 });
2088 2213
2089=over 4 2214=over 4
2090 2215
2091=item $pw = new urxvt::pw 2216=item $pw = new urxvt::pw
2092 2217
2131 http://software.schmorp.de/pkg/rxvt-unicode 2256 http://software.schmorp.de/pkg/rxvt-unicode
2132 2257
2133=cut 2258=cut
2134 2259
21351 22601
2261
2262# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines