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.141 by root, Mon Jul 3 19:11:41 2006 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 2012 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
62 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
63 ... 66 ...
64 67
65The index number (0, 1...) must not have any holes, and each regex must 68The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for 69contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
68between two vertical bars: 71between two vertical bars:
69 72
70 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
71 74
72Another example: Programs I use often output "absolute path: " at the 75Another example: Programs I use often output "absolute path: " at the
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
107first argument. 110first argument.
108 111
109The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
110C<$self->{myoption}>: 113C<< $self->{myoption} >>:
111 114
112 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 }; 117 };
115 118
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide wether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
155 164
156=item readline (enabled by default) 165=item readline (enabled by default)
157 166
158A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
159the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
160move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
161cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
162for programs that correctly support wide characters). 171for programs that correctly support wide characters).
163 172
164To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
165 174
166=over 4 175=over 4
214the message into vi commands to load the file. 223the message into vi commands to load the file.
215 224
216=item tabbed 225=item tabbed
217 226
218This transforms the terminal into a tabbar with additional terminals, that 227This transforms the terminal into a tabbar with additional terminals, that
219is, it implements what is commonly refered to as "tabbed terminal". The topmost line 228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
220displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one 229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
221button per tab. 230button per tab.
222 231
223Clicking a button will activate that tab. Pressing B<Shift-Left> and 232Clicking a button will activate that tab. Pressing B<Shift-Left> and
224B<Shift-Right> will switch to the tab left or right of the current one, 233B<Shift-Right> will switch to the tab left or right of the current one,
234 URxvt.tabbed.tab-bg: <colour-index, default 1> 243 URxvt.tabbed.tab-bg: <colour-index, default 1>
235 244
236See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid 245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
237indices. 246indices.
238 247
239=item mark-urls 248=item matcher
240 249
241Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
242make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
243resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
244the URL as first argument. 253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
268Example configuration:
269
270 URxvt.perl-ext: default,matcher
271 URxvt.urlLauncher: sensible-browser
272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
274 URxvt.matcher.button: 1
275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277 URxvt.matcher.launcher.2: gvim +$2 $1
245 278
246=item xim-onthespot 279=item xim-onthespot
247 280
248This (experimental) perl extension implements OnTheSpot editing. It does 281This (experimental) perl extension implements OnTheSpot editing. It does
249not work perfectly, and some input methods don't seem to work well with 282not work perfectly, and some input methods don't seem to work well with
250OnTheSpot editing in general, but it seems to work at leats for SCIM and 283OnTheSpot editing in general, but it seems to work at least for SCIM and
251kinput2. 284kinput2.
252 285
253You enable it by specifying this extension and a preedit style of 286You enable it by specifying this extension and a preedit style of
254C<OnTheSpot>, i.e.: 287C<OnTheSpot>, i.e.:
255 288
256 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot 289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
257 290
258=item automove-background 291=item kuake<hotkey>
259 292
260This is basically a very small extension that dynamically changes the 293A very primitive quake-console-like extension. It was inspired by a
261background pixmap offset to the window position, in effect creating the 294description of how the programs C<kuake> and C<yakuake> work: Whenever the
262same effect as pseudo transparency with a custom pixmap. No scaling is 295user presses a global accelerator key (by default C<F10>), the terminal
263supported in this mode. Exmaple: 296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
264 298
265 @@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.
266 315
267=item block-graphics-to-ascii 316=item block-graphics-to-ascii
268 317
269A 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
270by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
275Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
276 325
277=item remote-clipboard 326=item remote-clipboard
278 327
279Somewhat of a misnomer, this extension adds two menu entries to the 328Somewhat of a misnomer, this extension adds two menu entries to the
280selection popup that allows one ti run external commands to store the 329selection popup that allows one to run external commands to store the
281selection somewhere and fetch it again. 330selection somewhere and fetch it again.
282 331
283We use it to implement a "distributed selection mechanism", which just 332We use it to implement a "distributed selection mechanism", which just
284means 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
285reads it. 334reads it.
294 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
295 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
296 345
297=item selection-pastebin 346=item selection-pastebin
298 347
299This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
300textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
301not 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
302F</tmp> directly.). 351F</tmp> directly.).
303 352
304It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
321in the C<selection-pastebin-url> resource (again, the % is the placeholder 370in the C<selection-pastebin-url> resource (again, the % is the placeholder
322for the filename): 371for the filename):
323 372
324 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
325 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
326=item example-refresh-hooks 394=item example-refresh-hooks
327 395
328Displays 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
329window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
330overlays 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"
331 412
332=back 413=back
333 414
334=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
335 416
351 432
352=over 4 433=over 4
353 434
354=item $text 435=item $text
355 436
356Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
357always 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.
358 439
359=item $string 440=item $string
360 441
361A 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
365=item $octets 446=item $octets
366 447
367Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
368locale-specific way. 449locale-specific way.
369 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
370=back 457=back
371 458
372=head2 Extension Objects 459=head2 Extension Objects
373 460
374Every 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
375for 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,
376hooks. 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
377about 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
378begin with an underscore character C<_>: these are reserved for internal 466that begin with an underscore character C<_>: these are reserved for
379use. 467internal use.
380 468
381Although 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
382C<urxvt::term> class on this object. 470C<urxvt::term> class on this object.
383 471
384It has the following methods and data members: 472It has the following methods and data members:
405=head2 Hooks 493=head2 Hooks
406 494
407The following subroutines can be declared in extension files, and will be 495The following subroutines can be declared in extension files, and will be
408called whenever the relevant event happens. 496called whenever the relevant event happens.
409 497
410The 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
411the in the C<Extension Objects> section. 499the in the C<Extension Objects> section.
412 500
413B<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
414hooks 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
415relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
428place. 516place.
429 517
430=item on_start $term 518=item on_start $term
431 519
432Called 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
433trying to map (display) the toplevel and returning to the mainloop. 521trying to map (display) the toplevel and returning to the main loop.
434 522
435=item on_destroy $term 523=item on_destroy $term
436 524
437Called whenever something tries to destroy terminal, when the terminal is 525Called whenever something tries to destroy terminal, when the terminal is
438still fully functional (not for long, though). 526still fully functional (not for long, though).
465 553
466Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
467requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
468by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
469 557
470Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
471 559
472=item on_sel_extend $term 560=item on_sel_extend $term
473 561
474Called 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
475click) and is either supposed to return false (normal operation), or 563click) and is either supposed to return false (normal operation), or
476should 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
477processing. This can happen multiple times, as long as the callback 565processing. This can happen multiple times, as long as the callback
478returns 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
479supposed to enlarge the selection more and more, if possible. 567supposed to enlarge the selection more and more, if possible.
480 568
481See the F<selection> example extension. 569See the F<selection> example extension.
482 570
483=item on_view_change $term, $offset 571=item on_view_change $term, $offset
484 572
485Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
486scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
487show this many lines of scrollback. 575show this many lines of scrollback.
488 576
489=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
490 578
494 582
495It 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,
496$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
497number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
498 586
499=item on_osc_seq $term, $op, $args 587=item on_osc_seq $term, $op, $args, $resp
500 588
501Called 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
502behaviour. 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
503suppresses execution of the request completely. Make sure you don't get 591suppresses execution of the request completely. Make sure you don't get
504confused by recursive invocations when you output an osc sequence within 592confused by recursive invocations when you output an OSC sequence within
505this callback. 593this callback.
506 594
507C<on_osc_seq_perl> should be used for new behaviour. 595C<on_osc_seq_perl> should be used for new behaviour.
508 596
509=item on_osc_seq_perl $term, $string 597=item on_osc_seq_perl $term, $args, $resp
510 598
511Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
512operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
513information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
514string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
515it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
516future. 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 }
517 615
518Be 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,
519as 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
520other 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.
521 622
522=item on_add_lines $term, $string 623=item on_add_lines $term, $string
523 624
524Called 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
525can 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
530=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
531 632
532Called 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
533suppress or filter tty input. 634suppress or filter tty input.
534 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
535=item on_line_update $term, $row 643=item on_line_update $term, $row
536 644
537Called 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
538screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
539that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
546later 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
547you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
548 656
549=item on_refresh_begin $term 657=item on_refresh_begin $term
550 658
551Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
552or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
553restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
554code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
555 663
556=item on_refresh_end $term 664=item on_refresh_end $term
557 665
558Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
559 667
560=item on_user_command $term, $string 668=item on_user_command $term, $string
561 669
562Called whenever the a user-configured event is being activated (e.g. via 670Called whenever a user-configured event is being activated (e.g. via
563a 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>
564resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
565 673
566The 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
567slightly in the future. 675slightly in the future.
568 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
569=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
570 685
571Called just after the new window size has been calculcated, but before 686Called just after the new window size has been calculated, but before
572windows 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
573returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
574 689
575=item on_x_event $term, $event 690=item on_x_event $term, $event
576 691
577Called 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
578windows). Should only be used as a last resort. Most event structure 693windows). Should only be used as a last resort. Most event structure
579members are not passed. 694members are not passed.
580 695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
699
581=item on_focus_in $term 700=item on_focus_in $term
582 701
583Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
584does focus in processing. 703does focus in processing.
585 704
586=item on_focus_out $term 705=item on_focus_out $term
587 706
588Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
589focus out processing. 708focus out processing.
590 709
591=item on_configure_notify $term, $event 710=item on_configure_notify $term, $event
592 711
593=item on_property_notify $term, $event 712=item on_property_notify $term, $event
604 723
605=item on_map_notify $term, $event 724=item on_map_notify $term, $event
606 725
607=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
608 727
609Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
610the 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.
611 730
612The 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
613manpage), 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
614(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
615 734
624 743
625=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
626 745
627Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
628format=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.
629 752
630=back 753=back
631 754
632=cut 755=cut
633 756
676The current terminal. This variable stores the current C<urxvt::term> 799The current terminal. This variable stores the current C<urxvt::term>
677object, whenever a callback/hook is executing. 800object, whenever a callback/hook is executing.
678 801
679=item @urxvt::TERM_INIT 802=item @urxvt::TERM_INIT
680 803
681All 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
682created 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
683gets cleared before the codereferences that were in it are being executed, 806gets cleared before the code references that were in it are being executed,
684so coderefs can push themselves onto it again if they so desire. 807so references can push themselves onto it again if they so desire.
685 808
686This complements to the perl-eval commandline option, but gets executed 809This complements to the perl-eval command line option, but gets executed
687first. 810first.
688 811
689=item @urxvt::TERM_EXT 812=item @urxvt::TERM_EXT
690 813
691Works 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
698 821
699=over 4 822=over 4
700 823
701=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
702 825
703Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
704costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
705starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
706 830
707=item urxvt::warn $string 831=item urxvt::warn $string
708 832
709Calls 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
710newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
711that calls this function. 835that calls this function.
712 836
713Using 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
714correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
716Messages have a size limit of 1023 bytes currently. 840Messages have a size limit of 1023 bytes currently.
717 841
718=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
719 843
720Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
721wether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
722objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
723is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
724 848
725=item $time = urxvt::NOW 849=item $time = urxvt::NOW
726 850
727Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
728 852
771 895
772=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
773 897
774Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
775 899
776=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
777 902
778Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
779underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
780the bitset. 905the bitset.
781 906
818 }; 943 };
819} 944}
820 945
821no warnings 'utf8'; 946no warnings 'utf8';
822 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
823my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
824 983
825sub verbose { 984sub verbose {
826 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
827 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
863sub invoke { 1022sub invoke {
864 local $TERM = shift; 1023 local $TERM = shift;
865 my $htype = shift; 1024 my $htype = shift;
866 1025
867 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
868 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
869 1028
870 my %ext_arg; 1029 my %ext_arg;
871 1030
872 { 1031 {
873 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
874 @TERM_INIT = (); 1033 @TERM_INIT = ();
937 1096
938sub SET_COLOR($$$) { 1097sub SET_COLOR($$$) {
939 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 1098 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
940} 1099}
941 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
942# urxvt::term::extension 1126# urxvt::term::extension
943 1127
944package urxvt::term::extension; 1128package urxvt::term::extension;
945 1129
946sub enable { 1130sub enable {
1015is 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
1016work. 1200work.
1017 1201
1018=cut 1202=cut
1019 1203
1020our $VERSION = 1; 1204our $VERSION = '5.23';
1021 1205
1022$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1206$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1023push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1207push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1024 1208
1025sub timer { 1209sub timer {
1027 1211
1028 my $cb = $arg{cb}; 1212 my $cb = $arg{cb};
1029 1213
1030 urxvt::timer 1214 urxvt::timer
1031 ->new 1215 ->new
1032 ->start (urxvt::NOW + $arg{after}) 1216 ->after ($arg{after}, $arg{interval})
1033 ->cb (sub { 1217 ->cb ($arg{interval} ? $cb : sub {
1034 $_[0]->stop; # need to cancel manually 1218 $_[0]->stop; # need to cancel manually
1035 $cb->(); 1219 $cb->();
1036 }) 1220 })
1037} 1221}
1038 1222
1039sub io { 1223sub io {
1040 my ($class, %arg) = @_; 1224 my ($class, %arg) = @_;
1041 1225
1042 my $cb = $arg{cb}; 1226 my $cb = $arg{cb};
1227 my $fd = fileno $arg{fh};
1228 defined $fd or $fd = $arg{fh};
1043 1229
1044 bless [$arg{fh}, urxvt::iow 1230 bless [$arg{fh}, urxvt::iow
1045 ->new 1231 ->new
1046 ->fd (fileno $arg{fh}) 1232 ->fd ($fd)
1047 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1233 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1048 | ($arg{poll} =~ /w/ ? 2 : 0)) 1234 | ($arg{poll} =~ /w/ ? 2 : 0))
1049 ->start 1235 ->start
1050 ->cb (sub { 1236 ->cb ($cb)
1051 $cb->(($_[1] & 1 ? 'r' : '')
1052 . ($_[1] & 2 ? 'w' : ''));
1053 })],
1054 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 })
1055} 1263}
1056 1264
1057sub DESTROY { 1265sub DESTROY {
1058 $_[0][1]->stop; 1266 $_[0][1]->stop;
1059} 1267}
1060 1268
1061sub condvar { 1269# only needed for AnyEvent < 6 compatibility
1062 bless \my $flag, urxvt::anyevent::condvar:: 1270sub one_event {
1063}
1064
1065sub urxvt::anyevent::condvar::broadcast {
1066 ${$_[0]}++;
1067}
1068
1069sub urxvt::anyevent::condvar::wait {
1070 unless (${$_[0]}) {
1071 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";
1072 }
1073} 1272}
1074 1273
1075package urxvt::term; 1274package urxvt::term;
1076 1275
1077=head2 The C<urxvt::term> Class 1276=head2 The C<urxvt::term> Class
1104 $proxy->enable ($name => $ref); 1303 $proxy->enable ($name => $ref);
1105 } 1304 }
1106 } 1305 }
1107} 1306}
1108 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
1109=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1351=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1110 1352
1111Creates 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
1112C<$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
1113hash which defines the environment of the new terminal. 1355hash which defines the environment of the new terminal.
1164 1406
1165Returns true if the option specified by C<$optval> is enabled, and 1407Returns true if the option specified by C<$optval> is enabled, and
1166optionally 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
1167C<%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.
1168 1410
1169Here 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
1170source file F</src/optinc.h> to see the actual list: 1412source file F</src/optinc.h> to see the actual list:
1171 1413
1172 borderLess console cursorBlink cursorUnderline hold iconic insecure 1414 borderLess buffered console cursorBlink cursorUnderline hold iconic
1173 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1415 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1174 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1416 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1175 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1417 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1176 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1418 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1177 transparent tripleclickwords utmpInhibit visualBell 1419 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1420 urgentOnBell utmpInhibit visualBell
1178 1421
1179=item $value = $term->resource ($name[, $newval]) 1422=item $value = $term->resource ($name[, $newval])
1180 1423
1181Returns the current resource value associated with a given name and 1424Returns the current resource value associated with a given name and
1182optionally 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>
1191likely change). 1434likely change).
1192 1435
1193Please note that resource strings will currently only be freed when the 1436Please note that resource strings will currently only be freed when the
1194terminal is destroyed, so changing options frequently will eat memory. 1437terminal is destroyed, so changing options frequently will eat memory.
1195 1438
1196Here 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
1197are 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>
1198to see the actual list: 1441to see the actual list:
1199 1442
1200 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1443 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1201 borderLess color cursorBlink cursorUnderline cutchars delete_key 1444 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1202 display_name embed ext_bwidth fade font geometry hold iconName 1445 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1203 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
1204 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1448 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1205 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1449 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1206 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1450 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1207 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1451 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1208 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1452 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1209 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1453 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1210 secondaryScreen secondaryScroll selectstyle shade term_name title 1454 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1211 transient_for transparent transparent_all tripleclickwords utmpInhibit 1455 term_name title transient_for transparent tripleclickwords urgentOnBell
1212 visualBell 1456 utmpInhibit visualBell
1213 1457
1214=cut 1458=cut
1215 1459
1216sub resource($$;$) { 1460sub resource($$;$) {
1217 my ($self, $name) = (shift, shift); 1461 my ($self, $name) = (shift, shift);
1218 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1462 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1219 &urxvt::term::_resource 1463 goto &urxvt::term::_resource
1220} 1464}
1221 1465
1222=item $value = $term->x_resource ($pattern) 1466=item $value = $term->x_resource ($pattern)
1223 1467
1224Returns the X-Resource for the given pattern, excluding the program or 1468Returns the X-Resource for the given pattern, excluding the program or
1228 1472
1229This 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
1230only one resource database per display, and later invocations might return 1474only one resource database per display, and later invocations might return
1231the wrong resources. 1475the wrong resources.
1232 1476
1233=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1477=item $success = $term->parse_keysym ($key, $octets)
1234 1478
1235Adds a keymap translation exactly as specified via a resource. See the 1479Adds a key binding exactly as specified via a resource. See the
1236C<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.
1237 1488
1238=item $rend = $term->rstyle ([$new_rstyle]) 1489=item $rend = $term->rstyle ([$new_rstyle])
1239 1490
1240Return and optionally change the current rendition. Text that is output by 1491Return and optionally change the current rendition. Text that is output by
1241the terminal application will use this style. 1492the terminal application will use this style.
1249 1500
1250=item ($row, $col) = $term->selection_beg ([$row, $col]) 1501=item ($row, $col) = $term->selection_beg ([$row, $col])
1251 1502
1252=item ($row, $col) = $term->selection_end ([$row, $col]) 1503=item ($row, $col) = $term->selection_end ([$row, $col])
1253 1504
1254Return the current values of the selection mark, begin or end positions, 1505Return the current values of the selection mark, begin or end positions.
1255and 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.
1256 1514
1257=item $term->selection_make ($eventtime[, $rectangular]) 1515=item $term->selection_make ($eventtime[, $rectangular])
1258 1516
1259Tries to make a selection as set by C<selection_beg> and 1517Tries to make a selection as set by C<selection_beg> and
1260C<selection_end>. If C<$rectangular> is true (default: false), a 1518C<selection_end>. If C<$rectangular> is true (default: false), a
1261rectangular selection will be made. This is the prefered function to make 1519rectangular selection will be made. This is the preferred function to make
1262a selection. 1520a selection.
1263 1521
1264=item $success = $term->selection_grab ($eventtime) 1522=item $success = $term->selection_grab ($eventtime[, $clipboard])
1265 1523
1266Try 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
1267set by the next method). No visual feedback will be given. This function 1526with the next method. No visual feedback will be given. This function
1268is mostly useful from within C<on_sel_grab> hooks. 1527is mostly useful from within C<on_sel_grab> hooks.
1269 1528
1270=item $oldtext = $term->selection ([$newtext]) 1529=item $oldtext = $term->selection ([$newtext, $clipboard])
1271 1530
1272Return 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.
1273 1537
1274=item $term->overlay_simple ($x, $y, $text) 1538=item $term->overlay_simple ($x, $y, $text)
1275 1539
1276Create 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.
1277 1541
1307 1571
1308The methods currently supported on C<urxvt::overlay> objects are: 1572The methods currently supported on C<urxvt::overlay> objects are:
1309 1573
1310=over 4 1574=over 4
1311 1575
1312=item $overlay->set ($x, $y, $text, $rend) 1576=item $overlay->set ($x, $y, $text[, $rend])
1313 1577
1314Similar 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
1315text 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
1316at 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.
1317 1583
1318=item $overlay->hide 1584=item $overlay->hide
1319 1585
1320If visible, hide the overlay, but do not destroy it. 1586If visible, hide the overlay, but do not destroy it.
1321 1587
1403locale-specific encoding of the terminal and can contain command sequences 1669locale-specific encoding of the terminal and can contain command sequences
1404(escape codes) that will be interpreted. 1670(escape codes) that will be interpreted.
1405 1671
1406=item $term->tt_write ($octets) 1672=item $term->tt_write ($octets)
1407 1673
1408Write 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
1409pass characters instead of octets, you should convert your strings first 1675pass characters instead of octets, you should convert your strings first
1410to 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.
1411 1683
1412=item $old_events = $term->pty_ev_events ([$new_events]) 1684=item $old_events = $term->pty_ev_events ([$new_events])
1413 1685
1414Replaces 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
1415be 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
1434Adds 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
1435to receive pointer events all the times: 1707to receive pointer events all the times:
1436 1708
1437 $term->vt_emask_add (urxvt::PointerMotionMask); 1709 $term->vt_emask_add (urxvt::PointerMotionMask);
1438 1710
1711=item $term->set_urgency ($set)
1712
1713Enable/disable the urgency hint on the toplevel window.
1714
1439=item $term->focus_in 1715=item $term->focus_in
1440 1716
1441=item $term->focus_out 1717=item $term->focus_out
1442 1718
1443=item $term->key_press ($state, $keycode[, $time]) 1719=item $term->key_press ($state, $keycode[, $time])
1513 1789
1514Returns the currently displayed screen (0 primary, 1 secondary). 1790Returns the currently displayed screen (0 primary, 1 secondary).
1515 1791
1516=item $cursor_is_hidden = $term->hidden_cursor 1792=item $cursor_is_hidden = $term->hidden_cursor
1517 1793
1518Returns wether the cursor is currently hidden or not. 1794Returns whether the cursor is currently hidden or not.
1519 1795
1520=item $view_start = $term->view_start ([$newvalue]) 1796=item $view_start = $term->view_start ([$newvalue])
1521 1797
1522Returns the row number of the topmost displayed line. Maximum value is 1798Returns the row number of the topmost displayed line. Maximum value is
1523C<0>, which displays the normal terminal contents. Lower values scroll 1799C<0>, which displays the normal terminal contents. Lower values scroll
1531 1807
1532Used after changing terminal contents to display them. 1808Used after changing terminal contents to display them.
1533 1809
1534=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1810=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1535 1811
1536Returns 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 >>
1537is 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
1538terminal line. The scrollback buffer starts at line C<-1> and extends to
1539line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1814terminal line. Nothing will be returned if a nonexistent line
1540is requested. 1815is requested.
1541 1816
1542If 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
1543line, 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
1544to 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
1545automatically be updated. 1820automatically be updated.
1546 1821
1547C<$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
1548than 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)
1549characters. Characters with combining characters and other characters that 1824characters. Characters with combining characters and other characters that
1550do 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
1551in the private use area. 1826in the private use area.
1552 1827
1553You have to obey this encoding when changing text. The advantage is 1828You have to obey this encoding when changing text. The advantage is
1554that 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
1555characters. 1830characters.
1700where one character corresponds to one screen cell. See 1975where one character corresponds to one screen cell. See
1701C<< $term->ROW_t >> for details. 1976C<< $term->ROW_t >> for details.
1702 1977
1703=item $string = $term->special_decode $text 1978=item $string = $term->special_decode $text
1704 1979
1705Converts rxvt-unicodes text reprsentation into a perl string. See 1980Converts rxvt-unicodes text representation into a perl string. See
1706C<< $term->ROW_t >> for details. 1981C<< $term->ROW_t >> for details.
1707 1982
1708=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 1983=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1709 1984
1710=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 1985=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1713manpage. 1988manpage.
1714 1989
1715=item $success = $term->grab ($eventtime[, $sync]) 1990=item $success = $term->grab ($eventtime[, $sync])
1716 1991
1717Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1992Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1718synchronous (C<$sync> is true). Also remembers the grab timestampe. 1993synchronous (C<$sync> is true). Also remembers the grab timestamp.
1719 1994
1720=item $term->allow_events_async 1995=item $term->allow_events_async
1721 1996
1722Calls XAllowEvents with AsyncBoth for the most recent grab. 1997Calls XAllowEvents with AsyncBoth for the most recent grab.
1723 1998
1730Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2005Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1731recent grab. 2006recent grab.
1732 2007
1733=item $term->ungrab 2008=item $term->ungrab
1734 2009
1735Calls XUngrab for the most recent grab. Is called automatically on 2010Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1736evaluation 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
1737the session. 2012the session.
1738 2013
1739=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2014=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1740 2015
1742 2017
1743=item @atoms = $term->XListProperties ($window) 2018=item @atoms = $term->XListProperties ($window)
1744 2019
1745=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 2020=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1746 2021
1747=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 2022=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1748 2023
1749=item $term->XDeleteProperty ($window, $property) 2024=item $term->XDeleteProperty ($window, $property)
1750 2025
1751=item $window = $term->DefaultRootWindow 2026=item $window = $term->DefaultRootWindow
1752 2027
1759=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2034=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1760 2035
1761=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2036=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1762 2037
1763=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)
1764 2043
1765Various 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
1766the source of the display, otherwise those functions map more-or-less 2045the source of the display, otherwise those functions map more-or-less
1767directory onto the X functions of the same name. 2046directly onto the X functions of the same name.
1768 2047
1769=back 2048=back
1770 2049
1771=cut 2050=cut
1772 2051
1874 my $env = $self->{term}->env; 2153 my $env = $self->{term}->env;
1875 # 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.
1876 delete $env->{LC_ALL}; 2155 delete $env->{LC_ALL};
1877 $env->{LC_CTYPE} = $self->{term}->locale; 2156 $env->{LC_CTYPE} = $self->{term}->locale;
1878 2157
1879 urxvt::term->new ($env, "popup", 2158 my $term = urxvt::term->new (
2159 $env, "popup",
1880 "--perl-lib" => "", "--perl-ext-common" => "", 2160 "--perl-lib" => "", "--perl-ext-common" => "",
1881 "-pty-fd" => -1, "-sl" => 0, 2161 "-pty-fd" => -1, "-sl" => 0,
1882 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2162 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1883 "--transient-for" => $self->{term}->parent, 2163 "--transient-for" => $self->{term}->parent,
1884 "-display" => $self->{term}->display_id, 2164 "-display" => $self->{term}->display_id,
1885 "-pe" => "urxvt-popup") 2165 "-pe" => "urxvt-popup",
1886 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 }
1887} 2173}
1888 2174
1889sub DESTROY { 2175sub DESTROY {
1890 my ($self) = @_; 2176 my ($self) = @_;
1891 2177
1896=back 2182=back
1897 2183
1898=cut 2184=cut
1899 2185
1900package urxvt::watcher; 2186package urxvt::watcher;
1901
1902@urxvt::timer::ISA = __PACKAGE__;
1903@urxvt::iow::ISA = __PACKAGE__;
1904@urxvt::pw::ISA = __PACKAGE__;
1905@urxvt::iw::ISA = __PACKAGE__;
1906 2187
1907=head2 The C<urxvt::timer> Class 2188=head2 The C<urxvt::timer> Class
1908 2189
1909This class implements timer watchers/events. Time is represented as a 2190This class implements timer watchers/events. Time is represented as a
1910fractional number of seconds since the epoch. Example: 2191fractional number of seconds since the epoch. Example:
1914 ->new 2195 ->new
1915 ->interval (1) 2196 ->interval (1)
1916 ->cb (sub { 2197 ->cb (sub {
1917 $term->{overlay}->set (0, 0, 2198 $term->{overlay}->set (0, 0,
1918 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2199 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1919 }); 2200 });
1920 2201
1921=over 4 2202=over 4
1922 2203
1923=item $timer = new urxvt::timer 2204=item $timer = new urxvt::timer
1924 2205
1927 2208
1928=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2209=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1929 2210
1930Set the callback to be called when the timer triggers. 2211Set the callback to be called when the timer triggers.
1931 2212
1932=item $tstamp = $timer->at
1933
1934Return the time this watcher will fire next.
1935
1936=item $timer = $timer->set ($tstamp) 2213=item $timer = $timer->set ($tstamp[, $interval])
1937 2214
1938Set the time the event is generated to $tstamp. 2215Set the time the event is generated to $tstamp (and optionally specifies a
2216new $interval).
1939 2217
1940=item $timer = $timer->interval ($interval) 2218=item $timer = $timer->interval ($interval)
1941 2219
1942Normally (and when C<$interval> is C<0>), the timer will automatically 2220By default (and when C<$interval> is C<0>), the timer will automatically
1943stop 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
1944is automatically rescheduled at the given intervals. 2222is automatically rescheduled at the given intervals.
1945 2223
1946=item $timer = $timer->start 2224=item $timer = $timer->start
1947 2225
1948Start the timer. 2226Start the timer.
1949 2227
1950=item $timer = $timer->start ($tstamp) 2228=item $timer = $timer->start ($tstamp[, $interval])
1951 2229
1952Set 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.
1953 2232
1954=item $timer = $timer->after ($delay) 2233=item $timer = $timer->after ($delay[, $interval])
1955 2234
1956Like 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>.
1957 2236
1958=item $timer = $timer->stop 2237=item $timer = $timer->stop
1959 2238
1967 2246
1968 $term->{socket} = ... 2247 $term->{socket} = ...
1969 $term->{iow} = urxvt::iow 2248 $term->{iow} = urxvt::iow
1970 ->new 2249 ->new
1971 ->fd (fileno $term->{socket}) 2250 ->fd (fileno $term->{socket})
1972 ->events (urxvt::EVENT_READ) 2251 ->events (urxvt::EV_READ)
1973 ->start 2252 ->start
1974 ->cb (sub { 2253 ->cb (sub {
1975 my ($iow, $revents) = @_; 2254 my ($iow, $revents) = @_;
1976 # $revents must be 1 here, no need to check 2255 # $revents must be 1 here, no need to check
1977 sysread $term->{socket}, my $buf, 8192 2256 sysread $term->{socket}, my $buf, 8192
1990Set 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>
1991is a bitset as described in the C<events> method. 2270is a bitset as described in the C<events> method.
1992 2271
1993=item $iow = $iow->fd ($fd) 2272=item $iow = $iow->fd ($fd)
1994 2273
1995Set the filedescriptor (not handle) to watch. 2274Set the file descriptor (not handle) to watch.
1996 2275
1997=item $iow = $iow->events ($eventmask) 2276=item $iow = $iow->events ($eventmask)
1998 2277
1999Set the event mask to watch. The only allowed values are 2278Set the event mask to watch. The only allowed values are
2000C<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
2001together, or C<urxvt::EVENT_NONE>. 2280together, or C<urxvt::EV_NONE>.
2002 2281
2003=item $iow = $iow->start 2282=item $iow = $iow->start
2004 2283
2005Start watching for requested events on the given handle. 2284Start watching for requested events on the given handle.
2006 2285
2007=item $iow = $iow->stop 2286=item $iow = $iow->stop
2008 2287
2009Stop watching for events on the given filehandle. 2288Stop watching for events on the given file handle.
2010 2289
2011=back 2290=back
2012 2291
2013=head2 The C<urxvt::iw> Class 2292=head2 The C<urxvt::iw> Class
2014 2293
2047 ->new 2326 ->new
2048 ->start ($pid) 2327 ->start ($pid)
2049 ->cb (sub { 2328 ->cb (sub {
2050 my ($pw, $exit_status) = @_; 2329 my ($pw, $exit_status) = @_;
2051 ... 2330 ...
2052 }); 2331 });
2053 2332
2054=over 4 2333=over 4
2055 2334
2056=item $pw = new urxvt::pw 2335=item $pw = new urxvt::pw
2057 2336
2061 2340
2062Set the callback to be called when the timer triggers. 2341Set the callback to be called when the timer triggers.
2063 2342
2064=item $pw = $timer->start ($pid) 2343=item $pw = $timer->start ($pid)
2065 2344
2066Tells the wqtcher to start watching for process C<$pid>. 2345Tells the watcher to start watching for process C<$pid>.
2067 2346
2068=item $pw = $pw->stop 2347=item $pw = $pw->stop
2069 2348
2070Stop the watcher. 2349Stop the watcher.
2071 2350
2084 2363
2085=item >= 3 - script loading and management 2364=item >= 3 - script loading and management
2086 2365
2087=item >=10 - all called hooks 2366=item >=10 - all called hooks
2088 2367
2089=item >=11 - hook reutrn values 2368=item >=11 - hook return values
2090 2369
2091=back 2370=back
2092 2371
2093=head1 AUTHOR 2372=head1 AUTHOR
2094 2373
2095 Marc Lehmann <pcg@goof.com> 2374 Marc Lehmann <schmorp@schmorp.de>
2096 http://software.schmorp.de/pkg/rxvt-unicode 2375 http://software.schmorp.de/pkg/rxvt-unicode
2097 2376
2098=cut 2377=cut
2099 2378
21001 23791
2380
2381# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines