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.135 by root, Sun Feb 12 05:31:53 2006 UTC vs.
Revision 1.172 by root, Fri Oct 10 00:21:15 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).
265 307
266=item block-graphics-to-ascii 308=item block-graphics-to-ascii
267 309
268A 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
269by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
270similar-looking ascii character. 312similar-looking ascii character.
271 313
272=item digital-clock 314=item digital-clock
273 315
274Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
275 317
276=item remote-clipboard 318=item remote-clipboard
277 319
278Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
279selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
280selection somewhere and fetch it again. 322selection somewhere and fetch it again.
281 323
282We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
283means 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
284reads it. 326reads it.
319After 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
320in the C<selection-pastebin-url> resource (again, the % is the placeholder 362in the C<selection-pastebin-url> resource (again, the % is the placeholder
321for the filename): 363for the filename):
322 364
323 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.
324 371
325=item example-refresh-hooks 372=item example-refresh-hooks
326 373
327Displays 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
328window. Illustrates overwriting the refresh callbacks to create your own 375window. Illustrates overwriting the refresh callbacks to create your own
368 415
369=back 416=back
370 417
371=head2 Extension Objects 418=head2 Extension Objects
372 419
373Very 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
374for 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,
375hooks. 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
376about 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
377begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
378use. 426internal use.
379 427
380Although 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
381C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
382 430
383It has the following methods and data members: 431It has the following methods and data members:
404=head2 Hooks 452=head2 Hooks
405 453
406The following subroutines can be declared in extension files, and will be 454The following subroutines can be declared in extension files, and will be
407called whenever the relevant event happens. 455called whenever the relevant event happens.
408 456
409The 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
410the in the C<Extension Objects> section. 458the in the C<Extension Objects> section.
411 459
412B<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
413hooks 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
414relevant action might not be carried out by the C++ code. 462relevant action might not be carried out by the C++ code.
427place. 475place.
428 476
429=item on_start $term 477=item on_start $term
430 478
431Called 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
432trying to map (display) the toplevel and returning to the mainloop. 480trying to map (display) the toplevel and returning to the main loop.
433 481
434=item on_destroy $term 482=item on_destroy $term
435 483
436Called whenever something tries to destroy terminal, when the terminal is 484Called whenever something tries to destroy terminal, when the terminal is
437still fully functional (not for long, though). 485still fully functional (not for long, though).
464 512
465Called whenever a selection has been copied, but before the selection is 513Called whenever a selection has been copied, but before the selection is
466requested from the server. The selection text can be queried and changed 514requested from the server. The selection text can be queried and changed
467by calling C<< $term->selection >>. 515by calling C<< $term->selection >>.
468 516
469Returning a true value aborts selection grabbing. It will still be hilighted. 517Returning a true value aborts selection grabbing. It will still be highlighted.
470 518
471=item on_sel_extend $term 519=item on_sel_extend $term
472 520
473Called 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
474click) and is either supposed to return false (normal operation), or 522click) and is either supposed to return false (normal operation), or
475should 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
476processing. This can happen multiple times, as long as the callback 524processing. 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 525returns true, it will be called on every further click by the user and is
478supposed to enlarge the selection more and more, if possible. 526supposed to enlarge the selection more and more, if possible.
479 527
480See the F<selection> example extension. 528See the F<selection> example extension.
481 529
482=item on_view_change $term, $offset 530=item on_view_change $term, $offset
483 531
484Called whenever the view offset changes, i..e the user or program 532Called whenever the view offset changes, i.e. the user or program
485scrolls. Offset C<0> means display the normal terminal, positive values 533scrolls. Offset C<0> means display the normal terminal, positive values
486show this many lines of scrollback. 534show this many lines of scrollback.
487 535
488=item on_scroll_back $term, $lines, $saved 536=item on_scroll_back $term, $lines, $saved
489 537
493 541
494It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
495$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
496number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
497 545
498=item on_osc_seq $term, $string 546=item on_osc_seq $term, $op, $args, $resp
547
548Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an OSC sequence within
552this callback.
553
554C<on_osc_seq_perl> should be used for new behaviour.
555
556=item on_osc_seq_perl $term, $args, $resp
499 557
500Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
502information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
503string should start with the extension name and a colon, to distinguish 561string should start with the extension name (sans -osc) and a semicolon,
504it from commands for other extensions, and this might be enforced in the 562to distinguish it from commands for other extensions, and this might be
505future. 563enforced in the future.
564
565For example, C<overlay-osc> uses this:
566
567 sub on_osc_seq_perl {
568 my ($self, $osc, $resp) = @_;
569
570 return unless $osc =~ s/^overlay;//;
571
572 ... process remaining $osc string
573 }
506 574
507Be careful not ever to trust (in a security sense) the data you receive, 575Be careful not ever to trust (in a security sense) the data you receive,
508as its source can not easily be controleld (e-mail content, messages from 576as its source can not easily be controlled (e-mail content, messages from
509other users on the same system etc.). 577other users on the same system etc.).
578
579For responses, C<$resp> contains the end-of-args separator used by the
580sender.
510 581
511=item on_add_lines $term, $string 582=item on_add_lines $term, $string
512 583
513Called whenever text is about to be output, with the text as argument. You 584Called whenever text is about to be output, with the text as argument. You
514can filter/change and output the text yourself by returning a true value 585can filter/change and output the text yourself by returning a true value
535later with the already-modified line (e.g. if unrelated parts change), so 606later with the already-modified line (e.g. if unrelated parts change), so
536you cannot just toggle rendition bits, but only set them. 607you cannot just toggle rendition bits, but only set them.
537 608
538=item on_refresh_begin $term 609=item on_refresh_begin $term
539 610
540Called just before the screen gets redrawn. Can be used for overlay 611Called just before the screen gets redrawn. Can be used for overlay or
541or similar effects by modify terminal contents in refresh_begin, and 612similar effects by modifying the terminal contents in refresh_begin, and
542restoring them in refresh_end. The built-in overlay and selection display 613restoring them in refresh_end. The built-in overlay and selection display
543code is run after this hook, and takes precedence. 614code is run after this hook, and takes precedence.
544 615
545=item on_refresh_end $term 616=item on_refresh_end $term
546 617
547Called just after the screen gets redrawn. See C<on_refresh_begin>. 618Called just after the screen gets redrawn. See C<on_refresh_begin>.
548 619
549=item on_user_command $term, $string 620=item on_user_command $term, $string
550 621
551Called whenever the a user-configured event is being activated (e.g. via 622Called whenever a user-configured event is being activated (e.g. via
552a C<perl:string> action bound to a key, see description of the B<keysym> 623a C<perl:string> action bound to a key, see description of the B<keysym>
553resource in the @@RXVT_NAME@@(1) manpage). 624resource in the @@RXVT_NAME@@(1) manpage).
554 625
555The event is simply the action string. This interface is assumed to change 626The event is simply the action string. This interface is assumed to change
556slightly in the future. 627slightly in the future.
557 628
558=item on_resize_all_windows $tern, $new_width, $new_height 629=item on_resize_all_windows $tern, $new_width, $new_height
559 630
560Called just after the new window size has been calculcated, but before 631Called just after the new window size has been calculated, but before
561windows are actually being resized or hints are being set. If this hook 632windows are actually being resized or hints are being set. If this hook
562returns TRUE, setting of the window hints is being skipped. 633returns TRUE, setting of the window hints is being skipped.
563 634
564=item on_x_event $term, $event 635=item on_x_event $term, $event
565 636
566Called on every X event received on the vt window (and possibly other 637Called on every X event received on the vt window (and possibly other
567windows). Should only be used as a last resort. Most event structure 638windows). Should only be used as a last resort. Most event structure
568members are not passed. 639members are not passed.
569 640
641=item on_root_event $term, $event
642
643Like C<on_x_event>, but is called for events on the root window.
644
570=item on_focus_in $term 645=item on_focus_in $term
571 646
572Called whenever the window gets the keyboard focus, before rxvt-unicode 647Called whenever the window gets the keyboard focus, before rxvt-unicode
573does focus in processing. 648does focus in processing.
574 649
575=item on_focus_out $term 650=item on_focus_out $term
576 651
577Called wheneever the window loses keyboard focus, before rxvt-unicode does 652Called whenever the window loses keyboard focus, before rxvt-unicode does
578focus out processing. 653focus out processing.
579 654
580=item on_configure_notify $term, $event 655=item on_configure_notify $term, $event
581 656
582=item on_property_notify $term, $event 657=item on_property_notify $term, $event
665The current terminal. This variable stores the current C<urxvt::term> 740The current terminal. This variable stores the current C<urxvt::term>
666object, whenever a callback/hook is executing. 741object, whenever a callback/hook is executing.
667 742
668=item @urxvt::TERM_INIT 743=item @urxvt::TERM_INIT
669 744
670All coderefs in this array will be called as methods of the next newly 745All code references in this array will be called as methods of the next newly
671created C<urxvt::term> object (during the C<on_init> phase). The array 746created C<urxvt::term> object (during the C<on_init> phase). The array
672gets cleared before the codereferences that were in it are being executed, 747gets cleared before the code references that were in it are being executed,
673so coderefs can push themselves onto it again if they so desire. 748so references can push themselves onto it again if they so desire.
674 749
675This complements to the perl-eval commandline option, but gets executed 750This complements to the perl-eval command line option, but gets executed
676first. 751first.
677 752
678=item @urxvt::TERM_EXT 753=item @urxvt::TERM_EXT
679 754
680Works similar to C<@TERM_INIT>, but contains perl package/class names, which 755Works similar to C<@TERM_INIT>, but contains perl package/class names, which
705Messages have a size limit of 1023 bytes currently. 780Messages have a size limit of 1023 bytes currently.
706 781
707=item @terms = urxvt::termlist 782=item @terms = urxvt::termlist
708 783
709Returns all urxvt::term objects that exist in this process, regardless of 784Returns all urxvt::term objects that exist in this process, regardless of
710wether they are started, being destroyed etc., so be careful. Only term 785whether they are started, being destroyed etc., so be careful. Only term
711objects that have perl extensions attached will be returned (because there 786objects that have perl extensions attached will be returned (because there
712is no urxvt::term objet associated with others). 787is no urxvt::term objet associated with others).
713 788
714=item $time = urxvt::NOW 789=item $time = urxvt::NOW
715 790
853 local $TERM = shift; 928 local $TERM = shift;
854 my $htype = shift; 929 my $htype = shift;
855 930
856 if ($htype == 0) { # INIT 931 if ($htype == 0) { # INIT
857 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
858 933
859 my %ext_arg; 934 my %ext_arg;
860 935
861 { 936 {
862 my @init = @TERM_INIT; 937 my @init = @TERM_INIT;
863 @TERM_INIT = (); 938 @TERM_INIT = ();
897 972
898 if (my $cb = $TERM->{_hook}[$htype]) { 973 if (my $cb = $TERM->{_hook}[$htype]) {
899 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 974 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
900 if $verbosity >= 10; 975 if $verbosity >= 10;
901 976
902 keys %$cb; 977 for my $pkg (keys %$cb) {
903
904 while (my ($pkg, $cb) = each %$cb) {
905 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 978 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
906 $retval ||= $retval_; 979 $retval ||= $retval_;
907 980
908 if ($@) { 981 if ($@) {
909 $TERM->ungrab; # better to lose the grab than the session 982 $TERM->ungrab; # better to lose the grab than the session
910 warn $@; 983 warn $@;
926 $retval 999 $retval
927} 1000}
928 1001
929sub SET_COLOR($$$) { 1002sub SET_COLOR($$$) {
930 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1003 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1004}
1005
1006sub rend2mask {
1007 no strict 'refs';
1008 my ($str, $mask) = (@_, 0);
1009 my %color = ( fg => undef, bg => undef );
1010 my @failed;
1011 for my $spec ( split /\s+/, $str ) {
1012 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1013 $color{lc($1)} = $2;
1014 } else {
1015 my $neg = $spec =~ s/^[-^]//;
1016 unless ( exists &{"RS_$spec"} ) {
1017 push @failed, $spec;
1018 next;
1019 }
1020 my $cur = &{"RS_$spec"};
1021 if ( $neg ) {
1022 $mask &= ~$cur;
1023 } else {
1024 $mask |= $cur;
1025 }
1026 }
1027 }
1028 ($mask, @color{qw(fg bg)}, \@failed)
931} 1029}
932 1030
933# urxvt::term::extension 1031# urxvt::term::extension
934 1032
935package urxvt::term::extension; 1033package urxvt::term::extension;
1006is that you cannot use blocking APIs, but the non-blocking variant should 1104is that you cannot use blocking APIs, but the non-blocking variant should
1007work. 1105work.
1008 1106
1009=cut 1107=cut
1010 1108
1011our $VERSION = 1; 1109our $VERSION = '3.4';
1012 1110
1013$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1014push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1015 1113
1016sub timer { 1114sub timer {
1047 1145
1048sub DESTROY { 1146sub DESTROY {
1049 $_[0][1]->stop; 1147 $_[0][1]->stop;
1050} 1148}
1051 1149
1052sub condvar { 1150sub one_event {
1053 bless \my $flag, urxvt::anyevent::condvar::
1054}
1055
1056sub urxvt::anyevent::condvar::broadcast {
1057 ${$_[0]}++;
1058}
1059
1060sub urxvt::anyevent::condvar::wait {
1061 unless (${$_[0]}) {
1062 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1151 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1063 }
1064} 1152}
1065 1153
1066package urxvt::term; 1154package urxvt::term;
1067 1155
1068=head2 The C<urxvt::term> Class 1156=head2 The C<urxvt::term> Class
1155 1243
1156Returns true if the option specified by C<$optval> is enabled, and 1244Returns true if the option specified by C<$optval> is enabled, and
1157optionally change it. All option values are stored by name in the hash 1245optionally change it. All option values are stored by name in the hash
1158C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1246C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1159 1247
1160Here is a a likely non-exhaustive list of option names, please see the 1248Here is a likely non-exhaustive list of option names, please see the
1161source file F</src/optinc.h> to see the actual list: 1249source file F</src/optinc.h> to see the actual list:
1162 1250
1163 borderLess console cursorBlink cursorUnderline hold iconic insecure 1251 borderLess console cursorBlink cursorUnderline hold iconic insecure
1164 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1252 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1165 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1253 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1182likely change). 1270likely change).
1183 1271
1184Please note that resource strings will currently only be freed when the 1272Please note that resource strings will currently only be freed when the
1185terminal is destroyed, so changing options frequently will eat memory. 1273terminal is destroyed, so changing options frequently will eat memory.
1186 1274
1187Here is a a likely non-exhaustive list of resource names, not all of which 1275Here is a likely non-exhaustive list of resource names, not all of which
1188are supported in every build, please see the source file F</src/rsinc.h> 1276are supported in every build, please see the source file F</src/rsinc.h>
1189to see the actual list: 1277to see the actual list:
1190 1278
1191 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1192 borderLess color cursorBlink cursorUnderline cutchars delete_key 1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1193 display_name embed ext_bwidth fade font geometry hold iconName 1281 display_name embed ext_bwidth fade font geometry hold iconName
1194 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1195 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1196 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1197 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1198 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1199 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1200 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1201 secondaryScreen secondaryScroll selectstyle shade term_name title 1289 secondaryScreen secondaryScroll shade term_name title
1202 transient_for transparent transparent_all tripleclickwords utmpInhibit 1290 transient_for transparent transparent_all tripleclickwords utmpInhibit
1203 visualBell 1291 visualBell
1204 1292
1205=cut 1293=cut
1206 1294
1207sub resource($$;$) { 1295sub resource($$;$) {
1208 my ($self, $name) = (shift, shift); 1296 my ($self, $name) = (shift, shift);
1209 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1297 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1210 &urxvt::term::_resource 1298 goto &urxvt::term::_resource
1211} 1299}
1212 1300
1213=item $value = $term->x_resource ($pattern) 1301=item $value = $term->x_resource ($pattern)
1214 1302
1215Returns the X-Resource for the given pattern, excluding the program or 1303Returns the X-Resource for the given pattern, excluding the program or
1298 1386
1299The methods currently supported on C<urxvt::overlay> objects are: 1387The methods currently supported on C<urxvt::overlay> objects are:
1300 1388
1301=over 4 1389=over 4
1302 1390
1303=item $overlay->set ($x, $y, $text, $rend) 1391=item $overlay->set ($x, $y, $text[, $rend])
1304 1392
1305Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1393Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1306text in rxvt-unicode's special encoding and an array of rendition values 1394text in rxvt-unicode's special encoding and an array of rendition values
1307at a specific position inside the overlay. 1395at a specific position inside the overlay.
1396
1397If C<$rend> is missing, then the rendition will not be changed.
1308 1398
1309=item $overlay->hide 1399=item $overlay->hide
1310 1400
1311If visible, hide the overlay, but do not destroy it. 1401If visible, hide the overlay, but do not destroy it.
1312 1402
1474=item $env = $term->env 1564=item $env = $term->env
1475 1565
1476Returns a copy of the environment in effect for the terminal as a hashref 1566Returns a copy of the environment in effect for the terminal as a hashref
1477similar to C<\%ENV>. 1567similar to C<\%ENV>.
1478 1568
1569=item @envv = $term->envv
1570
1571Returns the environment as array of strings of the form C<VAR=VALUE>.
1572
1573=item @argv = $term->argv
1574
1575Return the argument vector as this terminal, similar to @ARGV, but
1576includes the program name as first element.
1577
1479=cut 1578=cut
1480 1579
1481sub env { 1580sub env {
1482 if (my $env = $_[0]->_env) {
1483 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1581 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1484 } else {
1485 +{ %ENV }
1486 }
1487} 1582}
1488 1583
1489=item $modifiermask = $term->ModLevel3Mask 1584=item $modifiermask = $term->ModLevel3Mask
1490 1585
1491=item $modifiermask = $term->ModMetaMask 1586=item $modifiermask = $term->ModMetaMask
1499 1594
1500Returns the currently displayed screen (0 primary, 1 secondary). 1595Returns the currently displayed screen (0 primary, 1 secondary).
1501 1596
1502=item $cursor_is_hidden = $term->hidden_cursor 1597=item $cursor_is_hidden = $term->hidden_cursor
1503 1598
1504Returns wether the cursor is currently hidden or not. 1599Returns whether the cursor is currently hidden or not.
1505 1600
1506=item $view_start = $term->view_start ([$newvalue]) 1601=item $view_start = $term->view_start ([$newvalue])
1507 1602
1508Returns the row number of the topmost displayed line. Maximum value is 1603Returns the row number of the topmost displayed line. Maximum value is
1509C<0>, which displays the normal terminal contents. Lower values scroll 1604C<0>, which displays the normal terminal contents. Lower values scroll
1517 1612
1518Used after changing terminal contents to display them. 1613Used after changing terminal contents to display them.
1519 1614
1520=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1615=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1521 1616
1522Returns the text of the entire row with number C<$row_number>. Row C<0> 1617Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1523is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1618is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1524terminal line. The scrollback buffer starts at line C<-1> and extends to
1525line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1619terminal line. Nothing will be returned if a nonexistent line
1526is requested. 1620is requested.
1527 1621
1528If C<$new_text> is specified, it will replace characters in the current 1622If C<$new_text> is specified, it will replace characters in the current
1529line, starting at column C<$start_col> (default C<0>), which is useful 1623line, starting at column C<$start_col> (default C<0>), which is useful
1530to replace only parts of a line. The font index in the rendition will 1624to replace only parts of a line. The font index in the rendition will
1531automatically be updated. 1625automatically be updated.
1532 1626
1533C<$text> is in a special encoding: tabs and wide characters that use more 1627C<$text> is in a special encoding: tabs and wide characters that use more
1534than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1628than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1535characters. Characters with combining characters and other characters that 1629characters. Characters with combining characters and other characters that
1536do not fit into the normal tetx encoding will be replaced with characters 1630do not fit into the normal text encoding will be replaced with characters
1537in the private use area. 1631in the private use area.
1538 1632
1539You have to obey this encoding when changing text. The advantage is 1633You have to obey this encoding when changing text. The advantage is
1540that C<substr> and similar functions work on screen cells and not on 1634that C<substr> and similar functions work on screen cells and not on
1541characters. 1635characters.
1686where one character corresponds to one screen cell. See 1780where one character corresponds to one screen cell. See
1687C<< $term->ROW_t >> for details. 1781C<< $term->ROW_t >> for details.
1688 1782
1689=item $string = $term->special_decode $text 1783=item $string = $term->special_decode $text
1690 1784
1691Converts rxvt-unicodes text reprsentation into a perl string. See 1785Converts rxvt-unicodes text representation into a perl string. See
1692C<< $term->ROW_t >> for details. 1786C<< $term->ROW_t >> for details.
1693 1787
1694=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1788=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1695 1789
1696=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1790=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1699manpage. 1793manpage.
1700 1794
1701=item $success = $term->grab ($eventtime[, $sync]) 1795=item $success = $term->grab ($eventtime[, $sync])
1702 1796
1703Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1797Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1704synchronous (C<$sync> is true). Also remembers the grab timestampe. 1798synchronous (C<$sync> is true). Also remembers the grab timestamp.
1705 1799
1706=item $term->allow_events_async 1800=item $term->allow_events_async
1707 1801
1708Calls XAllowEvents with AsyncBoth for the most recent grab. 1802Calls XAllowEvents with AsyncBoth for the most recent grab.
1709 1803
1728 1822
1729=item @atoms = $term->XListProperties ($window) 1823=item @atoms = $term->XListProperties ($window)
1730 1824
1731=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1825=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1732 1826
1733=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1827=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1734 1828
1735=item $term->XDeleteProperty ($window, $property) 1829=item $term->XDeleteProperty ($window, $property)
1736 1830
1737=item $window = $term->DefaultRootWindow 1831=item $window = $term->DefaultRootWindow
1738 1832
1860 my $env = $self->{term}->env; 1954 my $env = $self->{term}->env;
1861 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1955 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1862 delete $env->{LC_ALL}; 1956 delete $env->{LC_ALL};
1863 $env->{LC_CTYPE} = $self->{term}->locale; 1957 $env->{LC_CTYPE} = $self->{term}->locale;
1864 1958
1865 urxvt::term->new ($env, "popup", 1959 my $term = urxvt::term->new (
1960 $env, "popup",
1866 "--perl-lib" => "", "--perl-ext-common" => "", 1961 "--perl-lib" => "", "--perl-ext-common" => "",
1867 "-pty-fd" => -1, "-sl" => 0, 1962 "-pty-fd" => -1, "-sl" => 0,
1868 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1963 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1869 "--transient-for" => $self->{term}->parent, 1964 "--transient-for" => $self->{term}->parent,
1870 "-display" => $self->{term}->display_id, 1965 "-display" => $self->{term}->display_id,
1871 "-pe" => "urxvt-popup") 1966 "-pe" => "urxvt-popup",
1872 or die "unable to create popup window\n"; 1967 ) or die "unable to create popup window\n";
1968
1969 unless (delete $term->{urxvt_popup_init_done}) {
1970 $term->ungrab;
1971 $term->destroy;
1972 die "unable to initialise popup window\n";
1973 }
1873} 1974}
1874 1975
1875sub DESTROY { 1976sub DESTROY {
1876 my ($self) = @_; 1977 my ($self) = @_;
1877 1978
1882=back 1983=back
1883 1984
1884=cut 1985=cut
1885 1986
1886package urxvt::watcher; 1987package urxvt::watcher;
1887
1888@urxvt::timer::ISA = __PACKAGE__;
1889@urxvt::iow::ISA = __PACKAGE__;
1890@urxvt::pw::ISA = __PACKAGE__;
1891@urxvt::iw::ISA = __PACKAGE__;
1892 1988
1893=head2 The C<urxvt::timer> Class 1989=head2 The C<urxvt::timer> Class
1894 1990
1895This class implements timer watchers/events. Time is represented as a 1991This class implements timer watchers/events. Time is represented as a
1896fractional number of seconds since the epoch. Example: 1992fractional number of seconds since the epoch. Example:
1900 ->new 1996 ->new
1901 ->interval (1) 1997 ->interval (1)
1902 ->cb (sub { 1998 ->cb (sub {
1903 $term->{overlay}->set (0, 0, 1999 $term->{overlay}->set (0, 0,
1904 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2000 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1905 }); 2001 });
1906 2002
1907=over 4 2003=over 4
1908 2004
1909=item $timer = new urxvt::timer 2005=item $timer = new urxvt::timer
1910 2006
1953 2049
1954 $term->{socket} = ... 2050 $term->{socket} = ...
1955 $term->{iow} = urxvt::iow 2051 $term->{iow} = urxvt::iow
1956 ->new 2052 ->new
1957 ->fd (fileno $term->{socket}) 2053 ->fd (fileno $term->{socket})
1958 ->events (urxvt::EVENT_READ) 2054 ->events (urxvt::EV_READ)
1959 ->start 2055 ->start
1960 ->cb (sub { 2056 ->cb (sub {
1961 my ($iow, $revents) = @_; 2057 my ($iow, $revents) = @_;
1962 # $revents must be 1 here, no need to check 2058 # $revents must be 1 here, no need to check
1963 sysread $term->{socket}, my $buf, 8192 2059 sysread $term->{socket}, my $buf, 8192
1976Set the callback to be called when io events are triggered. C<$reventmask> 2072Set the callback to be called when io events are triggered. C<$reventmask>
1977is a bitset as described in the C<events> method. 2073is a bitset as described in the C<events> method.
1978 2074
1979=item $iow = $iow->fd ($fd) 2075=item $iow = $iow->fd ($fd)
1980 2076
1981Set the filedescriptor (not handle) to watch. 2077Set the file descriptor (not handle) to watch.
1982 2078
1983=item $iow = $iow->events ($eventmask) 2079=item $iow = $iow->events ($eventmask)
1984 2080
1985Set the event mask to watch. The only allowed values are 2081Set the event mask to watch. The only allowed values are
1986C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2082C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1987together, or C<urxvt::EVENT_NONE>. 2083together, or C<urxvt::EV_NONE>.
1988 2084
1989=item $iow = $iow->start 2085=item $iow = $iow->start
1990 2086
1991Start watching for requested events on the given handle. 2087Start watching for requested events on the given handle.
1992 2088
1993=item $iow = $iow->stop 2089=item $iow = $iow->stop
1994 2090
1995Stop watching for events on the given filehandle. 2091Stop watching for events on the given file handle.
1996 2092
1997=back 2093=back
1998 2094
1999=head2 The C<urxvt::iw> Class 2095=head2 The C<urxvt::iw> Class
2000 2096
2033 ->new 2129 ->new
2034 ->start ($pid) 2130 ->start ($pid)
2035 ->cb (sub { 2131 ->cb (sub {
2036 my ($pw, $exit_status) = @_; 2132 my ($pw, $exit_status) = @_;
2037 ... 2133 ...
2038 }); 2134 });
2039 2135
2040=over 4 2136=over 4
2041 2137
2042=item $pw = new urxvt::pw 2138=item $pw = new urxvt::pw
2043 2139
2047 2143
2048Set the callback to be called when the timer triggers. 2144Set the callback to be called when the timer triggers.
2049 2145
2050=item $pw = $timer->start ($pid) 2146=item $pw = $timer->start ($pid)
2051 2147
2052Tells the wqtcher to start watching for process C<$pid>. 2148Tells the watcher to start watching for process C<$pid>.
2053 2149
2054=item $pw = $pw->stop 2150=item $pw = $pw->stop
2055 2151
2056Stop the watcher. 2152Stop the watcher.
2057 2153
2070 2166
2071=item >= 3 - script loading and management 2167=item >= 3 - script loading and management
2072 2168
2073=item >=10 - all called hooks 2169=item >=10 - all called hooks
2074 2170
2075=item >=11 - hook reutrn values 2171=item >=11 - hook return values
2076 2172
2077=back 2173=back
2078 2174
2079=head1 AUTHOR 2175=head1 AUTHOR
2080 2176
2082 http://software.schmorp.de/pkg/rxvt-unicode 2178 http://software.schmorp.de/pkg/rxvt-unicode
2083 2179
2084=cut 2180=cut
2085 2181
20861 21821
2183
2184# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines