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.133 by root, Mon Feb 6 06:14:08 2006 UTC vs.
Revision 1.207 by root, Tue Jun 5 21:29:52 2012 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
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
109The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
110C<$self->{myoption}>: 113C<< $self->{myoption} >>:
111 114
112 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 }; 117 };
115 118
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It'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
127is 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.
128It 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
129string 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
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The 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
133the 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
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. 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>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. 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
152was 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
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 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.
155 164
156=item readline (enabled by default) 165=item readline (enabled by default)
157 166
158A support package that tries to make editing with readline easier. At the 167A support package that tries to make editing with readline easier. At
159moment, 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
160move 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
161cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
162for programs that correctly support wide characters). 171for programs that correctly support wide characters).
163 172
164To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
165 174
166=over 4 175=over 4
214the message into vi commands to load the file. 223the message into vi commands to load the file.
215 224
216=item tabbed 225=item tabbed
217 226
218This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
219is, 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
220displays 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
221button per tab. 230button per tab.
222 231
223Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
224B<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,
234 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
235 244
236See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid 245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237indices. 246indices.
238 247
239=item mark-urls 248=item matcher
240 249
241Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
242make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
243resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
244the 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 or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
268Example configuration:
269
270 URxvt.perl-ext: default,matcher
271 URxvt.urlLauncher: sensible-browser
272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
274 URxvt.matcher.button: 1
275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277 URxvt.matcher.launcher.2: gvim +$2 $1
245 278
246=item xim-onthespot 279=item xim-onthespot
247 280
248This (experimental) perl extension implements OnTheSpot editing. It does 281This (experimental) perl extension implements OnTheSpot editing. It does
249not work perfectly, and some input methods don't seem to work well with 282not work perfectly, and some input methods don't seem to work well with
250OnTheSpot editing in general, but it seems to work at leats for SCIM and 283OnTheSpot editing in general, but it seems to work at least for SCIM and
251kinput2. 284kinput2.
252 285
253You enable it by specifying this extension and a preedit style of 286You enable it by specifying this extension and a preedit style of
254C<OnTheSpot>, i.e.: 287C<OnTheSpot>, i.e.:
255 288
256 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257 290
258=item automove-background 291=item kuake<hotkey>
259 292
260This is basically a one-line extension that dynamically changes the background pixmap offset 293A very primitive quake-console-like extension. It was inspired by a
261to the window position, in effect creating the same effect as pseudo transparency with 294description of how the programs C<kuake> and C<yakuake> work: Whenever the
262a custom pixmap. No scaling is supported in this mode. Exmaple: 295user presses a global accelerator key (by default C<F10>), the terminal
296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
263 298
264 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 299Initially, the window will not be shown when using this extension.
300
301This is useful if you need a single terminal that is not using any desktop
302space most of the time but is quickly available at the press of a key.
303
304The accelerator key is grabbed regardless of any modifiers, so this
305extension will actually grab a physical key just for this function.
306
307If you want a quake-like animation, tell your window manager to do so
308(fvwm can do it).
309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
265 315
266=item block-graphics-to-ascii 316=item block-graphics-to-ascii
267 317
268A not very useful example of filtering all text output to the terminal, 318A not very useful example of filtering all text output to the terminal
269by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
270similar-looking ascii character. 320similar-looking ascii character.
271 321
272=item digital-clock 322=item digital-clock
273 323
274Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
275 325
276=item remote-clipboard 326=item remote-clipboard
277 327
278Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
279selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
280selection somewhere and fetch it again. 330selection somewhere and fetch it again.
281 331
282We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
283means that one command uploads the file to a remote server, and another 333means that one command uploads the file to a remote server, and another
284reads it. 334reads it.
293 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
294 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
295 345
296=item selection-pastebin 346=item selection-pastebin
297 347
298This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
299textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
300not currently secure for use in a multiuser environment as it writes to 350not currently secure for use in a multiuser environment as it writes to
301F</tmp> directly.). 351F</tmp> directly.).
302 352
303It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
320in the C<selection-pastebin-url> resource (again, the % is the placeholder 370in the C<selection-pastebin-url> resource (again, the % is the placeholder
321for the filename): 371for the filename):
322 372
323 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
324 374
375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376the double C</> characters as comment start. Use C<\057\057> instead,
377which works regardless of whether xrdb is used to parse the resource file
378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
393
325=item example-refresh-hooks 394=item example-refresh-hooks
326 395
327Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
328window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
329overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
330 412
331=back 413=back
332 414
333=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
334 416
350 432
351=over 4 433=over 4
352 434
353=item $text 435=item $text
354 436
355Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
356always represents one screen cell. See L<ROW_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
357 439
358=item $string 440=item $string
359 441
360A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
364=item $octets 446=item $octets
365 447
366Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
367locale-specific way. 449locale-specific way.
368 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
369=back 457=back
370 458
371=head2 Extension Objects 459=head2 Extension Objects
372 460
373Very perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
374for each terminal and each extension and passed as the first parameter to 462for each terminal, and each terminal has its own set of extension objects,
375hooks. So extensions can use their C<$self> object without having to think 463which are passed as the first parameter to hooks. So extensions can use
376about other extensions, with the exception of methods and members that 464their C<$self> object without having to think about clashes with other
465extensions or other terminals, with the exception of methods and members
377begin with an underscore character C<_>: these are reserved for internal 466that begin with an underscore character C<_>: these are reserved for
378use. 467internal use.
379 468
380Although it isn't a C<urxvt::term> object, you can call all methods of the 469Although it isn't a C<urxvt::term> object, you can call all methods of the
381C<urxvt::term> class on this object. 470C<urxvt::term> class on this object.
382 471
383It has the following methods and data members: 472It has the following methods and data members:
404=head2 Hooks 493=head2 Hooks
405 494
406The following subroutines can be declared in extension files, and will be 495The following subroutines can be declared in extension files, and will be
407called whenever the relevant event happens. 496called whenever the relevant event happens.
408 497
409The first argument passed to them is an extension oject as described in 498The first argument passed to them is an extension object as described in
410the in the C<Extension Objects> section. 499the in the C<Extension Objects> section.
411 500
412B<All> of these hooks must return a boolean value. If any of the called 501B<All> of these hooks must return a boolean value. If any of the called
413hooks returns true, then the event counts as being I<consumed>, and the 502hooks returns true, then the event counts as being I<consumed>, and the
414relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
427place. 516place.
428 517
429=item on_start $term 518=item on_start $term
430 519
431Called at the very end of initialisation of a new terminal, just before 520Called at the very end of initialisation of a new terminal, just before
432trying to map (display) the toplevel and returning to the mainloop. 521trying to map (display) the toplevel and returning to the main loop.
433 522
434=item on_destroy $term 523=item on_destroy $term
435 524
436Called whenever something tries to destroy terminal, when the terminal is 525Called whenever something tries to destroy terminal, when the terminal is
437still fully functional (not for long, though). 526still fully functional (not for long, though).
464 553
465Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
466requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
467by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
468 557
469Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
470 559
471=item on_sel_extend $term 560=item on_sel_extend $term
472 561
473Called whenever the user tries to extend the selection (e.g. with a double 562Called whenever the user tries to extend the selection (e.g. with a double
474click) and is either supposed to return false (normal operation), or 563click) and is either supposed to return false (normal operation), or
475should extend the selection itelf and return true to suppress the built-in 564should extend the selection itself and return true to suppress the built-in
476processing. This can happen multiple times, as long as the callback 565processing. This can happen multiple times, as long as the callback
477returns true, it will be called on every further click by the user and is 566returns true, it will be called on every further click by the user and is
478supposed to enlarge the selection more and more, if possible. 567supposed to enlarge the selection more and more, if possible.
479 568
480See the F<selection> example extension. 569See the F<selection> example extension.
481 570
482=item on_view_change $term, $offset 571=item on_view_change $term, $offset
483 572
484Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
485scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
486show this many lines of scrollback. 575show this many lines of scrollback.
487 576
488=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
489 578
493 582
494It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 583It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
495$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 584$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
496number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
497 586
498=item on_osc_seq $term, $string 587=item on_osc_seq $term, $op, $args, $resp
588
589Called on every OSC sequence and can be used to suppress it or modify its
590behaviour. The default should be to return an empty list. A true value
591suppresses execution of the request completely. Make sure you don't get
592confused by recursive invocations when you output an OSC sequence within
593this callback.
594
595C<on_osc_seq_perl> should be used for new behaviour.
596
597=item on_osc_seq_perl $term, $args, $resp
499 598
500Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
501operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
502information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
503string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
504it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
505future. 604enforced in the future.
605
606For example, C<overlay-osc> uses this:
607
608 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_;
610
611 return unless $osc =~ s/^overlay;//;
612
613 ... process remaining $osc string
614 }
506 615
507Be careful not ever to trust (in a security sense) the data you receive, 616Be careful not ever to trust (in a security sense) the data you receive,
508as its source can not easily be controleld (e-mail content, messages from 617as its source can not easily be controlled (e-mail content, messages from
509other users on the same system etc.). 618other users on the same system etc.).
619
620For responses, C<$resp> contains the end-of-args separator used by the
621sender.
510 622
511=item on_add_lines $term, $string 623=item on_add_lines $term, $string
512 624
513Called whenever text is about to be output, with the text as argument. You 625Called whenever text is about to be output, with the text as argument. You
514can filter/change and output the text yourself by returning a true value 626can filter/change and output the text yourself by returning a true value
519=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
520 632
521Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
522suppress or filter tty input. 634suppress or filter tty input.
523 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
524=item on_line_update $term, $row 643=item on_line_update $term, $row
525 644
526Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
527screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
528that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
535later with the already-modified line (e.g. if unrelated parts change), so 654later with the already-modified line (e.g. if unrelated parts change), so
536you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
537 656
538=item on_refresh_begin $term 657=item on_refresh_begin $term
539 658
540Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
541or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
542restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
543code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
544 663
545=item on_refresh_end $term 664=item on_refresh_end $term
546 665
547Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
548 667
549=item on_user_command $term, $string 668=item on_user_command $term, $string
550 669
551Called whenever the a user-configured event is being activated (e.g. via 670Called whenever a user-configured event is being activated (e.g. via
552a C<perl:string> action bound to a key, see description of the B<keysym> 671a C<perl:string> action bound to a key, see description of the B<keysym>
553resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
554 673
555The event is simply the action string. This interface is assumed to change 674The event is simply the action string. This interface is assumed to change
556slightly in the future. 675slightly in the future.
676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
684=item on_resize_all_windows $term, $new_width, $new_height
685
686Called just after the new window size has been calculated, but before
687windows are actually being resized or hints are being set. If this hook
688returns TRUE, setting of the window hints is being skipped.
557 689
558=item on_x_event $term, $event 690=item on_x_event $term, $event
559 691
560Called on every X event received on the vt window (and possibly other 692Called on every X event received on the vt window (and possibly other
561windows). Should only be used as a last resort. Most event structure 693windows). Should only be used as a last resort. Most event structure
562members are not passed. 694members are not passed.
563 695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
699
564=item on_focus_in $term 700=item on_focus_in $term
565 701
566Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
567does focus in processing. 703does focus in processing.
568 704
569=item on_focus_out $term 705=item on_focus_out $term
570 706
571Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
572focus out processing. 708focus out processing.
573 709
574=item on_configure_notify $term, $event 710=item on_configure_notify $term, $event
575 711
576=item on_property_notify $term, $event 712=item on_property_notify $term, $event
587 723
588=item on_map_notify $term, $event 724=item on_map_notify $term, $event
589 725
590=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
591 727
592Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
593the hook returns true, then the even will be ignored by rxvt-unicode. 729the hook returns true, then the event will be ignored by rxvt-unicode.
594 730
595The event is a hash with most values as named by Xlib (see the XEvent 731The event is a hash with most values as named by Xlib (see the XEvent
596manpage), with the additional members C<row> and C<col>, which are the 732manpage), with the additional members C<row> and C<col>, which are the
597(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
598 734
607 743
608=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
609 745
610Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
611format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
748
749=item on_bell $term
750
751Called on receipt of a bell character.
612 752
613=back 753=back
614 754
615=cut 755=cut
616 756
659The current terminal. This variable stores the current C<urxvt::term> 799The current terminal. This variable stores the current C<urxvt::term>
660object, whenever a callback/hook is executing. 800object, whenever a callback/hook is executing.
661 801
662=item @urxvt::TERM_INIT 802=item @urxvt::TERM_INIT
663 803
664All coderefs in this array will be called as methods of the next newly 804All code references in this array will be called as methods of the next newly
665created C<urxvt::term> object (during the C<on_init> phase). The array 805created C<urxvt::term> object (during the C<on_init> phase). The array
666gets cleared before the codereferences that were in it are being executed, 806gets cleared before the code references that were in it are being executed,
667so coderefs can push themselves onto it again if they so desire. 807so references can push themselves onto it again if they so desire.
668 808
669This complements to the perl-eval commandline option, but gets executed 809This complements to the perl-eval command line option, but gets executed
670first. 810first.
671 811
672=item @urxvt::TERM_EXT 812=item @urxvt::TERM_EXT
673 813
674Works similar to C<@TERM_INIT>, but contains perl package/class names, which 814Works similar to C<@TERM_INIT>, but contains perl package/class names, which
681 821
682=over 4 822=over 4
683 823
684=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
685 825
686Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
687costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
688starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
689 830
690=item urxvt::warn $string 831=item urxvt::warn $string
691 832
692Calls C<rxvt_warn> with the given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
693newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
694that calls this function. 835that calls this function.
695 836
696Using this function has the advantage that its output ends up in the 837Using this function has the advantage that its output ends up in the
697correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
699Messages have a size limit of 1023 bytes currently. 840Messages have a size limit of 1023 bytes currently.
700 841
701=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
702 843
703Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
704wether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
705objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
706is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
707 848
708=item $time = urxvt::NOW 849=item $time = urxvt::NOW
709 850
710Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
711 852
754 895
755=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
756 897
757Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
758 899
759=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
760 902
761Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
762underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
763the bitset. 905the bitset.
764 906
801 }; 943 };
802} 944}
803 945
804no warnings 'utf8'; 946no warnings 'utf8';
805 947
948sub perl_libdirs {
949 map { split /:/ }
950 $_[0]->resource ("perl_lib"),
951 $ENV{URXVT_PERL_LIB},
952 "$ENV{HOME}/.urxvt/ext",
953 "$LIBDIR/perl"
954}
955
956our %META; # meta header information from scripts
957our %SCAN; # which dirs already scanned
958
959sub resource {
960 my ($term, $name, $isarg, $flag, $value) = @_;
961
962 for my $dir (perl_libdirs $term) {
963 }
964
965 warn "resourece<@_>\n";#d#
966
967 0
968}
969
806my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 970my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
807 971
808sub verbose { 972sub verbose {
809 my ($level, $msg) = @_; 973 my ($level, $msg) = @_;
810 warn "$msg\n" if $level <= $verbosity; 974 warn "$msg\n" if $level <= $verbosity;
846sub invoke { 1010sub invoke {
847 local $TERM = shift; 1011 local $TERM = shift;
848 my $htype = shift; 1012 my $htype = shift;
849 1013
850 if ($htype == 0) { # INIT 1014 if ($htype == 0) { # INIT
851 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1015 my @dirs = perl_libdirs $TERM;
852 1016
853 my %ext_arg; 1017 my %ext_arg;
854 1018
855 { 1019 {
856 my @init = @TERM_INIT; 1020 my @init = @TERM_INIT;
857 @TERM_INIT = (); 1021 @TERM_INIT = ();
891 1055
892 if (my $cb = $TERM->{_hook}[$htype]) { 1056 if (my $cb = $TERM->{_hook}[$htype]) {
893 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1057 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
894 if $verbosity >= 10; 1058 if $verbosity >= 10;
895 1059
896 keys %$cb; 1060 for my $pkg (keys %$cb) {
897
898 while (my ($pkg, $cb) = each %$cb) {
899 my $retval_ = eval { $cb->($TERM->{_pkg}{$pkg}, @_) }; 1061 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
900 $retval ||= $retval_; 1062 $retval ||= $retval_;
901 1063
902 if ($@) { 1064 if ($@) {
903 $TERM->ungrab; # better to lose the grab than the session 1065 $TERM->ungrab; # better to lose the grab than the session
904 warn $@; 1066 warn $@;
920 $retval 1082 $retval
921} 1083}
922 1084
923sub SET_COLOR($$$) { 1085sub SET_COLOR($$$) {
924 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1086 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1087}
1088
1089sub rend2mask {
1090 no strict 'refs';
1091 my ($str, $mask) = (@_, 0);
1092 my %color = ( fg => undef, bg => undef );
1093 my @failed;
1094 for my $spec ( split /\s+/, $str ) {
1095 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1096 $color{lc($1)} = $2;
1097 } else {
1098 my $neg = $spec =~ s/^[-^]//;
1099 unless ( exists &{"RS_$spec"} ) {
1100 push @failed, $spec;
1101 next;
1102 }
1103 my $cur = &{"RS_$spec"};
1104 if ( $neg ) {
1105 $mask &= ~$cur;
1106 } else {
1107 $mask |= $cur;
1108 }
1109 }
1110 }
1111 ($mask, @color{qw(fg bg)}, \@failed)
925} 1112}
926 1113
927# urxvt::term::extension 1114# urxvt::term::extension
928 1115
929package urxvt::term::extension; 1116package urxvt::term::extension;
1000is that you cannot use blocking APIs, but the non-blocking variant should 1187is that you cannot use blocking APIs, but the non-blocking variant should
1001work. 1188work.
1002 1189
1003=cut 1190=cut
1004 1191
1005our $VERSION = 1; 1192our $VERSION = '5.23';
1006 1193
1007$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1194$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1008push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1195push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1009 1196
1010sub timer { 1197sub timer {
1012 1199
1013 my $cb = $arg{cb}; 1200 my $cb = $arg{cb};
1014 1201
1015 urxvt::timer 1202 urxvt::timer
1016 ->new 1203 ->new
1017 ->start (urxvt::NOW + $arg{after}) 1204 ->after ($arg{after}, $arg{interval})
1018 ->cb (sub { 1205 ->cb ($arg{interval} ? $cb : sub {
1019 $_[0]->stop; # need to cancel manually 1206 $_[0]->stop; # need to cancel manually
1020 $cb->(); 1207 $cb->();
1021 }) 1208 })
1022} 1209}
1023 1210
1024sub io { 1211sub io {
1025 my ($class, %arg) = @_; 1212 my ($class, %arg) = @_;
1026 1213
1027 my $cb = $arg{cb}; 1214 my $cb = $arg{cb};
1215 my $fd = fileno $arg{fh};
1216 defined $fd or $fd = $arg{fh};
1028 1217
1029 bless [$arg{fh}, urxvt::iow 1218 bless [$arg{fh}, urxvt::iow
1030 ->new 1219 ->new
1031 ->fd (fileno $arg{fh}) 1220 ->fd ($fd)
1032 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1221 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1033 | ($arg{poll} =~ /w/ ? 2 : 0)) 1222 | ($arg{poll} =~ /w/ ? 2 : 0))
1034 ->start 1223 ->start
1035 ->cb (sub { 1224 ->cb ($cb)
1036 $cb->(($_[1] & 1 ? 'r' : '')
1037 . ($_[1] & 2 ? 'w' : ''));
1038 })],
1039 urxvt::anyevent:: 1225 ], urxvt::anyevent::
1226}
1227
1228sub idle {
1229 my ($class, %arg) = @_;
1230
1231 my $cb = $arg{cb};
1232
1233 urxvt::iw
1234 ->new
1235 ->start
1236 ->cb ($cb)
1237}
1238
1239sub child {
1240 my ($class, %arg) = @_;
1241
1242 my $cb = $arg{cb};
1243
1244 urxvt::pw
1245 ->new
1246 ->start ($arg{pid})
1247 ->cb (sub {
1248 $_[0]->stop; # need to cancel manually
1249 $cb->($_[0]->rpid, $_[0]->rstatus);
1250 })
1040} 1251}
1041 1252
1042sub DESTROY { 1253sub DESTROY {
1043 $_[0][1]->stop; 1254 $_[0][1]->stop;
1044} 1255}
1045 1256
1046sub condvar { 1257# only needed for AnyEvent < 6 compatibility
1047 bless \my $flag, urxvt::anyevent::condvar:: 1258sub one_event {
1048}
1049
1050sub urxvt::anyevent::condvar::broadcast {
1051 ${$_[0]}++;
1052}
1053
1054sub urxvt::anyevent::condvar::wait {
1055 unless (${$_[0]}) {
1056 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1259 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1057 }
1058} 1260}
1059 1261
1060package urxvt::term; 1262package urxvt::term;
1061 1263
1062=head2 The C<urxvt::term> Class 1264=head2 The C<urxvt::term> Class
1149 1351
1150Returns true if the option specified by C<$optval> is enabled, and 1352Returns true if the option specified by C<$optval> is enabled, and
1151optionally change it. All option values are stored by name in the hash 1353optionally change it. All option values are stored by name in the hash
1152C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1354C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1153 1355
1154Here is a a likely non-exhaustive list of option names, please see the 1356Here is a likely non-exhaustive list of option names, please see the
1155source file F</src/optinc.h> to see the actual list: 1357source file F</src/optinc.h> to see the actual list:
1156 1358
1157 borderLess console cursorBlink cursorUnderline hold iconic insecure 1359 borderLess buffered console cursorBlink cursorUnderline hold iconic
1158 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1360 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1159 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1361 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1160 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1362 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1161 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1363 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1162 transparent tripleclickwords utmpInhibit visualBell 1364 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1365 urgentOnBell utmpInhibit visualBell
1163 1366
1164=item $value = $term->resource ($name[, $newval]) 1367=item $value = $term->resource ($name[, $newval])
1165 1368
1166Returns the current resource value associated with a given name and 1369Returns the current resource value associated with a given name and
1167optionally sets a new value. Setting values is most useful in the C<init> 1370optionally sets a new value. Setting values is most useful in the C<init>
1176likely change). 1379likely change).
1177 1380
1178Please note that resource strings will currently only be freed when the 1381Please note that resource strings will currently only be freed when the
1179terminal is destroyed, so changing options frequently will eat memory. 1382terminal is destroyed, so changing options frequently will eat memory.
1180 1383
1181Here is a a likely non-exhaustive list of resource names, not all of which 1384Here is a likely non-exhaustive list of resource names, not all of which
1182are supported in every build, please see the source file F</src/rsinc.h> 1385are supported in every build, please see the source file F</src/rsinc.h>
1183to see the actual list: 1386to see the actual list:
1184 1387
1185 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1388 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1186 borderLess color cursorBlink cursorUnderline cutchars delete_key 1389 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1187 display_name embed ext_bwidth fade font geometry hold iconName 1390 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1188 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1391 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1392 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1189 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1393 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1190 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1394 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1191 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1395 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1192 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1396 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1193 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1397 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1194 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1398 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1195 secondaryScreen secondaryScroll selectstyle shade term_name title 1399 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1196 transient_for transparent transparent_all tripleclickwords utmpInhibit 1400 term_name title transient_for transparent tripleclickwords urgentOnBell
1197 visualBell 1401 utmpInhibit visualBell
1198 1402
1199=cut 1403=cut
1200 1404
1201sub resource($$;$) { 1405sub resource($$;$) {
1202 my ($self, $name) = (shift, shift); 1406 my ($self, $name) = (shift, shift);
1203 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1407 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1204 &urxvt::term::_resource 1408 goto &urxvt::term::_resource
1205} 1409}
1206 1410
1207=item $value = $term->x_resource ($pattern) 1411=item $value = $term->x_resource ($pattern)
1208 1412
1209Returns the X-Resource for the given pattern, excluding the program or 1413Returns the X-Resource for the given pattern, excluding the program or
1213 1417
1214This method should only be called during the C<on_start> hook, as there is 1418This method should only be called during the C<on_start> hook, as there is
1215only one resource database per display, and later invocations might return 1419only one resource database per display, and later invocations might return
1216the wrong resources. 1420the wrong resources.
1217 1421
1218=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1422=item $success = $term->parse_keysym ($key, $octets)
1219 1423
1220Adds a keymap translation exactly as specified via a resource. See the 1424Adds a key binding exactly as specified via a resource. See the
1221C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1425C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1426
1427=item $term->register_command ($keysym, $modifiermask, $string)
1428
1429Adds a key binding. This is a lower level api compared to
1430C<parse_keysym>, as it expects a parsed key description, and can be
1431used only inside either the C<on_init> hook, to add a binding, or the
1432C<on_register_command> hook, to modify a parsed binding.
1222 1433
1223=item $rend = $term->rstyle ([$new_rstyle]) 1434=item $rend = $term->rstyle ([$new_rstyle])
1224 1435
1225Return and optionally change the current rendition. Text that is output by 1436Return and optionally change the current rendition. Text that is output by
1226the terminal application will use this style. 1437the terminal application will use this style.
1234 1445
1235=item ($row, $col) = $term->selection_beg ([$row, $col]) 1446=item ($row, $col) = $term->selection_beg ([$row, $col])
1236 1447
1237=item ($row, $col) = $term->selection_end ([$row, $col]) 1448=item ($row, $col) = $term->selection_end ([$row, $col])
1238 1449
1239Return the current values of the selection mark, begin or end positions, 1450Return the current values of the selection mark, begin or end positions.
1240and optionally set them to new values. 1451
1452When arguments are given, then the selection coordinates are set to
1453C<$row> and C<$col>, and the selection screen is set to the current
1454screen.
1455
1456=item $screen = $term->selection_screen ([$screen])
1457
1458Returns the current selection screen, and then optionally sets it.
1241 1459
1242=item $term->selection_make ($eventtime[, $rectangular]) 1460=item $term->selection_make ($eventtime[, $rectangular])
1243 1461
1244Tries to make a selection as set by C<selection_beg> and 1462Tries to make a selection as set by C<selection_beg> and
1245C<selection_end>. If C<$rectangular> is true (default: false), a 1463C<selection_end>. If C<$rectangular> is true (default: false), a
1246rectangular selection will be made. This is the prefered function to make 1464rectangular selection will be made. This is the preferred function to make
1247a selection. 1465a selection.
1248 1466
1249=item $success = $term->selection_grab ($eventtime) 1467=item $success = $term->selection_grab ($eventtime[, $clipboard])
1250 1468
1251Try to request the primary selection text from the server (for example, as 1469Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1470true) selection from the server. The corresponding text can be set
1252set by the next method). No visual feedback will be given. This function 1471with the next method. No visual feedback will be given. This function
1253is mostly useful from within C<on_sel_grab> hooks. 1472is mostly useful from within C<on_sel_grab> hooks.
1254 1473
1255=item $oldtext = $term->selection ([$newtext]) 1474=item $oldtext = $term->selection ([$newtext, $clipboard])
1256 1475
1257Return the current selection text and optionally replace it by C<$newtext>. 1476Return the current selection (clipboard if C<$clipboard> is true) text
1477and optionally replace it by C<$newtext>.
1478
1479=item $term->selection_clear ([$clipboard])
1480
1481Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1258 1482
1259=item $term->overlay_simple ($x, $y, $text) 1483=item $term->overlay_simple ($x, $y, $text)
1260 1484
1261Create a simple multi-line overlay box. See the next method for details. 1485Create a simple multi-line overlay box. See the next method for details.
1262 1486
1292 1516
1293The methods currently supported on C<urxvt::overlay> objects are: 1517The methods currently supported on C<urxvt::overlay> objects are:
1294 1518
1295=over 4 1519=over 4
1296 1520
1297=item $overlay->set ($x, $y, $text, $rend) 1521=item $overlay->set ($x, $y, $text[, $rend])
1298 1522
1299Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1523Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1300text in rxvt-unicode's special encoding and an array of rendition values 1524text in rxvt-unicode's special encoding and an array of rendition values
1301at a specific position inside the overlay. 1525at a specific position inside the overlay.
1526
1527If C<$rend> is missing, then the rendition will not be changed.
1302 1528
1303=item $overlay->hide 1529=item $overlay->hide
1304 1530
1305If visible, hide the overlay, but do not destroy it. 1531If visible, hide the overlay, but do not destroy it.
1306 1532
1388locale-specific encoding of the terminal and can contain command sequences 1614locale-specific encoding of the terminal and can contain command sequences
1389(escape codes) that will be interpreted. 1615(escape codes) that will be interpreted.
1390 1616
1391=item $term->tt_write ($octets) 1617=item $term->tt_write ($octets)
1392 1618
1393Write the octets given in C<$data> to the tty (i.e. as program input). To 1619Write the octets given in C<$octets> to the tty (i.e. as program input). To
1394pass characters instead of octets, you should convert your strings first 1620pass characters instead of octets, you should convert your strings first
1395to the locale-specific encoding using C<< $term->locale_encode >>. 1621to the locale-specific encoding using C<< $term->locale_encode >>.
1622
1623=item $term->tt_paste ($octets)
1624
1625Write the octets given in C<$octets> to the tty as a paste, converting NL to
1626CR and bracketing the data with control sequences if bracketed paste mode
1627is set.
1396 1628
1397=item $old_events = $term->pty_ev_events ([$new_events]) 1629=item $old_events = $term->pty_ev_events ([$new_events])
1398 1630
1399Replaces the event mask of the pty watcher by the given event mask. Can 1631Replaces the event mask of the pty watcher by the given event mask. Can
1400be used to suppress input and output handling to the pty/tty. See the 1632be used to suppress input and output handling to the pty/tty. See the
1419Adds the specified events to the vt event mask. Useful e.g. when you want 1651Adds the specified events to the vt event mask. Useful e.g. when you want
1420to receive pointer events all the times: 1652to receive pointer events all the times:
1421 1653
1422 $term->vt_emask_add (urxvt::PointerMotionMask); 1654 $term->vt_emask_add (urxvt::PointerMotionMask);
1423 1655
1656=item $term->set_urgency ($set)
1657
1658Enable/disable the urgency hint on the toplevel window.
1659
1424=item $term->focus_in 1660=item $term->focus_in
1425 1661
1426=item $term->focus_out 1662=item $term->focus_out
1427 1663
1428=item $term->key_press ($state, $keycode[, $time]) 1664=item $term->key_press ($state, $keycode[, $time])
1468=item $env = $term->env 1704=item $env = $term->env
1469 1705
1470Returns a copy of the environment in effect for the terminal as a hashref 1706Returns a copy of the environment in effect for the terminal as a hashref
1471similar to C<\%ENV>. 1707similar to C<\%ENV>.
1472 1708
1709=item @envv = $term->envv
1710
1711Returns the environment as array of strings of the form C<VAR=VALUE>.
1712
1713=item @argv = $term->argv
1714
1715Return the argument vector as this terminal, similar to @ARGV, but
1716includes the program name as first element.
1717
1473=cut 1718=cut
1474 1719
1475sub env { 1720sub env {
1476 if (my $env = $_[0]->_env) {
1477 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1721 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1478 } else {
1479 +{ %ENV }
1480 }
1481} 1722}
1482 1723
1483=item $modifiermask = $term->ModLevel3Mask 1724=item $modifiermask = $term->ModLevel3Mask
1484 1725
1485=item $modifiermask = $term->ModMetaMask 1726=item $modifiermask = $term->ModMetaMask
1493 1734
1494Returns the currently displayed screen (0 primary, 1 secondary). 1735Returns the currently displayed screen (0 primary, 1 secondary).
1495 1736
1496=item $cursor_is_hidden = $term->hidden_cursor 1737=item $cursor_is_hidden = $term->hidden_cursor
1497 1738
1498Returns wether the cursor is currently hidden or not. 1739Returns whether the cursor is currently hidden or not.
1499 1740
1500=item $view_start = $term->view_start ([$newvalue]) 1741=item $view_start = $term->view_start ([$newvalue])
1501 1742
1502Returns the row number of the topmost displayed line. Maximum value is 1743Returns the row number of the topmost displayed line. Maximum value is
1503C<0>, which displays the normal terminal contents. Lower values scroll 1744C<0>, which displays the normal terminal contents. Lower values scroll
1511 1752
1512Used after changing terminal contents to display them. 1753Used after changing terminal contents to display them.
1513 1754
1514=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1755=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1515 1756
1516Returns the text of the entire row with number C<$row_number>. Row C<0> 1757Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1517is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1758is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1518terminal line. The scrollback buffer starts at line C<-1> and extends to
1519line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1759terminal line. Nothing will be returned if a nonexistent line
1520is requested. 1760is requested.
1521 1761
1522If C<$new_text> is specified, it will replace characters in the current 1762If C<$new_text> is specified, it will replace characters in the current
1523line, starting at column C<$start_col> (default C<0>), which is useful 1763line, starting at column C<$start_col> (default C<0>), which is useful
1524to replace only parts of a line. The font index in the rendition will 1764to replace only parts of a line. The font index in the rendition will
1525automatically be updated. 1765automatically be updated.
1526 1766
1527C<$text> is in a special encoding: tabs and wide characters that use more 1767C<$text> is in a special encoding: tabs and wide characters that use more
1528than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1768than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1529characters. Characters with combining characters and other characters that 1769characters. Characters with combining characters and other characters that
1530do not fit into the normal tetx encoding will be replaced with characters 1770do not fit into the normal text encoding will be replaced with characters
1531in the private use area. 1771in the private use area.
1532 1772
1533You have to obey this encoding when changing text. The advantage is 1773You have to obey this encoding when changing text. The advantage is
1534that C<substr> and similar functions work on screen cells and not on 1774that C<substr> and similar functions work on screen cells and not on
1535characters. 1775characters.
1680where one character corresponds to one screen cell. See 1920where one character corresponds to one screen cell. See
1681C<< $term->ROW_t >> for details. 1921C<< $term->ROW_t >> for details.
1682 1922
1683=item $string = $term->special_decode $text 1923=item $string = $term->special_decode $text
1684 1924
1685Converts rxvt-unicodes text reprsentation into a perl string. See 1925Converts rxvt-unicodes text representation into a perl string. See
1686C<< $term->ROW_t >> for details. 1926C<< $term->ROW_t >> for details.
1687 1927
1688=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1928=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1689 1929
1690=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1930=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1693manpage. 1933manpage.
1694 1934
1695=item $success = $term->grab ($eventtime[, $sync]) 1935=item $success = $term->grab ($eventtime[, $sync])
1696 1936
1697Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1937Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1698synchronous (C<$sync> is true). Also remembers the grab timestampe. 1938synchronous (C<$sync> is true). Also remembers the grab timestamp.
1699 1939
1700=item $term->allow_events_async 1940=item $term->allow_events_async
1701 1941
1702Calls XAllowEvents with AsyncBoth for the most recent grab. 1942Calls XAllowEvents with AsyncBoth for the most recent grab.
1703 1943
1710Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1950Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1711recent grab. 1951recent grab.
1712 1952
1713=item $term->ungrab 1953=item $term->ungrab
1714 1954
1715Calls XUngrab for the most recent grab. Is called automatically on 1955Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1716evaluation errors, as it is better to lose the grab in the error case as 1956evaluation errors, as it is better to lose the grab in the error case as
1717the session. 1957the session.
1718 1958
1719=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1959=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1720 1960
1722 1962
1723=item @atoms = $term->XListProperties ($window) 1963=item @atoms = $term->XListProperties ($window)
1724 1964
1725=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1965=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1726 1966
1727=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1967=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1728 1968
1729=item $term->XDeleteProperty ($window, $property) 1969=item $term->XDeleteProperty ($window, $property)
1730 1970
1731=item $window = $term->DefaultRootWindow 1971=item $window = $term->DefaultRootWindow
1732 1972
1739=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1979=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1740 1980
1741=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1981=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1742 1982
1743=item $term->XChangeInput ($window, $add_events[, $del_events]) 1983=item $term->XChangeInput ($window, $add_events[, $del_events])
1984
1985=item $keysym = $term->XStringToKeysym ($string)
1986
1987=item $string = $term->XKeysymToString ($keysym)
1744 1988
1745Various X or X-related functions. The C<$term> object only serves as 1989Various X or X-related functions. The C<$term> object only serves as
1746the source of the display, otherwise those functions map more-or-less 1990the source of the display, otherwise those functions map more-or-less
1747directory onto the X functions of the same name. 1991directly onto the X functions of the same name.
1748 1992
1749=back 1993=back
1750 1994
1751=cut 1995=cut
1752 1996
1854 my $env = $self->{term}->env; 2098 my $env = $self->{term}->env;
1855 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2099 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1856 delete $env->{LC_ALL}; 2100 delete $env->{LC_ALL};
1857 $env->{LC_CTYPE} = $self->{term}->locale; 2101 $env->{LC_CTYPE} = $self->{term}->locale;
1858 2102
1859 urxvt::term->new ($env, "popup", 2103 my $term = urxvt::term->new (
2104 $env, "popup",
1860 "--perl-lib" => "", "--perl-ext-common" => "", 2105 "--perl-lib" => "", "--perl-ext-common" => "",
1861 "-pty-fd" => -1, "-sl" => 0, 2106 "-pty-fd" => -1, "-sl" => 0,
1862 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2107 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1863 "--transient-for" => $self->{term}->parent, 2108 "--transient-for" => $self->{term}->parent,
1864 "-display" => $self->{term}->display_id, 2109 "-display" => $self->{term}->display_id,
1865 "-pe" => "urxvt-popup") 2110 "-pe" => "urxvt-popup",
1866 or die "unable to create popup window\n"; 2111 ) or die "unable to create popup window\n";
2112
2113 unless (delete $term->{urxvt_popup_init_done}) {
2114 $term->ungrab;
2115 $term->destroy;
2116 die "unable to initialise popup window\n";
2117 }
1867} 2118}
1868 2119
1869sub DESTROY { 2120sub DESTROY {
1870 my ($self) = @_; 2121 my ($self) = @_;
1871 2122
1876=back 2127=back
1877 2128
1878=cut 2129=cut
1879 2130
1880package urxvt::watcher; 2131package urxvt::watcher;
1881
1882@urxvt::timer::ISA = __PACKAGE__;
1883@urxvt::iow::ISA = __PACKAGE__;
1884@urxvt::pw::ISA = __PACKAGE__;
1885@urxvt::iw::ISA = __PACKAGE__;
1886 2132
1887=head2 The C<urxvt::timer> Class 2133=head2 The C<urxvt::timer> Class
1888 2134
1889This class implements timer watchers/events. Time is represented as a 2135This class implements timer watchers/events. Time is represented as a
1890fractional number of seconds since the epoch. Example: 2136fractional number of seconds since the epoch. Example:
1894 ->new 2140 ->new
1895 ->interval (1) 2141 ->interval (1)
1896 ->cb (sub { 2142 ->cb (sub {
1897 $term->{overlay}->set (0, 0, 2143 $term->{overlay}->set (0, 0,
1898 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2144 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1899 }); 2145 });
1900 2146
1901=over 4 2147=over 4
1902 2148
1903=item $timer = new urxvt::timer 2149=item $timer = new urxvt::timer
1904 2150
1907 2153
1908=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2154=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1909 2155
1910Set the callback to be called when the timer triggers. 2156Set the callback to be called when the timer triggers.
1911 2157
1912=item $tstamp = $timer->at
1913
1914Return the time this watcher will fire next.
1915
1916=item $timer = $timer->set ($tstamp) 2158=item $timer = $timer->set ($tstamp[, $interval])
1917 2159
1918Set the time the event is generated to $tstamp. 2160Set the time the event is generated to $tstamp (and optionally specifies a
2161new $interval).
1919 2162
1920=item $timer = $timer->interval ($interval) 2163=item $timer = $timer->interval ($interval)
1921 2164
1922Normally (and when C<$interval> is C<0>), the timer will automatically 2165By default (and when C<$interval> is C<0>), the timer will automatically
1923stop after it has fired once. If C<$interval> is non-zero, then the timer 2166stop after it has fired once. If C<$interval> is non-zero, then the timer
1924is automatically rescheduled at the given intervals. 2167is automatically rescheduled at the given intervals.
1925 2168
1926=item $timer = $timer->start 2169=item $timer = $timer->start
1927 2170
1928Start the timer. 2171Start the timer.
1929 2172
1930=item $timer = $timer->start ($tstamp) 2173=item $timer = $timer->start ($tstamp[, $interval])
1931 2174
1932Set the event trigger time to C<$tstamp> and start the timer. 2175Set the event trigger time to C<$tstamp> and start the timer. Optionally
2176also replaces the interval.
1933 2177
1934=item $timer = $timer->after ($delay) 2178=item $timer = $timer->after ($delay[, $interval])
1935 2179
1936Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2180Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1937 2181
1938=item $timer = $timer->stop 2182=item $timer = $timer->stop
1939 2183
1947 2191
1948 $term->{socket} = ... 2192 $term->{socket} = ...
1949 $term->{iow} = urxvt::iow 2193 $term->{iow} = urxvt::iow
1950 ->new 2194 ->new
1951 ->fd (fileno $term->{socket}) 2195 ->fd (fileno $term->{socket})
1952 ->events (urxvt::EVENT_READ) 2196 ->events (urxvt::EV_READ)
1953 ->start 2197 ->start
1954 ->cb (sub { 2198 ->cb (sub {
1955 my ($iow, $revents) = @_; 2199 my ($iow, $revents) = @_;
1956 # $revents must be 1 here, no need to check 2200 # $revents must be 1 here, no need to check
1957 sysread $term->{socket}, my $buf, 8192 2201 sysread $term->{socket}, my $buf, 8192
1970Set the callback to be called when io events are triggered. C<$reventmask> 2214Set the callback to be called when io events are triggered. C<$reventmask>
1971is a bitset as described in the C<events> method. 2215is a bitset as described in the C<events> method.
1972 2216
1973=item $iow = $iow->fd ($fd) 2217=item $iow = $iow->fd ($fd)
1974 2218
1975Set the filedescriptor (not handle) to watch. 2219Set the file descriptor (not handle) to watch.
1976 2220
1977=item $iow = $iow->events ($eventmask) 2221=item $iow = $iow->events ($eventmask)
1978 2222
1979Set the event mask to watch. The only allowed values are 2223Set the event mask to watch. The only allowed values are
1980C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2224C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1981together, or C<urxvt::EVENT_NONE>. 2225together, or C<urxvt::EV_NONE>.
1982 2226
1983=item $iow = $iow->start 2227=item $iow = $iow->start
1984 2228
1985Start watching for requested events on the given handle. 2229Start watching for requested events on the given handle.
1986 2230
1987=item $iow = $iow->stop 2231=item $iow = $iow->stop
1988 2232
1989Stop watching for events on the given filehandle. 2233Stop watching for events on the given file handle.
1990 2234
1991=back 2235=back
1992 2236
1993=head2 The C<urxvt::iw> Class 2237=head2 The C<urxvt::iw> Class
1994 2238
2027 ->new 2271 ->new
2028 ->start ($pid) 2272 ->start ($pid)
2029 ->cb (sub { 2273 ->cb (sub {
2030 my ($pw, $exit_status) = @_; 2274 my ($pw, $exit_status) = @_;
2031 ... 2275 ...
2032 }); 2276 });
2033 2277
2034=over 4 2278=over 4
2035 2279
2036=item $pw = new urxvt::pw 2280=item $pw = new urxvt::pw
2037 2281
2041 2285
2042Set the callback to be called when the timer triggers. 2286Set the callback to be called when the timer triggers.
2043 2287
2044=item $pw = $timer->start ($pid) 2288=item $pw = $timer->start ($pid)
2045 2289
2046Tells the wqtcher to start watching for process C<$pid>. 2290Tells the watcher to start watching for process C<$pid>.
2047 2291
2048=item $pw = $pw->stop 2292=item $pw = $pw->stop
2049 2293
2050Stop the watcher. 2294Stop the watcher.
2051 2295
2064 2308
2065=item >= 3 - script loading and management 2309=item >= 3 - script loading and management
2066 2310
2067=item >=10 - all called hooks 2311=item >=10 - all called hooks
2068 2312
2069=item >=11 - hook reutrn values 2313=item >=11 - hook return values
2070 2314
2071=back 2315=back
2072 2316
2073=head1 AUTHOR 2317=head1 AUTHOR
2074 2318
2075 Marc Lehmann <pcg@goof.com> 2319 Marc Lehmann <schmorp@schmorp.de>
2076 http://software.schmorp.de/pkg/rxvt-unicode 2320 http://software.schmorp.de/pkg/rxvt-unicode
2077 2321
2078=cut 2322=cut
2079 2323
20801 23241
2325
2326# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines