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.154 by root, Sat Jun 2 06:43:02 2007 UTC vs.
Revision 1.207 by root, Tue Jun 5 21:29:52 2012 UTC

40 40
41 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42 42
43Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
44 44
45 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
46 46
47=over 4 47=over 4
48 48
49=item selection (enabled by default) 49=item selection (enabled by default)
50 50
101 101
102Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed. 104popup is being displayed.
105 105
106It'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
107either 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
108reference. 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
109will 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
110first argument. 110first argument.
111 111
112The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>: 113C<< $self->{myoption} >>:
114 114
115 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 }; 117 };
118 118
124 124
125Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed. 127popup is being displayed.
128 128
129It'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
130is 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.
131It 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
132string 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
133when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
134 134
135The 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
136the 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
137C<a>s: 137C<a>s:
138 138
139 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : () 141 : ()
142 }; 142 };
143 143
144=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
145 145
152search. 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>
153search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
154bottom. 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
155was 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
156additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
157selection. 157selection if the C<Shift> modifier is active.
158 158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get 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>
161or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
162 162
165=item readline (enabled by default) 165=item readline (enabled by default)
166 166
167A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
168the 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
169move 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
170cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters). 171for programs that correctly support wide characters).
172 172
173To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
174 174
175=over 4 175=over 4
259The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
263 263
264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
264Example configuration: 268Example configuration:
265 269
266 URxvt.perl-ext: default,matcher 270 URxvt.perl-ext: default,matcher
267 URxvt.urlLauncher: sensible-browser 271 URxvt.urlLauncher: sensible-browser
268 URxvt.keysym.C-Delete: perl:matcher 272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
269 URxvt.matcher.button: 1 274 URxvt.matcher.button: 1
270 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
271 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
272 URxvt.matcher.launcher.2: gvim +$2 $1 277 URxvt.matcher.launcher.2: gvim +$2 $1
273 278
274=item xim-onthespot 279=item xim-onthespot
275 280
276This (experimental) perl extension implements OnTheSpot editing. It does 281This (experimental) perl extension implements OnTheSpot editing. It does
277not work perfectly, and some input methods don't seem to work well with 282not work perfectly, and some input methods don't seem to work well with
278OnTheSpot editing in general, but it seems to work at leats for SCIM and 283OnTheSpot editing in general, but it seems to work at least for SCIM and
279kinput2. 284kinput2.
280 285
281You enable it by specifying this extension and a preedit style of 286You enable it by specifying this extension and a preedit style of
282C<OnTheSpot>, i.e.: 287C<OnTheSpot>, i.e.:
283 288
291will show or hide itself. Another press of the accelerator key will hide 296will show or hide itself. Another press of the accelerator key will hide
292or show it again. 297or show it again.
293 298
294Initially, the window will not be shown when using this extension. 299Initially, the window will not be shown when using this extension.
295 300
296This is useful if you need a single terminal thats not using any desktop 301This is useful if you need a single terminal that is not using any desktop
297space most of the time but is quickly available at the press of a key. 302space most of the time but is quickly available at the press of a key.
298 303
299The accelerator key is grabbed regardless of any modifiers, so this 304The accelerator key is grabbed regardless of any modifiers, so this
300extension will actually grab a physical key just for this function. 305extension will actually grab a physical key just for this function.
301 306
302If you want a quake-like animation, tell your window manager to do so 307If you want a quake-like animation, tell your window manager to do so
303(fvwm can do it). 308(fvwm can do it).
304 309
305=item automove-background 310=item overlay-osc
306 311
307This is basically a very small extension that dynamically changes the 312This extension implements some OSC commands to display timed popups on the
308background pixmap offset to the window position, in effect creating the 313screen - useful for status displays from within scripts. You have to read
309same effect as pseudo transparency with a custom pixmap. No scaling is 314the sources for more info.
310supported in this mode. Example:
311
312 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
313
314L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
315shows how this extension can be used to implement an automatically blurred
316transparent background.
317 315
318=item block-graphics-to-ascii 316=item block-graphics-to-ascii
319 317
320A not very useful example of filtering all text output to the terminal 318A not very useful example of filtering all text output to the terminal
321by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
326Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
327 325
328=item remote-clipboard 326=item remote-clipboard
329 327
330Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
331selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
332selection somewhere and fetch it again. 330selection somewhere and fetch it again.
333 331
334We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
335means that one command uploads the file to a remote server, and another 333means that one command uploads the file to a remote server, and another
336reads it. 334reads it.
345 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
346 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
347 345
348=item selection-pastebin 346=item selection-pastebin
349 347
350This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
351textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
352not currently secure for use in a multiuser environment as it writes to 350not currently secure for use in a multiuser environment as it writes to
353F</tmp> directly.). 351F</tmp> directly.).
354 352
355It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
374 372
375 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
376 374
377I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
378the double C</> characters as comment start. Use C<\057\057> instead, 376the double C</> characters as comment start. Use C<\057\057> instead,
379which works regardless of wether xrdb is used to parse the resource file 377which works regardless of whether xrdb is used to parse the resource file
380or not. 378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
381 393
382=item example-refresh-hooks 394=item example-refresh-hooks
383 395
384Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
385window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
386overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
387 412
388=back 413=back
389 414
390=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
391 416
407 432
408=over 4 433=over 4
409 434
410=item $text 435=item $text
411 436
412Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
413always represents one screen cell. See L<ROW_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
414 439
415=item $string 440=item $string
416 441
417A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
421=item $octets 446=item $octets
422 447
423Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
424locale-specific way. 449locale-specific way.
425 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
426=back 457=back
427 458
428=head2 Extension Objects 459=head2 Extension Objects
429 460
430Every perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
431for each terminal, and each terminal has its own set of extenion objects, 462for each terminal, and each terminal has its own set of extension objects,
432which are passed as the first parameter to hooks. So extensions can use 463which are passed as the first parameter to hooks. So extensions can use
433their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
434extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
435that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
436internal use. 467internal use.
551 582
552It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 583It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
553$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 584$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
554number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
555 586
556=item on_osc_seq $term, $op, $args 587=item on_osc_seq $term, $op, $args, $resp
557 588
558Called on every OSC sequence and can be used to suppress it or modify its 589Called on every OSC sequence and can be used to suppress it or modify its
559behaviour. The default should be to return an empty list. A true value 590behaviour. The default should be to return an empty list. A true value
560suppresses execution of the request completely. Make sure you don't get 591suppresses execution of the request completely. Make sure you don't get
561confused by recursive invocations when you output an osc sequence within 592confused by recursive invocations when you output an OSC sequence within
562this callback. 593this callback.
563 594
564C<on_osc_seq_perl> should be used for new behaviour. 595C<on_osc_seq_perl> should be used for new behaviour.
565 596
566=item on_osc_seq_perl $term, $string 597=item on_osc_seq_perl $term, $args, $resp
567 598
568Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
569operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
570information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
571string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
572it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
573future. 604enforced in the future.
605
606For example, C<overlay-osc> uses this:
607
608 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_;
610
611 return unless $osc =~ s/^overlay;//;
612
613 ... process remaining $osc string
614 }
574 615
575Be careful not ever to trust (in a security sense) the data you receive, 616Be careful not ever to trust (in a security sense) the data you receive,
576as its source can not easily be controlled (e-mail content, messages from 617as its source can not easily be controlled (e-mail content, messages from
577other users on the same system etc.). 618other users on the same system etc.).
619
620For responses, C<$resp> contains the end-of-args separator used by the
621sender.
578 622
579=item on_add_lines $term, $string 623=item on_add_lines $term, $string
580 624
581Called whenever text is about to be output, with the text as argument. You 625Called whenever text is about to be output, with the text as argument. You
582can filter/change and output the text yourself by returning a true value 626can filter/change and output the text yourself by returning a true value
587=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
588 632
589Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
590suppress or filter tty input. 634suppress or filter tty input.
591 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
592=item on_line_update $term, $row 643=item on_line_update $term, $row
593 644
594Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
595screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
596that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
603later with the already-modified line (e.g. if unrelated parts change), so 654later with the already-modified line (e.g. if unrelated parts change), so
604you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
605 656
606=item on_refresh_begin $term 657=item on_refresh_begin $term
607 658
608Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
609or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
610restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
611code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
612 663
613=item on_refresh_end $term 664=item on_refresh_end $term
614 665
621resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
622 673
623The event is simply the action string. This interface is assumed to change 674The event is simply the action string. This interface is assumed to change
624slightly in the future. 675slightly in the future.
625 676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
626=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
627 685
628Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
629windows are actually being resized or hints are being set. If this hook 687windows are actually being resized or hints are being set. If this hook
630returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
631 689
665 723
666=item on_map_notify $term, $event 724=item on_map_notify $term, $event
667 725
668=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
669 727
670Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
671the hook returns true, then the even will be ignored by rxvt-unicode. 729the hook returns true, then the event will be ignored by rxvt-unicode.
672 730
673The event is a hash with most values as named by Xlib (see the XEvent 731The event is a hash with most values as named by Xlib (see the XEvent
674manpage), with the additional members C<row> and C<col>, which are the 732manpage), with the additional members C<row> and C<col>, which are the
675(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
676 734
685 743
686=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
687 745
688Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
689format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
748
749=item on_bell $term
750
751Called on receipt of a bell character.
690 752
691=back 753=back
692 754
693=cut 755=cut
694 756
759 821
760=over 4 822=over 4
761 823
762=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
763 825
764Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
765costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
766starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
767 830
768=item urxvt::warn $string 831=item urxvt::warn $string
769 832
770Calls C<rxvt_warn> with the given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
771newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
772that calls this function. 835that calls this function.
773 836
774Using this function has the advantage that its output ends up in the 837Using this function has the advantage that its output ends up in the
775correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
779=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
780 843
781Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
782whether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
783objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
784is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
785 848
786=item $time = urxvt::NOW 849=item $time = urxvt::NOW
787 850
788Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
789 852
832 895
833=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
834 897
835Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
836 899
837=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
838 902
839Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
840underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
841the bitset. 905the bitset.
842 906
879 }; 943 };
880} 944}
881 945
882no warnings 'utf8'; 946no warnings 'utf8';
883 947
948sub perl_libdirs {
949 map { split /:/ }
950 $_[0]->resource ("perl_lib"),
951 $ENV{URXVT_PERL_LIB},
952 "$ENV{HOME}/.urxvt/ext",
953 "$LIBDIR/perl"
954}
955
956our %META; # meta header information from scripts
957our %SCAN; # which dirs already scanned
958
959sub resource {
960 my ($term, $name, $isarg, $flag, $value) = @_;
961
962 for my $dir (perl_libdirs $term) {
963 }
964
965 warn "resourece<@_>\n";#d#
966
967 0
968}
969
884my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 970my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
885 971
886sub verbose { 972sub verbose {
887 my ($level, $msg) = @_; 973 my ($level, $msg) = @_;
888 warn "$msg\n" if $level <= $verbosity; 974 warn "$msg\n" if $level <= $verbosity;
924sub invoke { 1010sub invoke {
925 local $TERM = shift; 1011 local $TERM = shift;
926 my $htype = shift; 1012 my $htype = shift;
927 1013
928 if ($htype == 0) { # INIT 1014 if ($htype == 0) { # INIT
929 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1015 my @dirs = perl_libdirs $TERM;
930 1016
931 my %ext_arg; 1017 my %ext_arg;
932 1018
933 { 1019 {
934 my @init = @TERM_INIT; 1020 my @init = @TERM_INIT;
935 @TERM_INIT = (); 1021 @TERM_INIT = ();
1101is that you cannot use blocking APIs, but the non-blocking variant should 1187is that you cannot use blocking APIs, but the non-blocking variant should
1102work. 1188work.
1103 1189
1104=cut 1190=cut
1105 1191
1106our $VERSION = 1; 1192our $VERSION = '5.23';
1107 1193
1108$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1194$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1109push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1195push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1110 1196
1111sub timer { 1197sub timer {
1113 1199
1114 my $cb = $arg{cb}; 1200 my $cb = $arg{cb};
1115 1201
1116 urxvt::timer 1202 urxvt::timer
1117 ->new 1203 ->new
1118 ->start (urxvt::NOW + $arg{after}) 1204 ->after ($arg{after}, $arg{interval})
1119 ->cb (sub { 1205 ->cb ($arg{interval} ? $cb : sub {
1120 $_[0]->stop; # need to cancel manually 1206 $_[0]->stop; # need to cancel manually
1121 $cb->(); 1207 $cb->();
1122 }) 1208 })
1123} 1209}
1124 1210
1125sub io { 1211sub io {
1126 my ($class, %arg) = @_; 1212 my ($class, %arg) = @_;
1127 1213
1128 my $cb = $arg{cb}; 1214 my $cb = $arg{cb};
1215 my $fd = fileno $arg{fh};
1216 defined $fd or $fd = $arg{fh};
1129 1217
1130 bless [$arg{fh}, urxvt::iow 1218 bless [$arg{fh}, urxvt::iow
1131 ->new 1219 ->new
1132 ->fd (fileno $arg{fh}) 1220 ->fd ($fd)
1133 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1221 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1134 | ($arg{poll} =~ /w/ ? 2 : 0)) 1222 | ($arg{poll} =~ /w/ ? 2 : 0))
1135 ->start 1223 ->start
1136 ->cb (sub { 1224 ->cb ($cb)
1137 $cb->(($_[1] & 1 ? 'r' : '')
1138 . ($_[1] & 2 ? 'w' : ''));
1139 })],
1140 urxvt::anyevent:: 1225 ], urxvt::anyevent::
1226}
1227
1228sub idle {
1229 my ($class, %arg) = @_;
1230
1231 my $cb = $arg{cb};
1232
1233 urxvt::iw
1234 ->new
1235 ->start
1236 ->cb ($cb)
1237}
1238
1239sub child {
1240 my ($class, %arg) = @_;
1241
1242 my $cb = $arg{cb};
1243
1244 urxvt::pw
1245 ->new
1246 ->start ($arg{pid})
1247 ->cb (sub {
1248 $_[0]->stop; # need to cancel manually
1249 $cb->($_[0]->rpid, $_[0]->rstatus);
1250 })
1141} 1251}
1142 1252
1143sub DESTROY { 1253sub DESTROY {
1144 $_[0][1]->stop; 1254 $_[0][1]->stop;
1145} 1255}
1146 1256
1147sub condvar { 1257# only needed for AnyEvent < 6 compatibility
1148 bless \my $flag, urxvt::anyevent::
1149}
1150
1151sub broadcast {
1152 ${$_[0]}++;
1153}
1154
1155sub wait {
1156 unless (${$_[0]}) {
1157 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1158 }
1159}
1160
1161sub one_event { 1258sub one_event {
1162 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1259 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1163} 1260}
1164 1261
1165package urxvt::term; 1262package urxvt::term;
1257C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1354C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1258 1355
1259Here is a likely non-exhaustive list of option names, please see the 1356Here is a likely non-exhaustive list of option names, please see the
1260source file F</src/optinc.h> to see the actual list: 1357source file F</src/optinc.h> to see the actual list:
1261 1358
1262 borderLess console cursorBlink cursorUnderline hold iconic insecure 1359 borderLess buffered console cursorBlink cursorUnderline hold iconic
1263 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1360 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1361 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1265 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1362 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1363 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267 transparent tripleclickwords utmpInhibit visualBell 1364 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1365 urgentOnBell utmpInhibit visualBell
1268 1366
1269=item $value = $term->resource ($name[, $newval]) 1367=item $value = $term->resource ($name[, $newval])
1270 1368
1271Returns the current resource value associated with a given name and 1369Returns the current resource value associated with a given name and
1272optionally sets a new value. Setting values is most useful in the C<init> 1370optionally sets a new value. Setting values is most useful in the C<init>
1285 1383
1286Here is a likely non-exhaustive list of resource names, not all of which 1384Here is a likely non-exhaustive list of resource names, not all of which
1287are supported in every build, please see the source file F</src/rsinc.h> 1385are supported in every build, please see the source file F</src/rsinc.h>
1288to see the actual list: 1386to see the actual list:
1289 1387
1290 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1388 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1291 borderLess color cursorBlink cursorUnderline cutchars delete_key 1389 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1292 display_name embed ext_bwidth fade font geometry hold iconName 1390 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1293 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1391 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1392 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1294 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1393 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1295 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1394 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1296 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1395 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1297 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1396 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1298 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1397 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1299 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1398 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1300 secondaryScreen secondaryScroll selectstyle shade term_name title 1399 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1301 transient_for transparent transparent_all tripleclickwords utmpInhibit 1400 term_name title transient_for transparent tripleclickwords urgentOnBell
1302 visualBell 1401 utmpInhibit visualBell
1303 1402
1304=cut 1403=cut
1305 1404
1306sub resource($$;$) { 1405sub resource($$;$) {
1307 my ($self, $name) = (shift, shift); 1406 my ($self, $name) = (shift, shift);
1308 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1407 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1309 &urxvt::term::_resource 1408 goto &urxvt::term::_resource
1310} 1409}
1311 1410
1312=item $value = $term->x_resource ($pattern) 1411=item $value = $term->x_resource ($pattern)
1313 1412
1314Returns the X-Resource for the given pattern, excluding the program or 1413Returns the X-Resource for the given pattern, excluding the program or
1318 1417
1319This method should only be called during the C<on_start> hook, as there is 1418This method should only be called during the C<on_start> hook, as there is
1320only one resource database per display, and later invocations might return 1419only one resource database per display, and later invocations might return
1321the wrong resources. 1420the wrong resources.
1322 1421
1323=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1422=item $success = $term->parse_keysym ($key, $octets)
1324 1423
1325Adds a keymap translation exactly as specified via a resource. See the 1424Adds a key binding exactly as specified via a resource. See the
1326C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1425C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1426
1427=item $term->register_command ($keysym, $modifiermask, $string)
1428
1429Adds a key binding. This is a lower level api compared to
1430C<parse_keysym>, as it expects a parsed key description, and can be
1431used only inside either the C<on_init> hook, to add a binding, or the
1432C<on_register_command> hook, to modify a parsed binding.
1327 1433
1328=item $rend = $term->rstyle ([$new_rstyle]) 1434=item $rend = $term->rstyle ([$new_rstyle])
1329 1435
1330Return and optionally change the current rendition. Text that is output by 1436Return and optionally change the current rendition. Text that is output by
1331the terminal application will use this style. 1437the terminal application will use this style.
1339 1445
1340=item ($row, $col) = $term->selection_beg ([$row, $col]) 1446=item ($row, $col) = $term->selection_beg ([$row, $col])
1341 1447
1342=item ($row, $col) = $term->selection_end ([$row, $col]) 1448=item ($row, $col) = $term->selection_end ([$row, $col])
1343 1449
1344Return the current values of the selection mark, begin or end positions, 1450Return the current values of the selection mark, begin or end positions.
1345and optionally set them to new values. 1451
1452When arguments are given, then the selection coordinates are set to
1453C<$row> and C<$col>, and the selection screen is set to the current
1454screen.
1455
1456=item $screen = $term->selection_screen ([$screen])
1457
1458Returns the current selection screen, and then optionally sets it.
1346 1459
1347=item $term->selection_make ($eventtime[, $rectangular]) 1460=item $term->selection_make ($eventtime[, $rectangular])
1348 1461
1349Tries to make a selection as set by C<selection_beg> and 1462Tries to make a selection as set by C<selection_beg> and
1350C<selection_end>. If C<$rectangular> is true (default: false), a 1463C<selection_end>. If C<$rectangular> is true (default: false), a
1351rectangular selection will be made. This is the prefered function to make 1464rectangular selection will be made. This is the preferred function to make
1352a selection. 1465a selection.
1353 1466
1354=item $success = $term->selection_grab ($eventtime) 1467=item $success = $term->selection_grab ($eventtime[, $clipboard])
1355 1468
1356Try to request the primary selection text from the server (for example, as 1469Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1470true) selection from the server. The corresponding text can be set
1357set by the next method). No visual feedback will be given. This function 1471with the next method. No visual feedback will be given. This function
1358is mostly useful from within C<on_sel_grab> hooks. 1472is mostly useful from within C<on_sel_grab> hooks.
1359 1473
1360=item $oldtext = $term->selection ([$newtext]) 1474=item $oldtext = $term->selection ([$newtext, $clipboard])
1361 1475
1362Return the current selection text and optionally replace it by C<$newtext>. 1476Return the current selection (clipboard if C<$clipboard> is true) text
1477and optionally replace it by C<$newtext>.
1478
1479=item $term->selection_clear ([$clipboard])
1480
1481Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1363 1482
1364=item $term->overlay_simple ($x, $y, $text) 1483=item $term->overlay_simple ($x, $y, $text)
1365 1484
1366Create a simple multi-line overlay box. See the next method for details. 1485Create a simple multi-line overlay box. See the next method for details.
1367 1486
1397 1516
1398The methods currently supported on C<urxvt::overlay> objects are: 1517The methods currently supported on C<urxvt::overlay> objects are:
1399 1518
1400=over 4 1519=over 4
1401 1520
1402=item $overlay->set ($x, $y, $text, $rend) 1521=item $overlay->set ($x, $y, $text[, $rend])
1403 1522
1404Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1523Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1405text in rxvt-unicode's special encoding and an array of rendition values 1524text in rxvt-unicode's special encoding and an array of rendition values
1406at a specific position inside the overlay. 1525at a specific position inside the overlay.
1526
1527If C<$rend> is missing, then the rendition will not be changed.
1407 1528
1408=item $overlay->hide 1529=item $overlay->hide
1409 1530
1410If visible, hide the overlay, but do not destroy it. 1531If visible, hide the overlay, but do not destroy it.
1411 1532
1493locale-specific encoding of the terminal and can contain command sequences 1614locale-specific encoding of the terminal and can contain command sequences
1494(escape codes) that will be interpreted. 1615(escape codes) that will be interpreted.
1495 1616
1496=item $term->tt_write ($octets) 1617=item $term->tt_write ($octets)
1497 1618
1498Write the octets given in C<$data> to the tty (i.e. as program input). To 1619Write the octets given in C<$octets> to the tty (i.e. as program input). To
1499pass characters instead of octets, you should convert your strings first 1620pass characters instead of octets, you should convert your strings first
1500to the locale-specific encoding using C<< $term->locale_encode >>. 1621to the locale-specific encoding using C<< $term->locale_encode >>.
1622
1623=item $term->tt_paste ($octets)
1624
1625Write the octets given in C<$octets> to the tty as a paste, converting NL to
1626CR and bracketing the data with control sequences if bracketed paste mode
1627is set.
1501 1628
1502=item $old_events = $term->pty_ev_events ([$new_events]) 1629=item $old_events = $term->pty_ev_events ([$new_events])
1503 1630
1504Replaces the event mask of the pty watcher by the given event mask. Can 1631Replaces the event mask of the pty watcher by the given event mask. Can
1505be used to suppress input and output handling to the pty/tty. See the 1632be used to suppress input and output handling to the pty/tty. See the
1524Adds the specified events to the vt event mask. Useful e.g. when you want 1651Adds the specified events to the vt event mask. Useful e.g. when you want
1525to receive pointer events all the times: 1652to receive pointer events all the times:
1526 1653
1527 $term->vt_emask_add (urxvt::PointerMotionMask); 1654 $term->vt_emask_add (urxvt::PointerMotionMask);
1528 1655
1656=item $term->set_urgency ($set)
1657
1658Enable/disable the urgency hint on the toplevel window.
1659
1529=item $term->focus_in 1660=item $term->focus_in
1530 1661
1531=item $term->focus_out 1662=item $term->focus_out
1532 1663
1533=item $term->key_press ($state, $keycode[, $time]) 1664=item $term->key_press ($state, $keycode[, $time])
1621 1752
1622Used after changing terminal contents to display them. 1753Used after changing terminal contents to display them.
1623 1754
1624=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1755=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1625 1756
1626Returns the text of the entire row with number C<$row_number>. Row C<0> 1757Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1627is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1758is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1628terminal line. The scrollback buffer starts at line C<-1> and extends to
1629line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1759terminal line. Nothing will be returned if a nonexistent line
1630is requested. 1760is requested.
1631 1761
1632If C<$new_text> is specified, it will replace characters in the current 1762If C<$new_text> is specified, it will replace characters in the current
1633line, starting at column C<$start_col> (default C<0>), which is useful 1763line, starting at column C<$start_col> (default C<0>), which is useful
1634to replace only parts of a line. The font index in the rendition will 1764to replace only parts of a line. The font index in the rendition will
1635automatically be updated. 1765automatically be updated.
1636 1766
1637C<$text> is in a special encoding: tabs and wide characters that use more 1767C<$text> is in a special encoding: tabs and wide characters that use more
1638than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1768than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1639characters. Characters with combining characters and other characters that 1769characters. Characters with combining characters and other characters that
1640do not fit into the normal tetx encoding will be replaced with characters 1770do not fit into the normal text encoding will be replaced with characters
1641in the private use area. 1771in the private use area.
1642 1772
1643You have to obey this encoding when changing text. The advantage is 1773You have to obey this encoding when changing text. The advantage is
1644that C<substr> and similar functions work on screen cells and not on 1774that C<substr> and similar functions work on screen cells and not on
1645characters. 1775characters.
1820Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1950Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1821recent grab. 1951recent grab.
1822 1952
1823=item $term->ungrab 1953=item $term->ungrab
1824 1954
1825Calls XUngrab for the most recent grab. Is called automatically on 1955Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1826evaluation errors, as it is better to lose the grab in the error case as 1956evaluation errors, as it is better to lose the grab in the error case as
1827the session. 1957the session.
1828 1958
1829=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1959=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1830 1960
1832 1962
1833=item @atoms = $term->XListProperties ($window) 1963=item @atoms = $term->XListProperties ($window)
1834 1964
1835=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1965=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1836 1966
1837=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1967=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1838 1968
1839=item $term->XDeleteProperty ($window, $property) 1969=item $term->XDeleteProperty ($window, $property)
1840 1970
1841=item $window = $term->DefaultRootWindow 1971=item $window = $term->DefaultRootWindow
1842 1972
1849=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1979=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1850 1980
1851=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1981=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1852 1982
1853=item $term->XChangeInput ($window, $add_events[, $del_events]) 1983=item $term->XChangeInput ($window, $add_events[, $del_events])
1984
1985=item $keysym = $term->XStringToKeysym ($string)
1986
1987=item $string = $term->XKeysymToString ($keysym)
1854 1988
1855Various X or X-related functions. The C<$term> object only serves as 1989Various X or X-related functions. The C<$term> object only serves as
1856the source of the display, otherwise those functions map more-or-less 1990the source of the display, otherwise those functions map more-or-less
1857directory onto the X functions of the same name. 1991directly onto the X functions of the same name.
1858 1992
1859=back 1993=back
1860 1994
1861=cut 1995=cut
1862 1996
1964 my $env = $self->{term}->env; 2098 my $env = $self->{term}->env;
1965 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2099 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1966 delete $env->{LC_ALL}; 2100 delete $env->{LC_ALL};
1967 $env->{LC_CTYPE} = $self->{term}->locale; 2101 $env->{LC_CTYPE} = $self->{term}->locale;
1968 2102
1969 urxvt::term->new ($env, "popup", 2103 my $term = urxvt::term->new (
2104 $env, "popup",
1970 "--perl-lib" => "", "--perl-ext-common" => "", 2105 "--perl-lib" => "", "--perl-ext-common" => "",
1971 "-pty-fd" => -1, "-sl" => 0, 2106 "-pty-fd" => -1, "-sl" => 0,
1972 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2107 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1973 "--transient-for" => $self->{term}->parent, 2108 "--transient-for" => $self->{term}->parent,
1974 "-display" => $self->{term}->display_id, 2109 "-display" => $self->{term}->display_id,
1975 "-pe" => "urxvt-popup") 2110 "-pe" => "urxvt-popup",
1976 or die "unable to create popup window\n"; 2111 ) or die "unable to create popup window\n";
2112
2113 unless (delete $term->{urxvt_popup_init_done}) {
2114 $term->ungrab;
2115 $term->destroy;
2116 die "unable to initialise popup window\n";
2117 }
1977} 2118}
1978 2119
1979sub DESTROY { 2120sub DESTROY {
1980 my ($self) = @_; 2121 my ($self) = @_;
1981 2122
1999 ->new 2140 ->new
2000 ->interval (1) 2141 ->interval (1)
2001 ->cb (sub { 2142 ->cb (sub {
2002 $term->{overlay}->set (0, 0, 2143 $term->{overlay}->set (0, 0,
2003 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2144 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2004 }); 2145 });
2005 2146
2006=over 4 2147=over 4
2007 2148
2008=item $timer = new urxvt::timer 2149=item $timer = new urxvt::timer
2009 2150
2012 2153
2013=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2154=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2014 2155
2015Set the callback to be called when the timer triggers. 2156Set the callback to be called when the timer triggers.
2016 2157
2017=item $tstamp = $timer->at
2018
2019Return the time this watcher will fire next.
2020
2021=item $timer = $timer->set ($tstamp) 2158=item $timer = $timer->set ($tstamp[, $interval])
2022 2159
2023Set the time the event is generated to $tstamp. 2160Set the time the event is generated to $tstamp (and optionally specifies a
2161new $interval).
2024 2162
2025=item $timer = $timer->interval ($interval) 2163=item $timer = $timer->interval ($interval)
2026 2164
2027Normally (and when C<$interval> is C<0>), the timer will automatically 2165By default (and when C<$interval> is C<0>), the timer will automatically
2028stop after it has fired once. If C<$interval> is non-zero, then the timer 2166stop after it has fired once. If C<$interval> is non-zero, then the timer
2029is automatically rescheduled at the given intervals. 2167is automatically rescheduled at the given intervals.
2030 2168
2031=item $timer = $timer->start 2169=item $timer = $timer->start
2032 2170
2033Start the timer. 2171Start the timer.
2034 2172
2035=item $timer = $timer->start ($tstamp) 2173=item $timer = $timer->start ($tstamp[, $interval])
2036 2174
2037Set the event trigger time to C<$tstamp> and start the timer. 2175Set the event trigger time to C<$tstamp> and start the timer. Optionally
2176also replaces the interval.
2038 2177
2039=item $timer = $timer->after ($delay) 2178=item $timer = $timer->after ($delay[, $interval])
2040 2179
2041Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2180Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2042 2181
2043=item $timer = $timer->stop 2182=item $timer = $timer->stop
2044 2183
2052 2191
2053 $term->{socket} = ... 2192 $term->{socket} = ...
2054 $term->{iow} = urxvt::iow 2193 $term->{iow} = urxvt::iow
2055 ->new 2194 ->new
2056 ->fd (fileno $term->{socket}) 2195 ->fd (fileno $term->{socket})
2057 ->events (urxvt::EVENT_READ) 2196 ->events (urxvt::EV_READ)
2058 ->start 2197 ->start
2059 ->cb (sub { 2198 ->cb (sub {
2060 my ($iow, $revents) = @_; 2199 my ($iow, $revents) = @_;
2061 # $revents must be 1 here, no need to check 2200 # $revents must be 1 here, no need to check
2062 sysread $term->{socket}, my $buf, 8192 2201 sysread $term->{socket}, my $buf, 8192
2080Set the file descriptor (not handle) to watch. 2219Set the file descriptor (not handle) to watch.
2081 2220
2082=item $iow = $iow->events ($eventmask) 2221=item $iow = $iow->events ($eventmask)
2083 2222
2084Set the event mask to watch. The only allowed values are 2223Set the event mask to watch. The only allowed values are
2085C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2224C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2086together, or C<urxvt::EVENT_NONE>. 2225together, or C<urxvt::EV_NONE>.
2087 2226
2088=item $iow = $iow->start 2227=item $iow = $iow->start
2089 2228
2090Start watching for requested events on the given handle. 2229Start watching for requested events on the given handle.
2091 2230
2132 ->new 2271 ->new
2133 ->start ($pid) 2272 ->start ($pid)
2134 ->cb (sub { 2273 ->cb (sub {
2135 my ($pw, $exit_status) = @_; 2274 my ($pw, $exit_status) = @_;
2136 ... 2275 ...
2137 }); 2276 });
2138 2277
2139=over 4 2278=over 4
2140 2279
2141=item $pw = new urxvt::pw 2280=item $pw = new urxvt::pw
2142 2281
2175 2314
2176=back 2315=back
2177 2316
2178=head1 AUTHOR 2317=head1 AUTHOR
2179 2318
2180 Marc Lehmann <pcg@goof.com> 2319 Marc Lehmann <schmorp@schmorp.de>
2181 http://software.schmorp.de/pkg/rxvt-unicode 2320 http://software.schmorp.de/pkg/rxvt-unicode
2182 2321
2183=cut 2322=cut
2184 2323
21851 23241

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines