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.99 by root, Tue Jan 17 17:09:26 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.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<a>s:
138
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : ()
142 };
93 143
94=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
95 145
96Adds regex search functionality to the scrollback buffer, triggered 146Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 147by a hotkey (default: C<M-s>). While in search mode, normal terminal
102search. 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>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. 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
105was 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
106additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
107selection. 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.
108 189
109=item selection-autotransform 190=item selection-autotransform
110 191
111This selection allows you to do automatic transforms on a selection 192This selection allows you to do automatic transforms on a selection
112whenever a selection is made. 193whenever a selection is made.
125 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/
126 207
127And 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
128paste directly into your (vi :) editor: 209paste directly into your (vi :) editor:
129 210
130 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/
131 212
132Of 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 :)
133 214
134To expand the example above to typical perl error messages ("XXX at 215To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 216FILENAME line YYY."), you need a slightly more elaborate solution:
136 217
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 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/
139 220
140The 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
141every error message as a selection pattern, and the second line transforms 222every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 223the message into vi commands to load the file.
143 224
144=item mark-urls 225=item tabbed
145 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
146Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
147make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
149the 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.
150 313
151=item block-graphics-to-ascii 314=item block-graphics-to-ascii
152 315
153A 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
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 318similar-looking ascii character.
156 319
157=item digital-clock 320=item digital-clock
158 321
159Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
160 323
161=item example-refresh-hooks 324=item remote-clipboard
162 325
163Displays a very simple digital clock in the upper right corner of the 326Somewhat of a misnomer, this extension adds two menu entries to the
164window. Illustrates overwriting the refresh callbacks to create your own 327selection popup that allows one to run external commands to store the
165overlays 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'
166 343
167=item selection-pastebin 344=item selection-pastebin
168 345
169This is a little rarely useful extension that Uploads the selection as 346This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things). (The implementation is 347textfile to a remote site (or does other things). (The implementation is
190After 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
191in the C<selection-pastebin-url> resource (again, the % is the placeholder 368in the C<selection-pastebin-url> resource (again, the % is the placeholder
192for the filename): 369for the filename):
193 370
194 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.
195 383
196=back 384=back
197 385
198=head1 API DOCUMENTATION 386=head1 API DOCUMENTATION
199 387
233 421
234=back 422=back
235 423
236=head2 Extension Objects 424=head2 Extension Objects
237 425
238Very 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
239for 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,
240hooks. 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
241about 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
242begin with an underscore character C<_>: these are reserved for internal 431that begin with an underscore character C<_>: these are reserved for
243use. 432internal use.
244 433
245Although 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
246C<urxvt::term> class on this object. 435C<urxvt::term> class on this object.
247 436
248It has the following methods and data members: 437It has the following methods and data members:
269=head2 Hooks 458=head2 Hooks
270 459
271The following subroutines can be declared in extension files, and will be 460The following subroutines can be declared in extension files, and will be
272called whenever the relevant event happens. 461called whenever the relevant event happens.
273 462
274The 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
275the in the C<Extension Objects> section. 464the in the C<Extension Objects> section.
276 465
277B<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
278event 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
279skipped, and the relevant action might not be carried out by the C++ code. 468relevant action might not be carried out by the C++ code.
280 469
281I<< When in doubt, return a false value (preferably C<()>). >> 470I<< When in doubt, return a false value (preferably C<()>). >>
282 471
283=over 4 472=over 4
284 473
285=item on_init $term 474=item on_init $term
286 475
287Called after a new terminal object has been initialized, but before 476Called after a new terminal object has been initialized, but before
288windows 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
289call or deliver senseless data, as terminal size and other characteristics 478call or deliver senseless data, as terminal size and other characteristics
290have not yet been determined. You can safely query and change resources, 479have not yet been determined. You can safely query and change resources
291though. 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).
292 492
293=item on_reset $term 493=item on_reset $term
294 494
295Called 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
296control 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
297variables. 497variables.
298 498
299=item on_start $term 499=item on_child_start $term, $pid
300 500
301Called at the very end of initialisation of a new terminal, just before 501Called just after the child process has been C<fork>ed.
302returning 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>.
303 507
304=item on_sel_make $term, $eventtime 508=item on_sel_make $term, $eventtime
305 509
306Called 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
307selection 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
314 518
315Called whenever a selection has been copied, but before the selection is 519Called whenever a selection has been copied, but before the selection is
316requested from the server. The selection text can be queried and changed 520requested from the server. The selection text can be queried and changed
317by calling C<< $term->selection >>. 521by calling C<< $term->selection >>.
318 522
319Returning a true value aborts selection grabbing. It will still be hilighted. 523Returning a true value aborts selection grabbing. It will still be highlighted.
320 524
321=item on_sel_extend $term 525=item on_sel_extend $term
322 526
323Called 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
324click) and is either supposed to return false (normal operation), or 528click) and is either supposed to return false (normal operation), or
325should 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
326processing. This can happen multiple times, as long as the callback 530processing. This can happen multiple times, as long as the callback
327returns 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
328supposed to enlarge the selection more and more, if possible. 532supposed to enlarge the selection more and more, if possible.
329 533
330See the F<selection> example extension. 534See the F<selection> example extension.
331 535
332=item on_view_change $term, $offset 536=item on_view_change $term, $offset
333 537
334Called whenever the view offset changes, i..e the user or program 538Called whenever the view offset changes, i.e. the user or program
335scrolls. Offset C<0> means display the normal terminal, positive values 539scrolls. Offset C<0> means display the normal terminal, positive values
336show this many lines of scrollback. 540show this many lines of scrollback.
337 541
338=item on_scroll_back $term, $lines, $saved 542=item on_scroll_back $term, $lines, $saved
339 543
343 547
344It 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,
345$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
346number of lines that will be in the scrollback buffer. 550number of lines that will be in the scrollback buffer.
347 551
348=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
349 563
350Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 564Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
351operating system command) is processed. Cursor position and other state 565operating system command) is processed. Cursor position and other state
352information is up-to-date when this happens. For interoperability, the 566information is up-to-date when this happens. For interoperability, the
353string should start with the extension name and a colon, to distinguish 567string should start with the extension name (sans -osc) and a semicolon,
354it from commands for other extensions, and this might be enforced in the 568to distinguish it from commands for other extensions, and this might be
355future. 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 }
356 580
357Be 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,
358as 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
359other 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.
360 587
361=item on_add_lines $term, $string 588=item on_add_lines $term, $string
362 589
363Called 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
364can 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
385later 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
386you cannot just toggle rendition bits, but only set them. 613you cannot just toggle rendition bits, but only set them.
387 614
388=item on_refresh_begin $term 615=item on_refresh_begin $term
389 616
390Called just before the screen gets redrawn. Can be used for overlay 617Called just before the screen gets redrawn. Can be used for overlay or
391or similar effects by modify terminal contents in refresh_begin, and 618similar effects by modifying the terminal contents in refresh_begin, and
392restoring them in refresh_end. The built-in overlay and selection display 619restoring them in refresh_end. The built-in overlay and selection display
393code is run after this hook, and takes precedence. 620code is run after this hook, and takes precedence.
394 621
395=item on_refresh_end $term 622=item on_refresh_end $term
396 623
397Called just after the screen gets redrawn. See C<on_refresh_begin>. 624Called just after the screen gets redrawn. See C<on_refresh_begin>.
398 625
399=item on_keyboard_command $term, $string 626=item on_user_command $term, $string
400 627
401Called whenever the user presses a key combination that has a 628Called whenever a user-configured event is being activated (e.g. via
402C<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>
403resource 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.
404 640
405=item on_x_event $term, $event 641=item on_x_event $term, $event
406 642
407Called 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
408windows). Should only be used as a last resort. Most event structure 644windows). Should only be used as a last resort. Most event structure
409members are not passed. 645members are not passed.
410 646
647=item on_root_event $term, $event
648
649Like C<on_x_event>, but is called for events on the root window.
650
411=item on_focus_in $term 651=item on_focus_in $term
412 652
413Called whenever the window gets the keyboard focus, before rxvt-unicode 653Called whenever the window gets the keyboard focus, before rxvt-unicode
414does focus in processing. 654does focus in processing.
415 655
416=item on_focus_out $term 656=item on_focus_out $term
417 657
418Called wheneever the window loses keyboard focus, before rxvt-unicode does 658Called whenever the window loses keyboard focus, before rxvt-unicode does
419focus out processing. 659focus out processing.
660
661=item on_configure_notify $term, $event
662
663=item on_property_notify $term, $event
420 664
421=item on_key_press $term, $event, $keysym, $octets 665=item on_key_press $term, $event, $keysym, $octets
422 666
423=item on_key_release $term, $event, $keysym 667=item on_key_release $term, $event, $keysym
424 668
434 678
435Called whenever the corresponding X event is received for the terminal If 679Called whenever the corresponding X event is received for the terminal If
436the 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.
437 681
438The 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
439manpage), 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
440and column under the mouse cursor. 684(real, not screen-based) row and column under the mouse cursor.
441 685
442C<on_key_press> additionally receives the string rxvt-unicode would 686C<on_key_press> additionally receives the string rxvt-unicode would
443output, if any, in locale-specific encoding. 687output, if any, in locale-specific encoding.
444 688
445subwindow. 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).
446 699
447=back 700=back
448 701
449=cut 702=cut
450 703
456use Scalar::Util (); 709use Scalar::Util ();
457use List::Util (); 710use List::Util ();
458 711
459our $VERSION = 1; 712our $VERSION = 1;
460our $TERM; 713our $TERM;
714our @TERM_INIT;
715our @TERM_EXT;
461our @HOOKNAME; 716our @HOOKNAME;
462our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 717our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
463our %OPTION; 718our %OPTION;
464 719
465our $LIBDIR; 720our $LIBDIR;
466our $RESNAME; 721our $RESNAME;
467our $RESCLASS; 722our $RESCLASS;
468our $RXVTNAME; 723our $RXVTNAME;
469 724
725our $NOCHAR = chr 0xffff;
726
470=head2 Variables in the C<urxvt> Package 727=head2 Variables in the C<urxvt> Package
471 728
472=over 4 729=over 4
473 730
474=item $urxvt::LIBDIR 731=item $urxvt::LIBDIR
486 743
487=item $urxvt::TERM 744=item $urxvt::TERM
488 745
489The current terminal. This variable stores the current C<urxvt::term> 746The current terminal. This variable stores the current C<urxvt::term>
490object, 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>.
491 764
492=back 765=back
493 766
494=head2 Functions in the C<urxvt> Package 767=head2 Functions in the C<urxvt> Package
495 768
509 782
510Using 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
511correct place, e.g. on stderr of the connecting urxvtc client. 784correct place, e.g. on stderr of the connecting urxvtc client.
512 785
513Messages 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).
514 794
515=item $time = urxvt::NOW 795=item $time = urxvt::NOW
516 796
517Returns the "current time" (as per the event loop). 797Returns the "current time" (as per the event loop).
518 798
577 857
578=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 858=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
579 859
580=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 860=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
581 861
862=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
863
582Replace the foreground/background colour in the rendition mask with the 864Replace the foreground/background colour in the rendition mask with the
583specified one. 865specified one.
584 866
585=item $value = urxvt::GET_CUSTOM $rend 867=item $value = urxvt::GET_CUSTOM $rend
586 868
595=back 877=back
596 878
597=cut 879=cut
598 880
599BEGIN { 881BEGIN {
600 urxvt->bootstrap;
601
602 # overwrite perl's warn 882 # overwrite perl's warn
603 *CORE::GLOBAL::warn = sub { 883 *CORE::GLOBAL::warn = sub {
604 my $msg = join "", @_; 884 my $msg = join "", @_;
605 $msg .= "\n" 885 $msg .= "\n"
606 unless $msg =~ /\n$/; 886 unless $msg =~ /\n$/;
607 urxvt::warn ($msg); 887 urxvt::warn ($msg);
608 }; 888 };
609
610 # %ENV is the original startup environment
611 delete $ENV{IFS};
612 delete $ENV{CDPATH};
613 delete $ENV{BASH_ENV};
614 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
615} 889}
890
891no warnings 'utf8';
616 892
617my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 893my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
618 894
619sub verbose { 895sub verbose {
620 my ($level, $msg) = @_; 896 my ($level, $msg) = @_;
621 warn "$msg\n" if $level <= $verbosity; 897 warn "$msg\n" if $level <= $verbosity;
622} 898}
623 899
624my $extension_pkg = "extension0000";
625my %extension_pkg; 900my %extension_pkg;
626 901
627# load a single script into its own package, once only 902# load a single script into its own package, once only
628sub extension_package($) { 903sub extension_package($) {
629 my ($path) = @_; 904 my ($path) = @_;
630 905
631 $extension_pkg{$path} ||= do { 906 $extension_pkg{$path} ||= do {
632 my $pkg = "urxvt::" . ($extension_pkg++); 907 $path =~ /([^\/\\]+)$/;
908 my $pkg = $1;
909 $pkg =~ s/[^[:word:]]/_/g;
910 $pkg = "urxvt::ext::$pkg";
633 911
634 verbose 3, "loading extension '$path' into package '$pkg'"; 912 verbose 3, "loading extension '$path' into package '$pkg'";
635 913
636 open my $fh, "<:raw", $path 914 open my $fh, "<:raw", $path
637 or die "$path: $!"; 915 or die "$path: $!";
638 916
639 my $source = 917 my $source =
640 "package $pkg; use strict; use utf8;\n" 918 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
641 . "use base urxvt::term::extension::;\n"
642 . "#line 1 \"$path\"\n{\n" 919 . "#line 1 \"$path\"\n{\n"
643 . (do { local $/; <$fh> }) 920 . (do { local $/; <$fh> })
644 . "\n};\n1"; 921 . "\n};\n1";
645 922
646 eval $source 923 eval $source
657 local $TERM = shift; 934 local $TERM = shift;
658 my $htype = shift; 935 my $htype = shift;
659 936
660 if ($htype == 0) { # INIT 937 if ($htype == 0) { # INIT
661 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 938 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
662 939
663 my %ext_arg; 940 my %ext_arg;
664 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
665 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 951 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
666 if ($_ eq "default") { 952 if ($_ eq "default") {
667 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 953 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
668 } elsif (/^-(.*)$/) { 954 } elsif (/^-(.*)$/) {
669 delete $ext_arg{$1}; 955 delete $ext_arg{$1};
670 } elsif (/^([^<]+)<(.*)>$/) { 956 } elsif (/^([^<]+)<(.*)>$/) {
671 push @{ $ext_arg{$1} }, $2; 957 push @{ $ext_arg{$1} }, $2;
672 } else { 958 } else {
673 $ext_arg{$_} ||= []; 959 $ext_arg{$_} ||= [];
674 } 960 }
675 } 961 }
676 962
677 while (my ($ext, $argv) = each %ext_arg) { 963 for my $ext (sort keys %ext_arg) {
678 my @files = grep -f $_, map "$_/$ext", @dirs; 964 my @files = grep -f $_, map "$_/$ext", @dirs;
679 965
680 if (@files) { 966 if (@files) {
681 $TERM->register_package (extension_package $files[0], $argv); 967 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
682 } else { 968 } else {
683 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";
684 } 970 }
685 } 971 }
686 972
692 978
693 if (my $cb = $TERM->{_hook}[$htype]) { 979 if (my $cb = $TERM->{_hook}[$htype]) {
694 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 980 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
695 if $verbosity >= 10; 981 if $verbosity >= 10;
696 982
697 keys %$cb; 983 for my $pkg (keys %$cb) {
698
699 while (my ($pkg, $cb) = each %$cb) {
700 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 984 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
701 and last; 985 $retval ||= $retval_;
702 986
703 if ($@) { 987 if ($@) {
704 $TERM->ungrab; # better to lose the grab than the session 988 $TERM->ungrab; # better to lose the grab than the session
705 warn $@; 989 warn $@;
706 } 990 }
719 } 1003 }
720 1004
721 $retval 1005 $retval
722} 1006}
723 1007
724sub exec_async(@) { 1008sub SET_COLOR($$$) {
725 my $pid = fork; 1009 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1010}
726 1011
727 return 1012sub rend2mask {
728 if !defined $pid or $pid; 1013 no strict 'refs';
729 1014 my ($str, $mask) = (@_, 0);
730 %ENV = %{ $TERM->env }; 1015 my %color = ( fg => undef, bg => undef );
731 1016 my @failed;
732 exec @_; 1017 for my $spec ( split /\s+/, $str ) {
733 _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)
734} 1035}
735 1036
736# urxvt::term::extension 1037# urxvt::term::extension
737 1038
738package urxvt::term::extension; 1039package urxvt::term::extension;
809is 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
810work. 1111work.
811 1112
812=cut 1113=cut
813 1114
814our $VERSION = 1; 1115our $VERSION = '3.4';
815 1116
816$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
817push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
818 1119
819sub timer { 1120sub timer {
850 1151
851sub DESTROY { 1152sub DESTROY {
852 $_[0][1]->stop; 1153 $_[0][1]->stop;
853} 1154}
854 1155
855sub condvar { 1156sub one_event {
856 bless \my $flag, urxvt::anyevent::condvar::
857}
858
859sub urxvt::anyevent::condvar::broadcast {
860 ${$_[0]}++;
861}
862
863sub urxvt::anyevent::condvar::wait {
864 unless (${$_[0]}) {
865 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";
866 }
867} 1158}
868 1159
869package urxvt::term; 1160package urxvt::term;
870 1161
871=head2 The C<urxvt::term> Class 1162=head2 The C<urxvt::term> Class
876 1167
877# find on_xxx subs in the package and register them 1168# find on_xxx subs in the package and register them
878# as hooks 1169# as hooks
879sub register_package { 1170sub register_package {
880 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::;
881 1178
882 my $proxy = bless { 1179 my $proxy = bless {
883 _pkg => $pkg, 1180 _pkg => $pkg,
884 argv => $argv, 1181 argv => $argv,
885 }, $pkg; 1182 }, $pkg;
901hash which defines the environment of the new terminal. 1198hash which defines the environment of the new terminal.
902 1199
903Croaks (and probably outputs an error message) if the new instance 1200Croaks (and probably outputs an error message) if the new instance
904couldn'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
905initialise perl, and the terminal object otherwise. The C<init> and 1202initialise perl, and the terminal object otherwise. The C<init> and
906C<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).
907 1205
908=cut 1206=cut
909 1207
910sub new { 1208sub new {
911 my ($class, $env, @args) = @_; 1209 my ($class, $env, @args) = @_;
912 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
913 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1214 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
914} 1215}
915 1216
916=item $term->destroy 1217=item $term->destroy
917 1218
918Destroy the terminal object (close the window, free resources 1219Destroy the terminal object (close the window, free resources
919etc.). 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
920watchers (timers, io watchers) are still active. 1221watchers (timers, io watchers) are still active.
921 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
922=item $isset = $term->option ($optval[, $set]) 1248=item $isset = $term->option ($optval[, $set])
923 1249
924Returns true if the option specified by C<$optval> is enabled, and 1250Returns true if the option specified by C<$optval> is enabled, and
925optionally 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
926C<%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.
927 1253
928Here 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
929source file F</src/optinc.h> to see the actual list: 1255source file F</src/optinc.h> to see the actual list:
930 1256
931 borderLess console cursorBlink cursorUnderline hold iconic insecure 1257 borderLess console cursorBlink cursorUnderline hold iconic insecure
932 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1258 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
933 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1259 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
934 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1260 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
935 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1261 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
936 tripleclickwords utmpInhibit visualBell 1262 transparent tripleclickwords utmpInhibit visualBell
937 1263
938=item $value = $term->resource ($name[, $newval]) 1264=item $value = $term->resource ($name[, $newval])
939 1265
940Returns the current resource value associated with a given name and 1266Returns the current resource value associated with a given name and
941optionally 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>
950likely change). 1276likely change).
951 1277
952Please note that resource strings will currently only be freed when the 1278Please note that resource strings will currently only be freed when the
953terminal is destroyed, so changing options frequently will eat memory. 1279terminal is destroyed, so changing options frequently will eat memory.
954 1280
955Here 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
956are 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>
957to see the actual list: 1283to see the actual list:
958 1284
959 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
960 borderLess color cursorBlink cursorUnderline cutchars delete_key 1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
961 display_name embed ext_bwidth fade font geometry hold iconName 1287 display_name embed ext_bwidth fade font geometry hold iconName
962 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles
963 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
964 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
965 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
966 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
967 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
968 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
969 shade term_name title transparent transparent_all tripleclickwords 1295 secondaryScreen secondaryScroll shade term_name title
970 utmpInhibit visualBell 1296 transient_for transparent transparent_all tripleclickwords utmpInhibit
1297 visualBell
971 1298
972=cut 1299=cut
973 1300
974sub resource($$;$) { 1301sub resource($$;$) {
975 my ($self, $name) = (shift, shift); 1302 my ($self, $name) = (shift, shift);
976 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1303 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
977 &urxvt::term::_resource 1304 goto &urxvt::term::_resource
978} 1305}
979 1306
980=item $value = $term->x_resource ($pattern) 1307=item $value = $term->x_resource ($pattern)
981 1308
982Returns the X-Resource for the given pattern, excluding the program or 1309Returns the X-Resource for the given pattern, excluding the program or
1065 1392
1066The methods currently supported on C<urxvt::overlay> objects are: 1393The methods currently supported on C<urxvt::overlay> objects are:
1067 1394
1068=over 4 1395=over 4
1069 1396
1070=item $overlay->set ($x, $y, $text, $rend) 1397=item $overlay->set ($x, $y, $text[, $rend])
1071 1398
1072Similar 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
1073text 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
1074at 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.
1075 1404
1076=item $overlay->hide 1405=item $overlay->hide
1077 1406
1078If visible, hide the overlay, but do not destroy it. 1407If visible, hide the overlay, but do not destroy it.
1079 1408
1149 1478
1150Normally 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
1151confused by changes in cursor position or scrolling. Its useful inside a 1480confused by changes in cursor position or scrolling. Its useful inside a
1152C<on_add_lines> hook, though. 1481C<on_add_lines> hook, though.
1153 1482
1483=item $term->scr_change_screen ($screen)
1484
1485Switch to given screen - 0 primary, 1 secondary.
1486
1154=item $term->cmd_parse ($octets) 1487=item $term->cmd_parse ($octets)
1155 1488
1156Similar 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
1157locale-specific encoding of the terminal and can contain command sequences 1490locale-specific encoding of the terminal and can contain command sequences
1158(escape codes) that will be interpreted. 1491(escape codes) that will be interpreted.
1168Replaces 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
1169be 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
1170description of C<< urxvt::timer->events >>. Make sure to always restore 1503description of C<< urxvt::timer->events >>. Make sure to always restore
1171the previous value. 1504the previous value.
1172 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
1173=item $windowid = $term->parent 1511=item $windowid = $term->parent
1174 1512
1175Return the window id of the toplevel window. 1513Return the window id of the toplevel window.
1176 1514
1177=item $windowid = $term->vt 1515=item $windowid = $term->vt
1183Adds 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
1184to receive pointer events all the times: 1522to receive pointer events all the times:
1185 1523
1186 $term->vt_emask_add (urxvt::PointerMotionMask); 1524 $term->vt_emask_add (urxvt::PointerMotionMask);
1187 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
1188=item $window_width = $term->width 1536=item $window_width = $term->width
1189 1537
1190=item $window_height = $term->height 1538=item $window_height = $term->height
1191 1539
1192=item $font_width = $term->fwidth 1540=item $font_width = $term->fwidth
1222=item $env = $term->env 1570=item $env = $term->env
1223 1571
1224Returns 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
1225similar to C<\%ENV>. 1573similar to C<\%ENV>.
1226 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
1227=cut 1584=cut
1228 1585
1229sub env { 1586sub env {
1230 if (my $env = $_[0]->_env) {
1231 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1587 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1232 } else {
1233 +{ %ENV }
1234 }
1235} 1588}
1236 1589
1237=item $modifiermask = $term->ModLevel3Mask 1590=item $modifiermask = $term->ModLevel3Mask
1238 1591
1239=item $modifiermask = $term->ModMetaMask 1592=item $modifiermask = $term->ModMetaMask
1240 1593
1241=item $modifiermask = $term->ModNumLockMask 1594=item $modifiermask = $term->ModNumLockMask
1242 1595
1243Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1596Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1244AltGr), 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.
1245 1606
1246=item $view_start = $term->view_start ([$newvalue]) 1607=item $view_start = $term->view_start ([$newvalue])
1247 1608
1248Returns the row number of the topmost displayed line. Maximum value is 1609Returns the row number of the topmost displayed line. Maximum value is
1249C<0>, which displays the normal terminal contents. Lower values scroll 1610C<0>, which displays the normal terminal contents. Lower values scroll
1257 1618
1258Used after changing terminal contents to display them. 1619Used after changing terminal contents to display them.
1259 1620
1260=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1261 1622
1262Returns 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 >>
1263is 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
1264terminal line. The scrollback buffer starts at line C<-1> and extends to
1265line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1625terminal line. Nothing will be returned if a nonexistent line
1266is requested. 1626is requested.
1267 1627
1268If 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
1269line, 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
1270to 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
1271automatically be updated. 1631automatically be updated.
1272 1632
1273C<$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
1274than one cell when displayed are padded with urxvt::NOCHAR characters 1634than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1275(C<chr 65535>). Characters with combining characters and other characters 1635characters. Characters with combining characters and other characters that
1276that 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
1277characters in the private use area. 1637in the private use area.
1278 1638
1279You have to obey this encoding when changing text. The advantage is 1639You have to obey this encoding when changing text. The advantage is
1280that 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
1281characters. 1641characters.
1282 1642
1426where one character corresponds to one screen cell. See 1786where one character corresponds to one screen cell. See
1427C<< $term->ROW_t >> for details. 1787C<< $term->ROW_t >> for details.
1428 1788
1429=item $string = $term->special_decode $text 1789=item $string = $term->special_decode $text
1430 1790
1431Converts rxvt-unicodes text reprsentation into a perl string. See 1791Converts rxvt-unicodes text representation into a perl string. See
1432C<< $term->ROW_t >> for details. 1792C<< $term->ROW_t >> for details.
1433 1793
1434=item $success = $term->grab_button ($button, $modifiermask) 1794=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1435 1795
1796=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1797
1436Registers a synchronous button grab. See the XGrabButton manpage. 1798Register/unregister a synchronous button grab. See the XGrabButton
1799manpage.
1437 1800
1438=item $success = $term->grab ($eventtime[, $sync]) 1801=item $success = $term->grab ($eventtime[, $sync])
1439 1802
1440Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1803Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1441synchronous (C<$sync> is true). Also remembers the grab timestampe. 1804synchronous (C<$sync> is true). Also remembers the grab timestamp.
1442 1805
1443=item $term->allow_events_async 1806=item $term->allow_events_async
1444 1807
1445Calls XAllowEvents with AsyncBoth for the most recent grab. 1808Calls XAllowEvents with AsyncBoth for the most recent grab.
1446 1809
1456=item $term->ungrab 1819=item $term->ungrab
1457 1820
1458Calls XUngrab for the most recent grab. Is called automatically on 1821Calls XUngrab for the most recent grab. Is called automatically on
1459evaluation 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
1460the 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.
1461 1854
1462=back 1855=back
1463 1856
1464=cut 1857=cut
1465 1858
1529 my ($self, $text, $cb) = @_; 1922 my ($self, $text, $cb) = @_;
1530 1923
1531 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1924 $self->add_item ({ type => "button", text => $text, activate => $cb});
1532} 1925}
1533 1926
1534=item $popup->add_toggle ($text, $cb, $initial_value) 1927=item $popup->add_toggle ($text, $initial_value, $cb)
1535 1928
1536Adds a toggle/checkbox item to the popup. Teh callback gets called 1929Adds a toggle/checkbox item to the popup. The callback gets called
1537whenever 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
1538argument. 1931first argument.
1539 1932
1540=cut 1933=cut
1541 1934
1542sub add_toggle { 1935sub add_toggle {
1543 my ($self, $text, $cb, $value) = @_; 1936 my ($self, $text, $value, $cb) = @_;
1544 1937
1545 my $item; $item = { 1938 my $item; $item = {
1546 type => "button", 1939 type => "button",
1547 text => " $text", 1940 text => " $text",
1548 value => $value, 1941 value => $value,
1567 my $env = $self->{term}->env; 1960 my $env = $self->{term}->env;
1568 # 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.
1569 delete $env->{LC_ALL}; 1962 delete $env->{LC_ALL};
1570 $env->{LC_CTYPE} = $self->{term}->locale; 1963 $env->{LC_CTYPE} = $self->{term}->locale;
1571 1964
1572 urxvt::term->new ($env, $self->{term}->resource ("name"), 1965 my $term = urxvt::term->new (
1573 "--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",
1574 "--transient-for" => $self->{term}->parent, 1970 "--transient-for" => $self->{term}->parent,
1575 "-display" => $self->{term}->display_id, 1971 "-display" => $self->{term}->display_id,
1576 "-pe" => "urxvt-popup") 1972 "-pe" => "urxvt-popup",
1577 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 }
1578} 1980}
1579 1981
1580sub DESTROY { 1982sub DESTROY {
1581 my ($self) = @_; 1983 my ($self) = @_;
1582 1984
1583 delete $self->{term}{_destroy}{$self}; 1985 delete $self->{term}{_destroy}{$self};
1584 $self->{term}->ungrab; 1986 $self->{term}->ungrab;
1585} 1987}
1586 1988
1587=back 1989=back
1990
1991=cut
1992
1993package urxvt::watcher;
1588 1994
1589=head2 The C<urxvt::timer> Class 1995=head2 The C<urxvt::timer> Class
1590 1996
1591This class implements timer watchers/events. Time is represented as a 1997This class implements timer watchers/events. Time is represented as a
1592fractional number of seconds since the epoch. Example: 1998fractional number of seconds since the epoch. Example:
1596 ->new 2002 ->new
1597 ->interval (1) 2003 ->interval (1)
1598 ->cb (sub { 2004 ->cb (sub {
1599 $term->{overlay}->set (0, 0, 2005 $term->{overlay}->set (0, 0,
1600 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1601 }); 2007 });
1602 2008
1603=over 4 2009=over 4
1604 2010
1605=item $timer = new urxvt::timer 2011=item $timer = new urxvt::timer
1606 2012
1630Start the timer. 2036Start the timer.
1631 2037
1632=item $timer = $timer->start ($tstamp) 2038=item $timer = $timer->start ($tstamp)
1633 2039
1634Set 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>.
1635 2045
1636=item $timer = $timer->stop 2046=item $timer = $timer->stop
1637 2047
1638Stop the timer. 2048Stop the timer.
1639 2049
1645 2055
1646 $term->{socket} = ... 2056 $term->{socket} = ...
1647 $term->{iow} = urxvt::iow 2057 $term->{iow} = urxvt::iow
1648 ->new 2058 ->new
1649 ->fd (fileno $term->{socket}) 2059 ->fd (fileno $term->{socket})
1650 ->events (urxvt::EVENT_READ) 2060 ->events (urxvt::EV_READ)
1651 ->start 2061 ->start
1652 ->cb (sub { 2062 ->cb (sub {
1653 my ($iow, $revents) = @_; 2063 my ($iow, $revents) = @_;
1654 # $revents must be 1 here, no need to check 2064 # $revents must be 1 here, no need to check
1655 sysread $term->{socket}, my $buf, 8192 2065 sysread $term->{socket}, my $buf, 8192
1668Set 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>
1669is a bitset as described in the C<events> method. 2079is a bitset as described in the C<events> method.
1670 2080
1671=item $iow = $iow->fd ($fd) 2081=item $iow = $iow->fd ($fd)
1672 2082
1673Set the filedescriptor (not handle) to watch. 2083Set the file descriptor (not handle) to watch.
1674 2084
1675=item $iow = $iow->events ($eventmask) 2085=item $iow = $iow->events ($eventmask)
1676 2086
1677Set the event mask to watch. The only allowed values are 2087Set the event mask to watch. The only allowed values are
1678C<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
1679together, or C<urxvt::EVENT_NONE>. 2089together, or C<urxvt::EV_NONE>.
1680 2090
1681=item $iow = $iow->start 2091=item $iow = $iow->start
1682 2092
1683Start watching for requested events on the given handle. 2093Start watching for requested events on the given handle.
1684 2094
1685=item $iow = $iow->stop 2095=item $iow = $iow->stop
1686 2096
1687Stop 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.
1688 2159
1689=back 2160=back
1690 2161
1691=head1 ENVIRONMENT 2162=head1 ENVIRONMENT
1692 2163
1701 2172
1702=item >= 3 - script loading and management 2173=item >= 3 - script loading and management
1703 2174
1704=item >=10 - all called hooks 2175=item >=10 - all called hooks
1705 2176
1706=item >=11 - hook reutrn values 2177=item >=11 - hook return values
1707 2178
1708=back 2179=back
1709 2180
1710=head1 AUTHOR 2181=head1 AUTHOR
1711 2182
1713 http://software.schmorp.de/pkg/rxvt-unicode 2184 http://software.schmorp.de/pkg/rxvt-unicode
1714 2185
1715=cut 2186=cut
1716 2187
17171 21881
2189
2190# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines