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.126 by root, Tue Jan 24 19:14:36 2006 UTC vs.
Revision 1.152 by tpope, Tue Jan 9 16:18:56 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
225=item block-graphics-to-ascii 311=item block-graphics-to-ascii
226 312
227A not very useful example of filtering all text output to the terminal, 313A not very useful example of filtering all text output to the terminal
228by replacing all line-drawing characters (U+2500 .. U+259F) by a 314by replacing all line-drawing characters (U+2500 .. U+259F) by a
229similar-looking ascii character. 315similar-looking ascii character.
230 316
231=item digital-clock 317=item digital-clock
232 318
233Displays a digital clock using the built-in overlay. 319Displays a digital clock using the built-in overlay.
234 320
235=item example-refresh-hooks 321=item remote-clipboard
236 322
237Displays a very simple digital clock in the upper right corner of the 323Somewhat of a misnomer, this extension adds two menu entries to the
238window. Illustrates overwriting the refresh callbacks to create your own 324selection popup that allows one ti run external commands to store the
239overlays or changes. 325selection somewhere and fetch it again.
326
327We use it to implement a "distributed selection mechanism", which just
328means that one command uploads the file to a remote server, and another
329reads it.
330
331The commands can be set using the C<URxvt.remote-selection.store> and
332C<URxvt.remote-selection.fetch> resources. The first should read the
333selection to store from STDIN (always in UTF-8), the second should provide
334the selection data on STDOUT (also in UTF-8).
335
336The defaults (which are likely useless to you) use rsh and cat:
337
338 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
339 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
240 340
241=item selection-pastebin 341=item selection-pastebin
242 342
243This is a little rarely useful extension that Uploads the selection as 343This is a little rarely useful extension that Uploads the selection as
244textfile to a remote site (or does other things). (The implementation is 344textfile to a remote site (or does other things). (The implementation is
264After a successful upload the selection will be replaced by the text given 364After a successful upload the selection will be replaced by the text given
265in the C<selection-pastebin-url> resource (again, the % is the placeholder 365in the C<selection-pastebin-url> resource (again, the % is the placeholder
266for the filename): 366for the filename):
267 367
268 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 368 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
369
370I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
371the double C</> characters as comment start. Use C<\057\057> instead,
372which works regardless of wether xrdb is used to parse the resource file
373or not.
374
375=item example-refresh-hooks
376
377Displays a very simple digital clock in the upper right corner of the
378window. Illustrates overwriting the refresh callbacks to create your own
379overlays or changes.
269 380
270=back 381=back
271 382
272=head1 API DOCUMENTATION 383=head1 API DOCUMENTATION
273 384
307 418
308=back 419=back
309 420
310=head2 Extension Objects 421=head2 Extension Objects
311 422
312Very perl extension is a perl class. A separate perl object is created 423Every 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 424for 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 425which are passed as the first parameter to hooks. So extensions can use
315about other extensions, with the exception of methods and members that 426their C<$self> object without having to think about clashes with other
427extensions or other terminals, with the exception of methods and members
316begin with an underscore character C<_>: these are reserved for internal 428that begin with an underscore character C<_>: these are reserved for
317use. 429internal use.
318 430
319Although it isn't a C<urxvt::term> object, you can call all methods of the 431Although it isn't a C<urxvt::term> object, you can call all methods of the
320C<urxvt::term> class on this object. 432C<urxvt::term> class on this object.
321 433
322It has the following methods and data members: 434It has the following methods and data members:
343=head2 Hooks 455=head2 Hooks
344 456
345The following subroutines can be declared in extension files, and will be 457The following subroutines can be declared in extension files, and will be
346called whenever the relevant event happens. 458called whenever the relevant event happens.
347 459
348The first argument passed to them is an extension oject as described in 460The first argument passed to them is an extension object as described in
349the in the C<Extension Objects> section. 461the in the C<Extension Objects> section.
350 462
351B<All> of these hooks must return a boolean value. If any of the called 463B<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 464hooks returns true, then the event counts as being I<consumed>, and the
353relevant action might not be carried out by the C++ code. 465relevant action might not be carried out by the C++ code.
366place. 478place.
367 479
368=item on_start $term 480=item on_start $term
369 481
370Called at the very end of initialisation of a new terminal, just before 482Called at the very end of initialisation of a new terminal, just before
371trying to map (display) the toplevel and returning to the mainloop. 483trying to map (display) the toplevel and returning to the main loop.
372 484
373=item on_destroy $term 485=item on_destroy $term
374 486
375Called whenever something tries to destroy terminal, before doing anything 487Called whenever something tries to destroy terminal, when the terminal is
376yet. If this hook returns true, then destruction is skipped, but this is 488still fully functional (not for long, though).
377rarely a good idea.
378 489
379=item on_reset $term 490=item on_reset $term
380 491
381Called after the screen is "reset" for any reason, such as resizing or 492Called after the screen is "reset" for any reason, such as resizing or
382control sequences. Here is where you can react on changes to size-related 493control sequences. Here is where you can react on changes to size-related
404 515
405Called whenever a selection has been copied, but before the selection is 516Called whenever a selection has been copied, but before the selection is
406requested from the server. The selection text can be queried and changed 517requested from the server. The selection text can be queried and changed
407by calling C<< $term->selection >>. 518by calling C<< $term->selection >>.
408 519
409Returning a true value aborts selection grabbing. It will still be hilighted. 520Returning a true value aborts selection grabbing. It will still be highlighted.
410 521
411=item on_sel_extend $term 522=item on_sel_extend $term
412 523
413Called whenever the user tries to extend the selection (e.g. with a double 524Called whenever the user tries to extend the selection (e.g. with a double
414click) and is either supposed to return false (normal operation), or 525click) and is either supposed to return false (normal operation), or
415should extend the selection itelf and return true to suppress the built-in 526should extend the selection itself and return true to suppress the built-in
416processing. This can happen multiple times, as long as the callback 527processing. This can happen multiple times, as long as the callback
417returns true, it will be called on every further click by the user and is 528returns true, it will be called on every further click by the user and is
418supposed to enlarge the selection more and more, if possible. 529supposed to enlarge the selection more and more, if possible.
419 530
420See the F<selection> example extension. 531See the F<selection> example extension.
421 532
422=item on_view_change $term, $offset 533=item on_view_change $term, $offset
423 534
424Called whenever the view offset changes, i..e the user or program 535Called whenever the view offset changes, i.e. the user or program
425scrolls. Offset C<0> means display the normal terminal, positive values 536scrolls. Offset C<0> means display the normal terminal, positive values
426show this many lines of scrollback. 537show this many lines of scrollback.
427 538
428=item on_scroll_back $term, $lines, $saved 539=item on_scroll_back $term, $lines, $saved
429 540
433 544
434It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 545It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
435$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 546$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
436number of lines that will be in the scrollback buffer. 547number of lines that will be in the scrollback buffer.
437 548
549=item on_osc_seq $term, $op, $args
550
551Called on every OSC sequence and can be used to suppress it or modify its
552behaviour. The default should be to return an empty list. A true value
553suppresses execution of the request completely. Make sure you don't get
554confused by recursive invocations when you output an osc sequence within
555this callback.
556
557C<on_osc_seq_perl> should be used for new behaviour.
558
438=item on_osc_seq $term, $string 559=item on_osc_seq_perl $term, $string
439 560
440Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 561Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
441operating system command) is processed. Cursor position and other state 562operating system command) is processed. Cursor position and other state
442information is up-to-date when this happens. For interoperability, the 563information is up-to-date when this happens. For interoperability, the
443string should start with the extension name and a colon, to distinguish 564string should start with the extension name and a colon, to distinguish
444it from commands for other extensions, and this might be enforced in the 565it from commands for other extensions, and this might be enforced in the
445future. 566future.
446 567
447Be careful not ever to trust (in a security sense) the data you receive, 568Be careful not ever to trust (in a security sense) the data you receive,
448as its source can not easily be controleld (e-mail content, messages from 569as its source can not easily be controlled (e-mail content, messages from
449other users on the same system etc.). 570other users on the same system etc.).
450 571
451=item on_add_lines $term, $string 572=item on_add_lines $term, $string
452 573
453Called whenever text is about to be output, with the text as argument. You 574Called whenever text is about to be output, with the text as argument. You
484 605
485=item on_refresh_end $term 606=item on_refresh_end $term
486 607
487Called just after the screen gets redrawn. See C<on_refresh_begin>. 608Called just after the screen gets redrawn. See C<on_refresh_begin>.
488 609
489=item on_keyboard_command $term, $string 610=item on_user_command $term, $string
490 611
491Called whenever the user presses a key combination that has a 612Called whenever a user-configured event is being activated (e.g. via
492C<perl:string> action bound to it (see description of the B<keysym> 613a C<perl:string> action bound to a key, see description of the B<keysym>
493resource in the @@RXVT_NAME@@(1) manpage). 614resource in the @@RXVT_NAME@@(1) manpage).
615
616The event is simply the action string. This interface is assumed to change
617slightly in the future.
618
619=item on_resize_all_windows $tern, $new_width, $new_height
620
621Called just after the new window size has been calculated, but before
622windows are actually being resized or hints are being set. If this hook
623returns TRUE, setting of the window hints is being skipped.
494 624
495=item on_x_event $term, $event 625=item on_x_event $term, $event
496 626
497Called on every X event received on the vt window (and possibly other 627Called on every X event received on the vt window (and possibly other
498windows). Should only be used as a last resort. Most event structure 628windows). Should only be used as a last resort. Most event structure
499members are not passed. 629members are not passed.
500 630
631=item on_root_event $term, $event
632
633Like C<on_x_event>, but is called for events on the root window.
634
501=item on_focus_in $term 635=item on_focus_in $term
502 636
503Called whenever the window gets the keyboard focus, before rxvt-unicode 637Called whenever the window gets the keyboard focus, before rxvt-unicode
504does focus in processing. 638does focus in processing.
505 639
506=item on_focus_out $term 640=item on_focus_out $term
507 641
508Called wheneever the window loses keyboard focus, before rxvt-unicode does 642Called whenever the window loses keyboard focus, before rxvt-unicode does
509focus out processing. 643focus out processing.
510 644
511=item on_configure_notify $term, $event 645=item on_configure_notify $term, $event
512 646
513=item on_property_notify $term, $event 647=item on_property_notify $term, $event
596The current terminal. This variable stores the current C<urxvt::term> 730The current terminal. This variable stores the current C<urxvt::term>
597object, whenever a callback/hook is executing. 731object, whenever a callback/hook is executing.
598 732
599=item @urxvt::TERM_INIT 733=item @urxvt::TERM_INIT
600 734
601All coderefs in this array will be called as methods of the next newly 735All code references in this array will be called as methods of the next newly
602created C<urxvt::term> object (during the C<on_init> phase). The array 736created C<urxvt::term> object (during the C<on_init> phase). The array
603gets cleared before the codereferences that were in it are being executed, 737gets cleared before the code references that were in it are being executed,
604so coderefs can push themselves onto it again if they so desire. 738so references can push themselves onto it again if they so desire.
605 739
606This complements to the perl-eval commandline option, but gets executed 740This complements to the perl-eval command line option, but gets executed
607first. 741first.
608 742
609=item @urxvt::TERM_EXT 743=item @urxvt::TERM_EXT
610 744
611Works similar to C<@TERM_INIT>, but contains perl package/class names, which 745Works similar to C<@TERM_INIT>, but contains perl package/class names, which
632 766
633Using this function has the advantage that its output ends up in the 767Using this function has the advantage that its output ends up in the
634correct place, e.g. on stderr of the connecting urxvtc client. 768correct place, e.g. on stderr of the connecting urxvtc client.
635 769
636Messages have a size limit of 1023 bytes currently. 770Messages have a size limit of 1023 bytes currently.
771
772=item @terms = urxvt::termlist
773
774Returns all urxvt::term objects that exist in this process, regardless of
775whether they are started, being destroyed etc., so be careful. Only term
776objects that have perl extensions attached will be returned (because there
777is no urxvt::term objet associated with others).
637 778
638=item $time = urxvt::NOW 779=item $time = urxvt::NOW
639 780
640Returns the "current time" (as per the event loop). 781Returns the "current time" (as per the event loop).
641 782
699Return the foreground/background colour index, respectively. 840Return the foreground/background colour index, respectively.
700 841
701=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 842=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
702 843
703=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 844=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
845
846=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
704 847
705Replace the foreground/background colour in the rendition mask with the 848Replace the foreground/background colour in the rendition mask with the
706specified one. 849specified one.
707 850
708=item $value = urxvt::GET_CUSTOM $rend 851=item $value = urxvt::GET_CUSTOM $rend
799 } else { 942 } else {
800 $ext_arg{$_} ||= []; 943 $ext_arg{$_} ||= [];
801 } 944 }
802 } 945 }
803 946
804 while (my ($ext, $argv) = each %ext_arg) { 947 for my $ext (sort keys %ext_arg) {
805 my @files = grep -f $_, map "$_/$ext", @dirs; 948 my @files = grep -f $_, map "$_/$ext", @dirs;
806 949
807 if (@files) { 950 if (@files) {
808 $TERM->register_package (extension_package $files[0], $argv); 951 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
809 } else { 952 } else {
810 warn "perl extension '$ext' not found in perl library search path\n"; 953 warn "perl extension '$ext' not found in perl library search path\n";
811 } 954 }
812 } 955 }
813 956
819 962
820 if (my $cb = $TERM->{_hook}[$htype]) { 963 if (my $cb = $TERM->{_hook}[$htype]) {
821 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 964 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
822 if $verbosity >= 10; 965 if $verbosity >= 10;
823 966
824 keys %$cb; 967 for my $pkg (keys %$cb) {
825
826 while (my ($pkg, $cb) = each %$cb) {
827 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 968 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
828 $retval ||= $retval_; 969 $retval ||= $retval_;
829 970
830 if ($@) { 971 if ($@) {
831 $TERM->ungrab; # better to lose the grab than the session 972 $TERM->ungrab; # better to lose the grab than the session
832 warn $@; 973 warn $@;
844 # clear package 985 # clear package
845 %$TERM = (); 986 %$TERM = ();
846 } 987 }
847 988
848 $retval 989 $retval
990}
991
992sub SET_COLOR($$$) {
993 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
994}
995
996sub rend2mask {
997 no strict 'refs';
998 my ($str, $mask) = (@_, 0);
999 my %color = ( fg => undef, bg => undef );
1000 my @failed;
1001 for my $spec ( split /\s+/, $str ) {
1002 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1003 $color{lc($1)} = $2;
1004 } else {
1005 my $neg = $spec =~ s/^[-^]//;
1006 unless ( exists &{"RS_$spec"} ) {
1007 push @failed, $spec;
1008 next;
1009 }
1010 my $cur = &{"RS_$spec"};
1011 if ( $neg ) {
1012 $mask &= ~$cur;
1013 } else {
1014 $mask |= $cur;
1015 }
1016 }
1017 }
1018 ($mask, @color{qw(fg bg)}, \@failed)
849} 1019}
850 1020
851# urxvt::term::extension 1021# urxvt::term::extension
852 1022
853package urxvt::term::extension; 1023package urxvt::term::extension;
966sub DESTROY { 1136sub DESTROY {
967 $_[0][1]->stop; 1137 $_[0][1]->stop;
968} 1138}
969 1139
970sub condvar { 1140sub condvar {
971 bless \my $flag, urxvt::anyevent::condvar:: 1141 bless \my $flag, urxvt::anyevent::
972} 1142}
973 1143
974sub urxvt::anyevent::condvar::broadcast { 1144sub broadcast {
975 ${$_[0]}++; 1145 ${$_[0]}++;
976} 1146}
977 1147
978sub urxvt::anyevent::condvar::wait { 1148sub wait {
979 unless (${$_[0]}) { 1149 unless (${$_[0]}) {
980 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1150 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
981 } 1151 }
1152}
1153
1154sub one_event {
1155 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
982} 1156}
983 1157
984package urxvt::term; 1158package urxvt::term;
985 1159
986=head2 The C<urxvt::term> Class 1160=head2 The C<urxvt::term> Class
1022hash which defines the environment of the new terminal. 1196hash which defines the environment of the new terminal.
1023 1197
1024Croaks (and probably outputs an error message) if the new instance 1198Croaks (and probably outputs an error message) if the new instance
1025couldn't be created. Returns C<undef> if the new instance didn't 1199couldn't be created. Returns C<undef> if the new instance didn't
1026initialise perl, and the terminal object otherwise. The C<init> and 1200initialise perl, and the terminal object otherwise. The C<init> and
1027C<start> hooks will be called during this call. 1201C<start> hooks will be called before this call returns, and are free to
1202refer to global data (which is race free).
1028 1203
1029=cut 1204=cut
1030 1205
1031sub new { 1206sub new {
1032 my ($class, $env, @args) = @_; 1207 my ($class, $env, @args) = @_;
1033 1208
1209 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1210 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1211
1034 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1212 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1035} 1213}
1036 1214
1037=item $term->destroy 1215=item $term->destroy
1038 1216
1039Destroy the terminal object (close the window, free resources 1217Destroy the terminal object (close the window, free resources
1069 1247
1070Returns true if the option specified by C<$optval> is enabled, and 1248Returns true if the option specified by C<$optval> is enabled, and
1071optionally change it. All option values are stored by name in the hash 1249optionally change it. All option values are stored by name in the hash
1072C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1250C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1073 1251
1074Here is a a likely non-exhaustive list of option names, please see the 1252Here is a likely non-exhaustive list of option names, please see the
1075source file F</src/optinc.h> to see the actual list: 1253source file F</src/optinc.h> to see the actual list:
1076 1254
1077 borderLess console cursorBlink cursorUnderline hold iconic insecure 1255 borderLess console cursorBlink cursorUnderline hold iconic insecure
1078 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1256 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1079 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1257 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1096likely change). 1274likely change).
1097 1275
1098Please note that resource strings will currently only be freed when the 1276Please note that resource strings will currently only be freed when the
1099terminal is destroyed, so changing options frequently will eat memory. 1277terminal is destroyed, so changing options frequently will eat memory.
1100 1278
1101Here is a a likely non-exhaustive list of resource names, not all of which 1279Here is a likely non-exhaustive list of resource names, not all of which
1102are supported in every build, please see the source file F</src/rsinc.h> 1280are supported in every build, please see the source file F</src/rsinc.h>
1103to see the actual list: 1281to see the actual list:
1104 1282
1105 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1283 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1106 borderLess color cursorBlink cursorUnderline cutchars delete_key 1284 borderLess color cursorBlink cursorUnderline cutchars delete_key
1339Adds the specified events to the vt event mask. Useful e.g. when you want 1517Adds the specified events to the vt event mask. Useful e.g. when you want
1340to receive pointer events all the times: 1518to receive pointer events all the times:
1341 1519
1342 $term->vt_emask_add (urxvt::PointerMotionMask); 1520 $term->vt_emask_add (urxvt::PointerMotionMask);
1343 1521
1522=item $term->focus_in
1523
1524=item $term->focus_out
1525
1526=item $term->key_press ($state, $keycode[, $time])
1527
1528=item $term->key_release ($state, $keycode[, $time])
1529
1530Deliver various fake events to to terminal.
1531
1344=item $window_width = $term->width 1532=item $window_width = $term->width
1345 1533
1346=item $window_height = $term->height 1534=item $window_height = $term->height
1347 1535
1348=item $font_width = $term->fwidth 1536=item $font_width = $term->fwidth
1378=item $env = $term->env 1566=item $env = $term->env
1379 1567
1380Returns a copy of the environment in effect for the terminal as a hashref 1568Returns a copy of the environment in effect for the terminal as a hashref
1381similar to C<\%ENV>. 1569similar to C<\%ENV>.
1382 1570
1571=item @envv = $term->envv
1572
1573Returns the environment as array of strings of the form C<VAR=VALUE>.
1574
1575=item @argv = $term->argv
1576
1577Return the argument vector as this terminal, similar to @ARGV, but
1578includes the program name as first element.
1579
1383=cut 1580=cut
1384 1581
1385sub env { 1582sub env {
1386 if (my $env = $_[0]->_env) {
1387 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1583 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1388 } else {
1389 +{ %ENV }
1390 }
1391} 1584}
1392 1585
1393=item $modifiermask = $term->ModLevel3Mask 1586=item $modifiermask = $term->ModLevel3Mask
1394 1587
1395=item $modifiermask = $term->ModMetaMask 1588=item $modifiermask = $term->ModMetaMask
1403 1596
1404Returns the currently displayed screen (0 primary, 1 secondary). 1597Returns the currently displayed screen (0 primary, 1 secondary).
1405 1598
1406=item $cursor_is_hidden = $term->hidden_cursor 1599=item $cursor_is_hidden = $term->hidden_cursor
1407 1600
1408Returns wether the cursor is currently hidden or not. 1601Returns whether the cursor is currently hidden or not.
1409 1602
1410=item $view_start = $term->view_start ([$newvalue]) 1603=item $view_start = $term->view_start ([$newvalue])
1411 1604
1412Returns the row number of the topmost displayed line. Maximum value is 1605Returns the row number of the topmost displayed line. Maximum value is
1413C<0>, which displays the normal terminal contents. Lower values scroll 1606C<0>, which displays the normal terminal contents. Lower values scroll
1590where one character corresponds to one screen cell. See 1783where one character corresponds to one screen cell. See
1591C<< $term->ROW_t >> for details. 1784C<< $term->ROW_t >> for details.
1592 1785
1593=item $string = $term->special_decode $text 1786=item $string = $term->special_decode $text
1594 1787
1595Converts rxvt-unicodes text reprsentation into a perl string. See 1788Converts rxvt-unicodes text representation into a perl string. See
1596C<< $term->ROW_t >> for details. 1789C<< $term->ROW_t >> for details.
1597 1790
1598=item $success = $term->grab_button ($button, $modifiermask) 1791=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1599 1792
1793=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1794
1600Registers a synchronous button grab. See the XGrabButton manpage. 1795Register/unregister a synchronous button grab. See the XGrabButton
1796manpage.
1601 1797
1602=item $success = $term->grab ($eventtime[, $sync]) 1798=item $success = $term->grab ($eventtime[, $sync])
1603 1799
1604Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1800Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1605synchronous (C<$sync> is true). Also remembers the grab timestampe. 1801synchronous (C<$sync> is true). Also remembers the grab timestamp.
1606 1802
1607=item $term->allow_events_async 1803=item $term->allow_events_async
1608 1804
1609Calls XAllowEvents with AsyncBoth for the most recent grab. 1805Calls XAllowEvents with AsyncBoth for the most recent grab.
1610 1806
1723 my ($self, $text, $cb) = @_; 1919 my ($self, $text, $cb) = @_;
1724 1920
1725 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1921 $self->add_item ({ type => "button", text => $text, activate => $cb});
1726} 1922}
1727 1923
1728=item $popup->add_toggle ($text, $cb, $initial_value) 1924=item $popup->add_toggle ($text, $initial_value, $cb)
1729 1925
1730Adds a toggle/checkbox item to the popup. Teh callback gets called 1926Adds a toggle/checkbox item to the popup. The callback gets called
1731whenever it gets toggled, with a boolean indicating its value as its first 1927whenever it gets toggled, with a boolean indicating its new value as its
1732argument. 1928first argument.
1733 1929
1734=cut 1930=cut
1735 1931
1736sub add_toggle { 1932sub add_toggle {
1737 my ($self, $text, $cb, $value) = @_; 1933 my ($self, $text, $value, $cb) = @_;
1738 1934
1739 my $item; $item = { 1935 my $item; $item = {
1740 type => "button", 1936 type => "button",
1741 text => " $text", 1937 text => " $text",
1742 value => $value, 1938 value => $value,
1783=back 1979=back
1784 1980
1785=cut 1981=cut
1786 1982
1787package urxvt::watcher; 1983package urxvt::watcher;
1788
1789@urxvt::timer::ISA = __PACKAGE__;
1790@urxvt::iow::ISA = __PACKAGE__;
1791@urxvt::pw::ISA = __PACKAGE__;
1792@urxvt::iw::ISA = __PACKAGE__;
1793 1984
1794=head2 The C<urxvt::timer> Class 1985=head2 The C<urxvt::timer> Class
1795 1986
1796This class implements timer watchers/events. Time is represented as a 1987This class implements timer watchers/events. Time is represented as a
1797fractional number of seconds since the epoch. Example: 1988fractional number of seconds since the epoch. Example:
1877Set the callback to be called when io events are triggered. C<$reventmask> 2068Set the callback to be called when io events are triggered. C<$reventmask>
1878is a bitset as described in the C<events> method. 2069is a bitset as described in the C<events> method.
1879 2070
1880=item $iow = $iow->fd ($fd) 2071=item $iow = $iow->fd ($fd)
1881 2072
1882Set the filedescriptor (not handle) to watch. 2073Set the file descriptor (not handle) to watch.
1883 2074
1884=item $iow = $iow->events ($eventmask) 2075=item $iow = $iow->events ($eventmask)
1885 2076
1886Set the event mask to watch. The only allowed values are 2077Set the event mask to watch. The only allowed values are
1887C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2078C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1891 2082
1892Start watching for requested events on the given handle. 2083Start watching for requested events on the given handle.
1893 2084
1894=item $iow = $iow->stop 2085=item $iow = $iow->stop
1895 2086
1896Stop watching for events on the given filehandle. 2087Stop watching for events on the given file handle.
1897 2088
1898=back 2089=back
1899 2090
1900=head2 The C<urxvt::iw> Class 2091=head2 The C<urxvt::iw> Class
1901 2092
1948 2139
1949Set the callback to be called when the timer triggers. 2140Set the callback to be called when the timer triggers.
1950 2141
1951=item $pw = $timer->start ($pid) 2142=item $pw = $timer->start ($pid)
1952 2143
1953Tells the wqtcher to start watching for process C<$pid>. 2144Tells the watcher to start watching for process C<$pid>.
1954 2145
1955=item $pw = $pw->stop 2146=item $pw = $pw->stop
1956 2147
1957Stop the watcher. 2148Stop the watcher.
1958 2149
1971 2162
1972=item >= 3 - script loading and management 2163=item >= 3 - script loading and management
1973 2164
1974=item >=10 - all called hooks 2165=item >=10 - all called hooks
1975 2166
1976=item >=11 - hook reutrn values 2167=item >=11 - hook return values
1977 2168
1978=back 2169=back
1979 2170
1980=head1 AUTHOR 2171=head1 AUTHOR
1981 2172
1983 http://software.schmorp.de/pkg/rxvt-unicode 2174 http://software.schmorp.de/pkg/rxvt-unicode
1984 2175
1985=cut 2176=cut
1986 2177
19871 21781
2179
2180# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines