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.150 by root, Thu Dec 7 03:02:44 2006 UTC vs.
Revision 1.209 by root, Tue Jun 5 22:38:17 2012 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
256The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
260 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
261Example configuration: 268Example configuration:
262 269
263 URxvt.perl-ext: default,matcher 270 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser 271 URxvt.urlLauncher: sensible-browser
272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
265 URxvt.matcher.button: 1 274 URxvt.matcher.button: 1
266 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
268 URxvt.matcher.launcher.2: gvim +$2 $1 277 URxvt.matcher.launcher.2: gvim +$2 $1
269 278
270=item xim-onthespot 279=item xim-onthespot
271 280
272This (experimental) perl extension implements OnTheSpot editing. It does 281This (experimental) perl extension implements OnTheSpot editing. It does
273not 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
274OnTheSpot 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
275kinput2. 284kinput2.
276 285
277You enable it by specifying this extension and a preedit style of 286You enable it by specifying this extension and a preedit style of
278C<OnTheSpot>, i.e.: 287C<OnTheSpot>, i.e.:
279 288
287will 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
288or show it again. 297or show it again.
289 298
290Initially, the window will not be shown when using this extension. 299Initially, the window will not be shown when using this extension.
291 300
292This 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
293space 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.
294 303
295The accelerator key is grabbed regardless of any modifiers, so this 304The accelerator key is grabbed regardless of any modifiers, so this
296extension will actually grab a physical key just for this function. 305extension will actually grab a physical key just for this function.
297 306
298If 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
299(fvwm can do it). 308(fvwm can do it).
300 309
301=item automove-background 310=item overlay-osc
302 311
303This is basically a very small extension that dynamically changes the 312This extension implements some OSC commands to display timed popups on the
304background pixmap offset to the window position, in effect creating the 313screen - useful for status displays from within scripts. You have to read
305same effect as pseudo transparency with a custom pixmap. No scaling is 314the sources for more info.
306supported in this mode. Example:
307
308 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309 315
310=item block-graphics-to-ascii 316=item block-graphics-to-ascii
311 317
312A 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
313by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
318Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
319 325
320=item remote-clipboard 326=item remote-clipboard
321 327
322Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
323selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
324selection somewhere and fetch it again. 330selection somewhere and fetch it again.
325 331
326We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
327means 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
328reads it. 334reads it.
337 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339 345
340=item selection-pastebin 346=item selection-pastebin
341 347
342This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
343textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
344not 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
345F</tmp> directly.). 351F</tmp> directly.).
346 352
347It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
366 372
367 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368 374
369I<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
370the double C</> characters as comment start. Use C<\057\057> instead, 376the double C</> characters as comment start. Use C<\057\057> instead,
371which 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
372or 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.
373 393
374=item example-refresh-hooks 394=item example-refresh-hooks
375 395
376Displays 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
377window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
378overlays 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"
379 412
380=back 413=back
381 414
382=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
383 416
399 432
400=over 4 433=over 4
401 434
402=item $text 435=item $text
403 436
404Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
405always 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.
406 439
407=item $string 440=item $string
408 441
409A 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
413=item $octets 446=item $octets
414 447
415Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
416locale-specific way. 449locale-specific way.
417 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
418=back 457=back
419 458
420=head2 Extension Objects 459=head2 Extension Objects
421 460
422Every 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
423for 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,
424which 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
425their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
426extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
427that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
428internal use. 467internal use.
543 582
544It 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,
545$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
546number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
547 586
548=item on_osc_seq $term, $op, $args 587=item on_osc_seq $term, $op, $args, $resp
549 588
550Called 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
551behaviour. 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
552suppresses execution of the request completely. Make sure you don't get 591suppresses execution of the request completely. Make sure you don't get
553confused by recursive invocations when you output an osc sequence within 592confused by recursive invocations when you output an OSC sequence within
554this callback. 593this callback.
555 594
556C<on_osc_seq_perl> should be used for new behaviour. 595C<on_osc_seq_perl> should be used for new behaviour.
557 596
558=item on_osc_seq_perl $term, $string 597=item on_osc_seq_perl $term, $args, $resp
559 598
560Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
561operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
562information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
563string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
564it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
565future. 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 }
566 615
567Be 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,
568as 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
569other 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.
570 622
571=item on_add_lines $term, $string 623=item on_add_lines $term, $string
572 624
573Called 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
574can 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
579=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
580 632
581Called 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
582suppress or filter tty input. 634suppress or filter tty input.
583 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
584=item on_line_update $term, $row 643=item on_line_update $term, $row
585 644
586Called 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
587screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
588that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
595later 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
596you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
597 656
598=item on_refresh_begin $term 657=item on_refresh_begin $term
599 658
600Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
601or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
602restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
603code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
604 663
605=item on_refresh_end $term 664=item on_refresh_end $term
606 665
613resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
614 673
615The 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
616slightly in the future. 675slightly in the future.
617 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
618=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
619 685
620Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
621windows 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
622returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
623 689
657 723
658=item on_map_notify $term, $event 724=item on_map_notify $term, $event
659 725
660=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
661 727
662Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
663the 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.
664 730
665The 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
666manpage), 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
667(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
668 734
677 743
678=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
679 745
680Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
681format=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.
682 752
683=back 753=back
684 754
685=cut 755=cut
686 756
751 821
752=over 4 822=over 4
753 823
754=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
755 825
756Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
757costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
758starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
759 830
760=item urxvt::warn $string 831=item urxvt::warn $string
761 832
762Calls 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
763newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
764that calls this function. 835that calls this function.
765 836
766Using 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
767correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
771=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
772 843
773Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
774whether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
775objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
776is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
777 848
778=item $time = urxvt::NOW 849=item $time = urxvt::NOW
779 850
780Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
781 852
824 895
825=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
826 897
827Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
828 899
829=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
830 902
831Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
832underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
833the bitset. 905the bitset.
834 906
871 }; 943 };
872} 944}
873 945
874no warnings 'utf8'; 946no warnings 'utf8';
875 947
948sub resource {
949 my ($term, $name, $isarg, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 warn "resourece<@_>\n";#d#
954
955 0
956}
957
958sub usage {
959 my ($term, $usage_type) = @_;
960
961 $term->scan_meta;
962
963 my $r = $term->{meta}{resource};
964
965 for my $regex (sort keys %$r) {
966 my ($ext, $type, $desc) = @{ $r->{$regex} };
967
968 $desc .= " (-pe $ext)";
969
970 if ($usage_type == 1) {
971 if ($type eq "boolean") {
972 urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
973 } else {
974 urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
975 }
976 } else {
977 urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
978 }
979 }
980}
981
876my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
877 983
878sub verbose { 984sub verbose {
879 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
880 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
916sub invoke { 1022sub invoke {
917 local $TERM = shift; 1023 local $TERM = shift;
918 my $htype = shift; 1024 my $htype = shift;
919 1025
920 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
921 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
922 1028
923 my %ext_arg; 1029 my %ext_arg;
924 1030
925 { 1031 {
926 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
927 @TERM_INIT = (); 1033 @TERM_INIT = ();
990 1096
991sub SET_COLOR($$$) { 1097sub SET_COLOR($$$) {
992 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1098 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993} 1099}
994 1100
1101sub rend2mask {
1102 no strict 'refs';
1103 my ($str, $mask) = (@_, 0);
1104 my %color = ( fg => undef, bg => undef );
1105 my @failed;
1106 for my $spec ( split /\s+/, $str ) {
1107 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1108 $color{lc($1)} = $2;
1109 } else {
1110 my $neg = $spec =~ s/^[-^]//;
1111 unless ( exists &{"RS_$spec"} ) {
1112 push @failed, $spec;
1113 next;
1114 }
1115 my $cur = &{"RS_$spec"};
1116 if ( $neg ) {
1117 $mask &= ~$cur;
1118 } else {
1119 $mask |= $cur;
1120 }
1121 }
1122 }
1123 ($mask, @color{qw(fg bg)}, \@failed)
1124}
1125
995# urxvt::term::extension 1126# urxvt::term::extension
996 1127
997package urxvt::term::extension; 1128package urxvt::term::extension;
998 1129
999sub enable { 1130sub enable {
1062=head2 The C<urxvt::anyevent> Class 1193=head2 The C<urxvt::anyevent> Class
1063 1194
1064The sole purpose of this class is to deliver an interface to the 1195The sole purpose of this class is to deliver an interface to the
1065C<AnyEvent> module - any module using it will work inside urxvt without 1196C<AnyEvent> module - any module using it will work inside urxvt without
1066further programming. The only exception is that you cannot wait on 1197further programming. The only exception is that you cannot wait on
1067condition variables, but non-blocking condvar use is ok. What this means 1198condition variables, but non-blocking condvar use is ok.
1068is that you cannot use blocking APIs, but the non-blocking variant should 1199
1069work. 1200In practical terms this means is that you cannot use blocking APIs, but
1201the non-blocking variant should work.
1070 1202
1071=cut 1203=cut
1072 1204
1073our $VERSION = 1; 1205our $VERSION = '5.23';
1074 1206
1075$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1207$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1076push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1208push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1077 1209
1078sub timer { 1210sub timer {
1080 1212
1081 my $cb = $arg{cb}; 1213 my $cb = $arg{cb};
1082 1214
1083 urxvt::timer 1215 urxvt::timer
1084 ->new 1216 ->new
1085 ->start (urxvt::NOW + $arg{after}) 1217 ->after ($arg{after}, $arg{interval})
1086 ->cb (sub { 1218 ->cb ($arg{interval} ? $cb : sub {
1087 $_[0]->stop; # need to cancel manually 1219 $_[0]->stop; # need to cancel manually
1088 $cb->(); 1220 $cb->();
1089 }) 1221 })
1090} 1222}
1091 1223
1092sub io { 1224sub io {
1093 my ($class, %arg) = @_; 1225 my ($class, %arg) = @_;
1094 1226
1095 my $cb = $arg{cb}; 1227 my $cb = $arg{cb};
1228 my $fd = fileno $arg{fh};
1229 defined $fd or $fd = $arg{fh};
1096 1230
1097 bless [$arg{fh}, urxvt::iow 1231 bless [$arg{fh}, urxvt::iow
1098 ->new 1232 ->new
1099 ->fd (fileno $arg{fh}) 1233 ->fd ($fd)
1100 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1234 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1101 | ($arg{poll} =~ /w/ ? 2 : 0)) 1235 | ($arg{poll} =~ /w/ ? 2 : 0))
1102 ->start 1236 ->start
1103 ->cb (sub { 1237 ->cb ($cb)
1104 $cb->(($_[1] & 1 ? 'r' : '')
1105 . ($_[1] & 2 ? 'w' : ''));
1106 })],
1107 urxvt::anyevent:: 1238 ], urxvt::anyevent::
1239}
1240
1241sub idle {
1242 my ($class, %arg) = @_;
1243
1244 my $cb = $arg{cb};
1245
1246 urxvt::iw
1247 ->new
1248 ->start
1249 ->cb ($cb)
1250}
1251
1252sub child {
1253 my ($class, %arg) = @_;
1254
1255 my $cb = $arg{cb};
1256
1257 urxvt::pw
1258 ->new
1259 ->start ($arg{pid})
1260 ->cb (sub {
1261 $_[0]->stop; # need to cancel manually
1262 $cb->($_[0]->rpid, $_[0]->rstatus);
1263 })
1108} 1264}
1109 1265
1110sub DESTROY { 1266sub DESTROY {
1111 $_[0][1]->stop; 1267 $_[0][1]->stop;
1112} 1268}
1113 1269
1114sub condvar { 1270# only needed for AnyEvent < 6 compatibility
1115 bless \my $flag, urxvt::anyevent::
1116}
1117
1118sub broadcast {
1119 ${$_[0]}++;
1120}
1121
1122sub wait {
1123 unless (${$_[0]}) {
1124 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1125 }
1126}
1127
1128sub one_event { 1271sub one_event {
1129 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1272 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1130} 1273}
1131 1274
1132package urxvt::term; 1275package urxvt::term;
1161 $proxy->enable ($name => $ref); 1304 $proxy->enable ($name => $ref);
1162 } 1305 }
1163 } 1306 }
1164} 1307}
1165 1308
1309sub perl_libdirs {
1310 map { split /:/ }
1311 $_[0]->resource ("perl_lib"),
1312 $ENV{URXVT_PERL_LIB},
1313 "$ENV{HOME}/.urxvt/ext",
1314 "$LIBDIR/perl"
1315}
1316
1317sub scan_meta {
1318 my ($self) = @_;
1319 my @libdirs = perl_libdirs $self;
1320
1321 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1322
1323 my %meta;
1324
1325 $self->{meta_libdirs} = join "\x00", @libdirs;
1326 $self->{meta} = \%meta;
1327
1328 for my $dir (reverse @libdirs) {
1329 opendir my $fh, $dir
1330 or next;
1331 for my $ext (readdir $fh) {
1332 $ext ne "."
1333 and $ext ne ".."
1334 and open my $fh, "<", "$dir/$ext"
1335 or next;
1336
1337 while (<$fh>) {
1338 if (/^#:META:RESOURCE:(.*)/) {
1339 my ($regex, $type, $desc) = split /:/, $1;
1340 $regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
1341 $meta{resource}{$regex} = [$ext, $type, $desc];
1342 } elsif (/^\s*(?:#|$)/) {
1343 # skip other comments and empty lines
1344 } else {
1345 last; # stop parsing on first non-empty non-comment line
1346 }
1347 }
1348 }
1349 }
1350}
1351
1166=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1352=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1167 1353
1168Creates a new terminal, very similar as if you had started it with system 1354Creates a new terminal, very similar as if you had started it with system
1169C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1355C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1170hash which defines the environment of the new terminal. 1356hash which defines the environment of the new terminal.
1224C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1410C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1225 1411
1226Here is a likely non-exhaustive list of option names, please see the 1412Here is a likely non-exhaustive list of option names, please see the
1227source file F</src/optinc.h> to see the actual list: 1413source file F</src/optinc.h> to see the actual list:
1228 1414
1229 borderLess console cursorBlink cursorUnderline hold iconic insecure 1415 borderLess buffered console cursorBlink cursorUnderline hold iconic
1230 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1416 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1231 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1417 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1232 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1418 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1233 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1419 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1234 transparent tripleclickwords utmpInhibit visualBell 1420 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1421 urgentOnBell utmpInhibit visualBell
1235 1422
1236=item $value = $term->resource ($name[, $newval]) 1423=item $value = $term->resource ($name[, $newval])
1237 1424
1238Returns the current resource value associated with a given name and 1425Returns the current resource value associated with a given name and
1239optionally sets a new value. Setting values is most useful in the C<init> 1426optionally sets a new value. Setting values is most useful in the C<init>
1252 1439
1253Here is a likely non-exhaustive list of resource names, not all of which 1440Here is a likely non-exhaustive list of resource names, not all of which
1254are supported in every build, please see the source file F</src/rsinc.h> 1441are supported in every build, please see the source file F</src/rsinc.h>
1255to see the actual list: 1442to see the actual list:
1256 1443
1257 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1444 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1258 borderLess color cursorBlink cursorUnderline cutchars delete_key 1445 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1259 display_name embed ext_bwidth fade font geometry hold iconName 1446 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1260 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1447 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1448 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1261 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1449 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1262 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1450 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1263 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1451 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1264 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1452 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1265 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1453 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1454 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1267 secondaryScreen secondaryScroll selectstyle shade term_name title 1455 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1268 transient_for transparent transparent_all tripleclickwords utmpInhibit 1456 term_name title transient_for transparent tripleclickwords urgentOnBell
1269 visualBell 1457 utmpInhibit visualBell
1270 1458
1271=cut 1459=cut
1272 1460
1273sub resource($$;$) { 1461sub resource($$;$) {
1274 my ($self, $name) = (shift, shift); 1462 my ($self, $name) = (shift, shift);
1275 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1463 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1276 &urxvt::term::_resource 1464 goto &urxvt::term::_resource
1277} 1465}
1278 1466
1279=item $value = $term->x_resource ($pattern) 1467=item $value = $term->x_resource ($pattern)
1280 1468
1281Returns the X-Resource for the given pattern, excluding the program or 1469Returns the X-Resource for the given pattern, excluding the program or
1285 1473
1286This method should only be called during the C<on_start> hook, as there is 1474This method should only be called during the C<on_start> hook, as there is
1287only one resource database per display, and later invocations might return 1475only one resource database per display, and later invocations might return
1288the wrong resources. 1476the wrong resources.
1289 1477
1290=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1478=item $success = $term->parse_keysym ($key, $octets)
1291 1479
1292Adds a keymap translation exactly as specified via a resource. See the 1480Adds a key binding exactly as specified via a resource. See the
1293C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1481C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1482
1483=item $term->register_command ($keysym, $modifiermask, $string)
1484
1485Adds a key binding. This is a lower level api compared to
1486C<parse_keysym>, as it expects a parsed key description, and can be
1487used only inside either the C<on_init> hook, to add a binding, or the
1488C<on_register_command> hook, to modify a parsed binding.
1294 1489
1295=item $rend = $term->rstyle ([$new_rstyle]) 1490=item $rend = $term->rstyle ([$new_rstyle])
1296 1491
1297Return and optionally change the current rendition. Text that is output by 1492Return and optionally change the current rendition. Text that is output by
1298the terminal application will use this style. 1493the terminal application will use this style.
1306 1501
1307=item ($row, $col) = $term->selection_beg ([$row, $col]) 1502=item ($row, $col) = $term->selection_beg ([$row, $col])
1308 1503
1309=item ($row, $col) = $term->selection_end ([$row, $col]) 1504=item ($row, $col) = $term->selection_end ([$row, $col])
1310 1505
1311Return the current values of the selection mark, begin or end positions, 1506Return the current values of the selection mark, begin or end positions.
1312and optionally set them to new values. 1507
1508When arguments are given, then the selection coordinates are set to
1509C<$row> and C<$col>, and the selection screen is set to the current
1510screen.
1511
1512=item $screen = $term->selection_screen ([$screen])
1513
1514Returns the current selection screen, and then optionally sets it.
1313 1515
1314=item $term->selection_make ($eventtime[, $rectangular]) 1516=item $term->selection_make ($eventtime[, $rectangular])
1315 1517
1316Tries to make a selection as set by C<selection_beg> and 1518Tries to make a selection as set by C<selection_beg> and
1317C<selection_end>. If C<$rectangular> is true (default: false), a 1519C<selection_end>. If C<$rectangular> is true (default: false), a
1318rectangular selection will be made. This is the prefered function to make 1520rectangular selection will be made. This is the preferred function to make
1319a selection. 1521a selection.
1320 1522
1321=item $success = $term->selection_grab ($eventtime) 1523=item $success = $term->selection_grab ($eventtime[, $clipboard])
1322 1524
1323Try to request the primary selection text from the server (for example, as 1525Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1526true) selection from the server. The corresponding text can be set
1324set by the next method). No visual feedback will be given. This function 1527with the next method. No visual feedback will be given. This function
1325is mostly useful from within C<on_sel_grab> hooks. 1528is mostly useful from within C<on_sel_grab> hooks.
1326 1529
1327=item $oldtext = $term->selection ([$newtext]) 1530=item $oldtext = $term->selection ([$newtext, $clipboard])
1328 1531
1329Return the current selection text and optionally replace it by C<$newtext>. 1532Return the current selection (clipboard if C<$clipboard> is true) text
1533and optionally replace it by C<$newtext>.
1534
1535=item $term->selection_clear ([$clipboard])
1536
1537Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1330 1538
1331=item $term->overlay_simple ($x, $y, $text) 1539=item $term->overlay_simple ($x, $y, $text)
1332 1540
1333Create a simple multi-line overlay box. See the next method for details. 1541Create a simple multi-line overlay box. See the next method for details.
1334 1542
1364 1572
1365The methods currently supported on C<urxvt::overlay> objects are: 1573The methods currently supported on C<urxvt::overlay> objects are:
1366 1574
1367=over 4 1575=over 4
1368 1576
1369=item $overlay->set ($x, $y, $text, $rend) 1577=item $overlay->set ($x, $y, $text[, $rend])
1370 1578
1371Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1579Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1372text in rxvt-unicode's special encoding and an array of rendition values 1580text in rxvt-unicode's special encoding and an array of rendition values
1373at a specific position inside the overlay. 1581at a specific position inside the overlay.
1582
1583If C<$rend> is missing, then the rendition will not be changed.
1374 1584
1375=item $overlay->hide 1585=item $overlay->hide
1376 1586
1377If visible, hide the overlay, but do not destroy it. 1587If visible, hide the overlay, but do not destroy it.
1378 1588
1460locale-specific encoding of the terminal and can contain command sequences 1670locale-specific encoding of the terminal and can contain command sequences
1461(escape codes) that will be interpreted. 1671(escape codes) that will be interpreted.
1462 1672
1463=item $term->tt_write ($octets) 1673=item $term->tt_write ($octets)
1464 1674
1465Write the octets given in C<$data> to the tty (i.e. as program input). To 1675Write the octets given in C<$octets> to the tty (i.e. as program input). To
1466pass characters instead of octets, you should convert your strings first 1676pass characters instead of octets, you should convert your strings first
1467to the locale-specific encoding using C<< $term->locale_encode >>. 1677to the locale-specific encoding using C<< $term->locale_encode >>.
1678
1679=item $term->tt_paste ($octets)
1680
1681Write the octets given in C<$octets> to the tty as a paste, converting NL to
1682CR and bracketing the data with control sequences if bracketed paste mode
1683is set.
1468 1684
1469=item $old_events = $term->pty_ev_events ([$new_events]) 1685=item $old_events = $term->pty_ev_events ([$new_events])
1470 1686
1471Replaces the event mask of the pty watcher by the given event mask. Can 1687Replaces the event mask of the pty watcher by the given event mask. Can
1472be used to suppress input and output handling to the pty/tty. See the 1688be used to suppress input and output handling to the pty/tty. See the
1491Adds the specified events to the vt event mask. Useful e.g. when you want 1707Adds the specified events to the vt event mask. Useful e.g. when you want
1492to receive pointer events all the times: 1708to receive pointer events all the times:
1493 1709
1494 $term->vt_emask_add (urxvt::PointerMotionMask); 1710 $term->vt_emask_add (urxvt::PointerMotionMask);
1495 1711
1712=item $term->set_urgency ($set)
1713
1714Enable/disable the urgency hint on the toplevel window.
1715
1496=item $term->focus_in 1716=item $term->focus_in
1497 1717
1498=item $term->focus_out 1718=item $term->focus_out
1499 1719
1500=item $term->key_press ($state, $keycode[, $time]) 1720=item $term->key_press ($state, $keycode[, $time])
1588 1808
1589Used after changing terminal contents to display them. 1809Used after changing terminal contents to display them.
1590 1810
1591=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1811=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1592 1812
1593Returns the text of the entire row with number C<$row_number>. Row C<0> 1813Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1594is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1814is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1595terminal line. The scrollback buffer starts at line C<-1> and extends to
1596line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1815terminal line. Nothing will be returned if a nonexistent line
1597is requested. 1816is requested.
1598 1817
1599If C<$new_text> is specified, it will replace characters in the current 1818If C<$new_text> is specified, it will replace characters in the current
1600line, starting at column C<$start_col> (default C<0>), which is useful 1819line, starting at column C<$start_col> (default C<0>), which is useful
1601to replace only parts of a line. The font index in the rendition will 1820to replace only parts of a line. The font index in the rendition will
1602automatically be updated. 1821automatically be updated.
1603 1822
1604C<$text> is in a special encoding: tabs and wide characters that use more 1823C<$text> is in a special encoding: tabs and wide characters that use more
1605than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1824than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1606characters. Characters with combining characters and other characters that 1825characters. Characters with combining characters and other characters that
1607do not fit into the normal tetx encoding will be replaced with characters 1826do not fit into the normal text encoding will be replaced with characters
1608in the private use area. 1827in the private use area.
1609 1828
1610You have to obey this encoding when changing text. The advantage is 1829You have to obey this encoding when changing text. The advantage is
1611that C<substr> and similar functions work on screen cells and not on 1830that C<substr> and similar functions work on screen cells and not on
1612characters. 1831characters.
1787Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2006Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1788recent grab. 2007recent grab.
1789 2008
1790=item $term->ungrab 2009=item $term->ungrab
1791 2010
1792Calls XUngrab for the most recent grab. Is called automatically on 2011Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1793evaluation errors, as it is better to lose the grab in the error case as 2012evaluation errors, as it is better to lose the grab in the error case as
1794the session. 2013the session.
1795 2014
1796=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2015=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1797 2016
1799 2018
1800=item @atoms = $term->XListProperties ($window) 2019=item @atoms = $term->XListProperties ($window)
1801 2020
1802=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 2021=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1803 2022
1804=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 2023=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1805 2024
1806=item $term->XDeleteProperty ($window, $property) 2025=item $term->XDeleteProperty ($window, $property)
1807 2026
1808=item $window = $term->DefaultRootWindow 2027=item $window = $term->DefaultRootWindow
1809 2028
1816=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2035=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1817 2036
1818=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2037=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1819 2038
1820=item $term->XChangeInput ($window, $add_events[, $del_events]) 2039=item $term->XChangeInput ($window, $add_events[, $del_events])
2040
2041=item $keysym = $term->XStringToKeysym ($string)
2042
2043=item $string = $term->XKeysymToString ($keysym)
1821 2044
1822Various X or X-related functions. The C<$term> object only serves as 2045Various X or X-related functions. The C<$term> object only serves as
1823the source of the display, otherwise those functions map more-or-less 2046the source of the display, otherwise those functions map more-or-less
1824directory onto the X functions of the same name. 2047directly onto the X functions of the same name.
1825 2048
1826=back 2049=back
1827 2050
1828=cut 2051=cut
1829 2052
1931 my $env = $self->{term}->env; 2154 my $env = $self->{term}->env;
1932 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2155 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1933 delete $env->{LC_ALL}; 2156 delete $env->{LC_ALL};
1934 $env->{LC_CTYPE} = $self->{term}->locale; 2157 $env->{LC_CTYPE} = $self->{term}->locale;
1935 2158
1936 urxvt::term->new ($env, "popup", 2159 my $term = urxvt::term->new (
2160 $env, "popup",
1937 "--perl-lib" => "", "--perl-ext-common" => "", 2161 "--perl-lib" => "", "--perl-ext-common" => "",
1938 "-pty-fd" => -1, "-sl" => 0, 2162 "-pty-fd" => -1, "-sl" => 0,
1939 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2163 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1940 "--transient-for" => $self->{term}->parent, 2164 "--transient-for" => $self->{term}->parent,
1941 "-display" => $self->{term}->display_id, 2165 "-display" => $self->{term}->display_id,
1942 "-pe" => "urxvt-popup") 2166 "-pe" => "urxvt-popup",
1943 or die "unable to create popup window\n"; 2167 ) or die "unable to create popup window\n";
2168
2169 unless (delete $term->{urxvt_popup_init_done}) {
2170 $term->ungrab;
2171 $term->destroy;
2172 die "unable to initialise popup window\n";
2173 }
1944} 2174}
1945 2175
1946sub DESTROY { 2176sub DESTROY {
1947 my ($self) = @_; 2177 my ($self) = @_;
1948 2178
1953=back 2183=back
1954 2184
1955=cut 2185=cut
1956 2186
1957package urxvt::watcher; 2187package urxvt::watcher;
1958
1959@urxvt::timer::ISA = __PACKAGE__;
1960@urxvt::iow::ISA = __PACKAGE__;
1961@urxvt::pw::ISA = __PACKAGE__;
1962@urxvt::iw::ISA = __PACKAGE__;
1963 2188
1964=head2 The C<urxvt::timer> Class 2189=head2 The C<urxvt::timer> Class
1965 2190
1966This class implements timer watchers/events. Time is represented as a 2191This class implements timer watchers/events. Time is represented as a
1967fractional number of seconds since the epoch. Example: 2192fractional number of seconds since the epoch. Example:
1971 ->new 2196 ->new
1972 ->interval (1) 2197 ->interval (1)
1973 ->cb (sub { 2198 ->cb (sub {
1974 $term->{overlay}->set (0, 0, 2199 $term->{overlay}->set (0, 0,
1975 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2200 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1976 }); 2201 });
1977 2202
1978=over 4 2203=over 4
1979 2204
1980=item $timer = new urxvt::timer 2205=item $timer = new urxvt::timer
1981 2206
1984 2209
1985=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2210=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1986 2211
1987Set the callback to be called when the timer triggers. 2212Set the callback to be called when the timer triggers.
1988 2213
1989=item $tstamp = $timer->at
1990
1991Return the time this watcher will fire next.
1992
1993=item $timer = $timer->set ($tstamp) 2214=item $timer = $timer->set ($tstamp[, $interval])
1994 2215
1995Set the time the event is generated to $tstamp. 2216Set the time the event is generated to $tstamp (and optionally specifies a
2217new $interval).
1996 2218
1997=item $timer = $timer->interval ($interval) 2219=item $timer = $timer->interval ($interval)
1998 2220
1999Normally (and when C<$interval> is C<0>), the timer will automatically 2221By default (and when C<$interval> is C<0>), the timer will automatically
2000stop after it has fired once. If C<$interval> is non-zero, then the timer 2222stop after it has fired once. If C<$interval> is non-zero, then the timer
2001is automatically rescheduled at the given intervals. 2223is automatically rescheduled at the given intervals.
2002 2224
2003=item $timer = $timer->start 2225=item $timer = $timer->start
2004 2226
2005Start the timer. 2227Start the timer.
2006 2228
2007=item $timer = $timer->start ($tstamp) 2229=item $timer = $timer->start ($tstamp[, $interval])
2008 2230
2009Set the event trigger time to C<$tstamp> and start the timer. 2231Set the event trigger time to C<$tstamp> and start the timer. Optionally
2232also replaces the interval.
2010 2233
2011=item $timer = $timer->after ($delay) 2234=item $timer = $timer->after ($delay[, $interval])
2012 2235
2013Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2236Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2014 2237
2015=item $timer = $timer->stop 2238=item $timer = $timer->stop
2016 2239
2024 2247
2025 $term->{socket} = ... 2248 $term->{socket} = ...
2026 $term->{iow} = urxvt::iow 2249 $term->{iow} = urxvt::iow
2027 ->new 2250 ->new
2028 ->fd (fileno $term->{socket}) 2251 ->fd (fileno $term->{socket})
2029 ->events (urxvt::EVENT_READ) 2252 ->events (urxvt::EV_READ)
2030 ->start 2253 ->start
2031 ->cb (sub { 2254 ->cb (sub {
2032 my ($iow, $revents) = @_; 2255 my ($iow, $revents) = @_;
2033 # $revents must be 1 here, no need to check 2256 # $revents must be 1 here, no need to check
2034 sysread $term->{socket}, my $buf, 8192 2257 sysread $term->{socket}, my $buf, 8192
2052Set the file descriptor (not handle) to watch. 2275Set the file descriptor (not handle) to watch.
2053 2276
2054=item $iow = $iow->events ($eventmask) 2277=item $iow = $iow->events ($eventmask)
2055 2278
2056Set the event mask to watch. The only allowed values are 2279Set the event mask to watch. The only allowed values are
2057C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2280C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2058together, or C<urxvt::EVENT_NONE>. 2281together, or C<urxvt::EV_NONE>.
2059 2282
2060=item $iow = $iow->start 2283=item $iow = $iow->start
2061 2284
2062Start watching for requested events on the given handle. 2285Start watching for requested events on the given handle.
2063 2286
2104 ->new 2327 ->new
2105 ->start ($pid) 2328 ->start ($pid)
2106 ->cb (sub { 2329 ->cb (sub {
2107 my ($pw, $exit_status) = @_; 2330 my ($pw, $exit_status) = @_;
2108 ... 2331 ...
2109 }); 2332 });
2110 2333
2111=over 4 2334=over 4
2112 2335
2113=item $pw = new urxvt::pw 2336=item $pw = new urxvt::pw
2114 2337
2147 2370
2148=back 2371=back
2149 2372
2150=head1 AUTHOR 2373=head1 AUTHOR
2151 2374
2152 Marc Lehmann <pcg@goof.com> 2375 Marc Lehmann <schmorp@schmorp.de>
2153 http://software.schmorp.de/pkg/rxvt-unicode 2376 http://software.schmorp.de/pkg/rxvt-unicode
2154 2377
2155=cut 2378=cut
2156 2379
21571 23801
2381
2382# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines