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.101 by root, Wed Jan 18 10:11:03 2006 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
36You can activate them like this: 39You can activate them like this:
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42
43Or by adding them to the resource for extensions loaded by default:
44
45 URxvt.perl-ext-common: default,selection-autotransform
39 46
40=over 4 47=over 4
41 48
42=item selection (enabled by default) 49=item selection (enabled by default)
43 50
58 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
59 ... 66 ...
60 67
61The 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
62contain 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
63the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
64between two vertical bars: 71between two vertical bars:
65 72
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
67 81
68You can look at the source of the selection extension to see more 82You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 83interesting uses, such as parsing a line from beginning to end.
70 84
71This extension also offers following bindable keyboard commands: 85This extension also offers following bindable keyboard commands:
83=item option-popup (enabled by default) 97=item option-popup (enabled by default)
84 98
85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86runtime. 100runtime.
87 101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<< $self->{myoption} >>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
118
88=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
89 120
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
93 124
94Other extensions can extend this popup menu by pushing a code reference onto 125Other extensions can extend this popup menu by pushing a code reference
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
96 128
97It'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
98is 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.
99It 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
100string 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
101when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
102 134
103The 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
104the 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
105C<a>s: 137C<a>s:
106 138
107 push urxvt::ext::selection_popup::hook, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
109 : () 141 : ()
110 }; 142 };
111 143
112=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
113 145
120search. 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>
121search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
122bottom. 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
123was 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
124additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
125selection. 157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
164
165=item readline (enabled by default)
166
167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters).
172
173To avoid too many false positives, this is only done when:
174
175=over 4
176
177=item - the tty is in ICANON state.
178
179=item - the text cursor is visible.
180
181=item - the primary screen is currently being displayed.
182
183=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
126 189
127=item selection-autotransform 190=item selection-autotransform
128 191
129This selection allows you to do automatic transforms on a selection 192This selection allows you to do automatic transforms on a selection
130whenever a selection is made. 193whenever a selection is made.
143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144 207
145And this example matches the same,but replaces it with vi-commands you can 208And this example matches the same,but replaces it with vi-commands you can
146paste directly into your (vi :) editor: 209paste directly into your (vi :) editor:
147 210
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149 212
150Of course, this can be modified to suit your needs and your editor :) 213Of course, this can be modified to suit your needs and your editor :)
151 214
152To expand the example above to typical perl error messages ("XXX at 215To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution: 216FILENAME line YYY."), you need a slightly more elaborate solution:
154 217
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 219 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157 220
158The first line tells the selection code to treat the unchanging part of 221The first line tells the selection code to treat the unchanging part of
159every error message as a selection pattern, and the second line transforms 222every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file. 223the message into vi commands to load the file.
161 224
162=item mark-urls 225=item tabbed
163 226
227This transforms the terminal into a tabbar with additional terminals, that
228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230button per tab.
231
232Clicking a button will activate that tab. Pressing B<Shift-Left> and
233B<Shift-Right> will switch to the tab left or right of the current one,
234while B<Shift-Down> creates a new tab.
235
236The tabbar itself can be configured similarly to a normal terminal, but
237with a resource class of C<URxvt.tabbed>. In addition, it supports the
238following four resources (shown with defaults):
239
240 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242 URxvt.tabbed.tab-fg: <colour-index, default 0>
243 URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246indices.
247
248=item matcher
249
164Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
165make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
167the 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
276
277=item xim-onthespot
278
279This (experimental) perl extension implements OnTheSpot editing. It does
280not work perfectly, and some input methods don't seem to work well with
281OnTheSpot editing in general, but it seems to work at least for SCIM and
282kinput2.
283
284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.:
286
287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289=item kuake<hotkey>
290
291A very primitive quake-console-like extension. It was inspired by a
292description of how the programs C<kuake> and C<yakuake> work: Whenever the
293user presses a global accelerator key (by default C<F10>), the terminal
294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
296
297Initially, the window will not be shown when using this extension.
298
299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key.
301
302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function.
304
305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it).
307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
168 313
169=item block-graphics-to-ascii 314=item block-graphics-to-ascii
170 315
171A not very useful example of filtering all text output to the terminal, 316A not very useful example of filtering all text output to the terminal
172by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
173similar-looking ascii character. 318similar-looking ascii character.
174 319
175=item digital-clock 320=item digital-clock
176 321
177Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
178 323
179=item example-refresh-hooks 324=item remote-clipboard
180 325
181Displays a very simple digital clock in the upper right corner of the 326Somewhat of a misnomer, this extension adds two menu entries to the
182window. Illustrates overwriting the refresh callbacks to create your own 327selection popup that allows one to run external commands to store the
183overlays or changes. 328selection somewhere and fetch it again.
329
330We use it to implement a "distributed selection mechanism", which just
331means that one command uploads the file to a remote server, and another
332reads it.
333
334The commands can be set using the C<URxvt.remote-selection.store> and
335C<URxvt.remote-selection.fetch> resources. The first should read the
336selection to store from STDIN (always in UTF-8), the second should provide
337the selection data on STDOUT (also in UTF-8).
338
339The defaults (which are likely useless to you) use rsh and cat:
340
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
184 343
185=item selection-pastebin 344=item selection-pastebin
186 345
187This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that Uploads the selection as
188textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
208After a successful upload the selection will be replaced by the text given 367After a successful upload the selection will be replaced by the text given
209in the C<selection-pastebin-url> resource (again, the % is the placeholder 368in the C<selection-pastebin-url> resource (again, the % is the placeholder
210for the filename): 369for the filename):
211 370
212 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file
376or not.
377
378=item example-refresh-hooks
379
380Displays a very simple digital clock in the upper right corner of the
381window. Illustrates overwriting the refresh callbacks to create your own
382overlays or changes.
213 383
214=back 384=back
215 385
216=head1 API DOCUMENTATION 386=head1 API DOCUMENTATION
217 387
251 421
252=back 422=back
253 423
254=head2 Extension Objects 424=head2 Extension Objects
255 425
256Very perl extension is a perl class. A separate perl object is created 426Every perl extension is a perl class. A separate perl object is created
257for each terminal and each extension and passed as the first parameter to 427for each terminal, and each terminal has its own set of extenion objects,
258hooks. So extensions can use their C<$self> object without having to think 428which are passed as the first parameter to hooks. So extensions can use
259about other extensions, with the exception of methods and members that 429their C<$self> object without having to think about clashes with other
430extensions or other terminals, with the exception of methods and members
260begin with an underscore character C<_>: these are reserved for internal 431that begin with an underscore character C<_>: these are reserved for
261use. 432internal use.
262 433
263Although it isn't a C<urxvt::term> object, you can call all methods of the 434Although it isn't a C<urxvt::term> object, you can call all methods of the
264C<urxvt::term> class on this object. 435C<urxvt::term> class on this object.
265 436
266It has the following methods and data members: 437It has the following methods and data members:
287=head2 Hooks 458=head2 Hooks
288 459
289The following subroutines can be declared in extension files, and will be 460The following subroutines can be declared in extension files, and will be
290called whenever the relevant event happens. 461called whenever the relevant event happens.
291 462
292The first argument passed to them is an extension oject as described in 463The first argument passed to them is an extension object as described in
293the in the C<Extension Objects> section. 464the in the C<Extension Objects> section.
294 465
295B<All> of these hooks must return a boolean value. If it is true, then the 466B<All> of these hooks must return a boolean value. If any of the called
296event counts as being I<consumed>, and the invocation of other hooks is 467hooks returns true, then the event counts as being I<consumed>, and the
297skipped, and the relevant action might not be carried out by the C++ code. 468relevant action might not be carried out by the C++ code.
298 469
299I<< When in doubt, return a false value (preferably C<()>). >> 470I<< When in doubt, return a false value (preferably C<()>). >>
300 471
301=over 4 472=over 4
302 473
303=item on_init $term 474=item on_init $term
304 475
305Called after a new terminal object has been initialized, but before 476Called after a new terminal object has been initialized, but before
306windows are created or the command gets run. Most methods are unsafe to 477windows are created or the command gets run. Most methods are unsafe to
307call or deliver senseless data, as terminal size and other characteristics 478call or deliver senseless data, as terminal size and other characteristics
308have not yet been determined. You can safely query and change resources, 479have not yet been determined. You can safely query and change resources
309though. 480and options, though. For many purposes the C<on_start> hook is a better
481place.
482
483=item on_start $term
484
485Called at the very end of initialisation of a new terminal, just before
486trying to map (display) the toplevel and returning to the main loop.
487
488=item on_destroy $term
489
490Called whenever something tries to destroy terminal, when the terminal is
491still fully functional (not for long, though).
310 492
311=item on_reset $term 493=item on_reset $term
312 494
313Called after the screen is "reset" for any reason, such as resizing or 495Called after the screen is "reset" for any reason, such as resizing or
314control sequences. Here is where you can react on changes to size-related 496control sequences. Here is where you can react on changes to size-related
315variables. 497variables.
316 498
317=item on_start $term 499=item on_child_start $term, $pid
318 500
319Called at the very end of initialisation of a new terminal, just before 501Called just after the child process has been C<fork>ed.
320returning to the mainloop. 502
503=item on_child_exit $term, $status
504
505Called just after the child process has exited. C<$status> is the status
506from C<waitpid>.
321 507
322=item on_sel_make $term, $eventtime 508=item on_sel_make $term, $eventtime
323 509
324Called whenever a selection has been made by the user, but before the 510Called whenever a selection has been made by the user, but before the
325selection text is copied, so changes to the beginning, end or type of the 511selection text is copied, so changes to the beginning, end or type of the
332 518
333Called whenever a selection has been copied, but before the selection is 519Called whenever a selection has been copied, but before the selection is
334requested from the server. The selection text can be queried and changed 520requested from the server. The selection text can be queried and changed
335by calling C<< $term->selection >>. 521by calling C<< $term->selection >>.
336 522
337Returning a true value aborts selection grabbing. It will still be hilighted. 523Returning a true value aborts selection grabbing. It will still be highlighted.
338 524
339=item on_sel_extend $term 525=item on_sel_extend $term
340 526
341Called whenever the user tries to extend the selection (e.g. with a double 527Called whenever the user tries to extend the selection (e.g. with a double
342click) and is either supposed to return false (normal operation), or 528click) and is either supposed to return false (normal operation), or
343should extend the selection itelf and return true to suppress the built-in 529should extend the selection itself and return true to suppress the built-in
344processing. This can happen multiple times, as long as the callback 530processing. This can happen multiple times, as long as the callback
345returns true, it will be called on every further click by the user and is 531returns true, it will be called on every further click by the user and is
346supposed to enlarge the selection more and more, if possible. 532supposed to enlarge the selection more and more, if possible.
347 533
348See the F<selection> example extension. 534See the F<selection> example extension.
349 535
350=item on_view_change $term, $offset 536=item on_view_change $term, $offset
351 537
352Called whenever the view offset changes, i..e the user or program 538Called whenever the view offset changes, i.e. the user or program
353scrolls. Offset C<0> means display the normal terminal, positive values 539scrolls. Offset C<0> means display the normal terminal, positive values
354show this many lines of scrollback. 540show this many lines of scrollback.
355 541
356=item on_scroll_back $term, $lines, $saved 542=item on_scroll_back $term, $lines, $saved
357 543
361 547
362It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 548It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
363$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 549$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
364number of lines that will be in the scrollback buffer. 550number of lines that will be in the scrollback buffer.
365 551
366=item on_osc_seq $term, $string 552=item on_osc_seq $term, $op, $args, $resp
553
554Called on every OSC sequence and can be used to suppress it or modify its
555behaviour. The default should be to return an empty list. A true value
556suppresses execution of the request completely. Make sure you don't get
557confused by recursive invocations when you output an OSC sequence within
558this callback.
559
560C<on_osc_seq_perl> should be used for new behaviour.
561
562=item on_osc_seq_perl $term, $args, $resp
367 563
368Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 564Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
369operating system command) is processed. Cursor position and other state 565operating system command) is processed. Cursor position and other state
370information is up-to-date when this happens. For interoperability, the 566information is up-to-date when this happens. For interoperability, the
371string should start with the extension name and a colon, to distinguish 567string should start with the extension name (sans -osc) and a semicolon,
372it from commands for other extensions, and this might be enforced in the 568to distinguish it from commands for other extensions, and this might be
373future. 569enforced in the future.
570
571For example, C<overlay-osc> uses this:
572
573 sub on_osc_seq_perl {
574 my ($self, $osc, $resp) = @_;
575
576 return unless $osc =~ s/^overlay;//;
577
578 ... process remaining $osc string
579 }
374 580
375Be careful not ever to trust (in a security sense) the data you receive, 581Be careful not ever to trust (in a security sense) the data you receive,
376as its source can not easily be controleld (e-mail content, messages from 582as its source can not easily be controlled (e-mail content, messages from
377other users on the same system etc.). 583other users on the same system etc.).
584
585For responses, C<$resp> contains the end-of-args separator used by the
586sender.
378 587
379=item on_add_lines $term, $string 588=item on_add_lines $term, $string
380 589
381Called whenever text is about to be output, with the text as argument. You 590Called whenever text is about to be output, with the text as argument. You
382can filter/change and output the text yourself by returning a true value 591can filter/change and output the text yourself by returning a true value
403later with the already-modified line (e.g. if unrelated parts change), so 612later with the already-modified line (e.g. if unrelated parts change), so
404you cannot just toggle rendition bits, but only set them. 613you cannot just toggle rendition bits, but only set them.
405 614
406=item on_refresh_begin $term 615=item on_refresh_begin $term
407 616
408Called just before the screen gets redrawn. Can be used for overlay 617Called just before the screen gets redrawn. Can be used for overlay or
409or similar effects by modify terminal contents in refresh_begin, and 618similar effects by modifying the terminal contents in refresh_begin, and
410restoring them in refresh_end. The built-in overlay and selection display 619restoring them in refresh_end. The built-in overlay and selection display
411code is run after this hook, and takes precedence. 620code is run after this hook, and takes precedence.
412 621
413=item on_refresh_end $term 622=item on_refresh_end $term
414 623
415Called just after the screen gets redrawn. See C<on_refresh_begin>. 624Called just after the screen gets redrawn. See C<on_refresh_begin>.
416 625
417=item on_keyboard_command $term, $string 626=item on_user_command $term, $string
418 627
419Called whenever the user presses a key combination that has a 628Called whenever a user-configured event is being activated (e.g. via
420C<perl:string> action bound to it (see description of the B<keysym> 629a C<perl:string> action bound to a key, see description of the B<keysym>
421resource in the @@RXVT_NAME@@(1) manpage). 630resource in the @@RXVT_NAME@@(1) manpage).
631
632The event is simply the action string. This interface is assumed to change
633slightly in the future.
634
635=item on_resize_all_windows $tern, $new_width, $new_height
636
637Called just after the new window size has been calculated, but before
638windows are actually being resized or hints are being set. If this hook
639returns TRUE, setting of the window hints is being skipped.
422 640
423=item on_x_event $term, $event 641=item on_x_event $term, $event
424 642
425Called on every X event received on the vt window (and possibly other 643Called on every X event received on the vt window (and possibly other
426windows). Should only be used as a last resort. Most event structure 644windows). Should only be used as a last resort. Most event structure
427members are not passed. 645members are not passed.
428 646
647=item on_root_event $term, $event
648
649Like C<on_x_event>, but is called for events on the root window.
650
429=item on_focus_in $term 651=item on_focus_in $term
430 652
431Called whenever the window gets the keyboard focus, before rxvt-unicode 653Called whenever the window gets the keyboard focus, before rxvt-unicode
432does focus in processing. 654does focus in processing.
433 655
434=item on_focus_out $term 656=item on_focus_out $term
435 657
436Called wheneever the window loses keyboard focus, before rxvt-unicode does 658Called whenever the window loses keyboard focus, before rxvt-unicode does
437focus out processing. 659focus out processing.
660
661=item on_configure_notify $term, $event
662
663=item on_property_notify $term, $event
438 664
439=item on_key_press $term, $event, $keysym, $octets 665=item on_key_press $term, $event, $keysym, $octets
440 666
441=item on_key_release $term, $event, $keysym 667=item on_key_release $term, $event, $keysym
442 668
452 678
453Called whenever the corresponding X event is received for the terminal If 679Called whenever the corresponding X event is received for the terminal If
454the hook returns true, then the even will be ignored by rxvt-unicode. 680the hook returns true, then the even will be ignored by rxvt-unicode.
455 681
456The event is a hash with most values as named by Xlib (see the XEvent 682The event is a hash with most values as named by Xlib (see the XEvent
457manpage), with the additional members C<row> and C<col>, which are the row 683manpage), with the additional members C<row> and C<col>, which are the
458and column under the mouse cursor. 684(real, not screen-based) row and column under the mouse cursor.
459 685
460C<on_key_press> additionally receives the string rxvt-unicode would 686C<on_key_press> additionally receives the string rxvt-unicode would
461output, if any, in locale-specific encoding. 687output, if any, in locale-specific encoding.
462 688
463subwindow. 689subwindow.
690
691=item on_client_message $term, $event
692
693=item on_wm_protocols $term, $event
694
695=item on_wm_delete_window $term, $event
696
697Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
464 699
465=back 700=back
466 701
467=cut 702=cut
468 703
474use Scalar::Util (); 709use Scalar::Util ();
475use List::Util (); 710use List::Util ();
476 711
477our $VERSION = 1; 712our $VERSION = 1;
478our $TERM; 713our $TERM;
714our @TERM_INIT;
715our @TERM_EXT;
479our @HOOKNAME; 716our @HOOKNAME;
480our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 717our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
481our %OPTION; 718our %OPTION;
482 719
483our $LIBDIR; 720our $LIBDIR;
484our $RESNAME; 721our $RESNAME;
485our $RESCLASS; 722our $RESCLASS;
486our $RXVTNAME; 723our $RXVTNAME;
487 724
725our $NOCHAR = chr 0xffff;
726
488=head2 Variables in the C<urxvt> Package 727=head2 Variables in the C<urxvt> Package
489 728
490=over 4 729=over 4
491 730
492=item $urxvt::LIBDIR 731=item $urxvt::LIBDIR
504 743
505=item $urxvt::TERM 744=item $urxvt::TERM
506 745
507The current terminal. This variable stores the current C<urxvt::term> 746The current terminal. This variable stores the current C<urxvt::term>
508object, whenever a callback/hook is executing. 747object, whenever a callback/hook is executing.
748
749=item @urxvt::TERM_INIT
750
751All code references in this array will be called as methods of the next newly
752created C<urxvt::term> object (during the C<on_init> phase). The array
753gets cleared before the code references that were in it are being executed,
754so references can push themselves onto it again if they so desire.
755
756This complements to the perl-eval command line option, but gets executed
757first.
758
759=item @urxvt::TERM_EXT
760
761Works similar to C<@TERM_INIT>, but contains perl package/class names, which
762get registered as normal extensions after calling the hooks in C<@TERM_INIT>
763but before other extensions. Gets cleared just like C<@TERM_INIT>.
509 764
510=back 765=back
511 766
512=head2 Functions in the C<urxvt> Package 767=head2 Functions in the C<urxvt> Package
513 768
527 782
528Using this function has the advantage that its output ends up in the 783Using this function has the advantage that its output ends up in the
529correct place, e.g. on stderr of the connecting urxvtc client. 784correct place, e.g. on stderr of the connecting urxvtc client.
530 785
531Messages have a size limit of 1023 bytes currently. 786Messages have a size limit of 1023 bytes currently.
787
788=item @terms = urxvt::termlist
789
790Returns all urxvt::term objects that exist in this process, regardless of
791whether they are started, being destroyed etc., so be careful. Only term
792objects that have perl extensions attached will be returned (because there
793is no urxvt::term objet associated with others).
532 794
533=item $time = urxvt::NOW 795=item $time = urxvt::NOW
534 796
535Returns the "current time" (as per the event loop). 797Returns the "current time" (as per the event loop).
536 798
594Return the foreground/background colour index, respectively. 856Return the foreground/background colour index, respectively.
595 857
596=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 858=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
597 859
598=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 860=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
861
862=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
599 863
600Replace the foreground/background colour in the rendition mask with the 864Replace the foreground/background colour in the rendition mask with the
601specified one. 865specified one.
602 866
603=item $value = urxvt::GET_CUSTOM $rend 867=item $value = urxvt::GET_CUSTOM $rend
620 my $msg = join "", @_; 884 my $msg = join "", @_;
621 $msg .= "\n" 885 $msg .= "\n"
622 unless $msg =~ /\n$/; 886 unless $msg =~ /\n$/;
623 urxvt::warn ($msg); 887 urxvt::warn ($msg);
624 }; 888 };
625
626 # %ENV is the original startup environment
627 delete $ENV{IFS};
628 delete $ENV{CDPATH};
629 delete $ENV{BASH_ENV};
630 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
631} 889}
890
891no warnings 'utf8';
632 892
633my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 893my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
634 894
635sub verbose { 895sub verbose {
636 my ($level, $msg) = @_; 896 my ($level, $msg) = @_;
640my %extension_pkg; 900my %extension_pkg;
641 901
642# load a single script into its own package, once only 902# load a single script into its own package, once only
643sub extension_package($) { 903sub extension_package($) {
644 my ($path) = @_; 904 my ($path) = @_;
645
646 no strict 'refs';
647 905
648 $extension_pkg{$path} ||= do { 906 $extension_pkg{$path} ||= do {
649 $path =~ /([^\/\\]+)$/; 907 $path =~ /([^\/\\]+)$/;
650 my $pkg = $1; 908 my $pkg = $1;
651 $pkg =~ s/[^[:word:]]/_/g; 909 $pkg =~ s/[^[:word:]]/_/g;
654 verbose 3, "loading extension '$path' into package '$pkg'"; 912 verbose 3, "loading extension '$path' into package '$pkg'";
655 913
656 open my $fh, "<:raw", $path 914 open my $fh, "<:raw", $path
657 or die "$path: $!"; 915 or die "$path: $!";
658 916
659 @{"$pkg\::ISA"} = urxvt::term::extension::;
660
661 my $source = 917 my $source =
662 "package $pkg; use strict; use utf8;\n" 918 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
663 . "#line 1 \"$path\"\n{\n" 919 . "#line 1 \"$path\"\n{\n"
664 . (do { local $/; <$fh> }) 920 . (do { local $/; <$fh> })
665 . "\n};\n1"; 921 . "\n};\n1";
666 922
667 eval $source 923 eval $source
678 local $TERM = shift; 934 local $TERM = shift;
679 my $htype = shift; 935 my $htype = shift;
680 936
681 if ($htype == 0) { # INIT 937 if ($htype == 0) { # INIT
682 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 938 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
683 939
684 my %ext_arg; 940 my %ext_arg;
685 941
942 {
943 my @init = @TERM_INIT;
944 @TERM_INIT = ();
945 $_->($TERM) for @init;
946 my @pkg = @TERM_EXT;
947 @TERM_EXT = ();
948 $TERM->register_package ($_) for @pkg;
949 }
950
686 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 951 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
687 if ($_ eq "default") { 952 if ($_ eq "default") {
688 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 953 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
689 } elsif (/^-(.*)$/) { 954 } elsif (/^-(.*)$/) {
690 delete $ext_arg{$1}; 955 delete $ext_arg{$1};
691 } elsif (/^([^<]+)<(.*)>$/) { 956 } elsif (/^([^<]+)<(.*)>$/) {
692 push @{ $ext_arg{$1} }, $2; 957 push @{ $ext_arg{$1} }, $2;
693 } else { 958 } else {
694 $ext_arg{$_} ||= []; 959 $ext_arg{$_} ||= [];
695 } 960 }
696 } 961 }
697 962
698 while (my ($ext, $argv) = each %ext_arg) { 963 for my $ext (sort keys %ext_arg) {
699 my @files = grep -f $_, map "$_/$ext", @dirs; 964 my @files = grep -f $_, map "$_/$ext", @dirs;
700 965
701 if (@files) { 966 if (@files) {
702 $TERM->register_package (extension_package $files[0], $argv); 967 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
703 } else { 968 } else {
704 warn "perl extension '$ext' not found in perl library search path\n"; 969 warn "perl extension '$ext' not found in perl library search path\n";
705 } 970 }
706 } 971 }
707 972
713 978
714 if (my $cb = $TERM->{_hook}[$htype]) { 979 if (my $cb = $TERM->{_hook}[$htype]) {
715 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 980 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
716 if $verbosity >= 10; 981 if $verbosity >= 10;
717 982
718 keys %$cb; 983 for my $pkg (keys %$cb) {
719
720 while (my ($pkg, $cb) = each %$cb) {
721 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 984 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
722 and last; 985 $retval ||= $retval_;
723 986
724 if ($@) { 987 if ($@) {
725 $TERM->ungrab; # better to lose the grab than the session 988 $TERM->ungrab; # better to lose the grab than the session
726 warn $@; 989 warn $@;
727 } 990 }
740 } 1003 }
741 1004
742 $retval 1005 $retval
743} 1006}
744 1007
745sub exec_async(@) { 1008sub SET_COLOR($$$) {
746 my $pid = fork; 1009 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1010}
747 1011
748 return 1012sub rend2mask {
749 if !defined $pid or $pid; 1013 no strict 'refs';
750 1014 my ($str, $mask) = (@_, 0);
751 %ENV = %{ $TERM->env }; 1015 my %color = ( fg => undef, bg => undef );
752 1016 my @failed;
753 exec @_; 1017 for my $spec ( split /\s+/, $str ) {
754 _exit 255; 1018 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1019 $color{lc($1)} = $2;
1020 } else {
1021 my $neg = $spec =~ s/^[-^]//;
1022 unless ( exists &{"RS_$spec"} ) {
1023 push @failed, $spec;
1024 next;
1025 }
1026 my $cur = &{"RS_$spec"};
1027 if ( $neg ) {
1028 $mask &= ~$cur;
1029 } else {
1030 $mask |= $cur;
1031 }
1032 }
1033 }
1034 ($mask, @color{qw(fg bg)}, \@failed)
755} 1035}
756 1036
757# urxvt::term::extension 1037# urxvt::term::extension
758 1038
759package urxvt::term::extension; 1039package urxvt::term::extension;
830is that you cannot use blocking APIs, but the non-blocking variant should 1110is that you cannot use blocking APIs, but the non-blocking variant should
831work. 1111work.
832 1112
833=cut 1113=cut
834 1114
835our $VERSION = 1; 1115our $VERSION = '3.4';
836 1116
837$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
838push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
839 1119
840sub timer { 1120sub timer {
871 1151
872sub DESTROY { 1152sub DESTROY {
873 $_[0][1]->stop; 1153 $_[0][1]->stop;
874} 1154}
875 1155
876sub condvar { 1156sub one_event {
877 bless \my $flag, urxvt::anyevent::condvar::
878}
879
880sub urxvt::anyevent::condvar::broadcast {
881 ${$_[0]}++;
882}
883
884sub urxvt::anyevent::condvar::wait {
885 unless (${$_[0]}) {
886 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1157 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
887 }
888} 1158}
889 1159
890package urxvt::term; 1160package urxvt::term;
891 1161
892=head2 The C<urxvt::term> Class 1162=head2 The C<urxvt::term> Class
897 1167
898# find on_xxx subs in the package and register them 1168# find on_xxx subs in the package and register them
899# as hooks 1169# as hooks
900sub register_package { 1170sub register_package {
901 my ($self, $pkg, $argv) = @_; 1171 my ($self, $pkg, $argv) = @_;
1172
1173 no strict 'refs';
1174
1175 urxvt::verbose 6, "register package $pkg to $self";
1176
1177 @{"$pkg\::ISA"} = urxvt::term::extension::;
902 1178
903 my $proxy = bless { 1179 my $proxy = bless {
904 _pkg => $pkg, 1180 _pkg => $pkg,
905 argv => $argv, 1181 argv => $argv,
906 }, $pkg; 1182 }, $pkg;
922hash which defines the environment of the new terminal. 1198hash which defines the environment of the new terminal.
923 1199
924Croaks (and probably outputs an error message) if the new instance 1200Croaks (and probably outputs an error message) if the new instance
925couldn't be created. Returns C<undef> if the new instance didn't 1201couldn't be created. Returns C<undef> if the new instance didn't
926initialise perl, and the terminal object otherwise. The C<init> and 1202initialise perl, and the terminal object otherwise. The C<init> and
927C<start> hooks will be called during this call. 1203C<start> hooks will be called before this call returns, and are free to
1204refer to global data (which is race free).
928 1205
929=cut 1206=cut
930 1207
931sub new { 1208sub new {
932 my ($class, $env, @args) = @_; 1209 my ($class, $env, @args) = @_;
933 1210
1211 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1212 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1213
934 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1214 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
935} 1215}
936 1216
937=item $term->destroy 1217=item $term->destroy
938 1218
939Destroy the terminal object (close the window, free resources 1219Destroy the terminal object (close the window, free resources
940etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1220etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
941watchers (timers, io watchers) are still active. 1221watchers (timers, io watchers) are still active.
942 1222
1223=item $term->exec_async ($cmd[, @args])
1224
1225Works like the combination of the C<fork>/C<exec> builtins, which executes
1226("starts") programs in the background. This function takes care of setting
1227the user environment before exec'ing the command (e.g. C<PATH>) and should
1228be preferred over explicit calls to C<exec> or C<system>.
1229
1230Returns the pid of the subprocess or C<undef> on error.
1231
1232=cut
1233
1234sub exec_async {
1235 my $self = shift;
1236
1237 my $pid = fork;
1238
1239 return $pid
1240 if !defined $pid or $pid;
1241
1242 %ENV = %{ $self->env };
1243
1244 exec @_;
1245 urxvt::_exit 255;
1246}
1247
943=item $isset = $term->option ($optval[, $set]) 1248=item $isset = $term->option ($optval[, $set])
944 1249
945Returns true if the option specified by C<$optval> is enabled, and 1250Returns true if the option specified by C<$optval> is enabled, and
946optionally change it. All option values are stored by name in the hash 1251optionally change it. All option values are stored by name in the hash
947C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1252C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
948 1253
949Here is a a likely non-exhaustive list of option names, please see the 1254Here is a likely non-exhaustive list of option names, please see the
950source file F</src/optinc.h> to see the actual list: 1255source file F</src/optinc.h> to see the actual list:
951 1256
952 borderLess console cursorBlink cursorUnderline hold iconic insecure 1257 borderLess console cursorBlink cursorUnderline hold iconic insecure
953 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1258 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
954 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1259 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
955 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1260 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
956 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1261 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
957 tripleclickwords utmpInhibit visualBell 1262 transparent tripleclickwords utmpInhibit visualBell
958 1263
959=item $value = $term->resource ($name[, $newval]) 1264=item $value = $term->resource ($name[, $newval])
960 1265
961Returns the current resource value associated with a given name and 1266Returns the current resource value associated with a given name and
962optionally sets a new value. Setting values is most useful in the C<init> 1267optionally sets a new value. Setting values is most useful in the C<init>
971likely change). 1276likely change).
972 1277
973Please note that resource strings will currently only be freed when the 1278Please note that resource strings will currently only be freed when the
974terminal is destroyed, so changing options frequently will eat memory. 1279terminal is destroyed, so changing options frequently will eat memory.
975 1280
976Here is a a likely non-exhaustive list of resource names, not all of which 1281Here is a likely non-exhaustive list of resource names, not all of which
977are supported in every build, please see the source file F</src/rsinc.h> 1282are supported in every build, please see the source file F</src/rsinc.h>
978to see the actual list: 1283to see the actual list:
979 1284
980 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
981 borderLess color cursorBlink cursorUnderline cutchars delete_key 1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
982 display_name embed ext_bwidth fade font geometry hold iconName 1287 display_name embed ext_bwidth fade font geometry hold iconName
983 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles
984 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
985 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
986 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
987 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
988 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
989 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
990 shade term_name title transparent transparent_all tripleclickwords 1295 secondaryScreen secondaryScroll shade term_name title
991 utmpInhibit visualBell 1296 transient_for transparent transparent_all tripleclickwords utmpInhibit
1297 visualBell
992 1298
993=cut 1299=cut
994 1300
995sub resource($$;$) { 1301sub resource($$;$) {
996 my ($self, $name) = (shift, shift); 1302 my ($self, $name) = (shift, shift);
997 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1303 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
998 &urxvt::term::_resource 1304 goto &urxvt::term::_resource
999} 1305}
1000 1306
1001=item $value = $term->x_resource ($pattern) 1307=item $value = $term->x_resource ($pattern)
1002 1308
1003Returns the X-Resource for the given pattern, excluding the program or 1309Returns the X-Resource for the given pattern, excluding the program or
1086 1392
1087The methods currently supported on C<urxvt::overlay> objects are: 1393The methods currently supported on C<urxvt::overlay> objects are:
1088 1394
1089=over 4 1395=over 4
1090 1396
1091=item $overlay->set ($x, $y, $text, $rend) 1397=item $overlay->set ($x, $y, $text[, $rend])
1092 1398
1093Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1399Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1094text in rxvt-unicode's special encoding and an array of rendition values 1400text in rxvt-unicode's special encoding and an array of rendition values
1095at a specific position inside the overlay. 1401at a specific position inside the overlay.
1402
1403If C<$rend> is missing, then the rendition will not be changed.
1096 1404
1097=item $overlay->hide 1405=item $overlay->hide
1098 1406
1099If visible, hide the overlay, but do not destroy it. 1407If visible, hide the overlay, but do not destroy it.
1100 1408
1170 1478
1171Normally its not a good idea to use this function, as programs might be 1479Normally its not a good idea to use this function, as programs might be
1172confused by changes in cursor position or scrolling. Its useful inside a 1480confused by changes in cursor position or scrolling. Its useful inside a
1173C<on_add_lines> hook, though. 1481C<on_add_lines> hook, though.
1174 1482
1483=item $term->scr_change_screen ($screen)
1484
1485Switch to given screen - 0 primary, 1 secondary.
1486
1175=item $term->cmd_parse ($octets) 1487=item $term->cmd_parse ($octets)
1176 1488
1177Similar to C<scr_add_lines>, but the argument must be in the 1489Similar to C<scr_add_lines>, but the argument must be in the
1178locale-specific encoding of the terminal and can contain command sequences 1490locale-specific encoding of the terminal and can contain command sequences
1179(escape codes) that will be interpreted. 1491(escape codes) that will be interpreted.
1189Replaces the event mask of the pty watcher by the given event mask. Can 1501Replaces the event mask of the pty watcher by the given event mask. Can
1190be used to suppress input and output handling to the pty/tty. See the 1502be used to suppress input and output handling to the pty/tty. See the
1191description of C<< urxvt::timer->events >>. Make sure to always restore 1503description of C<< urxvt::timer->events >>. Make sure to always restore
1192the previous value. 1504the previous value.
1193 1505
1506=item $fd = $term->pty_fd
1507
1508Returns the master file descriptor for the pty in use, or C<-1> if no pty
1509is used.
1510
1194=item $windowid = $term->parent 1511=item $windowid = $term->parent
1195 1512
1196Return the window id of the toplevel window. 1513Return the window id of the toplevel window.
1197 1514
1198=item $windowid = $term->vt 1515=item $windowid = $term->vt
1204Adds the specified events to the vt event mask. Useful e.g. when you want 1521Adds the specified events to the vt event mask. Useful e.g. when you want
1205to receive pointer events all the times: 1522to receive pointer events all the times:
1206 1523
1207 $term->vt_emask_add (urxvt::PointerMotionMask); 1524 $term->vt_emask_add (urxvt::PointerMotionMask);
1208 1525
1526=item $term->focus_in
1527
1528=item $term->focus_out
1529
1530=item $term->key_press ($state, $keycode[, $time])
1531
1532=item $term->key_release ($state, $keycode[, $time])
1533
1534Deliver various fake events to to terminal.
1535
1209=item $window_width = $term->width 1536=item $window_width = $term->width
1210 1537
1211=item $window_height = $term->height 1538=item $window_height = $term->height
1212 1539
1213=item $font_width = $term->fwidth 1540=item $font_width = $term->fwidth
1243=item $env = $term->env 1570=item $env = $term->env
1244 1571
1245Returns a copy of the environment in effect for the terminal as a hashref 1572Returns a copy of the environment in effect for the terminal as a hashref
1246similar to C<\%ENV>. 1573similar to C<\%ENV>.
1247 1574
1575=item @envv = $term->envv
1576
1577Returns the environment as array of strings of the form C<VAR=VALUE>.
1578
1579=item @argv = $term->argv
1580
1581Return the argument vector as this terminal, similar to @ARGV, but
1582includes the program name as first element.
1583
1248=cut 1584=cut
1249 1585
1250sub env { 1586sub env {
1251 if (my $env = $_[0]->_env) {
1252 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1587 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1253 } else {
1254 +{ %ENV }
1255 }
1256} 1588}
1257 1589
1258=item $modifiermask = $term->ModLevel3Mask 1590=item $modifiermask = $term->ModLevel3Mask
1259 1591
1260=item $modifiermask = $term->ModMetaMask 1592=item $modifiermask = $term->ModMetaMask
1261 1593
1262=item $modifiermask = $term->ModNumLockMask 1594=item $modifiermask = $term->ModNumLockMask
1263 1595
1264Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1596Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1265AltGr), the meta key (often Alt) and the num lock key, if applicable. 1597AltGr), the meta key (often Alt) and the num lock key, if applicable.
1598
1599=item $screen = $term->current_screen
1600
1601Returns the currently displayed screen (0 primary, 1 secondary).
1602
1603=item $cursor_is_hidden = $term->hidden_cursor
1604
1605Returns whether the cursor is currently hidden or not.
1266 1606
1267=item $view_start = $term->view_start ([$newvalue]) 1607=item $view_start = $term->view_start ([$newvalue])
1268 1608
1269Returns the row number of the topmost displayed line. Maximum value is 1609Returns the row number of the topmost displayed line. Maximum value is
1270C<0>, which displays the normal terminal contents. Lower values scroll 1610C<0>, which displays the normal terminal contents. Lower values scroll
1278 1618
1279Used after changing terminal contents to display them. 1619Used after changing terminal contents to display them.
1280 1620
1281=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1282 1622
1283Returns the text of the entire row with number C<$row_number>. Row C<0> 1623Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1284is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1624is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1285terminal line. The scrollback buffer starts at line C<-1> and extends to
1286line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1625terminal line. Nothing will be returned if a nonexistent line
1287is requested. 1626is requested.
1288 1627
1289If C<$new_text> is specified, it will replace characters in the current 1628If C<$new_text> is specified, it will replace characters in the current
1290line, starting at column C<$start_col> (default C<0>), which is useful 1629line, starting at column C<$start_col> (default C<0>), which is useful
1291to replace only parts of a line. The font index in the rendition will 1630to replace only parts of a line. The font index in the rendition will
1292automatically be updated. 1631automatically be updated.
1293 1632
1294C<$text> is in a special encoding: tabs and wide characters that use more 1633C<$text> is in a special encoding: tabs and wide characters that use more
1295than one cell when displayed are padded with urxvt::NOCHAR characters 1634than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1296(C<chr 65535>). Characters with combining characters and other characters 1635characters. Characters with combining characters and other characters that
1297that do not fit into the normal tetx encoding will be replaced with 1636do not fit into the normal text encoding will be replaced with characters
1298characters in the private use area. 1637in the private use area.
1299 1638
1300You have to obey this encoding when changing text. The advantage is 1639You have to obey this encoding when changing text. The advantage is
1301that C<substr> and similar functions work on screen cells and not on 1640that C<substr> and similar functions work on screen cells and not on
1302characters. 1641characters.
1303 1642
1447where one character corresponds to one screen cell. See 1786where one character corresponds to one screen cell. See
1448C<< $term->ROW_t >> for details. 1787C<< $term->ROW_t >> for details.
1449 1788
1450=item $string = $term->special_decode $text 1789=item $string = $term->special_decode $text
1451 1790
1452Converts rxvt-unicodes text reprsentation into a perl string. See 1791Converts rxvt-unicodes text representation into a perl string. See
1453C<< $term->ROW_t >> for details. 1792C<< $term->ROW_t >> for details.
1454 1793
1455=item $success = $term->grab_button ($button, $modifiermask) 1794=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1456 1795
1796=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1797
1457Registers a synchronous button grab. See the XGrabButton manpage. 1798Register/unregister a synchronous button grab. See the XGrabButton
1799manpage.
1458 1800
1459=item $success = $term->grab ($eventtime[, $sync]) 1801=item $success = $term->grab ($eventtime[, $sync])
1460 1802
1461Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1803Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1462synchronous (C<$sync> is true). Also remembers the grab timestampe. 1804synchronous (C<$sync> is true). Also remembers the grab timestamp.
1463 1805
1464=item $term->allow_events_async 1806=item $term->allow_events_async
1465 1807
1466Calls XAllowEvents with AsyncBoth for the most recent grab. 1808Calls XAllowEvents with AsyncBoth for the most recent grab.
1467 1809
1477=item $term->ungrab 1819=item $term->ungrab
1478 1820
1479Calls XUngrab for the most recent grab. Is called automatically on 1821Calls XUngrab for the most recent grab. Is called automatically on
1480evaluation errors, as it is better to lose the grab in the error case as 1822evaluation errors, as it is better to lose the grab in the error case as
1481the session. 1823the session.
1824
1825=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826
1827=item $atom_name = $term->XGetAtomName ($atom)
1828
1829=item @atoms = $term->XListProperties ($window)
1830
1831=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1832
1833=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1834
1835=item $term->XDeleteProperty ($window, $property)
1836
1837=item $window = $term->DefaultRootWindow
1838
1839=item $term->XReparentWindow ($window, $parent, [$x, $y])
1840
1841=item $term->XMapWindow ($window)
1842
1843=item $term->XUnmapWindow ($window)
1844
1845=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1846
1847=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1848
1849=item $term->XChangeInput ($window, $add_events[, $del_events])
1850
1851Various X or X-related functions. The C<$term> object only serves as
1852the source of the display, otherwise those functions map more-or-less
1853directory onto the X functions of the same name.
1482 1854
1483=back 1855=back
1484 1856
1485=cut 1857=cut
1486 1858
1550 my ($self, $text, $cb) = @_; 1922 my ($self, $text, $cb) = @_;
1551 1923
1552 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1924 $self->add_item ({ type => "button", text => $text, activate => $cb});
1553} 1925}
1554 1926
1555=item $popup->add_toggle ($text, $cb, $initial_value) 1927=item $popup->add_toggle ($text, $initial_value, $cb)
1556 1928
1557Adds a toggle/checkbox item to the popup. Teh callback gets called 1929Adds a toggle/checkbox item to the popup. The callback gets called
1558whenever it gets toggled, with a boolean indicating its value as its first 1930whenever it gets toggled, with a boolean indicating its new value as its
1559argument. 1931first argument.
1560 1932
1561=cut 1933=cut
1562 1934
1563sub add_toggle { 1935sub add_toggle {
1564 my ($self, $text, $cb, $value) = @_; 1936 my ($self, $text, $value, $cb) = @_;
1565 1937
1566 my $item; $item = { 1938 my $item; $item = {
1567 type => "button", 1939 type => "button",
1568 text => " $text", 1940 text => " $text",
1569 value => $value, 1941 value => $value,
1588 my $env = $self->{term}->env; 1960 my $env = $self->{term}->env;
1589 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1961 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1590 delete $env->{LC_ALL}; 1962 delete $env->{LC_ALL};
1591 $env->{LC_CTYPE} = $self->{term}->locale; 1963 $env->{LC_CTYPE} = $self->{term}->locale;
1592 1964
1593 urxvt::term->new ($env, $self->{term}->resource ("name"), 1965 my $term = urxvt::term->new (
1594 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1966 $env, "popup",
1967 "--perl-lib" => "", "--perl-ext-common" => "",
1968 "-pty-fd" => -1, "-sl" => 0,
1969 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1595 "--transient-for" => $self->{term}->parent, 1970 "--transient-for" => $self->{term}->parent,
1596 "-display" => $self->{term}->display_id, 1971 "-display" => $self->{term}->display_id,
1597 "-pe" => "urxvt-popup") 1972 "-pe" => "urxvt-popup",
1598 or die "unable to create popup window\n"; 1973 ) or die "unable to create popup window\n";
1974
1975 unless (delete $term->{urxvt_popup_init_done}) {
1976 $term->ungrab;
1977 $term->destroy;
1978 die "unable to initialise popup window\n";
1979 }
1599} 1980}
1600 1981
1601sub DESTROY { 1982sub DESTROY {
1602 my ($self) = @_; 1983 my ($self) = @_;
1603 1984
1604 delete $self->{term}{_destroy}{$self}; 1985 delete $self->{term}{_destroy}{$self};
1605 $self->{term}->ungrab; 1986 $self->{term}->ungrab;
1606} 1987}
1607 1988
1608=back 1989=back
1990
1991=cut
1992
1993package urxvt::watcher;
1609 1994
1610=head2 The C<urxvt::timer> Class 1995=head2 The C<urxvt::timer> Class
1611 1996
1612This class implements timer watchers/events. Time is represented as a 1997This class implements timer watchers/events. Time is represented as a
1613fractional number of seconds since the epoch. Example: 1998fractional number of seconds since the epoch. Example:
1617 ->new 2002 ->new
1618 ->interval (1) 2003 ->interval (1)
1619 ->cb (sub { 2004 ->cb (sub {
1620 $term->{overlay}->set (0, 0, 2005 $term->{overlay}->set (0, 0,
1621 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1622 }); 2007 });
1623 2008
1624=over 4 2009=over 4
1625 2010
1626=item $timer = new urxvt::timer 2011=item $timer = new urxvt::timer
1627 2012
1651Start the timer. 2036Start the timer.
1652 2037
1653=item $timer = $timer->start ($tstamp) 2038=item $timer = $timer->start ($tstamp)
1654 2039
1655Set the event trigger time to C<$tstamp> and start the timer. 2040Set the event trigger time to C<$tstamp> and start the timer.
2041
2042=item $timer = $timer->after ($delay)
2043
2044Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1656 2045
1657=item $timer = $timer->stop 2046=item $timer = $timer->stop
1658 2047
1659Stop the timer. 2048Stop the timer.
1660 2049
1666 2055
1667 $term->{socket} = ... 2056 $term->{socket} = ...
1668 $term->{iow} = urxvt::iow 2057 $term->{iow} = urxvt::iow
1669 ->new 2058 ->new
1670 ->fd (fileno $term->{socket}) 2059 ->fd (fileno $term->{socket})
1671 ->events (urxvt::EVENT_READ) 2060 ->events (urxvt::EV_READ)
1672 ->start 2061 ->start
1673 ->cb (sub { 2062 ->cb (sub {
1674 my ($iow, $revents) = @_; 2063 my ($iow, $revents) = @_;
1675 # $revents must be 1 here, no need to check 2064 # $revents must be 1 here, no need to check
1676 sysread $term->{socket}, my $buf, 8192 2065 sysread $term->{socket}, my $buf, 8192
1689Set the callback to be called when io events are triggered. C<$reventmask> 2078Set the callback to be called when io events are triggered. C<$reventmask>
1690is a bitset as described in the C<events> method. 2079is a bitset as described in the C<events> method.
1691 2080
1692=item $iow = $iow->fd ($fd) 2081=item $iow = $iow->fd ($fd)
1693 2082
1694Set the filedescriptor (not handle) to watch. 2083Set the file descriptor (not handle) to watch.
1695 2084
1696=item $iow = $iow->events ($eventmask) 2085=item $iow = $iow->events ($eventmask)
1697 2086
1698Set the event mask to watch. The only allowed values are 2087Set the event mask to watch. The only allowed values are
1699C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2088C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1700together, or C<urxvt::EVENT_NONE>. 2089together, or C<urxvt::EV_NONE>.
1701 2090
1702=item $iow = $iow->start 2091=item $iow = $iow->start
1703 2092
1704Start watching for requested events on the given handle. 2093Start watching for requested events on the given handle.
1705 2094
1706=item $iow = $iow->stop 2095=item $iow = $iow->stop
1707 2096
1708Stop watching for events on the given filehandle. 2097Stop watching for events on the given file handle.
2098
2099=back
2100
2101=head2 The C<urxvt::iw> Class
2102
2103This class implements idle watchers, that get called automatically when
2104the process is idle. They should return as fast as possible, after doing
2105some useful work.
2106
2107=over 4
2108
2109=item $iw = new urxvt::iw
2110
2111Create a new idle watcher object in stopped state.
2112
2113=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2114
2115Set the callback to be called when the watcher triggers.
2116
2117=item $timer = $timer->start
2118
2119Start the watcher.
2120
2121=item $timer = $timer->stop
2122
2123Stop the watcher.
2124
2125=back
2126
2127=head2 The C<urxvt::pw> Class
2128
2129This class implements process watchers. They create an event whenever a
2130process exits, after which they stop automatically.
2131
2132 my $pid = fork;
2133 ...
2134 $term->{pw} = urxvt::pw
2135 ->new
2136 ->start ($pid)
2137 ->cb (sub {
2138 my ($pw, $exit_status) = @_;
2139 ...
2140 });
2141
2142=over 4
2143
2144=item $pw = new urxvt::pw
2145
2146Create a new process watcher in stopped state.
2147
2148=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2149
2150Set the callback to be called when the timer triggers.
2151
2152=item $pw = $timer->start ($pid)
2153
2154Tells the watcher to start watching for process C<$pid>.
2155
2156=item $pw = $pw->stop
2157
2158Stop the watcher.
1709 2159
1710=back 2160=back
1711 2161
1712=head1 ENVIRONMENT 2162=head1 ENVIRONMENT
1713 2163
1722 2172
1723=item >= 3 - script loading and management 2173=item >= 3 - script loading and management
1724 2174
1725=item >=10 - all called hooks 2175=item >=10 - all called hooks
1726 2176
1727=item >=11 - hook reutrn values 2177=item >=11 - hook return values
1728 2178
1729=back 2179=back
1730 2180
1731=head1 AUTHOR 2181=head1 AUTHOR
1732 2182
1734 http://software.schmorp.de/pkg/rxvt-unicode 2184 http://software.schmorp.de/pkg/rxvt-unicode
1735 2185
1736=cut 2186=cut
1737 2187
17381 21881
2189
2190# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines