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.128 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.154 by root, Sat Jun 2 06:43:02 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
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
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
30 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/>.
62 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
63 ... 66 ...
64 67
65The index number (0, 1...) must not have any holes, and each regex must 68The 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 69contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
68between two vertical bars: 71between two vertical bars:
69 72
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
71 74
72Another example: Programs I use often output "absolute path: " at the 75Another example: Programs I use often output "absolute path: " at the
94=item option-popup (enabled by default) 97=item option-popup (enabled by default)
95 98
96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97runtime. 100runtime.
98 101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106It's sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
118
99=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
100 120
101Binds a popup menu to Ctrl-Button3 that lets you convert the selection 121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
102text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
103evaluation, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
104 124
105Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107popup is displayed. 127popup is being displayed.
108 128
109It's sole argument is the popup menu, which can be modified. The selection 129It'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. 130is 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 131It 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 132string will be used as button text and the code reference will be called
113when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
114 134
115The 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
134bottom. 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
135was 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
136additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
137selection. 157selection.
138 158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
164
139=item readline (enabled by default) 165=item readline (enabled by default)
140 166
141A support package that tries to make editing with readline easier. At the 167A support package that tries to make editing with readline easier. At
142moment, it reacts to clicking with the left mouse button by trying to 168the 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 169move 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 170cursor-left or cursor-right keypresses as required (the this only works
145for programs that correctly support wide characters). 171for programs that correctly support wide characters).
146 172
147To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
197the message into vi commands to load the file. 223the message into vi commands to load the file.
198 224
199=item tabbed 225=item tabbed
200 226
201This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
202is, it implements what is commonly refered to as "tabbed terminal". The topmost line 228is, 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 229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
204button per tab. 230button per tab.
205 231
206Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking 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, 233B<Shift-Right> will switch to the tab left or right of the current one,
208while B<Shift-Down> creates a new tab. 234while B<Shift-Down> creates a new tab.
209 235
210=item mark-urls 236The tabbar itself can be configured similarly to a normal terminal, but
237with a resource class of C<URxvt.tabbed>. In addition, it supports the
238following four resources (shown with defaults):
211 239
240 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242 URxvt.tabbed.tab-fg: <colour-index, default 0>
243 URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246indices.
247
248=item matcher
249
212Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
213make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
214resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
215the URL as first argument. 253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264Example configuration:
265
266 URxvt.perl-ext: default,matcher
267 URxvt.urlLauncher: sensible-browser
268 URxvt.keysym.C-Delete: perl:matcher
269 URxvt.matcher.button: 1
270 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
271 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
272 URxvt.matcher.launcher.2: gvim +$2 $1
216 273
217=item xim-onthespot 274=item xim-onthespot
218 275
219This (experimental) perl extension implements OnTheSpot editing. It does 276This (experimental) perl extension implements OnTheSpot editing. It does
220not work perfectly, and some input methods don't seem to work well with 277not work perfectly, and some input methods don't seem to work well with
224You enable it by specifying this extension and a preedit style of 281You enable it by specifying this extension and a preedit style of
225C<OnTheSpot>, i.e.: 282C<OnTheSpot>, i.e.:
226 283
227 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 284 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228 285
286=item kuake<hotkey>
287
288A very primitive quake-console-like extension. It was inspired by a
289description of how the programs C<kuake> and C<yakuake> work: Whenever the
290user presses a global accelerator key (by default C<F10>), the terminal
291will show or hide itself. Another press of the accelerator key will hide
292or show it again.
293
294Initially, the window will not be shown when using this extension.
295
296This is useful if you need a single terminal thats not using any desktop
297space most of the time but is quickly available at the press of a key.
298
299The accelerator key is grabbed regardless of any modifiers, so this
300extension will actually grab a physical key just for this function.
301
302If you want a quake-like animation, tell your window manager to do so
303(fvwm can do it).
304
229=item automove-background 305=item automove-background
230 306
231This is basically a one-line extension that dynamically changes the background pixmap offset 307This is basically a very small extension that dynamically changes the
232to the window position, in effect creating the same effect as pseudo transparency with 308background pixmap offset to the window position, in effect creating the
233a custom pixmap. No scaling is supported in this mode. Exmaple: 309same effect as pseudo transparency with a custom pixmap. No scaling is
310supported in this mode. Example:
234 311
235 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 312 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
236 313
314L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
315shows how this extension can be used to implement an automatically blurred
316transparent background.
317
237=item block-graphics-to-ascii 318=item block-graphics-to-ascii
238 319
239A not very useful example of filtering all text output to the terminal, 320A not very useful example of filtering all text output to the terminal
240by replacing all line-drawing characters (U+2500 .. U+259F) by a 321by replacing all line-drawing characters (U+2500 .. U+259F) by a
241similar-looking ascii character. 322similar-looking ascii character.
242 323
243=item digital-clock 324=item digital-clock
244 325
245Displays a digital clock using the built-in overlay. 326Displays a digital clock using the built-in overlay.
246 327
247=item example-refresh-hooks 328=item remote-clipboard
248 329
249Displays a very simple digital clock in the upper right corner of the 330Somewhat of a misnomer, this extension adds two menu entries to the
250window. Illustrates overwriting the refresh callbacks to create your own 331selection popup that allows one ti run external commands to store the
251overlays or changes. 332selection somewhere and fetch it again.
333
334We use it to implement a "distributed selection mechanism", which just
335means that one command uploads the file to a remote server, and another
336reads it.
337
338The commands can be set using the C<URxvt.remote-selection.store> and
339C<URxvt.remote-selection.fetch> resources. The first should read the
340selection to store from STDIN (always in UTF-8), the second should provide
341the selection data on STDOUT (also in UTF-8).
342
343The defaults (which are likely useless to you) use rsh and cat:
344
345 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
346 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
252 347
253=item selection-pastebin 348=item selection-pastebin
254 349
255This is a little rarely useful extension that Uploads the selection as 350This is a little rarely useful extension that Uploads the selection as
256textfile to a remote site (or does other things). (The implementation is 351textfile to a remote site (or does other things). (The implementation is
276After a successful upload the selection will be replaced by the text given 371After a successful upload the selection will be replaced by the text given
277in the C<selection-pastebin-url> resource (again, the % is the placeholder 372in the C<selection-pastebin-url> resource (again, the % is the placeholder
278for the filename): 373for the filename):
279 374
280 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 375 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
376
377I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
378the double C</> characters as comment start. Use C<\057\057> instead,
379which works regardless of wether xrdb is used to parse the resource file
380or not.
381
382=item example-refresh-hooks
383
384Displays a very simple digital clock in the upper right corner of the
385window. Illustrates overwriting the refresh callbacks to create your own
386overlays or changes.
281 387
282=back 388=back
283 389
284=head1 API DOCUMENTATION 390=head1 API DOCUMENTATION
285 391
319 425
320=back 426=back
321 427
322=head2 Extension Objects 428=head2 Extension Objects
323 429
324Very perl extension is a perl class. A separate perl object is created 430Every perl extension is a perl class. A separate perl object is created
325for each terminal and each extension and passed as the first parameter to 431for each terminal, and each terminal has its own set of extenion objects,
326hooks. So extensions can use their C<$self> object without having to think 432which are passed as the first parameter to hooks. So extensions can use
327about other extensions, with the exception of methods and members that 433their C<$self> object without having to think about clashes with other
434extensions or other terminals, with the exception of methods and members
328begin with an underscore character C<_>: these are reserved for internal 435that begin with an underscore character C<_>: these are reserved for
329use. 436internal use.
330 437
331Although it isn't a C<urxvt::term> object, you can call all methods of the 438Although it isn't a C<urxvt::term> object, you can call all methods of the
332C<urxvt::term> class on this object. 439C<urxvt::term> class on this object.
333 440
334It has the following methods and data members: 441It has the following methods and data members:
355=head2 Hooks 462=head2 Hooks
356 463
357The following subroutines can be declared in extension files, and will be 464The following subroutines can be declared in extension files, and will be
358called whenever the relevant event happens. 465called whenever the relevant event happens.
359 466
360The first argument passed to them is an extension oject as described in 467The first argument passed to them is an extension object as described in
361the in the C<Extension Objects> section. 468the in the C<Extension Objects> section.
362 469
363B<All> of these hooks must return a boolean value. If any of the called 470B<All> of these hooks must return a boolean value. If any of the called
364hooks returns true, then the event counts as being I<consumed>, and the 471hooks returns true, then the event counts as being I<consumed>, and the
365relevant action might not be carried out by the C++ code. 472relevant action might not be carried out by the C++ code.
378place. 485place.
379 486
380=item on_start $term 487=item on_start $term
381 488
382Called at the very end of initialisation of a new terminal, just before 489Called at the very end of initialisation of a new terminal, just before
383trying to map (display) the toplevel and returning to the mainloop. 490trying to map (display) the toplevel and returning to the main loop.
384 491
385=item on_destroy $term 492=item on_destroy $term
386 493
387Called whenever something tries to destroy terminal, when the terminal is 494Called whenever something tries to destroy terminal, when the terminal is
388still fully functional (not for long, though). 495still fully functional (not for long, though).
415 522
416Called whenever a selection has been copied, but before the selection is 523Called whenever a selection has been copied, but before the selection is
417requested from the server. The selection text can be queried and changed 524requested from the server. The selection text can be queried and changed
418by calling C<< $term->selection >>. 525by calling C<< $term->selection >>.
419 526
420Returning a true value aborts selection grabbing. It will still be hilighted. 527Returning a true value aborts selection grabbing. It will still be highlighted.
421 528
422=item on_sel_extend $term 529=item on_sel_extend $term
423 530
424Called whenever the user tries to extend the selection (e.g. with a double 531Called whenever the user tries to extend the selection (e.g. with a double
425click) and is either supposed to return false (normal operation), or 532click) and is either supposed to return false (normal operation), or
426should extend the selection itelf and return true to suppress the built-in 533should extend the selection itself and return true to suppress the built-in
427processing. This can happen multiple times, as long as the callback 534processing. This can happen multiple times, as long as the callback
428returns true, it will be called on every further click by the user and is 535returns true, it will be called on every further click by the user and is
429supposed to enlarge the selection more and more, if possible. 536supposed to enlarge the selection more and more, if possible.
430 537
431See the F<selection> example extension. 538See the F<selection> example extension.
432 539
433=item on_view_change $term, $offset 540=item on_view_change $term, $offset
434 541
435Called whenever the view offset changes, i..e the user or program 542Called whenever the view offset changes, i.e. the user or program
436scrolls. Offset C<0> means display the normal terminal, positive values 543scrolls. Offset C<0> means display the normal terminal, positive values
437show this many lines of scrollback. 544show this many lines of scrollback.
438 545
439=item on_scroll_back $term, $lines, $saved 546=item on_scroll_back $term, $lines, $saved
440 547
444 551
445It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 552It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
446$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 553$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
447number of lines that will be in the scrollback buffer. 554number of lines that will be in the scrollback buffer.
448 555
556=item on_osc_seq $term, $op, $args
557
558Called on every OSC sequence and can be used to suppress it or modify its
559behaviour. The default should be to return an empty list. A true value
560suppresses execution of the request completely. Make sure you don't get
561confused by recursive invocations when you output an osc sequence within
562this callback.
563
564C<on_osc_seq_perl> should be used for new behaviour.
565
449=item on_osc_seq $term, $string 566=item on_osc_seq_perl $term, $string
450 567
451Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 568Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
452operating system command) is processed. Cursor position and other state 569operating system command) is processed. Cursor position and other state
453information is up-to-date when this happens. For interoperability, the 570information is up-to-date when this happens. For interoperability, the
454string should start with the extension name and a colon, to distinguish 571string should start with the extension name and a colon, to distinguish
455it from commands for other extensions, and this might be enforced in the 572it from commands for other extensions, and this might be enforced in the
456future. 573future.
457 574
458Be careful not ever to trust (in a security sense) the data you receive, 575Be careful not ever to trust (in a security sense) the data you receive,
459as its source can not easily be controleld (e-mail content, messages from 576as its source can not easily be controlled (e-mail content, messages from
460other users on the same system etc.). 577other users on the same system etc.).
461 578
462=item on_add_lines $term, $string 579=item on_add_lines $term, $string
463 580
464Called whenever text is about to be output, with the text as argument. You 581Called whenever text is about to be output, with the text as argument. You
495 612
496=item on_refresh_end $term 613=item on_refresh_end $term
497 614
498Called just after the screen gets redrawn. See C<on_refresh_begin>. 615Called just after the screen gets redrawn. See C<on_refresh_begin>.
499 616
500=item on_keyboard_command $term, $string 617=item on_user_command $term, $string
501 618
502Called whenever the user presses a key combination that has a 619Called whenever a user-configured event is being activated (e.g. via
503C<perl:string> action bound to it (see description of the B<keysym> 620a C<perl:string> action bound to a key, see description of the B<keysym>
504resource in the @@RXVT_NAME@@(1) manpage). 621resource in the @@RXVT_NAME@@(1) manpage).
622
623The event is simply the action string. This interface is assumed to change
624slightly in the future.
625
626=item on_resize_all_windows $tern, $new_width, $new_height
627
628Called just after the new window size has been calculated, but before
629windows are actually being resized or hints are being set. If this hook
630returns TRUE, setting of the window hints is being skipped.
505 631
506=item on_x_event $term, $event 632=item on_x_event $term, $event
507 633
508Called on every X event received on the vt window (and possibly other 634Called on every X event received on the vt window (and possibly other
509windows). Should only be used as a last resort. Most event structure 635windows). Should only be used as a last resort. Most event structure
510members are not passed. 636members are not passed.
511 637
638=item on_root_event $term, $event
639
640Like C<on_x_event>, but is called for events on the root window.
641
512=item on_focus_in $term 642=item on_focus_in $term
513 643
514Called whenever the window gets the keyboard focus, before rxvt-unicode 644Called whenever the window gets the keyboard focus, before rxvt-unicode
515does focus in processing. 645does focus in processing.
516 646
517=item on_focus_out $term 647=item on_focus_out $term
518 648
519Called wheneever the window loses keyboard focus, before rxvt-unicode does 649Called whenever the window loses keyboard focus, before rxvt-unicode does
520focus out processing. 650focus out processing.
521 651
522=item on_configure_notify $term, $event 652=item on_configure_notify $term, $event
523 653
524=item on_property_notify $term, $event 654=item on_property_notify $term, $event
607The current terminal. This variable stores the current C<urxvt::term> 737The current terminal. This variable stores the current C<urxvt::term>
608object, whenever a callback/hook is executing. 738object, whenever a callback/hook is executing.
609 739
610=item @urxvt::TERM_INIT 740=item @urxvt::TERM_INIT
611 741
612All coderefs in this array will be called as methods of the next newly 742All code references in this array will be called as methods of the next newly
613created C<urxvt::term> object (during the C<on_init> phase). The array 743created C<urxvt::term> object (during the C<on_init> phase). The array
614gets cleared before the codereferences that were in it are being executed, 744gets cleared before the code references that were in it are being executed,
615so coderefs can push themselves onto it again if they so desire. 745so references can push themselves onto it again if they so desire.
616 746
617This complements to the perl-eval commandline option, but gets executed 747This complements to the perl-eval command line option, but gets executed
618first. 748first.
619 749
620=item @urxvt::TERM_EXT 750=item @urxvt::TERM_EXT
621 751
622Works similar to C<@TERM_INIT>, but contains perl package/class names, which 752Works similar to C<@TERM_INIT>, but contains perl package/class names, which
643 773
644Using this function has the advantage that its output ends up in the 774Using this function has the advantage that its output ends up in the
645correct place, e.g. on stderr of the connecting urxvtc client. 775correct place, e.g. on stderr of the connecting urxvtc client.
646 776
647Messages have a size limit of 1023 bytes currently. 777Messages have a size limit of 1023 bytes currently.
778
779=item @terms = urxvt::termlist
780
781Returns all urxvt::term objects that exist in this process, regardless of
782whether they are started, being destroyed etc., so be careful. Only term
783objects that have perl extensions attached will be returned (because there
784is no urxvt::term objet associated with others).
648 785
649=item $time = urxvt::NOW 786=item $time = urxvt::NOW
650 787
651Returns the "current time" (as per the event loop). 788Returns the "current time" (as per the event loop).
652 789
710Return the foreground/background colour index, respectively. 847Return the foreground/background colour index, respectively.
711 848
712=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 849=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
713 850
714=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 851=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
852
853=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
715 854
716Replace the foreground/background colour in the rendition mask with the 855Replace the foreground/background colour in the rendition mask with the
717specified one. 856specified one.
718 857
719=item $value = urxvt::GET_CUSTOM $rend 858=item $value = urxvt::GET_CUSTOM $rend
810 } else { 949 } else {
811 $ext_arg{$_} ||= []; 950 $ext_arg{$_} ||= [];
812 } 951 }
813 } 952 }
814 953
815 while (my ($ext, $argv) = each %ext_arg) { 954 for my $ext (sort keys %ext_arg) {
816 my @files = grep -f $_, map "$_/$ext", @dirs; 955 my @files = grep -f $_, map "$_/$ext", @dirs;
817 956
818 if (@files) { 957 if (@files) {
819 $TERM->register_package (extension_package $files[0], $argv); 958 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
820 } else { 959 } else {
821 warn "perl extension '$ext' not found in perl library search path\n"; 960 warn "perl extension '$ext' not found in perl library search path\n";
822 } 961 }
823 } 962 }
824 963
830 969
831 if (my $cb = $TERM->{_hook}[$htype]) { 970 if (my $cb = $TERM->{_hook}[$htype]) {
832 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 971 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
833 if $verbosity >= 10; 972 if $verbosity >= 10;
834 973
835 keys %$cb; 974 for my $pkg (keys %$cb) {
836
837 while (my ($pkg, $cb) = each %$cb) {
838 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 975 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
839 $retval ||= $retval_; 976 $retval ||= $retval_;
840 977
841 if ($@) { 978 if ($@) {
842 $TERM->ungrab; # better to lose the grab than the session 979 $TERM->ungrab; # better to lose the grab than the session
843 warn $@; 980 warn $@;
855 # clear package 992 # clear package
856 %$TERM = (); 993 %$TERM = ();
857 } 994 }
858 995
859 $retval 996 $retval
997}
998
999sub SET_COLOR($$$) {
1000 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1001}
1002
1003sub rend2mask {
1004 no strict 'refs';
1005 my ($str, $mask) = (@_, 0);
1006 my %color = ( fg => undef, bg => undef );
1007 my @failed;
1008 for my $spec ( split /\s+/, $str ) {
1009 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1010 $color{lc($1)} = $2;
1011 } else {
1012 my $neg = $spec =~ s/^[-^]//;
1013 unless ( exists &{"RS_$spec"} ) {
1014 push @failed, $spec;
1015 next;
1016 }
1017 my $cur = &{"RS_$spec"};
1018 if ( $neg ) {
1019 $mask &= ~$cur;
1020 } else {
1021 $mask |= $cur;
1022 }
1023 }
1024 }
1025 ($mask, @color{qw(fg bg)}, \@failed)
860} 1026}
861 1027
862# urxvt::term::extension 1028# urxvt::term::extension
863 1029
864package urxvt::term::extension; 1030package urxvt::term::extension;
977sub DESTROY { 1143sub DESTROY {
978 $_[0][1]->stop; 1144 $_[0][1]->stop;
979} 1145}
980 1146
981sub condvar { 1147sub condvar {
982 bless \my $flag, urxvt::anyevent::condvar:: 1148 bless \my $flag, urxvt::anyevent::
983} 1149}
984 1150
985sub urxvt::anyevent::condvar::broadcast { 1151sub broadcast {
986 ${$_[0]}++; 1152 ${$_[0]}++;
987} 1153}
988 1154
989sub urxvt::anyevent::condvar::wait { 1155sub wait {
990 unless (${$_[0]}) { 1156 unless (${$_[0]}) {
991 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1157 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
992 } 1158 }
1159}
1160
1161sub one_event {
1162 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
993} 1163}
994 1164
995package urxvt::term; 1165package urxvt::term;
996 1166
997=head2 The C<urxvt::term> Class 1167=head2 The C<urxvt::term> Class
1033hash which defines the environment of the new terminal. 1203hash which defines the environment of the new terminal.
1034 1204
1035Croaks (and probably outputs an error message) if the new instance 1205Croaks (and probably outputs an error message) if the new instance
1036couldn't be created. Returns C<undef> if the new instance didn't 1206couldn't be created. Returns C<undef> if the new instance didn't
1037initialise perl, and the terminal object otherwise. The C<init> and 1207initialise perl, and the terminal object otherwise. The C<init> and
1038C<start> hooks will be called during this call. 1208C<start> hooks will be called before this call returns, and are free to
1209refer to global data (which is race free).
1039 1210
1040=cut 1211=cut
1041 1212
1042sub new { 1213sub new {
1043 my ($class, $env, @args) = @_; 1214 my ($class, $env, @args) = @_;
1044 1215
1216 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1217 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1218
1045 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1219 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1046} 1220}
1047 1221
1048=item $term->destroy 1222=item $term->destroy
1049 1223
1050Destroy the terminal object (close the window, free resources 1224Destroy the terminal object (close the window, free resources
1080 1254
1081Returns true if the option specified by C<$optval> is enabled, and 1255Returns true if the option specified by C<$optval> is enabled, and
1082optionally change it. All option values are stored by name in the hash 1256optionally change it. All option values are stored by name in the hash
1083C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1257C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1084 1258
1085Here is a a likely non-exhaustive list of option names, please see the 1259Here is a likely non-exhaustive list of option names, please see the
1086source file F</src/optinc.h> to see the actual list: 1260source file F</src/optinc.h> to see the actual list:
1087 1261
1088 borderLess console cursorBlink cursorUnderline hold iconic insecure 1262 borderLess console cursorBlink cursorUnderline hold iconic insecure
1089 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1263 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1090 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1264 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1107likely change). 1281likely change).
1108 1282
1109Please note that resource strings will currently only be freed when the 1283Please note that resource strings will currently only be freed when the
1110terminal is destroyed, so changing options frequently will eat memory. 1284terminal is destroyed, so changing options frequently will eat memory.
1111 1285
1112Here is a a likely non-exhaustive list of resource names, not all of which 1286Here is a likely non-exhaustive list of resource names, not all of which
1113are supported in every build, please see the source file F</src/rsinc.h> 1287are supported in every build, please see the source file F</src/rsinc.h>
1114to see the actual list: 1288to see the actual list:
1115 1289
1116 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1290 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1117 borderLess color cursorBlink cursorUnderline cutchars delete_key 1291 borderLess color cursorBlink cursorUnderline cutchars delete_key
1350Adds the specified events to the vt event mask. Useful e.g. when you want 1524Adds the specified events to the vt event mask. Useful e.g. when you want
1351to receive pointer events all the times: 1525to receive pointer events all the times:
1352 1526
1353 $term->vt_emask_add (urxvt::PointerMotionMask); 1527 $term->vt_emask_add (urxvt::PointerMotionMask);
1354 1528
1529=item $term->focus_in
1530
1531=item $term->focus_out
1532
1533=item $term->key_press ($state, $keycode[, $time])
1534
1535=item $term->key_release ($state, $keycode[, $time])
1536
1537Deliver various fake events to to terminal.
1538
1355=item $window_width = $term->width 1539=item $window_width = $term->width
1356 1540
1357=item $window_height = $term->height 1541=item $window_height = $term->height
1358 1542
1359=item $font_width = $term->fwidth 1543=item $font_width = $term->fwidth
1389=item $env = $term->env 1573=item $env = $term->env
1390 1574
1391Returns a copy of the environment in effect for the terminal as a hashref 1575Returns a copy of the environment in effect for the terminal as a hashref
1392similar to C<\%ENV>. 1576similar to C<\%ENV>.
1393 1577
1578=item @envv = $term->envv
1579
1580Returns the environment as array of strings of the form C<VAR=VALUE>.
1581
1582=item @argv = $term->argv
1583
1584Return the argument vector as this terminal, similar to @ARGV, but
1585includes the program name as first element.
1586
1394=cut 1587=cut
1395 1588
1396sub env { 1589sub env {
1397 if (my $env = $_[0]->_env) {
1398 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1590 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1399 } else {
1400 +{ %ENV }
1401 }
1402} 1591}
1403 1592
1404=item $modifiermask = $term->ModLevel3Mask 1593=item $modifiermask = $term->ModLevel3Mask
1405 1594
1406=item $modifiermask = $term->ModMetaMask 1595=item $modifiermask = $term->ModMetaMask
1414 1603
1415Returns the currently displayed screen (0 primary, 1 secondary). 1604Returns the currently displayed screen (0 primary, 1 secondary).
1416 1605
1417=item $cursor_is_hidden = $term->hidden_cursor 1606=item $cursor_is_hidden = $term->hidden_cursor
1418 1607
1419Returns wether the cursor is currently hidden or not. 1608Returns whether the cursor is currently hidden or not.
1420 1609
1421=item $view_start = $term->view_start ([$newvalue]) 1610=item $view_start = $term->view_start ([$newvalue])
1422 1611
1423Returns the row number of the topmost displayed line. Maximum value is 1612Returns the row number of the topmost displayed line. Maximum value is
1424C<0>, which displays the normal terminal contents. Lower values scroll 1613C<0>, which displays the normal terminal contents. Lower values scroll
1601where one character corresponds to one screen cell. See 1790where one character corresponds to one screen cell. See
1602C<< $term->ROW_t >> for details. 1791C<< $term->ROW_t >> for details.
1603 1792
1604=item $string = $term->special_decode $text 1793=item $string = $term->special_decode $text
1605 1794
1606Converts rxvt-unicodes text reprsentation into a perl string. See 1795Converts rxvt-unicodes text representation into a perl string. See
1607C<< $term->ROW_t >> for details. 1796C<< $term->ROW_t >> for details.
1608 1797
1609=item $success = $term->grab_button ($button, $modifiermask) 1798=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1610 1799
1800=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1801
1611Registers a synchronous button grab. See the XGrabButton manpage. 1802Register/unregister a synchronous button grab. See the XGrabButton
1803manpage.
1612 1804
1613=item $success = $term->grab ($eventtime[, $sync]) 1805=item $success = $term->grab ($eventtime[, $sync])
1614 1806
1615Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1807Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1616synchronous (C<$sync> is true). Also remembers the grab timestampe. 1808synchronous (C<$sync> is true). Also remembers the grab timestamp.
1617 1809
1618=item $term->allow_events_async 1810=item $term->allow_events_async
1619 1811
1620Calls XAllowEvents with AsyncBoth for the most recent grab. 1812Calls XAllowEvents with AsyncBoth for the most recent grab.
1621 1813
1734 my ($self, $text, $cb) = @_; 1926 my ($self, $text, $cb) = @_;
1735 1927
1736 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1928 $self->add_item ({ type => "button", text => $text, activate => $cb});
1737} 1929}
1738 1930
1739=item $popup->add_toggle ($text, $cb, $initial_value) 1931=item $popup->add_toggle ($text, $initial_value, $cb)
1740 1932
1741Adds a toggle/checkbox item to the popup. Teh callback gets called 1933Adds a toggle/checkbox item to the popup. The callback gets called
1742whenever it gets toggled, with a boolean indicating its value as its first 1934whenever it gets toggled, with a boolean indicating its new value as its
1743argument. 1935first argument.
1744 1936
1745=cut 1937=cut
1746 1938
1747sub add_toggle { 1939sub add_toggle {
1748 my ($self, $text, $cb, $value) = @_; 1940 my ($self, $text, $value, $cb) = @_;
1749 1941
1750 my $item; $item = { 1942 my $item; $item = {
1751 type => "button", 1943 type => "button",
1752 text => " $text", 1944 text => " $text",
1753 value => $value, 1945 value => $value,
1794=back 1986=back
1795 1987
1796=cut 1988=cut
1797 1989
1798package urxvt::watcher; 1990package urxvt::watcher;
1799
1800@urxvt::timer::ISA = __PACKAGE__;
1801@urxvt::iow::ISA = __PACKAGE__;
1802@urxvt::pw::ISA = __PACKAGE__;
1803@urxvt::iw::ISA = __PACKAGE__;
1804 1991
1805=head2 The C<urxvt::timer> Class 1992=head2 The C<urxvt::timer> Class
1806 1993
1807This class implements timer watchers/events. Time is represented as a 1994This class implements timer watchers/events. Time is represented as a
1808fractional number of seconds since the epoch. Example: 1995fractional number of seconds since the epoch. Example:
1888Set the callback to be called when io events are triggered. C<$reventmask> 2075Set the callback to be called when io events are triggered. C<$reventmask>
1889is a bitset as described in the C<events> method. 2076is a bitset as described in the C<events> method.
1890 2077
1891=item $iow = $iow->fd ($fd) 2078=item $iow = $iow->fd ($fd)
1892 2079
1893Set the filedescriptor (not handle) to watch. 2080Set the file descriptor (not handle) to watch.
1894 2081
1895=item $iow = $iow->events ($eventmask) 2082=item $iow = $iow->events ($eventmask)
1896 2083
1897Set the event mask to watch. The only allowed values are 2084Set the event mask to watch. The only allowed values are
1898C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2085C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1902 2089
1903Start watching for requested events on the given handle. 2090Start watching for requested events on the given handle.
1904 2091
1905=item $iow = $iow->stop 2092=item $iow = $iow->stop
1906 2093
1907Stop watching for events on the given filehandle. 2094Stop watching for events on the given file handle.
1908 2095
1909=back 2096=back
1910 2097
1911=head2 The C<urxvt::iw> Class 2098=head2 The C<urxvt::iw> Class
1912 2099
1959 2146
1960Set the callback to be called when the timer triggers. 2147Set the callback to be called when the timer triggers.
1961 2148
1962=item $pw = $timer->start ($pid) 2149=item $pw = $timer->start ($pid)
1963 2150
1964Tells the wqtcher to start watching for process C<$pid>. 2151Tells the watcher to start watching for process C<$pid>.
1965 2152
1966=item $pw = $pw->stop 2153=item $pw = $pw->stop
1967 2154
1968Stop the watcher. 2155Stop the watcher.
1969 2156
1982 2169
1983=item >= 3 - script loading and management 2170=item >= 3 - script loading and management
1984 2171
1985=item >=10 - all called hooks 2172=item >=10 - all called hooks
1986 2173
1987=item >=11 - hook reutrn values 2174=item >=11 - hook return values
1988 2175
1989=back 2176=back
1990 2177
1991=head1 AUTHOR 2178=head1 AUTHOR
1992 2179
1994 http://software.schmorp.de/pkg/rxvt-unicode 2181 http://software.schmorp.de/pkg/rxvt-unicode
1995 2182
1996=cut 2183=cut
1997 2184
19981 21851
2186
2187# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines