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.128 by root, Wed Jan 25 00:57:57 2006 UTC vs.
Revision 1.191 by sf-exg, Fri Jan 7 21:55:28 2011 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: \\|([^|]+)\\|
71 74
72Another example: Programs I use often output "absolute path: " at the 75Another example: Programs I use often output "absolute path: " at the
94=item option-popup (enabled by default) 97=item option-popup (enabled by default)
95 98
96Binds 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
97runtime. 100runtime.
98 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
99=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
100 120
101Binds 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
102text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
103evaluation, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
104 124
105Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
106onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
107popup is displayed. 127popup is being displayed.
108 128
109It'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
110is 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.
111It 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
112string 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
113when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
114 134
115The 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
116the 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
117C<a>s: 137C<a>s:
118 138
119 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
120 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
121 : () 141 : ()
122 }; 142 };
123 143
124=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
125 145
132search. 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>
133search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
134bottom. 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
135was 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
136additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
137selection. 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.
138 164
139=item readline (enabled by default) 165=item readline (enabled by default)
140 166
141A support package that tries to make editing with readline easier. At the 167A support package that tries to make editing with readline easier. At
142moment, it reacts to clicking with the left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
143move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
144cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
145for programs that correctly support wide characters). 171for programs that correctly support wide characters).
146 172
147To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
148 174
149=over 4 175=over 4
197the message into vi commands to load the file. 223the message into vi commands to load the file.
198 224
199=item tabbed 225=item tabbed
200 226
201This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
202is, 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
203displays 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
204button per tab. 230button per tab.
205 231
206Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
207B<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,
208while B<Shift-Down> creates a new tab. 234while B<Shift-Down> creates a new tab.
209 235
210=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):
211 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
212Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
213make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
214resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
215the 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
216 276
217=item xim-onthespot 277=item xim-onthespot
218 278
219This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
220not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
221OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
222kinput2. 282kinput2.
223 283
224You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
225C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
226 286
227 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
228 288
229=item automove-background 289=item kuake<hotkey>
230 290
231This is basically a one-line extension that dynamically changes the background pixmap offset 291A very primitive quake-console-like extension. It was inspired by a
232to the window position, in effect creating the same effect as pseudo transparency with 292description of how the programs C<kuake> and C<yakuake> work: Whenever the
233a custom pixmap. No scaling is supported in this mode. Exmaple: 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.
234 296
235 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 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.
236 313
237=item block-graphics-to-ascii 314=item block-graphics-to-ascii
238 315
239A 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
240by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
241similar-looking ascii character. 318similar-looking ascii character.
242 319
243=item digital-clock 320=item digital-clock
244 321
245Displays 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 whether 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.
246 391
247=item example-refresh-hooks 392=item example-refresh-hooks
248 393
249Displays 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
250window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
251overlays or changes. 396overlays or changes.
252 397
253=item selection-pastebin 398=item confirm-paste
254 399
255This is a little rarely useful extension that Uploads the selection as 400Displays a confirmation dialog when a paste containing at least a full
256textfile to a remote site (or does other things). (The implementation is 401line is detected.
257not currently secure for use in a multiuser environment as it writes to
258F</tmp> directly.).
259
260It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
261i.e.
262
263 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
264
265Pressing this combination runs a command with C<%> replaced by the name of
266the textfile. This command can be set via a resource:
267
268 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
269
270And the default is likely not useful to anybody but the few people around
271here :)
272
273The name of the textfile is the hex encoded md5 sum of the selection, so
274the same content should lead to the same filename.
275
276After a successful upload the selection will be replaced by the text given
277in the C<selection-pastebin-url> resource (again, the % is the placeholder
278for the filename):
279
280 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
281 402
282=back 403=back
283 404
284=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
285 406
301 422
302=over 4 423=over 4
303 424
304=item $text 425=item $text
305 426
306Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
307always represents one screen cell. See L<ROW_t> for a discussion of this format. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
308 429
309=item $string 430=item $string
310 431
311A perl text string, with an emphasis on I<text>. It can store all unicode 432A perl text string, with an emphasis on I<text>. It can store all unicode
319 440
320=back 441=back
321 442
322=head2 Extension Objects 443=head2 Extension Objects
323 444
324Very perl extension is a perl class. A separate perl object is created 445Every perl extension is a perl class. A separate perl object is created
325for each terminal and each extension and passed as the first parameter to 446for each terminal, and each terminal has its own set of extenion objects,
326hooks. So extensions can use their C<$self> object without having to think 447which are passed as the first parameter to hooks. So extensions can use
327about other extensions, with the exception of methods and members that 448their C<$self> object without having to think about clashes with other
449extensions or other terminals, with the exception of methods and members
328begin with an underscore character C<_>: these are reserved for internal 450that begin with an underscore character C<_>: these are reserved for
329use. 451internal use.
330 452
331Although it isn't a C<urxvt::term> object, you can call all methods of the 453Although it isn't a C<urxvt::term> object, you can call all methods of the
332C<urxvt::term> class on this object. 454C<urxvt::term> class on this object.
333 455
334It has the following methods and data members: 456It has the following methods and data members:
355=head2 Hooks 477=head2 Hooks
356 478
357The following subroutines can be declared in extension files, and will be 479The following subroutines can be declared in extension files, and will be
358called whenever the relevant event happens. 480called whenever the relevant event happens.
359 481
360The first argument passed to them is an extension oject as described in 482The first argument passed to them is an extension object as described in
361the in the C<Extension Objects> section. 483the in the C<Extension Objects> section.
362 484
363B<All> of these hooks must return a boolean value. If any of the called 485B<All> of these hooks must return a boolean value. If any of the called
364hooks returns true, then the event counts as being I<consumed>, and the 486hooks returns true, then the event counts as being I<consumed>, and the
365relevant action might not be carried out by the C++ code. 487relevant action might not be carried out by the C++ code.
378place. 500place.
379 501
380=item on_start $term 502=item on_start $term
381 503
382Called at the very end of initialisation of a new terminal, just before 504Called at the very end of initialisation of a new terminal, just before
383trying to map (display) the toplevel and returning to the mainloop. 505trying to map (display) the toplevel and returning to the main loop.
384 506
385=item on_destroy $term 507=item on_destroy $term
386 508
387Called whenever something tries to destroy terminal, when the terminal is 509Called whenever something tries to destroy terminal, when the terminal is
388still fully functional (not for long, though). 510still fully functional (not for long, though).
415 537
416Called whenever a selection has been copied, but before the selection is 538Called whenever a selection has been copied, but before the selection is
417requested from the server. The selection text can be queried and changed 539requested from the server. The selection text can be queried and changed
418by calling C<< $term->selection >>. 540by calling C<< $term->selection >>.
419 541
420Returning a true value aborts selection grabbing. It will still be hilighted. 542Returning a true value aborts selection grabbing. It will still be highlighted.
421 543
422=item on_sel_extend $term 544=item on_sel_extend $term
423 545
424Called whenever the user tries to extend the selection (e.g. with a double 546Called whenever the user tries to extend the selection (e.g. with a double
425click) and is either supposed to return false (normal operation), or 547click) and is either supposed to return false (normal operation), or
426should extend the selection itelf and return true to suppress the built-in 548should extend the selection itself and return true to suppress the built-in
427processing. This can happen multiple times, as long as the callback 549processing. This can happen multiple times, as long as the callback
428returns true, it will be called on every further click by the user and is 550returns true, it will be called on every further click by the user and is
429supposed to enlarge the selection more and more, if possible. 551supposed to enlarge the selection more and more, if possible.
430 552
431See the F<selection> example extension. 553See the F<selection> example extension.
432 554
433=item on_view_change $term, $offset 555=item on_view_change $term, $offset
434 556
435Called whenever the view offset changes, i..e the user or program 557Called whenever the view offset changes, i.e. the user or program
436scrolls. Offset C<0> means display the normal terminal, positive values 558scrolls. Offset C<0> means display the normal terminal, positive values
437show this many lines of scrollback. 559show this many lines of scrollback.
438 560
439=item on_scroll_back $term, $lines, $saved 561=item on_scroll_back $term, $lines, $saved
440 562
444 566
445It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 567It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
446$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 568$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
447number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
448 570
449=item on_osc_seq $term, $string 571=item on_osc_seq $term, $op, $args, $resp
572
573Called on every OSC sequence and can be used to suppress it or modify its
574behaviour. The default should be to return an empty list. A true value
575suppresses execution of the request completely. Make sure you don't get
576confused by recursive invocations when you output an OSC sequence within
577this callback.
578
579C<on_osc_seq_perl> should be used for new behaviour.
580
581=item on_osc_seq_perl $term, $args, $resp
450 582
451Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
452operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
453information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
454string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
455it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
456future. 588enforced in the future.
589
590For example, C<overlay-osc> uses this:
591
592 sub on_osc_seq_perl {
593 my ($self, $osc, $resp) = @_;
594
595 return unless $osc =~ s/^overlay;//;
596
597 ... process remaining $osc string
598 }
457 599
458Be careful not ever to trust (in a security sense) the data you receive, 600Be careful not ever to trust (in a security sense) the data you receive,
459as its source can not easily be controleld (e-mail content, messages from 601as its source can not easily be controlled (e-mail content, messages from
460other users on the same system etc.). 602other users on the same system etc.).
603
604For responses, C<$resp> contains the end-of-args separator used by the
605sender.
461 606
462=item on_add_lines $term, $string 607=item on_add_lines $term, $string
463 608
464Called whenever text is about to be output, with the text as argument. You 609Called whenever text is about to be output, with the text as argument. You
465can filter/change and output the text yourself by returning a true value 610can filter/change and output the text yourself by returning a true value
470=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
471 616
472Called whenever some data is written to the tty/pty and can be used to 617Called whenever some data is written to the tty/pty and can be used to
473suppress or filter tty input. 618suppress or filter tty input.
474 619
620=item on_tt_paste $term, $octets
621
622Called whenever text is about to be pasted, with the text as argument. You
623can filter/change and paste the text yourself by returning a true value
624and calling C<< $term->tt_paste >> yourself. C<$octets> is
625locale-encoded.
626
475=item on_line_update $term, $row 627=item on_line_update $term, $row
476 628
477Called whenever a line was updated or changed. Can be used to filter 629Called whenever a line was updated or changed. Can be used to filter
478screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
479that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
486later with the already-modified line (e.g. if unrelated parts change), so 638later with the already-modified line (e.g. if unrelated parts change), so
487you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
488 640
489=item on_refresh_begin $term 641=item on_refresh_begin $term
490 642
491Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
492or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
493restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
494code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
495 647
496=item on_refresh_end $term 648=item on_refresh_end $term
497 649
498Called just after the screen gets redrawn. See C<on_refresh_begin>. 650Called just after the screen gets redrawn. See C<on_refresh_begin>.
499 651
500=item on_keyboard_command $term, $string 652=item on_user_command $term, $string
501 653
502Called whenever the user presses a key combination that has a 654Called whenever a user-configured event is being activated (e.g. via
503C<perl:string> action bound to it (see description of the B<keysym> 655a C<perl:string> action bound to a key, see description of the B<keysym>
504resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
657
658The event is simply the action string. This interface is assumed to change
659slightly in the future.
660
661=item on_resize_all_windows $term, $new_width, $new_height
662
663Called just after the new window size has been calculated, but before
664windows are actually being resized or hints are being set. If this hook
665returns TRUE, setting of the window hints is being skipped.
505 666
506=item on_x_event $term, $event 667=item on_x_event $term, $event
507 668
508Called on every X event received on the vt window (and possibly other 669Called on every X event received on the vt window (and possibly other
509windows). Should only be used as a last resort. Most event structure 670windows). Should only be used as a last resort. Most event structure
510members are not passed. 671members are not passed.
511 672
673=item on_root_event $term, $event
674
675Like C<on_x_event>, but is called for events on the root window.
676
512=item on_focus_in $term 677=item on_focus_in $term
513 678
514Called whenever the window gets the keyboard focus, before rxvt-unicode 679Called whenever the window gets the keyboard focus, before rxvt-unicode
515does focus in processing. 680does focus in processing.
516 681
517=item on_focus_out $term 682=item on_focus_out $term
518 683
519Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called whenever the window loses keyboard focus, before rxvt-unicode does
520focus out processing. 685focus out processing.
521 686
522=item on_configure_notify $term, $event 687=item on_configure_notify $term, $event
523 688
524=item on_property_notify $term, $event 689=item on_property_notify $term, $event
535 700
536=item on_map_notify $term, $event 701=item on_map_notify $term, $event
537 702
538=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
539 704
540Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
541the hook returns true, then the even will be ignored by rxvt-unicode. 706the hook returns true, then the event will be ignored by rxvt-unicode.
542 707
543The event is a hash with most values as named by Xlib (see the XEvent 708The event is a hash with most values as named by Xlib (see the XEvent
544manpage), with the additional members C<row> and C<col>, which are the 709manpage), with the additional members C<row> and C<col>, which are the
545(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
546 711
555 720
556=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
557 722
558Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
559format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 724format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
725
726=item on_bell $term
727
728Called on receipt of a bell character.
560 729
561=back 730=back
562 731
563=cut 732=cut
564 733
607The current terminal. This variable stores the current C<urxvt::term> 776The current terminal. This variable stores the current C<urxvt::term>
608object, whenever a callback/hook is executing. 777object, whenever a callback/hook is executing.
609 778
610=item @urxvt::TERM_INIT 779=item @urxvt::TERM_INIT
611 780
612All coderefs in this array will be called as methods of the next newly 781All code references in this array will be called as methods of the next newly
613created C<urxvt::term> object (during the C<on_init> phase). The array 782created C<urxvt::term> object (during the C<on_init> phase). The array
614gets cleared before the codereferences that were in it are being executed, 783gets cleared before the code references that were in it are being executed,
615so coderefs can push themselves onto it again if they so desire. 784so references can push themselves onto it again if they so desire.
616 785
617This complements to the perl-eval commandline option, but gets executed 786This complements to the perl-eval command line option, but gets executed
618first. 787first.
619 788
620=item @urxvt::TERM_EXT 789=item @urxvt::TERM_EXT
621 790
622Works similar to C<@TERM_INIT>, but contains perl package/class names, which 791Works similar to C<@TERM_INIT>, but contains perl package/class names, which
629 798
630=over 4 799=over 4
631 800
632=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
633 802
634Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message (which should
635costs! The only time this is acceptable is when the terminal process 804include a trailing newline). Avoid at all costs! The only time this
636starts up. 805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
637 807
638=item urxvt::warn $string 808=item urxvt::warn $string
639 809
640Calls C<rxvt_warn> with the given string which should not include a 810Calls C<rxvt_warn> with the given string which should include a trailing
641newline. The module also overwrites the C<warn> builtin with a function 811newline. The module also overwrites the C<warn> builtin with a function
642that calls this function. 812that calls this function.
643 813
644Using this function has the advantage that its output ends up in the 814Using this function has the advantage that its output ends up in the
645correct place, e.g. on stderr of the connecting urxvtc client. 815correct place, e.g. on stderr of the connecting urxvtc client.
646 816
647Messages have a size limit of 1023 bytes currently. 817Messages have a size limit of 1023 bytes currently.
818
819=item @terms = urxvt::termlist
820
821Returns all urxvt::term objects that exist in this process, regardless of
822whether they are started, being destroyed etc., so be careful. Only term
823objects that have perl extensions attached will be returned (because there
824is no urxvt::term objet associated with others).
648 825
649=item $time = urxvt::NOW 826=item $time = urxvt::NOW
650 827
651Returns the "current time" (as per the event loop). 828Returns the "current time" (as per the event loop).
652 829
695 872
696=item $rend = urxvt::OVERLAY_RSTYLE 873=item $rend = urxvt::OVERLAY_RSTYLE
697 874
698Return the rendition mask used for overlays by default. 875Return the rendition mask used for overlays by default.
699 876
700=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 877=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
878urxvt::RS_RVid, urxvt::RS_Uline
701 879
702Return the bit that enabled bold, italic, blink, reverse-video and 880Return the bit that enabled bold, italic, blink, reverse-video and
703underline, respectively. To enable such a style, just logically OR it into 881underline, respectively. To enable such a style, just logically OR it into
704the bitset. 882the bitset.
705 883
710Return the foreground/background colour index, respectively. 888Return the foreground/background colour index, respectively.
711 889
712=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 890=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
713 891
714=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 892=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
893
894=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
715 895
716Replace the foreground/background colour in the rendition mask with the 896Replace the foreground/background colour in the rendition mask with the
717specified one. 897specified one.
718 898
719=item $value = urxvt::GET_CUSTOM $rend 899=item $value = urxvt::GET_CUSTOM $rend
786 local $TERM = shift; 966 local $TERM = shift;
787 my $htype = shift; 967 my $htype = shift;
788 968
789 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
790 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
791 971
792 my %ext_arg; 972 my %ext_arg;
793 973
794 { 974 {
795 my @init = @TERM_INIT; 975 my @init = @TERM_INIT;
796 @TERM_INIT = (); 976 @TERM_INIT = ();
810 } else { 990 } else {
811 $ext_arg{$_} ||= []; 991 $ext_arg{$_} ||= [];
812 } 992 }
813 } 993 }
814 994
815 while (my ($ext, $argv) = each %ext_arg) { 995 for my $ext (sort keys %ext_arg) {
816 my @files = grep -f $_, map "$_/$ext", @dirs; 996 my @files = grep -f $_, map "$_/$ext", @dirs;
817 997
818 if (@files) { 998 if (@files) {
819 $TERM->register_package (extension_package $files[0], $argv); 999 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
820 } else { 1000 } else {
821 warn "perl extension '$ext' not found in perl library search path\n"; 1001 warn "perl extension '$ext' not found in perl library search path\n";
822 } 1002 }
823 } 1003 }
824 1004
830 1010
831 if (my $cb = $TERM->{_hook}[$htype]) { 1011 if (my $cb = $TERM->{_hook}[$htype]) {
832 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1012 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
833 if $verbosity >= 10; 1013 if $verbosity >= 10;
834 1014
835 keys %$cb; 1015 for my $pkg (keys %$cb) {
836
837 while (my ($pkg, $cb) = each %$cb) {
838 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1016 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
839 $retval ||= $retval_; 1017 $retval ||= $retval_;
840 1018
841 if ($@) { 1019 if ($@) {
842 $TERM->ungrab; # better to lose the grab than the session 1020 $TERM->ungrab; # better to lose the grab than the session
843 warn $@; 1021 warn $@;
855 # clear package 1033 # clear package
856 %$TERM = (); 1034 %$TERM = ();
857 } 1035 }
858 1036
859 $retval 1037 $retval
1038}
1039
1040sub SET_COLOR($$$) {
1041 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1042}
1043
1044sub rend2mask {
1045 no strict 'refs';
1046 my ($str, $mask) = (@_, 0);
1047 my %color = ( fg => undef, bg => undef );
1048 my @failed;
1049 for my $spec ( split /\s+/, $str ) {
1050 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1051 $color{lc($1)} = $2;
1052 } else {
1053 my $neg = $spec =~ s/^[-^]//;
1054 unless ( exists &{"RS_$spec"} ) {
1055 push @failed, $spec;
1056 next;
1057 }
1058 my $cur = &{"RS_$spec"};
1059 if ( $neg ) {
1060 $mask &= ~$cur;
1061 } else {
1062 $mask |= $cur;
1063 }
1064 }
1065 }
1066 ($mask, @color{qw(fg bg)}, \@failed)
860} 1067}
861 1068
862# urxvt::term::extension 1069# urxvt::term::extension
863 1070
864package urxvt::term::extension; 1071package urxvt::term::extension;
935is that you cannot use blocking APIs, but the non-blocking variant should 1142is that you cannot use blocking APIs, but the non-blocking variant should
936work. 1143work.
937 1144
938=cut 1145=cut
939 1146
940our $VERSION = 1; 1147our $VERSION = '5.23';
941 1148
942$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
943push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
944 1151
945sub timer { 1152sub timer {
947 1154
948 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
949 1156
950 urxvt::timer 1157 urxvt::timer
951 ->new 1158 ->new
952 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
953 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
954 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
955 $cb->(); 1162 $cb->();
956 }) 1163 })
957} 1164}
958 1165
959sub io { 1166sub io {
960 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
961 1168
962 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
963 1172
964 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
965 ->new 1174 ->new
966 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
967 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
968 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
969 ->start 1178 ->start
970 ->cb (sub { 1179 ->cb ($cb)
971 $cb->(($_[1] & 1 ? 'r' : '')
972 . ($_[1] & 2 ? 'w' : ''));
973 })],
974 urxvt::anyevent:: 1180 ], urxvt::anyevent::
1181}
1182
1183sub idle {
1184 my ($class, %arg) = @_;
1185
1186 my $cb = $arg{cb};
1187
1188 urxvt::iw
1189 ->new
1190 ->start
1191 ->cb ($cb)
1192}
1193
1194sub child {
1195 my ($class, %arg) = @_;
1196
1197 my $cb = $arg{cb};
1198
1199 urxvt::pw
1200 ->new
1201 ->start ($arg{pid})
1202 ->cb (sub {
1203 $_[0]->stop; # need to cancel manually
1204 $cb->($_[0]->rpid, $_[0]->rstatus);
1205 })
975} 1206}
976 1207
977sub DESTROY { 1208sub DESTROY {
978 $_[0][1]->stop; 1209 $_[0][1]->stop;
979} 1210}
980 1211
981sub condvar { 1212sub one_event {
982 bless \my $flag, urxvt::anyevent::condvar::
983}
984
985sub urxvt::anyevent::condvar::broadcast {
986 ${$_[0]}++;
987}
988
989sub urxvt::anyevent::condvar::wait {
990 unless (${$_[0]}) {
991 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
992 }
993} 1214}
994 1215
995package urxvt::term; 1216package urxvt::term;
996 1217
997=head2 The C<urxvt::term> Class 1218=head2 The C<urxvt::term> Class
1033hash which defines the environment of the new terminal. 1254hash which defines the environment of the new terminal.
1034 1255
1035Croaks (and probably outputs an error message) if the new instance 1256Croaks (and probably outputs an error message) if the new instance
1036couldn't be created. Returns C<undef> if the new instance didn't 1257couldn't be created. Returns C<undef> if the new instance didn't
1037initialise perl, and the terminal object otherwise. The C<init> and 1258initialise perl, and the terminal object otherwise. The C<init> and
1038C<start> hooks will be called during this call. 1259C<start> hooks will be called before this call returns, and are free to
1260refer to global data (which is race free).
1039 1261
1040=cut 1262=cut
1041 1263
1042sub new { 1264sub new {
1043 my ($class, $env, @args) = @_; 1265 my ($class, $env, @args) = @_;
1044 1266
1267 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1268 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1269
1045 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1270 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1046} 1271}
1047 1272
1048=item $term->destroy 1273=item $term->destroy
1049 1274
1050Destroy the terminal object (close the window, free resources 1275Destroy the terminal object (close the window, free resources
1080 1305
1081Returns true if the option specified by C<$optval> is enabled, and 1306Returns true if the option specified by C<$optval> is enabled, and
1082optionally change it. All option values are stored by name in the hash 1307optionally change it. All option values are stored by name in the hash
1083C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1308C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1084 1309
1085Here is a a likely non-exhaustive list of option names, please see the 1310Here is a likely non-exhaustive list of option names, please see the
1086source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
1087 1312
1088 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess console cursorBlink cursorUnderline hold iconic insecure
1089 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1090 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1315 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1107likely change). 1332likely change).
1108 1333
1109Please note that resource strings will currently only be freed when the 1334Please note that resource strings will currently only be freed when the
1110terminal is destroyed, so changing options frequently will eat memory. 1335terminal is destroyed, so changing options frequently will eat memory.
1111 1336
1112Here is a a likely non-exhaustive list of resource names, not all of which 1337Here is a likely non-exhaustive list of resource names, not all of which
1113are supported in every build, please see the source file F</src/rsinc.h> 1338are supported in every build, please see the source file F</src/rsinc.h>
1114to see the actual list: 1339to see the actual list:
1115 1340
1116 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1117 borderLess color cursorBlink cursorUnderline cutchars delete_key 1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1118 display_name embed ext_bwidth fade font geometry hold iconName 1343 display_name embed ext_bwidth fade font geometry hold iconName
1119 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1120 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1121 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1122 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1123 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1124 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1125 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1126 secondaryScreen secondaryScroll selectstyle shade term_name title 1351 secondaryScreen secondaryScroll shade term_name title
1127 transient_for transparent transparent_all tripleclickwords utmpInhibit 1352 transient_for transparent transparent_all tripleclickwords utmpInhibit
1128 visualBell 1353 visualBell
1129 1354
1130=cut 1355=cut
1131 1356
1132sub resource($$;$) { 1357sub resource($$;$) {
1133 my ($self, $name) = (shift, shift); 1358 my ($self, $name) = (shift, shift);
1134 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1359 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1135 &urxvt::term::_resource 1360 goto &urxvt::term::_resource
1136} 1361}
1137 1362
1138=item $value = $term->x_resource ($pattern) 1363=item $value = $term->x_resource ($pattern)
1139 1364
1140Returns the X-Resource for the given pattern, excluding the program or 1365Returns the X-Resource for the given pattern, excluding the program or
1165 1390
1166=item ($row, $col) = $term->selection_beg ([$row, $col]) 1391=item ($row, $col) = $term->selection_beg ([$row, $col])
1167 1392
1168=item ($row, $col) = $term->selection_end ([$row, $col]) 1393=item ($row, $col) = $term->selection_end ([$row, $col])
1169 1394
1170Return the current values of the selection mark, begin or end positions, 1395Return the current values of the selection mark, begin or end positions.
1171and optionally set them to new values. 1396
1397When arguments are given, then the selection coordinates are set to
1398C<$row> and C<$col>, and the selection screen is set to the current
1399screen.
1400
1401=item $screen = $term->selection_screen ([$screen])
1402
1403Returns the current selection screen, and then optionally sets it.
1172 1404
1173=item $term->selection_make ($eventtime[, $rectangular]) 1405=item $term->selection_make ($eventtime[, $rectangular])
1174 1406
1175Tries to make a selection as set by C<selection_beg> and 1407Tries to make a selection as set by C<selection_beg> and
1176C<selection_end>. If C<$rectangular> is true (default: false), a 1408C<selection_end>. If C<$rectangular> is true (default: false), a
1177rectangular selection will be made. This is the prefered function to make 1409rectangular selection will be made. This is the preferred function to make
1178a selection. 1410a selection.
1179 1411
1180=item $success = $term->selection_grab ($eventtime) 1412=item $success = $term->selection_grab ($eventtime[, $clipboard])
1181 1413
1182Try to request the primary selection text from the server (for example, as 1414Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1415true) selection from the server. The corresponding text can be set
1183set by the next method). No visual feedback will be given. This function 1416with the next method. No visual feedback will be given. This function
1184is mostly useful from within C<on_sel_grab> hooks. 1417is mostly useful from within C<on_sel_grab> hooks.
1185 1418
1186=item $oldtext = $term->selection ([$newtext]) 1419=item $oldtext = $term->selection ([$newtext, $clipboard])
1187 1420
1188Return the current selection text and optionally replace it by C<$newtext>. 1421Return the current selection (clipboard if C<$clipboard> is true) text
1422and optionally replace it by C<$newtext>.
1423
1424=item $term->selection_clear ([$clipboard])
1425
1426Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1189 1427
1190=item $term->overlay_simple ($x, $y, $text) 1428=item $term->overlay_simple ($x, $y, $text)
1191 1429
1192Create a simple multi-line overlay box. See the next method for details. 1430Create a simple multi-line overlay box. See the next method for details.
1193 1431
1223 1461
1224The methods currently supported on C<urxvt::overlay> objects are: 1462The methods currently supported on C<urxvt::overlay> objects are:
1225 1463
1226=over 4 1464=over 4
1227 1465
1228=item $overlay->set ($x, $y, $text, $rend) 1466=item $overlay->set ($x, $y, $text[, $rend])
1229 1467
1230Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1468Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1231text in rxvt-unicode's special encoding and an array of rendition values 1469text in rxvt-unicode's special encoding and an array of rendition values
1232at a specific position inside the overlay. 1470at a specific position inside the overlay.
1471
1472If C<$rend> is missing, then the rendition will not be changed.
1233 1473
1234=item $overlay->hide 1474=item $overlay->hide
1235 1475
1236If visible, hide the overlay, but do not destroy it. 1476If visible, hide the overlay, but do not destroy it.
1237 1477
1319locale-specific encoding of the terminal and can contain command sequences 1559locale-specific encoding of the terminal and can contain command sequences
1320(escape codes) that will be interpreted. 1560(escape codes) that will be interpreted.
1321 1561
1322=item $term->tt_write ($octets) 1562=item $term->tt_write ($octets)
1323 1563
1324Write the octets given in C<$data> to the tty (i.e. as program input). To 1564Write the octets given in C<$octets> to the tty (i.e. as program input). To
1325pass characters instead of octets, you should convert your strings first 1565pass characters instead of octets, you should convert your strings first
1326to the locale-specific encoding using C<< $term->locale_encode >>. 1566to the locale-specific encoding using C<< $term->locale_encode >>.
1567
1568=item $term->tt_paste ($octets)
1569
1570Write the octets given in C<$octets> to the tty as a paste, converting NL to
1571CR and bracketing the data with control sequences if bracketed paste mode
1572is set.
1327 1573
1328=item $old_events = $term->pty_ev_events ([$new_events]) 1574=item $old_events = $term->pty_ev_events ([$new_events])
1329 1575
1330Replaces the event mask of the pty watcher by the given event mask. Can 1576Replaces the event mask of the pty watcher by the given event mask. Can
1331be used to suppress input and output handling to the pty/tty. See the 1577be used to suppress input and output handling to the pty/tty. See the
1350Adds the specified events to the vt event mask. Useful e.g. when you want 1596Adds the specified events to the vt event mask. Useful e.g. when you want
1351to receive pointer events all the times: 1597to receive pointer events all the times:
1352 1598
1353 $term->vt_emask_add (urxvt::PointerMotionMask); 1599 $term->vt_emask_add (urxvt::PointerMotionMask);
1354 1600
1601=item $term->focus_in
1602
1603=item $term->focus_out
1604
1605=item $term->key_press ($state, $keycode[, $time])
1606
1607=item $term->key_release ($state, $keycode[, $time])
1608
1609Deliver various fake events to to terminal.
1610
1355=item $window_width = $term->width 1611=item $window_width = $term->width
1356 1612
1357=item $window_height = $term->height 1613=item $window_height = $term->height
1358 1614
1359=item $font_width = $term->fwidth 1615=item $font_width = $term->fwidth
1389=item $env = $term->env 1645=item $env = $term->env
1390 1646
1391Returns a copy of the environment in effect for the terminal as a hashref 1647Returns a copy of the environment in effect for the terminal as a hashref
1392similar to C<\%ENV>. 1648similar to C<\%ENV>.
1393 1649
1650=item @envv = $term->envv
1651
1652Returns the environment as array of strings of the form C<VAR=VALUE>.
1653
1654=item @argv = $term->argv
1655
1656Return the argument vector as this terminal, similar to @ARGV, but
1657includes the program name as first element.
1658
1394=cut 1659=cut
1395 1660
1396sub env { 1661sub env {
1397 if (my $env = $_[0]->_env) {
1398 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1662 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1399 } else {
1400 +{ %ENV }
1401 }
1402} 1663}
1403 1664
1404=item $modifiermask = $term->ModLevel3Mask 1665=item $modifiermask = $term->ModLevel3Mask
1405 1666
1406=item $modifiermask = $term->ModMetaMask 1667=item $modifiermask = $term->ModMetaMask
1414 1675
1415Returns the currently displayed screen (0 primary, 1 secondary). 1676Returns the currently displayed screen (0 primary, 1 secondary).
1416 1677
1417=item $cursor_is_hidden = $term->hidden_cursor 1678=item $cursor_is_hidden = $term->hidden_cursor
1418 1679
1419Returns wether the cursor is currently hidden or not. 1680Returns whether the cursor is currently hidden or not.
1420 1681
1421=item $view_start = $term->view_start ([$newvalue]) 1682=item $view_start = $term->view_start ([$newvalue])
1422 1683
1423Returns the row number of the topmost displayed line. Maximum value is 1684Returns the row number of the topmost displayed line. Maximum value is
1424C<0>, which displays the normal terminal contents. Lower values scroll 1685C<0>, which displays the normal terminal contents. Lower values scroll
1432 1693
1433Used after changing terminal contents to display them. 1694Used after changing terminal contents to display them.
1434 1695
1435=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1696=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1436 1697
1437Returns the text of the entire row with number C<$row_number>. Row C<0> 1698Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1438is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1699is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1439terminal line. The scrollback buffer starts at line C<-1> and extends to
1440line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1700terminal line. Nothing will be returned if a nonexistent line
1441is requested. 1701is requested.
1442 1702
1443If C<$new_text> is specified, it will replace characters in the current 1703If C<$new_text> is specified, it will replace characters in the current
1444line, starting at column C<$start_col> (default C<0>), which is useful 1704line, starting at column C<$start_col> (default C<0>), which is useful
1445to replace only parts of a line. The font index in the rendition will 1705to replace only parts of a line. The font index in the rendition will
1446automatically be updated. 1706automatically be updated.
1447 1707
1448C<$text> is in a special encoding: tabs and wide characters that use more 1708C<$text> is in a special encoding: tabs and wide characters that use more
1449than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1709than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1450characters. Characters with combining characters and other characters that 1710characters. Characters with combining characters and other characters that
1451do not fit into the normal tetx encoding will be replaced with characters 1711do not fit into the normal text encoding will be replaced with characters
1452in the private use area. 1712in the private use area.
1453 1713
1454You have to obey this encoding when changing text. The advantage is 1714You have to obey this encoding when changing text. The advantage is
1455that C<substr> and similar functions work on screen cells and not on 1715that C<substr> and similar functions work on screen cells and not on
1456characters. 1716characters.
1601where one character corresponds to one screen cell. See 1861where one character corresponds to one screen cell. See
1602C<< $term->ROW_t >> for details. 1862C<< $term->ROW_t >> for details.
1603 1863
1604=item $string = $term->special_decode $text 1864=item $string = $term->special_decode $text
1605 1865
1606Converts rxvt-unicodes text reprsentation into a perl string. See 1866Converts rxvt-unicodes text representation into a perl string. See
1607C<< $term->ROW_t >> for details. 1867C<< $term->ROW_t >> for details.
1608 1868
1609=item $success = $term->grab_button ($button, $modifiermask) 1869=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1610 1870
1871=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1872
1611Registers a synchronous button grab. See the XGrabButton manpage. 1873Register/unregister a synchronous button grab. See the XGrabButton
1874manpage.
1612 1875
1613=item $success = $term->grab ($eventtime[, $sync]) 1876=item $success = $term->grab ($eventtime[, $sync])
1614 1877
1615Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1878Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1616synchronous (C<$sync> is true). Also remembers the grab timestampe. 1879synchronous (C<$sync> is true). Also remembers the grab timestamp.
1617 1880
1618=item $term->allow_events_async 1881=item $term->allow_events_async
1619 1882
1620Calls XAllowEvents with AsyncBoth for the most recent grab. 1883Calls XAllowEvents with AsyncBoth for the most recent grab.
1621 1884
1628Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1891Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1629recent grab. 1892recent grab.
1630 1893
1631=item $term->ungrab 1894=item $term->ungrab
1632 1895
1633Calls XUngrab for the most recent grab. Is called automatically on 1896Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1634evaluation errors, as it is better to lose the grab in the error case as 1897evaluation errors, as it is better to lose the grab in the error case as
1635the session. 1898the session.
1636 1899
1637=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1900=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1638 1901
1640 1903
1641=item @atoms = $term->XListProperties ($window) 1904=item @atoms = $term->XListProperties ($window)
1642 1905
1643=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1906=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1644 1907
1645=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1908=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1646 1909
1647=item $term->XDeleteProperty ($window, $property) 1910=item $term->XDeleteProperty ($window, $property)
1648 1911
1649=item $window = $term->DefaultRootWindow 1912=item $window = $term->DefaultRootWindow
1650 1913
1660 1923
1661=item $term->XChangeInput ($window, $add_events[, $del_events]) 1924=item $term->XChangeInput ($window, $add_events[, $del_events])
1662 1925
1663Various X or X-related functions. The C<$term> object only serves as 1926Various X or X-related functions. The C<$term> object only serves as
1664the source of the display, otherwise those functions map more-or-less 1927the source of the display, otherwise those functions map more-or-less
1665directory onto the X functions of the same name. 1928directly onto the X functions of the same name.
1666 1929
1667=back 1930=back
1668 1931
1669=cut 1932=cut
1670 1933
1734 my ($self, $text, $cb) = @_; 1997 my ($self, $text, $cb) = @_;
1735 1998
1736 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1999 $self->add_item ({ type => "button", text => $text, activate => $cb});
1737} 2000}
1738 2001
1739=item $popup->add_toggle ($text, $cb, $initial_value) 2002=item $popup->add_toggle ($text, $initial_value, $cb)
1740 2003
1741Adds a toggle/checkbox item to the popup. Teh callback gets called 2004Adds a toggle/checkbox item to the popup. The callback gets called
1742whenever it gets toggled, with a boolean indicating its value as its first 2005whenever it gets toggled, with a boolean indicating its new value as its
1743argument. 2006first argument.
1744 2007
1745=cut 2008=cut
1746 2009
1747sub add_toggle { 2010sub add_toggle {
1748 my ($self, $text, $cb, $value) = @_; 2011 my ($self, $text, $value, $cb) = @_;
1749 2012
1750 my $item; $item = { 2013 my $item; $item = {
1751 type => "button", 2014 type => "button",
1752 text => " $text", 2015 text => " $text",
1753 value => $value, 2016 value => $value,
1772 my $env = $self->{term}->env; 2035 my $env = $self->{term}->env;
1773 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2036 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1774 delete $env->{LC_ALL}; 2037 delete $env->{LC_ALL};
1775 $env->{LC_CTYPE} = $self->{term}->locale; 2038 $env->{LC_CTYPE} = $self->{term}->locale;
1776 2039
1777 urxvt::term->new ($env, "popup", 2040 my $term = urxvt::term->new (
2041 $env, "popup",
1778 "--perl-lib" => "", "--perl-ext-common" => "", 2042 "--perl-lib" => "", "--perl-ext-common" => "",
1779 "-pty-fd" => -1, "-sl" => 0, 2043 "-pty-fd" => -1, "-sl" => 0,
1780 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2044 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1781 "--transient-for" => $self->{term}->parent, 2045 "--transient-for" => $self->{term}->parent,
1782 "-display" => $self->{term}->display_id, 2046 "-display" => $self->{term}->display_id,
1783 "-pe" => "urxvt-popup") 2047 "-pe" => "urxvt-popup",
1784 or die "unable to create popup window\n"; 2048 ) or die "unable to create popup window\n";
2049
2050 unless (delete $term->{urxvt_popup_init_done}) {
2051 $term->ungrab;
2052 $term->destroy;
2053 die "unable to initialise popup window\n";
2054 }
1785} 2055}
1786 2056
1787sub DESTROY { 2057sub DESTROY {
1788 my ($self) = @_; 2058 my ($self) = @_;
1789 2059
1794=back 2064=back
1795 2065
1796=cut 2066=cut
1797 2067
1798package urxvt::watcher; 2068package urxvt::watcher;
1799
1800@urxvt::timer::ISA = __PACKAGE__;
1801@urxvt::iow::ISA = __PACKAGE__;
1802@urxvt::pw::ISA = __PACKAGE__;
1803@urxvt::iw::ISA = __PACKAGE__;
1804 2069
1805=head2 The C<urxvt::timer> Class 2070=head2 The C<urxvt::timer> Class
1806 2071
1807This class implements timer watchers/events. Time is represented as a 2072This class implements timer watchers/events. Time is represented as a
1808fractional number of seconds since the epoch. Example: 2073fractional number of seconds since the epoch. Example:
1812 ->new 2077 ->new
1813 ->interval (1) 2078 ->interval (1)
1814 ->cb (sub { 2079 ->cb (sub {
1815 $term->{overlay}->set (0, 0, 2080 $term->{overlay}->set (0, 0,
1816 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2081 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1817 }); 2082 });
1818 2083
1819=over 4 2084=over 4
1820 2085
1821=item $timer = new urxvt::timer 2086=item $timer = new urxvt::timer
1822 2087
1825 2090
1826=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2091=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1827 2092
1828Set the callback to be called when the timer triggers. 2093Set the callback to be called when the timer triggers.
1829 2094
1830=item $tstamp = $timer->at
1831
1832Return the time this watcher will fire next.
1833
1834=item $timer = $timer->set ($tstamp) 2095=item $timer = $timer->set ($tstamp[, $interval])
1835 2096
1836Set the time the event is generated to $tstamp. 2097Set the time the event is generated to $tstamp (and optionally specifies a
2098new $interval).
1837 2099
1838=item $timer = $timer->interval ($interval) 2100=item $timer = $timer->interval ($interval)
1839 2101
1840Normally (and when C<$interval> is C<0>), the timer will automatically 2102By default (and when C<$interval> is C<0>), the timer will automatically
1841stop after it has fired once. If C<$interval> is non-zero, then the timer 2103stop after it has fired once. If C<$interval> is non-zero, then the timer
1842is automatically rescheduled at the given intervals. 2104is automatically rescheduled at the given intervals.
1843 2105
1844=item $timer = $timer->start 2106=item $timer = $timer->start
1845 2107
1846Start the timer. 2108Start the timer.
1847 2109
1848=item $timer = $timer->start ($tstamp) 2110=item $timer = $timer->start ($tstamp[, $interval])
1849 2111
1850Set the event trigger time to C<$tstamp> and start the timer. 2112Set the event trigger time to C<$tstamp> and start the timer. Optionally
2113also replaces the interval.
1851 2114
1852=item $timer = $timer->after ($delay) 2115=item $timer = $timer->after ($delay[, $interval])
1853 2116
1854Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2117Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1855 2118
1856=item $timer = $timer->stop 2119=item $timer = $timer->stop
1857 2120
1865 2128
1866 $term->{socket} = ... 2129 $term->{socket} = ...
1867 $term->{iow} = urxvt::iow 2130 $term->{iow} = urxvt::iow
1868 ->new 2131 ->new
1869 ->fd (fileno $term->{socket}) 2132 ->fd (fileno $term->{socket})
1870 ->events (urxvt::EVENT_READ) 2133 ->events (urxvt::EV_READ)
1871 ->start 2134 ->start
1872 ->cb (sub { 2135 ->cb (sub {
1873 my ($iow, $revents) = @_; 2136 my ($iow, $revents) = @_;
1874 # $revents must be 1 here, no need to check 2137 # $revents must be 1 here, no need to check
1875 sysread $term->{socket}, my $buf, 8192 2138 sysread $term->{socket}, my $buf, 8192
1888Set the callback to be called when io events are triggered. C<$reventmask> 2151Set the callback to be called when io events are triggered. C<$reventmask>
1889is a bitset as described in the C<events> method. 2152is a bitset as described in the C<events> method.
1890 2153
1891=item $iow = $iow->fd ($fd) 2154=item $iow = $iow->fd ($fd)
1892 2155
1893Set the filedescriptor (not handle) to watch. 2156Set the file descriptor (not handle) to watch.
1894 2157
1895=item $iow = $iow->events ($eventmask) 2158=item $iow = $iow->events ($eventmask)
1896 2159
1897Set the event mask to watch. The only allowed values are 2160Set the event mask to watch. The only allowed values are
1898C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2161C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1899together, or C<urxvt::EVENT_NONE>. 2162together, or C<urxvt::EV_NONE>.
1900 2163
1901=item $iow = $iow->start 2164=item $iow = $iow->start
1902 2165
1903Start watching for requested events on the given handle. 2166Start watching for requested events on the given handle.
1904 2167
1905=item $iow = $iow->stop 2168=item $iow = $iow->stop
1906 2169
1907Stop watching for events on the given filehandle. 2170Stop watching for events on the given file handle.
1908 2171
1909=back 2172=back
1910 2173
1911=head2 The C<urxvt::iw> Class 2174=head2 The C<urxvt::iw> Class
1912 2175
1945 ->new 2208 ->new
1946 ->start ($pid) 2209 ->start ($pid)
1947 ->cb (sub { 2210 ->cb (sub {
1948 my ($pw, $exit_status) = @_; 2211 my ($pw, $exit_status) = @_;
1949 ... 2212 ...
1950 }); 2213 });
1951 2214
1952=over 4 2215=over 4
1953 2216
1954=item $pw = new urxvt::pw 2217=item $pw = new urxvt::pw
1955 2218
1959 2222
1960Set the callback to be called when the timer triggers. 2223Set the callback to be called when the timer triggers.
1961 2224
1962=item $pw = $timer->start ($pid) 2225=item $pw = $timer->start ($pid)
1963 2226
1964Tells the wqtcher to start watching for process C<$pid>. 2227Tells the watcher to start watching for process C<$pid>.
1965 2228
1966=item $pw = $pw->stop 2229=item $pw = $pw->stop
1967 2230
1968Stop the watcher. 2231Stop the watcher.
1969 2232
1982 2245
1983=item >= 3 - script loading and management 2246=item >= 3 - script loading and management
1984 2247
1985=item >=10 - all called hooks 2248=item >=10 - all called hooks
1986 2249
1987=item >=11 - hook reutrn values 2250=item >=11 - hook return values
1988 2251
1989=back 2252=back
1990 2253
1991=head1 AUTHOR 2254=head1 AUTHOR
1992 2255
1994 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
1995 2258
1996=cut 2259=cut
1997 2260
19981 22611
2262
2263# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines