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.142 by root, Thu Jul 6 18:56:10 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.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the 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
166move 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
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
220the message into vi commands to load the file. 223the message into vi commands to load the file.
221 224
222=item tabbed 225=item tabbed
223 226
224This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
225is, 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
226displays 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
227button per tab. 230button per tab.
228 231
229Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
230B<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,
240 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
241 244
242See 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
243indices. 246indices.
244 247
245=item mark-urls 248=item matcher
246 249
247Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
248make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
249resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
250the 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
251 278
252=item xim-onthespot 279=item xim-onthespot
253 280
254This (experimental) perl extension implements OnTheSpot editing. It does 281This (experimental) perl extension implements OnTheSpot editing. It does
255not 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
256OnTheSpot 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
257kinput2. 284kinput2.
258 285
259You enable it by specifying this extension and a preedit style of 286You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.: 287C<OnTheSpot>, i.e.:
261 288
262 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263 290
264=item automove-background 291=item kuake<hotkey>
265 292
266This is basically a very small extension that dynamically changes the 293A very primitive quake-console-like extension. It was inspired by a
267background pixmap offset to the window position, in effect creating the 294description of how the programs C<kuake> and C<yakuake> work: Whenever the
268same effect as pseudo transparency with a custom pixmap. No scaling is 295user presses a global accelerator key (by default C<F10>), the terminal
269supported in this mode. Exmaple: 296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
270 298
271 @@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.
272 315
273=item block-graphics-to-ascii 316=item block-graphics-to-ascii
274 317
275A 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
276by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
281Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
282 325
283=item remote-clipboard 326=item remote-clipboard
284 327
285Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
286selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
287selection somewhere and fetch it again. 330selection somewhere and fetch it again.
288 331
289We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
290means 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
291reads it. 334reads it.
300 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
301 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
302 345
303=item selection-pastebin 346=item selection-pastebin
304 347
305This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
306textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
307not 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
308F</tmp> directly.). 351F</tmp> directly.).
309 352
310It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
327in the C<selection-pastebin-url> resource (again, the % is the placeholder 370in the C<selection-pastebin-url> resource (again, the % is the placeholder
328for the filename): 371for the filename):
329 372
330 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
331 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
332=item example-refresh-hooks 394=item example-refresh-hooks
333 395
334Displays 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
335window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
336overlays 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"
337 412
338=back 413=back
339 414
340=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
341 416
357 432
358=over 4 433=over 4
359 434
360=item $text 435=item $text
361 436
362Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
363always 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.
364 439
365=item $string 440=item $string
366 441
367A 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
371=item $octets 446=item $octets
372 447
373Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
374locale-specific way. 449locale-specific way.
375 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
376=back 457=back
377 458
378=head2 Extension Objects 459=head2 Extension Objects
379 460
380Every 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
381for 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,
382hooks. 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
383about 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
384begin with an underscore character C<_>: these are reserved for internal 466that begin with an underscore character C<_>: these are reserved for
385use. 467internal use.
386 468
387Although 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
388C<urxvt::term> class on this object. 470C<urxvt::term> class on this object.
389 471
390It has the following methods and data members: 472It has the following methods and data members:
411=head2 Hooks 493=head2 Hooks
412 494
413The following subroutines can be declared in extension files, and will be 495The following subroutines can be declared in extension files, and will be
414called whenever the relevant event happens. 496called whenever the relevant event happens.
415 497
416The 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
417the in the C<Extension Objects> section. 499the in the C<Extension Objects> section.
418 500
419B<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
420hooks 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
421relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
434place. 516place.
435 517
436=item on_start $term 518=item on_start $term
437 519
438Called 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
439trying to map (display) the toplevel and returning to the mainloop. 521trying to map (display) the toplevel and returning to the main loop.
440 522
441=item on_destroy $term 523=item on_destroy $term
442 524
443Called whenever something tries to destroy terminal, when the terminal is 525Called whenever something tries to destroy terminal, when the terminal is
444still fully functional (not for long, though). 526still fully functional (not for long, though).
471 553
472Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
473requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
474by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
475 557
476Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
477 559
478=item on_sel_extend $term 560=item on_sel_extend $term
479 561
480Called 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
481click) and is either supposed to return false (normal operation), or 563click) and is either supposed to return false (normal operation), or
482should 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
483processing. This can happen multiple times, as long as the callback 565processing. This can happen multiple times, as long as the callback
484returns 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
485supposed to enlarge the selection more and more, if possible. 567supposed to enlarge the selection more and more, if possible.
486 568
487See the F<selection> example extension. 569See the F<selection> example extension.
488 570
489=item on_view_change $term, $offset 571=item on_view_change $term, $offset
490 572
491Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
492scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
493show this many lines of scrollback. 575show this many lines of scrollback.
494 576
495=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
496 578
500 582
501It 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,
502$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
503number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
504 586
505=item on_osc_seq $term, $op, $args 587=item on_osc_seq $term, $op, $args, $resp
506 588
507Called 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
508behaviour. 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
509suppresses execution of the request completely. Make sure you don't get 591suppresses execution of the request completely. Make sure you don't get
510confused by recursive invocations when you output an osc sequence within 592confused by recursive invocations when you output an OSC sequence within
511this callback. 593this callback.
512 594
513C<on_osc_seq_perl> should be used for new behaviour. 595C<on_osc_seq_perl> should be used for new behaviour.
514 596
515=item on_osc_seq_perl $term, $string 597=item on_osc_seq_perl $term, $args, $resp
516 598
517Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
518operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
519information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
520string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
521it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
522future. 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 }
523 615
524Be 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,
525as 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
526other 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.
527 622
528=item on_add_lines $term, $string 623=item on_add_lines $term, $string
529 624
530Called 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
531can 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
536=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
537 632
538Called 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
539suppress or filter tty input. 634suppress or filter tty input.
540 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
541=item on_line_update $term, $row 643=item on_line_update $term, $row
542 644
543Called 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
544screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
545that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
552later 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
553you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
554 656
555=item on_refresh_begin $term 657=item on_refresh_begin $term
556 658
557Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
558or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
559restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
560code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
561 663
562=item on_refresh_end $term 664=item on_refresh_end $term
563 665
564Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
565 667
566=item on_user_command $term, $string 668=item on_user_command $term, $string
567 669
568Called whenever the a user-configured event is being activated (e.g. via 670Called whenever a user-configured event is being activated (e.g. via
569a 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>
570resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
571 673
572The 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
573slightly in the future. 675slightly in the future.
574 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
575=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
576 685
577Called just after the new window size has been calculcated, but before 686Called just after the new window size has been calculated, but before
578windows 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
579returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
580 689
581=item on_x_event $term, $event 690=item on_x_event $term, $event
582 691
583Called 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
584windows). Should only be used as a last resort. Most event structure 693windows). Should only be used as a last resort. Most event structure
585members are not passed. 694members are not passed.
586 695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
699
587=item on_focus_in $term 700=item on_focus_in $term
588 701
589Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
590does focus in processing. 703does focus in processing.
591 704
592=item on_focus_out $term 705=item on_focus_out $term
593 706
594Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
595focus out processing. 708focus out processing.
596 709
597=item on_configure_notify $term, $event 710=item on_configure_notify $term, $event
598 711
599=item on_property_notify $term, $event 712=item on_property_notify $term, $event
610 723
611=item on_map_notify $term, $event 724=item on_map_notify $term, $event
612 725
613=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
614 727
615Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
616the 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.
617 730
618The 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
619manpage), 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
620(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
621 734
630 743
631=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
632 745
633Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
634format=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.
635 752
636=back 753=back
637 754
638=cut 755=cut
639 756
682The current terminal. This variable stores the current C<urxvt::term> 799The current terminal. This variable stores the current C<urxvt::term>
683object, whenever a callback/hook is executing. 800object, whenever a callback/hook is executing.
684 801
685=item @urxvt::TERM_INIT 802=item @urxvt::TERM_INIT
686 803
687All 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
688created 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
689gets cleared before the codereferences that were in it are being executed, 806gets cleared before the code references that were in it are being executed,
690so coderefs can push themselves onto it again if they so desire. 807so references can push themselves onto it again if they so desire.
691 808
692This complements to the perl-eval commandline option, but gets executed 809This complements to the perl-eval command line option, but gets executed
693first. 810first.
694 811
695=item @urxvt::TERM_EXT 812=item @urxvt::TERM_EXT
696 813
697Works 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
704 821
705=over 4 822=over 4
706 823
707=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
708 825
709Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
710costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
711starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
712 830
713=item urxvt::warn $string 831=item urxvt::warn $string
714 832
715Calls 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
716newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
717that calls this function. 835that calls this function.
718 836
719Using 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
720correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
722Messages have a size limit of 1023 bytes currently. 840Messages have a size limit of 1023 bytes currently.
723 841
724=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
725 843
726Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
727wether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
728objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
729is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
730 848
731=item $time = urxvt::NOW 849=item $time = urxvt::NOW
732 850
733Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
734 852
777 895
778=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
779 897
780Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
781 899
782=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
783 902
784Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
785underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
786the bitset. 905the bitset.
787 906
824 }; 943 };
825} 944}
826 945
827no warnings 'utf8'; 946no warnings 'utf8';
828 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
829my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
830 983
831sub verbose { 984sub verbose {
832 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
833 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
869sub invoke { 1022sub invoke {
870 local $TERM = shift; 1023 local $TERM = shift;
871 my $htype = shift; 1024 my $htype = shift;
872 1025
873 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
874 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
875 1028
876 my %ext_arg; 1029 my %ext_arg;
877 1030
878 { 1031 {
879 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
880 @TERM_INIT = (); 1033 @TERM_INIT = ();
943 1096
944sub SET_COLOR($$$) { 1097sub SET_COLOR($$$) {
945 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1098 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
946} 1099}
947 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
948# urxvt::term::extension 1126# urxvt::term::extension
949 1127
950package urxvt::term::extension; 1128package urxvt::term::extension;
951 1129
952sub enable { 1130sub enable {
1021is 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
1022work. 1200work.
1023 1201
1024=cut 1202=cut
1025 1203
1026our $VERSION = 1; 1204our $VERSION = '5.23';
1027 1205
1028$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1206$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1029push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1207push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1030 1208
1031sub timer { 1209sub timer {
1033 1211
1034 my $cb = $arg{cb}; 1212 my $cb = $arg{cb};
1035 1213
1036 urxvt::timer 1214 urxvt::timer
1037 ->new 1215 ->new
1038 ->start (urxvt::NOW + $arg{after}) 1216 ->after ($arg{after}, $arg{interval})
1039 ->cb (sub { 1217 ->cb ($arg{interval} ? $cb : sub {
1040 $_[0]->stop; # need to cancel manually 1218 $_[0]->stop; # need to cancel manually
1041 $cb->(); 1219 $cb->();
1042 }) 1220 })
1043} 1221}
1044 1222
1045sub io { 1223sub io {
1046 my ($class, %arg) = @_; 1224 my ($class, %arg) = @_;
1047 1225
1048 my $cb = $arg{cb}; 1226 my $cb = $arg{cb};
1227 my $fd = fileno $arg{fh};
1228 defined $fd or $fd = $arg{fh};
1049 1229
1050 bless [$arg{fh}, urxvt::iow 1230 bless [$arg{fh}, urxvt::iow
1051 ->new 1231 ->new
1052 ->fd (fileno $arg{fh}) 1232 ->fd ($fd)
1053 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1233 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1054 | ($arg{poll} =~ /w/ ? 2 : 0)) 1234 | ($arg{poll} =~ /w/ ? 2 : 0))
1055 ->start 1235 ->start
1056 ->cb (sub { 1236 ->cb ($cb)
1057 $cb->(($_[1] & 1 ? 'r' : '')
1058 . ($_[1] & 2 ? 'w' : ''));
1059 })],
1060 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 })
1061} 1263}
1062 1264
1063sub DESTROY { 1265sub DESTROY {
1064 $_[0][1]->stop; 1266 $_[0][1]->stop;
1065} 1267}
1066 1268
1067sub condvar { 1269# only needed for AnyEvent < 6 compatibility
1068 bless \my $flag, urxvt::anyevent::condvar:: 1270sub one_event {
1069}
1070
1071sub urxvt::anyevent::condvar::broadcast {
1072 ${$_[0]}++;
1073}
1074
1075sub urxvt::anyevent::condvar::wait {
1076 unless (${$_[0]}) {
1077 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";
1078 }
1079} 1272}
1080 1273
1081package urxvt::term; 1274package urxvt::term;
1082 1275
1083=head2 The C<urxvt::term> Class 1276=head2 The C<urxvt::term> Class
1110 $proxy->enable ($name => $ref); 1303 $proxy->enable ($name => $ref);
1111 } 1304 }
1112 } 1305 }
1113} 1306}
1114 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
1115=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1351=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1116 1352
1117Creates 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
1118C<$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
1119hash which defines the environment of the new terminal. 1355hash which defines the environment of the new terminal.
1170 1406
1171Returns true if the option specified by C<$optval> is enabled, and 1407Returns true if the option specified by C<$optval> is enabled, and
1172optionally 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
1173C<%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.
1174 1410
1175Here 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
1176source file F</src/optinc.h> to see the actual list: 1412source file F</src/optinc.h> to see the actual list:
1177 1413
1178 borderLess console cursorBlink cursorUnderline hold iconic insecure 1414 borderLess buffered console cursorBlink cursorUnderline hold iconic
1179 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1415 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1180 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1416 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1181 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1417 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1182 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1418 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1183 transparent tripleclickwords utmpInhibit visualBell 1419 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1420 urgentOnBell utmpInhibit visualBell
1184 1421
1185=item $value = $term->resource ($name[, $newval]) 1422=item $value = $term->resource ($name[, $newval])
1186 1423
1187Returns the current resource value associated with a given name and 1424Returns the current resource value associated with a given name and
1188optionally 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>
1197likely change). 1434likely change).
1198 1435
1199Please note that resource strings will currently only be freed when the 1436Please note that resource strings will currently only be freed when the
1200terminal is destroyed, so changing options frequently will eat memory. 1437terminal is destroyed, so changing options frequently will eat memory.
1201 1438
1202Here 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
1203are 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>
1204to see the actual list: 1441to see the actual list:
1205 1442
1206 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1443 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1207 borderLess color cursorBlink cursorUnderline cutchars delete_key 1444 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1208 display_name embed ext_bwidth fade font geometry hold iconName 1445 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1209 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
1210 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1448 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1211 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1449 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1212 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1450 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1213 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1451 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1214 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1452 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1215 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1453 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1216 secondaryScreen secondaryScroll selectstyle shade term_name title 1454 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1217 transient_for transparent transparent_all tripleclickwords utmpInhibit 1455 term_name title transient_for transparent tripleclickwords urgentOnBell
1218 visualBell 1456 utmpInhibit visualBell
1219 1457
1220=cut 1458=cut
1221 1459
1222sub resource($$;$) { 1460sub resource($$;$) {
1223 my ($self, $name) = (shift, shift); 1461 my ($self, $name) = (shift, shift);
1224 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1462 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1225 &urxvt::term::_resource 1463 goto &urxvt::term::_resource
1226} 1464}
1227 1465
1228=item $value = $term->x_resource ($pattern) 1466=item $value = $term->x_resource ($pattern)
1229 1467
1230Returns the X-Resource for the given pattern, excluding the program or 1468Returns the X-Resource for the given pattern, excluding the program or
1234 1472
1235This 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
1236only one resource database per display, and later invocations might return 1474only one resource database per display, and later invocations might return
1237the wrong resources. 1475the wrong resources.
1238 1476
1239=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1477=item $success = $term->parse_keysym ($key, $octets)
1240 1478
1241Adds a keymap translation exactly as specified via a resource. See the 1479Adds a key binding exactly as specified via a resource. See the
1242C<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.
1243 1488
1244=item $rend = $term->rstyle ([$new_rstyle]) 1489=item $rend = $term->rstyle ([$new_rstyle])
1245 1490
1246Return and optionally change the current rendition. Text that is output by 1491Return and optionally change the current rendition. Text that is output by
1247the terminal application will use this style. 1492the terminal application will use this style.
1255 1500
1256=item ($row, $col) = $term->selection_beg ([$row, $col]) 1501=item ($row, $col) = $term->selection_beg ([$row, $col])
1257 1502
1258=item ($row, $col) = $term->selection_end ([$row, $col]) 1503=item ($row, $col) = $term->selection_end ([$row, $col])
1259 1504
1260Return the current values of the selection mark, begin or end positions, 1505Return the current values of the selection mark, begin or end positions.
1261and 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.
1262 1514
1263=item $term->selection_make ($eventtime[, $rectangular]) 1515=item $term->selection_make ($eventtime[, $rectangular])
1264 1516
1265Tries to make a selection as set by C<selection_beg> and 1517Tries to make a selection as set by C<selection_beg> and
1266C<selection_end>. If C<$rectangular> is true (default: false), a 1518C<selection_end>. If C<$rectangular> is true (default: false), a
1267rectangular selection will be made. This is the prefered function to make 1519rectangular selection will be made. This is the preferred function to make
1268a selection. 1520a selection.
1269 1521
1270=item $success = $term->selection_grab ($eventtime) 1522=item $success = $term->selection_grab ($eventtime[, $clipboard])
1271 1523
1272Try 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
1273set by the next method). No visual feedback will be given. This function 1526with the next method. No visual feedback will be given. This function
1274is mostly useful from within C<on_sel_grab> hooks. 1527is mostly useful from within C<on_sel_grab> hooks.
1275 1528
1276=item $oldtext = $term->selection ([$newtext]) 1529=item $oldtext = $term->selection ([$newtext, $clipboard])
1277 1530
1278Return 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.
1279 1537
1280=item $term->overlay_simple ($x, $y, $text) 1538=item $term->overlay_simple ($x, $y, $text)
1281 1539
1282Create 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.
1283 1541
1313 1571
1314The methods currently supported on C<urxvt::overlay> objects are: 1572The methods currently supported on C<urxvt::overlay> objects are:
1315 1573
1316=over 4 1574=over 4
1317 1575
1318=item $overlay->set ($x, $y, $text, $rend) 1576=item $overlay->set ($x, $y, $text[, $rend])
1319 1577
1320Similar 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
1321text 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
1322at 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.
1323 1583
1324=item $overlay->hide 1584=item $overlay->hide
1325 1585
1326If visible, hide the overlay, but do not destroy it. 1586If visible, hide the overlay, but do not destroy it.
1327 1587
1409locale-specific encoding of the terminal and can contain command sequences 1669locale-specific encoding of the terminal and can contain command sequences
1410(escape codes) that will be interpreted. 1670(escape codes) that will be interpreted.
1411 1671
1412=item $term->tt_write ($octets) 1672=item $term->tt_write ($octets)
1413 1673
1414Write 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
1415pass characters instead of octets, you should convert your strings first 1675pass characters instead of octets, you should convert your strings first
1416to 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.
1417 1683
1418=item $old_events = $term->pty_ev_events ([$new_events]) 1684=item $old_events = $term->pty_ev_events ([$new_events])
1419 1685
1420Replaces 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
1421be 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
1440Adds 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
1441to receive pointer events all the times: 1707to receive pointer events all the times:
1442 1708
1443 $term->vt_emask_add (urxvt::PointerMotionMask); 1709 $term->vt_emask_add (urxvt::PointerMotionMask);
1444 1710
1711=item $term->set_urgency ($set)
1712
1713Enable/disable the urgency hint on the toplevel window.
1714
1445=item $term->focus_in 1715=item $term->focus_in
1446 1716
1447=item $term->focus_out 1717=item $term->focus_out
1448 1718
1449=item $term->key_press ($state, $keycode[, $time]) 1719=item $term->key_press ($state, $keycode[, $time])
1519 1789
1520Returns the currently displayed screen (0 primary, 1 secondary). 1790Returns the currently displayed screen (0 primary, 1 secondary).
1521 1791
1522=item $cursor_is_hidden = $term->hidden_cursor 1792=item $cursor_is_hidden = $term->hidden_cursor
1523 1793
1524Returns wether the cursor is currently hidden or not. 1794Returns whether the cursor is currently hidden or not.
1525 1795
1526=item $view_start = $term->view_start ([$newvalue]) 1796=item $view_start = $term->view_start ([$newvalue])
1527 1797
1528Returns the row number of the topmost displayed line. Maximum value is 1798Returns the row number of the topmost displayed line. Maximum value is
1529C<0>, which displays the normal terminal contents. Lower values scroll 1799C<0>, which displays the normal terminal contents. Lower values scroll
1537 1807
1538Used after changing terminal contents to display them. 1808Used after changing terminal contents to display them.
1539 1809
1540=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1810=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1541 1811
1542Returns 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 >>
1543is 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
1544terminal line. The scrollback buffer starts at line C<-1> and extends to
1545line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1814terminal line. Nothing will be returned if a nonexistent line
1546is requested. 1815is requested.
1547 1816
1548If 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
1549line, 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
1550to 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
1551automatically be updated. 1820automatically be updated.
1552 1821
1553C<$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
1554than 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)
1555characters. Characters with combining characters and other characters that 1824characters. Characters with combining characters and other characters that
1556do 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
1557in the private use area. 1826in the private use area.
1558 1827
1559You have to obey this encoding when changing text. The advantage is 1828You have to obey this encoding when changing text. The advantage is
1560that 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
1561characters. 1830characters.
1706where one character corresponds to one screen cell. See 1975where one character corresponds to one screen cell. See
1707C<< $term->ROW_t >> for details. 1976C<< $term->ROW_t >> for details.
1708 1977
1709=item $string = $term->special_decode $text 1978=item $string = $term->special_decode $text
1710 1979
1711Converts rxvt-unicodes text reprsentation into a perl string. See 1980Converts rxvt-unicodes text representation into a perl string. See
1712C<< $term->ROW_t >> for details. 1981C<< $term->ROW_t >> for details.
1713 1982
1714=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1983=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1715 1984
1716=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1985=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1719manpage. 1988manpage.
1720 1989
1721=item $success = $term->grab ($eventtime[, $sync]) 1990=item $success = $term->grab ($eventtime[, $sync])
1722 1991
1723Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1992Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1724synchronous (C<$sync> is true). Also remembers the grab timestampe. 1993synchronous (C<$sync> is true). Also remembers the grab timestamp.
1725 1994
1726=item $term->allow_events_async 1995=item $term->allow_events_async
1727 1996
1728Calls XAllowEvents with AsyncBoth for the most recent grab. 1997Calls XAllowEvents with AsyncBoth for the most recent grab.
1729 1998
1736Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2005Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1737recent grab. 2006recent grab.
1738 2007
1739=item $term->ungrab 2008=item $term->ungrab
1740 2009
1741Calls XUngrab for the most recent grab. Is called automatically on 2010Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1742evaluation 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
1743the session. 2012the session.
1744 2013
1745=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2014=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746 2015
1748 2017
1749=item @atoms = $term->XListProperties ($window) 2018=item @atoms = $term->XListProperties ($window)
1750 2019
1751=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 2020=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752 2021
1753=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 2022=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1754 2023
1755=item $term->XDeleteProperty ($window, $property) 2024=item $term->XDeleteProperty ($window, $property)
1756 2025
1757=item $window = $term->DefaultRootWindow 2026=item $window = $term->DefaultRootWindow
1758 2027
1765=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2034=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1766 2035
1767=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2036=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1768 2037
1769=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)
1770 2043
1771Various 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
1772the source of the display, otherwise those functions map more-or-less 2045the source of the display, otherwise those functions map more-or-less
1773directory onto the X functions of the same name. 2046directly onto the X functions of the same name.
1774 2047
1775=back 2048=back
1776 2049
1777=cut 2050=cut
1778 2051
1880 my $env = $self->{term}->env; 2153 my $env = $self->{term}->env;
1881 # 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.
1882 delete $env->{LC_ALL}; 2155 delete $env->{LC_ALL};
1883 $env->{LC_CTYPE} = $self->{term}->locale; 2156 $env->{LC_CTYPE} = $self->{term}->locale;
1884 2157
1885 urxvt::term->new ($env, "popup", 2158 my $term = urxvt::term->new (
2159 $env, "popup",
1886 "--perl-lib" => "", "--perl-ext-common" => "", 2160 "--perl-lib" => "", "--perl-ext-common" => "",
1887 "-pty-fd" => -1, "-sl" => 0, 2161 "-pty-fd" => -1, "-sl" => 0,
1888 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2162 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1889 "--transient-for" => $self->{term}->parent, 2163 "--transient-for" => $self->{term}->parent,
1890 "-display" => $self->{term}->display_id, 2164 "-display" => $self->{term}->display_id,
1891 "-pe" => "urxvt-popup") 2165 "-pe" => "urxvt-popup",
1892 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 }
1893} 2173}
1894 2174
1895sub DESTROY { 2175sub DESTROY {
1896 my ($self) = @_; 2176 my ($self) = @_;
1897 2177
1902=back 2182=back
1903 2183
1904=cut 2184=cut
1905 2185
1906package urxvt::watcher; 2186package urxvt::watcher;
1907
1908@urxvt::timer::ISA = __PACKAGE__;
1909@urxvt::iow::ISA = __PACKAGE__;
1910@urxvt::pw::ISA = __PACKAGE__;
1911@urxvt::iw::ISA = __PACKAGE__;
1912 2187
1913=head2 The C<urxvt::timer> Class 2188=head2 The C<urxvt::timer> Class
1914 2189
1915This class implements timer watchers/events. Time is represented as a 2190This class implements timer watchers/events. Time is represented as a
1916fractional number of seconds since the epoch. Example: 2191fractional number of seconds since the epoch. Example:
1920 ->new 2195 ->new
1921 ->interval (1) 2196 ->interval (1)
1922 ->cb (sub { 2197 ->cb (sub {
1923 $term->{overlay}->set (0, 0, 2198 $term->{overlay}->set (0, 0,
1924 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2199 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1925 }); 2200 });
1926 2201
1927=over 4 2202=over 4
1928 2203
1929=item $timer = new urxvt::timer 2204=item $timer = new urxvt::timer
1930 2205
1933 2208
1934=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2209=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1935 2210
1936Set the callback to be called when the timer triggers. 2211Set the callback to be called when the timer triggers.
1937 2212
1938=item $tstamp = $timer->at
1939
1940Return the time this watcher will fire next.
1941
1942=item $timer = $timer->set ($tstamp) 2213=item $timer = $timer->set ($tstamp[, $interval])
1943 2214
1944Set the time the event is generated to $tstamp. 2215Set the time the event is generated to $tstamp (and optionally specifies a
2216new $interval).
1945 2217
1946=item $timer = $timer->interval ($interval) 2218=item $timer = $timer->interval ($interval)
1947 2219
1948Normally (and when C<$interval> is C<0>), the timer will automatically 2220By default (and when C<$interval> is C<0>), the timer will automatically
1949stop 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
1950is automatically rescheduled at the given intervals. 2222is automatically rescheduled at the given intervals.
1951 2223
1952=item $timer = $timer->start 2224=item $timer = $timer->start
1953 2225
1954Start the timer. 2226Start the timer.
1955 2227
1956=item $timer = $timer->start ($tstamp) 2228=item $timer = $timer->start ($tstamp[, $interval])
1957 2229
1958Set 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.
1959 2232
1960=item $timer = $timer->after ($delay) 2233=item $timer = $timer->after ($delay[, $interval])
1961 2234
1962Like 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>.
1963 2236
1964=item $timer = $timer->stop 2237=item $timer = $timer->stop
1965 2238
1973 2246
1974 $term->{socket} = ... 2247 $term->{socket} = ...
1975 $term->{iow} = urxvt::iow 2248 $term->{iow} = urxvt::iow
1976 ->new 2249 ->new
1977 ->fd (fileno $term->{socket}) 2250 ->fd (fileno $term->{socket})
1978 ->events (urxvt::EVENT_READ) 2251 ->events (urxvt::EV_READ)
1979 ->start 2252 ->start
1980 ->cb (sub { 2253 ->cb (sub {
1981 my ($iow, $revents) = @_; 2254 my ($iow, $revents) = @_;
1982 # $revents must be 1 here, no need to check 2255 # $revents must be 1 here, no need to check
1983 sysread $term->{socket}, my $buf, 8192 2256 sysread $term->{socket}, my $buf, 8192
1996Set 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>
1997is a bitset as described in the C<events> method. 2270is a bitset as described in the C<events> method.
1998 2271
1999=item $iow = $iow->fd ($fd) 2272=item $iow = $iow->fd ($fd)
2000 2273
2001Set the filedescriptor (not handle) to watch. 2274Set the file descriptor (not handle) to watch.
2002 2275
2003=item $iow = $iow->events ($eventmask) 2276=item $iow = $iow->events ($eventmask)
2004 2277
2005Set the event mask to watch. The only allowed values are 2278Set the event mask to watch. The only allowed values are
2006C<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
2007together, or C<urxvt::EVENT_NONE>. 2280together, or C<urxvt::EV_NONE>.
2008 2281
2009=item $iow = $iow->start 2282=item $iow = $iow->start
2010 2283
2011Start watching for requested events on the given handle. 2284Start watching for requested events on the given handle.
2012 2285
2013=item $iow = $iow->stop 2286=item $iow = $iow->stop
2014 2287
2015Stop watching for events on the given filehandle. 2288Stop watching for events on the given file handle.
2016 2289
2017=back 2290=back
2018 2291
2019=head2 The C<urxvt::iw> Class 2292=head2 The C<urxvt::iw> Class
2020 2293
2053 ->new 2326 ->new
2054 ->start ($pid) 2327 ->start ($pid)
2055 ->cb (sub { 2328 ->cb (sub {
2056 my ($pw, $exit_status) = @_; 2329 my ($pw, $exit_status) = @_;
2057 ... 2330 ...
2058 }); 2331 });
2059 2332
2060=over 4 2333=over 4
2061 2334
2062=item $pw = new urxvt::pw 2335=item $pw = new urxvt::pw
2063 2336
2067 2340
2068Set the callback to be called when the timer triggers. 2341Set the callback to be called when the timer triggers.
2069 2342
2070=item $pw = $timer->start ($pid) 2343=item $pw = $timer->start ($pid)
2071 2344
2072Tells the wqtcher to start watching for process C<$pid>. 2345Tells the watcher to start watching for process C<$pid>.
2073 2346
2074=item $pw = $pw->stop 2347=item $pw = $pw->stop
2075 2348
2076Stop the watcher. 2349Stop the watcher.
2077 2350
2090 2363
2091=item >= 3 - script loading and management 2364=item >= 3 - script loading and management
2092 2365
2093=item >=10 - all called hooks 2366=item >=10 - all called hooks
2094 2367
2095=item >=11 - hook reutrn values 2368=item >=11 - hook return values
2096 2369
2097=back 2370=back
2098 2371
2099=head1 AUTHOR 2372=head1 AUTHOR
2100 2373
2101 Marc Lehmann <pcg@goof.com> 2374 Marc Lehmann <schmorp@schmorp.de>
2102 http://software.schmorp.de/pkg/rxvt-unicode 2375 http://software.schmorp.de/pkg/rxvt-unicode
2103 2376
2104=cut 2377=cut
2105 2378
21061 23791
2380
2381# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines