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.124 by root, Sun Jan 22 11:57:06 2006 UTC vs.
Revision 1.151 by root, Thu Dec 14 17:22:04 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
132=item readline (enabled by default) 162=item readline (enabled by default)
133 163
134A support package that tries to make editing with readline easier. At the 164A support package that tries to make editing with readline easier. At
135moment, it reacts to clicking with the left mouse button by trying to 165the moment, it reacts to clicking shift-left mouse button by trying to
136move the text cursor to this position. It does so by generating as many 166move the text cursor to this position. It does so by generating as many
137cursor-left or cursor-right keypresses as required (the this only works 167cursor-left or cursor-right keypresses as required (the this only works
138for programs that correctly support wide characters). 168for programs that correctly support wide characters).
139 169
140To avoid too many false positives, this is only done when: 170To avoid too many false positives, this is only done when:
141 171
142=over 4 172=over 4
143 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
144=item - the mouse is on the same (multi-row-) line as the text cursor. 180=item - the mouse is on the same (multi-row-) line as the text cursor.
145
146=item - the primary screen is currently being displayed.
147
148=item - the text cursor is visible.
149 181
150=back 182=back
151 183
152The normal selection mechanism isn't disabled, so quick successive clicks 184The normal selection mechanism isn't disabled, so quick successive clicks
153might interfere with selection creation in harmless ways. 185might interfere with selection creation in harmless ways.
188the message into vi commands to load the file. 220the message into vi commands to load the file.
189 221
190=item tabbed 222=item tabbed
191 223
192This transforms the terminal into a tabbar with additional terminals, that 224This transforms the terminal into a tabbar with additional terminals, that
193is, 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
194displays 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
195button per tab. 227button per tab.
196 228
197Clicking a button will activate that tab. Pressing B<Shift-Left> and 229Clicking a button will activate that tab. Pressing B<Shift-Left> and
198B<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,
199while B<Shift-Down> creates a new tab. 231while B<Shift-Down> creates a new tab.
200 232
201=item mark-urls 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):
202 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.
244
245=item matcher
246
203Uses per-line display filtering (C<on_line_update>) to underline urls and 247Uses per-line display filtering (C<on_line_update>) to underline text
204make them clickable. When middle-clicked, the program specified in the 248matching a certain pattern and make it clickable. When clicked with the
205resource C<urlLauncher> (default C<x-www-browser>) will be started with 249mouse button specified in the C<matcher.button> resource (default 2, or
206the URL as first argument. 250middle), the program specified in the C<matcher.launcher> resource
251(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
252with the matched text as first argument. The default configuration is
253suitable for matching URLs and launching a web browser, like the
254former "mark-urls" extension.
255
256The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis.
260
261Example configuration:
262
263 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser
265 URxvt.matcher.button: 1
266 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
268 URxvt.matcher.launcher.2: gvim +$2 $1
269
270=item xim-onthespot
271
272This (experimental) perl extension implements OnTheSpot editing. It does
273not work perfectly, and some input methods don't seem to work well with
274OnTheSpot editing in general, but it seems to work at leats for SCIM and
275kinput2.
276
277You enable it by specifying this extension and a preedit style of
278C<OnTheSpot>, i.e.:
279
280 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
281
282=item kuake<hotkey>
283
284A very primitive quake-console-like extension. It was inspired by a
285description of how the programs C<kuake> and C<yakuake> work: Whenever the
286user presses a global accelerator key (by default C<F10>), the terminal
287will show or hide itself. Another press of the accelerator key will hide
288or show it again.
289
290Initially, the window will not be shown when using this extension.
291
292This is useful if you need a single terminal thats not using any desktop
293space most of the time but is quickly available at the press of a key.
294
295The accelerator key is grabbed regardless of any modifiers, so this
296extension will actually grab a physical key just for this function.
297
298If you want a quake-like animation, tell your window manager to do so
299(fvwm can do it).
207 300
208=item automove-background 301=item automove-background
209 302
210This is basically a one-line extension that dynamically changes the background pixmap offset 303This is basically a very small extension that dynamically changes the
211to the window position, in effect creating the same effect as pseudo transparency with 304background pixmap offset to the window position, in effect creating the
212a custom pixmap. No scaling is supported in this mode. Exmaple: 305same effect as pseudo transparency with a custom pixmap. No scaling is
306supported in this mode. Example:
213 307
214 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 308 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
215 309
216=item block-graphics-to-ascii 310=item block-graphics-to-ascii
217 311
218A not very useful example of filtering all text output to the terminal, 312A not very useful example of filtering all text output to the terminal
219by replacing all line-drawing characters (U+2500 .. U+259F) by a 313by replacing all line-drawing characters (U+2500 .. U+259F) by a
220similar-looking ascii character. 314similar-looking ascii character.
221 315
222=item digital-clock 316=item digital-clock
223 317
224Displays a digital clock using the built-in overlay. 318Displays a digital clock using the built-in overlay.
225 319
226=item example-refresh-hooks 320=item remote-clipboard
227 321
228Displays a very simple digital clock in the upper right corner of the 322Somewhat of a misnomer, this extension adds two menu entries to the
229window. Illustrates overwriting the refresh callbacks to create your own 323selection popup that allows one ti run external commands to store the
230overlays or changes. 324selection somewhere and fetch it again.
325
326We use it to implement a "distributed selection mechanism", which just
327means that one command uploads the file to a remote server, and another
328reads it.
329
330The commands can be set using the C<URxvt.remote-selection.store> and
331C<URxvt.remote-selection.fetch> resources. The first should read the
332selection to store from STDIN (always in UTF-8), the second should provide
333the selection data on STDOUT (also in UTF-8).
334
335The defaults (which are likely useless to you) use rsh and cat:
336
337 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
231 339
232=item selection-pastebin 340=item selection-pastebin
233 341
234This is a little rarely useful extension that Uploads the selection as 342This is a little rarely useful extension that Uploads the selection as
235textfile to a remote site (or does other things). (The implementation is 343textfile to a remote site (or does other things). (The implementation is
255After a successful upload the selection will be replaced by the text given 363After a successful upload the selection will be replaced by the text given
256in the C<selection-pastebin-url> resource (again, the % is the placeholder 364in the C<selection-pastebin-url> resource (again, the % is the placeholder
257for the filename): 365for the filename):
258 366
259 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 367 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368
369I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
370the double C</> characters as comment start. Use C<\057\057> instead,
371which works regardless of wether xrdb is used to parse the resource file
372or not.
373
374=item example-refresh-hooks
375
376Displays a very simple digital clock in the upper right corner of the
377window. Illustrates overwriting the refresh callbacks to create your own
378overlays or changes.
260 379
261=back 380=back
262 381
263=head1 API DOCUMENTATION 382=head1 API DOCUMENTATION
264 383
298 417
299=back 418=back
300 419
301=head2 Extension Objects 420=head2 Extension Objects
302 421
303Very perl extension is a perl class. A separate perl object is created 422Every perl extension is a perl class. A separate perl object is created
304for each terminal and each extension and passed as the first parameter to 423for each terminal, and each terminal has its own set of extenion objects,
305hooks. So extensions can use their C<$self> object without having to think 424which are passed as the first parameter to hooks. So extensions can use
306about other extensions, with the exception of methods and members that 425their C<$self> object without having to think about clashes with other
426extensions or other terminals, with the exception of methods and members
307begin with an underscore character C<_>: these are reserved for internal 427that begin with an underscore character C<_>: these are reserved for
308use. 428internal use.
309 429
310Although it isn't a C<urxvt::term> object, you can call all methods of the 430Although it isn't a C<urxvt::term> object, you can call all methods of the
311C<urxvt::term> class on this object. 431C<urxvt::term> class on this object.
312 432
313It has the following methods and data members: 433It has the following methods and data members:
334=head2 Hooks 454=head2 Hooks
335 455
336The following subroutines can be declared in extension files, and will be 456The following subroutines can be declared in extension files, and will be
337called whenever the relevant event happens. 457called whenever the relevant event happens.
338 458
339The first argument passed to them is an extension oject as described in 459The first argument passed to them is an extension object as described in
340the in the C<Extension Objects> section. 460the in the C<Extension Objects> section.
341 461
342B<All> of these hooks must return a boolean value. If any of the called 462B<All> of these hooks must return a boolean value. If any of the called
343hooks returns true, then the event counts as being I<consumed>, and the 463hooks returns true, then the event counts as being I<consumed>, and the
344relevant action might not be carried out by the C++ code. 464relevant action might not be carried out by the C++ code.
357place. 477place.
358 478
359=item on_start $term 479=item on_start $term
360 480
361Called at the very end of initialisation of a new terminal, just before 481Called at the very end of initialisation of a new terminal, just before
362trying to map (display) the toplevel and returning to the mainloop. 482trying to map (display) the toplevel and returning to the main loop.
363 483
364=item on_destroy $term 484=item on_destroy $term
365 485
366Called whenever something tries to destroy terminal, before doing anything 486Called whenever something tries to destroy terminal, when the terminal is
367yet. If this hook returns true, then destruction is skipped, but this is 487still fully functional (not for long, though).
368rarely a good idea.
369 488
370=item on_reset $term 489=item on_reset $term
371 490
372Called after the screen is "reset" for any reason, such as resizing or 491Called after the screen is "reset" for any reason, such as resizing or
373control sequences. Here is where you can react on changes to size-related 492control sequences. Here is where you can react on changes to size-related
395 514
396Called whenever a selection has been copied, but before the selection is 515Called whenever a selection has been copied, but before the selection is
397requested from the server. The selection text can be queried and changed 516requested from the server. The selection text can be queried and changed
398by calling C<< $term->selection >>. 517by calling C<< $term->selection >>.
399 518
400Returning a true value aborts selection grabbing. It will still be hilighted. 519Returning a true value aborts selection grabbing. It will still be highlighted.
401 520
402=item on_sel_extend $term 521=item on_sel_extend $term
403 522
404Called whenever the user tries to extend the selection (e.g. with a double 523Called whenever the user tries to extend the selection (e.g. with a double
405click) and is either supposed to return false (normal operation), or 524click) and is either supposed to return false (normal operation), or
406should extend the selection itelf and return true to suppress the built-in 525should extend the selection itself and return true to suppress the built-in
407processing. This can happen multiple times, as long as the callback 526processing. This can happen multiple times, as long as the callback
408returns true, it will be called on every further click by the user and is 527returns true, it will be called on every further click by the user and is
409supposed to enlarge the selection more and more, if possible. 528supposed to enlarge the selection more and more, if possible.
410 529
411See the F<selection> example extension. 530See the F<selection> example extension.
412 531
413=item on_view_change $term, $offset 532=item on_view_change $term, $offset
414 533
415Called whenever the view offset changes, i..e the user or program 534Called whenever the view offset changes, i.e. the user or program
416scrolls. Offset C<0> means display the normal terminal, positive values 535scrolls. Offset C<0> means display the normal terminal, positive values
417show this many lines of scrollback. 536show this many lines of scrollback.
418 537
419=item on_scroll_back $term, $lines, $saved 538=item on_scroll_back $term, $lines, $saved
420 539
424 543
425It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 544It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
426$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 545$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
427number of lines that will be in the scrollback buffer. 546number of lines that will be in the scrollback buffer.
428 547
548=item on_osc_seq $term, $op, $args
549
550Called on every OSC sequence and can be used to suppress it or modify its
551behaviour. The default should be to return an empty list. A true value
552suppresses execution of the request completely. Make sure you don't get
553confused by recursive invocations when you output an osc sequence within
554this callback.
555
556C<on_osc_seq_perl> should be used for new behaviour.
557
429=item on_osc_seq $term, $string 558=item on_osc_seq_perl $term, $string
430 559
431Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 560Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432operating system command) is processed. Cursor position and other state 561operating system command) is processed. Cursor position and other state
433information is up-to-date when this happens. For interoperability, the 562information is up-to-date when this happens. For interoperability, the
434string should start with the extension name and a colon, to distinguish 563string should start with the extension name and a colon, to distinguish
435it from commands for other extensions, and this might be enforced in the 564it from commands for other extensions, and this might be enforced in the
436future. 565future.
437 566
438Be careful not ever to trust (in a security sense) the data you receive, 567Be careful not ever to trust (in a security sense) the data you receive,
439as its source can not easily be controleld (e-mail content, messages from 568as its source can not easily be controlled (e-mail content, messages from
440other users on the same system etc.). 569other users on the same system etc.).
441 570
442=item on_add_lines $term, $string 571=item on_add_lines $term, $string
443 572
444Called whenever text is about to be output, with the text as argument. You 573Called whenever text is about to be output, with the text as argument. You
475 604
476=item on_refresh_end $term 605=item on_refresh_end $term
477 606
478Called just after the screen gets redrawn. See C<on_refresh_begin>. 607Called just after the screen gets redrawn. See C<on_refresh_begin>.
479 608
480=item on_keyboard_command $term, $string 609=item on_user_command $term, $string
481 610
482Called whenever the user presses a key combination that has a 611Called whenever a user-configured event is being activated (e.g. via
483C<perl:string> action bound to it (see description of the B<keysym> 612a C<perl:string> action bound to a key, see description of the B<keysym>
484resource in the @@RXVT_NAME@@(1) manpage). 613resource in the @@RXVT_NAME@@(1) manpage).
614
615The event is simply the action string. This interface is assumed to change
616slightly in the future.
617
618=item on_resize_all_windows $tern, $new_width, $new_height
619
620Called just after the new window size has been calculated, but before
621windows are actually being resized or hints are being set. If this hook
622returns TRUE, setting of the window hints is being skipped.
485 623
486=item on_x_event $term, $event 624=item on_x_event $term, $event
487 625
488Called on every X event received on the vt window (and possibly other 626Called on every X event received on the vt window (and possibly other
489windows). Should only be used as a last resort. Most event structure 627windows). Should only be used as a last resort. Most event structure
490members are not passed. 628members are not passed.
491 629
630=item on_root_event $term, $event
631
632Like C<on_x_event>, but is called for events on the root window.
633
492=item on_focus_in $term 634=item on_focus_in $term
493 635
494Called whenever the window gets the keyboard focus, before rxvt-unicode 636Called whenever the window gets the keyboard focus, before rxvt-unicode
495does focus in processing. 637does focus in processing.
496 638
497=item on_focus_out $term 639=item on_focus_out $term
498 640
499Called wheneever the window loses keyboard focus, before rxvt-unicode does 641Called whenever the window loses keyboard focus, before rxvt-unicode does
500focus out processing. 642focus out processing.
501 643
502=item on_configure_notify $term, $event 644=item on_configure_notify $term, $event
503 645
504=item on_property_notify $term, $event 646=item on_property_notify $term, $event
587The current terminal. This variable stores the current C<urxvt::term> 729The current terminal. This variable stores the current C<urxvt::term>
588object, whenever a callback/hook is executing. 730object, whenever a callback/hook is executing.
589 731
590=item @urxvt::TERM_INIT 732=item @urxvt::TERM_INIT
591 733
592All coderefs in this array will be called as methods of the next newly 734All code references in this array will be called as methods of the next newly
593created C<urxvt::term> object (during the C<on_init> phase). The array 735created C<urxvt::term> object (during the C<on_init> phase). The array
594gets cleared before the codereferences that were in it are being executed, 736gets cleared before the code references that were in it are being executed,
595so coderefs can push themselves onto it again if they so desire. 737so references can push themselves onto it again if they so desire.
596 738
597This complements to the perl-eval commandline option, but gets executed 739This complements to the perl-eval command line option, but gets executed
598first. 740first.
599 741
600=item @urxvt::TERM_EXT 742=item @urxvt::TERM_EXT
601 743
602Works similar to C<@TERM_INIT>, but contains perl package/class names, which 744Works similar to C<@TERM_INIT>, but contains perl package/class names, which
623 765
624Using this function has the advantage that its output ends up in the 766Using this function has the advantage that its output ends up in the
625correct place, e.g. on stderr of the connecting urxvtc client. 767correct place, e.g. on stderr of the connecting urxvtc client.
626 768
627Messages have a size limit of 1023 bytes currently. 769Messages have a size limit of 1023 bytes currently.
770
771=item @terms = urxvt::termlist
772
773Returns all urxvt::term objects that exist in this process, regardless of
774whether they are started, being destroyed etc., so be careful. Only term
775objects that have perl extensions attached will be returned (because there
776is no urxvt::term objet associated with others).
628 777
629=item $time = urxvt::NOW 778=item $time = urxvt::NOW
630 779
631Returns the "current time" (as per the event loop). 780Returns the "current time" (as per the event loop).
632 781
690Return the foreground/background colour index, respectively. 839Return the foreground/background colour index, respectively.
691 840
692=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 841=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693 842
694=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 843=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
844
845=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
695 846
696Replace the foreground/background colour in the rendition mask with the 847Replace the foreground/background colour in the rendition mask with the
697specified one. 848specified one.
698 849
699=item $value = urxvt::GET_CUSTOM $rend 850=item $value = urxvt::GET_CUSTOM $rend
790 } else { 941 } else {
791 $ext_arg{$_} ||= []; 942 $ext_arg{$_} ||= [];
792 } 943 }
793 } 944 }
794 945
795 while (my ($ext, $argv) = each %ext_arg) { 946 for my $ext (sort keys %ext_arg) {
796 my @files = grep -f $_, map "$_/$ext", @dirs; 947 my @files = grep -f $_, map "$_/$ext", @dirs;
797 948
798 if (@files) { 949 if (@files) {
799 $TERM->register_package (extension_package $files[0], $argv); 950 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
800 } else { 951 } else {
801 warn "perl extension '$ext' not found in perl library search path\n"; 952 warn "perl extension '$ext' not found in perl library search path\n";
802 } 953 }
803 } 954 }
804 955
810 961
811 if (my $cb = $TERM->{_hook}[$htype]) { 962 if (my $cb = $TERM->{_hook}[$htype]) {
812 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 963 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
813 if $verbosity >= 10; 964 if $verbosity >= 10;
814 965
815 keys %$cb; 966 for my $pkg (keys %$cb) {
816
817 while (my ($pkg, $cb) = each %$cb) {
818 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 967 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
819 $retval ||= $retval_; 968 $retval ||= $retval_;
820 969
821 if ($@) { 970 if ($@) {
822 $TERM->ungrab; # better to lose the grab than the session 971 $TERM->ungrab; # better to lose the grab than the session
823 warn $@; 972 warn $@;
835 # clear package 984 # clear package
836 %$TERM = (); 985 %$TERM = ();
837 } 986 }
838 987
839 $retval 988 $retval
989}
990
991sub SET_COLOR($$$) {
992 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
840} 993}
841 994
842# urxvt::term::extension 995# urxvt::term::extension
843 996
844package urxvt::term::extension; 997package urxvt::term::extension;
957sub DESTROY { 1110sub DESTROY {
958 $_[0][1]->stop; 1111 $_[0][1]->stop;
959} 1112}
960 1113
961sub condvar { 1114sub condvar {
962 bless \my $flag, urxvt::anyevent::condvar:: 1115 bless \my $flag, urxvt::anyevent::
963} 1116}
964 1117
965sub urxvt::anyevent::condvar::broadcast { 1118sub broadcast {
966 ${$_[0]}++; 1119 ${$_[0]}++;
967} 1120}
968 1121
969sub urxvt::anyevent::condvar::wait { 1122sub wait {
970 unless (${$_[0]}) { 1123 unless (${$_[0]}) {
971 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1124 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
972 } 1125 }
1126}
1127
1128sub one_event {
1129 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
973} 1130}
974 1131
975package urxvt::term; 1132package urxvt::term;
976 1133
977=head2 The C<urxvt::term> Class 1134=head2 The C<urxvt::term> Class
1013hash which defines the environment of the new terminal. 1170hash which defines the environment of the new terminal.
1014 1171
1015Croaks (and probably outputs an error message) if the new instance 1172Croaks (and probably outputs an error message) if the new instance
1016couldn't be created. Returns C<undef> if the new instance didn't 1173couldn't be created. Returns C<undef> if the new instance didn't
1017initialise perl, and the terminal object otherwise. The C<init> and 1174initialise perl, and the terminal object otherwise. The C<init> and
1018C<start> hooks will be called during this call. 1175C<start> hooks will be called before this call returns, and are free to
1176refer to global data (which is race free).
1019 1177
1020=cut 1178=cut
1021 1179
1022sub new { 1180sub new {
1023 my ($class, $env, @args) = @_; 1181 my ($class, $env, @args) = @_;
1024 1182
1183 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1184 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1185
1025 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1186 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1026} 1187}
1027 1188
1028=item $term->destroy 1189=item $term->destroy
1029 1190
1030Destroy the terminal object (close the window, free resources 1191Destroy the terminal object (close the window, free resources
1060 1221
1061Returns true if the option specified by C<$optval> is enabled, and 1222Returns true if the option specified by C<$optval> is enabled, and
1062optionally change it. All option values are stored by name in the hash 1223optionally change it. All option values are stored by name in the hash
1063C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1224C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1064 1225
1065Here is a a likely non-exhaustive list of option names, please see the 1226Here is a likely non-exhaustive list of option names, please see the
1066source file F</src/optinc.h> to see the actual list: 1227source file F</src/optinc.h> to see the actual list:
1067 1228
1068 borderLess console cursorBlink cursorUnderline hold iconic insecure 1229 borderLess console cursorBlink cursorUnderline hold iconic insecure
1069 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1230 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1070 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1231 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1087likely change). 1248likely change).
1088 1249
1089Please note that resource strings will currently only be freed when the 1250Please note that resource strings will currently only be freed when the
1090terminal is destroyed, so changing options frequently will eat memory. 1251terminal is destroyed, so changing options frequently will eat memory.
1091 1252
1092Here is a a likely non-exhaustive list of resource names, not all of which 1253Here is a likely non-exhaustive list of resource names, not all of which
1093are supported in every build, please see the source file F</src/rsinc.h> 1254are supported in every build, please see the source file F</src/rsinc.h>
1094to see the actual list: 1255to see the actual list:
1095 1256
1096 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1257 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1097 borderLess color cursorBlink cursorUnderline cutchars delete_key 1258 borderLess color cursorBlink cursorUnderline cutchars delete_key
1310Replaces the event mask of the pty watcher by the given event mask. Can 1471Replaces the event mask of the pty watcher by the given event mask. Can
1311be used to suppress input and output handling to the pty/tty. See the 1472be used to suppress input and output handling to the pty/tty. See the
1312description of C<< urxvt::timer->events >>. Make sure to always restore 1473description of C<< urxvt::timer->events >>. Make sure to always restore
1313the previous value. 1474the previous value.
1314 1475
1476=item $fd = $term->pty_fd
1477
1478Returns the master file descriptor for the pty in use, or C<-1> if no pty
1479is used.
1480
1315=item $windowid = $term->parent 1481=item $windowid = $term->parent
1316 1482
1317Return the window id of the toplevel window. 1483Return the window id of the toplevel window.
1318 1484
1319=item $windowid = $term->vt 1485=item $windowid = $term->vt
1325Adds the specified events to the vt event mask. Useful e.g. when you want 1491Adds the specified events to the vt event mask. Useful e.g. when you want
1326to receive pointer events all the times: 1492to receive pointer events all the times:
1327 1493
1328 $term->vt_emask_add (urxvt::PointerMotionMask); 1494 $term->vt_emask_add (urxvt::PointerMotionMask);
1329 1495
1496=item $term->focus_in
1497
1498=item $term->focus_out
1499
1500=item $term->key_press ($state, $keycode[, $time])
1501
1502=item $term->key_release ($state, $keycode[, $time])
1503
1504Deliver various fake events to to terminal.
1505
1330=item $window_width = $term->width 1506=item $window_width = $term->width
1331 1507
1332=item $window_height = $term->height 1508=item $window_height = $term->height
1333 1509
1334=item $font_width = $term->fwidth 1510=item $font_width = $term->fwidth
1364=item $env = $term->env 1540=item $env = $term->env
1365 1541
1366Returns a copy of the environment in effect for the terminal as a hashref 1542Returns a copy of the environment in effect for the terminal as a hashref
1367similar to C<\%ENV>. 1543similar to C<\%ENV>.
1368 1544
1545=item @envv = $term->envv
1546
1547Returns the environment as array of strings of the form C<VAR=VALUE>.
1548
1549=item @argv = $term->argv
1550
1551Return the argument vector as this terminal, similar to @ARGV, but
1552includes the program name as first element.
1553
1369=cut 1554=cut
1370 1555
1371sub env { 1556sub env {
1372 if (my $env = $_[0]->_env) {
1373 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1557 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1374 } else {
1375 +{ %ENV }
1376 }
1377} 1558}
1378 1559
1379=item $modifiermask = $term->ModLevel3Mask 1560=item $modifiermask = $term->ModLevel3Mask
1380 1561
1381=item $modifiermask = $term->ModMetaMask 1562=item $modifiermask = $term->ModMetaMask
1389 1570
1390Returns the currently displayed screen (0 primary, 1 secondary). 1571Returns the currently displayed screen (0 primary, 1 secondary).
1391 1572
1392=item $cursor_is_hidden = $term->hidden_cursor 1573=item $cursor_is_hidden = $term->hidden_cursor
1393 1574
1394Returns wether the cursor is currently hidden or not. 1575Returns whether the cursor is currently hidden or not.
1395 1576
1396=item $view_start = $term->view_start ([$newvalue]) 1577=item $view_start = $term->view_start ([$newvalue])
1397 1578
1398Returns the row number of the topmost displayed line. Maximum value is 1579Returns the row number of the topmost displayed line. Maximum value is
1399C<0>, which displays the normal terminal contents. Lower values scroll 1580C<0>, which displays the normal terminal contents. Lower values scroll
1576where one character corresponds to one screen cell. See 1757where one character corresponds to one screen cell. See
1577C<< $term->ROW_t >> for details. 1758C<< $term->ROW_t >> for details.
1578 1759
1579=item $string = $term->special_decode $text 1760=item $string = $term->special_decode $text
1580 1761
1581Converts rxvt-unicodes text reprsentation into a perl string. See 1762Converts rxvt-unicodes text representation into a perl string. See
1582C<< $term->ROW_t >> for details. 1763C<< $term->ROW_t >> for details.
1583 1764
1584=item $success = $term->grab_button ($button, $modifiermask) 1765=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1585 1766
1767=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1768
1586Registers a synchronous button grab. See the XGrabButton manpage. 1769Register/unregister a synchronous button grab. See the XGrabButton
1770manpage.
1587 1771
1588=item $success = $term->grab ($eventtime[, $sync]) 1772=item $success = $term->grab ($eventtime[, $sync])
1589 1773
1590Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1774Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1591synchronous (C<$sync> is true). Also remembers the grab timestampe. 1775synchronous (C<$sync> is true). Also remembers the grab timestamp.
1592 1776
1593=item $term->allow_events_async 1777=item $term->allow_events_async
1594 1778
1595Calls XAllowEvents with AsyncBoth for the most recent grab. 1779Calls XAllowEvents with AsyncBoth for the most recent grab.
1596 1780
1709 my ($self, $text, $cb) = @_; 1893 my ($self, $text, $cb) = @_;
1710 1894
1711 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1895 $self->add_item ({ type => "button", text => $text, activate => $cb});
1712} 1896}
1713 1897
1714=item $popup->add_toggle ($text, $cb, $initial_value) 1898=item $popup->add_toggle ($text, $initial_value, $cb)
1715 1899
1716Adds a toggle/checkbox item to the popup. Teh callback gets called 1900Adds a toggle/checkbox item to the popup. The callback gets called
1717whenever it gets toggled, with a boolean indicating its value as its first 1901whenever it gets toggled, with a boolean indicating its new value as its
1718argument. 1902first argument.
1719 1903
1720=cut 1904=cut
1721 1905
1722sub add_toggle { 1906sub add_toggle {
1723 my ($self, $text, $cb, $value) = @_; 1907 my ($self, $text, $value, $cb) = @_;
1724 1908
1725 my $item; $item = { 1909 my $item; $item = {
1726 type => "button", 1910 type => "button",
1727 text => " $text", 1911 text => " $text",
1728 value => $value, 1912 value => $value,
1769=back 1953=back
1770 1954
1771=cut 1955=cut
1772 1956
1773package urxvt::watcher; 1957package urxvt::watcher;
1774
1775@urxvt::timer::ISA = __PACKAGE__;
1776@urxvt::iow::ISA = __PACKAGE__;
1777@urxvt::pw::ISA = __PACKAGE__;
1778@urxvt::iw::ISA = __PACKAGE__;
1779 1958
1780=head2 The C<urxvt::timer> Class 1959=head2 The C<urxvt::timer> Class
1781 1960
1782This class implements timer watchers/events. Time is represented as a 1961This class implements timer watchers/events. Time is represented as a
1783fractional number of seconds since the epoch. Example: 1962fractional number of seconds since the epoch. Example:
1863Set the callback to be called when io events are triggered. C<$reventmask> 2042Set the callback to be called when io events are triggered. C<$reventmask>
1864is a bitset as described in the C<events> method. 2043is a bitset as described in the C<events> method.
1865 2044
1866=item $iow = $iow->fd ($fd) 2045=item $iow = $iow->fd ($fd)
1867 2046
1868Set the filedescriptor (not handle) to watch. 2047Set the file descriptor (not handle) to watch.
1869 2048
1870=item $iow = $iow->events ($eventmask) 2049=item $iow = $iow->events ($eventmask)
1871 2050
1872Set the event mask to watch. The only allowed values are 2051Set the event mask to watch. The only allowed values are
1873C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2052C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1877 2056
1878Start watching for requested events on the given handle. 2057Start watching for requested events on the given handle.
1879 2058
1880=item $iow = $iow->stop 2059=item $iow = $iow->stop
1881 2060
1882Stop watching for events on the given filehandle. 2061Stop watching for events on the given file handle.
1883 2062
1884=back 2063=back
1885 2064
1886=head2 The C<urxvt::iw> Class 2065=head2 The C<urxvt::iw> Class
1887 2066
1934 2113
1935Set the callback to be called when the timer triggers. 2114Set the callback to be called when the timer triggers.
1936 2115
1937=item $pw = $timer->start ($pid) 2116=item $pw = $timer->start ($pid)
1938 2117
1939Tells the wqtcher to start watching for process C<$pid>. 2118Tells the watcher to start watching for process C<$pid>.
1940 2119
1941=item $pw = $pw->stop 2120=item $pw = $pw->stop
1942 2121
1943Stop the watcher. 2122Stop the watcher.
1944 2123
1957 2136
1958=item >= 3 - script loading and management 2137=item >= 3 - script loading and management
1959 2138
1960=item >=10 - all called hooks 2139=item >=10 - all called hooks
1961 2140
1962=item >=11 - hook reutrn values 2141=item >=11 - hook return values
1963 2142
1964=back 2143=back
1965 2144
1966=head1 AUTHOR 2145=head1 AUTHOR
1967 2146

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines