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.144 by root, Mon Aug 7 15:59:44 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 2010 UTC

26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
109The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
110C<$self->{myoption}>: 113C<< $self->{myoption} >>:
111 114
112 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 }; 117 };
115 118
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide whether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 157selection if the C<Shift> modifier is active.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
166move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
240 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
241 244
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid 245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices. 246indices.
244 247
245=item mark-urls 248=item matcher
246 249
247Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
248make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
249resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
250the URL as first argument. 253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
251 276
252=item xim-onthespot 277=item xim-onthespot
253 278
254This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
255not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
256OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
257kinput2. 282kinput2.
258 283
259You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
261 286
269will show or hide itself. Another press of the accelerator key will hide 294will show or hide itself. Another press of the accelerator key will hide
270or show it again. 295or show it again.
271 296
272Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
273 298
274This is useful if you need a single terminal thats not using any desktop 299This is useful if you need a single terminal that is not using any desktop
275space most of the time but is quickly available at the press of a key. 300space most of the time but is quickly available at the press of a key.
276 301
277The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
278extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
279 304
280If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
281(fvwm can do it). 306(fvwm can do it).
282 307
283=item automove-background 308=item overlay-osc
284 309
285This is basically a very small extension that dynamically changes the 310This extension implements some OSC commands to display timed popups on the
286background pixmap offset to the window position, in effect creating the 311screen - useful for status displays from within scripts. You have to read
287same effect as pseudo transparency with a custom pixmap. No scaling is 312the sources for more info.
288supported in this mode. Example:
289
290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291 313
292=item block-graphics-to-ascii 314=item block-graphics-to-ascii
293 315
294A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
295by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
300Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
301 323
302=item remote-clipboard 324=item remote-clipboard
303 325
304Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
305selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
306selection somewhere and fetch it again. 328selection somewhere and fetch it again.
307 329
308We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
309means that one command uploads the file to a remote server, and another 331means that one command uploads the file to a remote server, and another
310reads it. 332reads it.
319 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321 343
322=item selection-pastebin 344=item selection-pastebin
323 345
324This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that uploads the selection as
325textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
326not currently secure for use in a multiuser environment as it writes to 348not currently secure for use in a multiuser environment as it writes to
327F</tmp> directly.). 349F</tmp> directly.).
328 350
329It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
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
395=back 441=back
396 442
397=head2 Extension Objects 443=head2 Extension Objects
398 444
399Every perl extension is a perl class. A separate perl object is created 445Every perl extension is a perl class. A separate perl object is created
400for each terminal and each extension and passed as the first parameter to 446for each terminal, and each terminal has its own set of extenion objects,
401hooks. So extensions can use their C<$self> object without having to think 447which are passed as the first parameter to hooks. So extensions can use
402about other extensions, with the exception of methods and members that 448their C<$self> object without having to think about clashes with other
449extensions or other terminals, with the exception of methods and members
403begin with an underscore character C<_>: these are reserved for internal 450that begin with an underscore character C<_>: these are reserved for
404use. 451internal use.
405 452
406Although it isn't a C<urxvt::term> object, you can call all methods of the 453Although it isn't a C<urxvt::term> object, you can call all methods of the
407C<urxvt::term> class on this object. 454C<urxvt::term> class on this object.
408 455
409It has the following methods and data members: 456It has the following methods and data members:
519 566
520It 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,
521$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
522number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
523 570
524=item on_osc_seq $term, $op, $args 571=item on_osc_seq $term, $op, $args, $resp
525 572
526Called 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
527behaviour. 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
528suppresses execution of the request completely. Make sure you don't get 575suppresses execution of the request completely. Make sure you don't get
529confused by recursive invocations when you output an osc sequence within 576confused by recursive invocations when you output an OSC sequence within
530this callback. 577this callback.
531 578
532C<on_osc_seq_perl> should be used for new behaviour. 579C<on_osc_seq_perl> should be used for new behaviour.
533 580
534=item on_osc_seq_perl $term, $string 581=item on_osc_seq_perl $term, $args, $resp
535 582
536Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
538information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
539string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
540it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
541future. 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 }
542 599
543Be 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,
544as 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
545other 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.
546 606
547=item on_add_lines $term, $string 607=item on_add_lines $term, $string
548 608
549Called 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
550can 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
555=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
556 616
557Called 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
558suppress or filter tty input. 618suppress or filter tty input.
559 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
560=item on_line_update $term, $row 627=item on_line_update $term, $row
561 628
562Called 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
563screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
564that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
571later 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
572you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
573 640
574=item on_refresh_begin $term 641=item on_refresh_begin $term
575 642
576Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
577or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
578restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
579code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
580 647
581=item on_refresh_end $term 648=item on_refresh_end $term
582 649
589resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
590 657
591The 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
592slightly in the future. 659slightly in the future.
593 660
594=item on_resize_all_windows $tern, $new_width, $new_height 661=item on_resize_all_windows $term, $new_width, $new_height
595 662
596Called just after the new window size has been calculated, but before 663Called just after the new window size has been calculated, but before
597windows 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
598returns TRUE, setting of the window hints is being skipped. 665returns TRUE, setting of the window hints is being skipped.
599 666
633 700
634=item on_map_notify $term, $event 701=item on_map_notify $term, $event
635 702
636=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
637 704
638Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
639the 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.
640 707
641The 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
642manpage), 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
643(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
644 711
653 720
654=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
655 722
656Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
657format=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.
658 729
659=back 730=back
660 731
661=cut 732=cut
662 733
800 871
801=item $rend = urxvt::OVERLAY_RSTYLE 872=item $rend = urxvt::OVERLAY_RSTYLE
802 873
803Return the rendition mask used for overlays by default. 874Return the rendition mask used for overlays by default.
804 875
805=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 876=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
877urxvt::RS_RVid, urxvt::RS_Uline
806 878
807Return the bit that enabled bold, italic, blink, reverse-video and 879Return the bit that enabled bold, italic, blink, reverse-video and
808underline, respectively. To enable such a style, just logically OR it into 880underline, respectively. To enable such a style, just logically OR it into
809the bitset. 881the bitset.
810 882
893 local $TERM = shift; 965 local $TERM = shift;
894 my $htype = shift; 966 my $htype = shift;
895 967
896 if ($htype == 0) { # INIT 968 if ($htype == 0) { # INIT
897 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 969 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
898 970
899 my %ext_arg; 971 my %ext_arg;
900 972
901 { 973 {
902 my @init = @TERM_INIT; 974 my @init = @TERM_INIT;
903 @TERM_INIT = (); 975 @TERM_INIT = ();
966 1038
967sub SET_COLOR($$$) { 1039sub SET_COLOR($$$) {
968 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1040 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969} 1041}
970 1042
1043sub rend2mask {
1044 no strict 'refs';
1045 my ($str, $mask) = (@_, 0);
1046 my %color = ( fg => undef, bg => undef );
1047 my @failed;
1048 for my $spec ( split /\s+/, $str ) {
1049 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1050 $color{lc($1)} = $2;
1051 } else {
1052 my $neg = $spec =~ s/^[-^]//;
1053 unless ( exists &{"RS_$spec"} ) {
1054 push @failed, $spec;
1055 next;
1056 }
1057 my $cur = &{"RS_$spec"};
1058 if ( $neg ) {
1059 $mask &= ~$cur;
1060 } else {
1061 $mask |= $cur;
1062 }
1063 }
1064 }
1065 ($mask, @color{qw(fg bg)}, \@failed)
1066}
1067
971# urxvt::term::extension 1068# urxvt::term::extension
972 1069
973package urxvt::term::extension; 1070package urxvt::term::extension;
974 1071
975sub enable { 1072sub enable {
1044is that you cannot use blocking APIs, but the non-blocking variant should 1141is that you cannot use blocking APIs, but the non-blocking variant should
1045work. 1142work.
1046 1143
1047=cut 1144=cut
1048 1145
1049our $VERSION = 1; 1146our $VERSION = '5.23';
1050 1147
1051$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1148$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1149push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053 1150
1054sub timer { 1151sub timer {
1056 1153
1057 my $cb = $arg{cb}; 1154 my $cb = $arg{cb};
1058 1155
1059 urxvt::timer 1156 urxvt::timer
1060 ->new 1157 ->new
1061 ->start (urxvt::NOW + $arg{after}) 1158 ->after ($arg{after}, $arg{interval})
1062 ->cb (sub { 1159 ->cb ($arg{interval} ? $cb : sub {
1063 $_[0]->stop; # need to cancel manually 1160 $_[0]->stop; # need to cancel manually
1064 $cb->(); 1161 $cb->();
1065 }) 1162 })
1066} 1163}
1067 1164
1068sub io { 1165sub io {
1069 my ($class, %arg) = @_; 1166 my ($class, %arg) = @_;
1070 1167
1071 my $cb = $arg{cb}; 1168 my $cb = $arg{cb};
1169 my $fd = fileno $arg{fh};
1170 defined $fd or $fd = $arg{fh};
1072 1171
1073 bless [$arg{fh}, urxvt::iow 1172 bless [$arg{fh}, urxvt::iow
1074 ->new 1173 ->new
1075 ->fd (fileno $arg{fh}) 1174 ->fd ($fd)
1076 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1175 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1077 | ($arg{poll} =~ /w/ ? 2 : 0)) 1176 | ($arg{poll} =~ /w/ ? 2 : 0))
1078 ->start 1177 ->start
1079 ->cb (sub { 1178 ->cb ($cb)
1080 $cb->(($_[1] & 1 ? 'r' : '')
1081 . ($_[1] & 2 ? 'w' : ''));
1082 })],
1083 urxvt::anyevent:: 1179 ], urxvt::anyevent::
1180}
1181
1182sub idle {
1183 my ($class, %arg) = @_;
1184
1185 my $cb = $arg{cb};
1186
1187 urxvt::iw
1188 ->new
1189 ->start
1190 ->cb ($cb)
1191}
1192
1193sub child {
1194 my ($class, %arg) = @_;
1195
1196 my $cb = $arg{cb};
1197
1198 urxvt::pw
1199 ->new
1200 ->start ($arg{pid})
1201 ->cb (sub {
1202 $_[0]->stop; # need to cancel manually
1203 $cb->($_[0]->rpid, $_[0]->rstatus);
1204 })
1084} 1205}
1085 1206
1086sub DESTROY { 1207sub DESTROY {
1087 $_[0][1]->stop; 1208 $_[0][1]->stop;
1088} 1209}
1089 1210
1090sub condvar { 1211sub one_event {
1091 bless \my $flag, urxvt::anyevent::condvar::
1092}
1093
1094sub urxvt::anyevent::condvar::broadcast {
1095 ${$_[0]}++;
1096}
1097
1098sub urxvt::anyevent::condvar::wait {
1099 unless (${$_[0]}) {
1100 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1212 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1101 }
1102} 1213}
1103 1214
1104package urxvt::term; 1215package urxvt::term;
1105 1216
1106=head2 The C<urxvt::term> Class 1217=head2 The C<urxvt::term> Class
1225Here is a likely non-exhaustive list of resource names, not all of which 1336Here is a likely non-exhaustive list of resource names, not all of which
1226are supported in every build, please see the source file F</src/rsinc.h> 1337are supported in every build, please see the source file F</src/rsinc.h>
1227to see the actual list: 1338to see the actual list:
1228 1339
1229 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1340 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1230 borderLess color cursorBlink cursorUnderline cutchars delete_key 1341 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1231 display_name embed ext_bwidth fade font geometry hold iconName 1342 display_name embed ext_bwidth fade font geometry hold iconName
1232 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1343 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1233 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1344 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1234 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1345 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1235 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1346 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1347 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1348 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1349 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239 secondaryScreen secondaryScroll selectstyle shade term_name title 1350 secondaryScreen secondaryScroll shade term_name title
1240 transient_for transparent transparent_all tripleclickwords utmpInhibit 1351 transient_for transparent transparent_all tripleclickwords utmpInhibit
1241 visualBell 1352 visualBell
1242 1353
1243=cut 1354=cut
1244 1355
1245sub resource($$;$) { 1356sub resource($$;$) {
1246 my ($self, $name) = (shift, shift); 1357 my ($self, $name) = (shift, shift);
1247 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1358 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1248 &urxvt::term::_resource 1359 goto &urxvt::term::_resource
1249} 1360}
1250 1361
1251=item $value = $term->x_resource ($pattern) 1362=item $value = $term->x_resource ($pattern)
1252 1363
1253Returns the X-Resource for the given pattern, excluding the program or 1364Returns the X-Resource for the given pattern, excluding the program or
1278 1389
1279=item ($row, $col) = $term->selection_beg ([$row, $col]) 1390=item ($row, $col) = $term->selection_beg ([$row, $col])
1280 1391
1281=item ($row, $col) = $term->selection_end ([$row, $col]) 1392=item ($row, $col) = $term->selection_end ([$row, $col])
1282 1393
1283Return the current values of the selection mark, begin or end positions, 1394Return the current values of the selection mark, begin or end positions.
1284and optionally set them to new values. 1395
1396When arguments are given, then the selection coordinates are set to
1397C<$row> and C<$col>, and the selection screen is set to the current
1398screen.
1399
1400=item $screen = $term->selection_screen ([$screen])
1401
1402Returns the current selection screen, and then optionally sets it.
1285 1403
1286=item $term->selection_make ($eventtime[, $rectangular]) 1404=item $term->selection_make ($eventtime[, $rectangular])
1287 1405
1288Tries to make a selection as set by C<selection_beg> and 1406Tries to make a selection as set by C<selection_beg> and
1289C<selection_end>. If C<$rectangular> is true (default: false), a 1407C<selection_end>. If C<$rectangular> is true (default: false), a
1290rectangular selection will be made. This is the prefered function to make 1408rectangular selection will be made. This is the preferred function to make
1291a selection. 1409a selection.
1292 1410
1293=item $success = $term->selection_grab ($eventtime) 1411=item $success = $term->selection_grab ($eventtime[, $clipboard])
1294 1412
1295Try to request the primary selection text from the server (for example, as 1413Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1414true) selection from the server. The corresponding text can be set
1296set by the next method). No visual feedback will be given. This function 1415with the next method. No visual feedback will be given. This function
1297is mostly useful from within C<on_sel_grab> hooks. 1416is mostly useful from within C<on_sel_grab> hooks.
1298 1417
1299=item $oldtext = $term->selection ([$newtext]) 1418=item $oldtext = $term->selection ([$newtext, $clipboard])
1300 1419
1301Return the current selection text and optionally replace it by C<$newtext>. 1420Return the current selection (clipboard if C<$clipboard> is true) text
1421and optionally replace it by C<$newtext>.
1422
1423=item $term->selection_clear ([$clipboard])
1424
1425Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1302 1426
1303=item $term->overlay_simple ($x, $y, $text) 1427=item $term->overlay_simple ($x, $y, $text)
1304 1428
1305Create a simple multi-line overlay box. See the next method for details. 1429Create a simple multi-line overlay box. See the next method for details.
1306 1430
1336 1460
1337The methods currently supported on C<urxvt::overlay> objects are: 1461The methods currently supported on C<urxvt::overlay> objects are:
1338 1462
1339=over 4 1463=over 4
1340 1464
1341=item $overlay->set ($x, $y, $text, $rend) 1465=item $overlay->set ($x, $y, $text[, $rend])
1342 1466
1343Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1467Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1344text in rxvt-unicode's special encoding and an array of rendition values 1468text in rxvt-unicode's special encoding and an array of rendition values
1345at a specific position inside the overlay. 1469at a specific position inside the overlay.
1470
1471If C<$rend> is missing, then the rendition will not be changed.
1346 1472
1347=item $overlay->hide 1473=item $overlay->hide
1348 1474
1349If visible, hide the overlay, but do not destroy it. 1475If visible, hide the overlay, but do not destroy it.
1350 1476
1432locale-specific encoding of the terminal and can contain command sequences 1558locale-specific encoding of the terminal and can contain command sequences
1433(escape codes) that will be interpreted. 1559(escape codes) that will be interpreted.
1434 1560
1435=item $term->tt_write ($octets) 1561=item $term->tt_write ($octets)
1436 1562
1437Write the octets given in C<$data> to the tty (i.e. as program input). To 1563Write the octets given in C<$octets> to the tty (i.e. as program input). To
1438pass characters instead of octets, you should convert your strings first 1564pass characters instead of octets, you should convert your strings first
1439to the locale-specific encoding using C<< $term->locale_encode >>. 1565to the locale-specific encoding using C<< $term->locale_encode >>.
1566
1567=item $term->tt_paste ($octets)
1568
1569Write the octets given in C<$octets> to the tty as a paste, converting NL to
1570CR and bracketing the data with control sequences if bracketed paste mode
1571is set.
1440 1572
1441=item $old_events = $term->pty_ev_events ([$new_events]) 1573=item $old_events = $term->pty_ev_events ([$new_events])
1442 1574
1443Replaces the event mask of the pty watcher by the given event mask. Can 1575Replaces the event mask of the pty watcher by the given event mask. Can
1444be used to suppress input and output handling to the pty/tty. See the 1576be used to suppress input and output handling to the pty/tty. See the
1560 1692
1561Used after changing terminal contents to display them. 1693Used after changing terminal contents to display them.
1562 1694
1563=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1695=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564 1696
1565Returns the text of the entire row with number C<$row_number>. Row C<0> 1697Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1566is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1698is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1567terminal line. The scrollback buffer starts at line C<-1> and extends to
1568line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1699terminal line. Nothing will be returned if a nonexistent line
1569is requested. 1700is requested.
1570 1701
1571If C<$new_text> is specified, it will replace characters in the current 1702If C<$new_text> is specified, it will replace characters in the current
1572line, starting at column C<$start_col> (default C<0>), which is useful 1703line, starting at column C<$start_col> (default C<0>), which is useful
1573to replace only parts of a line. The font index in the rendition will 1704to replace only parts of a line. The font index in the rendition will
1574automatically be updated. 1705automatically be updated.
1575 1706
1576C<$text> is in a special encoding: tabs and wide characters that use more 1707C<$text> is in a special encoding: tabs and wide characters that use more
1577than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1708than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1578characters. Characters with combining characters and other characters that 1709characters. Characters with combining characters and other characters that
1579do not fit into the normal tetx encoding will be replaced with characters 1710do not fit into the normal text encoding will be replaced with characters
1580in the private use area. 1711in the private use area.
1581 1712
1582You have to obey this encoding when changing text. The advantage is 1713You have to obey this encoding when changing text. The advantage is
1583that C<substr> and similar functions work on screen cells and not on 1714that C<substr> and similar functions work on screen cells and not on
1584characters. 1715characters.
1759Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1890Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1760recent grab. 1891recent grab.
1761 1892
1762=item $term->ungrab 1893=item $term->ungrab
1763 1894
1764Calls XUngrab for the most recent grab. Is called automatically on 1895Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1765evaluation errors, as it is better to lose the grab in the error case as 1896evaluation errors, as it is better to lose the grab in the error case as
1766the session. 1897the session.
1767 1898
1768=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1899=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1769 1900
1771 1902
1772=item @atoms = $term->XListProperties ($window) 1903=item @atoms = $term->XListProperties ($window)
1773 1904
1774=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1905=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775 1906
1776=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1907=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777 1908
1778=item $term->XDeleteProperty ($window, $property) 1909=item $term->XDeleteProperty ($window, $property)
1779 1910
1780=item $window = $term->DefaultRootWindow 1911=item $window = $term->DefaultRootWindow
1781 1912
1791 1922
1792=item $term->XChangeInput ($window, $add_events[, $del_events]) 1923=item $term->XChangeInput ($window, $add_events[, $del_events])
1793 1924
1794Various X or X-related functions. The C<$term> object only serves as 1925Various X or X-related functions. The C<$term> object only serves as
1795the source of the display, otherwise those functions map more-or-less 1926the source of the display, otherwise those functions map more-or-less
1796directory onto the X functions of the same name. 1927directly onto the X functions of the same name.
1797 1928
1798=back 1929=back
1799 1930
1800=cut 1931=cut
1801 1932
1903 my $env = $self->{term}->env; 2034 my $env = $self->{term}->env;
1904 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2035 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1905 delete $env->{LC_ALL}; 2036 delete $env->{LC_ALL};
1906 $env->{LC_CTYPE} = $self->{term}->locale; 2037 $env->{LC_CTYPE} = $self->{term}->locale;
1907 2038
1908 urxvt::term->new ($env, "popup", 2039 my $term = urxvt::term->new (
2040 $env, "popup",
1909 "--perl-lib" => "", "--perl-ext-common" => "", 2041 "--perl-lib" => "", "--perl-ext-common" => "",
1910 "-pty-fd" => -1, "-sl" => 0, 2042 "-pty-fd" => -1, "-sl" => 0,
1911 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2043 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912 "--transient-for" => $self->{term}->parent, 2044 "--transient-for" => $self->{term}->parent,
1913 "-display" => $self->{term}->display_id, 2045 "-display" => $self->{term}->display_id,
1914 "-pe" => "urxvt-popup") 2046 "-pe" => "urxvt-popup",
1915 or die "unable to create popup window\n"; 2047 ) or die "unable to create popup window\n";
2048
2049 unless (delete $term->{urxvt_popup_init_done}) {
2050 $term->ungrab;
2051 $term->destroy;
2052 die "unable to initialise popup window\n";
2053 }
1916} 2054}
1917 2055
1918sub DESTROY { 2056sub DESTROY {
1919 my ($self) = @_; 2057 my ($self) = @_;
1920 2058
1925=back 2063=back
1926 2064
1927=cut 2065=cut
1928 2066
1929package urxvt::watcher; 2067package urxvt::watcher;
1930
1931@urxvt::timer::ISA = __PACKAGE__;
1932@urxvt::iow::ISA = __PACKAGE__;
1933@urxvt::pw::ISA = __PACKAGE__;
1934@urxvt::iw::ISA = __PACKAGE__;
1935 2068
1936=head2 The C<urxvt::timer> Class 2069=head2 The C<urxvt::timer> Class
1937 2070
1938This class implements timer watchers/events. Time is represented as a 2071This class implements timer watchers/events. Time is represented as a
1939fractional number of seconds since the epoch. Example: 2072fractional number of seconds since the epoch. Example:
1943 ->new 2076 ->new
1944 ->interval (1) 2077 ->interval (1)
1945 ->cb (sub { 2078 ->cb (sub {
1946 $term->{overlay}->set (0, 0, 2079 $term->{overlay}->set (0, 0,
1947 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2080 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948 }); 2081 });
1949 2082
1950=over 4 2083=over 4
1951 2084
1952=item $timer = new urxvt::timer 2085=item $timer = new urxvt::timer
1953 2086
1956 2089
1957=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2090=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1958 2091
1959Set the callback to be called when the timer triggers. 2092Set the callback to be called when the timer triggers.
1960 2093
1961=item $tstamp = $timer->at
1962
1963Return the time this watcher will fire next.
1964
1965=item $timer = $timer->set ($tstamp) 2094=item $timer = $timer->set ($tstamp[, $interval])
1966 2095
1967Set the time the event is generated to $tstamp. 2096Set the time the event is generated to $tstamp (and optionally specifies a
2097new $interval).
1968 2098
1969=item $timer = $timer->interval ($interval) 2099=item $timer = $timer->interval ($interval)
1970 2100
1971Normally (and when C<$interval> is C<0>), the timer will automatically 2101By default (and when C<$interval> is C<0>), the timer will automatically
1972stop after it has fired once. If C<$interval> is non-zero, then the timer 2102stop after it has fired once. If C<$interval> is non-zero, then the timer
1973is automatically rescheduled at the given intervals. 2103is automatically rescheduled at the given intervals.
1974 2104
1975=item $timer = $timer->start 2105=item $timer = $timer->start
1976 2106
1977Start the timer. 2107Start the timer.
1978 2108
1979=item $timer = $timer->start ($tstamp) 2109=item $timer = $timer->start ($tstamp[, $interval])
1980 2110
1981Set the event trigger time to C<$tstamp> and start the timer. 2111Set the event trigger time to C<$tstamp> and start the timer. Optionally
2112also replaces the interval.
1982 2113
1983=item $timer = $timer->after ($delay) 2114=item $timer = $timer->after ($delay[, $interval])
1984 2115
1985Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2116Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1986 2117
1987=item $timer = $timer->stop 2118=item $timer = $timer->stop
1988 2119
1996 2127
1997 $term->{socket} = ... 2128 $term->{socket} = ...
1998 $term->{iow} = urxvt::iow 2129 $term->{iow} = urxvt::iow
1999 ->new 2130 ->new
2000 ->fd (fileno $term->{socket}) 2131 ->fd (fileno $term->{socket})
2001 ->events (urxvt::EVENT_READ) 2132 ->events (urxvt::EV_READ)
2002 ->start 2133 ->start
2003 ->cb (sub { 2134 ->cb (sub {
2004 my ($iow, $revents) = @_; 2135 my ($iow, $revents) = @_;
2005 # $revents must be 1 here, no need to check 2136 # $revents must be 1 here, no need to check
2006 sysread $term->{socket}, my $buf, 8192 2137 sysread $term->{socket}, my $buf, 8192
2024Set the file descriptor (not handle) to watch. 2155Set the file descriptor (not handle) to watch.
2025 2156
2026=item $iow = $iow->events ($eventmask) 2157=item $iow = $iow->events ($eventmask)
2027 2158
2028Set the event mask to watch. The only allowed values are 2159Set the event mask to watch. The only allowed values are
2029C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2160C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2030together, or C<urxvt::EVENT_NONE>. 2161together, or C<urxvt::EV_NONE>.
2031 2162
2032=item $iow = $iow->start 2163=item $iow = $iow->start
2033 2164
2034Start watching for requested events on the given handle. 2165Start watching for requested events on the given handle.
2035 2166
2076 ->new 2207 ->new
2077 ->start ($pid) 2208 ->start ($pid)
2078 ->cb (sub { 2209 ->cb (sub {
2079 my ($pw, $exit_status) = @_; 2210 my ($pw, $exit_status) = @_;
2080 ... 2211 ...
2081 }); 2212 });
2082 2213
2083=over 4 2214=over 4
2084 2215
2085=item $pw = new urxvt::pw 2216=item $pw = new urxvt::pw
2086 2217
2125 http://software.schmorp.de/pkg/rxvt-unicode 2256 http://software.schmorp.de/pkg/rxvt-unicode
2126 2257
2127=cut 2258=cut
2128 2259
21291 22601
2261
2262# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines