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.93 by root, Fri Jan 13 07:03:48 2006 UTC vs.
Revision 1.172 by root, Fri Oct 10 00:21:15 2008 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
36You can activate them like this: 39You can activate them like this:
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42
43Or by adding them to the resource for extensions loaded by default:
44
45 URxvt.perl-ext-common: default,selection-autotransform
39 46
40=over 4 47=over 4
41 48
42=item selection (enabled by default) 49=item selection (enabled by default)
43 50
58 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
59 ... 66 ...
60 67
61The 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
62contain 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
63the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
64between two vertical bars: 71between two vertical bars:
65 72
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
67 81
68You can look at the source of the selection extension to see more 82You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 83interesting uses, such as parsing a line from beginning to end.
70 84
71This extension also offers the following bindable keyboard command: 85This extension also offers following bindable keyboard commands:
72 86
73=over 4 87=over 4
74 88
75=item rot13 89=item rot13
76 90
83=item option-popup (enabled by default) 97=item option-popup (enabled by default)
84 98
85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86runtime. 100runtime.
87 101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<< $self->{myoption} >>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
118
88=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
89 120
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<a>s:
138
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : ()
142 };
93 143
94=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
95 145
96Adds regex search functionality to the scrollback buffer, triggered 146Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 147by a hotkey (default: C<M-s>). While in search mode, normal terminal
102search. 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>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. 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
105was 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
106additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
107selection. 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.
164
165=item readline (enabled by default)
166
167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters).
172
173To avoid too many false positives, this is only done when:
174
175=over 4
176
177=item - the tty is in ICANON state.
178
179=item - the text cursor is visible.
180
181=item - the primary screen is currently being displayed.
182
183=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
108 189
109=item selection-autotransform 190=item selection-autotransform
110 191
111This selection allows you to do automatic transforms on a selection 192This selection allows you to do automatic transforms on a selection
112whenever a selection is made. 193whenever a selection is made.
125 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 207
127And this example matches the same,but replaces it with vi-commands you can 208And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 209paste directly into your (vi :) editor:
129 210
130 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 212
132Of course, this can be modified to suit your needs and your editor :) 213Of course, this can be modified to suit your needs and your editor :)
133 214
134To expand the example above to typical perl error messages ("XXX at 215To expand the example above to typical perl error messages ("XXX at
135FILENAME line YYY."), you need a slightly more elaborate solution: 216FILENAME line YYY."), you need a slightly more elaborate solution:
136 217
137 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
138 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 219 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
139 220
140The first line tells the selection code to treat the unchanging part of 221The first line tells the selection code to treat the unchanging part of
141every error message as a selection pattern, and the second line transforms 222every error message as a selection pattern, and the second line transforms
142the message into vi commands to load the file. 223the message into vi commands to load the file.
143 224
144=item mark-urls 225=item tabbed
145 226
227This transforms the terminal into a tabbar with additional terminals, that
228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230button per tab.
231
232Clicking a button will activate that tab. Pressing B<Shift-Left> and
233B<Shift-Right> will switch to the tab left or right of the current one,
234while B<Shift-Down> creates a new tab.
235
236The tabbar itself can be configured similarly to a normal terminal, but
237with a resource class of C<URxvt.tabbed>. In addition, it supports the
238following four resources (shown with defaults):
239
240 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242 URxvt.tabbed.tab-fg: <colour-index, default 0>
243 URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246indices.
247
248=item matcher
249
146Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
147make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
148resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
149the 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 from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
276
277=item xim-onthespot
278
279This (experimental) perl extension implements OnTheSpot editing. It does
280not work perfectly, and some input methods don't seem to work well with
281OnTheSpot editing in general, but it seems to work at least for SCIM and
282kinput2.
283
284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.:
286
287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289=item kuake<hotkey>
290
291A very primitive quake-console-like extension. It was inspired by a
292description of how the programs C<kuake> and C<yakuake> work: Whenever the
293user presses a global accelerator key (by default C<F10>), the terminal
294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
296
297Initially, the window will not be shown when using this extension.
298
299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key.
301
302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function.
304
305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it).
150 307
151=item block-graphics-to-ascii 308=item block-graphics-to-ascii
152 309
153A not very useful example of filtering all text output to the terminal, 310A not very useful example of filtering all text output to the terminal
154by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
155similar-looking ascii character. 312similar-looking ascii character.
156 313
157=item digital-clock 314=item digital-clock
158 315
159Displays a digital clock using the built-in overlay. 316Displays a digital clock using the built-in overlay.
317
318=item remote-clipboard
319
320Somewhat of a misnomer, this extension adds two menu entries to the
321selection popup that allows one to run external commands to store the
322selection somewhere and fetch it again.
323
324We use it to implement a "distributed selection mechanism", which just
325means that one command uploads the file to a remote server, and another
326reads it.
327
328The commands can be set using the C<URxvt.remote-selection.store> and
329C<URxvt.remote-selection.fetch> resources. The first should read the
330selection to store from STDIN (always in UTF-8), the second should provide
331the selection data on STDOUT (also in UTF-8).
332
333The defaults (which are likely useless to you) use rsh and cat:
334
335 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337
338=item selection-pastebin
339
340This is a little rarely useful extension that Uploads the selection as
341textfile to a remote site (or does other things). (The implementation is
342not currently secure for use in a multiuser environment as it writes to
343F</tmp> directly.).
344
345It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
346i.e.
347
348 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
349
350Pressing this combination runs a command with C<%> replaced by the name of
351the textfile. This command can be set via a resource:
352
353 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
354
355And the default is likely not useful to anybody but the few people around
356here :)
357
358The name of the textfile is the hex encoded md5 sum of the selection, so
359the same content should lead to the same filename.
360
361After a successful upload the selection will be replaced by the text given
362in the C<selection-pastebin-url> resource (again, the % is the placeholder
363for the filename):
364
365 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366
367I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368the double C</> characters as comment start. Use C<\057\057> instead,
369which works regardless of wether xrdb is used to parse the resource file
370or not.
160 371
161=item example-refresh-hooks 372=item example-refresh-hooks
162 373
163Displays a very simple digital clock in the upper right corner of the 374Displays a very simple digital clock in the upper right corner of the
164window. Illustrates overwriting the refresh callbacks to create your own 375window. Illustrates overwriting the refresh callbacks to create your own
204 415
205=back 416=back
206 417
207=head2 Extension Objects 418=head2 Extension Objects
208 419
209Very perl extension is a perl class. A separate perl object is created 420Every perl extension is a perl class. A separate perl object is created
210for each terminal and each extension and passed as the first parameter to 421for each terminal, and each terminal has its own set of extenion objects,
211hooks. So extensions can use their C<$self> object without having to think 422which are passed as the first parameter to hooks. So extensions can use
212about other extensions, with the exception of methods and members that 423their C<$self> object without having to think about clashes with other
424extensions or other terminals, with the exception of methods and members
213begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
214use. 426internal use.
215 427
216Although it isn't a C<urxvt::term> object, you can call all methods of the 428Although it isn't a C<urxvt::term> object, you can call all methods of the
217C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
218 430
219It has the following methods and data members: 431It has the following methods and data members:
240=head2 Hooks 452=head2 Hooks
241 453
242The following subroutines can be declared in extension files, and will be 454The following subroutines can be declared in extension files, and will be
243called whenever the relevant event happens. 455called whenever the relevant event happens.
244 456
245The first argument passed to them is an extension oject as described in 457The first argument passed to them is an extension object as described in
246the in the C<Extension Objects> section. 458the in the C<Extension Objects> section.
247 459
248B<All> of these hooks must return a boolean value. If it is true, then the 460B<All> of these hooks must return a boolean value. If any of the called
249event counts as being I<consumed>, and the invocation of other hooks is 461hooks returns true, then the event counts as being I<consumed>, and the
250skipped, and the relevant action might not be carried out by the C++ code. 462relevant action might not be carried out by the C++ code.
251 463
252I<< When in doubt, return a false value (preferably C<()>). >> 464I<< When in doubt, return a false value (preferably C<()>). >>
253 465
254=over 4 466=over 4
255 467
256=item on_init $term 468=item on_init $term
257 469
258Called after a new terminal object has been initialized, but before 470Called after a new terminal object has been initialized, but before
259windows are created or the command gets run. Most methods are unsafe to 471windows are created or the command gets run. Most methods are unsafe to
260call or deliver senseless data, as terminal size and other characteristics 472call or deliver senseless data, as terminal size and other characteristics
261have not yet been determined. You can safely query and change resources, 473have not yet been determined. You can safely query and change resources
262though. 474and options, though. For many purposes the C<on_start> hook is a better
475place.
476
477=item on_start $term
478
479Called at the very end of initialisation of a new terminal, just before
480trying to map (display) the toplevel and returning to the main loop.
481
482=item on_destroy $term
483
484Called whenever something tries to destroy terminal, when the terminal is
485still fully functional (not for long, though).
263 486
264=item on_reset $term 487=item on_reset $term
265 488
266Called after the screen is "reset" for any reason, such as resizing or 489Called after the screen is "reset" for any reason, such as resizing or
267control sequences. Here is where you can react on changes to size-related 490control sequences. Here is where you can react on changes to size-related
268variables. 491variables.
269 492
270=item on_start $term 493=item on_child_start $term, $pid
271 494
272Called at the very end of initialisation of a new terminal, just before 495Called just after the child process has been C<fork>ed.
273returning to the mainloop. 496
497=item on_child_exit $term, $status
498
499Called just after the child process has exited. C<$status> is the status
500from C<waitpid>.
274 501
275=item on_sel_make $term, $eventtime 502=item on_sel_make $term, $eventtime
276 503
277Called whenever a selection has been made by the user, but before the 504Called whenever a selection has been made by the user, but before the
278selection text is copied, so changes to the beginning, end or type of the 505selection text is copied, so changes to the beginning, end or type of the
285 512
286Called whenever a selection has been copied, but before the selection is 513Called whenever a selection has been copied, but before the selection is
287requested from the server. The selection text can be queried and changed 514requested from the server. The selection text can be queried and changed
288by calling C<< $term->selection >>. 515by calling C<< $term->selection >>.
289 516
290Returning a true value aborts selection grabbing. It will still be hilighted. 517Returning a true value aborts selection grabbing. It will still be highlighted.
291 518
292=item on_sel_extend $term 519=item on_sel_extend $term
293 520
294Called whenever the user tries to extend the selection (e.g. with a double 521Called whenever the user tries to extend the selection (e.g. with a double
295click) and is either supposed to return false (normal operation), or 522click) and is either supposed to return false (normal operation), or
296should extend the selection itelf and return true to suppress the built-in 523should extend the selection itself and return true to suppress the built-in
297processing. This can happen multiple times, as long as the callback 524processing. This can happen multiple times, as long as the callback
298returns true, it will be called on every further click by the user and is 525returns true, it will be called on every further click by the user and is
299supposed to enlarge the selection more and more, if possible. 526supposed to enlarge the selection more and more, if possible.
300 527
301See the F<selection> example extension. 528See the F<selection> example extension.
302 529
303=item on_view_change $term, $offset 530=item on_view_change $term, $offset
304 531
305Called whenever the view offset changes, i..e the user or program 532Called whenever the view offset changes, i.e. the user or program
306scrolls. Offset C<0> means display the normal terminal, positive values 533scrolls. Offset C<0> means display the normal terminal, positive values
307show this many lines of scrollback. 534show this many lines of scrollback.
308 535
309=item on_scroll_back $term, $lines, $saved 536=item on_scroll_back $term, $lines, $saved
310 537
314 541
315It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
316$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
317number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
318 545
319=item on_osc_seq $term, $string 546=item on_osc_seq $term, $op, $args, $resp
547
548Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an OSC sequence within
552this callback.
553
554C<on_osc_seq_perl> should be used for new behaviour.
555
556=item on_osc_seq_perl $term, $args, $resp
320 557
321Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
322operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
323information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
324string should start with the extension name and a colon, to distinguish 561string should start with the extension name (sans -osc) and a semicolon,
325it from commands for other extensions, and this might be enforced in the 562to distinguish it from commands for other extensions, and this might be
326future. 563enforced in the future.
564
565For example, C<overlay-osc> uses this:
566
567 sub on_osc_seq_perl {
568 my ($self, $osc, $resp) = @_;
569
570 return unless $osc =~ s/^overlay;//;
571
572 ... process remaining $osc string
573 }
327 574
328Be careful not ever to trust (in a security sense) the data you receive, 575Be careful not ever to trust (in a security sense) the data you receive,
329as its source can not easily be controleld (e-mail content, messages from 576as its source can not easily be controlled (e-mail content, messages from
330other users on the same system etc.). 577other users on the same system etc.).
578
579For responses, C<$resp> contains the end-of-args separator used by the
580sender.
331 581
332=item on_add_lines $term, $string 582=item on_add_lines $term, $string
333 583
334Called whenever text is about to be output, with the text as argument. You 584Called whenever text is about to be output, with the text as argument. You
335can filter/change and output the text yourself by returning a true value 585can filter/change and output the text yourself by returning a true value
356later with the already-modified line (e.g. if unrelated parts change), so 606later with the already-modified line (e.g. if unrelated parts change), so
357you cannot just toggle rendition bits, but only set them. 607you cannot just toggle rendition bits, but only set them.
358 608
359=item on_refresh_begin $term 609=item on_refresh_begin $term
360 610
361Called just before the screen gets redrawn. Can be used for overlay 611Called just before the screen gets redrawn. Can be used for overlay or
362or similar effects by modify terminal contents in refresh_begin, and 612similar effects by modifying the terminal contents in refresh_begin, and
363restoring them in refresh_end. The built-in overlay and selection display 613restoring them in refresh_end. The built-in overlay and selection display
364code is run after this hook, and takes precedence. 614code is run after this hook, and takes precedence.
365 615
366=item on_refresh_end $term 616=item on_refresh_end $term
367 617
368Called just after the screen gets redrawn. See C<on_refresh_begin>. 618Called just after the screen gets redrawn. See C<on_refresh_begin>.
369 619
370=item on_keyboard_command $term, $string 620=item on_user_command $term, $string
371 621
372Called whenever the user presses a key combination that has a 622Called whenever a user-configured event is being activated (e.g. via
373C<perl:string> action bound to it (see description of the B<keysym> 623a C<perl:string> action bound to a key, see description of the B<keysym>
374resource in the @@RXVT_NAME@@(1) manpage). 624resource in the @@RXVT_NAME@@(1) manpage).
625
626The event is simply the action string. This interface is assumed to change
627slightly in the future.
628
629=item on_resize_all_windows $tern, $new_width, $new_height
630
631Called just after the new window size has been calculated, but before
632windows are actually being resized or hints are being set. If this hook
633returns TRUE, setting of the window hints is being skipped.
375 634
376=item on_x_event $term, $event 635=item on_x_event $term, $event
377 636
378Called on every X event received on the vt window (and possibly other 637Called on every X event received on the vt window (and possibly other
379windows). Should only be used as a last resort. Most event structure 638windows). Should only be used as a last resort. Most event structure
380members are not passed. 639members are not passed.
381 640
641=item on_root_event $term, $event
642
643Like C<on_x_event>, but is called for events on the root window.
644
382=item on_focus_in $term 645=item on_focus_in $term
383 646
384Called whenever the window gets the keyboard focus, before rxvt-unicode 647Called whenever the window gets the keyboard focus, before rxvt-unicode
385does focus in processing. 648does focus in processing.
386 649
387=item on_focus_out $term 650=item on_focus_out $term
388 651
389Called wheneever the window loses keyboard focus, before rxvt-unicode does 652Called whenever the window loses keyboard focus, before rxvt-unicode does
390focus out processing. 653focus out processing.
654
655=item on_configure_notify $term, $event
656
657=item on_property_notify $term, $event
391 658
392=item on_key_press $term, $event, $keysym, $octets 659=item on_key_press $term, $event, $keysym, $octets
393 660
394=item on_key_release $term, $event, $keysym 661=item on_key_release $term, $event, $keysym
395 662
405 672
406Called whenever the corresponding X event is received for the terminal If 673Called whenever the corresponding X event is received for the terminal If
407the hook returns true, then the even will be ignored by rxvt-unicode. 674the hook returns true, then the even will be ignored by rxvt-unicode.
408 675
409The event is a hash with most values as named by Xlib (see the XEvent 676The event is a hash with most values as named by Xlib (see the XEvent
410manpage), with the additional members C<row> and C<col>, which are the row 677manpage), with the additional members C<row> and C<col>, which are the
411and column under the mouse cursor. 678(real, not screen-based) row and column under the mouse cursor.
412 679
413C<on_key_press> additionally receives the string rxvt-unicode would 680C<on_key_press> additionally receives the string rxvt-unicode would
414output, if any, in locale-specific encoding. 681output, if any, in locale-specific encoding.
415 682
416subwindow. 683subwindow.
684
685=item on_client_message $term, $event
686
687=item on_wm_protocols $term, $event
688
689=item on_wm_delete_window $term, $event
690
691Called when various types of ClientMessage events are received (all with
692format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
417 693
418=back 694=back
419 695
420=cut 696=cut
421 697
427use Scalar::Util (); 703use Scalar::Util ();
428use List::Util (); 704use List::Util ();
429 705
430our $VERSION = 1; 706our $VERSION = 1;
431our $TERM; 707our $TERM;
708our @TERM_INIT;
709our @TERM_EXT;
432our @HOOKNAME; 710our @HOOKNAME;
433our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 711our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
434our %OPTION; 712our %OPTION;
435 713
436our $LIBDIR; 714our $LIBDIR;
437our $RESNAME; 715our $RESNAME;
438our $RESCLASS; 716our $RESCLASS;
439our $RXVTNAME; 717our $RXVTNAME;
440 718
719our $NOCHAR = chr 0xffff;
720
441=head2 Variables in the C<urxvt> Package 721=head2 Variables in the C<urxvt> Package
442 722
443=over 4 723=over 4
444 724
445=item $urxvt::LIBDIR 725=item $urxvt::LIBDIR
457 737
458=item $urxvt::TERM 738=item $urxvt::TERM
459 739
460The current terminal. This variable stores the current C<urxvt::term> 740The current terminal. This variable stores the current C<urxvt::term>
461object, whenever a callback/hook is executing. 741object, whenever a callback/hook is executing.
742
743=item @urxvt::TERM_INIT
744
745All code references in this array will be called as methods of the next newly
746created C<urxvt::term> object (during the C<on_init> phase). The array
747gets cleared before the code references that were in it are being executed,
748so references can push themselves onto it again if they so desire.
749
750This complements to the perl-eval command line option, but gets executed
751first.
752
753=item @urxvt::TERM_EXT
754
755Works similar to C<@TERM_INIT>, but contains perl package/class names, which
756get registered as normal extensions after calling the hooks in C<@TERM_INIT>
757but before other extensions. Gets cleared just like C<@TERM_INIT>.
462 758
463=back 759=back
464 760
465=head2 Functions in the C<urxvt> Package 761=head2 Functions in the C<urxvt> Package
466 762
481Using this function has the advantage that its output ends up in the 777Using this function has the advantage that its output ends up in the
482correct place, e.g. on stderr of the connecting urxvtc client. 778correct place, e.g. on stderr of the connecting urxvtc client.
483 779
484Messages have a size limit of 1023 bytes currently. 780Messages have a size limit of 1023 bytes currently.
485 781
486=item $is_safe = urxvt::safe 782=item @terms = urxvt::termlist
487 783
488Returns true when it is safe to do potentially unsafe things, such as 784Returns all urxvt::term objects that exist in this process, regardless of
489evaluating perl code specified by the user. This is true when urxvt was 785whether they are started, being destroyed etc., so be careful. Only term
490started setuid or setgid. 786objects that have perl extensions attached will be returned (because there
787is no urxvt::term objet associated with others).
491 788
492=item $time = urxvt::NOW 789=item $time = urxvt::NOW
493 790
494Returns the "current time" (as per the event loop). 791Returns the "current time" (as per the event loop).
495 792
554 851
555=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 852=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
556 853
557=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 854=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
558 855
856=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
857
559Replace the foreground/background colour in the rendition mask with the 858Replace the foreground/background colour in the rendition mask with the
560specified one. 859specified one.
561 860
562=item $value = urxvt::GET_CUSTOM $rend 861=item $value = urxvt::GET_CUSTOM $rend
563 862
572=back 871=back
573 872
574=cut 873=cut
575 874
576BEGIN { 875BEGIN {
577 urxvt->bootstrap;
578
579 # overwrite perl's warn 876 # overwrite perl's warn
580 *CORE::GLOBAL::warn = sub { 877 *CORE::GLOBAL::warn = sub {
581 my $msg = join "", @_; 878 my $msg = join "", @_;
582 $msg .= "\n" 879 $msg .= "\n"
583 unless $msg =~ /\n$/; 880 unless $msg =~ /\n$/;
584 urxvt::warn ($msg); 881 urxvt::warn ($msg);
585 }; 882 };
586
587 # %ENV is the original startup environment
588 delete $ENV{IFS};
589 delete $ENV{CDPATH};
590 delete $ENV{BASH_ENV};
591 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
592} 883}
884
885no warnings 'utf8';
593 886
594my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 887my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
595 888
596sub verbose { 889sub verbose {
597 my ($level, $msg) = @_; 890 my ($level, $msg) = @_;
598 warn "$msg\n" if $level <= $verbosity; 891 warn "$msg\n" if $level <= $verbosity;
599} 892}
600 893
601my $extension_pkg = "extension0000";
602my %extension_pkg; 894my %extension_pkg;
603 895
604# load a single script into its own package, once only 896# load a single script into its own package, once only
605sub extension_package($) { 897sub extension_package($) {
606 my ($path) = @_; 898 my ($path) = @_;
607 899
608 $extension_pkg{$path} ||= do { 900 $extension_pkg{$path} ||= do {
609 my $pkg = "urxvt::" . ($extension_pkg++); 901 $path =~ /([^\/\\]+)$/;
902 my $pkg = $1;
903 $pkg =~ s/[^[:word:]]/_/g;
904 $pkg = "urxvt::ext::$pkg";
610 905
611 verbose 3, "loading extension '$path' into package '$pkg'"; 906 verbose 3, "loading extension '$path' into package '$pkg'";
612 907
613 open my $fh, "<:raw", $path 908 open my $fh, "<:raw", $path
614 or die "$path: $!"; 909 or die "$path: $!";
615 910
616 my $source = untaint 911 my $source =
617 "package $pkg; use strict; use utf8;\n" 912 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
618 . "use base urxvt::term::extension::;\n"
619 . "#line 1 \"$path\"\n{\n" 913 . "#line 1 \"$path\"\n{\n"
620 . (do { local $/; <$fh> }) 914 . (do { local $/; <$fh> })
621 . "\n};\n1"; 915 . "\n};\n1";
622 916
623 eval $source 917 eval $source
634 local $TERM = shift; 928 local $TERM = shift;
635 my $htype = shift; 929 my $htype = shift;
636 930
637 if ($htype == 0) { # INIT 931 if ($htype == 0) { # INIT
638 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
639 933
640 my %ext_arg; 934 my %ext_arg;
641 935
936 {
937 my @init = @TERM_INIT;
938 @TERM_INIT = ();
939 $_->($TERM) for @init;
940 my @pkg = @TERM_EXT;
941 @TERM_EXT = ();
942 $TERM->register_package ($_) for @pkg;
943 }
944
642 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 945 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
643 if ($_ eq "default") { 946 if ($_ eq "default") {
644 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 947 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
645 } elsif (/^-(.*)$/) { 948 } elsif (/^-(.*)$/) {
646 delete $ext_arg{$1}; 949 delete $ext_arg{$1};
647 } elsif (/^([^<]+)<(.*)>$/) { 950 } elsif (/^([^<]+)<(.*)>$/) {
648 push @{ $ext_arg{$1} }, $2; 951 push @{ $ext_arg{$1} }, $2;
649 } else { 952 } else {
650 $ext_arg{$_} ||= []; 953 $ext_arg{$_} ||= [];
651 } 954 }
652 } 955 }
653 956
654 while (my ($ext, $argv) = each %ext_arg) { 957 for my $ext (sort keys %ext_arg) {
655 my @files = grep -f $_, map "$_/$ext", @dirs; 958 my @files = grep -f $_, map "$_/$ext", @dirs;
656 959
657 if (@files) { 960 if (@files) {
658 $TERM->register_package (extension_package $files[0], $argv); 961 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
659 } else { 962 } else {
660 warn "perl extension '$ext' not found in perl library search path\n"; 963 warn "perl extension '$ext' not found in perl library search path\n";
661 } 964 }
662 } 965 }
663 966
669 972
670 if (my $cb = $TERM->{_hook}[$htype]) { 973 if (my $cb = $TERM->{_hook}[$htype]) {
671 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 974 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
672 if $verbosity >= 10; 975 if $verbosity >= 10;
673 976
674 keys %$cb; 977 for my $pkg (keys %$cb) {
675
676 while (my ($pkg, $cb) = each %$cb) {
677 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 978 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
678 and last; 979 $retval ||= $retval_;
679 980
680 if ($@) { 981 if ($@) {
681 $TERM->ungrab; # better to lose the grab than the session 982 $TERM->ungrab; # better to lose the grab than the session
682 warn $@; 983 warn $@;
683 } 984 }
696 } 997 }
697 998
698 $retval 999 $retval
699} 1000}
700 1001
701sub exec_async(@) { 1002sub SET_COLOR($$$) {
702 my $pid = fork; 1003 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1004}
703 1005
704 return 1006sub rend2mask {
705 if !defined $pid or $pid; 1007 no strict 'refs';
706 1008 my ($str, $mask) = (@_, 0);
707 %ENV = %{ $TERM->env }; 1009 my %color = ( fg => undef, bg => undef );
708 1010 my @failed;
709 exec @_; 1011 for my $spec ( split /\s+/, $str ) {
710 _exit 255; 1012 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1013 $color{lc($1)} = $2;
1014 } else {
1015 my $neg = $spec =~ s/^[-^]//;
1016 unless ( exists &{"RS_$spec"} ) {
1017 push @failed, $spec;
1018 next;
1019 }
1020 my $cur = &{"RS_$spec"};
1021 if ( $neg ) {
1022 $mask &= ~$cur;
1023 } else {
1024 $mask |= $cur;
1025 }
1026 }
1027 }
1028 ($mask, @color{qw(fg bg)}, \@failed)
711} 1029}
712 1030
713# urxvt::term::extension 1031# urxvt::term::extension
714 1032
715package urxvt::term::extension; 1033package urxvt::term::extension;
786is that you cannot use blocking APIs, but the non-blocking variant should 1104is that you cannot use blocking APIs, but the non-blocking variant should
787work. 1105work.
788 1106
789=cut 1107=cut
790 1108
791our $VERSION = 1; 1109our $VERSION = '3.4';
792 1110
793$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
794push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
795 1113
796sub timer { 1114sub timer {
827 1145
828sub DESTROY { 1146sub DESTROY {
829 $_[0][1]->stop; 1147 $_[0][1]->stop;
830} 1148}
831 1149
832sub condvar { 1150sub one_event {
833 bless \my $flag, urxvt::anyevent::condvar::
834}
835
836sub urxvt::anyevent::condvar::broadcast {
837 ${$_[0]}++;
838}
839
840sub urxvt::anyevent::condvar::wait {
841 unless (${$_[0]}) {
842 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1151 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
843 }
844} 1152}
845 1153
846package urxvt::term; 1154package urxvt::term;
847 1155
848=head2 The C<urxvt::term> Class 1156=head2 The C<urxvt::term> Class
853 1161
854# find on_xxx subs in the package and register them 1162# find on_xxx subs in the package and register them
855# as hooks 1163# as hooks
856sub register_package { 1164sub register_package {
857 my ($self, $pkg, $argv) = @_; 1165 my ($self, $pkg, $argv) = @_;
1166
1167 no strict 'refs';
1168
1169 urxvt::verbose 6, "register package $pkg to $self";
1170
1171 @{"$pkg\::ISA"} = urxvt::term::extension::;
858 1172
859 my $proxy = bless { 1173 my $proxy = bless {
860 _pkg => $pkg, 1174 _pkg => $pkg,
861 argv => $argv, 1175 argv => $argv,
862 }, $pkg; 1176 }, $pkg;
878hash which defines the environment of the new terminal. 1192hash which defines the environment of the new terminal.
879 1193
880Croaks (and probably outputs an error message) if the new instance 1194Croaks (and probably outputs an error message) if the new instance
881couldn't be created. Returns C<undef> if the new instance didn't 1195couldn't be created. Returns C<undef> if the new instance didn't
882initialise perl, and the terminal object otherwise. The C<init> and 1196initialise perl, and the terminal object otherwise. The C<init> and
883C<start> hooks will be called during this call. 1197C<start> hooks will be called before this call returns, and are free to
1198refer to global data (which is race free).
884 1199
885=cut 1200=cut
886 1201
887sub new { 1202sub new {
888 my ($class, $env, @args) = @_; 1203 my ($class, $env, @args) = @_;
889 1204
1205 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1206 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1207
890 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1208 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
891} 1209}
892 1210
893=item $term->destroy 1211=item $term->destroy
894 1212
895Destroy the terminal object (close the window, free resources 1213Destroy the terminal object (close the window, free resources
896etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1214etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
897watchers (timers, io watchers) are still active. 1215watchers (timers, io watchers) are still active.
898 1216
1217=item $term->exec_async ($cmd[, @args])
1218
1219Works like the combination of the C<fork>/C<exec> builtins, which executes
1220("starts") programs in the background. This function takes care of setting
1221the user environment before exec'ing the command (e.g. C<PATH>) and should
1222be preferred over explicit calls to C<exec> or C<system>.
1223
1224Returns the pid of the subprocess or C<undef> on error.
1225
1226=cut
1227
1228sub exec_async {
1229 my $self = shift;
1230
1231 my $pid = fork;
1232
1233 return $pid
1234 if !defined $pid or $pid;
1235
1236 %ENV = %{ $self->env };
1237
1238 exec @_;
1239 urxvt::_exit 255;
1240}
1241
899=item $isset = $term->option ($optval[, $set]) 1242=item $isset = $term->option ($optval[, $set])
900 1243
901Returns true if the option specified by C<$optval> is enabled, and 1244Returns true if the option specified by C<$optval> is enabled, and
902optionally change it. All option values are stored by name in the hash 1245optionally change it. All option values are stored by name in the hash
903C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1246C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
904 1247
905Here is a a likely non-exhaustive list of option names, please see the 1248Here is a likely non-exhaustive list of option names, please see the
906source file F</src/optinc.h> to see the actual list: 1249source file F</src/optinc.h> to see the actual list:
907 1250
908 borderLess console cursorBlink cursorUnderline hold iconic insecure 1251 borderLess console cursorBlink cursorUnderline hold iconic insecure
909 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1252 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
910 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1253 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
911 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1254 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
912 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1255 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
913 tripleclickwords utmpInhibit visualBell 1256 transparent tripleclickwords utmpInhibit visualBell
914 1257
915=item $value = $term->resource ($name[, $newval]) 1258=item $value = $term->resource ($name[, $newval])
916 1259
917Returns the current resource value associated with a given name and 1260Returns the current resource value associated with a given name and
918optionally sets a new value. Setting values is most useful in the C<init> 1261optionally sets a new value. Setting values is most useful in the C<init>
927likely change). 1270likely change).
928 1271
929Please note that resource strings will currently only be freed when the 1272Please note that resource strings will currently only be freed when the
930terminal is destroyed, so changing options frequently will eat memory. 1273terminal is destroyed, so changing options frequently will eat memory.
931 1274
932Here is a a likely non-exhaustive list of resource names, not all of which 1275Here is a likely non-exhaustive list of resource names, not all of which
933are supported in every build, please see the source file F</src/rsinc.h> 1276are supported in every build, please see the source file F</src/rsinc.h>
934to see the actual list: 1277to see the actual list:
935 1278
936 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
937 borderLess color cursorBlink cursorUnderline cutchars delete_key 1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
938 display_name embed ext_bwidth fade font geometry hold iconName 1281 display_name embed ext_bwidth fade font geometry hold iconName
939 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles
940 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
941 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
942 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
943 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
944 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
945 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
946 shade term_name title transparent transparent_all tripleclickwords 1289 secondaryScreen secondaryScroll shade term_name title
947 utmpInhibit visualBell 1290 transient_for transparent transparent_all tripleclickwords utmpInhibit
1291 visualBell
948 1292
949=cut 1293=cut
950 1294
951sub resource($$;$) { 1295sub resource($$;$) {
952 my ($self, $name) = (shift, shift); 1296 my ($self, $name) = (shift, shift);
953 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1297 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
954 &urxvt::term::_resource 1298 goto &urxvt::term::_resource
955} 1299}
956 1300
957=item $value = $term->x_resource ($pattern) 1301=item $value = $term->x_resource ($pattern)
958 1302
959Returns the X-Resource for the given pattern, excluding the program or 1303Returns the X-Resource for the given pattern, excluding the program or
1042 1386
1043The methods currently supported on C<urxvt::overlay> objects are: 1387The methods currently supported on C<urxvt::overlay> objects are:
1044 1388
1045=over 4 1389=over 4
1046 1390
1047=item $overlay->set ($x, $y, $text, $rend) 1391=item $overlay->set ($x, $y, $text[, $rend])
1048 1392
1049Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1393Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1050text in rxvt-unicode's special encoding and an array of rendition values 1394text in rxvt-unicode's special encoding and an array of rendition values
1051at a specific position inside the overlay. 1395at a specific position inside the overlay.
1396
1397If C<$rend> is missing, then the rendition will not be changed.
1052 1398
1053=item $overlay->hide 1399=item $overlay->hide
1054 1400
1055If visible, hide the overlay, but do not destroy it. 1401If visible, hide the overlay, but do not destroy it.
1056 1402
1126 1472
1127Normally its not a good idea to use this function, as programs might be 1473Normally its not a good idea to use this function, as programs might be
1128confused by changes in cursor position or scrolling. Its useful inside a 1474confused by changes in cursor position or scrolling. Its useful inside a
1129C<on_add_lines> hook, though. 1475C<on_add_lines> hook, though.
1130 1476
1477=item $term->scr_change_screen ($screen)
1478
1479Switch to given screen - 0 primary, 1 secondary.
1480
1131=item $term->cmd_parse ($octets) 1481=item $term->cmd_parse ($octets)
1132 1482
1133Similar to C<scr_add_lines>, but the argument must be in the 1483Similar to C<scr_add_lines>, but the argument must be in the
1134locale-specific encoding of the terminal and can contain command sequences 1484locale-specific encoding of the terminal and can contain command sequences
1135(escape codes) that will be interpreted. 1485(escape codes) that will be interpreted.
1145Replaces the event mask of the pty watcher by the given event mask. Can 1495Replaces the event mask of the pty watcher by the given event mask. Can
1146be used to suppress input and output handling to the pty/tty. See the 1496be used to suppress input and output handling to the pty/tty. See the
1147description of C<< urxvt::timer->events >>. Make sure to always restore 1497description of C<< urxvt::timer->events >>. Make sure to always restore
1148the previous value. 1498the previous value.
1149 1499
1500=item $fd = $term->pty_fd
1501
1502Returns the master file descriptor for the pty in use, or C<-1> if no pty
1503is used.
1504
1150=item $windowid = $term->parent 1505=item $windowid = $term->parent
1151 1506
1152Return the window id of the toplevel window. 1507Return the window id of the toplevel window.
1153 1508
1154=item $windowid = $term->vt 1509=item $windowid = $term->vt
1160Adds the specified events to the vt event mask. Useful e.g. when you want 1515Adds the specified events to the vt event mask. Useful e.g. when you want
1161to receive pointer events all the times: 1516to receive pointer events all the times:
1162 1517
1163 $term->vt_emask_add (urxvt::PointerMotionMask); 1518 $term->vt_emask_add (urxvt::PointerMotionMask);
1164 1519
1520=item $term->focus_in
1521
1522=item $term->focus_out
1523
1524=item $term->key_press ($state, $keycode[, $time])
1525
1526=item $term->key_release ($state, $keycode[, $time])
1527
1528Deliver various fake events to to terminal.
1529
1165=item $window_width = $term->width 1530=item $window_width = $term->width
1166 1531
1167=item $window_height = $term->height 1532=item $window_height = $term->height
1168 1533
1169=item $font_width = $term->fwidth 1534=item $font_width = $term->fwidth
1182 1547
1183=item $max_scrollback = $term->saveLines 1548=item $max_scrollback = $term->saveLines
1184 1549
1185=item $nrow_plus_saveLines = $term->total_rows 1550=item $nrow_plus_saveLines = $term->total_rows
1186 1551
1187=item $lines_in_scrollback = $term->nsaved 1552=item $topmost_scrollback_row = $term->top_row
1188 1553
1189Return various integers describing terminal characteristics. 1554Return various integers describing terminal characteristics.
1190 1555
1191=item $x_display = $term->display_id 1556=item $x_display = $term->display_id
1192 1557
1199=item $env = $term->env 1564=item $env = $term->env
1200 1565
1201Returns a copy of the environment in effect for the terminal as a hashref 1566Returns a copy of the environment in effect for the terminal as a hashref
1202similar to C<\%ENV>. 1567similar to C<\%ENV>.
1203 1568
1569=item @envv = $term->envv
1570
1571Returns the environment as array of strings of the form C<VAR=VALUE>.
1572
1573=item @argv = $term->argv
1574
1575Return the argument vector as this terminal, similar to @ARGV, but
1576includes the program name as first element.
1577
1204=cut 1578=cut
1205 1579
1206sub env { 1580sub env {
1207 if (my $env = $_[0]->_env) {
1208 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1581 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1209 } else {
1210 +{ %ENV }
1211 }
1212} 1582}
1213 1583
1214=item $modifiermask = $term->ModLevel3Mask 1584=item $modifiermask = $term->ModLevel3Mask
1215 1585
1216=item $modifiermask = $term->ModMetaMask 1586=item $modifiermask = $term->ModMetaMask
1218=item $modifiermask = $term->ModNumLockMask 1588=item $modifiermask = $term->ModNumLockMask
1219 1589
1220Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1590Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1221AltGr), the meta key (often Alt) and the num lock key, if applicable. 1591AltGr), the meta key (often Alt) and the num lock key, if applicable.
1222 1592
1593=item $screen = $term->current_screen
1594
1595Returns the currently displayed screen (0 primary, 1 secondary).
1596
1597=item $cursor_is_hidden = $term->hidden_cursor
1598
1599Returns whether the cursor is currently hidden or not.
1600
1223=item $view_start = $term->view_start ([$newvalue]) 1601=item $view_start = $term->view_start ([$newvalue])
1224 1602
1225Returns the negative row number of the topmost line. Minimum value is 1603Returns the row number of the topmost displayed line. Maximum value is
1226C<0>, which displays the normal terminal contents. Larger values scroll 1604C<0>, which displays the normal terminal contents. Lower values scroll
1227this many lines into the scrollback buffer. 1605this many lines into the scrollback buffer.
1228 1606
1229=item $term->want_refresh 1607=item $term->want_refresh
1230 1608
1231Requests a screen refresh. At the next opportunity, rxvt-unicode will 1609Requests a screen refresh. At the next opportunity, rxvt-unicode will
1234 1612
1235Used after changing terminal contents to display them. 1613Used after changing terminal contents to display them.
1236 1614
1237=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1615=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1238 1616
1239Returns the text of the entire row with number C<$row_number>. Row C<0> 1617Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1240is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1618is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1241terminal line. The scrollback buffer starts at line C<-1> and extends to
1242line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1619terminal line. Nothing will be returned if a nonexistent line
1243is requested. 1620is requested.
1244 1621
1245If C<$new_text> is specified, it will replace characters in the current 1622If C<$new_text> is specified, it will replace characters in the current
1246line, starting at column C<$start_col> (default C<0>), which is useful 1623line, starting at column C<$start_col> (default C<0>), which is useful
1247to replace only parts of a line. The font index in the rendition will 1624to replace only parts of a line. The font index in the rendition will
1248automatically be updated. 1625automatically be updated.
1249 1626
1250C<$text> is in a special encoding: tabs and wide characters that use more 1627C<$text> is in a special encoding: tabs and wide characters that use more
1251than one cell when displayed are padded with urxvt::NOCHAR characters 1628than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1252(C<chr 65535>). Characters with combining characters and other characters 1629characters. Characters with combining characters and other characters that
1253that do not fit into the normal tetx encoding will be replaced with 1630do not fit into the normal text encoding will be replaced with characters
1254characters in the private use area. 1631in the private use area.
1255 1632
1256You have to obey this encoding when changing text. The advantage is 1633You have to obey this encoding when changing text. The advantage is
1257that C<substr> and similar functions work on screen cells and not on 1634that C<substr> and similar functions work on screen cells and not on
1258characters. 1635characters.
1259 1636
1403where one character corresponds to one screen cell. See 1780where one character corresponds to one screen cell. See
1404C<< $term->ROW_t >> for details. 1781C<< $term->ROW_t >> for details.
1405 1782
1406=item $string = $term->special_decode $text 1783=item $string = $term->special_decode $text
1407 1784
1408Converts rxvt-unicodes text reprsentation into a perl string. See 1785Converts rxvt-unicodes text representation into a perl string. See
1409C<< $term->ROW_t >> for details. 1786C<< $term->ROW_t >> for details.
1410 1787
1411=item $success = $term->grab_button ($button, $modifiermask) 1788=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1412 1789
1790=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1791
1413Registers a synchronous button grab. See the XGrabButton manpage. 1792Register/unregister a synchronous button grab. See the XGrabButton
1793manpage.
1414 1794
1415=item $success = $term->grab ($eventtime[, $sync]) 1795=item $success = $term->grab ($eventtime[, $sync])
1416 1796
1417Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1797Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1418synchronous (C<$sync> is true). Also remembers the grab timestampe. 1798synchronous (C<$sync> is true). Also remembers the grab timestamp.
1419 1799
1420=item $term->allow_events_async 1800=item $term->allow_events_async
1421 1801
1422Calls XAllowEvents with AsyncBoth for the most recent grab. 1802Calls XAllowEvents with AsyncBoth for the most recent grab.
1423 1803
1433=item $term->ungrab 1813=item $term->ungrab
1434 1814
1435Calls XUngrab for the most recent grab. Is called automatically on 1815Calls XUngrab for the most recent grab. Is called automatically on
1436evaluation errors, as it is better to lose the grab in the error case as 1816evaluation errors, as it is better to lose the grab in the error case as
1437the session. 1817the session.
1818
1819=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820
1821=item $atom_name = $term->XGetAtomName ($atom)
1822
1823=item @atoms = $term->XListProperties ($window)
1824
1825=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826
1827=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828
1829=item $term->XDeleteProperty ($window, $property)
1830
1831=item $window = $term->DefaultRootWindow
1832
1833=item $term->XReparentWindow ($window, $parent, [$x, $y])
1834
1835=item $term->XMapWindow ($window)
1836
1837=item $term->XUnmapWindow ($window)
1838
1839=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1840
1841=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842
1843=item $term->XChangeInput ($window, $add_events[, $del_events])
1844
1845Various X or X-related functions. The C<$term> object only serves as
1846the source of the display, otherwise those functions map more-or-less
1847directory onto the X functions of the same name.
1438 1848
1439=back 1849=back
1440 1850
1441=cut 1851=cut
1442 1852
1506 my ($self, $text, $cb) = @_; 1916 my ($self, $text, $cb) = @_;
1507 1917
1508 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1918 $self->add_item ({ type => "button", text => $text, activate => $cb});
1509} 1919}
1510 1920
1511=item $popup->add_toggle ($text, $cb, $initial_value) 1921=item $popup->add_toggle ($text, $initial_value, $cb)
1512 1922
1513Adds a toggle/checkbox item to the popup. Teh callback gets called 1923Adds a toggle/checkbox item to the popup. The callback gets called
1514whenever it gets toggled, with a boolean indicating its value as its first 1924whenever it gets toggled, with a boolean indicating its new value as its
1515argument. 1925first argument.
1516 1926
1517=cut 1927=cut
1518 1928
1519sub add_toggle { 1929sub add_toggle {
1520 my ($self, $text, $cb, $value) = @_; 1930 my ($self, $text, $value, $cb) = @_;
1521 1931
1522 my $item; $item = { 1932 my $item; $item = {
1523 type => "button", 1933 type => "button",
1524 text => " $text", 1934 text => " $text",
1525 value => $value, 1935 value => $value,
1544 my $env = $self->{term}->env; 1954 my $env = $self->{term}->env;
1545 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1955 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1546 delete $env->{LC_ALL}; 1956 delete $env->{LC_ALL};
1547 $env->{LC_CTYPE} = $self->{term}->locale; 1957 $env->{LC_CTYPE} = $self->{term}->locale;
1548 1958
1549 urxvt::term->new ($env, $self->{term}->resource ("name"), 1959 my $term = urxvt::term->new (
1550 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1960 $env, "popup",
1961 "--perl-lib" => "", "--perl-ext-common" => "",
1962 "-pty-fd" => -1, "-sl" => 0,
1963 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1551 "--transient-for" => $self->{term}->parent, 1964 "--transient-for" => $self->{term}->parent,
1552 "-display" => $self->{term}->display_id, 1965 "-display" => $self->{term}->display_id,
1553 "-pe" => "urxvt-popup") 1966 "-pe" => "urxvt-popup",
1554 or die "unable to create popup window\n"; 1967 ) or die "unable to create popup window\n";
1968
1969 unless (delete $term->{urxvt_popup_init_done}) {
1970 $term->ungrab;
1971 $term->destroy;
1972 die "unable to initialise popup window\n";
1973 }
1555} 1974}
1556 1975
1557sub DESTROY { 1976sub DESTROY {
1558 my ($self) = @_; 1977 my ($self) = @_;
1559 1978
1560 delete $self->{term}{_destroy}{$self}; 1979 delete $self->{term}{_destroy}{$self};
1561 $self->{term}->ungrab; 1980 $self->{term}->ungrab;
1562} 1981}
1563 1982
1564=back 1983=back
1984
1985=cut
1986
1987package urxvt::watcher;
1565 1988
1566=head2 The C<urxvt::timer> Class 1989=head2 The C<urxvt::timer> Class
1567 1990
1568This class implements timer watchers/events. Time is represented as a 1991This class implements timer watchers/events. Time is represented as a
1569fractional number of seconds since the epoch. Example: 1992fractional number of seconds since the epoch. Example:
1573 ->new 1996 ->new
1574 ->interval (1) 1997 ->interval (1)
1575 ->cb (sub { 1998 ->cb (sub {
1576 $term->{overlay}->set (0, 0, 1999 $term->{overlay}->set (0, 0,
1577 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2000 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1578 }); 2001 });
1579 2002
1580=over 4 2003=over 4
1581 2004
1582=item $timer = new urxvt::timer 2005=item $timer = new urxvt::timer
1583 2006
1607Start the timer. 2030Start the timer.
1608 2031
1609=item $timer = $timer->start ($tstamp) 2032=item $timer = $timer->start ($tstamp)
1610 2033
1611Set the event trigger time to C<$tstamp> and start the timer. 2034Set the event trigger time to C<$tstamp> and start the timer.
2035
2036=item $timer = $timer->after ($delay)
2037
2038Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1612 2039
1613=item $timer = $timer->stop 2040=item $timer = $timer->stop
1614 2041
1615Stop the timer. 2042Stop the timer.
1616 2043
1622 2049
1623 $term->{socket} = ... 2050 $term->{socket} = ...
1624 $term->{iow} = urxvt::iow 2051 $term->{iow} = urxvt::iow
1625 ->new 2052 ->new
1626 ->fd (fileno $term->{socket}) 2053 ->fd (fileno $term->{socket})
1627 ->events (urxvt::EVENT_READ) 2054 ->events (urxvt::EV_READ)
1628 ->start 2055 ->start
1629 ->cb (sub { 2056 ->cb (sub {
1630 my ($iow, $revents) = @_; 2057 my ($iow, $revents) = @_;
1631 # $revents must be 1 here, no need to check 2058 # $revents must be 1 here, no need to check
1632 sysread $term->{socket}, my $buf, 8192 2059 sysread $term->{socket}, my $buf, 8192
1645Set the callback to be called when io events are triggered. C<$reventmask> 2072Set the callback to be called when io events are triggered. C<$reventmask>
1646is a bitset as described in the C<events> method. 2073is a bitset as described in the C<events> method.
1647 2074
1648=item $iow = $iow->fd ($fd) 2075=item $iow = $iow->fd ($fd)
1649 2076
1650Set the filedescriptor (not handle) to watch. 2077Set the file descriptor (not handle) to watch.
1651 2078
1652=item $iow = $iow->events ($eventmask) 2079=item $iow = $iow->events ($eventmask)
1653 2080
1654Set the event mask to watch. The only allowed values are 2081Set the event mask to watch. The only allowed values are
1655C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2082C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1656together, or C<urxvt::EVENT_NONE>. 2083together, or C<urxvt::EV_NONE>.
1657 2084
1658=item $iow = $iow->start 2085=item $iow = $iow->start
1659 2086
1660Start watching for requested events on the given handle. 2087Start watching for requested events on the given handle.
1661 2088
1662=item $iow = $iow->stop 2089=item $iow = $iow->stop
1663 2090
1664Stop watching for events on the given filehandle. 2091Stop watching for events on the given file handle.
2092
2093=back
2094
2095=head2 The C<urxvt::iw> Class
2096
2097This class implements idle watchers, that get called automatically when
2098the process is idle. They should return as fast as possible, after doing
2099some useful work.
2100
2101=over 4
2102
2103=item $iw = new urxvt::iw
2104
2105Create a new idle watcher object in stopped state.
2106
2107=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2108
2109Set the callback to be called when the watcher triggers.
2110
2111=item $timer = $timer->start
2112
2113Start the watcher.
2114
2115=item $timer = $timer->stop
2116
2117Stop the watcher.
2118
2119=back
2120
2121=head2 The C<urxvt::pw> Class
2122
2123This class implements process watchers. They create an event whenever a
2124process exits, after which they stop automatically.
2125
2126 my $pid = fork;
2127 ...
2128 $term->{pw} = urxvt::pw
2129 ->new
2130 ->start ($pid)
2131 ->cb (sub {
2132 my ($pw, $exit_status) = @_;
2133 ...
2134 });
2135
2136=over 4
2137
2138=item $pw = new urxvt::pw
2139
2140Create a new process watcher in stopped state.
2141
2142=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2143
2144Set the callback to be called when the timer triggers.
2145
2146=item $pw = $timer->start ($pid)
2147
2148Tells the watcher to start watching for process C<$pid>.
2149
2150=item $pw = $pw->stop
2151
2152Stop the watcher.
1665 2153
1666=back 2154=back
1667 2155
1668=head1 ENVIRONMENT 2156=head1 ENVIRONMENT
1669 2157
1678 2166
1679=item >= 3 - script loading and management 2167=item >= 3 - script loading and management
1680 2168
1681=item >=10 - all called hooks 2169=item >=10 - all called hooks
1682 2170
1683=item >=11 - hook reutrn values 2171=item >=11 - hook return values
1684 2172
1685=back 2173=back
1686 2174
1687=head1 AUTHOR 2175=head1 AUTHOR
1688 2176
1690 http://software.schmorp.de/pkg/rxvt-unicode 2178 http://software.schmorp.de/pkg/rxvt-unicode
1691 2179
1692=cut 2180=cut
1693 2181
16941 21821
2183
2184# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines