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.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.
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
643 812
644Using 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
645correct place, e.g. on stderr of the connecting urxvtc client. 814correct place, e.g. on stderr of the connecting urxvtc client.
646 815
647Messages 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).
648 824
649=item $time = urxvt::NOW 825=item $time = urxvt::NOW
650 826
651Returns the "current time" (as per the event loop). 827Returns the "current time" (as per the event loop).
652 828
695 871
696=item $rend = urxvt::OVERLAY_RSTYLE 872=item $rend = urxvt::OVERLAY_RSTYLE
697 873
698Return the rendition mask used for overlays by default. 874Return the rendition mask used for overlays by default.
699 875
700=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
701 878
702Return the bit that enabled bold, italic, blink, reverse-video and 879Return the bit that enabled bold, italic, blink, reverse-video and
703underline, respectively. To enable such a style, just logically OR it into 880underline, respectively. To enable such a style, just logically OR it into
704the bitset. 881the bitset.
705 882
710Return the foreground/background colour index, respectively. 887Return the foreground/background colour index, respectively.
711 888
712=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 889=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
713 890
714=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
715 894
716Replace the foreground/background colour in the rendition mask with the 895Replace the foreground/background colour in the rendition mask with the
717specified one. 896specified one.
718 897
719=item $value = urxvt::GET_CUSTOM $rend 898=item $value = urxvt::GET_CUSTOM $rend
786 local $TERM = shift; 965 local $TERM = shift;
787 my $htype = shift; 966 my $htype = shift;
788 967
789 if ($htype == 0) { # INIT 968 if ($htype == 0) { # INIT
790 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 969 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
791 970
792 my %ext_arg; 971 my %ext_arg;
793 972
794 { 973 {
795 my @init = @TERM_INIT; 974 my @init = @TERM_INIT;
796 @TERM_INIT = (); 975 @TERM_INIT = ();
810 } else { 989 } else {
811 $ext_arg{$_} ||= []; 990 $ext_arg{$_} ||= [];
812 } 991 }
813 } 992 }
814 993
815 while (my ($ext, $argv) = each %ext_arg) { 994 for my $ext (sort keys %ext_arg) {
816 my @files = grep -f $_, map "$_/$ext", @dirs; 995 my @files = grep -f $_, map "$_/$ext", @dirs;
817 996
818 if (@files) { 997 if (@files) {
819 $TERM->register_package (extension_package $files[0], $argv); 998 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
820 } else { 999 } else {
821 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";
822 } 1001 }
823 } 1002 }
824 1003
830 1009
831 if (my $cb = $TERM->{_hook}[$htype]) { 1010 if (my $cb = $TERM->{_hook}[$htype]) {
832 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1011 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
833 if $verbosity >= 10; 1012 if $verbosity >= 10;
834 1013
835 keys %$cb; 1014 for my $pkg (keys %$cb) {
836
837 while (my ($pkg, $cb) = each %$cb) {
838 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1015 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
839 $retval ||= $retval_; 1016 $retval ||= $retval_;
840 1017
841 if ($@) { 1018 if ($@) {
842 $TERM->ungrab; # better to lose the grab than the session 1019 $TERM->ungrab; # better to lose the grab than the session
843 warn $@; 1020 warn $@;
855 # clear package 1032 # clear package
856 %$TERM = (); 1033 %$TERM = ();
857 } 1034 }
858 1035
859 $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)
860} 1066}
861 1067
862# urxvt::term::extension 1068# urxvt::term::extension
863 1069
864package urxvt::term::extension; 1070package urxvt::term::extension;
935is 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
936work. 1142work.
937 1143
938=cut 1144=cut
939 1145
940our $VERSION = 1; 1146our $VERSION = '5.23';
941 1147
942$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1148$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
943push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1149push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
944 1150
945sub timer { 1151sub timer {
947 1153
948 my $cb = $arg{cb}; 1154 my $cb = $arg{cb};
949 1155
950 urxvt::timer 1156 urxvt::timer
951 ->new 1157 ->new
952 ->start (urxvt::NOW + $arg{after}) 1158 ->after ($arg{after}, $arg{interval})
953 ->cb (sub { 1159 ->cb ($arg{interval} ? $cb : sub {
954 $_[0]->stop; # need to cancel manually 1160 $_[0]->stop; # need to cancel manually
955 $cb->(); 1161 $cb->();
956 }) 1162 })
957} 1163}
958 1164
959sub io { 1165sub io {
960 my ($class, %arg) = @_; 1166 my ($class, %arg) = @_;
961 1167
962 my $cb = $arg{cb}; 1168 my $cb = $arg{cb};
1169 my $fd = fileno $arg{fh};
1170 defined $fd or $fd = $arg{fh};
963 1171
964 bless [$arg{fh}, urxvt::iow 1172 bless [$arg{fh}, urxvt::iow
965 ->new 1173 ->new
966 ->fd (fileno $arg{fh}) 1174 ->fd ($fd)
967 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1175 ->events (($arg{poll} =~ /r/ ? 1 : 0)
968 | ($arg{poll} =~ /w/ ? 2 : 0)) 1176 | ($arg{poll} =~ /w/ ? 2 : 0))
969 ->start 1177 ->start
970 ->cb (sub { 1178 ->cb ($cb)
971 $cb->(($_[1] & 1 ? 'r' : '')
972 . ($_[1] & 2 ? 'w' : ''));
973 })],
974 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 })
975} 1205}
976 1206
977sub DESTROY { 1207sub DESTROY {
978 $_[0][1]->stop; 1208 $_[0][1]->stop;
979} 1209}
980 1210
981sub condvar { 1211sub 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"; 1212 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
992 }
993} 1213}
994 1214
995package urxvt::term; 1215package urxvt::term;
996 1216
997=head2 The C<urxvt::term> Class 1217=head2 The C<urxvt::term> Class
1033hash which defines the environment of the new terminal. 1253hash which defines the environment of the new terminal.
1034 1254
1035Croaks (and probably outputs an error message) if the new instance 1255Croaks (and probably outputs an error message) if the new instance
1036couldn'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
1037initialise perl, and the terminal object otherwise. The C<init> and 1257initialise perl, and the terminal object otherwise. The C<init> and
1038C<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).
1039 1260
1040=cut 1261=cut
1041 1262
1042sub new { 1263sub new {
1043 my ($class, $env, @args) = @_; 1264 my ($class, $env, @args) = @_;
1044 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
1045 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1269 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1046} 1270}
1047 1271
1048=item $term->destroy 1272=item $term->destroy
1049 1273
1050Destroy the terminal object (close the window, free resources 1274Destroy the terminal object (close the window, free resources
1080 1304
1081Returns true if the option specified by C<$optval> is enabled, and 1305Returns true if the option specified by C<$optval> is enabled, and
1082optionally 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
1083C<%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.
1084 1308
1085Here 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
1086source file F</src/optinc.h> to see the actual list: 1310source file F</src/optinc.h> to see the actual list:
1087 1311
1088 borderLess console cursorBlink cursorUnderline hold iconic insecure 1312 borderLess console cursorBlink cursorUnderline hold iconic insecure
1089 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1313 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1090 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1314 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1107likely change). 1331likely change).
1108 1332
1109Please note that resource strings will currently only be freed when the 1333Please note that resource strings will currently only be freed when the
1110terminal is destroyed, so changing options frequently will eat memory. 1334terminal is destroyed, so changing options frequently will eat memory.
1111 1335
1112Here 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
1113are 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>
1114to see the actual list: 1338to see the actual list:
1115 1339
1116 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1340 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1117 borderLess color cursorBlink cursorUnderline cutchars delete_key 1341 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1118 display_name embed ext_bwidth fade font geometry hold iconName 1342 display_name embed ext_bwidth fade font geometry hold iconName
1119 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1343 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1120 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1344 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1121 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1345 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1122 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1346 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1123 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1347 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1124 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1348 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1125 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1349 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1126 secondaryScreen secondaryScroll selectstyle shade term_name title 1350 secondaryScreen secondaryScroll shade term_name title
1127 transient_for transparent transparent_all tripleclickwords utmpInhibit 1351 transient_for transparent transparent_all tripleclickwords utmpInhibit
1128 visualBell 1352 visualBell
1129 1353
1130=cut 1354=cut
1131 1355
1132sub resource($$;$) { 1356sub resource($$;$) {
1133 my ($self, $name) = (shift, shift); 1357 my ($self, $name) = (shift, shift);
1134 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1358 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1135 &urxvt::term::_resource 1359 goto &urxvt::term::_resource
1136} 1360}
1137 1361
1138=item $value = $term->x_resource ($pattern) 1362=item $value = $term->x_resource ($pattern)
1139 1363
1140Returns the X-Resource for the given pattern, excluding the program or 1364Returns the X-Resource for the given pattern, excluding the program or
1165 1389
1166=item ($row, $col) = $term->selection_beg ([$row, $col]) 1390=item ($row, $col) = $term->selection_beg ([$row, $col])
1167 1391
1168=item ($row, $col) = $term->selection_end ([$row, $col]) 1392=item ($row, $col) = $term->selection_end ([$row, $col])
1169 1393
1170Return the current values of the selection mark, begin or end positions, 1394Return the current values of the selection mark, begin or end positions.
1171and 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.
1172 1403
1173=item $term->selection_make ($eventtime[, $rectangular]) 1404=item $term->selection_make ($eventtime[, $rectangular])
1174 1405
1175Tries to make a selection as set by C<selection_beg> and 1406Tries to make a selection as set by C<selection_beg> and
1176C<selection_end>. If C<$rectangular> is true (default: false), a 1407C<selection_end>. If C<$rectangular> is true (default: false), a
1177rectangular selection will be made. This is the prefered function to make 1408rectangular selection will be made. This is the preferred function to make
1178a selection. 1409a selection.
1179 1410
1180=item $success = $term->selection_grab ($eventtime) 1411=item $success = $term->selection_grab ($eventtime[, $clipboard])
1181 1412
1182Try 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
1183set by the next method). No visual feedback will be given. This function 1415with the next method. No visual feedback will be given. This function
1184is mostly useful from within C<on_sel_grab> hooks. 1416is mostly useful from within C<on_sel_grab> hooks.
1185 1417
1186=item $oldtext = $term->selection ([$newtext]) 1418=item $oldtext = $term->selection ([$newtext, $clipboard])
1187 1419
1188Return 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.
1189 1426
1190=item $term->overlay_simple ($x, $y, $text) 1427=item $term->overlay_simple ($x, $y, $text)
1191 1428
1192Create 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.
1193 1430
1223 1460
1224The methods currently supported on C<urxvt::overlay> objects are: 1461The methods currently supported on C<urxvt::overlay> objects are:
1225 1462
1226=over 4 1463=over 4
1227 1464
1228=item $overlay->set ($x, $y, $text, $rend) 1465=item $overlay->set ($x, $y, $text[, $rend])
1229 1466
1230Similar 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
1231text 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
1232at 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.
1233 1472
1234=item $overlay->hide 1473=item $overlay->hide
1235 1474
1236If visible, hide the overlay, but do not destroy it. 1475If visible, hide the overlay, but do not destroy it.
1237 1476
1319locale-specific encoding of the terminal and can contain command sequences 1558locale-specific encoding of the terminal and can contain command sequences
1320(escape codes) that will be interpreted. 1559(escape codes) that will be interpreted.
1321 1560
1322=item $term->tt_write ($octets) 1561=item $term->tt_write ($octets)
1323 1562
1324Write 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
1325pass characters instead of octets, you should convert your strings first 1564pass characters instead of octets, you should convert your strings first
1326to 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.
1327 1572
1328=item $old_events = $term->pty_ev_events ([$new_events]) 1573=item $old_events = $term->pty_ev_events ([$new_events])
1329 1574
1330Replaces 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
1331be 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
1350Adds 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
1351to receive pointer events all the times: 1596to receive pointer events all the times:
1352 1597
1353 $term->vt_emask_add (urxvt::PointerMotionMask); 1598 $term->vt_emask_add (urxvt::PointerMotionMask);
1354 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
1355=item $window_width = $term->width 1610=item $window_width = $term->width
1356 1611
1357=item $window_height = $term->height 1612=item $window_height = $term->height
1358 1613
1359=item $font_width = $term->fwidth 1614=item $font_width = $term->fwidth
1389=item $env = $term->env 1644=item $env = $term->env
1390 1645
1391Returns 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
1392similar to C<\%ENV>. 1647similar to C<\%ENV>.
1393 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
1394=cut 1658=cut
1395 1659
1396sub env { 1660sub env {
1397 if (my $env = $_[0]->_env) {
1398 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1661 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1399 } else {
1400 +{ %ENV }
1401 }
1402} 1662}
1403 1663
1404=item $modifiermask = $term->ModLevel3Mask 1664=item $modifiermask = $term->ModLevel3Mask
1405 1665
1406=item $modifiermask = $term->ModMetaMask 1666=item $modifiermask = $term->ModMetaMask
1414 1674
1415Returns the currently displayed screen (0 primary, 1 secondary). 1675Returns the currently displayed screen (0 primary, 1 secondary).
1416 1676
1417=item $cursor_is_hidden = $term->hidden_cursor 1677=item $cursor_is_hidden = $term->hidden_cursor
1418 1678
1419Returns wether the cursor is currently hidden or not. 1679Returns whether the cursor is currently hidden or not.
1420 1680
1421=item $view_start = $term->view_start ([$newvalue]) 1681=item $view_start = $term->view_start ([$newvalue])
1422 1682
1423Returns the row number of the topmost displayed line. Maximum value is 1683Returns the row number of the topmost displayed line. Maximum value is
1424C<0>, which displays the normal terminal contents. Lower values scroll 1684C<0>, which displays the normal terminal contents. Lower values scroll
1432 1692
1433Used after changing terminal contents to display them. 1693Used after changing terminal contents to display them.
1434 1694
1435=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1695=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1436 1696
1437Returns 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 >>
1438is 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
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 1699terminal line. Nothing will be returned if a nonexistent line
1441is requested. 1700is requested.
1442 1701
1443If 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
1444line, 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
1445to 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
1446automatically be updated. 1705automatically be updated.
1447 1706
1448C<$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
1449than 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)
1450characters. Characters with combining characters and other characters that 1709characters. Characters with combining characters and other characters that
1451do 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
1452in the private use area. 1711in the private use area.
1453 1712
1454You have to obey this encoding when changing text. The advantage is 1713You have to obey this encoding when changing text. The advantage is
1455that 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
1456characters. 1715characters.
1601where one character corresponds to one screen cell. See 1860where one character corresponds to one screen cell. See
1602C<< $term->ROW_t >> for details. 1861C<< $term->ROW_t >> for details.
1603 1862
1604=item $string = $term->special_decode $text 1863=item $string = $term->special_decode $text
1605 1864
1606Converts rxvt-unicodes text reprsentation into a perl string. See 1865Converts rxvt-unicodes text representation into a perl string. See
1607C<< $term->ROW_t >> for details. 1866C<< $term->ROW_t >> for details.
1608 1867
1609=item $success = $term->grab_button ($button, $modifiermask) 1868=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1610 1869
1870=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1871
1611Registers a synchronous button grab. See the XGrabButton manpage. 1872Register/unregister a synchronous button grab. See the XGrabButton
1873manpage.
1612 1874
1613=item $success = $term->grab ($eventtime[, $sync]) 1875=item $success = $term->grab ($eventtime[, $sync])
1614 1876
1615Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1877Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1616synchronous (C<$sync> is true). Also remembers the grab timestampe. 1878synchronous (C<$sync> is true). Also remembers the grab timestamp.
1617 1879
1618=item $term->allow_events_async 1880=item $term->allow_events_async
1619 1881
1620Calls XAllowEvents with AsyncBoth for the most recent grab. 1882Calls XAllowEvents with AsyncBoth for the most recent grab.
1621 1883
1628Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1890Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1629recent grab. 1891recent grab.
1630 1892
1631=item $term->ungrab 1893=item $term->ungrab
1632 1894
1633Calls XUngrab for the most recent grab. Is called automatically on 1895Calls 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 1896evaluation errors, as it is better to lose the grab in the error case as
1635the session. 1897the session.
1636 1898
1637=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1899=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1638 1900
1640 1902
1641=item @atoms = $term->XListProperties ($window) 1903=item @atoms = $term->XListProperties ($window)
1642 1904
1643=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1905=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1644 1906
1645=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1907=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1646 1908
1647=item $term->XDeleteProperty ($window, $property) 1909=item $term->XDeleteProperty ($window, $property)
1648 1910
1649=item $window = $term->DefaultRootWindow 1911=item $window = $term->DefaultRootWindow
1650 1912
1660 1922
1661=item $term->XChangeInput ($window, $add_events[, $del_events]) 1923=item $term->XChangeInput ($window, $add_events[, $del_events])
1662 1924
1663Various 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
1664the source of the display, otherwise those functions map more-or-less 1926the source of the display, otherwise those functions map more-or-less
1665directory onto the X functions of the same name. 1927directly onto the X functions of the same name.
1666 1928
1667=back 1929=back
1668 1930
1669=cut 1931=cut
1670 1932
1734 my ($self, $text, $cb) = @_; 1996 my ($self, $text, $cb) = @_;
1735 1997
1736 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1998 $self->add_item ({ type => "button", text => $text, activate => $cb});
1737} 1999}
1738 2000
1739=item $popup->add_toggle ($text, $cb, $initial_value) 2001=item $popup->add_toggle ($text, $initial_value, $cb)
1740 2002
1741Adds a toggle/checkbox item to the popup. Teh callback gets called 2003Adds a toggle/checkbox item to the popup. The callback gets called
1742whenever 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
1743argument. 2005first argument.
1744 2006
1745=cut 2007=cut
1746 2008
1747sub add_toggle { 2009sub add_toggle {
1748 my ($self, $text, $cb, $value) = @_; 2010 my ($self, $text, $value, $cb) = @_;
1749 2011
1750 my $item; $item = { 2012 my $item; $item = {
1751 type => "button", 2013 type => "button",
1752 text => " $text", 2014 text => " $text",
1753 value => $value, 2015 value => $value,
1772 my $env = $self->{term}->env; 2034 my $env = $self->{term}->env;
1773 # 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.
1774 delete $env->{LC_ALL}; 2036 delete $env->{LC_ALL};
1775 $env->{LC_CTYPE} = $self->{term}->locale; 2037 $env->{LC_CTYPE} = $self->{term}->locale;
1776 2038
1777 urxvt::term->new ($env, "popup", 2039 my $term = urxvt::term->new (
2040 $env, "popup",
1778 "--perl-lib" => "", "--perl-ext-common" => "", 2041 "--perl-lib" => "", "--perl-ext-common" => "",
1779 "-pty-fd" => -1, "-sl" => 0, 2042 "-pty-fd" => -1, "-sl" => 0,
1780 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2043 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1781 "--transient-for" => $self->{term}->parent, 2044 "--transient-for" => $self->{term}->parent,
1782 "-display" => $self->{term}->display_id, 2045 "-display" => $self->{term}->display_id,
1783 "-pe" => "urxvt-popup") 2046 "-pe" => "urxvt-popup",
1784 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 }
1785} 2054}
1786 2055
1787sub DESTROY { 2056sub DESTROY {
1788 my ($self) = @_; 2057 my ($self) = @_;
1789 2058
1794=back 2063=back
1795 2064
1796=cut 2065=cut
1797 2066
1798package urxvt::watcher; 2067package urxvt::watcher;
1799
1800@urxvt::timer::ISA = __PACKAGE__;
1801@urxvt::iow::ISA = __PACKAGE__;
1802@urxvt::pw::ISA = __PACKAGE__;
1803@urxvt::iw::ISA = __PACKAGE__;
1804 2068
1805=head2 The C<urxvt::timer> Class 2069=head2 The C<urxvt::timer> Class
1806 2070
1807This class implements timer watchers/events. Time is represented as a 2071This class implements timer watchers/events. Time is represented as a
1808fractional number of seconds since the epoch. Example: 2072fractional number of seconds since the epoch. Example:
1812 ->new 2076 ->new
1813 ->interval (1) 2077 ->interval (1)
1814 ->cb (sub { 2078 ->cb (sub {
1815 $term->{overlay}->set (0, 0, 2079 $term->{overlay}->set (0, 0,
1816 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2080 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1817 }); 2081 });
1818 2082
1819=over 4 2083=over 4
1820 2084
1821=item $timer = new urxvt::timer 2085=item $timer = new urxvt::timer
1822 2086
1825 2089
1826=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2090=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1827 2091
1828Set the callback to be called when the timer triggers. 2092Set the callback to be called when the timer triggers.
1829 2093
1830=item $tstamp = $timer->at
1831
1832Return the time this watcher will fire next.
1833
1834=item $timer = $timer->set ($tstamp) 2094=item $timer = $timer->set ($tstamp[, $interval])
1835 2095
1836Set the time the event is generated to $tstamp. 2096Set the time the event is generated to $tstamp (and optionally specifies a
2097new $interval).
1837 2098
1838=item $timer = $timer->interval ($interval) 2099=item $timer = $timer->interval ($interval)
1839 2100
1840Normally (and when C<$interval> is C<0>), the timer will automatically 2101By 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 2102stop after it has fired once. If C<$interval> is non-zero, then the timer
1842is automatically rescheduled at the given intervals. 2103is automatically rescheduled at the given intervals.
1843 2104
1844=item $timer = $timer->start 2105=item $timer = $timer->start
1845 2106
1846Start the timer. 2107Start the timer.
1847 2108
1848=item $timer = $timer->start ($tstamp) 2109=item $timer = $timer->start ($tstamp[, $interval])
1849 2110
1850Set 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.
1851 2113
1852=item $timer = $timer->after ($delay) 2114=item $timer = $timer->after ($delay[, $interval])
1853 2115
1854Like 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>.
1855 2117
1856=item $timer = $timer->stop 2118=item $timer = $timer->stop
1857 2119
1865 2127
1866 $term->{socket} = ... 2128 $term->{socket} = ...
1867 $term->{iow} = urxvt::iow 2129 $term->{iow} = urxvt::iow
1868 ->new 2130 ->new
1869 ->fd (fileno $term->{socket}) 2131 ->fd (fileno $term->{socket})
1870 ->events (urxvt::EVENT_READ) 2132 ->events (urxvt::EV_READ)
1871 ->start 2133 ->start
1872 ->cb (sub { 2134 ->cb (sub {
1873 my ($iow, $revents) = @_; 2135 my ($iow, $revents) = @_;
1874 # $revents must be 1 here, no need to check 2136 # $revents must be 1 here, no need to check
1875 sysread $term->{socket}, my $buf, 8192 2137 sysread $term->{socket}, my $buf, 8192
1888Set 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>
1889is a bitset as described in the C<events> method. 2151is a bitset as described in the C<events> method.
1890 2152
1891=item $iow = $iow->fd ($fd) 2153=item $iow = $iow->fd ($fd)
1892 2154
1893Set the filedescriptor (not handle) to watch. 2155Set the file descriptor (not handle) to watch.
1894 2156
1895=item $iow = $iow->events ($eventmask) 2157=item $iow = $iow->events ($eventmask)
1896 2158
1897Set the event mask to watch. The only allowed values are 2159Set the event mask to watch. The only allowed values are
1898C<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
1899together, or C<urxvt::EVENT_NONE>. 2161together, or C<urxvt::EV_NONE>.
1900 2162
1901=item $iow = $iow->start 2163=item $iow = $iow->start
1902 2164
1903Start watching for requested events on the given handle. 2165Start watching for requested events on the given handle.
1904 2166
1905=item $iow = $iow->stop 2167=item $iow = $iow->stop
1906 2168
1907Stop watching for events on the given filehandle. 2169Stop watching for events on the given file handle.
1908 2170
1909=back 2171=back
1910 2172
1911=head2 The C<urxvt::iw> Class 2173=head2 The C<urxvt::iw> Class
1912 2174
1945 ->new 2207 ->new
1946 ->start ($pid) 2208 ->start ($pid)
1947 ->cb (sub { 2209 ->cb (sub {
1948 my ($pw, $exit_status) = @_; 2210 my ($pw, $exit_status) = @_;
1949 ... 2211 ...
1950 }); 2212 });
1951 2213
1952=over 4 2214=over 4
1953 2215
1954=item $pw = new urxvt::pw 2216=item $pw = new urxvt::pw
1955 2217
1959 2221
1960Set the callback to be called when the timer triggers. 2222Set the callback to be called when the timer triggers.
1961 2223
1962=item $pw = $timer->start ($pid) 2224=item $pw = $timer->start ($pid)
1963 2225
1964Tells the wqtcher to start watching for process C<$pid>. 2226Tells the watcher to start watching for process C<$pid>.
1965 2227
1966=item $pw = $pw->stop 2228=item $pw = $pw->stop
1967 2229
1968Stop the watcher. 2230Stop the watcher.
1969 2231
1982 2244
1983=item >= 3 - script loading and management 2245=item >= 3 - script loading and management
1984 2246
1985=item >=10 - all called hooks 2247=item >=10 - all called hooks
1986 2248
1987=item >=11 - hook reutrn values 2249=item >=11 - hook return values
1988 2250
1989=back 2251=back
1990 2252
1991=head1 AUTHOR 2253=head1 AUTHOR
1992 2254
1994 http://software.schmorp.de/pkg/rxvt-unicode 2256 http://software.schmorp.de/pkg/rxvt-unicode
1995 2257
1996=cut 2258=cut
1997 2259
19981 22601
2261
2262# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines