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.132 by root, Mon Feb 6 05:40:15 2006 UTC vs.
Revision 1.161 by ayin, Fri Nov 30 01:22:26 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 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
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
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
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 129Its 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
116the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
117C<a>s: 137C<a>s:
118 138
119 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
120 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
121 : () 141 : ()
122 }; 142 };
123 143
124=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
125 145
132search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
133search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
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 if the C<Shift> modifier is active.
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.
138 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 (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:
148 174
149=over 4 175=over 4
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,
217 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
218 244
219See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid 245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
220indices. 246indices.
221 247
222=item mark-urls 248=item matcher
223 249
224Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
225make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
226resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
227the 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
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
228 276
229=item xim-onthespot 277=item xim-onthespot
230 278
231This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
232not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
233OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
234kinput2. 282kinput2.
235 283
236You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
237C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
238 286
239 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
240 288
241=item automove-background 289=item kuake<hotkey>
242 290
243This is basically a one-line extension that dynamically changes the background pixmap offset 291A very primitive quake-console-like extension. It was inspired by a
244to the window position, in effect creating the same effect as pseudo transparency with 292description of how the programs C<kuake> and C<yakuake> work: Whenever the
245a custom pixmap. No scaling is supported in this mode. Exmaple: 293user presses a global accelerator key (by default C<F10>), the terminal
294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
246 296
247 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 297Initially, the window will not be shown when using this extension.
298
299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key.
301
302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function.
304
305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it).
248 307
249=item block-graphics-to-ascii 308=item block-graphics-to-ascii
250 309
251A not very useful example of filtering all text output to the terminal, 310A not very useful example of filtering all text output to the terminal
252by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
253similar-looking ascii character. 312similar-looking ascii character.
254 313
255=item digital-clock 314=item digital-clock
256 315
257Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
258 317
259=item remote-clipboard 318=item remote-clipboard
260 319
261Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
262selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
263selection somewhere and fetch it again. 322selection somewhere and fetch it again.
264 323
265We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
266means that one command uploads the file to a remote server, and another 325means that one command uploads the file to a remote server, and another
267reads it. 326reads it.
302After a successful upload the selection will be replaced by the text given 361After a successful upload the selection will be replaced by the text given
303in the C<selection-pastebin-url> resource (again, the % is the placeholder 362in the C<selection-pastebin-url> resource (again, the % is the placeholder
304for the filename): 363for the filename):
305 364
306 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 365 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366
367I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368the double C</> characters as comment start. Use C<\057\057> instead,
369which works regardless of wether xrdb is used to parse the resource file
370or not.
307 371
308=item example-refresh-hooks 372=item example-refresh-hooks
309 373
310Displays a very simple digital clock in the upper right corner of the 374Displays a very simple digital clock in the upper right corner of the
311window. Illustrates overwriting the refresh callbacks to create your own 375window. Illustrates overwriting the refresh callbacks to create your own
351 415
352=back 416=back
353 417
354=head2 Extension Objects 418=head2 Extension Objects
355 419
356Very perl extension is a perl class. A separate perl object is created 420Every perl extension is a perl class. A separate perl object is created
357for each terminal and each extension and passed as the first parameter to 421for each terminal, and each terminal has its own set of extenion objects,
358hooks. So extensions can use their C<$self> object without having to think 422which are passed as the first parameter to hooks. So extensions can use
359about other extensions, with the exception of methods and members that 423their C<$self> object without having to think about clashes with other
424extensions or other terminals, with the exception of methods and members
360begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
361use. 426internal use.
362 427
363Although it isn't a C<urxvt::term> object, you can call all methods of the 428Although it isn't a C<urxvt::term> object, you can call all methods of the
364C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
365 430
366It has the following methods and data members: 431It has the following methods and data members:
387=head2 Hooks 452=head2 Hooks
388 453
389The following subroutines can be declared in extension files, and will be 454The following subroutines can be declared in extension files, and will be
390called whenever the relevant event happens. 455called whenever the relevant event happens.
391 456
392The first argument passed to them is an extension oject as described in 457The first argument passed to them is an extension object as described in
393the in the C<Extension Objects> section. 458the in the C<Extension Objects> section.
394 459
395B<All> of these hooks must return a boolean value. If any of the called 460B<All> of these hooks must return a boolean value. If any of the called
396hooks returns true, then the event counts as being I<consumed>, and the 461hooks returns true, then the event counts as being I<consumed>, and the
397relevant action might not be carried out by the C++ code. 462relevant action might not be carried out by the C++ code.
410place. 475place.
411 476
412=item on_start $term 477=item on_start $term
413 478
414Called at the very end of initialisation of a new terminal, just before 479Called at the very end of initialisation of a new terminal, just before
415trying to map (display) the toplevel and returning to the mainloop. 480trying to map (display) the toplevel and returning to the main loop.
416 481
417=item on_destroy $term 482=item on_destroy $term
418 483
419Called whenever something tries to destroy terminal, when the terminal is 484Called whenever something tries to destroy terminal, when the terminal is
420still fully functional (not for long, though). 485still fully functional (not for long, though).
447 512
448Called whenever a selection has been copied, but before the selection is 513Called whenever a selection has been copied, but before the selection is
449requested from the server. The selection text can be queried and changed 514requested from the server. The selection text can be queried and changed
450by calling C<< $term->selection >>. 515by calling C<< $term->selection >>.
451 516
452Returning a true value aborts selection grabbing. It will still be hilighted. 517Returning a true value aborts selection grabbing. It will still be highlighted.
453 518
454=item on_sel_extend $term 519=item on_sel_extend $term
455 520
456Called whenever the user tries to extend the selection (e.g. with a double 521Called whenever the user tries to extend the selection (e.g. with a double
457click) and is either supposed to return false (normal operation), or 522click) and is either supposed to return false (normal operation), or
458should extend the selection itelf and return true to suppress the built-in 523should extend the selection itself and return true to suppress the built-in
459processing. This can happen multiple times, as long as the callback 524processing. This can happen multiple times, as long as the callback
460returns true, it will be called on every further click by the user and is 525returns true, it will be called on every further click by the user and is
461supposed to enlarge the selection more and more, if possible. 526supposed to enlarge the selection more and more, if possible.
462 527
463See the F<selection> example extension. 528See the F<selection> example extension.
464 529
465=item on_view_change $term, $offset 530=item on_view_change $term, $offset
466 531
467Called whenever the view offset changes, i..e the user or program 532Called whenever the view offset changes, i.e. the user or program
468scrolls. Offset C<0> means display the normal terminal, positive values 533scrolls. Offset C<0> means display the normal terminal, positive values
469show this many lines of scrollback. 534show this many lines of scrollback.
470 535
471=item on_scroll_back $term, $lines, $saved 536=item on_scroll_back $term, $lines, $saved
472 537
476 541
477It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
478$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
479number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
480 545
546=item on_osc_seq $term, $op, $args
547
548Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within
552this callback.
553
554C<on_osc_seq_perl> should be used for new behaviour.
555
481=item on_osc_seq $term, $string 556=item on_osc_seq_perl $term, $string
482 557
483Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
484operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
485information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
486string should start with the extension name and a colon, to distinguish 561string should start with the extension name and a colon, to distinguish
487it from commands for other extensions, and this might be enforced in the 562it from commands for other extensions, and this might be enforced in the
488future. 563future.
489 564
490Be careful not ever to trust (in a security sense) the data you receive, 565Be careful not ever to trust (in a security sense) the data you receive,
491as its source can not easily be controleld (e-mail content, messages from 566as its source can not easily be controlled (e-mail content, messages from
492other users on the same system etc.). 567other users on the same system etc.).
493 568
494=item on_add_lines $term, $string 569=item on_add_lines $term, $string
495 570
496Called whenever text is about to be output, with the text as argument. You 571Called whenever text is about to be output, with the text as argument. You
529 604
530Called just after the screen gets redrawn. See C<on_refresh_begin>. 605Called just after the screen gets redrawn. See C<on_refresh_begin>.
531 606
532=item on_user_command $term, $string 607=item on_user_command $term, $string
533 608
534Called whenever the a user-configured event is being activated (e.g. via 609Called whenever a user-configured event is being activated (e.g. via
535a C<perl:string> action bound to a key, see description of the B<keysym> 610a C<perl:string> action bound to a key, see description of the B<keysym>
536resource in the @@RXVT_NAME@@(1) manpage). 611resource in the @@RXVT_NAME@@(1) manpage).
537 612
538The event is simply the action string. This interface is assumed to change 613The event is simply the action string. This interface is assumed to change
539slightly in the future. 614slightly in the future.
615
616=item on_resize_all_windows $tern, $new_width, $new_height
617
618Called just after the new window size has been calculated, but before
619windows are actually being resized or hints are being set. If this hook
620returns TRUE, setting of the window hints is being skipped.
540 621
541=item on_x_event $term, $event 622=item on_x_event $term, $event
542 623
543Called on every X event received on the vt window (and possibly other 624Called on every X event received on the vt window (and possibly other
544windows). Should only be used as a last resort. Most event structure 625windows). Should only be used as a last resort. Most event structure
545members are not passed. 626members are not passed.
546 627
628=item on_root_event $term, $event
629
630Like C<on_x_event>, but is called for events on the root window.
631
547=item on_focus_in $term 632=item on_focus_in $term
548 633
549Called whenever the window gets the keyboard focus, before rxvt-unicode 634Called whenever the window gets the keyboard focus, before rxvt-unicode
550does focus in processing. 635does focus in processing.
551 636
552=item on_focus_out $term 637=item on_focus_out $term
553 638
554Called wheneever the window loses keyboard focus, before rxvt-unicode does 639Called whenever the window loses keyboard focus, before rxvt-unicode does
555focus out processing. 640focus out processing.
556 641
557=item on_configure_notify $term, $event 642=item on_configure_notify $term, $event
558 643
559=item on_property_notify $term, $event 644=item on_property_notify $term, $event
642The current terminal. This variable stores the current C<urxvt::term> 727The current terminal. This variable stores the current C<urxvt::term>
643object, whenever a callback/hook is executing. 728object, whenever a callback/hook is executing.
644 729
645=item @urxvt::TERM_INIT 730=item @urxvt::TERM_INIT
646 731
647All coderefs in this array will be called as methods of the next newly 732All code references in this array will be called as methods of the next newly
648created C<urxvt::term> object (during the C<on_init> phase). The array 733created C<urxvt::term> object (during the C<on_init> phase). The array
649gets cleared before the codereferences that were in it are being executed, 734gets cleared before the code references that were in it are being executed,
650so coderefs can push themselves onto it again if they so desire. 735so references can push themselves onto it again if they so desire.
651 736
652This complements to the perl-eval commandline option, but gets executed 737This complements to the perl-eval command line option, but gets executed
653first. 738first.
654 739
655=item @urxvt::TERM_EXT 740=item @urxvt::TERM_EXT
656 741
657Works similar to C<@TERM_INIT>, but contains perl package/class names, which 742Works similar to C<@TERM_INIT>, but contains perl package/class names, which
682Messages have a size limit of 1023 bytes currently. 767Messages have a size limit of 1023 bytes currently.
683 768
684=item @terms = urxvt::termlist 769=item @terms = urxvt::termlist
685 770
686Returns all urxvt::term objects that exist in this process, regardless of 771Returns all urxvt::term objects that exist in this process, regardless of
687wether they are started, being destroyed etc., so be careful. Only term 772whether they are started, being destroyed etc., so be careful. Only term
688objects that have perl extensions attached will be returned (because there 773objects that have perl extensions attached will be returned (because there
689is no urxvt::term objet associated with others). 774is no urxvt::term objet associated with others).
690 775
691=item $time = urxvt::NOW 776=item $time = urxvt::NOW
692 777
830 local $TERM = shift; 915 local $TERM = shift;
831 my $htype = shift; 916 my $htype = shift;
832 917
833 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
834 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
835 920
836 my %ext_arg; 921 my %ext_arg;
837 922
838 { 923 {
839 my @init = @TERM_INIT; 924 my @init = @TERM_INIT;
840 @TERM_INIT = (); 925 @TERM_INIT = ();
854 } else { 939 } else {
855 $ext_arg{$_} ||= []; 940 $ext_arg{$_} ||= [];
856 } 941 }
857 } 942 }
858 943
859 while (my ($ext, $argv) = each %ext_arg) { 944 for my $ext (sort keys %ext_arg) {
860 my @files = grep -f $_, map "$_/$ext", @dirs; 945 my @files = grep -f $_, map "$_/$ext", @dirs;
861 946
862 if (@files) { 947 if (@files) {
863 $TERM->register_package (extension_package $files[0], $argv); 948 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
864 } else { 949 } else {
865 warn "perl extension '$ext' not found in perl library search path\n"; 950 warn "perl extension '$ext' not found in perl library search path\n";
866 } 951 }
867 } 952 }
868 953
874 959
875 if (my $cb = $TERM->{_hook}[$htype]) { 960 if (my $cb = $TERM->{_hook}[$htype]) {
876 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 961 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
877 if $verbosity >= 10; 962 if $verbosity >= 10;
878 963
879 keys %$cb; 964 for my $pkg (keys %$cb) {
880
881 while (my ($pkg, $cb) = each %$cb) {
882 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 965 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
883 $retval ||= $retval_; 966 $retval ||= $retval_;
884 967
885 if ($@) { 968 if ($@) {
886 $TERM->ungrab; # better to lose the grab than the session 969 $TERM->ungrab; # better to lose the grab than the session
887 warn $@; 970 warn $@;
903 $retval 986 $retval
904} 987}
905 988
906sub SET_COLOR($$$) { 989sub SET_COLOR($$$) {
907 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 990 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
991}
992
993sub rend2mask {
994 no strict 'refs';
995 my ($str, $mask) = (@_, 0);
996 my %color = ( fg => undef, bg => undef );
997 my @failed;
998 for my $spec ( split /\s+/, $str ) {
999 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1000 $color{lc($1)} = $2;
1001 } else {
1002 my $neg = $spec =~ s/^[-^]//;
1003 unless ( exists &{"RS_$spec"} ) {
1004 push @failed, $spec;
1005 next;
1006 }
1007 my $cur = &{"RS_$spec"};
1008 if ( $neg ) {
1009 $mask &= ~$cur;
1010 } else {
1011 $mask |= $cur;
1012 }
1013 }
1014 }
1015 ($mask, @color{qw(fg bg)}, \@failed)
908} 1016}
909 1017
910# urxvt::term::extension 1018# urxvt::term::extension
911 1019
912package urxvt::term::extension; 1020package urxvt::term::extension;
1025sub DESTROY { 1133sub DESTROY {
1026 $_[0][1]->stop; 1134 $_[0][1]->stop;
1027} 1135}
1028 1136
1029sub condvar { 1137sub condvar {
1030 bless \my $flag, urxvt::anyevent::condvar:: 1138 bless \my $flag, urxvt::anyevent::
1031} 1139}
1032 1140
1033sub urxvt::anyevent::condvar::broadcast { 1141sub broadcast {
1034 ${$_[0]}++; 1142 ${$_[0]}++;
1035} 1143}
1036 1144
1037sub urxvt::anyevent::condvar::wait { 1145sub wait {
1038 unless (${$_[0]}) { 1146 unless (${$_[0]}) {
1039 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1147 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1040 } 1148 }
1149}
1150
1151sub one_event {
1152 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1041} 1153}
1042 1154
1043package urxvt::term; 1155package urxvt::term;
1044 1156
1045=head2 The C<urxvt::term> Class 1157=head2 The C<urxvt::term> Class
1132 1244
1133Returns true if the option specified by C<$optval> is enabled, and 1245Returns true if the option specified by C<$optval> is enabled, and
1134optionally change it. All option values are stored by name in the hash 1246optionally change it. All option values are stored by name in the hash
1135C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1247C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1136 1248
1137Here is a a likely non-exhaustive list of option names, please see the 1249Here is a likely non-exhaustive list of option names, please see the
1138source file F</src/optinc.h> to see the actual list: 1250source file F</src/optinc.h> to see the actual list:
1139 1251
1140 borderLess console cursorBlink cursorUnderline hold iconic insecure 1252 borderLess console cursorBlink cursorUnderline hold iconic insecure
1141 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1253 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1142 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1254 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1159likely change). 1271likely change).
1160 1272
1161Please note that resource strings will currently only be freed when the 1273Please note that resource strings will currently only be freed when the
1162terminal is destroyed, so changing options frequently will eat memory. 1274terminal is destroyed, so changing options frequently will eat memory.
1163 1275
1164Here is a a likely non-exhaustive list of resource names, not all of which 1276Here is a likely non-exhaustive list of resource names, not all of which
1165are supported in every build, please see the source file F</src/rsinc.h> 1277are supported in every build, please see the source file F</src/rsinc.h>
1166to see the actual list: 1278to see the actual list:
1167 1279
1168 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1280 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1169 borderLess color cursorBlink cursorUnderline cutchars delete_key 1281 borderLess color cursorBlink cursorUnderline cutchars delete_key
1451=item $env = $term->env 1563=item $env = $term->env
1452 1564
1453Returns a copy of the environment in effect for the terminal as a hashref 1565Returns a copy of the environment in effect for the terminal as a hashref
1454similar to C<\%ENV>. 1566similar to C<\%ENV>.
1455 1567
1568=item @envv = $term->envv
1569
1570Returns the environment as array of strings of the form C<VAR=VALUE>.
1571
1572=item @argv = $term->argv
1573
1574Return the argument vector as this terminal, similar to @ARGV, but
1575includes the program name as first element.
1576
1456=cut 1577=cut
1457 1578
1458sub env { 1579sub env {
1459 if (my $env = $_[0]->_env) {
1460 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1580 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1461 } else {
1462 +{ %ENV }
1463 }
1464} 1581}
1465 1582
1466=item $modifiermask = $term->ModLevel3Mask 1583=item $modifiermask = $term->ModLevel3Mask
1467 1584
1468=item $modifiermask = $term->ModMetaMask 1585=item $modifiermask = $term->ModMetaMask
1476 1593
1477Returns the currently displayed screen (0 primary, 1 secondary). 1594Returns the currently displayed screen (0 primary, 1 secondary).
1478 1595
1479=item $cursor_is_hidden = $term->hidden_cursor 1596=item $cursor_is_hidden = $term->hidden_cursor
1480 1597
1481Returns wether the cursor is currently hidden or not. 1598Returns whether the cursor is currently hidden or not.
1482 1599
1483=item $view_start = $term->view_start ([$newvalue]) 1600=item $view_start = $term->view_start ([$newvalue])
1484 1601
1485Returns the row number of the topmost displayed line. Maximum value is 1602Returns the row number of the topmost displayed line. Maximum value is
1486C<0>, which displays the normal terminal contents. Lower values scroll 1603C<0>, which displays the normal terminal contents. Lower values scroll
1663where one character corresponds to one screen cell. See 1780where one character corresponds to one screen cell. See
1664C<< $term->ROW_t >> for details. 1781C<< $term->ROW_t >> for details.
1665 1782
1666=item $string = $term->special_decode $text 1783=item $string = $term->special_decode $text
1667 1784
1668Converts rxvt-unicodes text reprsentation into a perl string. See 1785Converts rxvt-unicodes text representation into a perl string. See
1669C<< $term->ROW_t >> for details. 1786C<< $term->ROW_t >> for details.
1670 1787
1671=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1788=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1672 1789
1673=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1790=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1676manpage. 1793manpage.
1677 1794
1678=item $success = $term->grab ($eventtime[, $sync]) 1795=item $success = $term->grab ($eventtime[, $sync])
1679 1796
1680Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1797Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1681synchronous (C<$sync> is true). Also remembers the grab timestampe. 1798synchronous (C<$sync> is true). Also remembers the grab timestamp.
1682 1799
1683=item $term->allow_events_async 1800=item $term->allow_events_async
1684 1801
1685Calls XAllowEvents with AsyncBoth for the most recent grab. 1802Calls XAllowEvents with AsyncBoth for the most recent grab.
1686 1803
1799 my ($self, $text, $cb) = @_; 1916 my ($self, $text, $cb) = @_;
1800 1917
1801 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1918 $self->add_item ({ type => "button", text => $text, activate => $cb});
1802} 1919}
1803 1920
1804=item $popup->add_toggle ($text, $cb, $initial_value) 1921=item $popup->add_toggle ($text, $initial_value, $cb)
1805 1922
1806Adds a toggle/checkbox item to the popup. Teh callback gets called 1923Adds a toggle/checkbox item to the popup. The callback gets called
1807whenever it gets toggled, with a boolean indicating its value as its first 1924whenever it gets toggled, with a boolean indicating its new value as its
1808argument. 1925first argument.
1809 1926
1810=cut 1927=cut
1811 1928
1812sub add_toggle { 1929sub add_toggle {
1813 my ($self, $text, $cb, $value) = @_; 1930 my ($self, $text, $value, $cb) = @_;
1814 1931
1815 my $item; $item = { 1932 my $item; $item = {
1816 type => "button", 1933 type => "button",
1817 text => " $text", 1934 text => " $text",
1818 value => $value, 1935 value => $value,
1860 1977
1861=cut 1978=cut
1862 1979
1863package urxvt::watcher; 1980package urxvt::watcher;
1864 1981
1865@urxvt::timer::ISA = __PACKAGE__;
1866@urxvt::iow::ISA = __PACKAGE__;
1867@urxvt::pw::ISA = __PACKAGE__;
1868@urxvt::iw::ISA = __PACKAGE__;
1869
1870=head2 The C<urxvt::timer> Class 1982=head2 The C<urxvt::timer> Class
1871 1983
1872This class implements timer watchers/events. Time is represented as a 1984This class implements timer watchers/events. Time is represented as a
1873fractional number of seconds since the epoch. Example: 1985fractional number of seconds since the epoch. Example:
1874 1986
1877 ->new 1989 ->new
1878 ->interval (1) 1990 ->interval (1)
1879 ->cb (sub { 1991 ->cb (sub {
1880 $term->{overlay}->set (0, 0, 1992 $term->{overlay}->set (0, 0,
1881 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1993 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1882 }); 1994 });
1883 1995
1884=over 4 1996=over 4
1885 1997
1886=item $timer = new urxvt::timer 1998=item $timer = new urxvt::timer
1887 1999
1930 2042
1931 $term->{socket} = ... 2043 $term->{socket} = ...
1932 $term->{iow} = urxvt::iow 2044 $term->{iow} = urxvt::iow
1933 ->new 2045 ->new
1934 ->fd (fileno $term->{socket}) 2046 ->fd (fileno $term->{socket})
1935 ->events (urxvt::EVENT_READ) 2047 ->events (urxvt::EV_READ)
1936 ->start 2048 ->start
1937 ->cb (sub { 2049 ->cb (sub {
1938 my ($iow, $revents) = @_; 2050 my ($iow, $revents) = @_;
1939 # $revents must be 1 here, no need to check 2051 # $revents must be 1 here, no need to check
1940 sysread $term->{socket}, my $buf, 8192 2052 sysread $term->{socket}, my $buf, 8192
1953Set the callback to be called when io events are triggered. C<$reventmask> 2065Set the callback to be called when io events are triggered. C<$reventmask>
1954is a bitset as described in the C<events> method. 2066is a bitset as described in the C<events> method.
1955 2067
1956=item $iow = $iow->fd ($fd) 2068=item $iow = $iow->fd ($fd)
1957 2069
1958Set the filedescriptor (not handle) to watch. 2070Set the file descriptor (not handle) to watch.
1959 2071
1960=item $iow = $iow->events ($eventmask) 2072=item $iow = $iow->events ($eventmask)
1961 2073
1962Set the event mask to watch. The only allowed values are 2074Set the event mask to watch. The only allowed values are
1963C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2075C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1964together, or C<urxvt::EVENT_NONE>. 2076together, or C<urxvt::EV_NONE>.
1965 2077
1966=item $iow = $iow->start 2078=item $iow = $iow->start
1967 2079
1968Start watching for requested events on the given handle. 2080Start watching for requested events on the given handle.
1969 2081
1970=item $iow = $iow->stop 2082=item $iow = $iow->stop
1971 2083
1972Stop watching for events on the given filehandle. 2084Stop watching for events on the given file handle.
1973 2085
1974=back 2086=back
1975 2087
1976=head2 The C<urxvt::iw> Class 2088=head2 The C<urxvt::iw> Class
1977 2089
2010 ->new 2122 ->new
2011 ->start ($pid) 2123 ->start ($pid)
2012 ->cb (sub { 2124 ->cb (sub {
2013 my ($pw, $exit_status) = @_; 2125 my ($pw, $exit_status) = @_;
2014 ... 2126 ...
2015 }); 2127 });
2016 2128
2017=over 4 2129=over 4
2018 2130
2019=item $pw = new urxvt::pw 2131=item $pw = new urxvt::pw
2020 2132
2024 2136
2025Set the callback to be called when the timer triggers. 2137Set the callback to be called when the timer triggers.
2026 2138
2027=item $pw = $timer->start ($pid) 2139=item $pw = $timer->start ($pid)
2028 2140
2029Tells the wqtcher to start watching for process C<$pid>. 2141Tells the watcher to start watching for process C<$pid>.
2030 2142
2031=item $pw = $pw->stop 2143=item $pw = $pw->stop
2032 2144
2033Stop the watcher. 2145Stop the watcher.
2034 2146
2047 2159
2048=item >= 3 - script loading and management 2160=item >= 3 - script loading and management
2049 2161
2050=item >=10 - all called hooks 2162=item >=10 - all called hooks
2051 2163
2052=item >=11 - hook reutrn values 2164=item >=11 - hook return values
2053 2165
2054=back 2166=back
2055 2167
2056=head1 AUTHOR 2168=head1 AUTHOR
2057 2169
2059 http://software.schmorp.de/pkg/rxvt-unicode 2171 http://software.schmorp.de/pkg/rxvt-unicode
2060 2172
2061=cut 2173=cut
2062 2174
20631 21751
2176
2177# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines