ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.121 by root, Fri Jan 20 22:49:34 2006 UTC vs.
Revision 1.182 by sf-exg, Wed Feb 17 08:27:56 2010 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
62 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
63 ... 66 ...
64 67
65The index number (0, 1...) must not have any holes, and each regex must 68The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for 69contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
68between two vertical bars: 71between two vertical bars:
69 72
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
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: ^(/[^:]+):\
71 81
72You 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
73interesting uses, such as parsing a line from beginning to end. 83interesting uses, such as parsing a line from beginning to end.
74 84
75This extension also offers following bindable keyboard commands: 85This extension also offers following bindable keyboard commands:
86 96
87=item option-popup (enabled by default) 97=item option-popup (enabled by default)
88 98
89Binds 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
90runtime. 100runtime.
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 };
91 118
92=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
93 120
94Binds 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
95text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
96evaluation, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
97 124
98Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100popup is displayed. 127popup is being displayed.
101 128
102It'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
103is 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.
104It 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
105string 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
106when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
107 134
108The 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
109the 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
110C<a>s: 137C<a>s:
111 138
112 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
114 : () 141 : ()
115 }; 142 };
116 143
117=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
118 145
125search. 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>
126search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
127bottom. 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
128was 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
129additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
130selection. 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.
131 189
132=item selection-autotransform 190=item selection-autotransform
133 191
134This selection allows you to do automatic transforms on a selection 192This selection allows you to do automatic transforms on a selection
135whenever a selection is made. 193whenever a selection is made.
162 220
163The 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
164every error message as a selection pattern, and the second line transforms 222every error message as a selection pattern, and the second line transforms
165the message into vi commands to load the file. 223the message into vi commands to load the file.
166 224
167=item readline
168
169A support package that tries to make editing with readline easier. At the
170moment, it reacts to clicking with the left mouse button by trying to
171move the text cursor to this position. It does so by generating as many
172cursor-left or cursor-right keypresses as required (the this only works
173for programs that correctly support wide characters).
174
175It only works when clicking into the same line (possibly extended over
176multiple rows) as the text cursor and on the primary screen, to reduce the
177risk of misinterpreting. The normal selection isn't disabled, so quick
178successive clicks might interfere with selection creation in harmless
179ways.
180
181=item tabbed 225=item tabbed
182 226
183This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
184is, it implements what is commonly refered to as "tabbed terminal". The topmost line 228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
185displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one 229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
186button per tab. 230button per tab.
187 231
188Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
189B<Shift-Right> will switch to the tab left or right of the current one, 233B<Shift-Right> will switch to the tab left or right of the current one,
190while B<Shift-Down> creates a new tab. 234while B<Shift-Down> creates a new tab.
191 235
192=item mark-urls 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):
193 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
194Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
195make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
196resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
197the 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.
198 258
199=item automove-background 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.
200 263
201This is basically a one-line extension that dynamically changes the background pixmap offset 264It is possible to activate the most recently seen match from the keyboard.
202to the window position, in effect creating the same effect as pseudo transparency with 265Simply bind a keysym to "perl:matcher" as seen in the example below.
203a custom pixmap. No scaling is supported in this mode. Exmaple:
204 266
205 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 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.
206 313
207=item block-graphics-to-ascii 314=item block-graphics-to-ascii
208 315
209A 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
210by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
211similar-looking ascii character. 318similar-looking ascii character.
212 319
213=item digital-clock 320=item digital-clock
214 321
215Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
323
324=item remote-clipboard
325
326Somewhat of a misnomer, this extension adds two menu entries to the
327selection popup that allows one to run external commands to store the
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'
343
344=item selection-pastebin
345
346This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.).
350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
352i.e.
353
354 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
355
356Pressing this combination runs a command with C<%> replaced by the name of
357the textfile. This command can be set via a resource:
358
359 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
360
361And the default is likely not useful to anybody but the few people around
362here :)
363
364The name of the textfile is the hex encoded md5 sum of the selection, so
365the same content should lead to the same filename.
366
367After a successful upload the selection will be replaced by the text given
368in the C<selection-pastebin-url> resource (again, the % is the placeholder
369for the filename):
370
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 macosx-clipboard and macosx-clipboard-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
216 391
217=item example-refresh-hooks 392=item example-refresh-hooks
218 393
219Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
220window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
221overlays or changes. 396overlays or changes.
222
223=item selection-pastebin
224
225This is a little rarely useful extension that Uploads the selection as
226textfile to a remote site (or does other things). (The implementation is
227not currently secure for use in a multiuser environment as it writes to
228F</tmp> directly.).
229
230It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
231i.e.
232
233 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
234
235Pressing this combination runs a command with C<%> replaced by the name of
236the textfile. This command can be set via a resource:
237
238 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
239
240And the default is likely not useful to anybody but the few people around
241here :)
242
243The name of the textfile is the hex encoded md5 sum of the selection, so
244the same content should lead to the same filename.
245
246After a successful upload the selection will be replaced by the text given
247in the C<selection-pastebin-url> resource (again, the % is the placeholder
248for the filename):
249
250 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
251 397
252=back 398=back
253 399
254=head1 API DOCUMENTATION 400=head1 API DOCUMENTATION
255 401
271 417
272=over 4 418=over 4
273 419
274=item $text 420=item $text
275 421
276Rxvt-unicodes special way of encoding text, where one "unicode" character 422Rxvt-unicode's special way of encoding text, where one "unicode" character
277always represents one screen cell. See L<ROW_t> for a discussion of this format. 423always represents one screen cell. See L<ROW_t> for a discussion of this format.
278 424
279=item $string 425=item $string
280 426
281A perl text string, with an emphasis on I<text>. It can store all unicode 427A perl text string, with an emphasis on I<text>. It can store all unicode
289 435
290=back 436=back
291 437
292=head2 Extension Objects 438=head2 Extension Objects
293 439
294Very perl extension is a perl class. A separate perl object is created 440Every perl extension is a perl class. A separate perl object is created
295for each terminal and each extension and passed as the first parameter to 441for each terminal, and each terminal has its own set of extenion objects,
296hooks. So extensions can use their C<$self> object without having to think 442which are passed as the first parameter to hooks. So extensions can use
297about other extensions, with the exception of methods and members that 443their C<$self> object without having to think about clashes with other
444extensions or other terminals, with the exception of methods and members
298begin with an underscore character C<_>: these are reserved for internal 445that begin with an underscore character C<_>: these are reserved for
299use. 446internal use.
300 447
301Although it isn't a C<urxvt::term> object, you can call all methods of the 448Although it isn't a C<urxvt::term> object, you can call all methods of the
302C<urxvt::term> class on this object. 449C<urxvt::term> class on this object.
303 450
304It has the following methods and data members: 451It has the following methods and data members:
325=head2 Hooks 472=head2 Hooks
326 473
327The following subroutines can be declared in extension files, and will be 474The following subroutines can be declared in extension files, and will be
328called whenever the relevant event happens. 475called whenever the relevant event happens.
329 476
330The first argument passed to them is an extension oject as described in 477The first argument passed to them is an extension object as described in
331the in the C<Extension Objects> section. 478the in the C<Extension Objects> section.
332 479
333B<All> of these hooks must return a boolean value. If any of the called 480B<All> of these hooks must return a boolean value. If any of the called
334hooks returns true, then the event counts as being I<consumed>, and the 481hooks returns true, then the event counts as being I<consumed>, and the
335relevant action might not be carried out by the C++ code. 482relevant action might not be carried out by the C++ code.
348place. 495place.
349 496
350=item on_start $term 497=item on_start $term
351 498
352Called at the very end of initialisation of a new terminal, just before 499Called at the very end of initialisation of a new terminal, just before
353trying to map (display) the toplevel and returning to the mainloop. 500trying to map (display) the toplevel and returning to the main loop.
354 501
355=item on_destroy $term 502=item on_destroy $term
356 503
357Called whenever something tries to destroy terminal, before doing anything 504Called whenever something tries to destroy terminal, when the terminal is
358yet. If this hook returns true, then destruction is skipped, but this is 505still fully functional (not for long, though).
359rarely a good idea.
360 506
361=item on_reset $term 507=item on_reset $term
362 508
363Called after the screen is "reset" for any reason, such as resizing or 509Called after the screen is "reset" for any reason, such as resizing or
364control sequences. Here is where you can react on changes to size-related 510control sequences. Here is where you can react on changes to size-related
386 532
387Called whenever a selection has been copied, but before the selection is 533Called whenever a selection has been copied, but before the selection is
388requested from the server. The selection text can be queried and changed 534requested from the server. The selection text can be queried and changed
389by calling C<< $term->selection >>. 535by calling C<< $term->selection >>.
390 536
391Returning a true value aborts selection grabbing. It will still be hilighted. 537Returning a true value aborts selection grabbing. It will still be highlighted.
392 538
393=item on_sel_extend $term 539=item on_sel_extend $term
394 540
395Called whenever the user tries to extend the selection (e.g. with a double 541Called whenever the user tries to extend the selection (e.g. with a double
396click) and is either supposed to return false (normal operation), or 542click) and is either supposed to return false (normal operation), or
397should extend the selection itelf and return true to suppress the built-in 543should extend the selection itself and return true to suppress the built-in
398processing. This can happen multiple times, as long as the callback 544processing. This can happen multiple times, as long as the callback
399returns true, it will be called on every further click by the user and is 545returns true, it will be called on every further click by the user and is
400supposed to enlarge the selection more and more, if possible. 546supposed to enlarge the selection more and more, if possible.
401 547
402See the F<selection> example extension. 548See the F<selection> example extension.
403 549
404=item on_view_change $term, $offset 550=item on_view_change $term, $offset
405 551
406Called whenever the view offset changes, i..e the user or program 552Called whenever the view offset changes, i.e. the user or program
407scrolls. Offset C<0> means display the normal terminal, positive values 553scrolls. Offset C<0> means display the normal terminal, positive values
408show this many lines of scrollback. 554show this many lines of scrollback.
409 555
410=item on_scroll_back $term, $lines, $saved 556=item on_scroll_back $term, $lines, $saved
411 557
415 561
416It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 562It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
417$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 563$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
418number of lines that will be in the scrollback buffer. 564number of lines that will be in the scrollback buffer.
419 565
420=item on_osc_seq $term, $string 566=item on_osc_seq $term, $op, $args, $resp
567
568Called on every OSC sequence and can be used to suppress it or modify its
569behaviour. The default should be to return an empty list. A true value
570suppresses execution of the request completely. Make sure you don't get
571confused by recursive invocations when you output an OSC sequence within
572this callback.
573
574C<on_osc_seq_perl> should be used for new behaviour.
575
576=item on_osc_seq_perl $term, $args, $resp
421 577
422Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 578Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
423operating system command) is processed. Cursor position and other state 579operating system command) is processed. Cursor position and other state
424information is up-to-date when this happens. For interoperability, the 580information is up-to-date when this happens. For interoperability, the
425string should start with the extension name and a colon, to distinguish 581string should start with the extension name (sans -osc) and a semicolon,
426it from commands for other extensions, and this might be enforced in the 582to distinguish it from commands for other extensions, and this might be
427future. 583enforced in the future.
584
585For example, C<overlay-osc> uses this:
586
587 sub on_osc_seq_perl {
588 my ($self, $osc, $resp) = @_;
589
590 return unless $osc =~ s/^overlay;//;
591
592 ... process remaining $osc string
593 }
428 594
429Be careful not ever to trust (in a security sense) the data you receive, 595Be careful not ever to trust (in a security sense) the data you receive,
430as its source can not easily be controleld (e-mail content, messages from 596as its source can not easily be controlled (e-mail content, messages from
431other users on the same system etc.). 597other users on the same system etc.).
598
599For responses, C<$resp> contains the end-of-args separator used by the
600sender.
432 601
433=item on_add_lines $term, $string 602=item on_add_lines $term, $string
434 603
435Called whenever text is about to be output, with the text as argument. You 604Called whenever text is about to be output, with the text as argument. You
436can filter/change and output the text yourself by returning a true value 605can filter/change and output the text yourself by returning a true value
457later with the already-modified line (e.g. if unrelated parts change), so 626later with the already-modified line (e.g. if unrelated parts change), so
458you cannot just toggle rendition bits, but only set them. 627you cannot just toggle rendition bits, but only set them.
459 628
460=item on_refresh_begin $term 629=item on_refresh_begin $term
461 630
462Called just before the screen gets redrawn. Can be used for overlay 631Called just before the screen gets redrawn. Can be used for overlay or
463or similar effects by modify terminal contents in refresh_begin, and 632similar effects by modifying the terminal contents in refresh_begin, and
464restoring them in refresh_end. The built-in overlay and selection display 633restoring them in refresh_end. The built-in overlay and selection display
465code is run after this hook, and takes precedence. 634code is run after this hook, and takes precedence.
466 635
467=item on_refresh_end $term 636=item on_refresh_end $term
468 637
469Called just after the screen gets redrawn. See C<on_refresh_begin>. 638Called just after the screen gets redrawn. See C<on_refresh_begin>.
470 639
471=item on_keyboard_command $term, $string 640=item on_user_command $term, $string
472 641
473Called whenever the user presses a key combination that has a 642Called whenever a user-configured event is being activated (e.g. via
474C<perl:string> action bound to it (see description of the B<keysym> 643a C<perl:string> action bound to a key, see description of the B<keysym>
475resource in the @@RXVT_NAME@@(1) manpage). 644resource in the @@RXVT_NAME@@(1) manpage).
645
646The event is simply the action string. This interface is assumed to change
647slightly in the future.
648
649=item on_resize_all_windows $tern, $new_width, $new_height
650
651Called just after the new window size has been calculated, but before
652windows are actually being resized or hints are being set. If this hook
653returns TRUE, setting of the window hints is being skipped.
476 654
477=item on_x_event $term, $event 655=item on_x_event $term, $event
478 656
479Called on every X event received on the vt window (and possibly other 657Called on every X event received on the vt window (and possibly other
480windows). Should only be used as a last resort. Most event structure 658windows). Should only be used as a last resort. Most event structure
481members are not passed. 659members are not passed.
482 660
661=item on_root_event $term, $event
662
663Like C<on_x_event>, but is called for events on the root window.
664
483=item on_focus_in $term 665=item on_focus_in $term
484 666
485Called whenever the window gets the keyboard focus, before rxvt-unicode 667Called whenever the window gets the keyboard focus, before rxvt-unicode
486does focus in processing. 668does focus in processing.
487 669
488=item on_focus_out $term 670=item on_focus_out $term
489 671
490Called wheneever the window loses keyboard focus, before rxvt-unicode does 672Called whenever the window loses keyboard focus, before rxvt-unicode does
491focus out processing. 673focus out processing.
492 674
493=item on_configure_notify $term, $event 675=item on_configure_notify $term, $event
494 676
495=item on_property_notify $term, $event 677=item on_property_notify $term, $event
506 688
507=item on_map_notify $term, $event 689=item on_map_notify $term, $event
508 690
509=item on_unmap_notify $term, $event 691=item on_unmap_notify $term, $event
510 692
511Called whenever the corresponding X event is received for the terminal If 693Called whenever the corresponding X event is received for the terminal. If
512the hook returns true, then the even will be ignored by rxvt-unicode. 694the hook returns true, then the event will be ignored by rxvt-unicode.
513 695
514The event is a hash with most values as named by Xlib (see the XEvent 696The event is a hash with most values as named by Xlib (see the XEvent
515manpage), with the additional members C<row> and C<col>, which are the 697manpage), with the additional members C<row> and C<col>, which are the
516(real, not screen-based) row and column under the mouse cursor. 698(real, not screen-based) row and column under the mouse cursor.
517 699
526 708
527=item on_wm_delete_window $term, $event 709=item on_wm_delete_window $term, $event
528 710
529Called when various types of ClientMessage events are received (all with 711Called when various types of ClientMessage events are received (all with
530format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 712format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
713
714=item on_bell $term
715
716Called on receipt of a bell character.
531 717
532=back 718=back
533 719
534=cut 720=cut
535 721
552our $LIBDIR; 738our $LIBDIR;
553our $RESNAME; 739our $RESNAME;
554our $RESCLASS; 740our $RESCLASS;
555our $RXVTNAME; 741our $RXVTNAME;
556 742
557our $NOCHAR = chr 0xfffe; 743our $NOCHAR = chr 0xffff;
558 744
559=head2 Variables in the C<urxvt> Package 745=head2 Variables in the C<urxvt> Package
560 746
561=over 4 747=over 4
562 748
578The current terminal. This variable stores the current C<urxvt::term> 764The current terminal. This variable stores the current C<urxvt::term>
579object, whenever a callback/hook is executing. 765object, whenever a callback/hook is executing.
580 766
581=item @urxvt::TERM_INIT 767=item @urxvt::TERM_INIT
582 768
583All coderefs in this array will be called as methods of the next newly 769All code references in this array will be called as methods of the next newly
584created C<urxvt::term> object (during the C<on_init> phase). The array 770created C<urxvt::term> object (during the C<on_init> phase). The array
585gets cleared before the codereferences that were in it are being executed, 771gets cleared before the code references that were in it are being executed,
586so coderefs can push themselves onto it again if they so desire. 772so references can push themselves onto it again if they so desire.
587 773
588This complements to the perl-eval commandline option, but gets executed 774This complements to the perl-eval command line option, but gets executed
589first. 775first.
590 776
591=item @urxvt::TERM_EXT 777=item @urxvt::TERM_EXT
592 778
593Works similar to C<@TERM_INIT>, but contains perl package/class names, which 779Works similar to C<@TERM_INIT>, but contains perl package/class names, which
614 800
615Using this function has the advantage that its output ends up in the 801Using this function has the advantage that its output ends up in the
616correct place, e.g. on stderr of the connecting urxvtc client. 802correct place, e.g. on stderr of the connecting urxvtc client.
617 803
618Messages have a size limit of 1023 bytes currently. 804Messages have a size limit of 1023 bytes currently.
805
806=item @terms = urxvt::termlist
807
808Returns all urxvt::term objects that exist in this process, regardless of
809whether they are started, being destroyed etc., so be careful. Only term
810objects that have perl extensions attached will be returned (because there
811is no urxvt::term objet associated with others).
619 812
620=item $time = urxvt::NOW 813=item $time = urxvt::NOW
621 814
622Returns the "current time" (as per the event loop). 815Returns the "current time" (as per the event loop).
623 816
681Return the foreground/background colour index, respectively. 874Return the foreground/background colour index, respectively.
682 875
683=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 876=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
684 877
685=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 878=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
879
880=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
686 881
687Replace the foreground/background colour in the rendition mask with the 882Replace the foreground/background colour in the rendition mask with the
688specified one. 883specified one.
689 884
690=item $value = urxvt::GET_CUSTOM $rend 885=item $value = urxvt::GET_CUSTOM $rend
709 unless $msg =~ /\n$/; 904 unless $msg =~ /\n$/;
710 urxvt::warn ($msg); 905 urxvt::warn ($msg);
711 }; 906 };
712} 907}
713 908
909no warnings 'utf8';
910
714my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 911my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
715 912
716sub verbose { 913sub verbose {
717 my ($level, $msg) = @_; 914 my ($level, $msg) = @_;
718 warn "$msg\n" if $level <= $verbosity; 915 warn "$msg\n" if $level <= $verbosity;
734 931
735 open my $fh, "<:raw", $path 932 open my $fh, "<:raw", $path
736 or die "$path: $!"; 933 or die "$path: $!";
737 934
738 my $source = 935 my $source =
739 "package $pkg; use strict; use utf8;\n" 936 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
740 . "#line 1 \"$path\"\n{\n" 937 . "#line 1 \"$path\"\n{\n"
741 . (do { local $/; <$fh> }) 938 . (do { local $/; <$fh> })
742 . "\n};\n1"; 939 . "\n};\n1";
743 940
744 eval $source 941 eval $source
755 local $TERM = shift; 952 local $TERM = shift;
756 my $htype = shift; 953 my $htype = shift;
757 954
758 if ($htype == 0) { # INIT 955 if ($htype == 0) { # INIT
759 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 956 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
760 957
761 my %ext_arg; 958 my %ext_arg;
762 959
763 { 960 {
764 my @init = @TERM_INIT; 961 my @init = @TERM_INIT;
765 @TERM_INIT = (); 962 @TERM_INIT = ();
769 $TERM->register_package ($_) for @pkg; 966 $TERM->register_package ($_) for @pkg;
770 } 967 }
771 968
772 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 969 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
773 if ($_ eq "default") { 970 if ($_ eq "default") {
774 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 971 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
775 } elsif (/^-(.*)$/) { 972 } elsif (/^-(.*)$/) {
776 delete $ext_arg{$1}; 973 delete $ext_arg{$1};
777 } elsif (/^([^<]+)<(.*)>$/) { 974 } elsif (/^([^<]+)<(.*)>$/) {
778 push @{ $ext_arg{$1} }, $2; 975 push @{ $ext_arg{$1} }, $2;
779 } else { 976 } else {
780 $ext_arg{$_} ||= []; 977 $ext_arg{$_} ||= [];
781 } 978 }
782 } 979 }
783 980
784 while (my ($ext, $argv) = each %ext_arg) { 981 for my $ext (sort keys %ext_arg) {
785 my @files = grep -f $_, map "$_/$ext", @dirs; 982 my @files = grep -f $_, map "$_/$ext", @dirs;
786 983
787 if (@files) { 984 if (@files) {
788 $TERM->register_package (extension_package $files[0], $argv); 985 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
789 } else { 986 } else {
790 warn "perl extension '$ext' not found in perl library search path\n"; 987 warn "perl extension '$ext' not found in perl library search path\n";
791 } 988 }
792 } 989 }
793 990
799 996
800 if (my $cb = $TERM->{_hook}[$htype]) { 997 if (my $cb = $TERM->{_hook}[$htype]) {
801 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 998 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
802 if $verbosity >= 10; 999 if $verbosity >= 10;
803 1000
804 keys %$cb; 1001 for my $pkg (keys %$cb) {
805
806 while (my ($pkg, $cb) = each %$cb) {
807 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1002 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
808 $retval ||= $retval_; 1003 $retval ||= $retval_;
809 1004
810 if ($@) { 1005 if ($@) {
811 $TERM->ungrab; # better to lose the grab than the session 1006 $TERM->ungrab; # better to lose the grab than the session
812 warn $@; 1007 warn $@;
824 # clear package 1019 # clear package
825 %$TERM = (); 1020 %$TERM = ();
826 } 1021 }
827 1022
828 $retval 1023 $retval
1024}
1025
1026sub SET_COLOR($$$) {
1027 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1028}
1029
1030sub rend2mask {
1031 no strict 'refs';
1032 my ($str, $mask) = (@_, 0);
1033 my %color = ( fg => undef, bg => undef );
1034 my @failed;
1035 for my $spec ( split /\s+/, $str ) {
1036 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1037 $color{lc($1)} = $2;
1038 } else {
1039 my $neg = $spec =~ s/^[-^]//;
1040 unless ( exists &{"RS_$spec"} ) {
1041 push @failed, $spec;
1042 next;
1043 }
1044 my $cur = &{"RS_$spec"};
1045 if ( $neg ) {
1046 $mask &= ~$cur;
1047 } else {
1048 $mask |= $cur;
1049 }
1050 }
1051 }
1052 ($mask, @color{qw(fg bg)}, \@failed)
829} 1053}
830 1054
831# urxvt::term::extension 1055# urxvt::term::extension
832 1056
833package urxvt::term::extension; 1057package urxvt::term::extension;
904is that you cannot use blocking APIs, but the non-blocking variant should 1128is that you cannot use blocking APIs, but the non-blocking variant should
905work. 1129work.
906 1130
907=cut 1131=cut
908 1132
909our $VERSION = 1; 1133our $VERSION = '5.23';
910 1134
911$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1135$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
912push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1136push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
913 1137
914sub timer { 1138sub timer {
916 1140
917 my $cb = $arg{cb}; 1141 my $cb = $arg{cb};
918 1142
919 urxvt::timer 1143 urxvt::timer
920 ->new 1144 ->new
921 ->start (urxvt::NOW + $arg{after}) 1145 ->after ($arg{after}, $arg{interval})
922 ->cb (sub { 1146 ->cb ($arg{interval} ? $cb : sub {
923 $_[0]->stop; # need to cancel manually 1147 $_[0]->stop; # need to cancel manually
924 $cb->(); 1148 $cb->();
925 }) 1149 })
926} 1150}
927 1151
928sub io { 1152sub io {
929 my ($class, %arg) = @_; 1153 my ($class, %arg) = @_;
930 1154
931 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
1156 my $fd = fileno $arg{fh};
1157 defined $fd or $fd = $arg{fh};
932 1158
933 bless [$arg{fh}, urxvt::iow 1159 bless [$arg{fh}, urxvt::iow
934 ->new 1160 ->new
935 ->fd (fileno $arg{fh}) 1161 ->fd ($fd)
936 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1162 ->events (($arg{poll} =~ /r/ ? 1 : 0)
937 | ($arg{poll} =~ /w/ ? 2 : 0)) 1163 | ($arg{poll} =~ /w/ ? 2 : 0))
938 ->start 1164 ->start
939 ->cb (sub { 1165 ->cb ($cb)
940 $cb->(($_[1] & 1 ? 'r' : '')
941 . ($_[1] & 2 ? 'w' : ''));
942 })],
943 urxvt::anyevent:: 1166 ], urxvt::anyevent::
1167}
1168
1169sub idle {
1170 my ($class, %arg) = @_;
1171
1172 my $cb = $arg{cb};
1173
1174 urxvt::iw
1175 ->new
1176 ->start
1177 ->cb ($cb)
1178}
1179
1180sub child {
1181 my ($class, %arg) = @_;
1182
1183 my $cb = $arg{cb};
1184
1185 urxvt::pw
1186 ->new
1187 ->start ($arg{pid})
1188 ->cb (sub {
1189 $_[0]->stop; # need to cancel manually
1190 $cb->($_[0]->rpid, $_[0]->rstatus);
1191 })
944} 1192}
945 1193
946sub DESTROY { 1194sub DESTROY {
947 $_[0][1]->stop; 1195 $_[0][1]->stop;
948} 1196}
949 1197
950sub condvar { 1198sub one_event {
951 bless \my $flag, urxvt::anyevent::condvar::
952}
953
954sub urxvt::anyevent::condvar::broadcast {
955 ${$_[0]}++;
956}
957
958sub urxvt::anyevent::condvar::wait {
959 unless (${$_[0]}) {
960 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1199 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
961 }
962} 1200}
963 1201
964package urxvt::term; 1202package urxvt::term;
965 1203
966=head2 The C<urxvt::term> Class 1204=head2 The C<urxvt::term> Class
1002hash which defines the environment of the new terminal. 1240hash which defines the environment of the new terminal.
1003 1241
1004Croaks (and probably outputs an error message) if the new instance 1242Croaks (and probably outputs an error message) if the new instance
1005couldn't be created. Returns C<undef> if the new instance didn't 1243couldn't be created. Returns C<undef> if the new instance didn't
1006initialise perl, and the terminal object otherwise. The C<init> and 1244initialise perl, and the terminal object otherwise. The C<init> and
1007C<start> hooks will be called during this call. 1245C<start> hooks will be called before this call returns, and are free to
1246refer to global data (which is race free).
1008 1247
1009=cut 1248=cut
1010 1249
1011sub new { 1250sub new {
1012 my ($class, $env, @args) = @_; 1251 my ($class, $env, @args) = @_;
1013 1252
1253 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1254 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1255
1014 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1256 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1015} 1257}
1016 1258
1017=item $term->destroy 1259=item $term->destroy
1018 1260
1019Destroy the terminal object (close the window, free resources 1261Destroy the terminal object (close the window, free resources
1049 1291
1050Returns true if the option specified by C<$optval> is enabled, and 1292Returns true if the option specified by C<$optval> is enabled, and
1051optionally change it. All option values are stored by name in the hash 1293optionally change it. All option values are stored by name in the hash
1052C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1294C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1053 1295
1054Here is a a likely non-exhaustive list of option names, please see the 1296Here is a likely non-exhaustive list of option names, please see the
1055source file F</src/optinc.h> to see the actual list: 1297source file F</src/optinc.h> to see the actual list:
1056 1298
1057 borderLess console cursorBlink cursorUnderline hold iconic insecure 1299 borderLess console cursorBlink cursorUnderline hold iconic insecure
1058 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1300 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1059 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1301 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1076likely change). 1318likely change).
1077 1319
1078Please note that resource strings will currently only be freed when the 1320Please note that resource strings will currently only be freed when the
1079terminal is destroyed, so changing options frequently will eat memory. 1321terminal is destroyed, so changing options frequently will eat memory.
1080 1322
1081Here is a a likely non-exhaustive list of resource names, not all of which 1323Here is a likely non-exhaustive list of resource names, not all of which
1082are supported in every build, please see the source file F</src/rsinc.h> 1324are supported in every build, please see the source file F</src/rsinc.h>
1083to see the actual list: 1325to see the actual list:
1084 1326
1085 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1327 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1086 borderLess color cursorBlink cursorUnderline cutchars delete_key 1328 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1087 display_name embed ext_bwidth fade font geometry hold iconName 1329 display_name embed ext_bwidth fade font geometry hold iconName
1088 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1330 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1089 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1331 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1090 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1332 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1091 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1333 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1092 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1334 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1093 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1335 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1094 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1336 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1095 secondaryScreen secondaryScroll selectstyle shade term_name title 1337 secondaryScreen secondaryScroll shade term_name title
1096 transient_for transparent transparent_all tripleclickwords utmpInhibit 1338 transient_for transparent transparent_all tripleclickwords utmpInhibit
1097 visualBell 1339 visualBell
1098 1340
1099=cut 1341=cut
1100 1342
1101sub resource($$;$) { 1343sub resource($$;$) {
1102 my ($self, $name) = (shift, shift); 1344 my ($self, $name) = (shift, shift);
1103 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1345 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1104 &urxvt::term::_resource 1346 goto &urxvt::term::_resource
1105} 1347}
1106 1348
1107=item $value = $term->x_resource ($pattern) 1349=item $value = $term->x_resource ($pattern)
1108 1350
1109Returns the X-Resource for the given pattern, excluding the program or 1351Returns the X-Resource for the given pattern, excluding the program or
1134 1376
1135=item ($row, $col) = $term->selection_beg ([$row, $col]) 1377=item ($row, $col) = $term->selection_beg ([$row, $col])
1136 1378
1137=item ($row, $col) = $term->selection_end ([$row, $col]) 1379=item ($row, $col) = $term->selection_end ([$row, $col])
1138 1380
1139Return the current values of the selection mark, begin or end positions, 1381Return the current values of the selection mark, begin or end positions.
1140and optionally set them to new values. 1382
1383When arguments are given, then the selection coordinates are set to
1384C<$row> and C<$col>, and the selection screen is set to the current
1385screen.
1386
1387=item $screen = $term->selection_screen ([$screen])
1388
1389Returns the current selection screen, and then optionally sets it.
1141 1390
1142=item $term->selection_make ($eventtime[, $rectangular]) 1391=item $term->selection_make ($eventtime[, $rectangular])
1143 1392
1144Tries to make a selection as set by C<selection_beg> and 1393Tries to make a selection as set by C<selection_beg> and
1145C<selection_end>. If C<$rectangular> is true (default: false), a 1394C<selection_end>. If C<$rectangular> is true (default: false), a
1192 1441
1193The methods currently supported on C<urxvt::overlay> objects are: 1442The methods currently supported on C<urxvt::overlay> objects are:
1194 1443
1195=over 4 1444=over 4
1196 1445
1197=item $overlay->set ($x, $y, $text, $rend) 1446=item $overlay->set ($x, $y, $text[, $rend])
1198 1447
1199Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1448Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1200text in rxvt-unicode's special encoding and an array of rendition values 1449text in rxvt-unicode's special encoding and an array of rendition values
1201at a specific position inside the overlay. 1450at a specific position inside the overlay.
1451
1452If C<$rend> is missing, then the rendition will not be changed.
1202 1453
1203=item $overlay->hide 1454=item $overlay->hide
1204 1455
1205If visible, hide the overlay, but do not destroy it. 1456If visible, hide the overlay, but do not destroy it.
1206 1457
1299Replaces the event mask of the pty watcher by the given event mask. Can 1550Replaces the event mask of the pty watcher by the given event mask. Can
1300be used to suppress input and output handling to the pty/tty. See the 1551be used to suppress input and output handling to the pty/tty. See the
1301description of C<< urxvt::timer->events >>. Make sure to always restore 1552description of C<< urxvt::timer->events >>. Make sure to always restore
1302the previous value. 1553the previous value.
1303 1554
1555=item $fd = $term->pty_fd
1556
1557Returns the master file descriptor for the pty in use, or C<-1> if no pty
1558is used.
1559
1304=item $windowid = $term->parent 1560=item $windowid = $term->parent
1305 1561
1306Return the window id of the toplevel window. 1562Return the window id of the toplevel window.
1307 1563
1308=item $windowid = $term->vt 1564=item $windowid = $term->vt
1314Adds the specified events to the vt event mask. Useful e.g. when you want 1570Adds the specified events to the vt event mask. Useful e.g. when you want
1315to receive pointer events all the times: 1571to receive pointer events all the times:
1316 1572
1317 $term->vt_emask_add (urxvt::PointerMotionMask); 1573 $term->vt_emask_add (urxvt::PointerMotionMask);
1318 1574
1575=item $term->focus_in
1576
1577=item $term->focus_out
1578
1579=item $term->key_press ($state, $keycode[, $time])
1580
1581=item $term->key_release ($state, $keycode[, $time])
1582
1583Deliver various fake events to to terminal.
1584
1319=item $window_width = $term->width 1585=item $window_width = $term->width
1320 1586
1321=item $window_height = $term->height 1587=item $window_height = $term->height
1322 1588
1323=item $font_width = $term->fwidth 1589=item $font_width = $term->fwidth
1353=item $env = $term->env 1619=item $env = $term->env
1354 1620
1355Returns a copy of the environment in effect for the terminal as a hashref 1621Returns a copy of the environment in effect for the terminal as a hashref
1356similar to C<\%ENV>. 1622similar to C<\%ENV>.
1357 1623
1624=item @envv = $term->envv
1625
1626Returns the environment as array of strings of the form C<VAR=VALUE>.
1627
1628=item @argv = $term->argv
1629
1630Return the argument vector as this terminal, similar to @ARGV, but
1631includes the program name as first element.
1632
1358=cut 1633=cut
1359 1634
1360sub env { 1635sub env {
1361 if (my $env = $_[0]->_env) {
1362 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1636 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1363 } else {
1364 +{ %ENV }
1365 }
1366} 1637}
1367 1638
1368=item $modifiermask = $term->ModLevel3Mask 1639=item $modifiermask = $term->ModLevel3Mask
1369 1640
1370=item $modifiermask = $term->ModMetaMask 1641=item $modifiermask = $term->ModMetaMask
1375AltGr), the meta key (often Alt) and the num lock key, if applicable. 1646AltGr), the meta key (often Alt) and the num lock key, if applicable.
1376 1647
1377=item $screen = $term->current_screen 1648=item $screen = $term->current_screen
1378 1649
1379Returns the currently displayed screen (0 primary, 1 secondary). 1650Returns the currently displayed screen (0 primary, 1 secondary).
1651
1652=item $cursor_is_hidden = $term->hidden_cursor
1653
1654Returns whether the cursor is currently hidden or not.
1380 1655
1381=item $view_start = $term->view_start ([$newvalue]) 1656=item $view_start = $term->view_start ([$newvalue])
1382 1657
1383Returns the row number of the topmost displayed line. Maximum value is 1658Returns the row number of the topmost displayed line. Maximum value is
1384C<0>, which displays the normal terminal contents. Lower values scroll 1659C<0>, which displays the normal terminal contents. Lower values scroll
1392 1667
1393Used after changing terminal contents to display them. 1668Used after changing terminal contents to display them.
1394 1669
1395=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1670=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1396 1671
1397Returns the text of the entire row with number C<$row_number>. Row C<0> 1672Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1398is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1673is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1399terminal line. The scrollback buffer starts at line C<-1> and extends to
1400line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1674terminal line. Nothing will be returned if a nonexistent line
1401is requested. 1675is requested.
1402 1676
1403If C<$new_text> is specified, it will replace characters in the current 1677If C<$new_text> is specified, it will replace characters in the current
1404line, starting at column C<$start_col> (default C<0>), which is useful 1678line, starting at column C<$start_col> (default C<0>), which is useful
1405to replace only parts of a line. The font index in the rendition will 1679to replace only parts of a line. The font index in the rendition will
1406automatically be updated. 1680automatically be updated.
1407 1681
1408C<$text> is in a special encoding: tabs and wide characters that use 1682C<$text> is in a special encoding: tabs and wide characters that use more
1409more than one cell when displayed are padded with C<$urxvt::NOCHAR> 1683than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1410characters. Characters with combining characters and other characters that 1684characters. Characters with combining characters and other characters that
1411do not fit into the normal tetx encoding will be replaced with characters 1685do not fit into the normal text encoding will be replaced with characters
1412in the private use area. 1686in the private use area.
1413 1687
1414You have to obey this encoding when changing text. The advantage is 1688You have to obey this encoding when changing text. The advantage is
1415that C<substr> and similar functions work on screen cells and not on 1689that C<substr> and similar functions work on screen cells and not on
1416characters. 1690characters.
1561where one character corresponds to one screen cell. See 1835where one character corresponds to one screen cell. See
1562C<< $term->ROW_t >> for details. 1836C<< $term->ROW_t >> for details.
1563 1837
1564=item $string = $term->special_decode $text 1838=item $string = $term->special_decode $text
1565 1839
1566Converts rxvt-unicodes text reprsentation into a perl string. See 1840Converts rxvt-unicodes text representation into a perl string. See
1567C<< $term->ROW_t >> for details. 1841C<< $term->ROW_t >> for details.
1568 1842
1569=item $success = $term->grab_button ($button, $modifiermask) 1843=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1570 1844
1845=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1846
1571Registers a synchronous button grab. See the XGrabButton manpage. 1847Register/unregister a synchronous button grab. See the XGrabButton
1848manpage.
1572 1849
1573=item $success = $term->grab ($eventtime[, $sync]) 1850=item $success = $term->grab ($eventtime[, $sync])
1574 1851
1575Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1852Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1576synchronous (C<$sync> is true). Also remembers the grab timestampe. 1853synchronous (C<$sync> is true). Also remembers the grab timestamp.
1577 1854
1578=item $term->allow_events_async 1855=item $term->allow_events_async
1579 1856
1580Calls XAllowEvents with AsyncBoth for the most recent grab. 1857Calls XAllowEvents with AsyncBoth for the most recent grab.
1581 1858
1588Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1865Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1589recent grab. 1866recent grab.
1590 1867
1591=item $term->ungrab 1868=item $term->ungrab
1592 1869
1593Calls XUngrab for the most recent grab. Is called automatically on 1870Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1594evaluation errors, as it is better to lose the grab in the error case as 1871evaluation errors, as it is better to lose the grab in the error case as
1595the session. 1872the session.
1596 1873
1597=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1874=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1598 1875
1600 1877
1601=item @atoms = $term->XListProperties ($window) 1878=item @atoms = $term->XListProperties ($window)
1602 1879
1603=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1880=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1604 1881
1605=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1882=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1606 1883
1607=item $term->XDeleteProperty ($window, $property) 1884=item $term->XDeleteProperty ($window, $property)
1608 1885
1609=item $window = $term->DefaultRootWindow 1886=item $window = $term->DefaultRootWindow
1610 1887
1620 1897
1621=item $term->XChangeInput ($window, $add_events[, $del_events]) 1898=item $term->XChangeInput ($window, $add_events[, $del_events])
1622 1899
1623Various X or X-related functions. The C<$term> object only serves as 1900Various X or X-related functions. The C<$term> object only serves as
1624the source of the display, otherwise those functions map more-or-less 1901the source of the display, otherwise those functions map more-or-less
1625directory onto the X functions of the same name. 1902directly onto the X functions of the same name.
1626 1903
1627=back 1904=back
1628 1905
1629=cut 1906=cut
1630 1907
1694 my ($self, $text, $cb) = @_; 1971 my ($self, $text, $cb) = @_;
1695 1972
1696 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1973 $self->add_item ({ type => "button", text => $text, activate => $cb});
1697} 1974}
1698 1975
1699=item $popup->add_toggle ($text, $cb, $initial_value) 1976=item $popup->add_toggle ($text, $initial_value, $cb)
1700 1977
1701Adds a toggle/checkbox item to the popup. Teh callback gets called 1978Adds a toggle/checkbox item to the popup. The callback gets called
1702whenever it gets toggled, with a boolean indicating its value as its first 1979whenever it gets toggled, with a boolean indicating its new value as its
1703argument. 1980first argument.
1704 1981
1705=cut 1982=cut
1706 1983
1707sub add_toggle { 1984sub add_toggle {
1708 my ($self, $text, $cb, $value) = @_; 1985 my ($self, $text, $value, $cb) = @_;
1709 1986
1710 my $item; $item = { 1987 my $item; $item = {
1711 type => "button", 1988 type => "button",
1712 text => " $text", 1989 text => " $text",
1713 value => $value, 1990 value => $value,
1732 my $env = $self->{term}->env; 2009 my $env = $self->{term}->env;
1733 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2010 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1734 delete $env->{LC_ALL}; 2011 delete $env->{LC_ALL};
1735 $env->{LC_CTYPE} = $self->{term}->locale; 2012 $env->{LC_CTYPE} = $self->{term}->locale;
1736 2013
1737 urxvt::term->new ($env, "popup", 2014 my $term = urxvt::term->new (
2015 $env, "popup",
1738 "--perl-lib" => "", "--perl-ext-common" => "", 2016 "--perl-lib" => "", "--perl-ext-common" => "",
1739 "-pty-fd" => -1, "-sl" => 0, 2017 "-pty-fd" => -1, "-sl" => 0,
1740 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2018 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1741 "--transient-for" => $self->{term}->parent, 2019 "--transient-for" => $self->{term}->parent,
1742 "-display" => $self->{term}->display_id, 2020 "-display" => $self->{term}->display_id,
1743 "-pe" => "urxvt-popup") 2021 "-pe" => "urxvt-popup",
1744 or die "unable to create popup window\n"; 2022 ) or die "unable to create popup window\n";
2023
2024 unless (delete $term->{urxvt_popup_init_done}) {
2025 $term->ungrab;
2026 $term->destroy;
2027 die "unable to initialise popup window\n";
2028 }
1745} 2029}
1746 2030
1747sub DESTROY { 2031sub DESTROY {
1748 my ($self) = @_; 2032 my ($self) = @_;
1749 2033
1754=back 2038=back
1755 2039
1756=cut 2040=cut
1757 2041
1758package urxvt::watcher; 2042package urxvt::watcher;
1759
1760@urxvt::timer::ISA = __PACKAGE__;
1761@urxvt::iow::ISA = __PACKAGE__;
1762@urxvt::pw::ISA = __PACKAGE__;
1763@urxvt::iw::ISA = __PACKAGE__;
1764 2043
1765=head2 The C<urxvt::timer> Class 2044=head2 The C<urxvt::timer> Class
1766 2045
1767This class implements timer watchers/events. Time is represented as a 2046This class implements timer watchers/events. Time is represented as a
1768fractional number of seconds since the epoch. Example: 2047fractional number of seconds since the epoch. Example:
1772 ->new 2051 ->new
1773 ->interval (1) 2052 ->interval (1)
1774 ->cb (sub { 2053 ->cb (sub {
1775 $term->{overlay}->set (0, 0, 2054 $term->{overlay}->set (0, 0,
1776 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2055 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1777 }); 2056 });
1778 2057
1779=over 4 2058=over 4
1780 2059
1781=item $timer = new urxvt::timer 2060=item $timer = new urxvt::timer
1782 2061
1785 2064
1786=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2065=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1787 2066
1788Set the callback to be called when the timer triggers. 2067Set the callback to be called when the timer triggers.
1789 2068
1790=item $tstamp = $timer->at
1791
1792Return the time this watcher will fire next.
1793
1794=item $timer = $timer->set ($tstamp) 2069=item $timer = $timer->set ($tstamp[, $interval])
1795 2070
1796Set the time the event is generated to $tstamp. 2071Set the time the event is generated to $tstamp (and optionally specifies a
2072new $interval).
1797 2073
1798=item $timer = $timer->interval ($interval) 2074=item $timer = $timer->interval ($interval)
1799 2075
1800Normally (and when C<$interval> is C<0>), the timer will automatically 2076By default (and when C<$interval> is C<0>), the timer will automatically
1801stop after it has fired once. If C<$interval> is non-zero, then the timer 2077stop after it has fired once. If C<$interval> is non-zero, then the timer
1802is automatically rescheduled at the given intervals. 2078is automatically rescheduled at the given intervals.
1803 2079
1804=item $timer = $timer->start 2080=item $timer = $timer->start
1805 2081
1806Start the timer. 2082Start the timer.
1807 2083
1808=item $timer = $timer->start ($tstamp) 2084=item $timer = $timer->start ($tstamp[, $interval])
1809 2085
1810Set the event trigger time to C<$tstamp> and start the timer. 2086Set the event trigger time to C<$tstamp> and start the timer. Optionally
2087also replaces the interval.
1811 2088
1812=item $timer = $timer->after ($delay) 2089=item $timer = $timer->after ($delay[, $interval])
1813 2090
1814Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2091Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1815 2092
1816=item $timer = $timer->stop 2093=item $timer = $timer->stop
1817 2094
1825 2102
1826 $term->{socket} = ... 2103 $term->{socket} = ...
1827 $term->{iow} = urxvt::iow 2104 $term->{iow} = urxvt::iow
1828 ->new 2105 ->new
1829 ->fd (fileno $term->{socket}) 2106 ->fd (fileno $term->{socket})
1830 ->events (urxvt::EVENT_READ) 2107 ->events (urxvt::EV_READ)
1831 ->start 2108 ->start
1832 ->cb (sub { 2109 ->cb (sub {
1833 my ($iow, $revents) = @_; 2110 my ($iow, $revents) = @_;
1834 # $revents must be 1 here, no need to check 2111 # $revents must be 1 here, no need to check
1835 sysread $term->{socket}, my $buf, 8192 2112 sysread $term->{socket}, my $buf, 8192
1848Set the callback to be called when io events are triggered. C<$reventmask> 2125Set the callback to be called when io events are triggered. C<$reventmask>
1849is a bitset as described in the C<events> method. 2126is a bitset as described in the C<events> method.
1850 2127
1851=item $iow = $iow->fd ($fd) 2128=item $iow = $iow->fd ($fd)
1852 2129
1853Set the filedescriptor (not handle) to watch. 2130Set the file descriptor (not handle) to watch.
1854 2131
1855=item $iow = $iow->events ($eventmask) 2132=item $iow = $iow->events ($eventmask)
1856 2133
1857Set the event mask to watch. The only allowed values are 2134Set the event mask to watch. The only allowed values are
1858C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2135C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1859together, or C<urxvt::EVENT_NONE>. 2136together, or C<urxvt::EV_NONE>.
1860 2137
1861=item $iow = $iow->start 2138=item $iow = $iow->start
1862 2139
1863Start watching for requested events on the given handle. 2140Start watching for requested events on the given handle.
1864 2141
1865=item $iow = $iow->stop 2142=item $iow = $iow->stop
1866 2143
1867Stop watching for events on the given filehandle. 2144Stop watching for events on the given file handle.
1868 2145
1869=back 2146=back
1870 2147
1871=head2 The C<urxvt::iw> Class 2148=head2 The C<urxvt::iw> Class
1872 2149
1905 ->new 2182 ->new
1906 ->start ($pid) 2183 ->start ($pid)
1907 ->cb (sub { 2184 ->cb (sub {
1908 my ($pw, $exit_status) = @_; 2185 my ($pw, $exit_status) = @_;
1909 ... 2186 ...
1910 }); 2187 });
1911 2188
1912=over 4 2189=over 4
1913 2190
1914=item $pw = new urxvt::pw 2191=item $pw = new urxvt::pw
1915 2192
1919 2196
1920Set the callback to be called when the timer triggers. 2197Set the callback to be called when the timer triggers.
1921 2198
1922=item $pw = $timer->start ($pid) 2199=item $pw = $timer->start ($pid)
1923 2200
1924Tells the wqtcher to start watching for process C<$pid>. 2201Tells the watcher to start watching for process C<$pid>.
1925 2202
1926=item $pw = $pw->stop 2203=item $pw = $pw->stop
1927 2204
1928Stop the watcher. 2205Stop the watcher.
1929 2206
1942 2219
1943=item >= 3 - script loading and management 2220=item >= 3 - script loading and management
1944 2221
1945=item >=10 - all called hooks 2222=item >=10 - all called hooks
1946 2223
1947=item >=11 - hook reutrn values 2224=item >=11 - hook return values
1948 2225
1949=back 2226=back
1950 2227
1951=head1 AUTHOR 2228=head1 AUTHOR
1952 2229
1954 http://software.schmorp.de/pkg/rxvt-unicode 2231 http://software.schmorp.de/pkg/rxvt-unicode
1955 2232
1956=cut 2233=cut
1957 2234
19581 22351
2236
2237# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines