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.143 by root, Thu Jul 6 23:48:11 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
269will show or hide itself. Another press of the accelerator key will hide 296will show or hide itself. Another press of the accelerator key will hide
270or show it again. 297or show it again.
271 298
272Initially, the window will not be shown when using this extension. 299Initially, the window will not be shown when using this extension.
273 300
274This is useful if you need a single terminal thats not using any desktop 301This is useful if you need a single terminal that is not using any desktop
275space most of the time but is quickly available at the press of a key. 302space most of the time but is quickly available at the press of a key.
276 303
277The accelerator key is grabbed regardless of any modifers, so this 304The accelerator key is grabbed regardless of any modifiers, so this
278extension will actually grab a physical key just for this function. 305extension will actually grab a physical key just for this function.
279 306
280If you want a quake-like animation, tell your window manager to do so 307If you want a quake-like animation, tell your window manager to do so
281(fvwm can do it). 308(fvwm can do it).
282 309
283=item automove-background 310=item overlay-osc
284 311
285This is basically a very small extension that dynamically changes the 312This extension implements some OSC commands to display timed popups on the
286background pixmap offset to the window position, in effect creating the 313screen - useful for status displays from within scripts. You have to read
287same effect as pseudo transparency with a custom pixmap. No scaling is 314the sources for more info.
288supported in this mode. Exmaple:
289
290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
291 315
292=item block-graphics-to-ascii 316=item block-graphics-to-ascii
293 317
294A 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
295by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
300Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
301 325
302=item remote-clipboard 326=item remote-clipboard
303 327
304Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
305selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
306selection somewhere and fetch it again. 330selection somewhere and fetch it again.
307 331
308We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
309means 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
310reads it. 334reads it.
319 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321 345
322=item selection-pastebin 346=item selection-pastebin
323 347
324This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
325textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
326not 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
327F</tmp> directly.). 351F</tmp> directly.).
328 352
329It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
346in the C<selection-pastebin-url> resource (again, the % is the placeholder 370in the C<selection-pastebin-url> resource (again, the % is the placeholder
347for the filename): 371for the filename):
348 372
349 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350 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
351=item example-refresh-hooks 394=item example-refresh-hooks
352 395
353Displays 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
354window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
355overlays 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"
356 412
357=back 413=back
358 414
359=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
360 416
376 432
377=over 4 433=over 4
378 434
379=item $text 435=item $text
380 436
381Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
382always 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.
383 439
384=item $string 440=item $string
385 441
386A 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
390=item $octets 446=item $octets
391 447
392Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
393locale-specific way. 449locale-specific way.
394 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
395=back 457=back
396 458
397=head2 Extension Objects 459=head2 Extension Objects
398 460
399Every 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
400for 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,
401hooks. 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
402about 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
403begin with an underscore character C<_>: these are reserved for internal 466that begin with an underscore character C<_>: these are reserved for
404use. 467internal use.
405 468
406Although 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
407C<urxvt::term> class on this object. 470C<urxvt::term> class on this object.
408 471
409It has the following methods and data members: 472It has the following methods and data members:
430=head2 Hooks 493=head2 Hooks
431 494
432The following subroutines can be declared in extension files, and will be 495The following subroutines can be declared in extension files, and will be
433called whenever the relevant event happens. 496called whenever the relevant event happens.
434 497
435The 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
436the in the C<Extension Objects> section. 499the in the C<Extension Objects> section.
437 500
438B<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
439hooks 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
440relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
453place. 516place.
454 517
455=item on_start $term 518=item on_start $term
456 519
457Called 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
458trying to map (display) the toplevel and returning to the mainloop. 521trying to map (display) the toplevel and returning to the main loop.
459 522
460=item on_destroy $term 523=item on_destroy $term
461 524
462Called whenever something tries to destroy terminal, when the terminal is 525Called whenever something tries to destroy terminal, when the terminal is
463still fully functional (not for long, though). 526still fully functional (not for long, though).
490 553
491Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
492requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
493by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
494 557
495Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
496 559
497=item on_sel_extend $term 560=item on_sel_extend $term
498 561
499Called 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
500click) and is either supposed to return false (normal operation), or 563click) and is either supposed to return false (normal operation), or
501should 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
502processing. This can happen multiple times, as long as the callback 565processing. This can happen multiple times, as long as the callback
503returns 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
504supposed to enlarge the selection more and more, if possible. 567supposed to enlarge the selection more and more, if possible.
505 568
506See the F<selection> example extension. 569See the F<selection> example extension.
507 570
508=item on_view_change $term, $offset 571=item on_view_change $term, $offset
509 572
510Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
511scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
512show this many lines of scrollback. 575show this many lines of scrollback.
513 576
514=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
515 578
519 582
520It 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,
521$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
522number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
523 586
524=item on_osc_seq $term, $op, $args 587=item on_osc_seq $term, $op, $args, $resp
525 588
526Called 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
527behaviour. 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
528suppresses execution of the request completely. Make sure you don't get 591suppresses execution of the request completely. Make sure you don't get
529confused by recursive invocations when you output an osc sequence within 592confused by recursive invocations when you output an OSC sequence within
530this callback. 593this callback.
531 594
532C<on_osc_seq_perl> should be used for new behaviour. 595C<on_osc_seq_perl> should be used for new behaviour.
533 596
534=item on_osc_seq_perl $term, $string 597=item on_osc_seq_perl $term, $args, $resp
535 598
536Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
537operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
538information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
539string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
540it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
541future. 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 }
542 615
543Be 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,
544as 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
545other 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.
546 622
547=item on_add_lines $term, $string 623=item on_add_lines $term, $string
548 624
549Called 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
550can 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
555=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
556 632
557Called 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
558suppress or filter tty input. 634suppress or filter tty input.
559 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
560=item on_line_update $term, $row 643=item on_line_update $term, $row
561 644
562Called 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
563screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
564that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
571later 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
572you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
573 656
574=item on_refresh_begin $term 657=item on_refresh_begin $term
575 658
576Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
577or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
578restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
579code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
580 663
581=item on_refresh_end $term 664=item on_refresh_end $term
582 665
583Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
584 667
585=item on_user_command $term, $string 668=item on_user_command $term, $string
586 669
587Called whenever the a user-configured event is being activated (e.g. via 670Called whenever a user-configured event is being activated (e.g. via
588a 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>
589resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
590 673
591The 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
592slightly in the future. 675slightly in the future.
593 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
594=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
595 685
596Called just after the new window size has been calculcated, but before 686Called just after the new window size has been calculated, but before
597windows 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
598returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
599 689
600=item on_x_event $term, $event 690=item on_x_event $term, $event
601 691
612Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
613does focus in processing. 703does focus in processing.
614 704
615=item on_focus_out $term 705=item on_focus_out $term
616 706
617Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
618focus out processing. 708focus out processing.
619 709
620=item on_configure_notify $term, $event 710=item on_configure_notify $term, $event
621 711
622=item on_property_notify $term, $event 712=item on_property_notify $term, $event
633 723
634=item on_map_notify $term, $event 724=item on_map_notify $term, $event
635 725
636=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
637 727
638Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
639the 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.
640 730
641The 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
642manpage), 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
643(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
644 734
653 743
654=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
655 745
656Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
657format=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.
658 752
659=back 753=back
660 754
661=cut 755=cut
662 756
705The current terminal. This variable stores the current C<urxvt::term> 799The current terminal. This variable stores the current C<urxvt::term>
706object, whenever a callback/hook is executing. 800object, whenever a callback/hook is executing.
707 801
708=item @urxvt::TERM_INIT 802=item @urxvt::TERM_INIT
709 803
710All 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
711created 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
712gets cleared before the codereferences that were in it are being executed, 806gets cleared before the code references that were in it are being executed,
713so coderefs can push themselves onto it again if they so desire. 807so references can push themselves onto it again if they so desire.
714 808
715This complements to the perl-eval commandline option, but gets executed 809This complements to the perl-eval command line option, but gets executed
716first. 810first.
717 811
718=item @urxvt::TERM_EXT 812=item @urxvt::TERM_EXT
719 813
720Works 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
727 821
728=over 4 822=over 4
729 823
730=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
731 825
732Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
733costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
734starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
735 830
736=item urxvt::warn $string 831=item urxvt::warn $string
737 832
738Calls 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
739newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
740that calls this function. 835that calls this function.
741 836
742Using 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
743correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
745Messages have a size limit of 1023 bytes currently. 840Messages have a size limit of 1023 bytes currently.
746 841
747=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
748 843
749Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
750wether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
751objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
752is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
753 848
754=item $time = urxvt::NOW 849=item $time = urxvt::NOW
755 850
756Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
757 852
800 895
801=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
802 897
803Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
804 899
805=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
806 902
807Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
808underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
809the bitset. 905the bitset.
810 906
847 }; 943 };
848} 944}
849 945
850no warnings 'utf8'; 946no warnings 'utf8';
851 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
852my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
853 983
854sub verbose { 984sub verbose {
855 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
856 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
892sub invoke { 1022sub invoke {
893 local $TERM = shift; 1023 local $TERM = shift;
894 my $htype = shift; 1024 my $htype = shift;
895 1025
896 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
897 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
898 1028
899 my %ext_arg; 1029 my %ext_arg;
900 1030
901 { 1031 {
902 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
903 @TERM_INIT = (); 1033 @TERM_INIT = ();
966 1096
967sub SET_COLOR($$$) { 1097sub SET_COLOR($$$) {
968 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1098 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
969} 1099}
970 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
971# urxvt::term::extension 1126# urxvt::term::extension
972 1127
973package urxvt::term::extension; 1128package urxvt::term::extension;
974 1129
975sub enable { 1130sub enable {
1044is 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
1045work. 1200work.
1046 1201
1047=cut 1202=cut
1048 1203
1049our $VERSION = 1; 1204our $VERSION = '5.23';
1050 1205
1051$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1206$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1052push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1207push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1053 1208
1054sub timer { 1209sub timer {
1056 1211
1057 my $cb = $arg{cb}; 1212 my $cb = $arg{cb};
1058 1213
1059 urxvt::timer 1214 urxvt::timer
1060 ->new 1215 ->new
1061 ->start (urxvt::NOW + $arg{after}) 1216 ->after ($arg{after}, $arg{interval})
1062 ->cb (sub { 1217 ->cb ($arg{interval} ? $cb : sub {
1063 $_[0]->stop; # need to cancel manually 1218 $_[0]->stop; # need to cancel manually
1064 $cb->(); 1219 $cb->();
1065 }) 1220 })
1066} 1221}
1067 1222
1068sub io { 1223sub io {
1069 my ($class, %arg) = @_; 1224 my ($class, %arg) = @_;
1070 1225
1071 my $cb = $arg{cb}; 1226 my $cb = $arg{cb};
1227 my $fd = fileno $arg{fh};
1228 defined $fd or $fd = $arg{fh};
1072 1229
1073 bless [$arg{fh}, urxvt::iow 1230 bless [$arg{fh}, urxvt::iow
1074 ->new 1231 ->new
1075 ->fd (fileno $arg{fh}) 1232 ->fd ($fd)
1076 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1233 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1077 | ($arg{poll} =~ /w/ ? 2 : 0)) 1234 | ($arg{poll} =~ /w/ ? 2 : 0))
1078 ->start 1235 ->start
1079 ->cb (sub { 1236 ->cb ($cb)
1080 $cb->(($_[1] & 1 ? 'r' : '')
1081 . ($_[1] & 2 ? 'w' : ''));
1082 })],
1083 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 })
1084} 1263}
1085 1264
1086sub DESTROY { 1265sub DESTROY {
1087 $_[0][1]->stop; 1266 $_[0][1]->stop;
1088} 1267}
1089 1268
1090sub condvar { 1269# only needed for AnyEvent < 6 compatibility
1091 bless \my $flag, urxvt::anyevent::condvar:: 1270sub one_event {
1092}
1093
1094sub urxvt::anyevent::condvar::broadcast {
1095 ${$_[0]}++;
1096}
1097
1098sub urxvt::anyevent::condvar::wait {
1099 unless (${$_[0]}) {
1100 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";
1101 }
1102} 1272}
1103 1273
1104package urxvt::term; 1274package urxvt::term;
1105 1275
1106=head2 The C<urxvt::term> Class 1276=head2 The C<urxvt::term> Class
1133 $proxy->enable ($name => $ref); 1303 $proxy->enable ($name => $ref);
1134 } 1304 }
1135 } 1305 }
1136} 1306}
1137 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
1138=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1351=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1139 1352
1140Creates 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
1141C<$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
1142hash which defines the environment of the new terminal. 1355hash which defines the environment of the new terminal.
1193 1406
1194Returns true if the option specified by C<$optval> is enabled, and 1407Returns true if the option specified by C<$optval> is enabled, and
1195optionally 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
1196C<%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.
1197 1410
1198Here 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
1199source file F</src/optinc.h> to see the actual list: 1412source file F</src/optinc.h> to see the actual list:
1200 1413
1201 borderLess console cursorBlink cursorUnderline hold iconic insecure 1414 borderLess buffered console cursorBlink cursorUnderline hold iconic
1202 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1415 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1203 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1416 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1204 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1417 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1205 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1418 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1206 transparent tripleclickwords utmpInhibit visualBell 1419 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1420 urgentOnBell utmpInhibit visualBell
1207 1421
1208=item $value = $term->resource ($name[, $newval]) 1422=item $value = $term->resource ($name[, $newval])
1209 1423
1210Returns the current resource value associated with a given name and 1424Returns the current resource value associated with a given name and
1211optionally 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>
1220likely change). 1434likely change).
1221 1435
1222Please note that resource strings will currently only be freed when the 1436Please note that resource strings will currently only be freed when the
1223terminal is destroyed, so changing options frequently will eat memory. 1437terminal is destroyed, so changing options frequently will eat memory.
1224 1438
1225Here 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
1226are 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>
1227to see the actual list: 1441to see the actual list:
1228 1442
1229 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1443 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1230 borderLess color cursorBlink cursorUnderline cutchars delete_key 1444 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1231 display_name embed ext_bwidth fade font geometry hold iconName 1445 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1232 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
1233 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1448 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1234 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1449 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1235 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1450 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1236 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1451 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1237 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1452 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1238 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1453 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1239 secondaryScreen secondaryScroll selectstyle shade term_name title 1454 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1240 transient_for transparent transparent_all tripleclickwords utmpInhibit 1455 term_name title transient_for transparent tripleclickwords urgentOnBell
1241 visualBell 1456 utmpInhibit visualBell
1242 1457
1243=cut 1458=cut
1244 1459
1245sub resource($$;$) { 1460sub resource($$;$) {
1246 my ($self, $name) = (shift, shift); 1461 my ($self, $name) = (shift, shift);
1247 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1462 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1248 &urxvt::term::_resource 1463 goto &urxvt::term::_resource
1249} 1464}
1250 1465
1251=item $value = $term->x_resource ($pattern) 1466=item $value = $term->x_resource ($pattern)
1252 1467
1253Returns the X-Resource for the given pattern, excluding the program or 1468Returns the X-Resource for the given pattern, excluding the program or
1257 1472
1258This 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
1259only one resource database per display, and later invocations might return 1474only one resource database per display, and later invocations might return
1260the wrong resources. 1475the wrong resources.
1261 1476
1262=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1477=item $success = $term->parse_keysym ($key, $octets)
1263 1478
1264Adds a keymap translation exactly as specified via a resource. See the 1479Adds a key binding exactly as specified via a resource. See the
1265C<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.
1266 1488
1267=item $rend = $term->rstyle ([$new_rstyle]) 1489=item $rend = $term->rstyle ([$new_rstyle])
1268 1490
1269Return and optionally change the current rendition. Text that is output by 1491Return and optionally change the current rendition. Text that is output by
1270the terminal application will use this style. 1492the terminal application will use this style.
1278 1500
1279=item ($row, $col) = $term->selection_beg ([$row, $col]) 1501=item ($row, $col) = $term->selection_beg ([$row, $col])
1280 1502
1281=item ($row, $col) = $term->selection_end ([$row, $col]) 1503=item ($row, $col) = $term->selection_end ([$row, $col])
1282 1504
1283Return the current values of the selection mark, begin or end positions, 1505Return the current values of the selection mark, begin or end positions.
1284and 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.
1285 1514
1286=item $term->selection_make ($eventtime[, $rectangular]) 1515=item $term->selection_make ($eventtime[, $rectangular])
1287 1516
1288Tries to make a selection as set by C<selection_beg> and 1517Tries to make a selection as set by C<selection_beg> and
1289C<selection_end>. If C<$rectangular> is true (default: false), a 1518C<selection_end>. If C<$rectangular> is true (default: false), a
1290rectangular selection will be made. This is the prefered function to make 1519rectangular selection will be made. This is the preferred function to make
1291a selection. 1520a selection.
1292 1521
1293=item $success = $term->selection_grab ($eventtime) 1522=item $success = $term->selection_grab ($eventtime[, $clipboard])
1294 1523
1295Try 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
1296set by the next method). No visual feedback will be given. This function 1526with the next method. No visual feedback will be given. This function
1297is mostly useful from within C<on_sel_grab> hooks. 1527is mostly useful from within C<on_sel_grab> hooks.
1298 1528
1299=item $oldtext = $term->selection ([$newtext]) 1529=item $oldtext = $term->selection ([$newtext, $clipboard])
1300 1530
1301Return 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.
1302 1537
1303=item $term->overlay_simple ($x, $y, $text) 1538=item $term->overlay_simple ($x, $y, $text)
1304 1539
1305Create 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.
1306 1541
1336 1571
1337The methods currently supported on C<urxvt::overlay> objects are: 1572The methods currently supported on C<urxvt::overlay> objects are:
1338 1573
1339=over 4 1574=over 4
1340 1575
1341=item $overlay->set ($x, $y, $text, $rend) 1576=item $overlay->set ($x, $y, $text[, $rend])
1342 1577
1343Similar 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
1344text 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
1345at 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.
1346 1583
1347=item $overlay->hide 1584=item $overlay->hide
1348 1585
1349If visible, hide the overlay, but do not destroy it. 1586If visible, hide the overlay, but do not destroy it.
1350 1587
1432locale-specific encoding of the terminal and can contain command sequences 1669locale-specific encoding of the terminal and can contain command sequences
1433(escape codes) that will be interpreted. 1670(escape codes) that will be interpreted.
1434 1671
1435=item $term->tt_write ($octets) 1672=item $term->tt_write ($octets)
1436 1673
1437Write 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
1438pass characters instead of octets, you should convert your strings first 1675pass characters instead of octets, you should convert your strings first
1439to 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.
1440 1683
1441=item $old_events = $term->pty_ev_events ([$new_events]) 1684=item $old_events = $term->pty_ev_events ([$new_events])
1442 1685
1443Replaces 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
1444be 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
1463Adds 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
1464to receive pointer events all the times: 1707to receive pointer events all the times:
1465 1708
1466 $term->vt_emask_add (urxvt::PointerMotionMask); 1709 $term->vt_emask_add (urxvt::PointerMotionMask);
1467 1710
1711=item $term->set_urgency ($set)
1712
1713Enable/disable the urgency hint on the toplevel window.
1714
1468=item $term->focus_in 1715=item $term->focus_in
1469 1716
1470=item $term->focus_out 1717=item $term->focus_out
1471 1718
1472=item $term->key_press ($state, $keycode[, $time]) 1719=item $term->key_press ($state, $keycode[, $time])
1542 1789
1543Returns the currently displayed screen (0 primary, 1 secondary). 1790Returns the currently displayed screen (0 primary, 1 secondary).
1544 1791
1545=item $cursor_is_hidden = $term->hidden_cursor 1792=item $cursor_is_hidden = $term->hidden_cursor
1546 1793
1547Returns wether the cursor is currently hidden or not. 1794Returns whether the cursor is currently hidden or not.
1548 1795
1549=item $view_start = $term->view_start ([$newvalue]) 1796=item $view_start = $term->view_start ([$newvalue])
1550 1797
1551Returns the row number of the topmost displayed line. Maximum value is 1798Returns the row number of the topmost displayed line. Maximum value is
1552C<0>, which displays the normal terminal contents. Lower values scroll 1799C<0>, which displays the normal terminal contents. Lower values scroll
1560 1807
1561Used after changing terminal contents to display them. 1808Used after changing terminal contents to display them.
1562 1809
1563=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1810=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1564 1811
1565Returns 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 >>
1566is 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
1567terminal line. The scrollback buffer starts at line C<-1> and extends to
1568line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1814terminal line. Nothing will be returned if a nonexistent line
1569is requested. 1815is requested.
1570 1816
1571If 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
1572line, 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
1573to 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
1574automatically be updated. 1820automatically be updated.
1575 1821
1576C<$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
1577than 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)
1578characters. Characters with combining characters and other characters that 1824characters. Characters with combining characters and other characters that
1579do 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
1580in the private use area. 1826in the private use area.
1581 1827
1582You have to obey this encoding when changing text. The advantage is 1828You have to obey this encoding when changing text. The advantage is
1583that 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
1584characters. 1830characters.
1729where one character corresponds to one screen cell. See 1975where one character corresponds to one screen cell. See
1730C<< $term->ROW_t >> for details. 1976C<< $term->ROW_t >> for details.
1731 1977
1732=item $string = $term->special_decode $text 1978=item $string = $term->special_decode $text
1733 1979
1734Converts rxvt-unicodes text reprsentation into a perl string. See 1980Converts rxvt-unicodes text representation into a perl string. See
1735C<< $term->ROW_t >> for details. 1981C<< $term->ROW_t >> for details.
1736 1982
1737=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1983=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1738 1984
1739=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1985=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1742manpage. 1988manpage.
1743 1989
1744=item $success = $term->grab ($eventtime[, $sync]) 1990=item $success = $term->grab ($eventtime[, $sync])
1745 1991
1746Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1992Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1747synchronous (C<$sync> is true). Also remembers the grab timestampe. 1993synchronous (C<$sync> is true). Also remembers the grab timestamp.
1748 1994
1749=item $term->allow_events_async 1995=item $term->allow_events_async
1750 1996
1751Calls XAllowEvents with AsyncBoth for the most recent grab. 1997Calls XAllowEvents with AsyncBoth for the most recent grab.
1752 1998
1759Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2005Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1760recent grab. 2006recent grab.
1761 2007
1762=item $term->ungrab 2008=item $term->ungrab
1763 2009
1764Calls XUngrab for the most recent grab. Is called automatically on 2010Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1765evaluation 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
1766the session. 2012the session.
1767 2013
1768=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2014=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1769 2015
1771 2017
1772=item @atoms = $term->XListProperties ($window) 2018=item @atoms = $term->XListProperties ($window)
1773 2019
1774=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 2020=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1775 2021
1776=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 2022=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1777 2023
1778=item $term->XDeleteProperty ($window, $property) 2024=item $term->XDeleteProperty ($window, $property)
1779 2025
1780=item $window = $term->DefaultRootWindow 2026=item $window = $term->DefaultRootWindow
1781 2027
1788=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2034=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1789 2035
1790=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2036=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1791 2037
1792=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)
1793 2043
1794Various 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
1795the source of the display, otherwise those functions map more-or-less 2045the source of the display, otherwise those functions map more-or-less
1796directory onto the X functions of the same name. 2046directly onto the X functions of the same name.
1797 2047
1798=back 2048=back
1799 2049
1800=cut 2050=cut
1801 2051
1903 my $env = $self->{term}->env; 2153 my $env = $self->{term}->env;
1904 # 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.
1905 delete $env->{LC_ALL}; 2155 delete $env->{LC_ALL};
1906 $env->{LC_CTYPE} = $self->{term}->locale; 2156 $env->{LC_CTYPE} = $self->{term}->locale;
1907 2157
1908 urxvt::term->new ($env, "popup", 2158 my $term = urxvt::term->new (
2159 $env, "popup",
1909 "--perl-lib" => "", "--perl-ext-common" => "", 2160 "--perl-lib" => "", "--perl-ext-common" => "",
1910 "-pty-fd" => -1, "-sl" => 0, 2161 "-pty-fd" => -1, "-sl" => 0,
1911 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2162 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1912 "--transient-for" => $self->{term}->parent, 2163 "--transient-for" => $self->{term}->parent,
1913 "-display" => $self->{term}->display_id, 2164 "-display" => $self->{term}->display_id,
1914 "-pe" => "urxvt-popup") 2165 "-pe" => "urxvt-popup",
1915 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 }
1916} 2173}
1917 2174
1918sub DESTROY { 2175sub DESTROY {
1919 my ($self) = @_; 2176 my ($self) = @_;
1920 2177
1925=back 2182=back
1926 2183
1927=cut 2184=cut
1928 2185
1929package urxvt::watcher; 2186package urxvt::watcher;
1930
1931@urxvt::timer::ISA = __PACKAGE__;
1932@urxvt::iow::ISA = __PACKAGE__;
1933@urxvt::pw::ISA = __PACKAGE__;
1934@urxvt::iw::ISA = __PACKAGE__;
1935 2187
1936=head2 The C<urxvt::timer> Class 2188=head2 The C<urxvt::timer> Class
1937 2189
1938This class implements timer watchers/events. Time is represented as a 2190This class implements timer watchers/events. Time is represented as a
1939fractional number of seconds since the epoch. Example: 2191fractional number of seconds since the epoch. Example:
1943 ->new 2195 ->new
1944 ->interval (1) 2196 ->interval (1)
1945 ->cb (sub { 2197 ->cb (sub {
1946 $term->{overlay}->set (0, 0, 2198 $term->{overlay}->set (0, 0,
1947 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2199 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1948 }); 2200 });
1949 2201
1950=over 4 2202=over 4
1951 2203
1952=item $timer = new urxvt::timer 2204=item $timer = new urxvt::timer
1953 2205
1956 2208
1957=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2209=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1958 2210
1959Set the callback to be called when the timer triggers. 2211Set the callback to be called when the timer triggers.
1960 2212
1961=item $tstamp = $timer->at
1962
1963Return the time this watcher will fire next.
1964
1965=item $timer = $timer->set ($tstamp) 2213=item $timer = $timer->set ($tstamp[, $interval])
1966 2214
1967Set the time the event is generated to $tstamp. 2215Set the time the event is generated to $tstamp (and optionally specifies a
2216new $interval).
1968 2217
1969=item $timer = $timer->interval ($interval) 2218=item $timer = $timer->interval ($interval)
1970 2219
1971Normally (and when C<$interval> is C<0>), the timer will automatically 2220By default (and when C<$interval> is C<0>), the timer will automatically
1972stop 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
1973is automatically rescheduled at the given intervals. 2222is automatically rescheduled at the given intervals.
1974 2223
1975=item $timer = $timer->start 2224=item $timer = $timer->start
1976 2225
1977Start the timer. 2226Start the timer.
1978 2227
1979=item $timer = $timer->start ($tstamp) 2228=item $timer = $timer->start ($tstamp[, $interval])
1980 2229
1981Set 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.
1982 2232
1983=item $timer = $timer->after ($delay) 2233=item $timer = $timer->after ($delay[, $interval])
1984 2234
1985Like 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>.
1986 2236
1987=item $timer = $timer->stop 2237=item $timer = $timer->stop
1988 2238
1996 2246
1997 $term->{socket} = ... 2247 $term->{socket} = ...
1998 $term->{iow} = urxvt::iow 2248 $term->{iow} = urxvt::iow
1999 ->new 2249 ->new
2000 ->fd (fileno $term->{socket}) 2250 ->fd (fileno $term->{socket})
2001 ->events (urxvt::EVENT_READ) 2251 ->events (urxvt::EV_READ)
2002 ->start 2252 ->start
2003 ->cb (sub { 2253 ->cb (sub {
2004 my ($iow, $revents) = @_; 2254 my ($iow, $revents) = @_;
2005 # $revents must be 1 here, no need to check 2255 # $revents must be 1 here, no need to check
2006 sysread $term->{socket}, my $buf, 8192 2256 sysread $term->{socket}, my $buf, 8192
2019Set 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>
2020is a bitset as described in the C<events> method. 2270is a bitset as described in the C<events> method.
2021 2271
2022=item $iow = $iow->fd ($fd) 2272=item $iow = $iow->fd ($fd)
2023 2273
2024Set the filedescriptor (not handle) to watch. 2274Set the file descriptor (not handle) to watch.
2025 2275
2026=item $iow = $iow->events ($eventmask) 2276=item $iow = $iow->events ($eventmask)
2027 2277
2028Set the event mask to watch. The only allowed values are 2278Set the event mask to watch. The only allowed values are
2029C<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
2030together, or C<urxvt::EVENT_NONE>. 2280together, or C<urxvt::EV_NONE>.
2031 2281
2032=item $iow = $iow->start 2282=item $iow = $iow->start
2033 2283
2034Start watching for requested events on the given handle. 2284Start watching for requested events on the given handle.
2035 2285
2036=item $iow = $iow->stop 2286=item $iow = $iow->stop
2037 2287
2038Stop watching for events on the given filehandle. 2288Stop watching for events on the given file handle.
2039 2289
2040=back 2290=back
2041 2291
2042=head2 The C<urxvt::iw> Class 2292=head2 The C<urxvt::iw> Class
2043 2293
2076 ->new 2326 ->new
2077 ->start ($pid) 2327 ->start ($pid)
2078 ->cb (sub { 2328 ->cb (sub {
2079 my ($pw, $exit_status) = @_; 2329 my ($pw, $exit_status) = @_;
2080 ... 2330 ...
2081 }); 2331 });
2082 2332
2083=over 4 2333=over 4
2084 2334
2085=item $pw = new urxvt::pw 2335=item $pw = new urxvt::pw
2086 2336
2090 2340
2091Set the callback to be called when the timer triggers. 2341Set the callback to be called when the timer triggers.
2092 2342
2093=item $pw = $timer->start ($pid) 2343=item $pw = $timer->start ($pid)
2094 2344
2095Tells the wqtcher to start watching for process C<$pid>. 2345Tells the watcher to start watching for process C<$pid>.
2096 2346
2097=item $pw = $pw->stop 2347=item $pw = $pw->stop
2098 2348
2099Stop the watcher. 2349Stop the watcher.
2100 2350
2113 2363
2114=item >= 3 - script loading and management 2364=item >= 3 - script loading and management
2115 2365
2116=item >=10 - all called hooks 2366=item >=10 - all called hooks
2117 2367
2118=item >=11 - hook reutrn values 2368=item >=11 - hook return values
2119 2369
2120=back 2370=back
2121 2371
2122=head1 AUTHOR 2372=head1 AUTHOR
2123 2373
2124 Marc Lehmann <pcg@goof.com> 2374 Marc Lehmann <schmorp@schmorp.de>
2125 http://software.schmorp.de/pkg/rxvt-unicode 2375 http://software.schmorp.de/pkg/rxvt-unicode
2126 2376
2127=cut 2377=cut
2128 2378
21291 23791
2380
2381# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines