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.127 by root, Wed Jan 25 00:42:21 2006 UTC vs.
Revision 1.153 by root, Sat Jun 2 05:23:11 2007 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
62 URxvt.selection.pattern-1: perl-regex 62 URxvt.selection.pattern-1: perl-regex
63 ... 63 ...
64 64
65The index number (0, 1...) must not have any holes, and each regex must 65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for 66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 67the match. For example, the following adds a regex that matches everything
68between two vertical bars: 68between two vertical bars:
69 69
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71 71
72Another example: Programs I use often output "absolute path: " at the 72Another example: Programs I use often output "absolute path: " at the
94=item option-popup (enabled by default) 94=item option-popup (enabled by default)
95 95
96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97runtime. 97runtime.
98 98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's 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
105reference. 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
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
115
99=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
100 117
101Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
103evaluation, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
104 121
105Other extensions can extend this popup menu by pushing a code reference 122Other extensions can extend this popup menu by pushing a code reference
106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107popup is displayed. 124popup is being displayed.
108 125
109It's sole argument is the popup menu, which can be modified. The selection 126It's sole argument is the popup menu, which can be modified. The selection
110is in C<$_>, which can be used to decide wether to add something or not. 127is in C<$_>, which can be used to decide whether to add something or not.
111It should either return nothing or a string and a code reference. The 128It should either return nothing or a string and a code reference. The
112string will be used as button text and the code reference will be called 129string will be used as button text and the code reference will be called
113when the button gets activated and should transform C<$_>. 130when the button gets activated and should transform C<$_>.
114 131
115The following will add an entry C<a to b> that transforms all C<a>s in 132The following will add an entry C<a to b> that transforms all C<a>s in
134bottom. C<Escape> leaves search mode and returns to the point where search 151bottom. C<Escape> leaves search mode and returns to the point where search
135was started, while C<Enter> or C<Return> stay at the current position and 152was started, while C<Enter> or C<Return> stay at the current position and
136additionally stores the first match in the current line into the primary 153additionally stores the first match in the current line into the primary
137selection. 154selection.
138 155
156The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix.
159
160See L<perlre> for more info about perl regular expression syntax.
161
139=item readline (enabled by default) 162=item readline (enabled by default)
140 163
141A support package that tries to make editing with readline easier. At the 164A support package that tries to make editing with readline easier. At
142moment, it reacts to clicking with the left mouse button by trying to 165the moment, it reacts to clicking shift-left mouse button by trying to
143move the text cursor to this position. It does so by generating as many 166move the text cursor to this position. It does so by generating as many
144cursor-left or cursor-right keypresses as required (the this only works 167cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters). 168for programs that correctly support wide characters).
146 169
147To avoid too many false positives, this is only done when: 170To avoid too many false positives, this is only done when:
197the message into vi commands to load the file. 220the message into vi commands to load the file.
198 221
199=item tabbed 222=item tabbed
200 223
201This transforms the terminal into a tabbar with additional terminals, that 224This transforms the terminal into a tabbar with additional terminals, that
202is, it implements what is commonly refered to as "tabbed terminal". The topmost line 225is, it implements what is commonly referred to as "tabbed terminal". The topmost line
203displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one 226displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204button per tab. 227button per tab.
205 228
206Clicking a button will activate that tab. Pressing B<Shift-Left> and 229Clicking a button will activate that tab. Pressing B<Shift-Left> and
207B<Shift-Right> will switch to the tab left or right of the current one, 230B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab. 231while B<Shift-Down> creates a new tab.
209 232
210=item mark-urls 233The tabbar itself can be configured similarly to a normal terminal, but
234with a resource class of C<URxvt.tabbed>. In addition, it supports the
235following four resources (shown with defaults):
211 236
237 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239 URxvt.tabbed.tab-fg: <colour-index, default 0>
240 URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices.
244
245=item matcher
246
212Uses per-line display filtering (C<on_line_update>) to underline urls and 247Uses per-line display filtering (C<on_line_update>) to underline text
213make them clickable. When middle-clicked, the program specified in the 248matching a certain pattern and make it clickable. When clicked with the
214resource C<urlLauncher> (default C<x-www-browser>) will be started with 249mouse button specified in the C<matcher.button> resource (default 2, or
215the URL as first argument. 250middle), the program specified in the C<matcher.launcher> resource
251(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
252with the matched text as first argument. The default configuration is
253suitable for matching URLs and launching a web browser, like the
254former "mark-urls" extension.
255
256The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis.
260
261Example configuration:
262
263 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser
265 URxvt.keysym.C-Delete: perl:matcher
266 URxvt.matcher.button: 1
267 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
268 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
269 URxvt.matcher.launcher.2: gvim +$2 $1
270
271=item xim-onthespot
272
273This (experimental) perl extension implements OnTheSpot editing. It does
274not work perfectly, and some input methods don't seem to work well with
275OnTheSpot editing in general, but it seems to work at leats for SCIM and
276kinput2.
277
278You enable it by specifying this extension and a preedit style of
279C<OnTheSpot>, i.e.:
280
281 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
282
283=item kuake<hotkey>
284
285A very primitive quake-console-like extension. It was inspired by a
286description of how the programs C<kuake> and C<yakuake> work: Whenever the
287user presses a global accelerator key (by default C<F10>), the terminal
288will show or hide itself. Another press of the accelerator key will hide
289or show it again.
290
291Initially, the window will not be shown when using this extension.
292
293This is useful if you need a single terminal thats not using any desktop
294space most of the time but is quickly available at the press of a key.
295
296The accelerator key is grabbed regardless of any modifiers, so this
297extension will actually grab a physical key just for this function.
298
299If you want a quake-like animation, tell your window manager to do so
300(fvwm can do it).
216 301
217=item automove-background 302=item automove-background
218 303
219This is basically a one-line extension that dynamically changes the background pixmap offset 304This is basically a very small extension that dynamically changes the
220to the window position, in effect creating the same effect as pseudo transparency with 305background pixmap offset to the window position, in effect creating the
221a custom pixmap. No scaling is supported in this mode. Exmaple: 306same effect as pseudo transparency with a custom pixmap. No scaling is
307supported in this mode. Example:
222 308
223 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 309 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
224 310
311L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
312shows how this extension can be used to implement an automatically blurred
313transparent background.
314
225=item block-graphics-to-ascii 315=item block-graphics-to-ascii
226 316
227A not very useful example of filtering all text output to the terminal, 317A not very useful example of filtering all text output to the terminal
228by replacing all line-drawing characters (U+2500 .. U+259F) by a 318by replacing all line-drawing characters (U+2500 .. U+259F) by a
229similar-looking ascii character. 319similar-looking ascii character.
230 320
231=item digital-clock 321=item digital-clock
232 322
233Displays a digital clock using the built-in overlay. 323Displays a digital clock using the built-in overlay.
234 324
235=item example-refresh-hooks 325=item remote-clipboard
236 326
237Displays a very simple digital clock in the upper right corner of the 327Somewhat of a misnomer, this extension adds two menu entries to the
238window. Illustrates overwriting the refresh callbacks to create your own 328selection popup that allows one ti run external commands to store the
239overlays or changes. 329selection somewhere and fetch it again.
330
331We use it to implement a "distributed selection mechanism", which just
332means that one command uploads the file to a remote server, and another
333reads it.
334
335The commands can be set using the C<URxvt.remote-selection.store> and
336C<URxvt.remote-selection.fetch> resources. The first should read the
337selection to store from STDIN (always in UTF-8), the second should provide
338the selection data on STDOUT (also in UTF-8).
339
340The defaults (which are likely useless to you) use rsh and cat:
341
342 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
343 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
240 344
241=item selection-pastebin 345=item selection-pastebin
242 346
243This is a little rarely useful extension that Uploads the selection as 347This is a little rarely useful extension that Uploads the selection as
244textfile to a remote site (or does other things). (The implementation is 348textfile to a remote site (or does other things). (The implementation is
264After a successful upload the selection will be replaced by the text given 368After a successful upload the selection will be replaced by the text given
265in the C<selection-pastebin-url> resource (again, the % is the placeholder 369in the C<selection-pastebin-url> resource (again, the % is the placeholder
266for the filename): 370for the filename):
267 371
268 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 372 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
373
374I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
375the double C</> characters as comment start. Use C<\057\057> instead,
376which works regardless of wether xrdb is used to parse the resource file
377or not.
378
379=item example-refresh-hooks
380
381Displays a very simple digital clock in the upper right corner of the
382window. Illustrates overwriting the refresh callbacks to create your own
383overlays or changes.
269 384
270=back 385=back
271 386
272=head1 API DOCUMENTATION 387=head1 API DOCUMENTATION
273 388
307 422
308=back 423=back
309 424
310=head2 Extension Objects 425=head2 Extension Objects
311 426
312Very perl extension is a perl class. A separate perl object is created 427Every perl extension is a perl class. A separate perl object is created
313for each terminal and each extension and passed as the first parameter to 428for each terminal, and each terminal has its own set of extenion objects,
314hooks. So extensions can use their C<$self> object without having to think 429which are passed as the first parameter to hooks. So extensions can use
315about other extensions, with the exception of methods and members that 430their C<$self> object without having to think about clashes with other
431extensions or other terminals, with the exception of methods and members
316begin with an underscore character C<_>: these are reserved for internal 432that begin with an underscore character C<_>: these are reserved for
317use. 433internal use.
318 434
319Although it isn't a C<urxvt::term> object, you can call all methods of the 435Although it isn't a C<urxvt::term> object, you can call all methods of the
320C<urxvt::term> class on this object. 436C<urxvt::term> class on this object.
321 437
322It has the following methods and data members: 438It has the following methods and data members:
343=head2 Hooks 459=head2 Hooks
344 460
345The following subroutines can be declared in extension files, and will be 461The following subroutines can be declared in extension files, and will be
346called whenever the relevant event happens. 462called whenever the relevant event happens.
347 463
348The first argument passed to them is an extension oject as described in 464The first argument passed to them is an extension object as described in
349the in the C<Extension Objects> section. 465the in the C<Extension Objects> section.
350 466
351B<All> of these hooks must return a boolean value. If any of the called 467B<All> of these hooks must return a boolean value. If any of the called
352hooks returns true, then the event counts as being I<consumed>, and the 468hooks returns true, then the event counts as being I<consumed>, and the
353relevant action might not be carried out by the C++ code. 469relevant action might not be carried out by the C++ code.
366place. 482place.
367 483
368=item on_start $term 484=item on_start $term
369 485
370Called at the very end of initialisation of a new terminal, just before 486Called at the very end of initialisation of a new terminal, just before
371trying to map (display) the toplevel and returning to the mainloop. 487trying to map (display) the toplevel and returning to the main loop.
372 488
373=item on_destroy $term 489=item on_destroy $term
374 490
375Called whenever something tries to destroy terminal, when the terminal is 491Called whenever something tries to destroy terminal, when the terminal is
376still fully functional (not for long, though). 492still fully functional (not for long, though).
403 519
404Called whenever a selection has been copied, but before the selection is 520Called whenever a selection has been copied, but before the selection is
405requested from the server. The selection text can be queried and changed 521requested from the server. The selection text can be queried and changed
406by calling C<< $term->selection >>. 522by calling C<< $term->selection >>.
407 523
408Returning a true value aborts selection grabbing. It will still be hilighted. 524Returning a true value aborts selection grabbing. It will still be highlighted.
409 525
410=item on_sel_extend $term 526=item on_sel_extend $term
411 527
412Called whenever the user tries to extend the selection (e.g. with a double 528Called whenever the user tries to extend the selection (e.g. with a double
413click) and is either supposed to return false (normal operation), or 529click) and is either supposed to return false (normal operation), or
414should extend the selection itelf and return true to suppress the built-in 530should extend the selection itself and return true to suppress the built-in
415processing. This can happen multiple times, as long as the callback 531processing. This can happen multiple times, as long as the callback
416returns true, it will be called on every further click by the user and is 532returns true, it will be called on every further click by the user and is
417supposed to enlarge the selection more and more, if possible. 533supposed to enlarge the selection more and more, if possible.
418 534
419See the F<selection> example extension. 535See the F<selection> example extension.
420 536
421=item on_view_change $term, $offset 537=item on_view_change $term, $offset
422 538
423Called whenever the view offset changes, i..e the user or program 539Called whenever the view offset changes, i.e. the user or program
424scrolls. Offset C<0> means display the normal terminal, positive values 540scrolls. Offset C<0> means display the normal terminal, positive values
425show this many lines of scrollback. 541show this many lines of scrollback.
426 542
427=item on_scroll_back $term, $lines, $saved 543=item on_scroll_back $term, $lines, $saved
428 544
432 548
433It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 549It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
434$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 550$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
435number of lines that will be in the scrollback buffer. 551number of lines that will be in the scrollback buffer.
436 552
553=item on_osc_seq $term, $op, $args
554
555Called on every OSC sequence and can be used to suppress it or modify its
556behaviour. The default should be to return an empty list. A true value
557suppresses execution of the request completely. Make sure you don't get
558confused by recursive invocations when you output an osc sequence within
559this callback.
560
561C<on_osc_seq_perl> should be used for new behaviour.
562
437=item on_osc_seq $term, $string 563=item on_osc_seq_perl $term, $string
438 564
439Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 565Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
440operating system command) is processed. Cursor position and other state 566operating system command) is processed. Cursor position and other state
441information is up-to-date when this happens. For interoperability, the 567information is up-to-date when this happens. For interoperability, the
442string should start with the extension name and a colon, to distinguish 568string should start with the extension name and a colon, to distinguish
443it from commands for other extensions, and this might be enforced in the 569it from commands for other extensions, and this might be enforced in the
444future. 570future.
445 571
446Be careful not ever to trust (in a security sense) the data you receive, 572Be careful not ever to trust (in a security sense) the data you receive,
447as its source can not easily be controleld (e-mail content, messages from 573as its source can not easily be controlled (e-mail content, messages from
448other users on the same system etc.). 574other users on the same system etc.).
449 575
450=item on_add_lines $term, $string 576=item on_add_lines $term, $string
451 577
452Called whenever text is about to be output, with the text as argument. You 578Called whenever text is about to be output, with the text as argument. You
483 609
484=item on_refresh_end $term 610=item on_refresh_end $term
485 611
486Called just after the screen gets redrawn. See C<on_refresh_begin>. 612Called just after the screen gets redrawn. See C<on_refresh_begin>.
487 613
488=item on_keyboard_command $term, $string 614=item on_user_command $term, $string
489 615
490Called whenever the user presses a key combination that has a 616Called whenever a user-configured event is being activated (e.g. via
491C<perl:string> action bound to it (see description of the B<keysym> 617a C<perl:string> action bound to a key, see description of the B<keysym>
492resource in the @@RXVT_NAME@@(1) manpage). 618resource in the @@RXVT_NAME@@(1) manpage).
619
620The event is simply the action string. This interface is assumed to change
621slightly in the future.
622
623=item on_resize_all_windows $tern, $new_width, $new_height
624
625Called just after the new window size has been calculated, but before
626windows are actually being resized or hints are being set. If this hook
627returns TRUE, setting of the window hints is being skipped.
493 628
494=item on_x_event $term, $event 629=item on_x_event $term, $event
495 630
496Called on every X event received on the vt window (and possibly other 631Called on every X event received on the vt window (and possibly other
497windows). Should only be used as a last resort. Most event structure 632windows). Should only be used as a last resort. Most event structure
498members are not passed. 633members are not passed.
499 634
635=item on_root_event $term, $event
636
637Like C<on_x_event>, but is called for events on the root window.
638
500=item on_focus_in $term 639=item on_focus_in $term
501 640
502Called whenever the window gets the keyboard focus, before rxvt-unicode 641Called whenever the window gets the keyboard focus, before rxvt-unicode
503does focus in processing. 642does focus in processing.
504 643
505=item on_focus_out $term 644=item on_focus_out $term
506 645
507Called wheneever the window loses keyboard focus, before rxvt-unicode does 646Called whenever the window loses keyboard focus, before rxvt-unicode does
508focus out processing. 647focus out processing.
509 648
510=item on_configure_notify $term, $event 649=item on_configure_notify $term, $event
511 650
512=item on_property_notify $term, $event 651=item on_property_notify $term, $event
595The current terminal. This variable stores the current C<urxvt::term> 734The current terminal. This variable stores the current C<urxvt::term>
596object, whenever a callback/hook is executing. 735object, whenever a callback/hook is executing.
597 736
598=item @urxvt::TERM_INIT 737=item @urxvt::TERM_INIT
599 738
600All coderefs in this array will be called as methods of the next newly 739All code references in this array will be called as methods of the next newly
601created C<urxvt::term> object (during the C<on_init> phase). The array 740created C<urxvt::term> object (during the C<on_init> phase). The array
602gets cleared before the codereferences that were in it are being executed, 741gets cleared before the code references that were in it are being executed,
603so coderefs can push themselves onto it again if they so desire. 742so references can push themselves onto it again if they so desire.
604 743
605This complements to the perl-eval commandline option, but gets executed 744This complements to the perl-eval command line option, but gets executed
606first. 745first.
607 746
608=item @urxvt::TERM_EXT 747=item @urxvt::TERM_EXT
609 748
610Works similar to C<@TERM_INIT>, but contains perl package/class names, which 749Works similar to C<@TERM_INIT>, but contains perl package/class names, which
631 770
632Using this function has the advantage that its output ends up in the 771Using this function has the advantage that its output ends up in the
633correct place, e.g. on stderr of the connecting urxvtc client. 772correct place, e.g. on stderr of the connecting urxvtc client.
634 773
635Messages have a size limit of 1023 bytes currently. 774Messages have a size limit of 1023 bytes currently.
775
776=item @terms = urxvt::termlist
777
778Returns all urxvt::term objects that exist in this process, regardless of
779whether they are started, being destroyed etc., so be careful. Only term
780objects that have perl extensions attached will be returned (because there
781is no urxvt::term objet associated with others).
636 782
637=item $time = urxvt::NOW 783=item $time = urxvt::NOW
638 784
639Returns the "current time" (as per the event loop). 785Returns the "current time" (as per the event loop).
640 786
698Return the foreground/background colour index, respectively. 844Return the foreground/background colour index, respectively.
699 845
700=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 846=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
701 847
702=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 848=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
849
850=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
703 851
704Replace the foreground/background colour in the rendition mask with the 852Replace the foreground/background colour in the rendition mask with the
705specified one. 853specified one.
706 854
707=item $value = urxvt::GET_CUSTOM $rend 855=item $value = urxvt::GET_CUSTOM $rend
798 } else { 946 } else {
799 $ext_arg{$_} ||= []; 947 $ext_arg{$_} ||= [];
800 } 948 }
801 } 949 }
802 950
803 while (my ($ext, $argv) = each %ext_arg) { 951 for my $ext (sort keys %ext_arg) {
804 my @files = grep -f $_, map "$_/$ext", @dirs; 952 my @files = grep -f $_, map "$_/$ext", @dirs;
805 953
806 if (@files) { 954 if (@files) {
807 $TERM->register_package (extension_package $files[0], $argv); 955 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
808 } else { 956 } else {
809 warn "perl extension '$ext' not found in perl library search path\n"; 957 warn "perl extension '$ext' not found in perl library search path\n";
810 } 958 }
811 } 959 }
812 960
818 966
819 if (my $cb = $TERM->{_hook}[$htype]) { 967 if (my $cb = $TERM->{_hook}[$htype]) {
820 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 968 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
821 if $verbosity >= 10; 969 if $verbosity >= 10;
822 970
823 keys %$cb; 971 for my $pkg (keys %$cb) {
824
825 while (my ($pkg, $cb) = each %$cb) {
826 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 972 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
827 $retval ||= $retval_; 973 $retval ||= $retval_;
828 974
829 if ($@) { 975 if ($@) {
830 $TERM->ungrab; # better to lose the grab than the session 976 $TERM->ungrab; # better to lose the grab than the session
831 warn $@; 977 warn $@;
843 # clear package 989 # clear package
844 %$TERM = (); 990 %$TERM = ();
845 } 991 }
846 992
847 $retval 993 $retval
994}
995
996sub SET_COLOR($$$) {
997 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
998}
999
1000sub rend2mask {
1001 no strict 'refs';
1002 my ($str, $mask) = (@_, 0);
1003 my %color = ( fg => undef, bg => undef );
1004 my @failed;
1005 for my $spec ( split /\s+/, $str ) {
1006 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1007 $color{lc($1)} = $2;
1008 } else {
1009 my $neg = $spec =~ s/^[-^]//;
1010 unless ( exists &{"RS_$spec"} ) {
1011 push @failed, $spec;
1012 next;
1013 }
1014 my $cur = &{"RS_$spec"};
1015 if ( $neg ) {
1016 $mask &= ~$cur;
1017 } else {
1018 $mask |= $cur;
1019 }
1020 }
1021 }
1022 ($mask, @color{qw(fg bg)}, \@failed)
848} 1023}
849 1024
850# urxvt::term::extension 1025# urxvt::term::extension
851 1026
852package urxvt::term::extension; 1027package urxvt::term::extension;
965sub DESTROY { 1140sub DESTROY {
966 $_[0][1]->stop; 1141 $_[0][1]->stop;
967} 1142}
968 1143
969sub condvar { 1144sub condvar {
970 bless \my $flag, urxvt::anyevent::condvar:: 1145 bless \my $flag, urxvt::anyevent::
971} 1146}
972 1147
973sub urxvt::anyevent::condvar::broadcast { 1148sub broadcast {
974 ${$_[0]}++; 1149 ${$_[0]}++;
975} 1150}
976 1151
977sub urxvt::anyevent::condvar::wait { 1152sub wait {
978 unless (${$_[0]}) { 1153 unless (${$_[0]}) {
979 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1154 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
980 } 1155 }
1156}
1157
1158sub one_event {
1159 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
981} 1160}
982 1161
983package urxvt::term; 1162package urxvt::term;
984 1163
985=head2 The C<urxvt::term> Class 1164=head2 The C<urxvt::term> Class
1021hash which defines the environment of the new terminal. 1200hash which defines the environment of the new terminal.
1022 1201
1023Croaks (and probably outputs an error message) if the new instance 1202Croaks (and probably outputs an error message) if the new instance
1024couldn't be created. Returns C<undef> if the new instance didn't 1203couldn't be created. Returns C<undef> if the new instance didn't
1025initialise perl, and the terminal object otherwise. The C<init> and 1204initialise perl, and the terminal object otherwise. The C<init> and
1026C<start> hooks will be called during this call. 1205C<start> hooks will be called before this call returns, and are free to
1206refer to global data (which is race free).
1027 1207
1028=cut 1208=cut
1029 1209
1030sub new { 1210sub new {
1031 my ($class, $env, @args) = @_; 1211 my ($class, $env, @args) = @_;
1032 1212
1213 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1214 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1215
1033 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1216 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1034} 1217}
1035 1218
1036=item $term->destroy 1219=item $term->destroy
1037 1220
1038Destroy the terminal object (close the window, free resources 1221Destroy the terminal object (close the window, free resources
1068 1251
1069Returns true if the option specified by C<$optval> is enabled, and 1252Returns true if the option specified by C<$optval> is enabled, and
1070optionally change it. All option values are stored by name in the hash 1253optionally change it. All option values are stored by name in the hash
1071C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1254C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1072 1255
1073Here is a a likely non-exhaustive list of option names, please see the 1256Here is a likely non-exhaustive list of option names, please see the
1074source file F</src/optinc.h> to see the actual list: 1257source file F</src/optinc.h> to see the actual list:
1075 1258
1076 borderLess console cursorBlink cursorUnderline hold iconic insecure 1259 borderLess console cursorBlink cursorUnderline hold iconic insecure
1077 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1260 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1078 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1261 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1095likely change). 1278likely change).
1096 1279
1097Please note that resource strings will currently only be freed when the 1280Please note that resource strings will currently only be freed when the
1098terminal is destroyed, so changing options frequently will eat memory. 1281terminal is destroyed, so changing options frequently will eat memory.
1099 1282
1100Here is a a likely non-exhaustive list of resource names, not all of which 1283Here is a likely non-exhaustive list of resource names, not all of which
1101are supported in every build, please see the source file F</src/rsinc.h> 1284are supported in every build, please see the source file F</src/rsinc.h>
1102to see the actual list: 1285to see the actual list:
1103 1286
1104 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1287 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1105 borderLess color cursorBlink cursorUnderline cutchars delete_key 1288 borderLess color cursorBlink cursorUnderline cutchars delete_key
1338Adds the specified events to the vt event mask. Useful e.g. when you want 1521Adds the specified events to the vt event mask. Useful e.g. when you want
1339to receive pointer events all the times: 1522to receive pointer events all the times:
1340 1523
1341 $term->vt_emask_add (urxvt::PointerMotionMask); 1524 $term->vt_emask_add (urxvt::PointerMotionMask);
1342 1525
1526=item $term->focus_in
1527
1528=item $term->focus_out
1529
1530=item $term->key_press ($state, $keycode[, $time])
1531
1532=item $term->key_release ($state, $keycode[, $time])
1533
1534Deliver various fake events to to terminal.
1535
1343=item $window_width = $term->width 1536=item $window_width = $term->width
1344 1537
1345=item $window_height = $term->height 1538=item $window_height = $term->height
1346 1539
1347=item $font_width = $term->fwidth 1540=item $font_width = $term->fwidth
1377=item $env = $term->env 1570=item $env = $term->env
1378 1571
1379Returns a copy of the environment in effect for the terminal as a hashref 1572Returns a copy of the environment in effect for the terminal as a hashref
1380similar to C<\%ENV>. 1573similar to C<\%ENV>.
1381 1574
1575=item @envv = $term->envv
1576
1577Returns the environment as array of strings of the form C<VAR=VALUE>.
1578
1579=item @argv = $term->argv
1580
1581Return the argument vector as this terminal, similar to @ARGV, but
1582includes the program name as first element.
1583
1382=cut 1584=cut
1383 1585
1384sub env { 1586sub env {
1385 if (my $env = $_[0]->_env) {
1386 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1587 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1387 } else {
1388 +{ %ENV }
1389 }
1390} 1588}
1391 1589
1392=item $modifiermask = $term->ModLevel3Mask 1590=item $modifiermask = $term->ModLevel3Mask
1393 1591
1394=item $modifiermask = $term->ModMetaMask 1592=item $modifiermask = $term->ModMetaMask
1402 1600
1403Returns the currently displayed screen (0 primary, 1 secondary). 1601Returns the currently displayed screen (0 primary, 1 secondary).
1404 1602
1405=item $cursor_is_hidden = $term->hidden_cursor 1603=item $cursor_is_hidden = $term->hidden_cursor
1406 1604
1407Returns wether the cursor is currently hidden or not. 1605Returns whether the cursor is currently hidden or not.
1408 1606
1409=item $view_start = $term->view_start ([$newvalue]) 1607=item $view_start = $term->view_start ([$newvalue])
1410 1608
1411Returns the row number of the topmost displayed line. Maximum value is 1609Returns the row number of the topmost displayed line. Maximum value is
1412C<0>, which displays the normal terminal contents. Lower values scroll 1610C<0>, which displays the normal terminal contents. Lower values scroll
1589where one character corresponds to one screen cell. See 1787where one character corresponds to one screen cell. See
1590C<< $term->ROW_t >> for details. 1788C<< $term->ROW_t >> for details.
1591 1789
1592=item $string = $term->special_decode $text 1790=item $string = $term->special_decode $text
1593 1791
1594Converts rxvt-unicodes text reprsentation into a perl string. See 1792Converts rxvt-unicodes text representation into a perl string. See
1595C<< $term->ROW_t >> for details. 1793C<< $term->ROW_t >> for details.
1596 1794
1597=item $success = $term->grab_button ($button, $modifiermask) 1795=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1598 1796
1797=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1798
1599Registers a synchronous button grab. See the XGrabButton manpage. 1799Register/unregister a synchronous button grab. See the XGrabButton
1800manpage.
1600 1801
1601=item $success = $term->grab ($eventtime[, $sync]) 1802=item $success = $term->grab ($eventtime[, $sync])
1602 1803
1603Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1804Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1604synchronous (C<$sync> is true). Also remembers the grab timestampe. 1805synchronous (C<$sync> is true). Also remembers the grab timestamp.
1605 1806
1606=item $term->allow_events_async 1807=item $term->allow_events_async
1607 1808
1608Calls XAllowEvents with AsyncBoth for the most recent grab. 1809Calls XAllowEvents with AsyncBoth for the most recent grab.
1609 1810
1722 my ($self, $text, $cb) = @_; 1923 my ($self, $text, $cb) = @_;
1723 1924
1724 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1925 $self->add_item ({ type => "button", text => $text, activate => $cb});
1725} 1926}
1726 1927
1727=item $popup->add_toggle ($text, $cb, $initial_value) 1928=item $popup->add_toggle ($text, $initial_value, $cb)
1728 1929
1729Adds a toggle/checkbox item to the popup. Teh callback gets called 1930Adds a toggle/checkbox item to the popup. The callback gets called
1730whenever it gets toggled, with a boolean indicating its value as its first 1931whenever it gets toggled, with a boolean indicating its new value as its
1731argument. 1932first argument.
1732 1933
1733=cut 1934=cut
1734 1935
1735sub add_toggle { 1936sub add_toggle {
1736 my ($self, $text, $cb, $value) = @_; 1937 my ($self, $text, $value, $cb) = @_;
1737 1938
1738 my $item; $item = { 1939 my $item; $item = {
1739 type => "button", 1940 type => "button",
1740 text => " $text", 1941 text => " $text",
1741 value => $value, 1942 value => $value,
1782=back 1983=back
1783 1984
1784=cut 1985=cut
1785 1986
1786package urxvt::watcher; 1987package urxvt::watcher;
1787
1788@urxvt::timer::ISA = __PACKAGE__;
1789@urxvt::iow::ISA = __PACKAGE__;
1790@urxvt::pw::ISA = __PACKAGE__;
1791@urxvt::iw::ISA = __PACKAGE__;
1792 1988
1793=head2 The C<urxvt::timer> Class 1989=head2 The C<urxvt::timer> Class
1794 1990
1795This class implements timer watchers/events. Time is represented as a 1991This class implements timer watchers/events. Time is represented as a
1796fractional number of seconds since the epoch. Example: 1992fractional number of seconds since the epoch. Example:
1876Set the callback to be called when io events are triggered. C<$reventmask> 2072Set the callback to be called when io events are triggered. C<$reventmask>
1877is a bitset as described in the C<events> method. 2073is a bitset as described in the C<events> method.
1878 2074
1879=item $iow = $iow->fd ($fd) 2075=item $iow = $iow->fd ($fd)
1880 2076
1881Set the filedescriptor (not handle) to watch. 2077Set the file descriptor (not handle) to watch.
1882 2078
1883=item $iow = $iow->events ($eventmask) 2079=item $iow = $iow->events ($eventmask)
1884 2080
1885Set the event mask to watch. The only allowed values are 2081Set the event mask to watch. The only allowed values are
1886C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2082C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1890 2086
1891Start watching for requested events on the given handle. 2087Start watching for requested events on the given handle.
1892 2088
1893=item $iow = $iow->stop 2089=item $iow = $iow->stop
1894 2090
1895Stop watching for events on the given filehandle. 2091Stop watching for events on the given file handle.
1896 2092
1897=back 2093=back
1898 2094
1899=head2 The C<urxvt::iw> Class 2095=head2 The C<urxvt::iw> Class
1900 2096
1947 2143
1948Set the callback to be called when the timer triggers. 2144Set the callback to be called when the timer triggers.
1949 2145
1950=item $pw = $timer->start ($pid) 2146=item $pw = $timer->start ($pid)
1951 2147
1952Tells the wqtcher to start watching for process C<$pid>. 2148Tells the watcher to start watching for process C<$pid>.
1953 2149
1954=item $pw = $pw->stop 2150=item $pw = $pw->stop
1955 2151
1956Stop the watcher. 2152Stop the watcher.
1957 2153
1970 2166
1971=item >= 3 - script loading and management 2167=item >= 3 - script loading and management
1972 2168
1973=item >=10 - all called hooks 2169=item >=10 - all called hooks
1974 2170
1975=item >=11 - hook reutrn values 2171=item >=11 - hook return values
1976 2172
1977=back 2173=back
1978 2174
1979=head1 AUTHOR 2175=head1 AUTHOR
1980 2176
1982 http://software.schmorp.de/pkg/rxvt-unicode 2178 http://software.schmorp.de/pkg/rxvt-unicode
1983 2179
1984=cut 2180=cut
1985 2181
19861 21821
2183
2184# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines