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.191 by sf-exg, Fri Jan 7 21:55:28 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
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
733 798
734=over 4 799=over 4
735 800
736=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
737 802
738Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
739costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
740starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
741 807
742=item urxvt::warn $string 808=item urxvt::warn $string
743 809
744Calls 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
745newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
746that calls this function. 812that calls this function.
747 813
748Using 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
749correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
806 872
807=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
808 874
809Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
810 876
811=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
812 879
813Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
814underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
815the bitset. 882the bitset.
816 883
899 local $TERM = shift; 966 local $TERM = shift;
900 my $htype = shift; 967 my $htype = shift;
901 968
902 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
903 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
904 971
905 my %ext_arg; 972 my %ext_arg;
906 973
907 { 974 {
908 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
909 @TERM_INIT = (); 976 @TERM_INIT = ();
972 1039
973sub SET_COLOR($$$) { 1040sub SET_COLOR($$$) {
974 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1041 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
975} 1042}
976 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
977# urxvt::term::extension 1069# urxvt::term::extension
978 1070
979package urxvt::term::extension; 1071package urxvt::term::extension;
980 1072
981sub enable { 1073sub enable {
1050is 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
1051work. 1143work.
1052 1144
1053=cut 1145=cut
1054 1146
1055our $VERSION = 1; 1147our $VERSION = '5.23';
1056 1148
1057$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1058push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1059 1151
1060sub timer { 1152sub timer {
1062 1154
1063 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1064 1156
1065 urxvt::timer 1157 urxvt::timer
1066 ->new 1158 ->new
1067 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
1068 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
1069 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
1070 $cb->(); 1162 $cb->();
1071 }) 1163 })
1072} 1164}
1073 1165
1074sub io { 1166sub io {
1075 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
1076 1168
1077 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
1078 1172
1079 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
1080 ->new 1174 ->new
1081 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
1082 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1083 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
1084 ->start 1178 ->start
1085 ->cb (sub { 1179 ->cb ($cb)
1086 $cb->(($_[1] & 1 ? 'r' : '')
1087 . ($_[1] & 2 ? 'w' : ''));
1088 })],
1089 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 })
1090} 1206}
1091 1207
1092sub DESTROY { 1208sub DESTROY {
1093 $_[0][1]->stop; 1209 $_[0][1]->stop;
1094} 1210}
1095 1211
1096sub condvar { 1212sub 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"; 1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1107 }
1108} 1214}
1109 1215
1110package urxvt::term; 1216package urxvt::term;
1111 1217
1112=head2 The C<urxvt::term> Class 1218=head2 The C<urxvt::term> Class
1231Here 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
1232are 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>
1233to see the actual list: 1339to see the actual list:
1234 1340
1235 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1236 borderLess color cursorBlink cursorUnderline cutchars delete_key 1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1237 display_name embed ext_bwidth fade font geometry hold iconName 1343 display_name embed ext_bwidth fade font geometry hold iconName
1238 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1239 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1240 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1241 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1242 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1243 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1244 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1245 secondaryScreen secondaryScroll selectstyle shade term_name title 1351 secondaryScreen secondaryScroll shade term_name title
1246 transient_for transparent transparent_all tripleclickwords utmpInhibit 1352 transient_for transparent transparent_all tripleclickwords utmpInhibit
1247 visualBell 1353 visualBell
1248 1354
1249=cut 1355=cut
1250 1356
1251sub resource($$;$) { 1357sub resource($$;$) {
1252 my ($self, $name) = (shift, shift); 1358 my ($self, $name) = (shift, shift);
1253 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1359 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1254 &urxvt::term::_resource 1360 goto &urxvt::term::_resource
1255} 1361}
1256 1362
1257=item $value = $term->x_resource ($pattern) 1363=item $value = $term->x_resource ($pattern)
1258 1364
1259Returns the X-Resource for the given pattern, excluding the program or 1365Returns the X-Resource for the given pattern, excluding the program or
1284 1390
1285=item ($row, $col) = $term->selection_beg ([$row, $col]) 1391=item ($row, $col) = $term->selection_beg ([$row, $col])
1286 1392
1287=item ($row, $col) = $term->selection_end ([$row, $col]) 1393=item ($row, $col) = $term->selection_end ([$row, $col])
1288 1394
1289Return the current values of the selection mark, begin or end positions, 1395Return the current values of the selection mark, begin or end positions.
1290and 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.
1291 1404
1292=item $term->selection_make ($eventtime[, $rectangular]) 1405=item $term->selection_make ($eventtime[, $rectangular])
1293 1406
1294Tries to make a selection as set by C<selection_beg> and 1407Tries to make a selection as set by C<selection_beg> and
1295C<selection_end>. If C<$rectangular> is true (default: false), a 1408C<selection_end>. If C<$rectangular> is true (default: false), a
1296rectangular selection will be made. This is the prefered function to make 1409rectangular selection will be made. This is the preferred function to make
1297a selection. 1410a selection.
1298 1411
1299=item $success = $term->selection_grab ($eventtime) 1412=item $success = $term->selection_grab ($eventtime[, $clipboard])
1300 1413
1301Try 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
1302set by the next method). No visual feedback will be given. This function 1416with the next method. No visual feedback will be given. This function
1303is mostly useful from within C<on_sel_grab> hooks. 1417is mostly useful from within C<on_sel_grab> hooks.
1304 1418
1305=item $oldtext = $term->selection ([$newtext]) 1419=item $oldtext = $term->selection ([$newtext, $clipboard])
1306 1420
1307Return 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.
1308 1427
1309=item $term->overlay_simple ($x, $y, $text) 1428=item $term->overlay_simple ($x, $y, $text)
1310 1429
1311Create 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.
1312 1431
1342 1461
1343The methods currently supported on C<urxvt::overlay> objects are: 1462The methods currently supported on C<urxvt::overlay> objects are:
1344 1463
1345=over 4 1464=over 4
1346 1465
1347=item $overlay->set ($x, $y, $text, $rend) 1466=item $overlay->set ($x, $y, $text[, $rend])
1348 1467
1349Similar 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
1350text 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
1351at 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.
1352 1473
1353=item $overlay->hide 1474=item $overlay->hide
1354 1475
1355If visible, hide the overlay, but do not destroy it. 1476If visible, hide the overlay, but do not destroy it.
1356 1477
1438locale-specific encoding of the terminal and can contain command sequences 1559locale-specific encoding of the terminal and can contain command sequences
1439(escape codes) that will be interpreted. 1560(escape codes) that will be interpreted.
1440 1561
1441=item $term->tt_write ($octets) 1562=item $term->tt_write ($octets)
1442 1563
1443Write 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
1444pass characters instead of octets, you should convert your strings first 1565pass characters instead of octets, you should convert your strings first
1445to 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.
1446 1573
1447=item $old_events = $term->pty_ev_events ([$new_events]) 1574=item $old_events = $term->pty_ev_events ([$new_events])
1448 1575
1449Replaces 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
1450be 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
1566 1693
1567Used after changing terminal contents to display them. 1694Used after changing terminal contents to display them.
1568 1695
1569=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1696=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1570 1697
1571Returns 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 >>
1572is 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
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 1700terminal line. Nothing will be returned if a nonexistent line
1575is requested. 1701is requested.
1576 1702
1577If 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
1578line, 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
1579to 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
1580automatically be updated. 1706automatically be updated.
1581 1707
1582C<$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
1583than 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)
1584characters. Characters with combining characters and other characters that 1710characters. Characters with combining characters and other characters that
1585do 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
1586in the private use area. 1712in the private use area.
1587 1713
1588You have to obey this encoding when changing text. The advantage is 1714You have to obey this encoding when changing text. The advantage is
1589that 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
1590characters. 1716characters.
1765Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1891Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1766recent grab. 1892recent grab.
1767 1893
1768=item $term->ungrab 1894=item $term->ungrab
1769 1895
1770Calls XUngrab for the most recent grab. Is called automatically on 1896Calls 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 1897evaluation errors, as it is better to lose the grab in the error case as
1772the session. 1898the session.
1773 1899
1774=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1900=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775 1901
1777 1903
1778=item @atoms = $term->XListProperties ($window) 1904=item @atoms = $term->XListProperties ($window)
1779 1905
1780=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1906=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781 1907
1782=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1908=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1783 1909
1784=item $term->XDeleteProperty ($window, $property) 1910=item $term->XDeleteProperty ($window, $property)
1785 1911
1786=item $window = $term->DefaultRootWindow 1912=item $window = $term->DefaultRootWindow
1787 1913
1797 1923
1798=item $term->XChangeInput ($window, $add_events[, $del_events]) 1924=item $term->XChangeInput ($window, $add_events[, $del_events])
1799 1925
1800Various 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
1801the source of the display, otherwise those functions map more-or-less 1927the source of the display, otherwise those functions map more-or-less
1802directory onto the X functions of the same name. 1928directly onto the X functions of the same name.
1803 1929
1804=back 1930=back
1805 1931
1806=cut 1932=cut
1807 1933
1909 my $env = $self->{term}->env; 2035 my $env = $self->{term}->env;
1910 # 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.
1911 delete $env->{LC_ALL}; 2037 delete $env->{LC_ALL};
1912 $env->{LC_CTYPE} = $self->{term}->locale; 2038 $env->{LC_CTYPE} = $self->{term}->locale;
1913 2039
1914 urxvt::term->new ($env, "popup", 2040 my $term = urxvt::term->new (
2041 $env, "popup",
1915 "--perl-lib" => "", "--perl-ext-common" => "", 2042 "--perl-lib" => "", "--perl-ext-common" => "",
1916 "-pty-fd" => -1, "-sl" => 0, 2043 "-pty-fd" => -1, "-sl" => 0,
1917 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2044 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1918 "--transient-for" => $self->{term}->parent, 2045 "--transient-for" => $self->{term}->parent,
1919 "-display" => $self->{term}->display_id, 2046 "-display" => $self->{term}->display_id,
1920 "-pe" => "urxvt-popup") 2047 "-pe" => "urxvt-popup",
1921 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 }
1922} 2055}
1923 2056
1924sub DESTROY { 2057sub DESTROY {
1925 my ($self) = @_; 2058 my ($self) = @_;
1926 2059
1931=back 2064=back
1932 2065
1933=cut 2066=cut
1934 2067
1935package urxvt::watcher; 2068package urxvt::watcher;
1936
1937@urxvt::timer::ISA = __PACKAGE__;
1938@urxvt::iow::ISA = __PACKAGE__;
1939@urxvt::pw::ISA = __PACKAGE__;
1940@urxvt::iw::ISA = __PACKAGE__;
1941 2069
1942=head2 The C<urxvt::timer> Class 2070=head2 The C<urxvt::timer> Class
1943 2071
1944This class implements timer watchers/events. Time is represented as a 2072This class implements timer watchers/events. Time is represented as a
1945fractional number of seconds since the epoch. Example: 2073fractional number of seconds since the epoch. Example:
1949 ->new 2077 ->new
1950 ->interval (1) 2078 ->interval (1)
1951 ->cb (sub { 2079 ->cb (sub {
1952 $term->{overlay}->set (0, 0, 2080 $term->{overlay}->set (0, 0,
1953 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2081 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1954 }); 2082 });
1955 2083
1956=over 4 2084=over 4
1957 2085
1958=item $timer = new urxvt::timer 2086=item $timer = new urxvt::timer
1959 2087
1962 2090
1963=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2091=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1964 2092
1965Set the callback to be called when the timer triggers. 2093Set the callback to be called when the timer triggers.
1966 2094
1967=item $tstamp = $timer->at
1968
1969Return the time this watcher will fire next.
1970
1971=item $timer = $timer->set ($tstamp) 2095=item $timer = $timer->set ($tstamp[, $interval])
1972 2096
1973Set the time the event is generated to $tstamp. 2097Set the time the event is generated to $tstamp (and optionally specifies a
2098new $interval).
1974 2099
1975=item $timer = $timer->interval ($interval) 2100=item $timer = $timer->interval ($interval)
1976 2101
1977Normally (and when C<$interval> is C<0>), the timer will automatically 2102By 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 2103stop after it has fired once. If C<$interval> is non-zero, then the timer
1979is automatically rescheduled at the given intervals. 2104is automatically rescheduled at the given intervals.
1980 2105
1981=item $timer = $timer->start 2106=item $timer = $timer->start
1982 2107
1983Start the timer. 2108Start the timer.
1984 2109
1985=item $timer = $timer->start ($tstamp) 2110=item $timer = $timer->start ($tstamp[, $interval])
1986 2111
1987Set 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.
1988 2114
1989=item $timer = $timer->after ($delay) 2115=item $timer = $timer->after ($delay[, $interval])
1990 2116
1991Like 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>.
1992 2118
1993=item $timer = $timer->stop 2119=item $timer = $timer->stop
1994 2120
2002 2128
2003 $term->{socket} = ... 2129 $term->{socket} = ...
2004 $term->{iow} = urxvt::iow 2130 $term->{iow} = urxvt::iow
2005 ->new 2131 ->new
2006 ->fd (fileno $term->{socket}) 2132 ->fd (fileno $term->{socket})
2007 ->events (urxvt::EVENT_READ) 2133 ->events (urxvt::EV_READ)
2008 ->start 2134 ->start
2009 ->cb (sub { 2135 ->cb (sub {
2010 my ($iow, $revents) = @_; 2136 my ($iow, $revents) = @_;
2011 # $revents must be 1 here, no need to check 2137 # $revents must be 1 here, no need to check
2012 sysread $term->{socket}, my $buf, 8192 2138 sysread $term->{socket}, my $buf, 8192
2030Set the file descriptor (not handle) to watch. 2156Set the file descriptor (not handle) to watch.
2031 2157
2032=item $iow = $iow->events ($eventmask) 2158=item $iow = $iow->events ($eventmask)
2033 2159
2034Set the event mask to watch. The only allowed values are 2160Set the event mask to watch. The only allowed values are
2035C<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
2036together, or C<urxvt::EVENT_NONE>. 2162together, or C<urxvt::EV_NONE>.
2037 2163
2038=item $iow = $iow->start 2164=item $iow = $iow->start
2039 2165
2040Start watching for requested events on the given handle. 2166Start watching for requested events on the given handle.
2041 2167
2082 ->new 2208 ->new
2083 ->start ($pid) 2209 ->start ($pid)
2084 ->cb (sub { 2210 ->cb (sub {
2085 my ($pw, $exit_status) = @_; 2211 my ($pw, $exit_status) = @_;
2086 ... 2212 ...
2087 }); 2213 });
2088 2214
2089=over 4 2215=over 4
2090 2216
2091=item $pw = new urxvt::pw 2217=item $pw = new urxvt::pw
2092 2218
2131 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
2132 2258
2133=cut 2259=cut
2134 2260
21351 22611
2262
2263# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines