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.126 by root, Tue Jan 24 19:14:36 2006 UTC vs.
Revision 1.189 by root, Sat Dec 18 15:37:10 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: \\|([^|]+)\\|
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.
216 258
217=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.
218 263
219This 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.
220to 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.
221a custom pixmap. No scaling is supported in this mode. Exmaple:
222 266
223 @@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.
224 313
225=item block-graphics-to-ascii 314=item block-graphics-to-ascii
226 315
227A 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
228by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
229similar-looking ascii character. 318similar-looking ascii character.
230 319
231=item digital-clock 320=item digital-clock
232 321
233Displays 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.
234 391
235=item example-refresh-hooks 392=item example-refresh-hooks
236 393
237Displays 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
238window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
239overlays or changes. 396overlays or changes.
240 397
241=item selection-pastebin 398=item confirm-paste
242 399
243This is a little rarely useful extension that Uploads the selection as 400Displays a confirmation dialog when a paste containing at least a full
244textfile to a remote site (or does other things). (The implementation is 401line is detected.
245not currently secure for use in a multiuser environment as it writes to
246F</tmp> directly.).
247
248It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
249i.e.
250
251 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
252
253Pressing this combination runs a command with C<%> replaced by the name of
254the textfile. This command can be set via a resource:
255
256 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
257
258And the default is likely not useful to anybody but the few people around
259here :)
260
261The name of the textfile is the hex encoded md5 sum of the selection, so
262the same content should lead to the same filename.
263
264After a successful upload the selection will be replaced by the text given
265in the C<selection-pastebin-url> resource (again, the % is the placeholder
266for the filename):
267
268 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
269 402
270=back 403=back
271 404
272=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
273 406
289 422
290=over 4 423=over 4
291 424
292=item $text 425=item $text
293 426
294Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
295always 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.
296 429
297=item $string 430=item $string
298 431
299A 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
307 440
308=back 441=back
309 442
310=head2 Extension Objects 443=head2 Extension Objects
311 444
312Very 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
313for 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,
314hooks. 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
315about 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
316begin with an underscore character C<_>: these are reserved for internal 450that begin with an underscore character C<_>: these are reserved for
317use. 451internal use.
318 452
319Although 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
320C<urxvt::term> class on this object. 454C<urxvt::term> class on this object.
321 455
322It has the following methods and data members: 456It has the following methods and data members:
343=head2 Hooks 477=head2 Hooks
344 478
345The following subroutines can be declared in extension files, and will be 479The following subroutines can be declared in extension files, and will be
346called whenever the relevant event happens. 480called whenever the relevant event happens.
347 481
348The 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
349the in the C<Extension Objects> section. 483the in the C<Extension Objects> section.
350 484
351B<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
352hooks 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
353relevant action might not be carried out by the C++ code. 487relevant action might not be carried out by the C++ code.
366place. 500place.
367 501
368=item on_start $term 502=item on_start $term
369 503
370Called 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
371trying to map (display) the toplevel and returning to the mainloop. 505trying to map (display) the toplevel and returning to the main loop.
372 506
373=item on_destroy $term 507=item on_destroy $term
374 508
375Called whenever something tries to destroy terminal, before doing anything 509Called whenever something tries to destroy terminal, when the terminal is
376yet. If this hook returns true, then destruction is skipped, but this is 510still fully functional (not for long, though).
377rarely a good idea.
378 511
379=item on_reset $term 512=item on_reset $term
380 513
381Called after the screen is "reset" for any reason, such as resizing or 514Called after the screen is "reset" for any reason, such as resizing or
382control sequences. Here is where you can react on changes to size-related 515control sequences. Here is where you can react on changes to size-related
404 537
405Called whenever a selection has been copied, but before the selection is 538Called whenever a selection has been copied, but before the selection is
406requested from the server. The selection text can be queried and changed 539requested from the server. The selection text can be queried and changed
407by calling C<< $term->selection >>. 540by calling C<< $term->selection >>.
408 541
409Returning a true value aborts selection grabbing. It will still be hilighted. 542Returning a true value aborts selection grabbing. It will still be highlighted.
410 543
411=item on_sel_extend $term 544=item on_sel_extend $term
412 545
413Called 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
414click) and is either supposed to return false (normal operation), or 547click) and is either supposed to return false (normal operation), or
415should 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
416processing. This can happen multiple times, as long as the callback 549processing. This can happen multiple times, as long as the callback
417returns 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
418supposed to enlarge the selection more and more, if possible. 551supposed to enlarge the selection more and more, if possible.
419 552
420See the F<selection> example extension. 553See the F<selection> example extension.
421 554
422=item on_view_change $term, $offset 555=item on_view_change $term, $offset
423 556
424Called whenever the view offset changes, i..e the user or program 557Called whenever the view offset changes, i.e. the user or program
425scrolls. Offset C<0> means display the normal terminal, positive values 558scrolls. Offset C<0> means display the normal terminal, positive values
426show this many lines of scrollback. 559show this many lines of scrollback.
427 560
428=item on_scroll_back $term, $lines, $saved 561=item on_scroll_back $term, $lines, $saved
429 562
433 566
434It 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,
435$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
436number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
437 570
438=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
439 582
440Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
441operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
442information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
443string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
444it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
445future. 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 }
446 599
447Be 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,
448as 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
449other 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.
450 606
451=item on_add_lines $term, $string 607=item on_add_lines $term, $string
452 608
453Called 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
454can 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
459=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
460 616
461Called 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
462suppress or filter tty input. 618suppress or filter tty input.
463 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
464=item on_line_update $term, $row 627=item on_line_update $term, $row
465 628
466Called 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
467screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
468that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
475later 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
476you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
477 640
478=item on_refresh_begin $term 641=item on_refresh_begin $term
479 642
480Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
481or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
482restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
483code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
484 647
485=item on_refresh_end $term 648=item on_refresh_end $term
486 649
487Called just after the screen gets redrawn. See C<on_refresh_begin>. 650Called just after the screen gets redrawn. See C<on_refresh_begin>.
488 651
489=item on_keyboard_command $term, $string 652=item on_user_command $term, $string
490 653
491Called whenever the user presses a key combination that has a 654Called whenever a user-configured event is being activated (e.g. via
492C<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>
493resource 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.
494 666
495=item on_x_event $term, $event 667=item on_x_event $term, $event
496 668
497Called 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
498windows). Should only be used as a last resort. Most event structure 670windows). Should only be used as a last resort. Most event structure
499members are not passed. 671members are not passed.
500 672
673=item on_root_event $term, $event
674
675Like C<on_x_event>, but is called for events on the root window.
676
501=item on_focus_in $term 677=item on_focus_in $term
502 678
503Called whenever the window gets the keyboard focus, before rxvt-unicode 679Called whenever the window gets the keyboard focus, before rxvt-unicode
504does focus in processing. 680does focus in processing.
505 681
506=item on_focus_out $term 682=item on_focus_out $term
507 683
508Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called whenever the window loses keyboard focus, before rxvt-unicode does
509focus out processing. 685focus out processing.
510 686
511=item on_configure_notify $term, $event 687=item on_configure_notify $term, $event
512 688
513=item on_property_notify $term, $event 689=item on_property_notify $term, $event
524 700
525=item on_map_notify $term, $event 701=item on_map_notify $term, $event
526 702
527=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
528 704
529Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
530the 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.
531 707
532The 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
533manpage), 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
534(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
535 711
544 720
545=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
546 722
547Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
548format=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.
549 729
550=back 730=back
551 731
552=cut 732=cut
553 733
596The current terminal. This variable stores the current C<urxvt::term> 776The current terminal. This variable stores the current C<urxvt::term>
597object, whenever a callback/hook is executing. 777object, whenever a callback/hook is executing.
598 778
599=item @urxvt::TERM_INIT 779=item @urxvt::TERM_INIT
600 780
601All 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
602created 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
603gets cleared before the codereferences that were in it are being executed, 783gets cleared before the code references that were in it are being executed,
604so coderefs can push themselves onto it again if they so desire. 784so references can push themselves onto it again if they so desire.
605 785
606This complements to the perl-eval commandline option, but gets executed 786This complements to the perl-eval command line option, but gets executed
607first. 787first.
608 788
609=item @urxvt::TERM_EXT 789=item @urxvt::TERM_EXT
610 790
611Works 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
632 812
633Using this function has the advantage that its output ends up in the 813Using this function has the advantage that its output ends up in the
634correct place, e.g. on stderr of the connecting urxvtc client. 814correct place, e.g. on stderr of the connecting urxvtc client.
635 815
636Messages have a size limit of 1023 bytes currently. 816Messages have a size limit of 1023 bytes currently.
817
818=item @terms = urxvt::termlist
819
820Returns all urxvt::term objects that exist in this process, regardless of
821whether they are started, being destroyed etc., so be careful. Only term
822objects that have perl extensions attached will be returned (because there
823is no urxvt::term objet associated with others).
637 824
638=item $time = urxvt::NOW 825=item $time = urxvt::NOW
639 826
640Returns the "current time" (as per the event loop). 827Returns the "current time" (as per the event loop).
641 828
684 871
685=item $rend = urxvt::OVERLAY_RSTYLE 872=item $rend = urxvt::OVERLAY_RSTYLE
686 873
687Return the rendition mask used for overlays by default. 874Return the rendition mask used for overlays by default.
688 875
689=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 876=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
877urxvt::RS_RVid, urxvt::RS_Uline
690 878
691Return the bit that enabled bold, italic, blink, reverse-video and 879Return the bit that enabled bold, italic, blink, reverse-video and
692underline, respectively. To enable such a style, just logically OR it into 880underline, respectively. To enable such a style, just logically OR it into
693the bitset. 881the bitset.
694 882
699Return the foreground/background colour index, respectively. 887Return the foreground/background colour index, respectively.
700 888
701=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 889=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
702 890
703=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 891=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
892
893=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
704 894
705Replace the foreground/background colour in the rendition mask with the 895Replace the foreground/background colour in the rendition mask with the
706specified one. 896specified one.
707 897
708=item $value = urxvt::GET_CUSTOM $rend 898=item $value = urxvt::GET_CUSTOM $rend
775 local $TERM = shift; 965 local $TERM = shift;
776 my $htype = shift; 966 my $htype = shift;
777 967
778 if ($htype == 0) { # INIT 968 if ($htype == 0) { # INIT
779 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 969 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
780 970
781 my %ext_arg; 971 my %ext_arg;
782 972
783 { 973 {
784 my @init = @TERM_INIT; 974 my @init = @TERM_INIT;
785 @TERM_INIT = (); 975 @TERM_INIT = ();
799 } else { 989 } else {
800 $ext_arg{$_} ||= []; 990 $ext_arg{$_} ||= [];
801 } 991 }
802 } 992 }
803 993
804 while (my ($ext, $argv) = each %ext_arg) { 994 for my $ext (sort keys %ext_arg) {
805 my @files = grep -f $_, map "$_/$ext", @dirs; 995 my @files = grep -f $_, map "$_/$ext", @dirs;
806 996
807 if (@files) { 997 if (@files) {
808 $TERM->register_package (extension_package $files[0], $argv); 998 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
809 } else { 999 } else {
810 warn "perl extension '$ext' not found in perl library search path\n"; 1000 warn "perl extension '$ext' not found in perl library search path\n";
811 } 1001 }
812 } 1002 }
813 1003
819 1009
820 if (my $cb = $TERM->{_hook}[$htype]) { 1010 if (my $cb = $TERM->{_hook}[$htype]) {
821 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1011 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
822 if $verbosity >= 10; 1012 if $verbosity >= 10;
823 1013
824 keys %$cb; 1014 for my $pkg (keys %$cb) {
825
826 while (my ($pkg, $cb) = each %$cb) {
827 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1015 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
828 $retval ||= $retval_; 1016 $retval ||= $retval_;
829 1017
830 if ($@) { 1018 if ($@) {
831 $TERM->ungrab; # better to lose the grab than the session 1019 $TERM->ungrab; # better to lose the grab than the session
832 warn $@; 1020 warn $@;
844 # clear package 1032 # clear package
845 %$TERM = (); 1033 %$TERM = ();
846 } 1034 }
847 1035
848 $retval 1036 $retval
1037}
1038
1039sub SET_COLOR($$$) {
1040 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1041}
1042
1043sub rend2mask {
1044 no strict 'refs';
1045 my ($str, $mask) = (@_, 0);
1046 my %color = ( fg => undef, bg => undef );
1047 my @failed;
1048 for my $spec ( split /\s+/, $str ) {
1049 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1050 $color{lc($1)} = $2;
1051 } else {
1052 my $neg = $spec =~ s/^[-^]//;
1053 unless ( exists &{"RS_$spec"} ) {
1054 push @failed, $spec;
1055 next;
1056 }
1057 my $cur = &{"RS_$spec"};
1058 if ( $neg ) {
1059 $mask &= ~$cur;
1060 } else {
1061 $mask |= $cur;
1062 }
1063 }
1064 }
1065 ($mask, @color{qw(fg bg)}, \@failed)
849} 1066}
850 1067
851# urxvt::term::extension 1068# urxvt::term::extension
852 1069
853package urxvt::term::extension; 1070package urxvt::term::extension;
924is that you cannot use blocking APIs, but the non-blocking variant should 1141is that you cannot use blocking APIs, but the non-blocking variant should
925work. 1142work.
926 1143
927=cut 1144=cut
928 1145
929our $VERSION = 1; 1146our $VERSION = '5.23';
930 1147
931$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1148$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
932push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1149push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
933 1150
934sub timer { 1151sub timer {
936 1153
937 my $cb = $arg{cb}; 1154 my $cb = $arg{cb};
938 1155
939 urxvt::timer 1156 urxvt::timer
940 ->new 1157 ->new
941 ->start (urxvt::NOW + $arg{after}) 1158 ->after ($arg{after}, $arg{interval})
942 ->cb (sub { 1159 ->cb ($arg{interval} ? $cb : sub {
943 $_[0]->stop; # need to cancel manually 1160 $_[0]->stop; # need to cancel manually
944 $cb->(); 1161 $cb->();
945 }) 1162 })
946} 1163}
947 1164
948sub io { 1165sub io {
949 my ($class, %arg) = @_; 1166 my ($class, %arg) = @_;
950 1167
951 my $cb = $arg{cb}; 1168 my $cb = $arg{cb};
1169 my $fd = fileno $arg{fh};
1170 defined $fd or $fd = $arg{fh};
952 1171
953 bless [$arg{fh}, urxvt::iow 1172 bless [$arg{fh}, urxvt::iow
954 ->new 1173 ->new
955 ->fd (fileno $arg{fh}) 1174 ->fd ($fd)
956 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1175 ->events (($arg{poll} =~ /r/ ? 1 : 0)
957 | ($arg{poll} =~ /w/ ? 2 : 0)) 1176 | ($arg{poll} =~ /w/ ? 2 : 0))
958 ->start 1177 ->start
959 ->cb (sub { 1178 ->cb ($cb)
960 $cb->(($_[1] & 1 ? 'r' : '')
961 . ($_[1] & 2 ? 'w' : ''));
962 })],
963 urxvt::anyevent:: 1179 ], urxvt::anyevent::
1180}
1181
1182sub idle {
1183 my ($class, %arg) = @_;
1184
1185 my $cb = $arg{cb};
1186
1187 urxvt::iw
1188 ->new
1189 ->start
1190 ->cb ($cb)
1191}
1192
1193sub child {
1194 my ($class, %arg) = @_;
1195
1196 my $cb = $arg{cb};
1197
1198 urxvt::pw
1199 ->new
1200 ->start ($arg{pid})
1201 ->cb (sub {
1202 $_[0]->stop; # need to cancel manually
1203 $cb->($_[0]->rpid, $_[0]->rstatus);
1204 })
964} 1205}
965 1206
966sub DESTROY { 1207sub DESTROY {
967 $_[0][1]->stop; 1208 $_[0][1]->stop;
968} 1209}
969 1210
970sub condvar { 1211sub one_event {
971 bless \my $flag, urxvt::anyevent::condvar::
972}
973
974sub urxvt::anyevent::condvar::broadcast {
975 ${$_[0]}++;
976}
977
978sub urxvt::anyevent::condvar::wait {
979 unless (${$_[0]}) {
980 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1212 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
981 }
982} 1213}
983 1214
984package urxvt::term; 1215package urxvt::term;
985 1216
986=head2 The C<urxvt::term> Class 1217=head2 The C<urxvt::term> Class
1022hash which defines the environment of the new terminal. 1253hash which defines the environment of the new terminal.
1023 1254
1024Croaks (and probably outputs an error message) if the new instance 1255Croaks (and probably outputs an error message) if the new instance
1025couldn't be created. Returns C<undef> if the new instance didn't 1256couldn't be created. Returns C<undef> if the new instance didn't
1026initialise perl, and the terminal object otherwise. The C<init> and 1257initialise perl, and the terminal object otherwise. The C<init> and
1027C<start> hooks will be called during this call. 1258C<start> hooks will be called before this call returns, and are free to
1259refer to global data (which is race free).
1028 1260
1029=cut 1261=cut
1030 1262
1031sub new { 1263sub new {
1032 my ($class, $env, @args) = @_; 1264 my ($class, $env, @args) = @_;
1033 1265
1266 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1267 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1268
1034 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1269 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1035} 1270}
1036 1271
1037=item $term->destroy 1272=item $term->destroy
1038 1273
1039Destroy the terminal object (close the window, free resources 1274Destroy the terminal object (close the window, free resources
1069 1304
1070Returns true if the option specified by C<$optval> is enabled, and 1305Returns true if the option specified by C<$optval> is enabled, and
1071optionally change it. All option values are stored by name in the hash 1306optionally change it. All option values are stored by name in the hash
1072C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1307C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1073 1308
1074Here is a a likely non-exhaustive list of option names, please see the 1309Here is a likely non-exhaustive list of option names, please see the
1075source file F</src/optinc.h> to see the actual list: 1310source file F</src/optinc.h> to see the actual list:
1076 1311
1077 borderLess console cursorBlink cursorUnderline hold iconic insecure 1312 borderLess console cursorBlink cursorUnderline hold iconic insecure
1078 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1313 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1079 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1314 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1096likely change). 1331likely change).
1097 1332
1098Please note that resource strings will currently only be freed when the 1333Please note that resource strings will currently only be freed when the
1099terminal is destroyed, so changing options frequently will eat memory. 1334terminal is destroyed, so changing options frequently will eat memory.
1100 1335
1101Here is a a likely non-exhaustive list of resource names, not all of which 1336Here is a likely non-exhaustive list of resource names, not all of which
1102are supported in every build, please see the source file F</src/rsinc.h> 1337are supported in every build, please see the source file F</src/rsinc.h>
1103to see the actual list: 1338to see the actual list:
1104 1339
1105 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1340 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1106 borderLess color cursorBlink cursorUnderline cutchars delete_key 1341 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1107 display_name embed ext_bwidth fade font geometry hold iconName 1342 display_name embed ext_bwidth fade font geometry hold iconName
1108 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1343 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1109 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1344 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1110 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1345 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1111 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1346 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1112 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1347 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1113 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1348 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1114 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1349 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1115 secondaryScreen secondaryScroll selectstyle shade term_name title 1350 secondaryScreen secondaryScroll shade term_name title
1116 transient_for transparent transparent_all tripleclickwords utmpInhibit 1351 transient_for transparent transparent_all tripleclickwords utmpInhibit
1117 visualBell 1352 visualBell
1118 1353
1119=cut 1354=cut
1120 1355
1121sub resource($$;$) { 1356sub resource($$;$) {
1122 my ($self, $name) = (shift, shift); 1357 my ($self, $name) = (shift, shift);
1123 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1358 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1124 &urxvt::term::_resource 1359 goto &urxvt::term::_resource
1125} 1360}
1126 1361
1127=item $value = $term->x_resource ($pattern) 1362=item $value = $term->x_resource ($pattern)
1128 1363
1129Returns the X-Resource for the given pattern, excluding the program or 1364Returns the X-Resource for the given pattern, excluding the program or
1154 1389
1155=item ($row, $col) = $term->selection_beg ([$row, $col]) 1390=item ($row, $col) = $term->selection_beg ([$row, $col])
1156 1391
1157=item ($row, $col) = $term->selection_end ([$row, $col]) 1392=item ($row, $col) = $term->selection_end ([$row, $col])
1158 1393
1159Return the current values of the selection mark, begin or end positions, 1394Return the current values of the selection mark, begin or end positions.
1160and optionally set them to new values. 1395
1396When arguments are given, then the selection coordinates are set to
1397C<$row> and C<$col>, and the selection screen is set to the current
1398screen.
1399
1400=item $screen = $term->selection_screen ([$screen])
1401
1402Returns the current selection screen, and then optionally sets it.
1161 1403
1162=item $term->selection_make ($eventtime[, $rectangular]) 1404=item $term->selection_make ($eventtime[, $rectangular])
1163 1405
1164Tries to make a selection as set by C<selection_beg> and 1406Tries to make a selection as set by C<selection_beg> and
1165C<selection_end>. If C<$rectangular> is true (default: false), a 1407C<selection_end>. If C<$rectangular> is true (default: false), a
1166rectangular selection will be made. This is the prefered function to make 1408rectangular selection will be made. This is the preferred function to make
1167a selection. 1409a selection.
1168 1410
1169=item $success = $term->selection_grab ($eventtime) 1411=item $success = $term->selection_grab ($eventtime[, $clipboard])
1170 1412
1171Try to request the primary selection text from the server (for example, as 1413Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1414true) selection from the server. The corresponding text can be set
1172set by the next method). No visual feedback will be given. This function 1415with the next method. No visual feedback will be given. This function
1173is mostly useful from within C<on_sel_grab> hooks. 1416is mostly useful from within C<on_sel_grab> hooks.
1174 1417
1175=item $oldtext = $term->selection ([$newtext]) 1418=item $oldtext = $term->selection ([$newtext, $clipboard])
1176 1419
1177Return the current selection text and optionally replace it by C<$newtext>. 1420Return the current selection (clipboard if C<$clipboard> is true) text
1421and optionally replace it by C<$newtext>.
1422
1423=item $term->selection_clear ([$clipboard])
1424
1425Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1178 1426
1179=item $term->overlay_simple ($x, $y, $text) 1427=item $term->overlay_simple ($x, $y, $text)
1180 1428
1181Create a simple multi-line overlay box. See the next method for details. 1429Create a simple multi-line overlay box. See the next method for details.
1182 1430
1212 1460
1213The methods currently supported on C<urxvt::overlay> objects are: 1461The methods currently supported on C<urxvt::overlay> objects are:
1214 1462
1215=over 4 1463=over 4
1216 1464
1217=item $overlay->set ($x, $y, $text, $rend) 1465=item $overlay->set ($x, $y, $text[, $rend])
1218 1466
1219Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1467Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1220text in rxvt-unicode's special encoding and an array of rendition values 1468text in rxvt-unicode's special encoding and an array of rendition values
1221at a specific position inside the overlay. 1469at a specific position inside the overlay.
1470
1471If C<$rend> is missing, then the rendition will not be changed.
1222 1472
1223=item $overlay->hide 1473=item $overlay->hide
1224 1474
1225If visible, hide the overlay, but do not destroy it. 1475If visible, hide the overlay, but do not destroy it.
1226 1476
1308locale-specific encoding of the terminal and can contain command sequences 1558locale-specific encoding of the terminal and can contain command sequences
1309(escape codes) that will be interpreted. 1559(escape codes) that will be interpreted.
1310 1560
1311=item $term->tt_write ($octets) 1561=item $term->tt_write ($octets)
1312 1562
1313Write the octets given in C<$data> to the tty (i.e. as program input). To 1563Write the octets given in C<$octets> to the tty (i.e. as program input). To
1314pass characters instead of octets, you should convert your strings first 1564pass characters instead of octets, you should convert your strings first
1315to the locale-specific encoding using C<< $term->locale_encode >>. 1565to the locale-specific encoding using C<< $term->locale_encode >>.
1566
1567=item $term->tt_paste ($octets)
1568
1569Write the octets given in C<$octets> to the tty as a paste, converting NL to
1570CR and bracketing the data with control sequences if bracketed paste mode
1571is set.
1316 1572
1317=item $old_events = $term->pty_ev_events ([$new_events]) 1573=item $old_events = $term->pty_ev_events ([$new_events])
1318 1574
1319Replaces the event mask of the pty watcher by the given event mask. Can 1575Replaces the event mask of the pty watcher by the given event mask. Can
1320be used to suppress input and output handling to the pty/tty. See the 1576be used to suppress input and output handling to the pty/tty. See the
1339Adds the specified events to the vt event mask. Useful e.g. when you want 1595Adds the specified events to the vt event mask. Useful e.g. when you want
1340to receive pointer events all the times: 1596to receive pointer events all the times:
1341 1597
1342 $term->vt_emask_add (urxvt::PointerMotionMask); 1598 $term->vt_emask_add (urxvt::PointerMotionMask);
1343 1599
1600=item $term->focus_in
1601
1602=item $term->focus_out
1603
1604=item $term->key_press ($state, $keycode[, $time])
1605
1606=item $term->key_release ($state, $keycode[, $time])
1607
1608Deliver various fake events to to terminal.
1609
1344=item $window_width = $term->width 1610=item $window_width = $term->width
1345 1611
1346=item $window_height = $term->height 1612=item $window_height = $term->height
1347 1613
1348=item $font_width = $term->fwidth 1614=item $font_width = $term->fwidth
1378=item $env = $term->env 1644=item $env = $term->env
1379 1645
1380Returns a copy of the environment in effect for the terminal as a hashref 1646Returns a copy of the environment in effect for the terminal as a hashref
1381similar to C<\%ENV>. 1647similar to C<\%ENV>.
1382 1648
1649=item @envv = $term->envv
1650
1651Returns the environment as array of strings of the form C<VAR=VALUE>.
1652
1653=item @argv = $term->argv
1654
1655Return the argument vector as this terminal, similar to @ARGV, but
1656includes the program name as first element.
1657
1383=cut 1658=cut
1384 1659
1385sub env { 1660sub env {
1386 if (my $env = $_[0]->_env) {
1387 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1661 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1388 } else {
1389 +{ %ENV }
1390 }
1391} 1662}
1392 1663
1393=item $modifiermask = $term->ModLevel3Mask 1664=item $modifiermask = $term->ModLevel3Mask
1394 1665
1395=item $modifiermask = $term->ModMetaMask 1666=item $modifiermask = $term->ModMetaMask
1403 1674
1404Returns the currently displayed screen (0 primary, 1 secondary). 1675Returns the currently displayed screen (0 primary, 1 secondary).
1405 1676
1406=item $cursor_is_hidden = $term->hidden_cursor 1677=item $cursor_is_hidden = $term->hidden_cursor
1407 1678
1408Returns wether the cursor is currently hidden or not. 1679Returns whether the cursor is currently hidden or not.
1409 1680
1410=item $view_start = $term->view_start ([$newvalue]) 1681=item $view_start = $term->view_start ([$newvalue])
1411 1682
1412Returns the row number of the topmost displayed line. Maximum value is 1683Returns the row number of the topmost displayed line. Maximum value is
1413C<0>, which displays the normal terminal contents. Lower values scroll 1684C<0>, which displays the normal terminal contents. Lower values scroll
1421 1692
1422Used after changing terminal contents to display them. 1693Used after changing terminal contents to display them.
1423 1694
1424=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1695=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1425 1696
1426Returns the text of the entire row with number C<$row_number>. Row C<0> 1697Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1427is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1698is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1428terminal line. The scrollback buffer starts at line C<-1> and extends to
1429line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1699terminal line. Nothing will be returned if a nonexistent line
1430is requested. 1700is requested.
1431 1701
1432If C<$new_text> is specified, it will replace characters in the current 1702If C<$new_text> is specified, it will replace characters in the current
1433line, starting at column C<$start_col> (default C<0>), which is useful 1703line, starting at column C<$start_col> (default C<0>), which is useful
1434to replace only parts of a line. The font index in the rendition will 1704to replace only parts of a line. The font index in the rendition will
1435automatically be updated. 1705automatically be updated.
1436 1706
1437C<$text> is in a special encoding: tabs and wide characters that use more 1707C<$text> is in a special encoding: tabs and wide characters that use more
1438than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1708than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1439characters. Characters with combining characters and other characters that 1709characters. Characters with combining characters and other characters that
1440do not fit into the normal tetx encoding will be replaced with characters 1710do not fit into the normal text encoding will be replaced with characters
1441in the private use area. 1711in the private use area.
1442 1712
1443You have to obey this encoding when changing text. The advantage is 1713You have to obey this encoding when changing text. The advantage is
1444that C<substr> and similar functions work on screen cells and not on 1714that C<substr> and similar functions work on screen cells and not on
1445characters. 1715characters.
1590where one character corresponds to one screen cell. See 1860where one character corresponds to one screen cell. See
1591C<< $term->ROW_t >> for details. 1861C<< $term->ROW_t >> for details.
1592 1862
1593=item $string = $term->special_decode $text 1863=item $string = $term->special_decode $text
1594 1864
1595Converts rxvt-unicodes text reprsentation into a perl string. See 1865Converts rxvt-unicodes text representation into a perl string. See
1596C<< $term->ROW_t >> for details. 1866C<< $term->ROW_t >> for details.
1597 1867
1598=item $success = $term->grab_button ($button, $modifiermask) 1868=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1599 1869
1870=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1871
1600Registers a synchronous button grab. See the XGrabButton manpage. 1872Register/unregister a synchronous button grab. See the XGrabButton
1873manpage.
1601 1874
1602=item $success = $term->grab ($eventtime[, $sync]) 1875=item $success = $term->grab ($eventtime[, $sync])
1603 1876
1604Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1877Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1605synchronous (C<$sync> is true). Also remembers the grab timestampe. 1878synchronous (C<$sync> is true). Also remembers the grab timestamp.
1606 1879
1607=item $term->allow_events_async 1880=item $term->allow_events_async
1608 1881
1609Calls XAllowEvents with AsyncBoth for the most recent grab. 1882Calls XAllowEvents with AsyncBoth for the most recent grab.
1610 1883
1617Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1890Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1618recent grab. 1891recent grab.
1619 1892
1620=item $term->ungrab 1893=item $term->ungrab
1621 1894
1622Calls XUngrab for the most recent grab. Is called automatically on 1895Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1623evaluation errors, as it is better to lose the grab in the error case as 1896evaluation errors, as it is better to lose the grab in the error case as
1624the session. 1897the session.
1625 1898
1626=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1899=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1627 1900
1629 1902
1630=item @atoms = $term->XListProperties ($window) 1903=item @atoms = $term->XListProperties ($window)
1631 1904
1632=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1905=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1633 1906
1634=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1907=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1635 1908
1636=item $term->XDeleteProperty ($window, $property) 1909=item $term->XDeleteProperty ($window, $property)
1637 1910
1638=item $window = $term->DefaultRootWindow 1911=item $window = $term->DefaultRootWindow
1639 1912
1649 1922
1650=item $term->XChangeInput ($window, $add_events[, $del_events]) 1923=item $term->XChangeInput ($window, $add_events[, $del_events])
1651 1924
1652Various X or X-related functions. The C<$term> object only serves as 1925Various X or X-related functions. The C<$term> object only serves as
1653the source of the display, otherwise those functions map more-or-less 1926the source of the display, otherwise those functions map more-or-less
1654directory onto the X functions of the same name. 1927directly onto the X functions of the same name.
1655 1928
1656=back 1929=back
1657 1930
1658=cut 1931=cut
1659 1932
1723 my ($self, $text, $cb) = @_; 1996 my ($self, $text, $cb) = @_;
1724 1997
1725 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1998 $self->add_item ({ type => "button", text => $text, activate => $cb});
1726} 1999}
1727 2000
1728=item $popup->add_toggle ($text, $cb, $initial_value) 2001=item $popup->add_toggle ($text, $initial_value, $cb)
1729 2002
1730Adds a toggle/checkbox item to the popup. Teh callback gets called 2003Adds a toggle/checkbox item to the popup. The callback gets called
1731whenever it gets toggled, with a boolean indicating its value as its first 2004whenever it gets toggled, with a boolean indicating its new value as its
1732argument. 2005first argument.
1733 2006
1734=cut 2007=cut
1735 2008
1736sub add_toggle { 2009sub add_toggle {
1737 my ($self, $text, $cb, $value) = @_; 2010 my ($self, $text, $value, $cb) = @_;
1738 2011
1739 my $item; $item = { 2012 my $item; $item = {
1740 type => "button", 2013 type => "button",
1741 text => " $text", 2014 text => " $text",
1742 value => $value, 2015 value => $value,
1761 my $env = $self->{term}->env; 2034 my $env = $self->{term}->env;
1762 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2035 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1763 delete $env->{LC_ALL}; 2036 delete $env->{LC_ALL};
1764 $env->{LC_CTYPE} = $self->{term}->locale; 2037 $env->{LC_CTYPE} = $self->{term}->locale;
1765 2038
1766 urxvt::term->new ($env, "popup", 2039 my $term = urxvt::term->new (
2040 $env, "popup",
1767 "--perl-lib" => "", "--perl-ext-common" => "", 2041 "--perl-lib" => "", "--perl-ext-common" => "",
1768 "-pty-fd" => -1, "-sl" => 0, 2042 "-pty-fd" => -1, "-sl" => 0,
1769 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2043 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1770 "--transient-for" => $self->{term}->parent, 2044 "--transient-for" => $self->{term}->parent,
1771 "-display" => $self->{term}->display_id, 2045 "-display" => $self->{term}->display_id,
1772 "-pe" => "urxvt-popup") 2046 "-pe" => "urxvt-popup",
1773 or die "unable to create popup window\n"; 2047 ) or die "unable to create popup window\n";
2048
2049 unless (delete $term->{urxvt_popup_init_done}) {
2050 $term->ungrab;
2051 $term->destroy;
2052 die "unable to initialise popup window\n";
2053 }
1774} 2054}
1775 2055
1776sub DESTROY { 2056sub DESTROY {
1777 my ($self) = @_; 2057 my ($self) = @_;
1778 2058
1783=back 2063=back
1784 2064
1785=cut 2065=cut
1786 2066
1787package urxvt::watcher; 2067package urxvt::watcher;
1788
1789@urxvt::timer::ISA = __PACKAGE__;
1790@urxvt::iow::ISA = __PACKAGE__;
1791@urxvt::pw::ISA = __PACKAGE__;
1792@urxvt::iw::ISA = __PACKAGE__;
1793 2068
1794=head2 The C<urxvt::timer> Class 2069=head2 The C<urxvt::timer> Class
1795 2070
1796This class implements timer watchers/events. Time is represented as a 2071This class implements timer watchers/events. Time is represented as a
1797fractional number of seconds since the epoch. Example: 2072fractional number of seconds since the epoch. Example:
1801 ->new 2076 ->new
1802 ->interval (1) 2077 ->interval (1)
1803 ->cb (sub { 2078 ->cb (sub {
1804 $term->{overlay}->set (0, 0, 2079 $term->{overlay}->set (0, 0,
1805 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2080 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1806 }); 2081 });
1807 2082
1808=over 4 2083=over 4
1809 2084
1810=item $timer = new urxvt::timer 2085=item $timer = new urxvt::timer
1811 2086
1814 2089
1815=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2090=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1816 2091
1817Set the callback to be called when the timer triggers. 2092Set the callback to be called when the timer triggers.
1818 2093
1819=item $tstamp = $timer->at
1820
1821Return the time this watcher will fire next.
1822
1823=item $timer = $timer->set ($tstamp) 2094=item $timer = $timer->set ($tstamp[, $interval])
1824 2095
1825Set the time the event is generated to $tstamp. 2096Set the time the event is generated to $tstamp (and optionally specifies a
2097new $interval).
1826 2098
1827=item $timer = $timer->interval ($interval) 2099=item $timer = $timer->interval ($interval)
1828 2100
1829Normally (and when C<$interval> is C<0>), the timer will automatically 2101By default (and when C<$interval> is C<0>), the timer will automatically
1830stop after it has fired once. If C<$interval> is non-zero, then the timer 2102stop after it has fired once. If C<$interval> is non-zero, then the timer
1831is automatically rescheduled at the given intervals. 2103is automatically rescheduled at the given intervals.
1832 2104
1833=item $timer = $timer->start 2105=item $timer = $timer->start
1834 2106
1835Start the timer. 2107Start the timer.
1836 2108
1837=item $timer = $timer->start ($tstamp) 2109=item $timer = $timer->start ($tstamp[, $interval])
1838 2110
1839Set the event trigger time to C<$tstamp> and start the timer. 2111Set the event trigger time to C<$tstamp> and start the timer. Optionally
2112also replaces the interval.
1840 2113
1841=item $timer = $timer->after ($delay) 2114=item $timer = $timer->after ($delay[, $interval])
1842 2115
1843Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2116Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1844 2117
1845=item $timer = $timer->stop 2118=item $timer = $timer->stop
1846 2119
1854 2127
1855 $term->{socket} = ... 2128 $term->{socket} = ...
1856 $term->{iow} = urxvt::iow 2129 $term->{iow} = urxvt::iow
1857 ->new 2130 ->new
1858 ->fd (fileno $term->{socket}) 2131 ->fd (fileno $term->{socket})
1859 ->events (urxvt::EVENT_READ) 2132 ->events (urxvt::EV_READ)
1860 ->start 2133 ->start
1861 ->cb (sub { 2134 ->cb (sub {
1862 my ($iow, $revents) = @_; 2135 my ($iow, $revents) = @_;
1863 # $revents must be 1 here, no need to check 2136 # $revents must be 1 here, no need to check
1864 sysread $term->{socket}, my $buf, 8192 2137 sysread $term->{socket}, my $buf, 8192
1877Set the callback to be called when io events are triggered. C<$reventmask> 2150Set the callback to be called when io events are triggered. C<$reventmask>
1878is a bitset as described in the C<events> method. 2151is a bitset as described in the C<events> method.
1879 2152
1880=item $iow = $iow->fd ($fd) 2153=item $iow = $iow->fd ($fd)
1881 2154
1882Set the filedescriptor (not handle) to watch. 2155Set the file descriptor (not handle) to watch.
1883 2156
1884=item $iow = $iow->events ($eventmask) 2157=item $iow = $iow->events ($eventmask)
1885 2158
1886Set the event mask to watch. The only allowed values are 2159Set the event mask to watch. The only allowed values are
1887C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2160C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1888together, or C<urxvt::EVENT_NONE>. 2161together, or C<urxvt::EV_NONE>.
1889 2162
1890=item $iow = $iow->start 2163=item $iow = $iow->start
1891 2164
1892Start watching for requested events on the given handle. 2165Start watching for requested events on the given handle.
1893 2166
1894=item $iow = $iow->stop 2167=item $iow = $iow->stop
1895 2168
1896Stop watching for events on the given filehandle. 2169Stop watching for events on the given file handle.
1897 2170
1898=back 2171=back
1899 2172
1900=head2 The C<urxvt::iw> Class 2173=head2 The C<urxvt::iw> Class
1901 2174
1934 ->new 2207 ->new
1935 ->start ($pid) 2208 ->start ($pid)
1936 ->cb (sub { 2209 ->cb (sub {
1937 my ($pw, $exit_status) = @_; 2210 my ($pw, $exit_status) = @_;
1938 ... 2211 ...
1939 }); 2212 });
1940 2213
1941=over 4 2214=over 4
1942 2215
1943=item $pw = new urxvt::pw 2216=item $pw = new urxvt::pw
1944 2217
1948 2221
1949Set the callback to be called when the timer triggers. 2222Set the callback to be called when the timer triggers.
1950 2223
1951=item $pw = $timer->start ($pid) 2224=item $pw = $timer->start ($pid)
1952 2225
1953Tells the wqtcher to start watching for process C<$pid>. 2226Tells the watcher to start watching for process C<$pid>.
1954 2227
1955=item $pw = $pw->stop 2228=item $pw = $pw->stop
1956 2229
1957Stop the watcher. 2230Stop the watcher.
1958 2231
1971 2244
1972=item >= 3 - script loading and management 2245=item >= 3 - script loading and management
1973 2246
1974=item >=10 - all called hooks 2247=item >=10 - all called hooks
1975 2248
1976=item >=11 - hook reutrn values 2249=item >=11 - hook return values
1977 2250
1978=back 2251=back
1979 2252
1980=head1 AUTHOR 2253=head1 AUTHOR
1981 2254
1983 http://software.schmorp.de/pkg/rxvt-unicode 2256 http://software.schmorp.de/pkg/rxvt-unicode
1984 2257
1985=cut 2258=cut
1986 2259
19871 22601
2261
2262# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines