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.138 by root, Sat Mar 4 22:36:50 2006 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 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 167A support package that tries to make editing with readline easier. At
159the moment, it reacts to clicking shift-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, $op, $args 587=item on_osc_seq $term, $op, $args, $resp
499 588
500Called on every OSC sequence and can be used to suppress it or modify its 589Called on every OSC sequence and can be used to suppress it or modify its
501behaviour. The default should be to return an empty list. A true value 590behaviour. The default should be to return an empty list. A true value
502suppresses execution of the request completely. Make sure you don't get 591suppresses execution of the request completely. Make sure you don't get
503confused by recursive invocations when you output an osc sequence within 592confused by recursive invocations when you output an OSC sequence within
504this callback. 593this callback.
505 594
506C<on_osc_seq_perl> should be used for new behaviour. 595C<on_osc_seq_perl> should be used for new behaviour.
507 596
508=item on_osc_seq_perl $term, $string 597=item on_osc_seq_perl $term, $args, $resp
509 598
510Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
511operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
512information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
513string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
514it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
515future. 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 }
516 615
517Be 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,
518as 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
519other 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.
520 622
521=item on_add_lines $term, $string 623=item on_add_lines $term, $string
522 624
523Called 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
524can 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
529=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
530 632
531Called 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
532suppress or filter tty input. 634suppress or filter tty input.
533 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
534=item on_line_update $term, $row 643=item on_line_update $term, $row
535 644
536Called 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
537screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
538that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
545later 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
546you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
547 656
548=item on_refresh_begin $term 657=item on_refresh_begin $term
549 658
550Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
551or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
552restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
553code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
554 663
555=item on_refresh_end $term 664=item on_refresh_end $term
556 665
557Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
558 667
559=item on_user_command $term, $string 668=item on_user_command $term, $string
560 669
561Called whenever the a user-configured event is being activated (e.g. via 670Called whenever a user-configured event is being activated (e.g. via
562a 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>
563resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
564 673
565The 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
566slightly in the future. 675slightly in the future.
567 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
568=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
569 685
570Called just after the new window size has been calculcated, but before 686Called just after the new window size has been calculated, but before
571windows are actually being resized or hints are being set. If this hook 687windows are actually being resized or hints are being set. If this hook
572returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
573 689
574=item on_x_event $term, $event 690=item on_x_event $term, $event
575 691
576Called 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
577windows). Should only be used as a last resort. Most event structure 693windows). Should only be used as a last resort. Most event structure
578members are not passed. 694members are not passed.
579 695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
699
580=item on_focus_in $term 700=item on_focus_in $term
581 701
582Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
583does focus in processing. 703does focus in processing.
584 704
585=item on_focus_out $term 705=item on_focus_out $term
586 706
587Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
588focus out processing. 708focus out processing.
589 709
590=item on_configure_notify $term, $event 710=item on_configure_notify $term, $event
591 711
592=item on_property_notify $term, $event 712=item on_property_notify $term, $event
603 723
604=item on_map_notify $term, $event 724=item on_map_notify $term, $event
605 725
606=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
607 727
608Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
609the 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.
610 730
611The 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
612manpage), 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
613(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
614 734
623 743
624=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
625 745
626Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
627format=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.
628 752
629=back 753=back
630 754
631=cut 755=cut
632 756
675The current terminal. This variable stores the current C<urxvt::term> 799The current terminal. This variable stores the current C<urxvt::term>
676object, whenever a callback/hook is executing. 800object, whenever a callback/hook is executing.
677 801
678=item @urxvt::TERM_INIT 802=item @urxvt::TERM_INIT
679 803
680All 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
681created 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
682gets cleared before the codereferences that were in it are being executed, 806gets cleared before the code references that were in it are being executed,
683so coderefs can push themselves onto it again if they so desire. 807so references can push themselves onto it again if they so desire.
684 808
685This complements to the perl-eval commandline option, but gets executed 809This complements to the perl-eval command line option, but gets executed
686first. 810first.
687 811
688=item @urxvt::TERM_EXT 812=item @urxvt::TERM_EXT
689 813
690Works 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
697 821
698=over 4 822=over 4
699 823
700=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
701 825
702Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
703costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
704starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
705 830
706=item urxvt::warn $string 831=item urxvt::warn $string
707 832
708Calls 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
709newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
710that calls this function. 835that calls this function.
711 836
712Using 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
713correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
715Messages have a size limit of 1023 bytes currently. 840Messages have a size limit of 1023 bytes currently.
716 841
717=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
718 843
719Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
720wether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
721objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
722is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
723 848
724=item $time = urxvt::NOW 849=item $time = urxvt::NOW
725 850
726Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
727 852
770 895
771=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
772 897
773Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
774 899
775=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
776 902
777Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
778underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
779the bitset. 905the bitset.
780 906
817 }; 943 };
818} 944}
819 945
820no warnings 'utf8'; 946no warnings 'utf8';
821 947
948sub resource {
949 my ($term, $name, $isarg, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 warn "resourece<@_>\n";#d#
954
955 0
956}
957
958sub usage {
959 my ($term, $usage_type) = @_;
960
961 $term->scan_meta;
962
963 my $r = $term->{meta}{resource};
964
965 for my $regex (sort keys %$r) {
966 my ($ext, $type, $desc) = @{ $r->{$regex} };
967
968 $desc .= " (-pe $ext)";
969
970 if ($usage_type == 1) {
971 if ($type eq "boolean") {
972 urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
973 } else {
974 urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
975 }
976 } else {
977 urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
978 }
979 }
980}
981
822my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
823 983
824sub verbose { 984sub verbose {
825 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
826 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
862sub invoke { 1022sub invoke {
863 local $TERM = shift; 1023 local $TERM = shift;
864 my $htype = shift; 1024 my $htype = shift;
865 1025
866 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
867 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
868 1028
869 my %ext_arg; 1029 my %ext_arg;
870 1030
871 { 1031 {
872 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
873 @TERM_INIT = (); 1033 @TERM_INIT = ();
936 1096
937sub SET_COLOR($$$) { 1097sub SET_COLOR($$$) {
938 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1098 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
939} 1099}
940 1100
1101sub rend2mask {
1102 no strict 'refs';
1103 my ($str, $mask) = (@_, 0);
1104 my %color = ( fg => undef, bg => undef );
1105 my @failed;
1106 for my $spec ( split /\s+/, $str ) {
1107 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1108 $color{lc($1)} = $2;
1109 } else {
1110 my $neg = $spec =~ s/^[-^]//;
1111 unless ( exists &{"RS_$spec"} ) {
1112 push @failed, $spec;
1113 next;
1114 }
1115 my $cur = &{"RS_$spec"};
1116 if ( $neg ) {
1117 $mask &= ~$cur;
1118 } else {
1119 $mask |= $cur;
1120 }
1121 }
1122 }
1123 ($mask, @color{qw(fg bg)}, \@failed)
1124}
1125
941# urxvt::term::extension 1126# urxvt::term::extension
942 1127
943package urxvt::term::extension; 1128package urxvt::term::extension;
944 1129
945sub enable { 1130sub enable {
1014is that you cannot use blocking APIs, but the non-blocking variant should 1199is that you cannot use blocking APIs, but the non-blocking variant should
1015work. 1200work.
1016 1201
1017=cut 1202=cut
1018 1203
1019our $VERSION = 1; 1204our $VERSION = '5.23';
1020 1205
1021$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1206$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1022push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1207push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1023 1208
1024sub timer { 1209sub timer {
1026 1211
1027 my $cb = $arg{cb}; 1212 my $cb = $arg{cb};
1028 1213
1029 urxvt::timer 1214 urxvt::timer
1030 ->new 1215 ->new
1031 ->start (urxvt::NOW + $arg{after}) 1216 ->after ($arg{after}, $arg{interval})
1032 ->cb (sub { 1217 ->cb ($arg{interval} ? $cb : sub {
1033 $_[0]->stop; # need to cancel manually 1218 $_[0]->stop; # need to cancel manually
1034 $cb->(); 1219 $cb->();
1035 }) 1220 })
1036} 1221}
1037 1222
1038sub io { 1223sub io {
1039 my ($class, %arg) = @_; 1224 my ($class, %arg) = @_;
1040 1225
1041 my $cb = $arg{cb}; 1226 my $cb = $arg{cb};
1227 my $fd = fileno $arg{fh};
1228 defined $fd or $fd = $arg{fh};
1042 1229
1043 bless [$arg{fh}, urxvt::iow 1230 bless [$arg{fh}, urxvt::iow
1044 ->new 1231 ->new
1045 ->fd (fileno $arg{fh}) 1232 ->fd ($fd)
1046 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1233 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1047 | ($arg{poll} =~ /w/ ? 2 : 0)) 1234 | ($arg{poll} =~ /w/ ? 2 : 0))
1048 ->start 1235 ->start
1049 ->cb (sub { 1236 ->cb ($cb)
1050 $cb->(($_[1] & 1 ? 'r' : '')
1051 . ($_[1] & 2 ? 'w' : ''));
1052 })],
1053 urxvt::anyevent:: 1237 ], urxvt::anyevent::
1238}
1239
1240sub idle {
1241 my ($class, %arg) = @_;
1242
1243 my $cb = $arg{cb};
1244
1245 urxvt::iw
1246 ->new
1247 ->start
1248 ->cb ($cb)
1249}
1250
1251sub child {
1252 my ($class, %arg) = @_;
1253
1254 my $cb = $arg{cb};
1255
1256 urxvt::pw
1257 ->new
1258 ->start ($arg{pid})
1259 ->cb (sub {
1260 $_[0]->stop; # need to cancel manually
1261 $cb->($_[0]->rpid, $_[0]->rstatus);
1262 })
1054} 1263}
1055 1264
1056sub DESTROY { 1265sub DESTROY {
1057 $_[0][1]->stop; 1266 $_[0][1]->stop;
1058} 1267}
1059 1268
1060sub condvar { 1269# only needed for AnyEvent < 6 compatibility
1061 bless \my $flag, urxvt::anyevent::condvar:: 1270sub one_event {
1062}
1063
1064sub urxvt::anyevent::condvar::broadcast {
1065 ${$_[0]}++;
1066}
1067
1068sub urxvt::anyevent::condvar::wait {
1069 unless (${$_[0]}) {
1070 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1271 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1071 }
1072} 1272}
1073 1273
1074package urxvt::term; 1274package urxvt::term;
1075 1275
1076=head2 The C<urxvt::term> Class 1276=head2 The C<urxvt::term> Class
1103 $proxy->enable ($name => $ref); 1303 $proxy->enable ($name => $ref);
1104 } 1304 }
1105 } 1305 }
1106} 1306}
1107 1307
1308sub perl_libdirs {
1309 map { split /:/ }
1310 $_[0]->resource ("perl_lib"),
1311 $ENV{URXVT_PERL_LIB},
1312 "$ENV{HOME}/.urxvt/ext",
1313 "$LIBDIR/perl"
1314}
1315
1316sub scan_meta {
1317 my ($self) = @_;
1318 my @libdirs = perl_libdirs $self;
1319
1320 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1321
1322 my %meta;
1323
1324 $self->{meta_libdirs} = join "\x00", @libdirs;
1325 $self->{meta} = \%meta;
1326
1327 for my $dir (reverse @libdirs) {
1328 opendir my $fh, $dir
1329 or next;
1330 for my $ext (readdir $fh) {
1331 $ext ne "."
1332 and $ext ne ".."
1333 and open my $fh, "<", "$dir/$ext"
1334 or next;
1335
1336 while (<$fh>) {
1337 if (/^#:META:RESOURCE:(.*)/) {
1338 my ($regex, $type, $desc) = split /:/, $1;
1339 $regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
1340 $meta{resource}{$regex} = [$ext, $type, $desc];
1341 } elsif (/^\s*(?:#|$)/) {
1342 # skip other comments and empty lines
1343 } else {
1344 last; # stop parsing on first non-empty non-comment line
1345 }
1346 }
1347 }
1348 }
1349}
1350
1108=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1351=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1109 1352
1110Creates a new terminal, very similar as if you had started it with system 1353Creates a new terminal, very similar as if you had started it with system
1111C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1354C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1112hash which defines the environment of the new terminal. 1355hash which defines the environment of the new terminal.
1163 1406
1164Returns true if the option specified by C<$optval> is enabled, and 1407Returns true if the option specified by C<$optval> is enabled, and
1165optionally change it. All option values are stored by name in the hash 1408optionally change it. All option values are stored by name in the hash
1166C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1409C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1167 1410
1168Here is a a likely non-exhaustive list of option names, please see the 1411Here is a likely non-exhaustive list of option names, please see the
1169source file F</src/optinc.h> to see the actual list: 1412source file F</src/optinc.h> to see the actual list:
1170 1413
1171 borderLess console cursorBlink cursorUnderline hold iconic insecure 1414 borderLess buffered console cursorBlink cursorUnderline hold iconic
1172 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1415 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1173 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1416 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1174 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1417 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1175 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1418 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1176 transparent tripleclickwords utmpInhibit visualBell 1419 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1420 urgentOnBell utmpInhibit visualBell
1177 1421
1178=item $value = $term->resource ($name[, $newval]) 1422=item $value = $term->resource ($name[, $newval])
1179 1423
1180Returns the current resource value associated with a given name and 1424Returns the current resource value associated with a given name and
1181optionally sets a new value. Setting values is most useful in the C<init> 1425optionally sets a new value. Setting values is most useful in the C<init>
1190likely change). 1434likely change).
1191 1435
1192Please note that resource strings will currently only be freed when the 1436Please note that resource strings will currently only be freed when the
1193terminal is destroyed, so changing options frequently will eat memory. 1437terminal is destroyed, so changing options frequently will eat memory.
1194 1438
1195Here is a a likely non-exhaustive list of resource names, not all of which 1439Here is a likely non-exhaustive list of resource names, not all of which
1196are supported in every build, please see the source file F</src/rsinc.h> 1440are supported in every build, please see the source file F</src/rsinc.h>
1197to see the actual list: 1441to see the actual list:
1198 1442
1199 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1443 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1200 borderLess color cursorBlink cursorUnderline cutchars delete_key 1444 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1201 display_name embed ext_bwidth fade font geometry hold iconName 1445 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1202 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1446 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1447 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1203 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1448 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1204 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1449 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1205 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1450 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1206 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1451 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1207 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1452 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1208 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1453 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1209 secondaryScreen secondaryScroll selectstyle shade term_name title 1454 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1210 transient_for transparent transparent_all tripleclickwords utmpInhibit 1455 term_name title transient_for transparent tripleclickwords urgentOnBell
1211 visualBell 1456 utmpInhibit visualBell
1212 1457
1213=cut 1458=cut
1214 1459
1215sub resource($$;$) { 1460sub resource($$;$) {
1216 my ($self, $name) = (shift, shift); 1461 my ($self, $name) = (shift, shift);
1217 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1462 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1218 &urxvt::term::_resource 1463 goto &urxvt::term::_resource
1219} 1464}
1220 1465
1221=item $value = $term->x_resource ($pattern) 1466=item $value = $term->x_resource ($pattern)
1222 1467
1223Returns the X-Resource for the given pattern, excluding the program or 1468Returns the X-Resource for the given pattern, excluding the program or
1227 1472
1228This method should only be called during the C<on_start> hook, as there is 1473This method should only be called during the C<on_start> hook, as there is
1229only one resource database per display, and later invocations might return 1474only one resource database per display, and later invocations might return
1230the wrong resources. 1475the wrong resources.
1231 1476
1232=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1477=item $success = $term->parse_keysym ($key, $octets)
1233 1478
1234Adds a keymap translation exactly as specified via a resource. See the 1479Adds a key binding exactly as specified via a resource. See the
1235C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1480C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1481
1482=item $term->register_command ($keysym, $modifiermask, $string)
1483
1484Adds a key binding. This is a lower level api compared to
1485C<parse_keysym>, as it expects a parsed key description, and can be
1486used only inside either the C<on_init> hook, to add a binding, or the
1487C<on_register_command> hook, to modify a parsed binding.
1236 1488
1237=item $rend = $term->rstyle ([$new_rstyle]) 1489=item $rend = $term->rstyle ([$new_rstyle])
1238 1490
1239Return and optionally change the current rendition. Text that is output by 1491Return and optionally change the current rendition. Text that is output by
1240the terminal application will use this style. 1492the terminal application will use this style.
1248 1500
1249=item ($row, $col) = $term->selection_beg ([$row, $col]) 1501=item ($row, $col) = $term->selection_beg ([$row, $col])
1250 1502
1251=item ($row, $col) = $term->selection_end ([$row, $col]) 1503=item ($row, $col) = $term->selection_end ([$row, $col])
1252 1504
1253Return the current values of the selection mark, begin or end positions, 1505Return the current values of the selection mark, begin or end positions.
1254and optionally set them to new values. 1506
1507When arguments are given, then the selection coordinates are set to
1508C<$row> and C<$col>, and the selection screen is set to the current
1509screen.
1510
1511=item $screen = $term->selection_screen ([$screen])
1512
1513Returns the current selection screen, and then optionally sets it.
1255 1514
1256=item $term->selection_make ($eventtime[, $rectangular]) 1515=item $term->selection_make ($eventtime[, $rectangular])
1257 1516
1258Tries to make a selection as set by C<selection_beg> and 1517Tries to make a selection as set by C<selection_beg> and
1259C<selection_end>. If C<$rectangular> is true (default: false), a 1518C<selection_end>. If C<$rectangular> is true (default: false), a
1260rectangular selection will be made. This is the prefered function to make 1519rectangular selection will be made. This is the preferred function to make
1261a selection. 1520a selection.
1262 1521
1263=item $success = $term->selection_grab ($eventtime) 1522=item $success = $term->selection_grab ($eventtime[, $clipboard])
1264 1523
1265Try to request the primary selection text from the server (for example, as 1524Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1525true) selection from the server. The corresponding text can be set
1266set by the next method). No visual feedback will be given. This function 1526with the next method. No visual feedback will be given. This function
1267is mostly useful from within C<on_sel_grab> hooks. 1527is mostly useful from within C<on_sel_grab> hooks.
1268 1528
1269=item $oldtext = $term->selection ([$newtext]) 1529=item $oldtext = $term->selection ([$newtext, $clipboard])
1270 1530
1271Return the current selection text and optionally replace it by C<$newtext>. 1531Return the current selection (clipboard if C<$clipboard> is true) text
1532and optionally replace it by C<$newtext>.
1533
1534=item $term->selection_clear ([$clipboard])
1535
1536Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1272 1537
1273=item $term->overlay_simple ($x, $y, $text) 1538=item $term->overlay_simple ($x, $y, $text)
1274 1539
1275Create a simple multi-line overlay box. See the next method for details. 1540Create a simple multi-line overlay box. See the next method for details.
1276 1541
1306 1571
1307The methods currently supported on C<urxvt::overlay> objects are: 1572The methods currently supported on C<urxvt::overlay> objects are:
1308 1573
1309=over 4 1574=over 4
1310 1575
1311=item $overlay->set ($x, $y, $text, $rend) 1576=item $overlay->set ($x, $y, $text[, $rend])
1312 1577
1313Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1578Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1314text in rxvt-unicode's special encoding and an array of rendition values 1579text in rxvt-unicode's special encoding and an array of rendition values
1315at a specific position inside the overlay. 1580at a specific position inside the overlay.
1581
1582If C<$rend> is missing, then the rendition will not be changed.
1316 1583
1317=item $overlay->hide 1584=item $overlay->hide
1318 1585
1319If visible, hide the overlay, but do not destroy it. 1586If visible, hide the overlay, but do not destroy it.
1320 1587
1402locale-specific encoding of the terminal and can contain command sequences 1669locale-specific encoding of the terminal and can contain command sequences
1403(escape codes) that will be interpreted. 1670(escape codes) that will be interpreted.
1404 1671
1405=item $term->tt_write ($octets) 1672=item $term->tt_write ($octets)
1406 1673
1407Write the octets given in C<$data> to the tty (i.e. as program input). To 1674Write the octets given in C<$octets> to the tty (i.e. as program input). To
1408pass characters instead of octets, you should convert your strings first 1675pass characters instead of octets, you should convert your strings first
1409to the locale-specific encoding using C<< $term->locale_encode >>. 1676to the locale-specific encoding using C<< $term->locale_encode >>.
1677
1678=item $term->tt_paste ($octets)
1679
1680Write the octets given in C<$octets> to the tty as a paste, converting NL to
1681CR and bracketing the data with control sequences if bracketed paste mode
1682is set.
1410 1683
1411=item $old_events = $term->pty_ev_events ([$new_events]) 1684=item $old_events = $term->pty_ev_events ([$new_events])
1412 1685
1413Replaces the event mask of the pty watcher by the given event mask. Can 1686Replaces the event mask of the pty watcher by the given event mask. Can
1414be used to suppress input and output handling to the pty/tty. See the 1687be used to suppress input and output handling to the pty/tty. See the
1433Adds the specified events to the vt event mask. Useful e.g. when you want 1706Adds the specified events to the vt event mask. Useful e.g. when you want
1434to receive pointer events all the times: 1707to receive pointer events all the times:
1435 1708
1436 $term->vt_emask_add (urxvt::PointerMotionMask); 1709 $term->vt_emask_add (urxvt::PointerMotionMask);
1437 1710
1711=item $term->set_urgency ($set)
1712
1713Enable/disable the urgency hint on the toplevel window.
1714
1438=item $term->focus_in 1715=item $term->focus_in
1439 1716
1440=item $term->focus_out 1717=item $term->focus_out
1441 1718
1442=item $term->key_press ($state, $keycode[, $time]) 1719=item $term->key_press ($state, $keycode[, $time])
1512 1789
1513Returns the currently displayed screen (0 primary, 1 secondary). 1790Returns the currently displayed screen (0 primary, 1 secondary).
1514 1791
1515=item $cursor_is_hidden = $term->hidden_cursor 1792=item $cursor_is_hidden = $term->hidden_cursor
1516 1793
1517Returns wether the cursor is currently hidden or not. 1794Returns whether the cursor is currently hidden or not.
1518 1795
1519=item $view_start = $term->view_start ([$newvalue]) 1796=item $view_start = $term->view_start ([$newvalue])
1520 1797
1521Returns the row number of the topmost displayed line. Maximum value is 1798Returns the row number of the topmost displayed line. Maximum value is
1522C<0>, which displays the normal terminal contents. Lower values scroll 1799C<0>, which displays the normal terminal contents. Lower values scroll
1530 1807
1531Used after changing terminal contents to display them. 1808Used after changing terminal contents to display them.
1532 1809
1533=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1810=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1534 1811
1535Returns the text of the entire row with number C<$row_number>. Row C<0> 1812Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1536is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1813is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1537terminal line. The scrollback buffer starts at line C<-1> and extends to
1538line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1814terminal line. Nothing will be returned if a nonexistent line
1539is requested. 1815is requested.
1540 1816
1541If C<$new_text> is specified, it will replace characters in the current 1817If C<$new_text> is specified, it will replace characters in the current
1542line, starting at column C<$start_col> (default C<0>), which is useful 1818line, starting at column C<$start_col> (default C<0>), which is useful
1543to replace only parts of a line. The font index in the rendition will 1819to replace only parts of a line. The font index in the rendition will
1544automatically be updated. 1820automatically be updated.
1545 1821
1546C<$text> is in a special encoding: tabs and wide characters that use more 1822C<$text> is in a special encoding: tabs and wide characters that use more
1547than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1823than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1548characters. Characters with combining characters and other characters that 1824characters. Characters with combining characters and other characters that
1549do not fit into the normal tetx encoding will be replaced with characters 1825do not fit into the normal text encoding will be replaced with characters
1550in the private use area. 1826in the private use area.
1551 1827
1552You have to obey this encoding when changing text. The advantage is 1828You have to obey this encoding when changing text. The advantage is
1553that C<substr> and similar functions work on screen cells and not on 1829that C<substr> and similar functions work on screen cells and not on
1554characters. 1830characters.
1699where one character corresponds to one screen cell. See 1975where one character corresponds to one screen cell. See
1700C<< $term->ROW_t >> for details. 1976C<< $term->ROW_t >> for details.
1701 1977
1702=item $string = $term->special_decode $text 1978=item $string = $term->special_decode $text
1703 1979
1704Converts rxvt-unicodes text reprsentation into a perl string. See 1980Converts rxvt-unicodes text representation into a perl string. See
1705C<< $term->ROW_t >> for details. 1981C<< $term->ROW_t >> for details.
1706 1982
1707=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1983=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1708 1984
1709=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1985=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1712manpage. 1988manpage.
1713 1989
1714=item $success = $term->grab ($eventtime[, $sync]) 1990=item $success = $term->grab ($eventtime[, $sync])
1715 1991
1716Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1992Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1717synchronous (C<$sync> is true). Also remembers the grab timestampe. 1993synchronous (C<$sync> is true). Also remembers the grab timestamp.
1718 1994
1719=item $term->allow_events_async 1995=item $term->allow_events_async
1720 1996
1721Calls XAllowEvents with AsyncBoth for the most recent grab. 1997Calls XAllowEvents with AsyncBoth for the most recent grab.
1722 1998
1729Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2005Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1730recent grab. 2006recent grab.
1731 2007
1732=item $term->ungrab 2008=item $term->ungrab
1733 2009
1734Calls XUngrab for the most recent grab. Is called automatically on 2010Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1735evaluation errors, as it is better to lose the grab in the error case as 2011evaluation errors, as it is better to lose the grab in the error case as
1736the session. 2012the session.
1737 2013
1738=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2014=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1739 2015
1741 2017
1742=item @atoms = $term->XListProperties ($window) 2018=item @atoms = $term->XListProperties ($window)
1743 2019
1744=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 2020=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1745 2021
1746=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 2022=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1747 2023
1748=item $term->XDeleteProperty ($window, $property) 2024=item $term->XDeleteProperty ($window, $property)
1749 2025
1750=item $window = $term->DefaultRootWindow 2026=item $window = $term->DefaultRootWindow
1751 2027
1758=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2034=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1759 2035
1760=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2036=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1761 2037
1762=item $term->XChangeInput ($window, $add_events[, $del_events]) 2038=item $term->XChangeInput ($window, $add_events[, $del_events])
2039
2040=item $keysym = $term->XStringToKeysym ($string)
2041
2042=item $string = $term->XKeysymToString ($keysym)
1763 2043
1764Various X or X-related functions. The C<$term> object only serves as 2044Various X or X-related functions. The C<$term> object only serves as
1765the source of the display, otherwise those functions map more-or-less 2045the source of the display, otherwise those functions map more-or-less
1766directory onto the X functions of the same name. 2046directly onto the X functions of the same name.
1767 2047
1768=back 2048=back
1769 2049
1770=cut 2050=cut
1771 2051
1873 my $env = $self->{term}->env; 2153 my $env = $self->{term}->env;
1874 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2154 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1875 delete $env->{LC_ALL}; 2155 delete $env->{LC_ALL};
1876 $env->{LC_CTYPE} = $self->{term}->locale; 2156 $env->{LC_CTYPE} = $self->{term}->locale;
1877 2157
1878 urxvt::term->new ($env, "popup", 2158 my $term = urxvt::term->new (
2159 $env, "popup",
1879 "--perl-lib" => "", "--perl-ext-common" => "", 2160 "--perl-lib" => "", "--perl-ext-common" => "",
1880 "-pty-fd" => -1, "-sl" => 0, 2161 "-pty-fd" => -1, "-sl" => 0,
1881 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2162 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1882 "--transient-for" => $self->{term}->parent, 2163 "--transient-for" => $self->{term}->parent,
1883 "-display" => $self->{term}->display_id, 2164 "-display" => $self->{term}->display_id,
1884 "-pe" => "urxvt-popup") 2165 "-pe" => "urxvt-popup",
1885 or die "unable to create popup window\n"; 2166 ) or die "unable to create popup window\n";
2167
2168 unless (delete $term->{urxvt_popup_init_done}) {
2169 $term->ungrab;
2170 $term->destroy;
2171 die "unable to initialise popup window\n";
2172 }
1886} 2173}
1887 2174
1888sub DESTROY { 2175sub DESTROY {
1889 my ($self) = @_; 2176 my ($self) = @_;
1890 2177
1895=back 2182=back
1896 2183
1897=cut 2184=cut
1898 2185
1899package urxvt::watcher; 2186package urxvt::watcher;
1900
1901@urxvt::timer::ISA = __PACKAGE__;
1902@urxvt::iow::ISA = __PACKAGE__;
1903@urxvt::pw::ISA = __PACKAGE__;
1904@urxvt::iw::ISA = __PACKAGE__;
1905 2187
1906=head2 The C<urxvt::timer> Class 2188=head2 The C<urxvt::timer> Class
1907 2189
1908This class implements timer watchers/events. Time is represented as a 2190This class implements timer watchers/events. Time is represented as a
1909fractional number of seconds since the epoch. Example: 2191fractional number of seconds since the epoch. Example:
1913 ->new 2195 ->new
1914 ->interval (1) 2196 ->interval (1)
1915 ->cb (sub { 2197 ->cb (sub {
1916 $term->{overlay}->set (0, 0, 2198 $term->{overlay}->set (0, 0,
1917 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2199 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1918 }); 2200 });
1919 2201
1920=over 4 2202=over 4
1921 2203
1922=item $timer = new urxvt::timer 2204=item $timer = new urxvt::timer
1923 2205
1926 2208
1927=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2209=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1928 2210
1929Set the callback to be called when the timer triggers. 2211Set the callback to be called when the timer triggers.
1930 2212
1931=item $tstamp = $timer->at
1932
1933Return the time this watcher will fire next.
1934
1935=item $timer = $timer->set ($tstamp) 2213=item $timer = $timer->set ($tstamp[, $interval])
1936 2214
1937Set the time the event is generated to $tstamp. 2215Set the time the event is generated to $tstamp (and optionally specifies a
2216new $interval).
1938 2217
1939=item $timer = $timer->interval ($interval) 2218=item $timer = $timer->interval ($interval)
1940 2219
1941Normally (and when C<$interval> is C<0>), the timer will automatically 2220By default (and when C<$interval> is C<0>), the timer will automatically
1942stop after it has fired once. If C<$interval> is non-zero, then the timer 2221stop after it has fired once. If C<$interval> is non-zero, then the timer
1943is automatically rescheduled at the given intervals. 2222is automatically rescheduled at the given intervals.
1944 2223
1945=item $timer = $timer->start 2224=item $timer = $timer->start
1946 2225
1947Start the timer. 2226Start the timer.
1948 2227
1949=item $timer = $timer->start ($tstamp) 2228=item $timer = $timer->start ($tstamp[, $interval])
1950 2229
1951Set the event trigger time to C<$tstamp> and start the timer. 2230Set the event trigger time to C<$tstamp> and start the timer. Optionally
2231also replaces the interval.
1952 2232
1953=item $timer = $timer->after ($delay) 2233=item $timer = $timer->after ($delay[, $interval])
1954 2234
1955Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2235Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1956 2236
1957=item $timer = $timer->stop 2237=item $timer = $timer->stop
1958 2238
1966 2246
1967 $term->{socket} = ... 2247 $term->{socket} = ...
1968 $term->{iow} = urxvt::iow 2248 $term->{iow} = urxvt::iow
1969 ->new 2249 ->new
1970 ->fd (fileno $term->{socket}) 2250 ->fd (fileno $term->{socket})
1971 ->events (urxvt::EVENT_READ) 2251 ->events (urxvt::EV_READ)
1972 ->start 2252 ->start
1973 ->cb (sub { 2253 ->cb (sub {
1974 my ($iow, $revents) = @_; 2254 my ($iow, $revents) = @_;
1975 # $revents must be 1 here, no need to check 2255 # $revents must be 1 here, no need to check
1976 sysread $term->{socket}, my $buf, 8192 2256 sysread $term->{socket}, my $buf, 8192
1989Set the callback to be called when io events are triggered. C<$reventmask> 2269Set the callback to be called when io events are triggered. C<$reventmask>
1990is a bitset as described in the C<events> method. 2270is a bitset as described in the C<events> method.
1991 2271
1992=item $iow = $iow->fd ($fd) 2272=item $iow = $iow->fd ($fd)
1993 2273
1994Set the filedescriptor (not handle) to watch. 2274Set the file descriptor (not handle) to watch.
1995 2275
1996=item $iow = $iow->events ($eventmask) 2276=item $iow = $iow->events ($eventmask)
1997 2277
1998Set the event mask to watch. The only allowed values are 2278Set the event mask to watch. The only allowed values are
1999C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2279C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2000together, or C<urxvt::EVENT_NONE>. 2280together, or C<urxvt::EV_NONE>.
2001 2281
2002=item $iow = $iow->start 2282=item $iow = $iow->start
2003 2283
2004Start watching for requested events on the given handle. 2284Start watching for requested events on the given handle.
2005 2285
2006=item $iow = $iow->stop 2286=item $iow = $iow->stop
2007 2287
2008Stop watching for events on the given filehandle. 2288Stop watching for events on the given file handle.
2009 2289
2010=back 2290=back
2011 2291
2012=head2 The C<urxvt::iw> Class 2292=head2 The C<urxvt::iw> Class
2013 2293
2046 ->new 2326 ->new
2047 ->start ($pid) 2327 ->start ($pid)
2048 ->cb (sub { 2328 ->cb (sub {
2049 my ($pw, $exit_status) = @_; 2329 my ($pw, $exit_status) = @_;
2050 ... 2330 ...
2051 }); 2331 });
2052 2332
2053=over 4 2333=over 4
2054 2334
2055=item $pw = new urxvt::pw 2335=item $pw = new urxvt::pw
2056 2336
2060 2340
2061Set the callback to be called when the timer triggers. 2341Set the callback to be called when the timer triggers.
2062 2342
2063=item $pw = $timer->start ($pid) 2343=item $pw = $timer->start ($pid)
2064 2344
2065Tells the wqtcher to start watching for process C<$pid>. 2345Tells the watcher to start watching for process C<$pid>.
2066 2346
2067=item $pw = $pw->stop 2347=item $pw = $pw->stop
2068 2348
2069Stop the watcher. 2349Stop the watcher.
2070 2350
2083 2363
2084=item >= 3 - script loading and management 2364=item >= 3 - script loading and management
2085 2365
2086=item >=10 - all called hooks 2366=item >=10 - all called hooks
2087 2367
2088=item >=11 - hook reutrn values 2368=item >=11 - hook return values
2089 2369
2090=back 2370=back
2091 2371
2092=head1 AUTHOR 2372=head1 AUTHOR
2093 2373
2094 Marc Lehmann <pcg@goof.com> 2374 Marc Lehmann <schmorp@schmorp.de>
2095 http://software.schmorp.de/pkg/rxvt-unicode 2375 http://software.schmorp.de/pkg/rxvt-unicode
2096 2376
2097=cut 2377=cut
2098 2378
20991 23791
2380
2381# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines