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.145 by root, Thu Aug 10 22:53:20 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,
346in the C<selection-pastebin-url> resource (again, the % is the placeholder 368in the C<selection-pastebin-url> resource (again, the % is the placeholder
347for the filename): 369for the filename):
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
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of whether xrdb is used to parse the resource file
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.
391
351=item example-refresh-hooks 392=item example-refresh-hooks
352 393
353Displays 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
354window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
355overlays 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.
356 402
357=back 403=back
358 404
359=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
360 406
376 422
377=over 4 423=over 4
378 424
379=item $text 425=item $text
380 426
381Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
382always 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.
383 429
384=item $string 430=item $string
385 431
386A 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
520 566
521It 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,
522$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
523number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
524 570
525=item on_osc_seq $term, $op, $args 571=item on_osc_seq $term, $op, $args, $resp
526 572
527Called 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
528behaviour. 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
529suppresses execution of the request completely. Make sure you don't get 575suppresses execution of the request completely. Make sure you don't get
530confused by recursive invocations when you output an osc sequence within 576confused by recursive invocations when you output an OSC sequence within
531this callback. 577this callback.
532 578
533C<on_osc_seq_perl> should be used for new behaviour. 579C<on_osc_seq_perl> should be used for new behaviour.
534 580
535=item on_osc_seq_perl $term, $string 581=item on_osc_seq_perl $term, $args, $resp
536 582
537Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
538operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
539information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
540string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
541it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
542future. 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 }
543 599
544Be 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,
545as 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
546other 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.
547 606
548=item on_add_lines $term, $string 607=item on_add_lines $term, $string
549 608
550Called 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
551can 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
556=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
557 616
558Called 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
559suppress or filter tty input. 618suppress or filter tty input.
560 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
561=item on_line_update $term, $row 627=item on_line_update $term, $row
562 628
563Called 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
564screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
565that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
572later 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
573you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
574 640
575=item on_refresh_begin $term 641=item on_refresh_begin $term
576 642
577Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
578or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
579restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
580code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
581 647
582=item on_refresh_end $term 648=item on_refresh_end $term
583 649
590resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
591 657
592The 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
593slightly in the future. 659slightly in the future.
594 660
595=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
596 662
597Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
598windows 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
599returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
600 666
634 700
635=item on_map_notify $term, $event 701=item on_map_notify $term, $event
636 702
637=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
638 704
639Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
640the 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.
641 707
642The 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
643manpage), 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
644(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
645 711
654 720
655=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
656 722
657Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
658format=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.
659 729
660=back 730=back
661 731
662=cut 732=cut
663 733
728 798
729=over 4 799=over 4
730 800
731=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
732 802
733Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
734costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
735starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
736 807
737=item urxvt::warn $string 808=item urxvt::warn $string
738 809
739Calls 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
740newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
741that calls this function. 812that calls this function.
742 813
743Using 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
744correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
801 872
802=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
803 874
804Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
805 876
806=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
807 879
808Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
809underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
810the bitset. 882the bitset.
811 883
894 local $TERM = shift; 966 local $TERM = shift;
895 my $htype = shift; 967 my $htype = shift;
896 968
897 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
898 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
899 971
900 my %ext_arg; 972 my %ext_arg;
901 973
902 { 974 {
903 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
904 @TERM_INIT = (); 976 @TERM_INIT = ();
967 1039
968sub SET_COLOR($$$) { 1040sub SET_COLOR($$$) {
969 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1041 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
970} 1042}
971 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
972# urxvt::term::extension 1069# urxvt::term::extension
973 1070
974package urxvt::term::extension; 1071package urxvt::term::extension;
975 1072
976sub enable { 1073sub enable {
1045is 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
1046work. 1143work.
1047 1144
1048=cut 1145=cut
1049 1146
1050our $VERSION = 1; 1147our $VERSION = '5.23';
1051 1148
1052$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1053push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1054 1151
1055sub timer { 1152sub timer {
1057 1154
1058 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1059 1156
1060 urxvt::timer 1157 urxvt::timer
1061 ->new 1158 ->new
1062 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
1063 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
1064 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
1065 $cb->(); 1162 $cb->();
1066 }) 1163 })
1067} 1164}
1068 1165
1069sub io { 1166sub io {
1070 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
1071 1168
1072 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
1073 1172
1074 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
1075 ->new 1174 ->new
1076 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
1077 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1078 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
1079 ->start 1178 ->start
1080 ->cb (sub { 1179 ->cb ($cb)
1081 $cb->(($_[1] & 1 ? 'r' : '')
1082 . ($_[1] & 2 ? 'w' : ''));
1083 })],
1084 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 })
1085} 1206}
1086 1207
1087sub DESTROY { 1208sub DESTROY {
1088 $_[0][1]->stop; 1209 $_[0][1]->stop;
1089} 1210}
1090 1211
1091sub condvar { 1212sub one_event {
1092 bless \my $flag, urxvt::anyevent::condvar::
1093}
1094
1095sub urxvt::anyevent::condvar::broadcast {
1096 ${$_[0]}++;
1097}
1098
1099sub urxvt::anyevent::condvar::wait {
1100 unless (${$_[0]}) {
1101 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";
1102 }
1103} 1214}
1104 1215
1105package urxvt::term; 1216package urxvt::term;
1106 1217
1107=head2 The C<urxvt::term> Class 1218=head2 The C<urxvt::term> Class
1226Here 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
1227are 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>
1228to see the actual list: 1339to see the actual list:
1229 1340
1230 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1231 borderLess color cursorBlink cursorUnderline cutchars delete_key 1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1232 display_name embed ext_bwidth fade font geometry hold iconName 1343 display_name embed ext_bwidth fade font geometry hold iconName
1233 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1234 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1235 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1236 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1237 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1238 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1239 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1240 secondaryScreen secondaryScroll selectstyle shade term_name title 1351 secondaryScreen secondaryScroll shade term_name title
1241 transient_for transparent transparent_all tripleclickwords utmpInhibit 1352 transient_for transparent transparent_all tripleclickwords utmpInhibit
1242 visualBell 1353 visualBell
1243 1354
1244=cut 1355=cut
1245 1356
1246sub resource($$;$) { 1357sub resource($$;$) {
1247 my ($self, $name) = (shift, shift); 1358 my ($self, $name) = (shift, shift);
1248 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1359 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1249 &urxvt::term::_resource 1360 goto &urxvt::term::_resource
1250} 1361}
1251 1362
1252=item $value = $term->x_resource ($pattern) 1363=item $value = $term->x_resource ($pattern)
1253 1364
1254Returns the X-Resource for the given pattern, excluding the program or 1365Returns the X-Resource for the given pattern, excluding the program or
1279 1390
1280=item ($row, $col) = $term->selection_beg ([$row, $col]) 1391=item ($row, $col) = $term->selection_beg ([$row, $col])
1281 1392
1282=item ($row, $col) = $term->selection_end ([$row, $col]) 1393=item ($row, $col) = $term->selection_end ([$row, $col])
1283 1394
1284Return the current values of the selection mark, begin or end positions, 1395Return the current values of the selection mark, begin or end positions.
1285and 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.
1286 1404
1287=item $term->selection_make ($eventtime[, $rectangular]) 1405=item $term->selection_make ($eventtime[, $rectangular])
1288 1406
1289Tries to make a selection as set by C<selection_beg> and 1407Tries to make a selection as set by C<selection_beg> and
1290C<selection_end>. If C<$rectangular> is true (default: false), a 1408C<selection_end>. If C<$rectangular> is true (default: false), a
1291rectangular selection will be made. This is the prefered function to make 1409rectangular selection will be made. This is the preferred function to make
1292a selection. 1410a selection.
1293 1411
1294=item $success = $term->selection_grab ($eventtime) 1412=item $success = $term->selection_grab ($eventtime[, $clipboard])
1295 1413
1296Try 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
1297set by the next method). No visual feedback will be given. This function 1416with the next method. No visual feedback will be given. This function
1298is mostly useful from within C<on_sel_grab> hooks. 1417is mostly useful from within C<on_sel_grab> hooks.
1299 1418
1300=item $oldtext = $term->selection ([$newtext]) 1419=item $oldtext = $term->selection ([$newtext, $clipboard])
1301 1420
1302Return 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.
1303 1427
1304=item $term->overlay_simple ($x, $y, $text) 1428=item $term->overlay_simple ($x, $y, $text)
1305 1429
1306Create 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.
1307 1431
1337 1461
1338The methods currently supported on C<urxvt::overlay> objects are: 1462The methods currently supported on C<urxvt::overlay> objects are:
1339 1463
1340=over 4 1464=over 4
1341 1465
1342=item $overlay->set ($x, $y, $text, $rend) 1466=item $overlay->set ($x, $y, $text[, $rend])
1343 1467
1344Similar 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
1345text 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
1346at 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.
1347 1473
1348=item $overlay->hide 1474=item $overlay->hide
1349 1475
1350If visible, hide the overlay, but do not destroy it. 1476If visible, hide the overlay, but do not destroy it.
1351 1477
1433locale-specific encoding of the terminal and can contain command sequences 1559locale-specific encoding of the terminal and can contain command sequences
1434(escape codes) that will be interpreted. 1560(escape codes) that will be interpreted.
1435 1561
1436=item $term->tt_write ($octets) 1562=item $term->tt_write ($octets)
1437 1563
1438Write 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
1439pass characters instead of octets, you should convert your strings first 1565pass characters instead of octets, you should convert your strings first
1440to 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.
1441 1573
1442=item $old_events = $term->pty_ev_events ([$new_events]) 1574=item $old_events = $term->pty_ev_events ([$new_events])
1443 1575
1444Replaces 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
1445be 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
1561 1693
1562Used after changing terminal contents to display them. 1694Used after changing terminal contents to display them.
1563 1695
1564=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1696=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1565 1697
1566Returns 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 >>
1567is 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
1568terminal line. The scrollback buffer starts at line C<-1> and extends to
1569line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1700terminal line. Nothing will be returned if a nonexistent line
1570is requested. 1701is requested.
1571 1702
1572If 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
1573line, 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
1574to 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
1575automatically be updated. 1706automatically be updated.
1576 1707
1577C<$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
1578than 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)
1579characters. Characters with combining characters and other characters that 1710characters. Characters with combining characters and other characters that
1580do 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
1581in the private use area. 1712in the private use area.
1582 1713
1583You have to obey this encoding when changing text. The advantage is 1714You have to obey this encoding when changing text. The advantage is
1584that 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
1585characters. 1716characters.
1760Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1891Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1761recent grab. 1892recent grab.
1762 1893
1763=item $term->ungrab 1894=item $term->ungrab
1764 1895
1765Calls XUngrab for the most recent grab. Is called automatically on 1896Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1766evaluation 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
1767the session. 1898the session.
1768 1899
1769=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1900=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1770 1901
1772 1903
1773=item @atoms = $term->XListProperties ($window) 1904=item @atoms = $term->XListProperties ($window)
1774 1905
1775=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1906=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1776 1907
1777=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1908=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1778 1909
1779=item $term->XDeleteProperty ($window, $property) 1910=item $term->XDeleteProperty ($window, $property)
1780 1911
1781=item $window = $term->DefaultRootWindow 1912=item $window = $term->DefaultRootWindow
1782 1913
1792 1923
1793=item $term->XChangeInput ($window, $add_events[, $del_events]) 1924=item $term->XChangeInput ($window, $add_events[, $del_events])
1794 1925
1795Various 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
1796the source of the display, otherwise those functions map more-or-less 1927the source of the display, otherwise those functions map more-or-less
1797directory onto the X functions of the same name. 1928directly onto the X functions of the same name.
1798 1929
1799=back 1930=back
1800 1931
1801=cut 1932=cut
1802 1933
1904 my $env = $self->{term}->env; 2035 my $env = $self->{term}->env;
1905 # 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.
1906 delete $env->{LC_ALL}; 2037 delete $env->{LC_ALL};
1907 $env->{LC_CTYPE} = $self->{term}->locale; 2038 $env->{LC_CTYPE} = $self->{term}->locale;
1908 2039
1909 urxvt::term->new ($env, "popup", 2040 my $term = urxvt::term->new (
2041 $env, "popup",
1910 "--perl-lib" => "", "--perl-ext-common" => "", 2042 "--perl-lib" => "", "--perl-ext-common" => "",
1911 "-pty-fd" => -1, "-sl" => 0, 2043 "-pty-fd" => -1, "-sl" => 0,
1912 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2044 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1913 "--transient-for" => $self->{term}->parent, 2045 "--transient-for" => $self->{term}->parent,
1914 "-display" => $self->{term}->display_id, 2046 "-display" => $self->{term}->display_id,
1915 "-pe" => "urxvt-popup") 2047 "-pe" => "urxvt-popup",
1916 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 }
1917} 2055}
1918 2056
1919sub DESTROY { 2057sub DESTROY {
1920 my ($self) = @_; 2058 my ($self) = @_;
1921 2059
1926=back 2064=back
1927 2065
1928=cut 2066=cut
1929 2067
1930package urxvt::watcher; 2068package urxvt::watcher;
1931
1932@urxvt::timer::ISA = __PACKAGE__;
1933@urxvt::iow::ISA = __PACKAGE__;
1934@urxvt::pw::ISA = __PACKAGE__;
1935@urxvt::iw::ISA = __PACKAGE__;
1936 2069
1937=head2 The C<urxvt::timer> Class 2070=head2 The C<urxvt::timer> Class
1938 2071
1939This class implements timer watchers/events. Time is represented as a 2072This class implements timer watchers/events. Time is represented as a
1940fractional number of seconds since the epoch. Example: 2073fractional number of seconds since the epoch. Example:
1944 ->new 2077 ->new
1945 ->interval (1) 2078 ->interval (1)
1946 ->cb (sub { 2079 ->cb (sub {
1947 $term->{overlay}->set (0, 0, 2080 $term->{overlay}->set (0, 0,
1948 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2081 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1949 }); 2082 });
1950 2083
1951=over 4 2084=over 4
1952 2085
1953=item $timer = new urxvt::timer 2086=item $timer = new urxvt::timer
1954 2087
1957 2090
1958=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2091=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1959 2092
1960Set the callback to be called when the timer triggers. 2093Set the callback to be called when the timer triggers.
1961 2094
1962=item $tstamp = $timer->at
1963
1964Return the time this watcher will fire next.
1965
1966=item $timer = $timer->set ($tstamp) 2095=item $timer = $timer->set ($tstamp[, $interval])
1967 2096
1968Set the time the event is generated to $tstamp. 2097Set the time the event is generated to $tstamp (and optionally specifies a
2098new $interval).
1969 2099
1970=item $timer = $timer->interval ($interval) 2100=item $timer = $timer->interval ($interval)
1971 2101
1972Normally (and when C<$interval> is C<0>), the timer will automatically 2102By default (and when C<$interval> is C<0>), the timer will automatically
1973stop 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
1974is automatically rescheduled at the given intervals. 2104is automatically rescheduled at the given intervals.
1975 2105
1976=item $timer = $timer->start 2106=item $timer = $timer->start
1977 2107
1978Start the timer. 2108Start the timer.
1979 2109
1980=item $timer = $timer->start ($tstamp) 2110=item $timer = $timer->start ($tstamp[, $interval])
1981 2111
1982Set 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.
1983 2114
1984=item $timer = $timer->after ($delay) 2115=item $timer = $timer->after ($delay[, $interval])
1985 2116
1986Like 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>.
1987 2118
1988=item $timer = $timer->stop 2119=item $timer = $timer->stop
1989 2120
1997 2128
1998 $term->{socket} = ... 2129 $term->{socket} = ...
1999 $term->{iow} = urxvt::iow 2130 $term->{iow} = urxvt::iow
2000 ->new 2131 ->new
2001 ->fd (fileno $term->{socket}) 2132 ->fd (fileno $term->{socket})
2002 ->events (urxvt::EVENT_READ) 2133 ->events (urxvt::EV_READ)
2003 ->start 2134 ->start
2004 ->cb (sub { 2135 ->cb (sub {
2005 my ($iow, $revents) = @_; 2136 my ($iow, $revents) = @_;
2006 # $revents must be 1 here, no need to check 2137 # $revents must be 1 here, no need to check
2007 sysread $term->{socket}, my $buf, 8192 2138 sysread $term->{socket}, my $buf, 8192
2025Set the file descriptor (not handle) to watch. 2156Set the file descriptor (not handle) to watch.
2026 2157
2027=item $iow = $iow->events ($eventmask) 2158=item $iow = $iow->events ($eventmask)
2028 2159
2029Set the event mask to watch. The only allowed values are 2160Set the event mask to watch. The only allowed values are
2030C<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
2031together, or C<urxvt::EVENT_NONE>. 2162together, or C<urxvt::EV_NONE>.
2032 2163
2033=item $iow = $iow->start 2164=item $iow = $iow->start
2034 2165
2035Start watching for requested events on the given handle. 2166Start watching for requested events on the given handle.
2036 2167
2077 ->new 2208 ->new
2078 ->start ($pid) 2209 ->start ($pid)
2079 ->cb (sub { 2210 ->cb (sub {
2080 my ($pw, $exit_status) = @_; 2211 my ($pw, $exit_status) = @_;
2081 ... 2212 ...
2082 }); 2213 });
2083 2214
2084=over 4 2215=over 4
2085 2216
2086=item $pw = new urxvt::pw 2217=item $pw = new urxvt::pw
2087 2218
2126 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
2127 2258
2128=cut 2259=cut
2129 2260
21301 22611
2262
2263# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines