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.141 by root, Mon Jul 3 19:11:41 2006 UTC vs.
Revision 1.168 by root, Sun Jun 15 14:07:58 2008 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
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide wether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 157selection if the C<Shift> modifier is active.
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.
155 164
156=item readline (enabled by default) 165=item readline (enabled by default)
157 166
158A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
159the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
160move 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
161cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
162for programs that correctly support wide characters). 171for programs that correctly support wide characters).
163 172
164To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
165 174
166=over 4 175=over 4
214the message into vi commands to load the file. 223the message into vi commands to load the file.
215 224
216=item tabbed 225=item tabbed
217 226
218This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
219is, 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
220displays 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
221button per tab. 230button per tab.
222 231
223Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
224B<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,
234 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
235 244
236See 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
237indices. 246indices.
238 247
239=item mark-urls 248=item matcher
240 249
241Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
242make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
243resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
244the 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
245 276
246=item xim-onthespot 277=item xim-onthespot
247 278
248This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
249not 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
250OnTheSpot 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
251kinput2. 282kinput2.
252 283
253You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
254C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
255 286
256 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257 288
258=item automove-background 289=item kuake<hotkey>
259 290
260This is basically a very small extension that dynamically changes the 291A very primitive quake-console-like extension. It was inspired by a
261background pixmap offset to the window position, in effect creating the 292description of how the programs C<kuake> and C<yakuake> work: Whenever the
262same effect as pseudo transparency with a custom pixmap. No scaling is 293user presses a global accelerator key (by default C<F10>), the terminal
263supported in this mode. Exmaple: 294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
264 296
265 @@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).
266 307
267=item block-graphics-to-ascii 308=item block-graphics-to-ascii
268 309
269A 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
270by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
275Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
276 317
277=item remote-clipboard 318=item remote-clipboard
278 319
279Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
280selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
281selection somewhere and fetch it again. 322selection somewhere and fetch it again.
282 323
283We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
284means 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
285reads it. 326reads it.
320After 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
321in the C<selection-pastebin-url> resource (again, the % is the placeholder 362in the C<selection-pastebin-url> resource (again, the % is the placeholder
322for the filename): 363for the filename):
323 364
324 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.
325 371
326=item example-refresh-hooks 372=item example-refresh-hooks
327 373
328Displays 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
329window. Illustrates overwriting the refresh callbacks to create your own 375window. Illustrates overwriting the refresh callbacks to create your own
370=back 416=back
371 417
372=head2 Extension Objects 418=head2 Extension Objects
373 419
374Every 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
375for 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,
376hooks. 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
377about 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
378begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
379use. 426internal use.
380 427
381Although 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
382C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
383 430
384It has the following methods and data members: 431It has the following methods and data members:
405=head2 Hooks 452=head2 Hooks
406 453
407The following subroutines can be declared in extension files, and will be 454The following subroutines can be declared in extension files, and will be
408called whenever the relevant event happens. 455called whenever the relevant event happens.
409 456
410The 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
411the in the C<Extension Objects> section. 458the in the C<Extension Objects> section.
412 459
413B<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
414hooks 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
415relevant action might not be carried out by the C++ code. 462relevant action might not be carried out by the C++ code.
428place. 475place.
429 476
430=item on_start $term 477=item on_start $term
431 478
432Called 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
433trying to map (display) the toplevel and returning to the mainloop. 480trying to map (display) the toplevel and returning to the main loop.
434 481
435=item on_destroy $term 482=item on_destroy $term
436 483
437Called whenever something tries to destroy terminal, when the terminal is 484Called whenever something tries to destroy terminal, when the terminal is
438still fully functional (not for long, though). 485still fully functional (not for long, though).
465 512
466Called whenever a selection has been copied, but before the selection is 513Called whenever a selection has been copied, but before the selection is
467requested from the server. The selection text can be queried and changed 514requested from the server. The selection text can be queried and changed
468by calling C<< $term->selection >>. 515by calling C<< $term->selection >>.
469 516
470Returning a true value aborts selection grabbing. It will still be hilighted. 517Returning a true value aborts selection grabbing. It will still be highlighted.
471 518
472=item on_sel_extend $term 519=item on_sel_extend $term
473 520
474Called 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
475click) and is either supposed to return false (normal operation), or 522click) and is either supposed to return false (normal operation), or
476should 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
477processing. This can happen multiple times, as long as the callback 524processing. This can happen multiple times, as long as the callback
478returns 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
479supposed to enlarge the selection more and more, if possible. 526supposed to enlarge the selection more and more, if possible.
480 527
481See the F<selection> example extension. 528See the F<selection> example extension.
482 529
483=item on_view_change $term, $offset 530=item on_view_change $term, $offset
484 531
485Called whenever the view offset changes, i..e the user or program 532Called whenever the view offset changes, i.e. the user or program
486scrolls. Offset C<0> means display the normal terminal, positive values 533scrolls. Offset C<0> means display the normal terminal, positive values
487show this many lines of scrollback. 534show this many lines of scrollback.
488 535
489=item on_scroll_back $term, $lines, $saved 536=item on_scroll_back $term, $lines, $saved
490 537
514string should start with the extension name and a colon, to distinguish 561string should start with the extension name and a colon, to distinguish
515it 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
516future. 563future.
517 564
518Be 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,
519as 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
520other users on the same system etc.). 567other users on the same system etc.).
521 568
522=item on_add_lines $term, $string 569=item on_add_lines $term, $string
523 570
524Called 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
557 604
558Called just after the screen gets redrawn. See C<on_refresh_begin>. 605Called just after the screen gets redrawn. See C<on_refresh_begin>.
559 606
560=item on_user_command $term, $string 607=item on_user_command $term, $string
561 608
562Called whenever the a user-configured event is being activated (e.g. via 609Called whenever a user-configured event is being activated (e.g. via
563a 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>
564resource in the @@RXVT_NAME@@(1) manpage). 611resource in the @@RXVT_NAME@@(1) manpage).
565 612
566The 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
567slightly in the future. 614slightly in the future.
568 615
569=item on_resize_all_windows $tern, $new_width, $new_height 616=item on_resize_all_windows $tern, $new_width, $new_height
570 617
571Called just after the new window size has been calculcated, but before 618Called just after the new window size has been calculated, but before
572windows are actually being resized or hints are being set. If this hook 619windows are actually being resized or hints are being set. If this hook
573returns TRUE, setting of the window hints is being skipped. 620returns TRUE, setting of the window hints is being skipped.
574 621
575=item on_x_event $term, $event 622=item on_x_event $term, $event
576 623
577Called 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
578windows). Should only be used as a last resort. Most event structure 625windows). Should only be used as a last resort. Most event structure
579members are not passed. 626members are not passed.
580 627
628=item on_root_event $term, $event
629
630Like C<on_x_event>, but is called for events on the root window.
631
581=item on_focus_in $term 632=item on_focus_in $term
582 633
583Called whenever the window gets the keyboard focus, before rxvt-unicode 634Called whenever the window gets the keyboard focus, before rxvt-unicode
584does focus in processing. 635does focus in processing.
585 636
586=item on_focus_out $term 637=item on_focus_out $term
587 638
588Called wheneever the window loses keyboard focus, before rxvt-unicode does 639Called whenever the window loses keyboard focus, before rxvt-unicode does
589focus out processing. 640focus out processing.
590 641
591=item on_configure_notify $term, $event 642=item on_configure_notify $term, $event
592 643
593=item on_property_notify $term, $event 644=item on_property_notify $term, $event
676The current terminal. This variable stores the current C<urxvt::term> 727The current terminal. This variable stores the current C<urxvt::term>
677object, whenever a callback/hook is executing. 728object, whenever a callback/hook is executing.
678 729
679=item @urxvt::TERM_INIT 730=item @urxvt::TERM_INIT
680 731
681All 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
682created 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
683gets cleared before the codereferences that were in it are being executed, 734gets cleared before the code references that were in it are being executed,
684so coderefs can push themselves onto it again if they so desire. 735so references can push themselves onto it again if they so desire.
685 736
686This complements to the perl-eval commandline option, but gets executed 737This complements to the perl-eval command line option, but gets executed
687first. 738first.
688 739
689=item @urxvt::TERM_EXT 740=item @urxvt::TERM_EXT
690 741
691Works 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
716Messages have a size limit of 1023 bytes currently. 767Messages have a size limit of 1023 bytes currently.
717 768
718=item @terms = urxvt::termlist 769=item @terms = urxvt::termlist
719 770
720Returns all urxvt::term objects that exist in this process, regardless of 771Returns all urxvt::term objects that exist in this process, regardless of
721wether they are started, being destroyed etc., so be careful. Only term 772whether they are started, being destroyed etc., so be careful. Only term
722objects that have perl extensions attached will be returned (because there 773objects that have perl extensions attached will be returned (because there
723is no urxvt::term objet associated with others). 774is no urxvt::term objet associated with others).
724 775
725=item $time = urxvt::NOW 776=item $time = urxvt::NOW
726 777
864 local $TERM = shift; 915 local $TERM = shift;
865 my $htype = shift; 916 my $htype = shift;
866 917
867 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
868 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
869 920
870 my %ext_arg; 921 my %ext_arg;
871 922
872 { 923 {
873 my @init = @TERM_INIT; 924 my @init = @TERM_INIT;
874 @TERM_INIT = (); 925 @TERM_INIT = ();
937 988
938sub SET_COLOR($$$) { 989sub SET_COLOR($$$) {
939 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 990 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
940} 991}
941 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)
1016}
1017
942# urxvt::term::extension 1018# urxvt::term::extension
943 1019
944package urxvt::term::extension; 1020package urxvt::term::extension;
945 1021
946sub enable { 1022sub enable {
1015is that you cannot use blocking APIs, but the non-blocking variant should 1091is that you cannot use blocking APIs, but the non-blocking variant should
1016work. 1092work.
1017 1093
1018=cut 1094=cut
1019 1095
1020our $VERSION = 1; 1096our $VERSION = '3.4';
1021 1097
1022$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1023push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1024 1100
1025sub timer { 1101sub timer {
1056 1132
1057sub DESTROY { 1133sub DESTROY {
1058 $_[0][1]->stop; 1134 $_[0][1]->stop;
1059} 1135}
1060 1136
1061sub condvar { 1137sub one_event {
1062 bless \my $flag, urxvt::anyevent::condvar::
1063}
1064
1065sub urxvt::anyevent::condvar::broadcast {
1066 ${$_[0]}++;
1067}
1068
1069sub urxvt::anyevent::condvar::wait {
1070 unless (${$_[0]}) {
1071 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1138 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1072 }
1073} 1139}
1074 1140
1075package urxvt::term; 1141package urxvt::term;
1076 1142
1077=head2 The C<urxvt::term> Class 1143=head2 The C<urxvt::term> Class
1164 1230
1165Returns true if the option specified by C<$optval> is enabled, and 1231Returns true if the option specified by C<$optval> is enabled, and
1166optionally change it. All option values are stored by name in the hash 1232optionally change it. All option values are stored by name in the hash
1167C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1233C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1168 1234
1169Here is a a likely non-exhaustive list of option names, please see the 1235Here is a likely non-exhaustive list of option names, please see the
1170source file F</src/optinc.h> to see the actual list: 1236source file F</src/optinc.h> to see the actual list:
1171 1237
1172 borderLess console cursorBlink cursorUnderline hold iconic insecure 1238 borderLess console cursorBlink cursorUnderline hold iconic insecure
1173 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1239 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1174 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1240 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1191likely change). 1257likely change).
1192 1258
1193Please note that resource strings will currently only be freed when the 1259Please note that resource strings will currently only be freed when the
1194terminal is destroyed, so changing options frequently will eat memory. 1260terminal is destroyed, so changing options frequently will eat memory.
1195 1261
1196Here is a a likely non-exhaustive list of resource names, not all of which 1262Here is a likely non-exhaustive list of resource names, not all of which
1197are supported in every build, please see the source file F</src/rsinc.h> 1263are supported in every build, please see the source file F</src/rsinc.h>
1198to see the actual list: 1264to see the actual list:
1199 1265
1200 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1266 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1201 borderLess color cursorBlink cursorUnderline cutchars delete_key 1267 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1202 display_name embed ext_bwidth fade font geometry hold iconName 1268 display_name embed ext_bwidth fade font geometry hold iconName
1203 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1269 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1204 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1270 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1205 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1271 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1206 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1272 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1207 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1273 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1208 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1274 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1209 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1275 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1210 secondaryScreen secondaryScroll selectstyle shade term_name title 1276 secondaryScreen secondaryScroll shade term_name title
1211 transient_for transparent transparent_all tripleclickwords utmpInhibit 1277 transient_for transparent transparent_all tripleclickwords utmpInhibit
1212 visualBell 1278 visualBell
1213 1279
1214=cut 1280=cut
1215 1281
1513 1579
1514Returns the currently displayed screen (0 primary, 1 secondary). 1580Returns the currently displayed screen (0 primary, 1 secondary).
1515 1581
1516=item $cursor_is_hidden = $term->hidden_cursor 1582=item $cursor_is_hidden = $term->hidden_cursor
1517 1583
1518Returns wether the cursor is currently hidden or not. 1584Returns whether the cursor is currently hidden or not.
1519 1585
1520=item $view_start = $term->view_start ([$newvalue]) 1586=item $view_start = $term->view_start ([$newvalue])
1521 1587
1522Returns the row number of the topmost displayed line. Maximum value is 1588Returns the row number of the topmost displayed line. Maximum value is
1523C<0>, which displays the normal terminal contents. Lower values scroll 1589C<0>, which displays the normal terminal contents. Lower values scroll
1531 1597
1532Used after changing terminal contents to display them. 1598Used after changing terminal contents to display them.
1533 1599
1534=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1600=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1535 1601
1536Returns the text of the entire row with number C<$row_number>. Row C<0> 1602Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1537is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1603is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1538terminal line. The scrollback buffer starts at line C<-1> and extends to
1539line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1604terminal line. Nothing will be returned if a nonexistent line
1540is requested. 1605is requested.
1541 1606
1542If C<$new_text> is specified, it will replace characters in the current 1607If C<$new_text> is specified, it will replace characters in the current
1543line, starting at column C<$start_col> (default C<0>), which is useful 1608line, starting at column C<$start_col> (default C<0>), which is useful
1544to replace only parts of a line. The font index in the rendition will 1609to replace only parts of a line. The font index in the rendition will
1545automatically be updated. 1610automatically be updated.
1546 1611
1547C<$text> is in a special encoding: tabs and wide characters that use more 1612C<$text> is in a special encoding: tabs and wide characters that use more
1548than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1613than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1549characters. Characters with combining characters and other characters that 1614characters. Characters with combining characters and other characters that
1550do not fit into the normal tetx encoding will be replaced with characters 1615do not fit into the normal text encoding will be replaced with characters
1551in the private use area. 1616in the private use area.
1552 1617
1553You have to obey this encoding when changing text. The advantage is 1618You have to obey this encoding when changing text. The advantage is
1554that C<substr> and similar functions work on screen cells and not on 1619that C<substr> and similar functions work on screen cells and not on
1555characters. 1620characters.
1700where one character corresponds to one screen cell. See 1765where one character corresponds to one screen cell. See
1701C<< $term->ROW_t >> for details. 1766C<< $term->ROW_t >> for details.
1702 1767
1703=item $string = $term->special_decode $text 1768=item $string = $term->special_decode $text
1704 1769
1705Converts rxvt-unicodes text reprsentation into a perl string. See 1770Converts rxvt-unicodes text representation into a perl string. See
1706C<< $term->ROW_t >> for details. 1771C<< $term->ROW_t >> for details.
1707 1772
1708=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1773=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1709 1774
1710=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1775=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1713manpage. 1778manpage.
1714 1779
1715=item $success = $term->grab ($eventtime[, $sync]) 1780=item $success = $term->grab ($eventtime[, $sync])
1716 1781
1717Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1782Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1718synchronous (C<$sync> is true). Also remembers the grab timestampe. 1783synchronous (C<$sync> is true). Also remembers the grab timestamp.
1719 1784
1720=item $term->allow_events_async 1785=item $term->allow_events_async
1721 1786
1722Calls XAllowEvents with AsyncBoth for the most recent grab. 1787Calls XAllowEvents with AsyncBoth for the most recent grab.
1723 1788
1742 1807
1743=item @atoms = $term->XListProperties ($window) 1808=item @atoms = $term->XListProperties ($window)
1744 1809
1745=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1810=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1746 1811
1747=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1812=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1748 1813
1749=item $term->XDeleteProperty ($window, $property) 1814=item $term->XDeleteProperty ($window, $property)
1750 1815
1751=item $window = $term->DefaultRootWindow 1816=item $window = $term->DefaultRootWindow
1752 1817
1874 my $env = $self->{term}->env; 1939 my $env = $self->{term}->env;
1875 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1940 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1876 delete $env->{LC_ALL}; 1941 delete $env->{LC_ALL};
1877 $env->{LC_CTYPE} = $self->{term}->locale; 1942 $env->{LC_CTYPE} = $self->{term}->locale;
1878 1943
1879 urxvt::term->new ($env, "popup", 1944 my $term = urxvt::term->new (
1945 $env, "popup",
1880 "--perl-lib" => "", "--perl-ext-common" => "", 1946 "--perl-lib" => "", "--perl-ext-common" => "",
1881 "-pty-fd" => -1, "-sl" => 0, 1947 "-pty-fd" => -1, "-sl" => 0,
1882 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1948 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1883 "--transient-for" => $self->{term}->parent, 1949 "--transient-for" => $self->{term}->parent,
1884 "-display" => $self->{term}->display_id, 1950 "-display" => $self->{term}->display_id,
1885 "-pe" => "urxvt-popup") 1951 "-pe" => "urxvt-popup",
1886 or die "unable to create popup window\n"; 1952 ) or die "unable to create popup window\n";
1953
1954 unless (delete $term->{urxvt_popup_init_done}) {
1955 $term->ungrab;
1956 $term->destroy;
1957 die "unable to initialise popup window\n";
1958 }
1887} 1959}
1888 1960
1889sub DESTROY { 1961sub DESTROY {
1890 my ($self) = @_; 1962 my ($self) = @_;
1891 1963
1896=back 1968=back
1897 1969
1898=cut 1970=cut
1899 1971
1900package urxvt::watcher; 1972package urxvt::watcher;
1901
1902@urxvt::timer::ISA = __PACKAGE__;
1903@urxvt::iow::ISA = __PACKAGE__;
1904@urxvt::pw::ISA = __PACKAGE__;
1905@urxvt::iw::ISA = __PACKAGE__;
1906 1973
1907=head2 The C<urxvt::timer> Class 1974=head2 The C<urxvt::timer> Class
1908 1975
1909This class implements timer watchers/events. Time is represented as a 1976This class implements timer watchers/events. Time is represented as a
1910fractional number of seconds since the epoch. Example: 1977fractional number of seconds since the epoch. Example:
1914 ->new 1981 ->new
1915 ->interval (1) 1982 ->interval (1)
1916 ->cb (sub { 1983 ->cb (sub {
1917 $term->{overlay}->set (0, 0, 1984 $term->{overlay}->set (0, 0,
1918 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1985 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1919 }); 1986 });
1920 1987
1921=over 4 1988=over 4
1922 1989
1923=item $timer = new urxvt::timer 1990=item $timer = new urxvt::timer
1924 1991
1967 2034
1968 $term->{socket} = ... 2035 $term->{socket} = ...
1969 $term->{iow} = urxvt::iow 2036 $term->{iow} = urxvt::iow
1970 ->new 2037 ->new
1971 ->fd (fileno $term->{socket}) 2038 ->fd (fileno $term->{socket})
1972 ->events (urxvt::EVENT_READ) 2039 ->events (urxvt::EV_READ)
1973 ->start 2040 ->start
1974 ->cb (sub { 2041 ->cb (sub {
1975 my ($iow, $revents) = @_; 2042 my ($iow, $revents) = @_;
1976 # $revents must be 1 here, no need to check 2043 # $revents must be 1 here, no need to check
1977 sysread $term->{socket}, my $buf, 8192 2044 sysread $term->{socket}, my $buf, 8192
1990Set the callback to be called when io events are triggered. C<$reventmask> 2057Set the callback to be called when io events are triggered. C<$reventmask>
1991is a bitset as described in the C<events> method. 2058is a bitset as described in the C<events> method.
1992 2059
1993=item $iow = $iow->fd ($fd) 2060=item $iow = $iow->fd ($fd)
1994 2061
1995Set the filedescriptor (not handle) to watch. 2062Set the file descriptor (not handle) to watch.
1996 2063
1997=item $iow = $iow->events ($eventmask) 2064=item $iow = $iow->events ($eventmask)
1998 2065
1999Set the event mask to watch. The only allowed values are 2066Set the event mask to watch. The only allowed values are
2000C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2067C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2001together, or C<urxvt::EVENT_NONE>. 2068together, or C<urxvt::EV_NONE>.
2002 2069
2003=item $iow = $iow->start 2070=item $iow = $iow->start
2004 2071
2005Start watching for requested events on the given handle. 2072Start watching for requested events on the given handle.
2006 2073
2007=item $iow = $iow->stop 2074=item $iow = $iow->stop
2008 2075
2009Stop watching for events on the given filehandle. 2076Stop watching for events on the given file handle.
2010 2077
2011=back 2078=back
2012 2079
2013=head2 The C<urxvt::iw> Class 2080=head2 The C<urxvt::iw> Class
2014 2081
2047 ->new 2114 ->new
2048 ->start ($pid) 2115 ->start ($pid)
2049 ->cb (sub { 2116 ->cb (sub {
2050 my ($pw, $exit_status) = @_; 2117 my ($pw, $exit_status) = @_;
2051 ... 2118 ...
2052 }); 2119 });
2053 2120
2054=over 4 2121=over 4
2055 2122
2056=item $pw = new urxvt::pw 2123=item $pw = new urxvt::pw
2057 2124
2061 2128
2062Set the callback to be called when the timer triggers. 2129Set the callback to be called when the timer triggers.
2063 2130
2064=item $pw = $timer->start ($pid) 2131=item $pw = $timer->start ($pid)
2065 2132
2066Tells the wqtcher to start watching for process C<$pid>. 2133Tells the watcher to start watching for process C<$pid>.
2067 2134
2068=item $pw = $pw->stop 2135=item $pw = $pw->stop
2069 2136
2070Stop the watcher. 2137Stop the watcher.
2071 2138
2084 2151
2085=item >= 3 - script loading and management 2152=item >= 3 - script loading and management
2086 2153
2087=item >=10 - all called hooks 2154=item >=10 - all called hooks
2088 2155
2089=item >=11 - hook reutrn values 2156=item >=11 - hook return values
2090 2157
2091=back 2158=back
2092 2159
2093=head1 AUTHOR 2160=head1 AUTHOR
2094 2161
2096 http://software.schmorp.de/pkg/rxvt-unicode 2163 http://software.schmorp.de/pkg/rxvt-unicode
2097 2164
2098=cut 2165=cut
2099 2166
21001 21671
2168
2169# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines