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.124 by root, Sun Jan 22 11:57:06 2006 UTC vs.
Revision 1.188 by sf-exg, Sat Jul 24 13:04:27 2010 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
62 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
63 ... 66 ...
64 67
65The index number (0, 1...) must not have any holes, and each regex must 68The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for 69contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
68between two vertical bars: 71between two vertical bars:
69 72
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
71 81
72You can look at the source of the selection extension to see more 82You can look at the source of the selection extension to see more
73interesting uses, such as parsing a line from beginning to end. 83interesting uses, such as parsing a line from beginning to end.
74 84
75This extension also offers following bindable keyboard commands: 85This extension also offers following bindable keyboard commands:
86 96
87=item option-popup (enabled by default) 97=item option-popup (enabled by default)
88 98
89Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
90runtime. 100runtime.
101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<< $self->{myoption} >>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
91 118
92=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
93 120
94Binds a popup menu to Ctrl-Button3 that lets you convert the selection 121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
95text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
96evaluation, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
97 124
98Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
99onto C<@{ $term->{selection_popup_hook} }>, that is called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
100popup is displayed. 127popup is being displayed.
101 128
102It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
103is in C<$_>, which can be used to decide wether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
104It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
105string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
106when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
107 134
108The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
109the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
110C<a>s: 137C<a>s:
111 138
112 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
113 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
114 : () 141 : ()
115 }; 142 };
116 143
117=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
118 145
125search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
126search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
127bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
128was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
129additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
130selection. 157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
131 164
132=item readline (enabled by default) 165=item readline (enabled by default)
133 166
134A support package that tries to make editing with readline easier. At the 167A support package that tries to make editing with readline easier. At
135moment, 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
136move 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
137cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
138for programs that correctly support wide characters). 171for programs that correctly support wide characters).
139 172
140To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
141 174
142=over 4 175=over 4
143 176
177=item - the tty is in ICANON state.
178
179=item - the text cursor is visible.
180
181=item - the primary screen is currently being displayed.
182
144=item - the mouse is on the same (multi-row-) line as the text cursor. 183=item - the mouse is on the same (multi-row-) line as the text cursor.
145
146=item - the primary screen is currently being displayed.
147
148=item - the text cursor is visible.
149 184
150=back 185=back
151 186
152The normal selection mechanism isn't disabled, so quick successive clicks 187The normal selection mechanism isn't disabled, so quick successive clicks
153might interfere with selection creation in harmless ways. 188might interfere with selection creation in harmless ways.
188the message into vi commands to load the file. 223the message into vi commands to load the file.
189 224
190=item tabbed 225=item tabbed
191 226
192This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
193is, 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
194displays 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
195button per tab. 230button per tab.
196 231
197Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
198B<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,
199while B<Shift-Down> creates a new tab. 234while B<Shift-Down> creates a new tab.
200 235
201=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):
202 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
203Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
204make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
205resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
206the 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.
207 258
208=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.
209 263
210This 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.
211to 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.
212a custom pixmap. No scaling is supported in this mode. Exmaple:
213 266
214 @@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.
215 313
216=item block-graphics-to-ascii 314=item block-graphics-to-ascii
217 315
218A 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
219by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
220similar-looking ascii character. 318similar-looking ascii character.
221 319
222=item digital-clock 320=item digital-clock
223 321
224Displays 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.
225 391
226=item example-refresh-hooks 392=item example-refresh-hooks
227 393
228Displays 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
229window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
230overlays or changes. 396overlays or changes.
231 397
232=item selection-pastebin 398=item confirm-paste
233 399
234This is a little rarely useful extension that Uploads the selection as 400Displays a confirmation dialog when a paste containing at least a full
235textfile to a remote site (or does other things). (The implementation is 401line is detected.
236not currently secure for use in a multiuser environment as it writes to
237F</tmp> directly.).
238
239It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
240i.e.
241
242 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
243
244Pressing this combination runs a command with C<%> replaced by the name of
245the textfile. This command can be set via a resource:
246
247 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
248
249And the default is likely not useful to anybody but the few people around
250here :)
251
252The name of the textfile is the hex encoded md5 sum of the selection, so
253the same content should lead to the same filename.
254
255After a successful upload the selection will be replaced by the text given
256in the C<selection-pastebin-url> resource (again, the % is the placeholder
257for the filename):
258
259 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
260 402
261=back 403=back
262 404
263=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
264 406
280 422
281=over 4 423=over 4
282 424
283=item $text 425=item $text
284 426
285Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
286always 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.
287 429
288=item $string 430=item $string
289 431
290A 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
298 440
299=back 441=back
300 442
301=head2 Extension Objects 443=head2 Extension Objects
302 444
303Very 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
304for 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,
305hooks. 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
306about 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
307begin with an underscore character C<_>: these are reserved for internal 450that begin with an underscore character C<_>: these are reserved for
308use. 451internal use.
309 452
310Although 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
311C<urxvt::term> class on this object. 454C<urxvt::term> class on this object.
312 455
313It has the following methods and data members: 456It has the following methods and data members:
334=head2 Hooks 477=head2 Hooks
335 478
336The following subroutines can be declared in extension files, and will be 479The following subroutines can be declared in extension files, and will be
337called whenever the relevant event happens. 480called whenever the relevant event happens.
338 481
339The 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
340the in the C<Extension Objects> section. 483the in the C<Extension Objects> section.
341 484
342B<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
343hooks 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
344relevant action might not be carried out by the C++ code. 487relevant action might not be carried out by the C++ code.
357place. 500place.
358 501
359=item on_start $term 502=item on_start $term
360 503
361Called 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
362trying to map (display) the toplevel and returning to the mainloop. 505trying to map (display) the toplevel and returning to the main loop.
363 506
364=item on_destroy $term 507=item on_destroy $term
365 508
366Called whenever something tries to destroy terminal, before doing anything 509Called whenever something tries to destroy terminal, when the terminal is
367yet. If this hook returns true, then destruction is skipped, but this is 510still fully functional (not for long, though).
368rarely a good idea.
369 511
370=item on_reset $term 512=item on_reset $term
371 513
372Called 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
373control 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
395 537
396Called whenever a selection has been copied, but before the selection is 538Called whenever a selection has been copied, but before the selection is
397requested from the server. The selection text can be queried and changed 539requested from the server. The selection text can be queried and changed
398by calling C<< $term->selection >>. 540by calling C<< $term->selection >>.
399 541
400Returning a true value aborts selection grabbing. It will still be hilighted. 542Returning a true value aborts selection grabbing. It will still be highlighted.
401 543
402=item on_sel_extend $term 544=item on_sel_extend $term
403 545
404Called 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
405click) and is either supposed to return false (normal operation), or 547click) and is either supposed to return false (normal operation), or
406should 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
407processing. This can happen multiple times, as long as the callback 549processing. This can happen multiple times, as long as the callback
408returns 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
409supposed to enlarge the selection more and more, if possible. 551supposed to enlarge the selection more and more, if possible.
410 552
411See the F<selection> example extension. 553See the F<selection> example extension.
412 554
413=item on_view_change $term, $offset 555=item on_view_change $term, $offset
414 556
415Called whenever the view offset changes, i..e the user or program 557Called whenever the view offset changes, i.e. the user or program
416scrolls. Offset C<0> means display the normal terminal, positive values 558scrolls. Offset C<0> means display the normal terminal, positive values
417show this many lines of scrollback. 559show this many lines of scrollback.
418 560
419=item on_scroll_back $term, $lines, $saved 561=item on_scroll_back $term, $lines, $saved
420 562
424 566
425It 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,
426$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
427number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
428 570
429=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
430 582
431Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
432operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
433information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
434string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
435it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
436future. 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 }
437 599
438Be 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,
439as 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
440other 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.
441 606
442=item on_add_lines $term, $string 607=item on_add_lines $term, $string
443 608
444Called 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
445can 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
450=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
451 616
452Called 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
453suppress or filter tty input. 618suppress or filter tty input.
454 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
455=item on_line_update $term, $row 627=item on_line_update $term, $row
456 628
457Called 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
458screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
459that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
466later 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
467you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
468 640
469=item on_refresh_begin $term 641=item on_refresh_begin $term
470 642
471Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
472or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
473restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
474code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
475 647
476=item on_refresh_end $term 648=item on_refresh_end $term
477 649
478Called just after the screen gets redrawn. See C<on_refresh_begin>. 650Called just after the screen gets redrawn. See C<on_refresh_begin>.
479 651
480=item on_keyboard_command $term, $string 652=item on_user_command $term, $string
481 653
482Called whenever the user presses a key combination that has a 654Called whenever a user-configured event is being activated (e.g. via
483C<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>
484resource 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.
485 666
486=item on_x_event $term, $event 667=item on_x_event $term, $event
487 668
488Called 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
489windows). Should only be used as a last resort. Most event structure 670windows). Should only be used as a last resort. Most event structure
490members are not passed. 671members are not passed.
491 672
673=item on_root_event $term, $event
674
675Like C<on_x_event>, but is called for events on the root window.
676
492=item on_focus_in $term 677=item on_focus_in $term
493 678
494Called whenever the window gets the keyboard focus, before rxvt-unicode 679Called whenever the window gets the keyboard focus, before rxvt-unicode
495does focus in processing. 680does focus in processing.
496 681
497=item on_focus_out $term 682=item on_focus_out $term
498 683
499Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called whenever the window loses keyboard focus, before rxvt-unicode does
500focus out processing. 685focus out processing.
501 686
502=item on_configure_notify $term, $event 687=item on_configure_notify $term, $event
503 688
504=item on_property_notify $term, $event 689=item on_property_notify $term, $event
515 700
516=item on_map_notify $term, $event 701=item on_map_notify $term, $event
517 702
518=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
519 704
520Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
521the 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.
522 707
523The 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
524manpage), 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
525(real, not screen-based) row and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
526 711
535 720
536=item on_wm_delete_window $term, $event 721=item on_wm_delete_window $term, $event
537 722
538Called when various types of ClientMessage events are received (all with 723Called when various types of ClientMessage events are received (all with
539format=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.
540 729
541=back 730=back
542 731
543=cut 732=cut
544 733
587The current terminal. This variable stores the current C<urxvt::term> 776The current terminal. This variable stores the current C<urxvt::term>
588object, whenever a callback/hook is executing. 777object, whenever a callback/hook is executing.
589 778
590=item @urxvt::TERM_INIT 779=item @urxvt::TERM_INIT
591 780
592All 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
593created 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
594gets cleared before the codereferences that were in it are being executed, 783gets cleared before the code references that were in it are being executed,
595so coderefs can push themselves onto it again if they so desire. 784so references can push themselves onto it again if they so desire.
596 785
597This complements to the perl-eval commandline option, but gets executed 786This complements to the perl-eval command line option, but gets executed
598first. 787first.
599 788
600=item @urxvt::TERM_EXT 789=item @urxvt::TERM_EXT
601 790
602Works 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
623 812
624Using 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
625correct place, e.g. on stderr of the connecting urxvtc client. 814correct place, e.g. on stderr of the connecting urxvtc client.
626 815
627Messages 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).
628 824
629=item $time = urxvt::NOW 825=item $time = urxvt::NOW
630 826
631Returns the "current time" (as per the event loop). 827Returns the "current time" (as per the event loop).
632 828
690Return the foreground/background colour index, respectively. 886Return the foreground/background colour index, respectively.
691 887
692=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 888=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
693 889
694=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 890=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
891
892=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
695 893
696Replace the foreground/background colour in the rendition mask with the 894Replace the foreground/background colour in the rendition mask with the
697specified one. 895specified one.
698 896
699=item $value = urxvt::GET_CUSTOM $rend 897=item $value = urxvt::GET_CUSTOM $rend
766 local $TERM = shift; 964 local $TERM = shift;
767 my $htype = shift; 965 my $htype = shift;
768 966
769 if ($htype == 0) { # INIT 967 if ($htype == 0) { # INIT
770 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 968 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
771 969
772 my %ext_arg; 970 my %ext_arg;
773 971
774 { 972 {
775 my @init = @TERM_INIT; 973 my @init = @TERM_INIT;
776 @TERM_INIT = (); 974 @TERM_INIT = ();
790 } else { 988 } else {
791 $ext_arg{$_} ||= []; 989 $ext_arg{$_} ||= [];
792 } 990 }
793 } 991 }
794 992
795 while (my ($ext, $argv) = each %ext_arg) { 993 for my $ext (sort keys %ext_arg) {
796 my @files = grep -f $_, map "$_/$ext", @dirs; 994 my @files = grep -f $_, map "$_/$ext", @dirs;
797 995
798 if (@files) { 996 if (@files) {
799 $TERM->register_package (extension_package $files[0], $argv); 997 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
800 } else { 998 } else {
801 warn "perl extension '$ext' not found in perl library search path\n"; 999 warn "perl extension '$ext' not found in perl library search path\n";
802 } 1000 }
803 } 1001 }
804 1002
810 1008
811 if (my $cb = $TERM->{_hook}[$htype]) { 1009 if (my $cb = $TERM->{_hook}[$htype]) {
812 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1010 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
813 if $verbosity >= 10; 1011 if $verbosity >= 10;
814 1012
815 keys %$cb; 1013 for my $pkg (keys %$cb) {
816
817 while (my ($pkg, $cb) = each %$cb) {
818 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1014 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
819 $retval ||= $retval_; 1015 $retval ||= $retval_;
820 1016
821 if ($@) { 1017 if ($@) {
822 $TERM->ungrab; # better to lose the grab than the session 1018 $TERM->ungrab; # better to lose the grab than the session
823 warn $@; 1019 warn $@;
835 # clear package 1031 # clear package
836 %$TERM = (); 1032 %$TERM = ();
837 } 1033 }
838 1034
839 $retval 1035 $retval
1036}
1037
1038sub SET_COLOR($$$) {
1039 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1040}
1041
1042sub rend2mask {
1043 no strict 'refs';
1044 my ($str, $mask) = (@_, 0);
1045 my %color = ( fg => undef, bg => undef );
1046 my @failed;
1047 for my $spec ( split /\s+/, $str ) {
1048 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1049 $color{lc($1)} = $2;
1050 } else {
1051 my $neg = $spec =~ s/^[-^]//;
1052 unless ( exists &{"RS_$spec"} ) {
1053 push @failed, $spec;
1054 next;
1055 }
1056 my $cur = &{"RS_$spec"};
1057 if ( $neg ) {
1058 $mask &= ~$cur;
1059 } else {
1060 $mask |= $cur;
1061 }
1062 }
1063 }
1064 ($mask, @color{qw(fg bg)}, \@failed)
840} 1065}
841 1066
842# urxvt::term::extension 1067# urxvt::term::extension
843 1068
844package urxvt::term::extension; 1069package urxvt::term::extension;
915is that you cannot use blocking APIs, but the non-blocking variant should 1140is that you cannot use blocking APIs, but the non-blocking variant should
916work. 1141work.
917 1142
918=cut 1143=cut
919 1144
920our $VERSION = 1; 1145our $VERSION = '5.23';
921 1146
922$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1147$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
923push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1148push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
924 1149
925sub timer { 1150sub timer {
927 1152
928 my $cb = $arg{cb}; 1153 my $cb = $arg{cb};
929 1154
930 urxvt::timer 1155 urxvt::timer
931 ->new 1156 ->new
932 ->start (urxvt::NOW + $arg{after}) 1157 ->after ($arg{after}, $arg{interval})
933 ->cb (sub { 1158 ->cb ($arg{interval} ? $cb : sub {
934 $_[0]->stop; # need to cancel manually 1159 $_[0]->stop; # need to cancel manually
935 $cb->(); 1160 $cb->();
936 }) 1161 })
937} 1162}
938 1163
939sub io { 1164sub io {
940 my ($class, %arg) = @_; 1165 my ($class, %arg) = @_;
941 1166
942 my $cb = $arg{cb}; 1167 my $cb = $arg{cb};
1168 my $fd = fileno $arg{fh};
1169 defined $fd or $fd = $arg{fh};
943 1170
944 bless [$arg{fh}, urxvt::iow 1171 bless [$arg{fh}, urxvt::iow
945 ->new 1172 ->new
946 ->fd (fileno $arg{fh}) 1173 ->fd ($fd)
947 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1174 ->events (($arg{poll} =~ /r/ ? 1 : 0)
948 | ($arg{poll} =~ /w/ ? 2 : 0)) 1175 | ($arg{poll} =~ /w/ ? 2 : 0))
949 ->start 1176 ->start
950 ->cb (sub { 1177 ->cb ($cb)
951 $cb->(($_[1] & 1 ? 'r' : '')
952 . ($_[1] & 2 ? 'w' : ''));
953 })],
954 urxvt::anyevent:: 1178 ], urxvt::anyevent::
1179}
1180
1181sub idle {
1182 my ($class, %arg) = @_;
1183
1184 my $cb = $arg{cb};
1185
1186 urxvt::iw
1187 ->new
1188 ->start
1189 ->cb ($cb)
1190}
1191
1192sub child {
1193 my ($class, %arg) = @_;
1194
1195 my $cb = $arg{cb};
1196
1197 urxvt::pw
1198 ->new
1199 ->start ($arg{pid})
1200 ->cb (sub {
1201 $_[0]->stop; # need to cancel manually
1202 $cb->($_[0]->rpid, $_[0]->rstatus);
1203 })
955} 1204}
956 1205
957sub DESTROY { 1206sub DESTROY {
958 $_[0][1]->stop; 1207 $_[0][1]->stop;
959} 1208}
960 1209
961sub condvar { 1210sub one_event {
962 bless \my $flag, urxvt::anyevent::condvar::
963}
964
965sub urxvt::anyevent::condvar::broadcast {
966 ${$_[0]}++;
967}
968
969sub urxvt::anyevent::condvar::wait {
970 unless (${$_[0]}) {
971 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1211 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
972 }
973} 1212}
974 1213
975package urxvt::term; 1214package urxvt::term;
976 1215
977=head2 The C<urxvt::term> Class 1216=head2 The C<urxvt::term> Class
1013hash which defines the environment of the new terminal. 1252hash which defines the environment of the new terminal.
1014 1253
1015Croaks (and probably outputs an error message) if the new instance 1254Croaks (and probably outputs an error message) if the new instance
1016couldn't be created. Returns C<undef> if the new instance didn't 1255couldn't be created. Returns C<undef> if the new instance didn't
1017initialise perl, and the terminal object otherwise. The C<init> and 1256initialise perl, and the terminal object otherwise. The C<init> and
1018C<start> hooks will be called during this call. 1257C<start> hooks will be called before this call returns, and are free to
1258refer to global data (which is race free).
1019 1259
1020=cut 1260=cut
1021 1261
1022sub new { 1262sub new {
1023 my ($class, $env, @args) = @_; 1263 my ($class, $env, @args) = @_;
1024 1264
1265 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1266 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1267
1025 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1268 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1026} 1269}
1027 1270
1028=item $term->destroy 1271=item $term->destroy
1029 1272
1030Destroy the terminal object (close the window, free resources 1273Destroy the terminal object (close the window, free resources
1060 1303
1061Returns true if the option specified by C<$optval> is enabled, and 1304Returns true if the option specified by C<$optval> is enabled, and
1062optionally change it. All option values are stored by name in the hash 1305optionally change it. All option values are stored by name in the hash
1063C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1306C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1064 1307
1065Here is a a likely non-exhaustive list of option names, please see the 1308Here is a likely non-exhaustive list of option names, please see the
1066source file F</src/optinc.h> to see the actual list: 1309source file F</src/optinc.h> to see the actual list:
1067 1310
1068 borderLess console cursorBlink cursorUnderline hold iconic insecure 1311 borderLess console cursorBlink cursorUnderline hold iconic insecure
1069 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1312 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
1070 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1313 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
1087likely change). 1330likely change).
1088 1331
1089Please note that resource strings will currently only be freed when the 1332Please note that resource strings will currently only be freed when the
1090terminal is destroyed, so changing options frequently will eat memory. 1333terminal is destroyed, so changing options frequently will eat memory.
1091 1334
1092Here is a a likely non-exhaustive list of resource names, not all of which 1335Here is a likely non-exhaustive list of resource names, not all of which
1093are supported in every build, please see the source file F</src/rsinc.h> 1336are supported in every build, please see the source file F</src/rsinc.h>
1094to see the actual list: 1337to see the actual list:
1095 1338
1096 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1339 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1097 borderLess color cursorBlink cursorUnderline cutchars delete_key 1340 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1098 display_name embed ext_bwidth fade font geometry hold iconName 1341 display_name embed ext_bwidth fade font geometry hold iconName
1099 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1342 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1100 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1343 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1101 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1344 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1102 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1345 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1103 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1346 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1104 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1347 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1105 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1348 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1106 secondaryScreen secondaryScroll selectstyle shade term_name title 1349 secondaryScreen secondaryScroll shade term_name title
1107 transient_for transparent transparent_all tripleclickwords utmpInhibit 1350 transient_for transparent transparent_all tripleclickwords utmpInhibit
1108 visualBell 1351 visualBell
1109 1352
1110=cut 1353=cut
1111 1354
1112sub resource($$;$) { 1355sub resource($$;$) {
1113 my ($self, $name) = (shift, shift); 1356 my ($self, $name) = (shift, shift);
1114 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1357 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1115 &urxvt::term::_resource 1358 goto &urxvt::term::_resource
1116} 1359}
1117 1360
1118=item $value = $term->x_resource ($pattern) 1361=item $value = $term->x_resource ($pattern)
1119 1362
1120Returns the X-Resource for the given pattern, excluding the program or 1363Returns the X-Resource for the given pattern, excluding the program or
1145 1388
1146=item ($row, $col) = $term->selection_beg ([$row, $col]) 1389=item ($row, $col) = $term->selection_beg ([$row, $col])
1147 1390
1148=item ($row, $col) = $term->selection_end ([$row, $col]) 1391=item ($row, $col) = $term->selection_end ([$row, $col])
1149 1392
1150Return the current values of the selection mark, begin or end positions, 1393Return the current values of the selection mark, begin or end positions.
1151and optionally set them to new values. 1394
1395When arguments are given, then the selection coordinates are set to
1396C<$row> and C<$col>, and the selection screen is set to the current
1397screen.
1398
1399=item $screen = $term->selection_screen ([$screen])
1400
1401Returns the current selection screen, and then optionally sets it.
1152 1402
1153=item $term->selection_make ($eventtime[, $rectangular]) 1403=item $term->selection_make ($eventtime[, $rectangular])
1154 1404
1155Tries to make a selection as set by C<selection_beg> and 1405Tries to make a selection as set by C<selection_beg> and
1156C<selection_end>. If C<$rectangular> is true (default: false), a 1406C<selection_end>. If C<$rectangular> is true (default: false), a
1157rectangular selection will be made. This is the prefered function to make 1407rectangular selection will be made. This is the preferred function to make
1158a selection. 1408a selection.
1159 1409
1160=item $success = $term->selection_grab ($eventtime) 1410=item $success = $term->selection_grab ($eventtime[, $clipboard])
1161 1411
1162Try to request the primary selection text from the server (for example, as 1412Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1413true) selection from the server. The corresponding text can be set
1163set by the next method). No visual feedback will be given. This function 1414with the next method. No visual feedback will be given. This function
1164is mostly useful from within C<on_sel_grab> hooks. 1415is mostly useful from within C<on_sel_grab> hooks.
1165 1416
1166=item $oldtext = $term->selection ([$newtext]) 1417=item $oldtext = $term->selection ([$newtext, $clipboard])
1167 1418
1168Return the current selection text and optionally replace it by C<$newtext>. 1419Return the current selection (clipboard if C<$clipboard> is true) text
1420and optionally replace it by C<$newtext>.
1421
1422=item $term->selection_clear ([$clipboard])
1423
1424Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1169 1425
1170=item $term->overlay_simple ($x, $y, $text) 1426=item $term->overlay_simple ($x, $y, $text)
1171 1427
1172Create a simple multi-line overlay box. See the next method for details. 1428Create a simple multi-line overlay box. See the next method for details.
1173 1429
1203 1459
1204The methods currently supported on C<urxvt::overlay> objects are: 1460The methods currently supported on C<urxvt::overlay> objects are:
1205 1461
1206=over 4 1462=over 4
1207 1463
1208=item $overlay->set ($x, $y, $text, $rend) 1464=item $overlay->set ($x, $y, $text[, $rend])
1209 1465
1210Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1466Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1211text in rxvt-unicode's special encoding and an array of rendition values 1467text in rxvt-unicode's special encoding and an array of rendition values
1212at a specific position inside the overlay. 1468at a specific position inside the overlay.
1469
1470If C<$rend> is missing, then the rendition will not be changed.
1213 1471
1214=item $overlay->hide 1472=item $overlay->hide
1215 1473
1216If visible, hide the overlay, but do not destroy it. 1474If visible, hide the overlay, but do not destroy it.
1217 1475
1299locale-specific encoding of the terminal and can contain command sequences 1557locale-specific encoding of the terminal and can contain command sequences
1300(escape codes) that will be interpreted. 1558(escape codes) that will be interpreted.
1301 1559
1302=item $term->tt_write ($octets) 1560=item $term->tt_write ($octets)
1303 1561
1304Write the octets given in C<$data> to the tty (i.e. as program input). To 1562Write the octets given in C<$octets> to the tty (i.e. as program input). To
1305pass characters instead of octets, you should convert your strings first 1563pass characters instead of octets, you should convert your strings first
1306to the locale-specific encoding using C<< $term->locale_encode >>. 1564to the locale-specific encoding using C<< $term->locale_encode >>.
1565
1566=item $term->tt_paste ($octets)
1567
1568Write the octets given in C<$octets> to the tty as a paste, converting NL to
1569CR and bracketing the data with control sequences if bracketed paste mode
1570is set.
1307 1571
1308=item $old_events = $term->pty_ev_events ([$new_events]) 1572=item $old_events = $term->pty_ev_events ([$new_events])
1309 1573
1310Replaces the event mask of the pty watcher by the given event mask. Can 1574Replaces the event mask of the pty watcher by the given event mask. Can
1311be used to suppress input and output handling to the pty/tty. See the 1575be used to suppress input and output handling to the pty/tty. See the
1312description of C<< urxvt::timer->events >>. Make sure to always restore 1576description of C<< urxvt::timer->events >>. Make sure to always restore
1313the previous value. 1577the previous value.
1314 1578
1579=item $fd = $term->pty_fd
1580
1581Returns the master file descriptor for the pty in use, or C<-1> if no pty
1582is used.
1583
1315=item $windowid = $term->parent 1584=item $windowid = $term->parent
1316 1585
1317Return the window id of the toplevel window. 1586Return the window id of the toplevel window.
1318 1587
1319=item $windowid = $term->vt 1588=item $windowid = $term->vt
1325Adds the specified events to the vt event mask. Useful e.g. when you want 1594Adds the specified events to the vt event mask. Useful e.g. when you want
1326to receive pointer events all the times: 1595to receive pointer events all the times:
1327 1596
1328 $term->vt_emask_add (urxvt::PointerMotionMask); 1597 $term->vt_emask_add (urxvt::PointerMotionMask);
1329 1598
1599=item $term->focus_in
1600
1601=item $term->focus_out
1602
1603=item $term->key_press ($state, $keycode[, $time])
1604
1605=item $term->key_release ($state, $keycode[, $time])
1606
1607Deliver various fake events to to terminal.
1608
1330=item $window_width = $term->width 1609=item $window_width = $term->width
1331 1610
1332=item $window_height = $term->height 1611=item $window_height = $term->height
1333 1612
1334=item $font_width = $term->fwidth 1613=item $font_width = $term->fwidth
1364=item $env = $term->env 1643=item $env = $term->env
1365 1644
1366Returns a copy of the environment in effect for the terminal as a hashref 1645Returns a copy of the environment in effect for the terminal as a hashref
1367similar to C<\%ENV>. 1646similar to C<\%ENV>.
1368 1647
1648=item @envv = $term->envv
1649
1650Returns the environment as array of strings of the form C<VAR=VALUE>.
1651
1652=item @argv = $term->argv
1653
1654Return the argument vector as this terminal, similar to @ARGV, but
1655includes the program name as first element.
1656
1369=cut 1657=cut
1370 1658
1371sub env { 1659sub env {
1372 if (my $env = $_[0]->_env) {
1373 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1660 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1374 } else {
1375 +{ %ENV }
1376 }
1377} 1661}
1378 1662
1379=item $modifiermask = $term->ModLevel3Mask 1663=item $modifiermask = $term->ModLevel3Mask
1380 1664
1381=item $modifiermask = $term->ModMetaMask 1665=item $modifiermask = $term->ModMetaMask
1389 1673
1390Returns the currently displayed screen (0 primary, 1 secondary). 1674Returns the currently displayed screen (0 primary, 1 secondary).
1391 1675
1392=item $cursor_is_hidden = $term->hidden_cursor 1676=item $cursor_is_hidden = $term->hidden_cursor
1393 1677
1394Returns wether the cursor is currently hidden or not. 1678Returns whether the cursor is currently hidden or not.
1395 1679
1396=item $view_start = $term->view_start ([$newvalue]) 1680=item $view_start = $term->view_start ([$newvalue])
1397 1681
1398Returns the row number of the topmost displayed line. Maximum value is 1682Returns the row number of the topmost displayed line. Maximum value is
1399C<0>, which displays the normal terminal contents. Lower values scroll 1683C<0>, which displays the normal terminal contents. Lower values scroll
1407 1691
1408Used after changing terminal contents to display them. 1692Used after changing terminal contents to display them.
1409 1693
1410=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1694=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1411 1695
1412Returns the text of the entire row with number C<$row_number>. Row C<0> 1696Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1413is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1697is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1414terminal line. The scrollback buffer starts at line C<-1> and extends to
1415line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1698terminal line. Nothing will be returned if a nonexistent line
1416is requested. 1699is requested.
1417 1700
1418If C<$new_text> is specified, it will replace characters in the current 1701If C<$new_text> is specified, it will replace characters in the current
1419line, starting at column C<$start_col> (default C<0>), which is useful 1702line, starting at column C<$start_col> (default C<0>), which is useful
1420to replace only parts of a line. The font index in the rendition will 1703to replace only parts of a line. The font index in the rendition will
1421automatically be updated. 1704automatically be updated.
1422 1705
1423C<$text> is in a special encoding: tabs and wide characters that use more 1706C<$text> is in a special encoding: tabs and wide characters that use more
1424than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1707than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1425characters. Characters with combining characters and other characters that 1708characters. Characters with combining characters and other characters that
1426do not fit into the normal tetx encoding will be replaced with characters 1709do not fit into the normal text encoding will be replaced with characters
1427in the private use area. 1710in the private use area.
1428 1711
1429You have to obey this encoding when changing text. The advantage is 1712You have to obey this encoding when changing text. The advantage is
1430that C<substr> and similar functions work on screen cells and not on 1713that C<substr> and similar functions work on screen cells and not on
1431characters. 1714characters.
1576where one character corresponds to one screen cell. See 1859where one character corresponds to one screen cell. See
1577C<< $term->ROW_t >> for details. 1860C<< $term->ROW_t >> for details.
1578 1861
1579=item $string = $term->special_decode $text 1862=item $string = $term->special_decode $text
1580 1863
1581Converts rxvt-unicodes text reprsentation into a perl string. See 1864Converts rxvt-unicodes text representation into a perl string. See
1582C<< $term->ROW_t >> for details. 1865C<< $term->ROW_t >> for details.
1583 1866
1584=item $success = $term->grab_button ($button, $modifiermask) 1867=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1585 1868
1869=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1870
1586Registers a synchronous button grab. See the XGrabButton manpage. 1871Register/unregister a synchronous button grab. See the XGrabButton
1872manpage.
1587 1873
1588=item $success = $term->grab ($eventtime[, $sync]) 1874=item $success = $term->grab ($eventtime[, $sync])
1589 1875
1590Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1876Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1591synchronous (C<$sync> is true). Also remembers the grab timestampe. 1877synchronous (C<$sync> is true). Also remembers the grab timestamp.
1592 1878
1593=item $term->allow_events_async 1879=item $term->allow_events_async
1594 1880
1595Calls XAllowEvents with AsyncBoth for the most recent grab. 1881Calls XAllowEvents with AsyncBoth for the most recent grab.
1596 1882
1603Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1889Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1604recent grab. 1890recent grab.
1605 1891
1606=item $term->ungrab 1892=item $term->ungrab
1607 1893
1608Calls XUngrab for the most recent grab. Is called automatically on 1894Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1609evaluation errors, as it is better to lose the grab in the error case as 1895evaluation errors, as it is better to lose the grab in the error case as
1610the session. 1896the session.
1611 1897
1612=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1898=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1613 1899
1615 1901
1616=item @atoms = $term->XListProperties ($window) 1902=item @atoms = $term->XListProperties ($window)
1617 1903
1618=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1904=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1619 1905
1620=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1906=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1621 1907
1622=item $term->XDeleteProperty ($window, $property) 1908=item $term->XDeleteProperty ($window, $property)
1623 1909
1624=item $window = $term->DefaultRootWindow 1910=item $window = $term->DefaultRootWindow
1625 1911
1635 1921
1636=item $term->XChangeInput ($window, $add_events[, $del_events]) 1922=item $term->XChangeInput ($window, $add_events[, $del_events])
1637 1923
1638Various X or X-related functions. The C<$term> object only serves as 1924Various X or X-related functions. The C<$term> object only serves as
1639the source of the display, otherwise those functions map more-or-less 1925the source of the display, otherwise those functions map more-or-less
1640directory onto the X functions of the same name. 1926directly onto the X functions of the same name.
1641 1927
1642=back 1928=back
1643 1929
1644=cut 1930=cut
1645 1931
1709 my ($self, $text, $cb) = @_; 1995 my ($self, $text, $cb) = @_;
1710 1996
1711 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1997 $self->add_item ({ type => "button", text => $text, activate => $cb});
1712} 1998}
1713 1999
1714=item $popup->add_toggle ($text, $cb, $initial_value) 2000=item $popup->add_toggle ($text, $initial_value, $cb)
1715 2001
1716Adds a toggle/checkbox item to the popup. Teh callback gets called 2002Adds a toggle/checkbox item to the popup. The callback gets called
1717whenever it gets toggled, with a boolean indicating its value as its first 2003whenever it gets toggled, with a boolean indicating its new value as its
1718argument. 2004first argument.
1719 2005
1720=cut 2006=cut
1721 2007
1722sub add_toggle { 2008sub add_toggle {
1723 my ($self, $text, $cb, $value) = @_; 2009 my ($self, $text, $value, $cb) = @_;
1724 2010
1725 my $item; $item = { 2011 my $item; $item = {
1726 type => "button", 2012 type => "button",
1727 text => " $text", 2013 text => " $text",
1728 value => $value, 2014 value => $value,
1747 my $env = $self->{term}->env; 2033 my $env = $self->{term}->env;
1748 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2034 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1749 delete $env->{LC_ALL}; 2035 delete $env->{LC_ALL};
1750 $env->{LC_CTYPE} = $self->{term}->locale; 2036 $env->{LC_CTYPE} = $self->{term}->locale;
1751 2037
1752 urxvt::term->new ($env, "popup", 2038 my $term = urxvt::term->new (
2039 $env, "popup",
1753 "--perl-lib" => "", "--perl-ext-common" => "", 2040 "--perl-lib" => "", "--perl-ext-common" => "",
1754 "-pty-fd" => -1, "-sl" => 0, 2041 "-pty-fd" => -1, "-sl" => 0,
1755 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2042 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1756 "--transient-for" => $self->{term}->parent, 2043 "--transient-for" => $self->{term}->parent,
1757 "-display" => $self->{term}->display_id, 2044 "-display" => $self->{term}->display_id,
1758 "-pe" => "urxvt-popup") 2045 "-pe" => "urxvt-popup",
1759 or die "unable to create popup window\n"; 2046 ) or die "unable to create popup window\n";
2047
2048 unless (delete $term->{urxvt_popup_init_done}) {
2049 $term->ungrab;
2050 $term->destroy;
2051 die "unable to initialise popup window\n";
2052 }
1760} 2053}
1761 2054
1762sub DESTROY { 2055sub DESTROY {
1763 my ($self) = @_; 2056 my ($self) = @_;
1764 2057
1769=back 2062=back
1770 2063
1771=cut 2064=cut
1772 2065
1773package urxvt::watcher; 2066package urxvt::watcher;
1774
1775@urxvt::timer::ISA = __PACKAGE__;
1776@urxvt::iow::ISA = __PACKAGE__;
1777@urxvt::pw::ISA = __PACKAGE__;
1778@urxvt::iw::ISA = __PACKAGE__;
1779 2067
1780=head2 The C<urxvt::timer> Class 2068=head2 The C<urxvt::timer> Class
1781 2069
1782This class implements timer watchers/events. Time is represented as a 2070This class implements timer watchers/events. Time is represented as a
1783fractional number of seconds since the epoch. Example: 2071fractional number of seconds since the epoch. Example:
1787 ->new 2075 ->new
1788 ->interval (1) 2076 ->interval (1)
1789 ->cb (sub { 2077 ->cb (sub {
1790 $term->{overlay}->set (0, 0, 2078 $term->{overlay}->set (0, 0,
1791 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2079 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1792 }); 2080 });
1793 2081
1794=over 4 2082=over 4
1795 2083
1796=item $timer = new urxvt::timer 2084=item $timer = new urxvt::timer
1797 2085
1800 2088
1801=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2089=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1802 2090
1803Set the callback to be called when the timer triggers. 2091Set the callback to be called when the timer triggers.
1804 2092
1805=item $tstamp = $timer->at
1806
1807Return the time this watcher will fire next.
1808
1809=item $timer = $timer->set ($tstamp) 2093=item $timer = $timer->set ($tstamp[, $interval])
1810 2094
1811Set the time the event is generated to $tstamp. 2095Set the time the event is generated to $tstamp (and optionally specifies a
2096new $interval).
1812 2097
1813=item $timer = $timer->interval ($interval) 2098=item $timer = $timer->interval ($interval)
1814 2099
1815Normally (and when C<$interval> is C<0>), the timer will automatically 2100By default (and when C<$interval> is C<0>), the timer will automatically
1816stop after it has fired once. If C<$interval> is non-zero, then the timer 2101stop after it has fired once. If C<$interval> is non-zero, then the timer
1817is automatically rescheduled at the given intervals. 2102is automatically rescheduled at the given intervals.
1818 2103
1819=item $timer = $timer->start 2104=item $timer = $timer->start
1820 2105
1821Start the timer. 2106Start the timer.
1822 2107
1823=item $timer = $timer->start ($tstamp) 2108=item $timer = $timer->start ($tstamp[, $interval])
1824 2109
1825Set the event trigger time to C<$tstamp> and start the timer. 2110Set the event trigger time to C<$tstamp> and start the timer. Optionally
2111also replaces the interval.
1826 2112
1827=item $timer = $timer->after ($delay) 2113=item $timer = $timer->after ($delay[, $interval])
1828 2114
1829Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2115Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1830 2116
1831=item $timer = $timer->stop 2117=item $timer = $timer->stop
1832 2118
1840 2126
1841 $term->{socket} = ... 2127 $term->{socket} = ...
1842 $term->{iow} = urxvt::iow 2128 $term->{iow} = urxvt::iow
1843 ->new 2129 ->new
1844 ->fd (fileno $term->{socket}) 2130 ->fd (fileno $term->{socket})
1845 ->events (urxvt::EVENT_READ) 2131 ->events (urxvt::EV_READ)
1846 ->start 2132 ->start
1847 ->cb (sub { 2133 ->cb (sub {
1848 my ($iow, $revents) = @_; 2134 my ($iow, $revents) = @_;
1849 # $revents must be 1 here, no need to check 2135 # $revents must be 1 here, no need to check
1850 sysread $term->{socket}, my $buf, 8192 2136 sysread $term->{socket}, my $buf, 8192
1863Set the callback to be called when io events are triggered. C<$reventmask> 2149Set the callback to be called when io events are triggered. C<$reventmask>
1864is a bitset as described in the C<events> method. 2150is a bitset as described in the C<events> method.
1865 2151
1866=item $iow = $iow->fd ($fd) 2152=item $iow = $iow->fd ($fd)
1867 2153
1868Set the filedescriptor (not handle) to watch. 2154Set the file descriptor (not handle) to watch.
1869 2155
1870=item $iow = $iow->events ($eventmask) 2156=item $iow = $iow->events ($eventmask)
1871 2157
1872Set the event mask to watch. The only allowed values are 2158Set the event mask to watch. The only allowed values are
1873C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2159C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1874together, or C<urxvt::EVENT_NONE>. 2160together, or C<urxvt::EV_NONE>.
1875 2161
1876=item $iow = $iow->start 2162=item $iow = $iow->start
1877 2163
1878Start watching for requested events on the given handle. 2164Start watching for requested events on the given handle.
1879 2165
1880=item $iow = $iow->stop 2166=item $iow = $iow->stop
1881 2167
1882Stop watching for events on the given filehandle. 2168Stop watching for events on the given file handle.
1883 2169
1884=back 2170=back
1885 2171
1886=head2 The C<urxvt::iw> Class 2172=head2 The C<urxvt::iw> Class
1887 2173
1920 ->new 2206 ->new
1921 ->start ($pid) 2207 ->start ($pid)
1922 ->cb (sub { 2208 ->cb (sub {
1923 my ($pw, $exit_status) = @_; 2209 my ($pw, $exit_status) = @_;
1924 ... 2210 ...
1925 }); 2211 });
1926 2212
1927=over 4 2213=over 4
1928 2214
1929=item $pw = new urxvt::pw 2215=item $pw = new urxvt::pw
1930 2216
1934 2220
1935Set the callback to be called when the timer triggers. 2221Set the callback to be called when the timer triggers.
1936 2222
1937=item $pw = $timer->start ($pid) 2223=item $pw = $timer->start ($pid)
1938 2224
1939Tells the wqtcher to start watching for process C<$pid>. 2225Tells the watcher to start watching for process C<$pid>.
1940 2226
1941=item $pw = $pw->stop 2227=item $pw = $pw->stop
1942 2228
1943Stop the watcher. 2229Stop the watcher.
1944 2230
1957 2243
1958=item >= 3 - script loading and management 2244=item >= 3 - script loading and management
1959 2245
1960=item >=10 - all called hooks 2246=item >=10 - all called hooks
1961 2247
1962=item >=11 - hook reutrn values 2248=item >=11 - hook return values
1963 2249
1964=back 2250=back
1965 2251
1966=head1 AUTHOR 2252=head1 AUTHOR
1967 2253
1969 http://software.schmorp.de/pkg/rxvt-unicode 2255 http://software.schmorp.de/pkg/rxvt-unicode
1970 2256
1971=cut 2257=cut
1972 2258
19731 22591
2260
2261# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines