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.143 by root, Thu Jul 6 23:48:11 2006 UTC vs.
Revision 1.171 by root, Fri Oct 10 00:11:44 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.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the 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
166move 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
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
220the message into vi commands to load the file. 223the message into vi commands to load the file.
221 224
222=item tabbed 225=item tabbed
223 226
224This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
225is, 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
226displays 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
227button per tab. 230button per tab.
228 231
229Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
230B<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,
240 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
241 244
242See 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
243indices. 246indices.
244 247
245=item mark-urls 248=item matcher
246 249
247Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
248make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
249resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
250the 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
251 276
252=item xim-onthespot 277=item xim-onthespot
253 278
254This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
255not 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
256OnTheSpot 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
257kinput2. 282kinput2.
258 283
259You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
261 286
269will show or hide itself. Another press of the accelerator key will hide 294will show or hide itself. Another press of the accelerator key will hide
270or show it again. 295or show it again.
271 296
272Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
273 298
274This is useful if you need a single terminal thats not using any desktop 299This is useful if you need a single terminal that is not using any desktop
275space most of the time but is quickly available at the press of a key. 300space most of the time but is quickly available at the press of a key.
276 301
277The accelerator key is grabbed regardless of any modifers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
278extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
279 304
280If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
281(fvwm can do it). 306(fvwm can do it).
282
283=item automove-background
284
285This is basically a very small extension that dynamically changes the
286background pixmap offset to the window position, in effect creating the
287same effect as pseudo transparency with a custom pixmap. No scaling is
288supported in this mode. Exmaple:
289
290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291 307
292=item block-graphics-to-ascii 308=item block-graphics-to-ascii
293 309
294A 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
295by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
300Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
301 317
302=item remote-clipboard 318=item remote-clipboard
303 319
304Somewhat of a misnomer, this extension adds two menu entries to the 320Somewhat of a misnomer, this extension adds two menu entries to the
305selection popup that allows one ti run external commands to store the 321selection popup that allows one to run external commands to store the
306selection somewhere and fetch it again. 322selection somewhere and fetch it again.
307 323
308We use it to implement a "distributed selection mechanism", which just 324We use it to implement a "distributed selection mechanism", which just
309means 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
310reads it. 326reads it.
345After 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
346in the C<selection-pastebin-url> resource (again, the % is the placeholder 362in the C<selection-pastebin-url> resource (again, the % is the placeholder
347for the filename): 363for the filename):
348 364
349 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.
350 371
351=item example-refresh-hooks 372=item example-refresh-hooks
352 373
353Displays 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
354window. Illustrates overwriting the refresh callbacks to create your own 375window. Illustrates overwriting the refresh callbacks to create your own
395=back 416=back
396 417
397=head2 Extension Objects 418=head2 Extension Objects
398 419
399Every 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
400for 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,
401hooks. 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
402about 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
403begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
404use. 426internal use.
405 427
406Although 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
407C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
408 430
409It has the following methods and data members: 431It has the following methods and data members:
430=head2 Hooks 452=head2 Hooks
431 453
432The following subroutines can be declared in extension files, and will be 454The following subroutines can be declared in extension files, and will be
433called whenever the relevant event happens. 455called whenever the relevant event happens.
434 456
435The 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
436the in the C<Extension Objects> section. 458the in the C<Extension Objects> section.
437 459
438B<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
439hooks 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
440relevant action might not be carried out by the C++ code. 462relevant action might not be carried out by the C++ code.
453place. 475place.
454 476
455=item on_start $term 477=item on_start $term
456 478
457Called 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
458trying to map (display) the toplevel and returning to the mainloop. 480trying to map (display) the toplevel and returning to the main loop.
459 481
460=item on_destroy $term 482=item on_destroy $term
461 483
462Called whenever something tries to destroy terminal, when the terminal is 484Called whenever something tries to destroy terminal, when the terminal is
463still fully functional (not for long, though). 485still fully functional (not for long, though).
490 512
491Called whenever a selection has been copied, but before the selection is 513Called whenever a selection has been copied, but before the selection is
492requested from the server. The selection text can be queried and changed 514requested from the server. The selection text can be queried and changed
493by calling C<< $term->selection >>. 515by calling C<< $term->selection >>.
494 516
495Returning a true value aborts selection grabbing. It will still be hilighted. 517Returning a true value aborts selection grabbing. It will still be highlighted.
496 518
497=item on_sel_extend $term 519=item on_sel_extend $term
498 520
499Called 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
500click) and is either supposed to return false (normal operation), or 522click) and is either supposed to return false (normal operation), or
501should 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
502processing. This can happen multiple times, as long as the callback 524processing. This can happen multiple times, as long as the callback
503returns 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
504supposed to enlarge the selection more and more, if possible. 526supposed to enlarge the selection more and more, if possible.
505 527
506See the F<selection> example extension. 528See the F<selection> example extension.
507 529
508=item on_view_change $term, $offset 530=item on_view_change $term, $offset
509 531
510Called whenever the view offset changes, i..e the user or program 532Called whenever the view offset changes, i.e. the user or program
511scrolls. Offset C<0> means display the normal terminal, positive values 533scrolls. Offset C<0> means display the normal terminal, positive values
512show this many lines of scrollback. 534show this many lines of scrollback.
513 535
514=item on_scroll_back $term, $lines, $saved 536=item on_scroll_back $term, $lines, $saved
515 537
519 541
520It 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,
521$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
522number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
523 545
524=item on_osc_seq $term, $op, $args 546=item on_osc_seq $term, $op, $args, $resp
525 547
526Called on every OSC sequence and can be used to suppress it or modify its 548Called on every OSC sequence and can be used to suppress it or modify its
527behaviour. The default should be to return an empty list. A true value 549behaviour. The default should be to return an empty list. A true value
528suppresses execution of the request completely. Make sure you don't get 550suppresses execution of the request completely. Make sure you don't get
529confused by recursive invocations when you output an osc sequence within 551confused by recursive invocations when you output an OSC sequence within
530this callback. 552this callback.
531 553
532C<on_osc_seq_perl> should be used for new behaviour. 554C<on_osc_seq_perl> should be used for new behaviour.
533 555
534=item on_osc_seq_perl $term, $string 556=item on_osc_seq_perl $term, $args, $resp
535 557
536Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
538information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
539string should start with the extension name and a colon, to distinguish 561string should start with the extension name (sans -osc) and a semicolon,
540it from commands for other extensions, and this might be enforced in the 562to distinguish it from commands for other extensions, and this might be
541future. 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 }
542 574
543Be 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,
544as 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
545other 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.
546 581
547=item on_add_lines $term, $string 582=item on_add_lines $term, $string
548 583
549Called 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
550can 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
571later 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
572you cannot just toggle rendition bits, but only set them. 607you cannot just toggle rendition bits, but only set them.
573 608
574=item on_refresh_begin $term 609=item on_refresh_begin $term
575 610
576Called just before the screen gets redrawn. Can be used for overlay 611Called just before the screen gets redrawn. Can be used for overlay or
577or similar effects by modify terminal contents in refresh_begin, and 612similar effects by modifying the terminal contents in refresh_begin, and
578restoring them in refresh_end. The built-in overlay and selection display 613restoring them in refresh_end. The built-in overlay and selection display
579code is run after this hook, and takes precedence. 614code is run after this hook, and takes precedence.
580 615
581=item on_refresh_end $term 616=item on_refresh_end $term
582 617
583Called just after the screen gets redrawn. See C<on_refresh_begin>. 618Called just after the screen gets redrawn. See C<on_refresh_begin>.
584 619
585=item on_user_command $term, $string 620=item on_user_command $term, $string
586 621
587Called whenever the a user-configured event is being activated (e.g. via 622Called whenever a user-configured event is being activated (e.g. via
588a 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>
589resource in the @@RXVT_NAME@@(1) manpage). 624resource in the @@RXVT_NAME@@(1) manpage).
590 625
591The 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
592slightly in the future. 627slightly in the future.
593 628
594=item on_resize_all_windows $tern, $new_width, $new_height 629=item on_resize_all_windows $tern, $new_width, $new_height
595 630
596Called just after the new window size has been calculcated, but before 631Called just after the new window size has been calculated, but before
597windows 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
598returns TRUE, setting of the window hints is being skipped. 633returns TRUE, setting of the window hints is being skipped.
599 634
600=item on_x_event $term, $event 635=item on_x_event $term, $event
601 636
612Called whenever the window gets the keyboard focus, before rxvt-unicode 647Called whenever the window gets the keyboard focus, before rxvt-unicode
613does focus in processing. 648does focus in processing.
614 649
615=item on_focus_out $term 650=item on_focus_out $term
616 651
617Called wheneever the window loses keyboard focus, before rxvt-unicode does 652Called whenever the window loses keyboard focus, before rxvt-unicode does
618focus out processing. 653focus out processing.
619 654
620=item on_configure_notify $term, $event 655=item on_configure_notify $term, $event
621 656
622=item on_property_notify $term, $event 657=item on_property_notify $term, $event
705The current terminal. This variable stores the current C<urxvt::term> 740The current terminal. This variable stores the current C<urxvt::term>
706object, whenever a callback/hook is executing. 741object, whenever a callback/hook is executing.
707 742
708=item @urxvt::TERM_INIT 743=item @urxvt::TERM_INIT
709 744
710All 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
711created 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
712gets cleared before the codereferences that were in it are being executed, 747gets cleared before the code references that were in it are being executed,
713so coderefs can push themselves onto it again if they so desire. 748so references can push themselves onto it again if they so desire.
714 749
715This complements to the perl-eval commandline option, but gets executed 750This complements to the perl-eval command line option, but gets executed
716first. 751first.
717 752
718=item @urxvt::TERM_EXT 753=item @urxvt::TERM_EXT
719 754
720Works 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
745Messages have a size limit of 1023 bytes currently. 780Messages have a size limit of 1023 bytes currently.
746 781
747=item @terms = urxvt::termlist 782=item @terms = urxvt::termlist
748 783
749Returns all urxvt::term objects that exist in this process, regardless of 784Returns all urxvt::term objects that exist in this process, regardless of
750wether they are started, being destroyed etc., so be careful. Only term 785whether they are started, being destroyed etc., so be careful. Only term
751objects that have perl extensions attached will be returned (because there 786objects that have perl extensions attached will be returned (because there
752is no urxvt::term objet associated with others). 787is no urxvt::term objet associated with others).
753 788
754=item $time = urxvt::NOW 789=item $time = urxvt::NOW
755 790
893 local $TERM = shift; 928 local $TERM = shift;
894 my $htype = shift; 929 my $htype = shift;
895 930
896 if ($htype == 0) { # INIT 931 if ($htype == 0) { # INIT
897 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
898 933
899 my %ext_arg; 934 my %ext_arg;
900 935
901 { 936 {
902 my @init = @TERM_INIT; 937 my @init = @TERM_INIT;
903 @TERM_INIT = (); 938 @TERM_INIT = ();
966 1001
967sub SET_COLOR($$$) { 1002sub SET_COLOR($$$) {
968 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1003 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969} 1004}
970 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)
1029}
1030
971# urxvt::term::extension 1031# urxvt::term::extension
972 1032
973package urxvt::term::extension; 1033package urxvt::term::extension;
974 1034
975sub enable { 1035sub enable {
1044is 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
1045work. 1105work.
1046 1106
1047=cut 1107=cut
1048 1108
1049our $VERSION = 1; 1109our $VERSION = '3.4';
1050 1110
1051$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053 1113
1054sub timer { 1114sub timer {
1085 1145
1086sub DESTROY { 1146sub DESTROY {
1087 $_[0][1]->stop; 1147 $_[0][1]->stop;
1088} 1148}
1089 1149
1090sub condvar { 1150sub one_event {
1091 bless \my $flag, urxvt::anyevent::condvar::
1092}
1093
1094sub urxvt::anyevent::condvar::broadcast {
1095 ${$_[0]}++;
1096}
1097
1098sub urxvt::anyevent::condvar::wait {
1099 unless (${$_[0]}) {
1100 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";
1101 }
1102} 1152}
1103 1153
1104package urxvt::term; 1154package urxvt::term;
1105 1155
1106=head2 The C<urxvt::term> Class 1156=head2 The C<urxvt::term> Class
1193 1243
1194Returns true if the option specified by C<$optval> is enabled, and 1244Returns true if the option specified by C<$optval> is enabled, and
1195optionally 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
1196C<%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.
1197 1247
1198Here 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
1199source file F</src/optinc.h> to see the actual list: 1249source file F</src/optinc.h> to see the actual list:
1200 1250
1201 borderLess console cursorBlink cursorUnderline hold iconic insecure 1251 borderLess console cursorBlink cursorUnderline hold iconic insecure
1202 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1252 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1203 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1253 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1220likely change). 1270likely change).
1221 1271
1222Please note that resource strings will currently only be freed when the 1272Please note that resource strings will currently only be freed when the
1223terminal is destroyed, so changing options frequently will eat memory. 1273terminal is destroyed, so changing options frequently will eat memory.
1224 1274
1225Here 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
1226are 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>
1227to see the actual list: 1277to see the actual list:
1228 1278
1229 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1230 borderLess color cursorBlink cursorUnderline cutchars delete_key 1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1231 display_name embed ext_bwidth fade font geometry hold iconName 1281 display_name embed ext_bwidth fade font geometry hold iconName
1232 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1233 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1234 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1235 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239 secondaryScreen secondaryScroll selectstyle shade term_name title 1289 secondaryScreen secondaryScroll shade term_name title
1240 transient_for transparent transparent_all tripleclickwords utmpInhibit 1290 transient_for transparent transparent_all tripleclickwords utmpInhibit
1241 visualBell 1291 visualBell
1242 1292
1243=cut 1293=cut
1244 1294
1245sub resource($$;$) { 1295sub resource($$;$) {
1246 my ($self, $name) = (shift, shift); 1296 my ($self, $name) = (shift, shift);
1247 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1297 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1248 &urxvt::term::_resource 1298 goto &urxvt::term::_resource
1249} 1299}
1250 1300
1251=item $value = $term->x_resource ($pattern) 1301=item $value = $term->x_resource ($pattern)
1252 1302
1253Returns the X-Resource for the given pattern, excluding the program or 1303Returns the X-Resource for the given pattern, excluding the program or
1542 1592
1543Returns the currently displayed screen (0 primary, 1 secondary). 1593Returns the currently displayed screen (0 primary, 1 secondary).
1544 1594
1545=item $cursor_is_hidden = $term->hidden_cursor 1595=item $cursor_is_hidden = $term->hidden_cursor
1546 1596
1547Returns wether the cursor is currently hidden or not. 1597Returns whether the cursor is currently hidden or not.
1548 1598
1549=item $view_start = $term->view_start ([$newvalue]) 1599=item $view_start = $term->view_start ([$newvalue])
1550 1600
1551Returns the row number of the topmost displayed line. Maximum value is 1601Returns the row number of the topmost displayed line. Maximum value is
1552C<0>, which displays the normal terminal contents. Lower values scroll 1602C<0>, which displays the normal terminal contents. Lower values scroll
1560 1610
1561Used after changing terminal contents to display them. 1611Used after changing terminal contents to display them.
1562 1612
1563=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1613=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564 1614
1565Returns the text of the entire row with number C<$row_number>. Row C<0> 1615Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1566is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1616is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1567terminal line. The scrollback buffer starts at line C<-1> and extends to
1568line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1617terminal line. Nothing will be returned if a nonexistent line
1569is requested. 1618is requested.
1570 1619
1571If C<$new_text> is specified, it will replace characters in the current 1620If C<$new_text> is specified, it will replace characters in the current
1572line, starting at column C<$start_col> (default C<0>), which is useful 1621line, starting at column C<$start_col> (default C<0>), which is useful
1573to replace only parts of a line. The font index in the rendition will 1622to replace only parts of a line. The font index in the rendition will
1574automatically be updated. 1623automatically be updated.
1575 1624
1576C<$text> is in a special encoding: tabs and wide characters that use more 1625C<$text> is in a special encoding: tabs and wide characters that use more
1577than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1626than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1578characters. Characters with combining characters and other characters that 1627characters. Characters with combining characters and other characters that
1579do not fit into the normal tetx encoding will be replaced with characters 1628do not fit into the normal text encoding will be replaced with characters
1580in the private use area. 1629in the private use area.
1581 1630
1582You have to obey this encoding when changing text. The advantage is 1631You have to obey this encoding when changing text. The advantage is
1583that C<substr> and similar functions work on screen cells and not on 1632that C<substr> and similar functions work on screen cells and not on
1584characters. 1633characters.
1729where one character corresponds to one screen cell. See 1778where one character corresponds to one screen cell. See
1730C<< $term->ROW_t >> for details. 1779C<< $term->ROW_t >> for details.
1731 1780
1732=item $string = $term->special_decode $text 1781=item $string = $term->special_decode $text
1733 1782
1734Converts rxvt-unicodes text reprsentation into a perl string. See 1783Converts rxvt-unicodes text representation into a perl string. See
1735C<< $term->ROW_t >> for details. 1784C<< $term->ROW_t >> for details.
1736 1785
1737=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1786=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1738 1787
1739=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1788=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1742manpage. 1791manpage.
1743 1792
1744=item $success = $term->grab ($eventtime[, $sync]) 1793=item $success = $term->grab ($eventtime[, $sync])
1745 1794
1746Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1795Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1747synchronous (C<$sync> is true). Also remembers the grab timestampe. 1796synchronous (C<$sync> is true). Also remembers the grab timestamp.
1748 1797
1749=item $term->allow_events_async 1798=item $term->allow_events_async
1750 1799
1751Calls XAllowEvents with AsyncBoth for the most recent grab. 1800Calls XAllowEvents with AsyncBoth for the most recent grab.
1752 1801
1771 1820
1772=item @atoms = $term->XListProperties ($window) 1821=item @atoms = $term->XListProperties ($window)
1773 1822
1774=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1823=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775 1824
1776=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1825=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777 1826
1778=item $term->XDeleteProperty ($window, $property) 1827=item $term->XDeleteProperty ($window, $property)
1779 1828
1780=item $window = $term->DefaultRootWindow 1829=item $window = $term->DefaultRootWindow
1781 1830
1903 my $env = $self->{term}->env; 1952 my $env = $self->{term}->env;
1904 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1953 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1905 delete $env->{LC_ALL}; 1954 delete $env->{LC_ALL};
1906 $env->{LC_CTYPE} = $self->{term}->locale; 1955 $env->{LC_CTYPE} = $self->{term}->locale;
1907 1956
1908 urxvt::term->new ($env, "popup", 1957 my $term = urxvt::term->new (
1958 $env, "popup",
1909 "--perl-lib" => "", "--perl-ext-common" => "", 1959 "--perl-lib" => "", "--perl-ext-common" => "",
1910 "-pty-fd" => -1, "-sl" => 0, 1960 "-pty-fd" => -1, "-sl" => 0,
1911 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1961 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912 "--transient-for" => $self->{term}->parent, 1962 "--transient-for" => $self->{term}->parent,
1913 "-display" => $self->{term}->display_id, 1963 "-display" => $self->{term}->display_id,
1914 "-pe" => "urxvt-popup") 1964 "-pe" => "urxvt-popup",
1915 or die "unable to create popup window\n"; 1965 ) or die "unable to create popup window\n";
1966
1967 unless (delete $term->{urxvt_popup_init_done}) {
1968 $term->ungrab;
1969 $term->destroy;
1970 die "unable to initialise popup window\n";
1971 }
1916} 1972}
1917 1973
1918sub DESTROY { 1974sub DESTROY {
1919 my ($self) = @_; 1975 my ($self) = @_;
1920 1976
1925=back 1981=back
1926 1982
1927=cut 1983=cut
1928 1984
1929package urxvt::watcher; 1985package urxvt::watcher;
1930
1931@urxvt::timer::ISA = __PACKAGE__;
1932@urxvt::iow::ISA = __PACKAGE__;
1933@urxvt::pw::ISA = __PACKAGE__;
1934@urxvt::iw::ISA = __PACKAGE__;
1935 1986
1936=head2 The C<urxvt::timer> Class 1987=head2 The C<urxvt::timer> Class
1937 1988
1938This class implements timer watchers/events. Time is represented as a 1989This class implements timer watchers/events. Time is represented as a
1939fractional number of seconds since the epoch. Example: 1990fractional number of seconds since the epoch. Example:
1943 ->new 1994 ->new
1944 ->interval (1) 1995 ->interval (1)
1945 ->cb (sub { 1996 ->cb (sub {
1946 $term->{overlay}->set (0, 0, 1997 $term->{overlay}->set (0, 0,
1947 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1998 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948 }); 1999 });
1949 2000
1950=over 4 2001=over 4
1951 2002
1952=item $timer = new urxvt::timer 2003=item $timer = new urxvt::timer
1953 2004
1996 2047
1997 $term->{socket} = ... 2048 $term->{socket} = ...
1998 $term->{iow} = urxvt::iow 2049 $term->{iow} = urxvt::iow
1999 ->new 2050 ->new
2000 ->fd (fileno $term->{socket}) 2051 ->fd (fileno $term->{socket})
2001 ->events (urxvt::EVENT_READ) 2052 ->events (urxvt::EV_READ)
2002 ->start 2053 ->start
2003 ->cb (sub { 2054 ->cb (sub {
2004 my ($iow, $revents) = @_; 2055 my ($iow, $revents) = @_;
2005 # $revents must be 1 here, no need to check 2056 # $revents must be 1 here, no need to check
2006 sysread $term->{socket}, my $buf, 8192 2057 sysread $term->{socket}, my $buf, 8192
2019Set the callback to be called when io events are triggered. C<$reventmask> 2070Set the callback to be called when io events are triggered. C<$reventmask>
2020is a bitset as described in the C<events> method. 2071is a bitset as described in the C<events> method.
2021 2072
2022=item $iow = $iow->fd ($fd) 2073=item $iow = $iow->fd ($fd)
2023 2074
2024Set the filedescriptor (not handle) to watch. 2075Set the file descriptor (not handle) to watch.
2025 2076
2026=item $iow = $iow->events ($eventmask) 2077=item $iow = $iow->events ($eventmask)
2027 2078
2028Set the event mask to watch. The only allowed values are 2079Set the event mask to watch. The only allowed values are
2029C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2080C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2030together, or C<urxvt::EVENT_NONE>. 2081together, or C<urxvt::EV_NONE>.
2031 2082
2032=item $iow = $iow->start 2083=item $iow = $iow->start
2033 2084
2034Start watching for requested events on the given handle. 2085Start watching for requested events on the given handle.
2035 2086
2036=item $iow = $iow->stop 2087=item $iow = $iow->stop
2037 2088
2038Stop watching for events on the given filehandle. 2089Stop watching for events on the given file handle.
2039 2090
2040=back 2091=back
2041 2092
2042=head2 The C<urxvt::iw> Class 2093=head2 The C<urxvt::iw> Class
2043 2094
2076 ->new 2127 ->new
2077 ->start ($pid) 2128 ->start ($pid)
2078 ->cb (sub { 2129 ->cb (sub {
2079 my ($pw, $exit_status) = @_; 2130 my ($pw, $exit_status) = @_;
2080 ... 2131 ...
2081 }); 2132 });
2082 2133
2083=over 4 2134=over 4
2084 2135
2085=item $pw = new urxvt::pw 2136=item $pw = new urxvt::pw
2086 2137
2090 2141
2091Set the callback to be called when the timer triggers. 2142Set the callback to be called when the timer triggers.
2092 2143
2093=item $pw = $timer->start ($pid) 2144=item $pw = $timer->start ($pid)
2094 2145
2095Tells the wqtcher to start watching for process C<$pid>. 2146Tells the watcher to start watching for process C<$pid>.
2096 2147
2097=item $pw = $pw->stop 2148=item $pw = $pw->stop
2098 2149
2099Stop the watcher. 2150Stop the watcher.
2100 2151
2113 2164
2114=item >= 3 - script loading and management 2165=item >= 3 - script loading and management
2115 2166
2116=item >=10 - all called hooks 2167=item >=10 - all called hooks
2117 2168
2118=item >=11 - hook reutrn values 2169=item >=11 - hook return values
2119 2170
2120=back 2171=back
2121 2172
2122=head1 AUTHOR 2173=head1 AUTHOR
2123 2174
2125 http://software.schmorp.de/pkg/rxvt-unicode 2176 http://software.schmorp.de/pkg/rxvt-unicode
2126 2177
2127=cut 2178=cut
2128 2179
21291 21801
2181
2182# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines