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.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.145 by root, Thu Aug 10 22:53:20 2006 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
62 URxvt.selection.pattern-1: perl-regex 62 URxvt.selection.pattern-1: perl-regex
63 ... 63 ...
64 64
65The index number (0, 1...) must not have any holes, and each regex must 65The 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 66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 67the match. For example, the following adds a regex that matches everything
68between two vertical bars: 68between two vertical bars:
69 69
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
71 78
72You can look at the source of the selection extension to see more 79You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end. 80interesting uses, such as parsing a line from beginning to end.
74 81
75This extension also offers following bindable keyboard commands: 82This extension also offers following bindable keyboard commands:
86 93
87=item option-popup (enabled by default) 94=item option-popup (enabled by default)
88 95
89Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90runtime. 97runtime.
98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's 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
105reference. 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
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
91 115
92=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
93 117
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
96evaluation, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
97 121
98Other extensions can extend this popup menu by pushing a code reference 122Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100popup is displayed. 124popup is being displayed.
101 125
102It's sole argument is the popup menu, which can be modified. The selection 126It's sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not. 127is in C<$_>, which can be used to decide whether to add something or not.
104It should either return nothing or a string and a code reference. The 128It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called 129string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>. 130when the button gets activated and should transform C<$_>.
107 131
108The following will add an entry C<a to b> that transforms all C<a>s in 132The following will add an entry C<a to b> that transforms all C<a>s in
127bottom. C<Escape> leaves search mode and returns to the point where search 151bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and 152was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary 153additionally stores the first match in the current line into the primary
130selection. 154selection.
131 155
156The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix.
159
160See L<perlre> for more info about perl regular expression syntax.
161
162=item readline (enabled by default)
163
164A support package that tries to make editing with readline easier. At
165the 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
167cursor-left or cursor-right keypresses as required (the this only works
168for programs that correctly support wide characters).
169
170To avoid too many false positives, this is only done when:
171
172=over 4
173
174=item - the tty is in ICANON state.
175
176=item - the text cursor is visible.
177
178=item - the primary screen is currently being displayed.
179
180=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182=back
183
184The normal selection mechanism isn't disabled, so quick successive clicks
185might interfere with selection creation in harmless ways.
186
132=item selection-autotransform 187=item selection-autotransform
133 188
134This selection allows you to do automatic transforms on a selection 189This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 190whenever a selection is made.
136 191
162 217
163The first line tells the selection code to treat the unchanging part of 218The first line tells the selection code to treat the unchanging part of
164every error message as a selection pattern, and the second line transforms 219every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 220the message into vi commands to load the file.
166 221
167=item readline
168
169A support package that tries to make editing with readline easier. At the
170moment, it reacts to clicking with the left mouse button by trying to
171move the text cursor to this position. It does so by generating as many
172cursor-left or cursor-right keypresses as required (the this only works
173for programs that correctly support wide characters).
174
175It only works when clicking into the same line (possibly extended over
176multiple rows) as the text cursor and on the primary screen, to reduce the
177risk of misinterpreting. The normal selection isn't disabled, so quick
178successive clicks might interfere with selection creation in harmless
179ways.
180
181=item tabbed 222=item tabbed
182 223
183This transforms the terminal into a tabbar with additional terminals, that 224This transforms the terminal into a tabbar with additional terminals, that
184is, it implements what is commonly refered to as "tabbed terminal". The topmost line 225is, it implements what is commonly referred to as "tabbed terminal". The topmost line
185displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one 226displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186button per tab. 227button per tab.
187 228
188Clicking a button will activate that tab. Pressing B<Shift-Left> and 229Clicking a button will activate that tab. Pressing B<Shift-Left> and
189B<Shift-Right> will switch to the tab left or right of the current one, 230B<Shift-Right> will switch to the tab left or right of the current one,
190while B<Shift-Down> creates a new tab. 231while B<Shift-Down> creates a new tab.
232
233The tabbar itself can be configured similarly to a normal terminal, but
234with a resource class of C<URxvt.tabbed>. In addition, it supports the
235following four resources (shown with defaults):
236
237 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239 URxvt.tabbed.tab-fg: <colour-index, default 0>
240 URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices.
191 244
192=item mark-urls 245=item mark-urls
193 246
194Uses per-line display filtering (C<on_line_update>) to underline urls and 247Uses per-line display filtering (C<on_line_update>) to underline urls and
195make them clickable. When middle-clicked, the program specified in the 248make them clickable. When middle-clicked, the program specified in the
196resource C<urlLauncher> (default C<x-www-browser>) will be started with 249resource C<urlLauncher> (default C<x-www-browser>) will be started with
197the URL as first argument. 250the URL as first argument.
198 251
252=item xim-onthespot
253
254This (experimental) perl extension implements OnTheSpot editing. It does
255not 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
257kinput2.
258
259You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.:
261
262 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264=item kuake<hotkey>
265
266A very primitive quake-console-like extension. It was inspired by a
267description of how the programs C<kuake> and C<yakuake> work: Whenever the
268user presses a global accelerator key (by default C<F10>), the terminal
269will show or hide itself. Another press of the accelerator key will hide
270or show it again.
271
272Initially, the window will not be shown when using this extension.
273
274This is useful if you need a single terminal thats not using any desktop
275space most of the time but is quickly available at the press of a key.
276
277The accelerator key is grabbed regardless of any modifiers, so this
278extension will actually grab a physical key just for this function.
279
280If you want a quake-like animation, tell your window manager to do so
281(fvwm can do it).
282
199=item automove-background 283=item automove-background
200 284
201This is basically a one-line extension that dynamically changes the background pixmap offset 285This is basically a very small extension that dynamically changes the
202to the window position, in effect creating the same effect as pseudo transparency with 286background pixmap offset to the window position, in effect creating the
203a custom pixmap. No scaling is supported in this mode. Exmaple: 287same effect as pseudo transparency with a custom pixmap. No scaling is
288supported in this mode. Example:
204 289
205 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
206 291
207=item block-graphics-to-ascii 292=item block-graphics-to-ascii
208 293
209A not very useful example of filtering all text output to the terminal, 294A not very useful example of filtering all text output to the terminal
210by replacing all line-drawing characters (U+2500 .. U+259F) by a 295by replacing all line-drawing characters (U+2500 .. U+259F) by a
211similar-looking ascii character. 296similar-looking ascii character.
212 297
213=item digital-clock 298=item digital-clock
214 299
215Displays a digital clock using the built-in overlay. 300Displays a digital clock using the built-in overlay.
216 301
217=item example-refresh-hooks 302=item remote-clipboard
218 303
219Displays a very simple digital clock in the upper right corner of the 304Somewhat of a misnomer, this extension adds two menu entries to the
220window. Illustrates overwriting the refresh callbacks to create your own 305selection popup that allows one ti run external commands to store the
221overlays or changes. 306selection somewhere and fetch it again.
307
308We use it to implement a "distributed selection mechanism", which just
309means that one command uploads the file to a remote server, and another
310reads it.
311
312The commands can be set using the C<URxvt.remote-selection.store> and
313C<URxvt.remote-selection.fetch> resources. The first should read the
314selection to store from STDIN (always in UTF-8), the second should provide
315the selection data on STDOUT (also in UTF-8).
316
317The defaults (which are likely useless to you) use rsh and cat:
318
319 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
222 321
223=item selection-pastebin 322=item selection-pastebin
224 323
225This is a little rarely useful extension that Uploads the selection as 324This is a little rarely useful extension that Uploads the selection as
226textfile to a remote site (or does other things). (The implementation is 325textfile to a remote site (or does other things). (The implementation is
246After a successful upload the selection will be replaced by the text given 345After a successful upload the selection will be replaced by the text given
247in the C<selection-pastebin-url> resource (again, the % is the placeholder 346in the C<selection-pastebin-url> resource (again, the % is the placeholder
248for the filename): 347for the filename):
249 348
250 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 349 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350
351=item example-refresh-hooks
352
353Displays a very simple digital clock in the upper right corner of the
354window. Illustrates overwriting the refresh callbacks to create your own
355overlays or changes.
251 356
252=back 357=back
253 358
254=head1 API DOCUMENTATION 359=head1 API DOCUMENTATION
255 360
289 394
290=back 395=back
291 396
292=head2 Extension Objects 397=head2 Extension Objects
293 398
294Very perl extension is a perl class. A separate perl object is created 399Every perl extension is a perl class. A separate perl object is created
295for each terminal and each extension and passed as the first parameter to 400for each terminal, and each terminal has its own set of extenion objects,
296hooks. So extensions can use their C<$self> object without having to think 401which are passed as the first parameter to hooks. So extensions can use
297about other extensions, with the exception of methods and members that 402their C<$self> object without having to think about clashes with other
403extensions or other terminals, with the exception of methods and members
298begin with an underscore character C<_>: these are reserved for internal 404that begin with an underscore character C<_>: these are reserved for
299use. 405internal use.
300 406
301Although it isn't a C<urxvt::term> object, you can call all methods of the 407Although it isn't a C<urxvt::term> object, you can call all methods of the
302C<urxvt::term> class on this object. 408C<urxvt::term> class on this object.
303 409
304It has the following methods and data members: 410It has the following methods and data members:
325=head2 Hooks 431=head2 Hooks
326 432
327The following subroutines can be declared in extension files, and will be 433The following subroutines can be declared in extension files, and will be
328called whenever the relevant event happens. 434called whenever the relevant event happens.
329 435
330The first argument passed to them is an extension oject as described in 436The first argument passed to them is an extension object as described in
331the in the C<Extension Objects> section. 437the in the C<Extension Objects> section.
332 438
333B<All> of these hooks must return a boolean value. If any of the called 439B<All> of these hooks must return a boolean value. If any of the called
334hooks returns true, then the event counts as being I<consumed>, and the 440hooks returns true, then the event counts as being I<consumed>, and the
335relevant action might not be carried out by the C++ code. 441relevant action might not be carried out by the C++ code.
348place. 454place.
349 455
350=item on_start $term 456=item on_start $term
351 457
352Called at the very end of initialisation of a new terminal, just before 458Called at the very end of initialisation of a new terminal, just before
353trying to map (display) the toplevel and returning to the mainloop. 459trying to map (display) the toplevel and returning to the main loop.
354 460
355=item on_destroy $term 461=item on_destroy $term
356 462
357Called whenever something tries to destroy terminal, before doing anything 463Called whenever something tries to destroy terminal, when the terminal is
358yet. If this hook returns true, then destruction is skipped, but this is 464still fully functional (not for long, though).
359rarely a good idea.
360 465
361=item on_reset $term 466=item on_reset $term
362 467
363Called after the screen is "reset" for any reason, such as resizing or 468Called after the screen is "reset" for any reason, such as resizing or
364control sequences. Here is where you can react on changes to size-related 469control sequences. Here is where you can react on changes to size-related
386 491
387Called whenever a selection has been copied, but before the selection is 492Called whenever a selection has been copied, but before the selection is
388requested from the server. The selection text can be queried and changed 493requested from the server. The selection text can be queried and changed
389by calling C<< $term->selection >>. 494by calling C<< $term->selection >>.
390 495
391Returning a true value aborts selection grabbing. It will still be hilighted. 496Returning a true value aborts selection grabbing. It will still be highlighted.
392 497
393=item on_sel_extend $term 498=item on_sel_extend $term
394 499
395Called whenever the user tries to extend the selection (e.g. with a double 500Called whenever the user tries to extend the selection (e.g. with a double
396click) and is either supposed to return false (normal operation), or 501click) and is either supposed to return false (normal operation), or
397should extend the selection itelf and return true to suppress the built-in 502should extend the selection itself and return true to suppress the built-in
398processing. This can happen multiple times, as long as the callback 503processing. This can happen multiple times, as long as the callback
399returns true, it will be called on every further click by the user and is 504returns true, it will be called on every further click by the user and is
400supposed to enlarge the selection more and more, if possible. 505supposed to enlarge the selection more and more, if possible.
401 506
402See the F<selection> example extension. 507See the F<selection> example extension.
403 508
404=item on_view_change $term, $offset 509=item on_view_change $term, $offset
405 510
406Called whenever the view offset changes, i..e the user or program 511Called whenever the view offset changes, i.e. the user or program
407scrolls. Offset C<0> means display the normal terminal, positive values 512scrolls. Offset C<0> means display the normal terminal, positive values
408show this many lines of scrollback. 513show this many lines of scrollback.
409 514
410=item on_scroll_back $term, $lines, $saved 515=item on_scroll_back $term, $lines, $saved
411 516
415 520
416It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 521It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
417$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 522$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
418number of lines that will be in the scrollback buffer. 523number of lines that will be in the scrollback buffer.
419 524
525=item on_osc_seq $term, $op, $args
526
527Called on every OSC sequence and can be used to suppress it or modify its
528behaviour. The default should be to return an empty list. A true value
529suppresses execution of the request completely. Make sure you don't get
530confused by recursive invocations when you output an osc sequence within
531this callback.
532
533C<on_osc_seq_perl> should be used for new behaviour.
534
420=item on_osc_seq $term, $string 535=item on_osc_seq_perl $term, $string
421 536
422Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 537Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
423operating system command) is processed. Cursor position and other state 538operating system command) is processed. Cursor position and other state
424information is up-to-date when this happens. For interoperability, the 539information is up-to-date when this happens. For interoperability, the
425string should start with the extension name and a colon, to distinguish 540string should start with the extension name and a colon, to distinguish
426it from commands for other extensions, and this might be enforced in the 541it from commands for other extensions, and this might be enforced in the
427future. 542future.
428 543
429Be careful not ever to trust (in a security sense) the data you receive, 544Be careful not ever to trust (in a security sense) the data you receive,
430as its source can not easily be controleld (e-mail content, messages from 545as its source can not easily be controlled (e-mail content, messages from
431other users on the same system etc.). 546other users on the same system etc.).
432 547
433=item on_add_lines $term, $string 548=item on_add_lines $term, $string
434 549
435Called whenever text is about to be output, with the text as argument. You 550Called whenever text is about to be output, with the text as argument. You
466 581
467=item on_refresh_end $term 582=item on_refresh_end $term
468 583
469Called just after the screen gets redrawn. See C<on_refresh_begin>. 584Called just after the screen gets redrawn. See C<on_refresh_begin>.
470 585
471=item on_keyboard_command $term, $string 586=item on_user_command $term, $string
472 587
473Called whenever the user presses a key combination that has a 588Called whenever a user-configured event is being activated (e.g. via
474C<perl:string> action bound to it (see description of the B<keysym> 589a C<perl:string> action bound to a key, see description of the B<keysym>
475resource in the @@RXVT_NAME@@(1) manpage). 590resource in the @@RXVT_NAME@@(1) manpage).
591
592The event is simply the action string. This interface is assumed to change
593slightly in the future.
594
595=item on_resize_all_windows $tern, $new_width, $new_height
596
597Called just after the new window size has been calculated, but before
598windows are actually being resized or hints are being set. If this hook
599returns TRUE, setting of the window hints is being skipped.
476 600
477=item on_x_event $term, $event 601=item on_x_event $term, $event
478 602
479Called on every X event received on the vt window (and possibly other 603Called on every X event received on the vt window (and possibly other
480windows). Should only be used as a last resort. Most event structure 604windows). Should only be used as a last resort. Most event structure
481members are not passed. 605members are not passed.
482 606
607=item on_root_event $term, $event
608
609Like C<on_x_event>, but is called for events on the root window.
610
483=item on_focus_in $term 611=item on_focus_in $term
484 612
485Called whenever the window gets the keyboard focus, before rxvt-unicode 613Called whenever the window gets the keyboard focus, before rxvt-unicode
486does focus in processing. 614does focus in processing.
487 615
488=item on_focus_out $term 616=item on_focus_out $term
489 617
490Called wheneever the window loses keyboard focus, before rxvt-unicode does 618Called whenever the window loses keyboard focus, before rxvt-unicode does
491focus out processing. 619focus out processing.
492 620
493=item on_configure_notify $term, $event 621=item on_configure_notify $term, $event
494 622
495=item on_property_notify $term, $event 623=item on_property_notify $term, $event
552our $LIBDIR; 680our $LIBDIR;
553our $RESNAME; 681our $RESNAME;
554our $RESCLASS; 682our $RESCLASS;
555our $RXVTNAME; 683our $RXVTNAME;
556 684
557our $NOCHAR = chr 0xfffe; 685our $NOCHAR = chr 0xffff;
558 686
559=head2 Variables in the C<urxvt> Package 687=head2 Variables in the C<urxvt> Package
560 688
561=over 4 689=over 4
562 690
578The current terminal. This variable stores the current C<urxvt::term> 706The current terminal. This variable stores the current C<urxvt::term>
579object, whenever a callback/hook is executing. 707object, whenever a callback/hook is executing.
580 708
581=item @urxvt::TERM_INIT 709=item @urxvt::TERM_INIT
582 710
583All coderefs in this array will be called as methods of the next newly 711All code references in this array will be called as methods of the next newly
584created C<urxvt::term> object (during the C<on_init> phase). The array 712created C<urxvt::term> object (during the C<on_init> phase). The array
585gets cleared before the codereferences that were in it are being executed, 713gets cleared before the code references that were in it are being executed,
586so coderefs can push themselves onto it again if they so desire. 714so references can push themselves onto it again if they so desire.
587 715
588This complements to the perl-eval commandline option, but gets executed 716This complements to the perl-eval command line option, but gets executed
589first. 717first.
590 718
591=item @urxvt::TERM_EXT 719=item @urxvt::TERM_EXT
592 720
593Works similar to C<@TERM_INIT>, but contains perl package/class names, which 721Works similar to C<@TERM_INIT>, but contains perl package/class names, which
614 742
615Using this function has the advantage that its output ends up in the 743Using this function has the advantage that its output ends up in the
616correct place, e.g. on stderr of the connecting urxvtc client. 744correct place, e.g. on stderr of the connecting urxvtc client.
617 745
618Messages have a size limit of 1023 bytes currently. 746Messages have a size limit of 1023 bytes currently.
747
748=item @terms = urxvt::termlist
749
750Returns all urxvt::term objects that exist in this process, regardless of
751whether they are started, being destroyed etc., so be careful. Only term
752objects that have perl extensions attached will be returned (because there
753is no urxvt::term objet associated with others).
619 754
620=item $time = urxvt::NOW 755=item $time = urxvt::NOW
621 756
622Returns the "current time" (as per the event loop). 757Returns the "current time" (as per the event loop).
623 758
681Return the foreground/background colour index, respectively. 816Return the foreground/background colour index, respectively.
682 817
683=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 818=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
684 819
685=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 820=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
821
822=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
686 823
687Replace the foreground/background colour in the rendition mask with the 824Replace the foreground/background colour in the rendition mask with the
688specified one. 825specified one.
689 826
690=item $value = urxvt::GET_CUSTOM $rend 827=item $value = urxvt::GET_CUSTOM $rend
709 unless $msg =~ /\n$/; 846 unless $msg =~ /\n$/;
710 urxvt::warn ($msg); 847 urxvt::warn ($msg);
711 }; 848 };
712} 849}
713 850
851no warnings 'utf8';
852
714my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 853my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715 854
716sub verbose { 855sub verbose {
717 my ($level, $msg) = @_; 856 my ($level, $msg) = @_;
718 warn "$msg\n" if $level <= $verbosity; 857 warn "$msg\n" if $level <= $verbosity;
734 873
735 open my $fh, "<:raw", $path 874 open my $fh, "<:raw", $path
736 or die "$path: $!"; 875 or die "$path: $!";
737 876
738 my $source = 877 my $source =
739 "package $pkg; use strict; use utf8;\n" 878 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
740 . "#line 1 \"$path\"\n{\n" 879 . "#line 1 \"$path\"\n{\n"
741 . (do { local $/; <$fh> }) 880 . (do { local $/; <$fh> })
742 . "\n};\n1"; 881 . "\n};\n1";
743 882
744 eval $source 883 eval $source
769 $TERM->register_package ($_) for @pkg; 908 $TERM->register_package ($_) for @pkg;
770 } 909 }
771 910
772 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 911 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
773 if ($_ eq "default") { 912 if ($_ eq "default") {
774 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 913 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
775 } elsif (/^-(.*)$/) { 914 } elsif (/^-(.*)$/) {
776 delete $ext_arg{$1}; 915 delete $ext_arg{$1};
777 } elsif (/^([^<]+)<(.*)>$/) { 916 } elsif (/^([^<]+)<(.*)>$/) {
778 push @{ $ext_arg{$1} }, $2; 917 push @{ $ext_arg{$1} }, $2;
779 } else { 918 } else {
780 $ext_arg{$_} ||= []; 919 $ext_arg{$_} ||= [];
781 } 920 }
782 } 921 }
783 922
784 while (my ($ext, $argv) = each %ext_arg) { 923 for my $ext (sort keys %ext_arg) {
785 my @files = grep -f $_, map "$_/$ext", @dirs; 924 my @files = grep -f $_, map "$_/$ext", @dirs;
786 925
787 if (@files) { 926 if (@files) {
788 $TERM->register_package (extension_package $files[0], $argv); 927 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
789 } else { 928 } else {
790 warn "perl extension '$ext' not found in perl library search path\n"; 929 warn "perl extension '$ext' not found in perl library search path\n";
791 } 930 }
792 } 931 }
793 932
799 938
800 if (my $cb = $TERM->{_hook}[$htype]) { 939 if (my $cb = $TERM->{_hook}[$htype]) {
801 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 940 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
802 if $verbosity >= 10; 941 if $verbosity >= 10;
803 942
804 keys %$cb; 943 for my $pkg (keys %$cb) {
805
806 while (my ($pkg, $cb) = each %$cb) {
807 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 944 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
808 $retval ||= $retval_; 945 $retval ||= $retval_;
809 946
810 if ($@) { 947 if ($@) {
811 $TERM->ungrab; # better to lose the grab than the session 948 $TERM->ungrab; # better to lose the grab than the session
812 warn $@; 949 warn $@;
824 # clear package 961 # clear package
825 %$TERM = (); 962 %$TERM = ();
826 } 963 }
827 964
828 $retval 965 $retval
966}
967
968sub SET_COLOR($$$) {
969 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
829} 970}
830 971
831# urxvt::term::extension 972# urxvt::term::extension
832 973
833package urxvt::term::extension; 974package urxvt::term::extension;
1002hash which defines the environment of the new terminal. 1143hash which defines the environment of the new terminal.
1003 1144
1004Croaks (and probably outputs an error message) if the new instance 1145Croaks (and probably outputs an error message) if the new instance
1005couldn't be created. Returns C<undef> if the new instance didn't 1146couldn't be created. Returns C<undef> if the new instance didn't
1006initialise perl, and the terminal object otherwise. The C<init> and 1147initialise perl, and the terminal object otherwise. The C<init> and
1007C<start> hooks will be called during this call. 1148C<start> hooks will be called before this call returns, and are free to
1149refer to global data (which is race free).
1008 1150
1009=cut 1151=cut
1010 1152
1011sub new { 1153sub new {
1012 my ($class, $env, @args) = @_; 1154 my ($class, $env, @args) = @_;
1013 1155
1156 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1157 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1158
1014 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1159 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1015} 1160}
1016 1161
1017=item $term->destroy 1162=item $term->destroy
1018 1163
1019Destroy the terminal object (close the window, free resources 1164Destroy the terminal object (close the window, free resources
1049 1194
1050Returns true if the option specified by C<$optval> is enabled, and 1195Returns true if the option specified by C<$optval> is enabled, and
1051optionally change it. All option values are stored by name in the hash 1196optionally change it. All option values are stored by name in the hash
1052C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1197C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1053 1198
1054Here is a a likely non-exhaustive list of option names, please see the 1199Here is a likely non-exhaustive list of option names, please see the
1055source file F</src/optinc.h> to see the actual list: 1200source file F</src/optinc.h> to see the actual list:
1056 1201
1057 borderLess console cursorBlink cursorUnderline hold iconic insecure 1202 borderLess console cursorBlink cursorUnderline hold iconic insecure
1058 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1203 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1059 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1204 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1076likely change). 1221likely change).
1077 1222
1078Please note that resource strings will currently only be freed when the 1223Please note that resource strings will currently only be freed when the
1079terminal is destroyed, so changing options frequently will eat memory. 1224terminal is destroyed, so changing options frequently will eat memory.
1080 1225
1081Here is a a likely non-exhaustive list of resource names, not all of which 1226Here is a likely non-exhaustive list of resource names, not all of which
1082are supported in every build, please see the source file F</src/rsinc.h> 1227are supported in every build, please see the source file F</src/rsinc.h>
1083to see the actual list: 1228to see the actual list:
1084 1229
1085 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1230 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1086 borderLess color cursorBlink cursorUnderline cutchars delete_key 1231 borderLess color cursorBlink cursorUnderline cutchars delete_key
1299Replaces the event mask of the pty watcher by the given event mask. Can 1444Replaces the event mask of the pty watcher by the given event mask. Can
1300be used to suppress input and output handling to the pty/tty. See the 1445be used to suppress input and output handling to the pty/tty. See the
1301description of C<< urxvt::timer->events >>. Make sure to always restore 1446description of C<< urxvt::timer->events >>. Make sure to always restore
1302the previous value. 1447the previous value.
1303 1448
1449=item $fd = $term->pty_fd
1450
1451Returns the master file descriptor for the pty in use, or C<-1> if no pty
1452is used.
1453
1304=item $windowid = $term->parent 1454=item $windowid = $term->parent
1305 1455
1306Return the window id of the toplevel window. 1456Return the window id of the toplevel window.
1307 1457
1308=item $windowid = $term->vt 1458=item $windowid = $term->vt
1314Adds the specified events to the vt event mask. Useful e.g. when you want 1464Adds the specified events to the vt event mask. Useful e.g. when you want
1315to receive pointer events all the times: 1465to receive pointer events all the times:
1316 1466
1317 $term->vt_emask_add (urxvt::PointerMotionMask); 1467 $term->vt_emask_add (urxvt::PointerMotionMask);
1318 1468
1469=item $term->focus_in
1470
1471=item $term->focus_out
1472
1473=item $term->key_press ($state, $keycode[, $time])
1474
1475=item $term->key_release ($state, $keycode[, $time])
1476
1477Deliver various fake events to to terminal.
1478
1319=item $window_width = $term->width 1479=item $window_width = $term->width
1320 1480
1321=item $window_height = $term->height 1481=item $window_height = $term->height
1322 1482
1323=item $font_width = $term->fwidth 1483=item $font_width = $term->fwidth
1353=item $env = $term->env 1513=item $env = $term->env
1354 1514
1355Returns a copy of the environment in effect for the terminal as a hashref 1515Returns a copy of the environment in effect for the terminal as a hashref
1356similar to C<\%ENV>. 1516similar to C<\%ENV>.
1357 1517
1518=item @envv = $term->envv
1519
1520Returns the environment as array of strings of the form C<VAR=VALUE>.
1521
1522=item @argv = $term->argv
1523
1524Return the argument vector as this terminal, similar to @ARGV, but
1525includes the program name as first element.
1526
1358=cut 1527=cut
1359 1528
1360sub env { 1529sub env {
1361 if (my $env = $_[0]->_env) {
1362 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1530 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1363 } else {
1364 +{ %ENV }
1365 }
1366} 1531}
1367 1532
1368=item $modifiermask = $term->ModLevel3Mask 1533=item $modifiermask = $term->ModLevel3Mask
1369 1534
1370=item $modifiermask = $term->ModMetaMask 1535=item $modifiermask = $term->ModMetaMask
1375AltGr), the meta key (often Alt) and the num lock key, if applicable. 1540AltGr), the meta key (often Alt) and the num lock key, if applicable.
1376 1541
1377=item $screen = $term->current_screen 1542=item $screen = $term->current_screen
1378 1543
1379Returns the currently displayed screen (0 primary, 1 secondary). 1544Returns the currently displayed screen (0 primary, 1 secondary).
1545
1546=item $cursor_is_hidden = $term->hidden_cursor
1547
1548Returns whether the cursor is currently hidden or not.
1380 1549
1381=item $view_start = $term->view_start ([$newvalue]) 1550=item $view_start = $term->view_start ([$newvalue])
1382 1551
1383Returns the row number of the topmost displayed line. Maximum value is 1552Returns the row number of the topmost displayed line. Maximum value is
1384C<0>, which displays the normal terminal contents. Lower values scroll 1553C<0>, which displays the normal terminal contents. Lower values scroll
1403If C<$new_text> is specified, it will replace characters in the current 1572If C<$new_text> is specified, it will replace characters in the current
1404line, starting at column C<$start_col> (default C<0>), which is useful 1573line, starting at column C<$start_col> (default C<0>), which is useful
1405to replace only parts of a line. The font index in the rendition will 1574to replace only parts of a line. The font index in the rendition will
1406automatically be updated. 1575automatically be updated.
1407 1576
1408C<$text> is in a special encoding: tabs and wide characters that use 1577C<$text> is in a special encoding: tabs and wide characters that use more
1409more than one cell when displayed are padded with C<$urxvt::NOCHAR> 1578than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410characters. Characters with combining characters and other characters that 1579characters. Characters with combining characters and other characters that
1411do not fit into the normal tetx encoding will be replaced with characters 1580do not fit into the normal tetx encoding will be replaced with characters
1412in the private use area. 1581in the private use area.
1413 1582
1414You have to obey this encoding when changing text. The advantage is 1583You have to obey this encoding when changing text. The advantage is
1561where one character corresponds to one screen cell. See 1730where one character corresponds to one screen cell. See
1562C<< $term->ROW_t >> for details. 1731C<< $term->ROW_t >> for details.
1563 1732
1564=item $string = $term->special_decode $text 1733=item $string = $term->special_decode $text
1565 1734
1566Converts rxvt-unicodes text reprsentation into a perl string. See 1735Converts rxvt-unicodes text representation into a perl string. See
1567C<< $term->ROW_t >> for details. 1736C<< $term->ROW_t >> for details.
1568 1737
1569=item $success = $term->grab_button ($button, $modifiermask) 1738=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1570 1739
1740=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1741
1571Registers a synchronous button grab. See the XGrabButton manpage. 1742Register/unregister a synchronous button grab. See the XGrabButton
1743manpage.
1572 1744
1573=item $success = $term->grab ($eventtime[, $sync]) 1745=item $success = $term->grab ($eventtime[, $sync])
1574 1746
1575Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1747Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576synchronous (C<$sync> is true). Also remembers the grab timestampe. 1748synchronous (C<$sync> is true). Also remembers the grab timestamp.
1577 1749
1578=item $term->allow_events_async 1750=item $term->allow_events_async
1579 1751
1580Calls XAllowEvents with AsyncBoth for the most recent grab. 1752Calls XAllowEvents with AsyncBoth for the most recent grab.
1581 1753
1694 my ($self, $text, $cb) = @_; 1866 my ($self, $text, $cb) = @_;
1695 1867
1696 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1868 $self->add_item ({ type => "button", text => $text, activate => $cb});
1697} 1869}
1698 1870
1699=item $popup->add_toggle ($text, $cb, $initial_value) 1871=item $popup->add_toggle ($text, $initial_value, $cb)
1700 1872
1701Adds a toggle/checkbox item to the popup. Teh callback gets called 1873Adds a toggle/checkbox item to the popup. The callback gets called
1702whenever it gets toggled, with a boolean indicating its value as its first 1874whenever it gets toggled, with a boolean indicating its new value as its
1703argument. 1875first argument.
1704 1876
1705=cut 1877=cut
1706 1878
1707sub add_toggle { 1879sub add_toggle {
1708 my ($self, $text, $cb, $value) = @_; 1880 my ($self, $text, $value, $cb) = @_;
1709 1881
1710 my $item; $item = { 1882 my $item; $item = {
1711 type => "button", 1883 type => "button",
1712 text => " $text", 1884 text => " $text",
1713 value => $value, 1885 value => $value,
1848Set the callback to be called when io events are triggered. C<$reventmask> 2020Set the callback to be called when io events are triggered. C<$reventmask>
1849is a bitset as described in the C<events> method. 2021is a bitset as described in the C<events> method.
1850 2022
1851=item $iow = $iow->fd ($fd) 2023=item $iow = $iow->fd ($fd)
1852 2024
1853Set the filedescriptor (not handle) to watch. 2025Set the file descriptor (not handle) to watch.
1854 2026
1855=item $iow = $iow->events ($eventmask) 2027=item $iow = $iow->events ($eventmask)
1856 2028
1857Set the event mask to watch. The only allowed values are 2029Set the event mask to watch. The only allowed values are
1858C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2030C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1862 2034
1863Start watching for requested events on the given handle. 2035Start watching for requested events on the given handle.
1864 2036
1865=item $iow = $iow->stop 2037=item $iow = $iow->stop
1866 2038
1867Stop watching for events on the given filehandle. 2039Stop watching for events on the given file handle.
1868 2040
1869=back 2041=back
1870 2042
1871=head2 The C<urxvt::iw> Class 2043=head2 The C<urxvt::iw> Class
1872 2044
1919 2091
1920Set the callback to be called when the timer triggers. 2092Set the callback to be called when the timer triggers.
1921 2093
1922=item $pw = $timer->start ($pid) 2094=item $pw = $timer->start ($pid)
1923 2095
1924Tells the wqtcher to start watching for process C<$pid>. 2096Tells the watcher to start watching for process C<$pid>.
1925 2097
1926=item $pw = $pw->stop 2098=item $pw = $pw->stop
1927 2099
1928Stop the watcher. 2100Stop the watcher.
1929 2101
1942 2114
1943=item >= 3 - script loading and management 2115=item >= 3 - script loading and management
1944 2116
1945=item >=10 - all called hooks 2117=item >=10 - all called hooks
1946 2118
1947=item >=11 - hook reutrn values 2119=item >=11 - hook return values
1948 2120
1949=back 2121=back
1950 2122
1951=head1 AUTHOR 2123=head1 AUTHOR
1952 2124

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines