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.138 by root, Sat Mar 4 22:36:50 2006 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 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
109The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
110C<$self->{myoption}>: 113C<< $self->{myoption} >>:
111 114
112 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 }; 117 };
115 118
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 one-line extension that dynamically changes the background pixmap offset 291A very primitive quake-console-like extension. It was inspired by a
261to 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
262a 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.
263 296
264 @@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).
307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
265 313
266=item block-graphics-to-ascii 314=item block-graphics-to-ascii
267 315
268A not very useful example of filtering all text output to the terminal, 316A not very useful example of filtering all text output to the terminal
269by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
270similar-looking ascii character. 318similar-looking ascii character.
271 319
272=item digital-clock 320=item digital-clock
273 321
274Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
275 323
276=item remote-clipboard 324=item remote-clipboard
277 325
278Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
279selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
280selection somewhere and fetch it again. 328selection somewhere and fetch it again.
281 329
282We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
283means that one command uploads the file to a remote server, and another 331means that one command uploads the file to a remote server, and another
284reads it. 332reads it.
319After a successful upload the selection will be replaced by the text given 367After a successful upload the selection will be replaced by the text given
320in the C<selection-pastebin-url> resource (again, the % is the placeholder 368in the C<selection-pastebin-url> resource (again, the % is the placeholder
321for the filename): 369for the filename):
322 370
323 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file
376or not.
324 377
325=item example-refresh-hooks 378=item example-refresh-hooks
326 379
327Displays a very simple digital clock in the upper right corner of the 380Displays a very simple digital clock in the upper right corner of the
328window. Illustrates overwriting the refresh callbacks to create your own 381window. Illustrates overwriting the refresh callbacks to create your own
368 421
369=back 422=back
370 423
371=head2 Extension Objects 424=head2 Extension Objects
372 425
373Very perl extension is a perl class. A separate perl object is created 426Every perl extension is a perl class. A separate perl object is created
374for each terminal and each extension and passed as the first parameter to 427for each terminal, and each terminal has its own set of extenion objects,
375hooks. So extensions can use their C<$self> object without having to think 428which are passed as the first parameter to hooks. So extensions can use
376about other extensions, with the exception of methods and members that 429their C<$self> object without having to think about clashes with other
430extensions or other terminals, with the exception of methods and members
377begin with an underscore character C<_>: these are reserved for internal 431that begin with an underscore character C<_>: these are reserved for
378use. 432internal use.
379 433
380Although it isn't a C<urxvt::term> object, you can call all methods of the 434Although it isn't a C<urxvt::term> object, you can call all methods of the
381C<urxvt::term> class on this object. 435C<urxvt::term> class on this object.
382 436
383It has the following methods and data members: 437It has the following methods and data members:
404=head2 Hooks 458=head2 Hooks
405 459
406The following subroutines can be declared in extension files, and will be 460The following subroutines can be declared in extension files, and will be
407called whenever the relevant event happens. 461called whenever the relevant event happens.
408 462
409The first argument passed to them is an extension oject as described in 463The first argument passed to them is an extension object as described in
410the in the C<Extension Objects> section. 464the in the C<Extension Objects> section.
411 465
412B<All> of these hooks must return a boolean value. If any of the called 466B<All> of these hooks must return a boolean value. If any of the called
413hooks returns true, then the event counts as being I<consumed>, and the 467hooks returns true, then the event counts as being I<consumed>, and the
414relevant action might not be carried out by the C++ code. 468relevant action might not be carried out by the C++ code.
427place. 481place.
428 482
429=item on_start $term 483=item on_start $term
430 484
431Called at the very end of initialisation of a new terminal, just before 485Called at the very end of initialisation of a new terminal, just before
432trying to map (display) the toplevel and returning to the mainloop. 486trying to map (display) the toplevel and returning to the main loop.
433 487
434=item on_destroy $term 488=item on_destroy $term
435 489
436Called whenever something tries to destroy terminal, when the terminal is 490Called whenever something tries to destroy terminal, when the terminal is
437still fully functional (not for long, though). 491still fully functional (not for long, though).
464 518
465Called whenever a selection has been copied, but before the selection is 519Called whenever a selection has been copied, but before the selection is
466requested from the server. The selection text can be queried and changed 520requested from the server. The selection text can be queried and changed
467by calling C<< $term->selection >>. 521by calling C<< $term->selection >>.
468 522
469Returning a true value aborts selection grabbing. It will still be hilighted. 523Returning a true value aborts selection grabbing. It will still be highlighted.
470 524
471=item on_sel_extend $term 525=item on_sel_extend $term
472 526
473Called whenever the user tries to extend the selection (e.g. with a double 527Called whenever the user tries to extend the selection (e.g. with a double
474click) and is either supposed to return false (normal operation), or 528click) and is either supposed to return false (normal operation), or
475should extend the selection itelf and return true to suppress the built-in 529should extend the selection itself and return true to suppress the built-in
476processing. This can happen multiple times, as long as the callback 530processing. This can happen multiple times, as long as the callback
477returns true, it will be called on every further click by the user and is 531returns true, it will be called on every further click by the user and is
478supposed to enlarge the selection more and more, if possible. 532supposed to enlarge the selection more and more, if possible.
479 533
480See the F<selection> example extension. 534See the F<selection> example extension.
481 535
482=item on_view_change $term, $offset 536=item on_view_change $term, $offset
483 537
484Called whenever the view offset changes, i..e the user or program 538Called whenever the view offset changes, i.e. the user or program
485scrolls. Offset C<0> means display the normal terminal, positive values 539scrolls. Offset C<0> means display the normal terminal, positive values
486show this many lines of scrollback. 540show this many lines of scrollback.
487 541
488=item on_scroll_back $term, $lines, $saved 542=item on_scroll_back $term, $lines, $saved
489 543
493 547
494It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 548It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
495$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 549$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
496number of lines that will be in the scrollback buffer. 550number of lines that will be in the scrollback buffer.
497 551
498=item on_osc_seq $term, $op, $args 552=item on_osc_seq $term, $op, $args, $resp
499 553
500Called on every OSC sequence and can be used to suppress it or modify its 554Called on every OSC sequence and can be used to suppress it or modify its
501behaviour. The default should be to return an empty list. A true value 555behaviour. The default should be to return an empty list. A true value
502suppresses execution of the request completely. Make sure you don't get 556suppresses execution of the request completely. Make sure you don't get
503confused by recursive invocations when you output an osc sequence within 557confused by recursive invocations when you output an OSC sequence within
504this callback. 558this callback.
505 559
506C<on_osc_seq_perl> should be used for new behaviour. 560C<on_osc_seq_perl> should be used for new behaviour.
507 561
508=item on_osc_seq_perl $term, $string 562=item on_osc_seq_perl $term, $args, $resp
509 563
510Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 564Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
511operating system command) is processed. Cursor position and other state 565operating system command) is processed. Cursor position and other state
512information is up-to-date when this happens. For interoperability, the 566information is up-to-date when this happens. For interoperability, the
513string should start with the extension name and a colon, to distinguish 567string should start with the extension name (sans -osc) and a semicolon,
514it from commands for other extensions, and this might be enforced in the 568to distinguish it from commands for other extensions, and this might be
515future. 569enforced in the future.
570
571For example, C<overlay-osc> uses this:
572
573 sub on_osc_seq_perl {
574 my ($self, $osc, $resp) = @_;
575
576 return unless $osc =~ s/^overlay;//;
577
578 ... process remaining $osc string
579 }
516 580
517Be careful not ever to trust (in a security sense) the data you receive, 581Be careful not ever to trust (in a security sense) the data you receive,
518as its source can not easily be controleld (e-mail content, messages from 582as its source can not easily be controlled (e-mail content, messages from
519other users on the same system etc.). 583other users on the same system etc.).
584
585For responses, C<$resp> contains the end-of-args separator used by the
586sender.
520 587
521=item on_add_lines $term, $string 588=item on_add_lines $term, $string
522 589
523Called whenever text is about to be output, with the text as argument. You 590Called whenever text is about to be output, with the text as argument. You
524can filter/change and output the text yourself by returning a true value 591can filter/change and output the text yourself by returning a true value
545later with the already-modified line (e.g. if unrelated parts change), so 612later with the already-modified line (e.g. if unrelated parts change), so
546you cannot just toggle rendition bits, but only set them. 613you cannot just toggle rendition bits, but only set them.
547 614
548=item on_refresh_begin $term 615=item on_refresh_begin $term
549 616
550Called just before the screen gets redrawn. Can be used for overlay 617Called just before the screen gets redrawn. Can be used for overlay or
551or similar effects by modify terminal contents in refresh_begin, and 618similar effects by modifying the terminal contents in refresh_begin, and
552restoring them in refresh_end. The built-in overlay and selection display 619restoring them in refresh_end. The built-in overlay and selection display
553code is run after this hook, and takes precedence. 620code is run after this hook, and takes precedence.
554 621
555=item on_refresh_end $term 622=item on_refresh_end $term
556 623
557Called just after the screen gets redrawn. See C<on_refresh_begin>. 624Called just after the screen gets redrawn. See C<on_refresh_begin>.
558 625
559=item on_user_command $term, $string 626=item on_user_command $term, $string
560 627
561Called whenever the a user-configured event is being activated (e.g. via 628Called whenever a user-configured event is being activated (e.g. via
562a C<perl:string> action bound to a key, see description of the B<keysym> 629a C<perl:string> action bound to a key, see description of the B<keysym>
563resource in the @@RXVT_NAME@@(1) manpage). 630resource in the @@RXVT_NAME@@(1) manpage).
564 631
565The event is simply the action string. This interface is assumed to change 632The event is simply the action string. This interface is assumed to change
566slightly in the future. 633slightly in the future.
567 634
568=item on_resize_all_windows $tern, $new_width, $new_height 635=item on_resize_all_windows $tern, $new_width, $new_height
569 636
570Called just after the new window size has been calculcated, but before 637Called just after the new window size has been calculated, but before
571windows are actually being resized or hints are being set. If this hook 638windows are actually being resized or hints are being set. If this hook
572returns TRUE, setting of the window hints is being skipped. 639returns TRUE, setting of the window hints is being skipped.
573 640
574=item on_x_event $term, $event 641=item on_x_event $term, $event
575 642
576Called on every X event received on the vt window (and possibly other 643Called on every X event received on the vt window (and possibly other
577windows). Should only be used as a last resort. Most event structure 644windows). Should only be used as a last resort. Most event structure
578members are not passed. 645members are not passed.
579 646
647=item on_root_event $term, $event
648
649Like C<on_x_event>, but is called for events on the root window.
650
580=item on_focus_in $term 651=item on_focus_in $term
581 652
582Called whenever the window gets the keyboard focus, before rxvt-unicode 653Called whenever the window gets the keyboard focus, before rxvt-unicode
583does focus in processing. 654does focus in processing.
584 655
585=item on_focus_out $term 656=item on_focus_out $term
586 657
587Called wheneever the window loses keyboard focus, before rxvt-unicode does 658Called whenever the window loses keyboard focus, before rxvt-unicode does
588focus out processing. 659focus out processing.
589 660
590=item on_configure_notify $term, $event 661=item on_configure_notify $term, $event
591 662
592=item on_property_notify $term, $event 663=item on_property_notify $term, $event
675The current terminal. This variable stores the current C<urxvt::term> 746The current terminal. This variable stores the current C<urxvt::term>
676object, whenever a callback/hook is executing. 747object, whenever a callback/hook is executing.
677 748
678=item @urxvt::TERM_INIT 749=item @urxvt::TERM_INIT
679 750
680All coderefs in this array will be called as methods of the next newly 751All code references in this array will be called as methods of the next newly
681created C<urxvt::term> object (during the C<on_init> phase). The array 752created C<urxvt::term> object (during the C<on_init> phase). The array
682gets cleared before the codereferences that were in it are being executed, 753gets cleared before the code references that were in it are being executed,
683so coderefs can push themselves onto it again if they so desire. 754so references can push themselves onto it again if they so desire.
684 755
685This complements to the perl-eval commandline option, but gets executed 756This complements to the perl-eval command line option, but gets executed
686first. 757first.
687 758
688=item @urxvt::TERM_EXT 759=item @urxvt::TERM_EXT
689 760
690Works similar to C<@TERM_INIT>, but contains perl package/class names, which 761Works similar to C<@TERM_INIT>, but contains perl package/class names, which
715Messages have a size limit of 1023 bytes currently. 786Messages have a size limit of 1023 bytes currently.
716 787
717=item @terms = urxvt::termlist 788=item @terms = urxvt::termlist
718 789
719Returns all urxvt::term objects that exist in this process, regardless of 790Returns all urxvt::term objects that exist in this process, regardless of
720wether they are started, being destroyed etc., so be careful. Only term 791whether they are started, being destroyed etc., so be careful. Only term
721objects that have perl extensions attached will be returned (because there 792objects that have perl extensions attached will be returned (because there
722is no urxvt::term objet associated with others). 793is no urxvt::term objet associated with others).
723 794
724=item $time = urxvt::NOW 795=item $time = urxvt::NOW
725 796
863 local $TERM = shift; 934 local $TERM = shift;
864 my $htype = shift; 935 my $htype = shift;
865 936
866 if ($htype == 0) { # INIT 937 if ($htype == 0) { # INIT
867 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 938 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
868 939
869 my %ext_arg; 940 my %ext_arg;
870 941
871 { 942 {
872 my @init = @TERM_INIT; 943 my @init = @TERM_INIT;
873 @TERM_INIT = (); 944 @TERM_INIT = ();
936 1007
937sub SET_COLOR($$$) { 1008sub SET_COLOR($$$) {
938 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1009 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
939} 1010}
940 1011
1012sub rend2mask {
1013 no strict 'refs';
1014 my ($str, $mask) = (@_, 0);
1015 my %color = ( fg => undef, bg => undef );
1016 my @failed;
1017 for my $spec ( split /\s+/, $str ) {
1018 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1019 $color{lc($1)} = $2;
1020 } else {
1021 my $neg = $spec =~ s/^[-^]//;
1022 unless ( exists &{"RS_$spec"} ) {
1023 push @failed, $spec;
1024 next;
1025 }
1026 my $cur = &{"RS_$spec"};
1027 if ( $neg ) {
1028 $mask &= ~$cur;
1029 } else {
1030 $mask |= $cur;
1031 }
1032 }
1033 }
1034 ($mask, @color{qw(fg bg)}, \@failed)
1035}
1036
941# urxvt::term::extension 1037# urxvt::term::extension
942 1038
943package urxvt::term::extension; 1039package urxvt::term::extension;
944 1040
945sub enable { 1041sub enable {
1014is that you cannot use blocking APIs, but the non-blocking variant should 1110is that you cannot use blocking APIs, but the non-blocking variant should
1015work. 1111work.
1016 1112
1017=cut 1113=cut
1018 1114
1019our $VERSION = 1; 1115our $VERSION = '3.4';
1020 1116
1021$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1022push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1023 1119
1024sub timer { 1120sub timer {
1055 1151
1056sub DESTROY { 1152sub DESTROY {
1057 $_[0][1]->stop; 1153 $_[0][1]->stop;
1058} 1154}
1059 1155
1060sub condvar { 1156sub one_event {
1061 bless \my $flag, urxvt::anyevent::condvar::
1062}
1063
1064sub urxvt::anyevent::condvar::broadcast {
1065 ${$_[0]}++;
1066}
1067
1068sub urxvt::anyevent::condvar::wait {
1069 unless (${$_[0]}) {
1070 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1157 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1071 }
1072} 1158}
1073 1159
1074package urxvt::term; 1160package urxvt::term;
1075 1161
1076=head2 The C<urxvt::term> Class 1162=head2 The C<urxvt::term> Class
1163 1249
1164Returns true if the option specified by C<$optval> is enabled, and 1250Returns true if the option specified by C<$optval> is enabled, and
1165optionally change it. All option values are stored by name in the hash 1251optionally change it. All option values are stored by name in the hash
1166C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1252C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1167 1253
1168Here is a a likely non-exhaustive list of option names, please see the 1254Here is a likely non-exhaustive list of option names, please see the
1169source file F</src/optinc.h> to see the actual list: 1255source file F</src/optinc.h> to see the actual list:
1170 1256
1171 borderLess console cursorBlink cursorUnderline hold iconic insecure 1257 borderLess console cursorBlink cursorUnderline hold iconic insecure
1172 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1258 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1173 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1259 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1190likely change). 1276likely change).
1191 1277
1192Please note that resource strings will currently only be freed when the 1278Please note that resource strings will currently only be freed when the
1193terminal is destroyed, so changing options frequently will eat memory. 1279terminal is destroyed, so changing options frequently will eat memory.
1194 1280
1195Here is a a likely non-exhaustive list of resource names, not all of which 1281Here is a likely non-exhaustive list of resource names, not all of which
1196are supported in every build, please see the source file F</src/rsinc.h> 1282are supported in every build, please see the source file F</src/rsinc.h>
1197to see the actual list: 1283to see the actual list:
1198 1284
1199 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1200 borderLess color cursorBlink cursorUnderline cutchars delete_key 1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1201 display_name embed ext_bwidth fade font geometry hold iconName 1287 display_name embed ext_bwidth fade font geometry hold iconName
1202 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1203 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1204 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1205 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1206 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1207 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1208 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1209 secondaryScreen secondaryScroll selectstyle shade term_name title 1295 secondaryScreen secondaryScroll shade term_name title
1210 transient_for transparent transparent_all tripleclickwords utmpInhibit 1296 transient_for transparent transparent_all tripleclickwords utmpInhibit
1211 visualBell 1297 visualBell
1212 1298
1213=cut 1299=cut
1214 1300
1215sub resource($$;$) { 1301sub resource($$;$) {
1216 my ($self, $name) = (shift, shift); 1302 my ($self, $name) = (shift, shift);
1217 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1303 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1218 &urxvt::term::_resource 1304 goto &urxvt::term::_resource
1219} 1305}
1220 1306
1221=item $value = $term->x_resource ($pattern) 1307=item $value = $term->x_resource ($pattern)
1222 1308
1223Returns the X-Resource for the given pattern, excluding the program or 1309Returns the X-Resource for the given pattern, excluding the program or
1306 1392
1307The methods currently supported on C<urxvt::overlay> objects are: 1393The methods currently supported on C<urxvt::overlay> objects are:
1308 1394
1309=over 4 1395=over 4
1310 1396
1311=item $overlay->set ($x, $y, $text, $rend) 1397=item $overlay->set ($x, $y, $text[, $rend])
1312 1398
1313Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1399Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1314text in rxvt-unicode's special encoding and an array of rendition values 1400text in rxvt-unicode's special encoding and an array of rendition values
1315at a specific position inside the overlay. 1401at a specific position inside the overlay.
1402
1403If C<$rend> is missing, then the rendition will not be changed.
1316 1404
1317=item $overlay->hide 1405=item $overlay->hide
1318 1406
1319If visible, hide the overlay, but do not destroy it. 1407If visible, hide the overlay, but do not destroy it.
1320 1408
1512 1600
1513Returns the currently displayed screen (0 primary, 1 secondary). 1601Returns the currently displayed screen (0 primary, 1 secondary).
1514 1602
1515=item $cursor_is_hidden = $term->hidden_cursor 1603=item $cursor_is_hidden = $term->hidden_cursor
1516 1604
1517Returns wether the cursor is currently hidden or not. 1605Returns whether the cursor is currently hidden or not.
1518 1606
1519=item $view_start = $term->view_start ([$newvalue]) 1607=item $view_start = $term->view_start ([$newvalue])
1520 1608
1521Returns the row number of the topmost displayed line. Maximum value is 1609Returns the row number of the topmost displayed line. Maximum value is
1522C<0>, which displays the normal terminal contents. Lower values scroll 1610C<0>, which displays the normal terminal contents. Lower values scroll
1530 1618
1531Used after changing terminal contents to display them. 1619Used after changing terminal contents to display them.
1532 1620
1533=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1534 1622
1535Returns the text of the entire row with number C<$row_number>. Row C<0> 1623Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1536is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1624is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1537terminal line. The scrollback buffer starts at line C<-1> and extends to
1538line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1625terminal line. Nothing will be returned if a nonexistent line
1539is requested. 1626is requested.
1540 1627
1541If C<$new_text> is specified, it will replace characters in the current 1628If C<$new_text> is specified, it will replace characters in the current
1542line, starting at column C<$start_col> (default C<0>), which is useful 1629line, starting at column C<$start_col> (default C<0>), which is useful
1543to replace only parts of a line. The font index in the rendition will 1630to replace only parts of a line. The font index in the rendition will
1544automatically be updated. 1631automatically be updated.
1545 1632
1546C<$text> is in a special encoding: tabs and wide characters that use more 1633C<$text> is in a special encoding: tabs and wide characters that use more
1547than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1634than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1548characters. Characters with combining characters and other characters that 1635characters. Characters with combining characters and other characters that
1549do not fit into the normal tetx encoding will be replaced with characters 1636do not fit into the normal text encoding will be replaced with characters
1550in the private use area. 1637in the private use area.
1551 1638
1552You have to obey this encoding when changing text. The advantage is 1639You have to obey this encoding when changing text. The advantage is
1553that C<substr> and similar functions work on screen cells and not on 1640that C<substr> and similar functions work on screen cells and not on
1554characters. 1641characters.
1699where one character corresponds to one screen cell. See 1786where one character corresponds to one screen cell. See
1700C<< $term->ROW_t >> for details. 1787C<< $term->ROW_t >> for details.
1701 1788
1702=item $string = $term->special_decode $text 1789=item $string = $term->special_decode $text
1703 1790
1704Converts rxvt-unicodes text reprsentation into a perl string. See 1791Converts rxvt-unicodes text representation into a perl string. See
1705C<< $term->ROW_t >> for details. 1792C<< $term->ROW_t >> for details.
1706 1793
1707=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1794=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1708 1795
1709=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1796=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1712manpage. 1799manpage.
1713 1800
1714=item $success = $term->grab ($eventtime[, $sync]) 1801=item $success = $term->grab ($eventtime[, $sync])
1715 1802
1716Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1803Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1717synchronous (C<$sync> is true). Also remembers the grab timestampe. 1804synchronous (C<$sync> is true). Also remembers the grab timestamp.
1718 1805
1719=item $term->allow_events_async 1806=item $term->allow_events_async
1720 1807
1721Calls XAllowEvents with AsyncBoth for the most recent grab. 1808Calls XAllowEvents with AsyncBoth for the most recent grab.
1722 1809
1741 1828
1742=item @atoms = $term->XListProperties ($window) 1829=item @atoms = $term->XListProperties ($window)
1743 1830
1744=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1831=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1745 1832
1746=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1833=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1747 1834
1748=item $term->XDeleteProperty ($window, $property) 1835=item $term->XDeleteProperty ($window, $property)
1749 1836
1750=item $window = $term->DefaultRootWindow 1837=item $window = $term->DefaultRootWindow
1751 1838
1873 my $env = $self->{term}->env; 1960 my $env = $self->{term}->env;
1874 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1961 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1875 delete $env->{LC_ALL}; 1962 delete $env->{LC_ALL};
1876 $env->{LC_CTYPE} = $self->{term}->locale; 1963 $env->{LC_CTYPE} = $self->{term}->locale;
1877 1964
1878 urxvt::term->new ($env, "popup", 1965 my $term = urxvt::term->new (
1966 $env, "popup",
1879 "--perl-lib" => "", "--perl-ext-common" => "", 1967 "--perl-lib" => "", "--perl-ext-common" => "",
1880 "-pty-fd" => -1, "-sl" => 0, 1968 "-pty-fd" => -1, "-sl" => 0,
1881 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1969 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1882 "--transient-for" => $self->{term}->parent, 1970 "--transient-for" => $self->{term}->parent,
1883 "-display" => $self->{term}->display_id, 1971 "-display" => $self->{term}->display_id,
1884 "-pe" => "urxvt-popup") 1972 "-pe" => "urxvt-popup",
1885 or die "unable to create popup window\n"; 1973 ) or die "unable to create popup window\n";
1974
1975 unless (delete $term->{urxvt_popup_init_done}) {
1976 $term->ungrab;
1977 $term->destroy;
1978 die "unable to initialise popup window\n";
1979 }
1886} 1980}
1887 1981
1888sub DESTROY { 1982sub DESTROY {
1889 my ($self) = @_; 1983 my ($self) = @_;
1890 1984
1895=back 1989=back
1896 1990
1897=cut 1991=cut
1898 1992
1899package urxvt::watcher; 1993package urxvt::watcher;
1900
1901@urxvt::timer::ISA = __PACKAGE__;
1902@urxvt::iow::ISA = __PACKAGE__;
1903@urxvt::pw::ISA = __PACKAGE__;
1904@urxvt::iw::ISA = __PACKAGE__;
1905 1994
1906=head2 The C<urxvt::timer> Class 1995=head2 The C<urxvt::timer> Class
1907 1996
1908This class implements timer watchers/events. Time is represented as a 1997This class implements timer watchers/events. Time is represented as a
1909fractional number of seconds since the epoch. Example: 1998fractional number of seconds since the epoch. Example:
1913 ->new 2002 ->new
1914 ->interval (1) 2003 ->interval (1)
1915 ->cb (sub { 2004 ->cb (sub {
1916 $term->{overlay}->set (0, 0, 2005 $term->{overlay}->set (0, 0,
1917 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1918 }); 2007 });
1919 2008
1920=over 4 2009=over 4
1921 2010
1922=item $timer = new urxvt::timer 2011=item $timer = new urxvt::timer
1923 2012
1966 2055
1967 $term->{socket} = ... 2056 $term->{socket} = ...
1968 $term->{iow} = urxvt::iow 2057 $term->{iow} = urxvt::iow
1969 ->new 2058 ->new
1970 ->fd (fileno $term->{socket}) 2059 ->fd (fileno $term->{socket})
1971 ->events (urxvt::EVENT_READ) 2060 ->events (urxvt::EV_READ)
1972 ->start 2061 ->start
1973 ->cb (sub { 2062 ->cb (sub {
1974 my ($iow, $revents) = @_; 2063 my ($iow, $revents) = @_;
1975 # $revents must be 1 here, no need to check 2064 # $revents must be 1 here, no need to check
1976 sysread $term->{socket}, my $buf, 8192 2065 sysread $term->{socket}, my $buf, 8192
1989Set the callback to be called when io events are triggered. C<$reventmask> 2078Set the callback to be called when io events are triggered. C<$reventmask>
1990is a bitset as described in the C<events> method. 2079is a bitset as described in the C<events> method.
1991 2080
1992=item $iow = $iow->fd ($fd) 2081=item $iow = $iow->fd ($fd)
1993 2082
1994Set the filedescriptor (not handle) to watch. 2083Set the file descriptor (not handle) to watch.
1995 2084
1996=item $iow = $iow->events ($eventmask) 2085=item $iow = $iow->events ($eventmask)
1997 2086
1998Set the event mask to watch. The only allowed values are 2087Set the event mask to watch. The only allowed values are
1999C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2088C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2000together, or C<urxvt::EVENT_NONE>. 2089together, or C<urxvt::EV_NONE>.
2001 2090
2002=item $iow = $iow->start 2091=item $iow = $iow->start
2003 2092
2004Start watching for requested events on the given handle. 2093Start watching for requested events on the given handle.
2005 2094
2006=item $iow = $iow->stop 2095=item $iow = $iow->stop
2007 2096
2008Stop watching for events on the given filehandle. 2097Stop watching for events on the given file handle.
2009 2098
2010=back 2099=back
2011 2100
2012=head2 The C<urxvt::iw> Class 2101=head2 The C<urxvt::iw> Class
2013 2102
2046 ->new 2135 ->new
2047 ->start ($pid) 2136 ->start ($pid)
2048 ->cb (sub { 2137 ->cb (sub {
2049 my ($pw, $exit_status) = @_; 2138 my ($pw, $exit_status) = @_;
2050 ... 2139 ...
2051 }); 2140 });
2052 2141
2053=over 4 2142=over 4
2054 2143
2055=item $pw = new urxvt::pw 2144=item $pw = new urxvt::pw
2056 2145
2060 2149
2061Set the callback to be called when the timer triggers. 2150Set the callback to be called when the timer triggers.
2062 2151
2063=item $pw = $timer->start ($pid) 2152=item $pw = $timer->start ($pid)
2064 2153
2065Tells the wqtcher to start watching for process C<$pid>. 2154Tells the watcher to start watching for process C<$pid>.
2066 2155
2067=item $pw = $pw->stop 2156=item $pw = $pw->stop
2068 2157
2069Stop the watcher. 2158Stop the watcher.
2070 2159
2083 2172
2084=item >= 3 - script loading and management 2173=item >= 3 - script loading and management
2085 2174
2086=item >=10 - all called hooks 2175=item >=10 - all called hooks
2087 2176
2088=item >=11 - hook reutrn values 2177=item >=11 - hook return values
2089 2178
2090=back 2179=back
2091 2180
2092=head1 AUTHOR 2181=head1 AUTHOR
2093 2182
2095 http://software.schmorp.de/pkg/rxvt-unicode 2184 http://software.schmorp.de/pkg/rxvt-unicode
2096 2185
2097=cut 2186=cut
2098 2187
20991 21881
2189
2190# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines