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.95 by elmex, Tue Jan 17 13:19:45 2006 UTC vs.
Revision 1.173 by root, Wed Nov 5 12:45:36 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 following bindable keyboard commands: 85This extension also offers following bindable keyboard commands:
76 90
77Rot-13 the selection when activated. Used via keyboard trigger: 91Rot-13 the selection when activated. Used via keyboard trigger:
78 92
79 URxvt.keysym.C-M-r: perl:selection:rot13 93 URxvt.keysym.C-M-r: perl:selection:rot13
80 94
81=item remote-pastebin
82
83Upload the selection as textfile to a remote site.
84
85 URxvt.keysym.C-M-e: perl:selection:remote-pastebin
86
87To set the command to upload the file set this resource:
88
89 URxvt.selection-pastebin-cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
90
91The % is the placeholder for the textfile. The name of the textfile is the hex encoded
92md5 sum of the selection.
93After an successful upload the selection will be replaced by the following url
94(the % is the placeholder for the filename):
95
96 URxvt.selection-pastebin-url: http://www.ta-sa.org/files/txt/%
97
98=back 95=back
99 96
100=item option-popup (enabled by default) 97=item option-popup (enabled by default)
101 98
102Binds 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
103runtime. 100runtime.
104 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
105=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
106 120
107Binds 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
108text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
109evalution, 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 };
110 143
111=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
112 145
113Adds regex search functionality to the scrollback buffer, triggered 146Adds regex search functionality to the scrollback buffer, triggered
114by 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
119search. 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>
120search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
121bottom. 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
122was 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
123additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
124selection. 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.
125 189
126=item selection-autotransform 190=item selection-autotransform
127 191
128This selection allows you to do automatic transforms on a selection 192This selection allows you to do automatic transforms on a selection
129whenever a selection is made. 193whenever a selection is made.
142 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/
143 207
144And 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
145paste directly into your (vi :) editor: 209paste directly into your (vi :) editor:
146 210
147 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/
148 212
149Of 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 :)
150 214
151To expand the example above to typical perl error messages ("XXX at 215To expand the example above to typical perl error messages ("XXX at
152FILENAME line YYY."), you need a slightly more elaborate solution: 216FILENAME line YYY."), you need a slightly more elaborate solution:
153 217
154 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
155 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/
156 220
157The 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
158every error message as a selection pattern, and the second line transforms 222every error message as a selection pattern, and the second line transforms
159the message into vi commands to load the file. 223the message into vi commands to load the file.
160 224
161=item mark-urls 225=item tabbed
162 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
163Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
164make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
165resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
166the 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).
307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
167 313
168=item block-graphics-to-ascii 314=item block-graphics-to-ascii
169 315
170A not very useful example of filtering all text output to the terminal, 316A not very useful example of filtering all text output to the terminal
171by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
172similar-looking ascii character. 318similar-looking ascii character.
173 319
174=item digital-clock 320=item digital-clock
175 321
176Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
323
324=item remote-clipboard
325
326Somewhat of a misnomer, this extension adds two menu entries to the
327selection popup that allows one to run external commands to store the
328selection somewhere and fetch it again.
329
330We use it to implement a "distributed selection mechanism", which just
331means that one command uploads the file to a remote server, and another
332reads it.
333
334The commands can be set using the C<URxvt.remote-selection.store> and
335C<URxvt.remote-selection.fetch> resources. The first should read the
336selection to store from STDIN (always in UTF-8), the second should provide
337the selection data on STDOUT (also in UTF-8).
338
339The defaults (which are likely useless to you) use rsh and cat:
340
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343
344=item selection-pastebin
345
346This is a little rarely useful extension that Uploads the selection as
347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.).
350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
352i.e.
353
354 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
355
356Pressing this combination runs a command with C<%> replaced by the name of
357the textfile. This command can be set via a resource:
358
359 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
360
361And the default is likely not useful to anybody but the few people around
362here :)
363
364The name of the textfile is the hex encoded md5 sum of the selection, so
365the same content should lead to the same filename.
366
367After a successful upload the selection will be replaced by the text given
368in the C<selection-pastebin-url> resource (again, the % is the placeholder
369for the filename):
370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file
376or not.
177 377
178=item example-refresh-hooks 378=item example-refresh-hooks
179 379
180Displays a very simple digital clock in the upper right corner of the 380Displays a very simple digital clock in the upper right corner of the
181window. Illustrates overwriting the refresh callbacks to create your own 381window. Illustrates overwriting the refresh callbacks to create your own
221 421
222=back 422=back
223 423
224=head2 Extension Objects 424=head2 Extension Objects
225 425
226Very perl extension is a perl class. A separate perl object is created 426Every perl extension is a perl class. A separate perl object is created
227for each terminal and each extension and passed as the first parameter to 427for each terminal, and each terminal has its own set of extenion objects,
228hooks. So extensions can use their C<$self> object without having to think 428which are passed as the first parameter to hooks. So extensions can use
229about other extensions, with the exception of methods and members that 429their C<$self> object without having to think about clashes with other
430extensions or other terminals, with the exception of methods and members
230begin with an underscore character C<_>: these are reserved for internal 431that begin with an underscore character C<_>: these are reserved for
231use. 432internal use.
232 433
233Although it isn't a C<urxvt::term> object, you can call all methods of the 434Although it isn't a C<urxvt::term> object, you can call all methods of the
234C<urxvt::term> class on this object. 435C<urxvt::term> class on this object.
235 436
236It has the following methods and data members: 437It has the following methods and data members:
257=head2 Hooks 458=head2 Hooks
258 459
259The following subroutines can be declared in extension files, and will be 460The following subroutines can be declared in extension files, and will be
260called whenever the relevant event happens. 461called whenever the relevant event happens.
261 462
262The first argument passed to them is an extension oject as described in 463The first argument passed to them is an extension object as described in
263the in the C<Extension Objects> section. 464the in the C<Extension Objects> section.
264 465
265B<All> of these hooks must return a boolean value. If it is true, then the 466B<All> of these hooks must return a boolean value. If any of the called
266event counts as being I<consumed>, and the invocation of other hooks is 467hooks returns true, then the event counts as being I<consumed>, and the
267skipped, and the relevant action might not be carried out by the C++ code. 468relevant action might not be carried out by the C++ code.
268 469
269I<< When in doubt, return a false value (preferably C<()>). >> 470I<< When in doubt, return a false value (preferably C<()>). >>
270 471
271=over 4 472=over 4
272 473
273=item on_init $term 474=item on_init $term
274 475
275Called after a new terminal object has been initialized, but before 476Called after a new terminal object has been initialized, but before
276windows are created or the command gets run. Most methods are unsafe to 477windows are created or the command gets run. Most methods are unsafe to
277call or deliver senseless data, as terminal size and other characteristics 478call or deliver senseless data, as terminal size and other characteristics
278have not yet been determined. You can safely query and change resources, 479have not yet been determined. You can safely query and change resources
279though. 480and options, though. For many purposes the C<on_start> hook is a better
481place.
482
483=item on_start $term
484
485Called at the very end of initialisation of a new terminal, just before
486trying to map (display) the toplevel and returning to the main loop.
487
488=item on_destroy $term
489
490Called whenever something tries to destroy terminal, when the terminal is
491still fully functional (not for long, though).
280 492
281=item on_reset $term 493=item on_reset $term
282 494
283Called after the screen is "reset" for any reason, such as resizing or 495Called after the screen is "reset" for any reason, such as resizing or
284control sequences. Here is where you can react on changes to size-related 496control sequences. Here is where you can react on changes to size-related
285variables. 497variables.
286 498
287=item on_start $term 499=item on_child_start $term, $pid
288 500
289Called at the very end of initialisation of a new terminal, just before 501Called just after the child process has been C<fork>ed.
290returning to the mainloop. 502
503=item on_child_exit $term, $status
504
505Called just after the child process has exited. C<$status> is the status
506from C<waitpid>.
291 507
292=item on_sel_make $term, $eventtime 508=item on_sel_make $term, $eventtime
293 509
294Called whenever a selection has been made by the user, but before the 510Called whenever a selection has been made by the user, but before the
295selection text is copied, so changes to the beginning, end or type of the 511selection text is copied, so changes to the beginning, end or type of the
302 518
303Called whenever a selection has been copied, but before the selection is 519Called whenever a selection has been copied, but before the selection is
304requested from the server. The selection text can be queried and changed 520requested from the server. The selection text can be queried and changed
305by calling C<< $term->selection >>. 521by calling C<< $term->selection >>.
306 522
307Returning a true value aborts selection grabbing. It will still be hilighted. 523Returning a true value aborts selection grabbing. It will still be highlighted.
308 524
309=item on_sel_extend $term 525=item on_sel_extend $term
310 526
311Called whenever the user tries to extend the selection (e.g. with a double 527Called whenever the user tries to extend the selection (e.g. with a double
312click) and is either supposed to return false (normal operation), or 528click) and is either supposed to return false (normal operation), or
313should extend the selection itelf and return true to suppress the built-in 529should extend the selection itself and return true to suppress the built-in
314processing. This can happen multiple times, as long as the callback 530processing. This can happen multiple times, as long as the callback
315returns true, it will be called on every further click by the user and is 531returns true, it will be called on every further click by the user and is
316supposed to enlarge the selection more and more, if possible. 532supposed to enlarge the selection more and more, if possible.
317 533
318See the F<selection> example extension. 534See the F<selection> example extension.
319 535
320=item on_view_change $term, $offset 536=item on_view_change $term, $offset
321 537
322Called whenever the view offset changes, i..e the user or program 538Called whenever the view offset changes, i.e. the user or program
323scrolls. Offset C<0> means display the normal terminal, positive values 539scrolls. Offset C<0> means display the normal terminal, positive values
324show this many lines of scrollback. 540show this many lines of scrollback.
325 541
326=item on_scroll_back $term, $lines, $saved 542=item on_scroll_back $term, $lines, $saved
327 543
331 547
332It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 548It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
333$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 549$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
334number of lines that will be in the scrollback buffer. 550number of lines that will be in the scrollback buffer.
335 551
336=item on_osc_seq $term, $string 552=item on_osc_seq $term, $op, $args, $resp
553
554Called on every OSC sequence and can be used to suppress it or modify its
555behaviour. The default should be to return an empty list. A true value
556suppresses execution of the request completely. Make sure you don't get
557confused by recursive invocations when you output an OSC sequence within
558this callback.
559
560C<on_osc_seq_perl> should be used for new behaviour.
561
562=item on_osc_seq_perl $term, $args, $resp
337 563
338Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 564Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
339operating system command) is processed. Cursor position and other state 565operating system command) is processed. Cursor position and other state
340information is up-to-date when this happens. For interoperability, the 566information is up-to-date when this happens. For interoperability, the
341string should start with the extension name and a colon, to distinguish 567string should start with the extension name (sans -osc) and a semicolon,
342it from commands for other extensions, and this might be enforced in the 568to distinguish it from commands for other extensions, and this might be
343future. 569enforced in the future.
570
571For example, C<overlay-osc> uses this:
572
573 sub on_osc_seq_perl {
574 my ($self, $osc, $resp) = @_;
575
576 return unless $osc =~ s/^overlay;//;
577
578 ... process remaining $osc string
579 }
344 580
345Be careful not ever to trust (in a security sense) the data you receive, 581Be careful not ever to trust (in a security sense) the data you receive,
346as its source can not easily be controleld (e-mail content, messages from 582as its source can not easily be controlled (e-mail content, messages from
347other users on the same system etc.). 583other users on the same system etc.).
584
585For responses, C<$resp> contains the end-of-args separator used by the
586sender.
348 587
349=item on_add_lines $term, $string 588=item on_add_lines $term, $string
350 589
351Called whenever text is about to be output, with the text as argument. You 590Called whenever text is about to be output, with the text as argument. You
352can filter/change and output the text yourself by returning a true value 591can filter/change and output the text yourself by returning a true value
373later with the already-modified line (e.g. if unrelated parts change), so 612later with the already-modified line (e.g. if unrelated parts change), so
374you cannot just toggle rendition bits, but only set them. 613you cannot just toggle rendition bits, but only set them.
375 614
376=item on_refresh_begin $term 615=item on_refresh_begin $term
377 616
378Called just before the screen gets redrawn. Can be used for overlay 617Called just before the screen gets redrawn. Can be used for overlay or
379or similar effects by modify terminal contents in refresh_begin, and 618similar effects by modifying the terminal contents in refresh_begin, and
380restoring them in refresh_end. The built-in overlay and selection display 619restoring them in refresh_end. The built-in overlay and selection display
381code is run after this hook, and takes precedence. 620code is run after this hook, and takes precedence.
382 621
383=item on_refresh_end $term 622=item on_refresh_end $term
384 623
385Called just after the screen gets redrawn. See C<on_refresh_begin>. 624Called just after the screen gets redrawn. See C<on_refresh_begin>.
386 625
387=item on_keyboard_command $term, $string 626=item on_user_command $term, $string
388 627
389Called whenever the user presses a key combination that has a 628Called whenever a user-configured event is being activated (e.g. via
390C<perl:string> action bound to it (see description of the B<keysym> 629a C<perl:string> action bound to a key, see description of the B<keysym>
391resource in the @@RXVT_NAME@@(1) manpage). 630resource in the @@RXVT_NAME@@(1) manpage).
631
632The event is simply the action string. This interface is assumed to change
633slightly in the future.
634
635=item on_resize_all_windows $tern, $new_width, $new_height
636
637Called just after the new window size has been calculated, but before
638windows are actually being resized or hints are being set. If this hook
639returns TRUE, setting of the window hints is being skipped.
392 640
393=item on_x_event $term, $event 641=item on_x_event $term, $event
394 642
395Called on every X event received on the vt window (and possibly other 643Called on every X event received on the vt window (and possibly other
396windows). Should only be used as a last resort. Most event structure 644windows). Should only be used as a last resort. Most event structure
397members are not passed. 645members are not passed.
398 646
647=item on_root_event $term, $event
648
649Like C<on_x_event>, but is called for events on the root window.
650
399=item on_focus_in $term 651=item on_focus_in $term
400 652
401Called whenever the window gets the keyboard focus, before rxvt-unicode 653Called whenever the window gets the keyboard focus, before rxvt-unicode
402does focus in processing. 654does focus in processing.
403 655
404=item on_focus_out $term 656=item on_focus_out $term
405 657
406Called wheneever the window loses keyboard focus, before rxvt-unicode does 658Called whenever the window loses keyboard focus, before rxvt-unicode does
407focus out processing. 659focus out processing.
660
661=item on_configure_notify $term, $event
662
663=item on_property_notify $term, $event
408 664
409=item on_key_press $term, $event, $keysym, $octets 665=item on_key_press $term, $event, $keysym, $octets
410 666
411=item on_key_release $term, $event, $keysym 667=item on_key_release $term, $event, $keysym
412 668
422 678
423Called whenever the corresponding X event is received for the terminal If 679Called whenever the corresponding X event is received for the terminal If
424the hook returns true, then the even will be ignored by rxvt-unicode. 680the hook returns true, then the even will be ignored by rxvt-unicode.
425 681
426The event is a hash with most values as named by Xlib (see the XEvent 682The event is a hash with most values as named by Xlib (see the XEvent
427manpage), with the additional members C<row> and C<col>, which are the row 683manpage), with the additional members C<row> and C<col>, which are the
428and column under the mouse cursor. 684(real, not screen-based) row and column under the mouse cursor.
429 685
430C<on_key_press> additionally receives the string rxvt-unicode would 686C<on_key_press> additionally receives the string rxvt-unicode would
431output, if any, in locale-specific encoding. 687output, if any, in locale-specific encoding.
432 688
433subwindow. 689subwindow.
690
691=item on_client_message $term, $event
692
693=item on_wm_protocols $term, $event
694
695=item on_wm_delete_window $term, $event
696
697Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
434 699
435=back 700=back
436 701
437=cut 702=cut
438 703
444use Scalar::Util (); 709use Scalar::Util ();
445use List::Util (); 710use List::Util ();
446 711
447our $VERSION = 1; 712our $VERSION = 1;
448our $TERM; 713our $TERM;
714our @TERM_INIT;
715our @TERM_EXT;
449our @HOOKNAME; 716our @HOOKNAME;
450our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 717our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
451our %OPTION; 718our %OPTION;
452 719
453our $LIBDIR; 720our $LIBDIR;
454our $RESNAME; 721our $RESNAME;
455our $RESCLASS; 722our $RESCLASS;
456our $RXVTNAME; 723our $RXVTNAME;
457 724
725our $NOCHAR = chr 0xffff;
726
458=head2 Variables in the C<urxvt> Package 727=head2 Variables in the C<urxvt> Package
459 728
460=over 4 729=over 4
461 730
462=item $urxvt::LIBDIR 731=item $urxvt::LIBDIR
474 743
475=item $urxvt::TERM 744=item $urxvt::TERM
476 745
477The current terminal. This variable stores the current C<urxvt::term> 746The current terminal. This variable stores the current C<urxvt::term>
478object, whenever a callback/hook is executing. 747object, whenever a callback/hook is executing.
748
749=item @urxvt::TERM_INIT
750
751All code references in this array will be called as methods of the next newly
752created C<urxvt::term> object (during the C<on_init> phase). The array
753gets cleared before the code references that were in it are being executed,
754so references can push themselves onto it again if they so desire.
755
756This complements to the perl-eval command line option, but gets executed
757first.
758
759=item @urxvt::TERM_EXT
760
761Works similar to C<@TERM_INIT>, but contains perl package/class names, which
762get registered as normal extensions after calling the hooks in C<@TERM_INIT>
763but before other extensions. Gets cleared just like C<@TERM_INIT>.
479 764
480=back 765=back
481 766
482=head2 Functions in the C<urxvt> Package 767=head2 Functions in the C<urxvt> Package
483 768
498Using this function has the advantage that its output ends up in the 783Using this function has the advantage that its output ends up in the
499correct place, e.g. on stderr of the connecting urxvtc client. 784correct place, e.g. on stderr of the connecting urxvtc client.
500 785
501Messages have a size limit of 1023 bytes currently. 786Messages have a size limit of 1023 bytes currently.
502 787
503=item $is_safe = urxvt::safe 788=item @terms = urxvt::termlist
504 789
505Returns true when it is safe to do potentially unsafe things, such as 790Returns all urxvt::term objects that exist in this process, regardless of
506evaluating perl code specified by the user. This is true when urxvt was 791whether they are started, being destroyed etc., so be careful. Only term
507started setuid or setgid. 792objects that have perl extensions attached will be returned (because there
793is no urxvt::term objet associated with others).
508 794
509=item $time = urxvt::NOW 795=item $time = urxvt::NOW
510 796
511Returns the "current time" (as per the event loop). 797Returns the "current time" (as per the event loop).
512 798
571 857
572=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 858=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
573 859
574=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 860=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
575 861
862=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
863
576Replace the foreground/background colour in the rendition mask with the 864Replace the foreground/background colour in the rendition mask with the
577specified one. 865specified one.
578 866
579=item $value = urxvt::GET_CUSTOM $rend 867=item $value = urxvt::GET_CUSTOM $rend
580 868
589=back 877=back
590 878
591=cut 879=cut
592 880
593BEGIN { 881BEGIN {
594 urxvt->bootstrap;
595
596 # overwrite perl's warn 882 # overwrite perl's warn
597 *CORE::GLOBAL::warn = sub { 883 *CORE::GLOBAL::warn = sub {
598 my $msg = join "", @_; 884 my $msg = join "", @_;
599 $msg .= "\n" 885 $msg .= "\n"
600 unless $msg =~ /\n$/; 886 unless $msg =~ /\n$/;
601 urxvt::warn ($msg); 887 urxvt::warn ($msg);
602 }; 888 };
603
604 # %ENV is the original startup environment
605 delete $ENV{IFS};
606 delete $ENV{CDPATH};
607 delete $ENV{BASH_ENV};
608 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
609} 889}
890
891no warnings 'utf8';
610 892
611my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 893my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
612 894
613sub verbose { 895sub verbose {
614 my ($level, $msg) = @_; 896 my ($level, $msg) = @_;
615 warn "$msg\n" if $level <= $verbosity; 897 warn "$msg\n" if $level <= $verbosity;
616} 898}
617 899
618my $extension_pkg = "extension0000";
619my %extension_pkg; 900my %extension_pkg;
620 901
621# load a single script into its own package, once only 902# load a single script into its own package, once only
622sub extension_package($) { 903sub extension_package($) {
623 my ($path) = @_; 904 my ($path) = @_;
624 905
625 $extension_pkg{$path} ||= do { 906 $extension_pkg{$path} ||= do {
626 my $pkg = "urxvt::" . ($extension_pkg++); 907 $path =~ /([^\/\\]+)$/;
908 my $pkg = $1;
909 $pkg =~ s/[^[:word:]]/_/g;
910 $pkg = "urxvt::ext::$pkg";
627 911
628 verbose 3, "loading extension '$path' into package '$pkg'"; 912 verbose 3, "loading extension '$path' into package '$pkg'";
629 913
630 open my $fh, "<:raw", $path 914 open my $fh, "<:raw", $path
631 or die "$path: $!"; 915 or die "$path: $!";
632 916
633 my $source = untaint 917 my $source =
634 "package $pkg; use strict; use utf8;\n" 918 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
635 . "use base urxvt::term::extension::;\n"
636 . "#line 1 \"$path\"\n{\n" 919 . "#line 1 \"$path\"\n{\n"
637 . (do { local $/; <$fh> }) 920 . (do { local $/; <$fh> })
638 . "\n};\n1"; 921 . "\n};\n1";
639 922
640 eval $source 923 eval $source
651 local $TERM = shift; 934 local $TERM = shift;
652 my $htype = shift; 935 my $htype = shift;
653 936
654 if ($htype == 0) { # INIT 937 if ($htype == 0) { # INIT
655 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 938 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
656 939
657 my %ext_arg; 940 my %ext_arg;
658 941
942 {
943 my @init = @TERM_INIT;
944 @TERM_INIT = ();
945 $_->($TERM) for @init;
946 my @pkg = @TERM_EXT;
947 @TERM_EXT = ();
948 $TERM->register_package ($_) for @pkg;
949 }
950
659 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 951 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
660 if ($_ eq "default") { 952 if ($_ eq "default") {
661 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 953 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
662 } elsif (/^-(.*)$/) { 954 } elsif (/^-(.*)$/) {
663 delete $ext_arg{$1}; 955 delete $ext_arg{$1};
664 } elsif (/^([^<]+)<(.*)>$/) { 956 } elsif (/^([^<]+)<(.*)>$/) {
665 push @{ $ext_arg{$1} }, $2; 957 push @{ $ext_arg{$1} }, $2;
666 } else { 958 } else {
667 $ext_arg{$_} ||= []; 959 $ext_arg{$_} ||= [];
668 } 960 }
669 } 961 }
670 962
671 while (my ($ext, $argv) = each %ext_arg) { 963 for my $ext (sort keys %ext_arg) {
672 my @files = grep -f $_, map "$_/$ext", @dirs; 964 my @files = grep -f $_, map "$_/$ext", @dirs;
673 965
674 if (@files) { 966 if (@files) {
675 $TERM->register_package (extension_package $files[0], $argv); 967 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
676 } else { 968 } else {
677 warn "perl extension '$ext' not found in perl library search path\n"; 969 warn "perl extension '$ext' not found in perl library search path\n";
678 } 970 }
679 } 971 }
680 972
686 978
687 if (my $cb = $TERM->{_hook}[$htype]) { 979 if (my $cb = $TERM->{_hook}[$htype]) {
688 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 980 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
689 if $verbosity >= 10; 981 if $verbosity >= 10;
690 982
691 keys %$cb; 983 for my $pkg (keys %$cb) {
692
693 while (my ($pkg, $cb) = each %$cb) {
694 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 984 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
695 and last; 985 $retval ||= $retval_;
696 986
697 if ($@) { 987 if ($@) {
698 $TERM->ungrab; # better to lose the grab than the session 988 $TERM->ungrab; # better to lose the grab than the session
699 warn $@; 989 warn $@;
700 } 990 }
713 } 1003 }
714 1004
715 $retval 1005 $retval
716} 1006}
717 1007
718sub exec_async(@) { 1008sub SET_COLOR($$$) {
719 my $pid = fork; 1009 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1010}
720 1011
721 return 1012sub rend2mask {
722 if !defined $pid or $pid; 1013 no strict 'refs';
723 1014 my ($str, $mask) = (@_, 0);
724 %ENV = %{ $TERM->env }; 1015 my %color = ( fg => undef, bg => undef );
725 1016 my @failed;
726 exec @_; 1017 for my $spec ( split /\s+/, $str ) {
727 _exit 255; 1018 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1019 $color{lc($1)} = $2;
1020 } else {
1021 my $neg = $spec =~ s/^[-^]//;
1022 unless ( exists &{"RS_$spec"} ) {
1023 push @failed, $spec;
1024 next;
1025 }
1026 my $cur = &{"RS_$spec"};
1027 if ( $neg ) {
1028 $mask &= ~$cur;
1029 } else {
1030 $mask |= $cur;
1031 }
1032 }
1033 }
1034 ($mask, @color{qw(fg bg)}, \@failed)
728} 1035}
729 1036
730# urxvt::term::extension 1037# urxvt::term::extension
731 1038
732package urxvt::term::extension; 1039package urxvt::term::extension;
803is that you cannot use blocking APIs, but the non-blocking variant should 1110is that you cannot use blocking APIs, but the non-blocking variant should
804work. 1111work.
805 1112
806=cut 1113=cut
807 1114
808our $VERSION = 1; 1115our $VERSION = '3.4';
809 1116
810$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
811push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
812 1119
813sub timer { 1120sub timer {
844 1151
845sub DESTROY { 1152sub DESTROY {
846 $_[0][1]->stop; 1153 $_[0][1]->stop;
847} 1154}
848 1155
849sub condvar { 1156sub one_event {
850 bless \my $flag, urxvt::anyevent::condvar::
851}
852
853sub urxvt::anyevent::condvar::broadcast {
854 ${$_[0]}++;
855}
856
857sub urxvt::anyevent::condvar::wait {
858 unless (${$_[0]}) {
859 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1157 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
860 }
861} 1158}
862 1159
863package urxvt::term; 1160package urxvt::term;
864 1161
865=head2 The C<urxvt::term> Class 1162=head2 The C<urxvt::term> Class
870 1167
871# find on_xxx subs in the package and register them 1168# find on_xxx subs in the package and register them
872# as hooks 1169# as hooks
873sub register_package { 1170sub register_package {
874 my ($self, $pkg, $argv) = @_; 1171 my ($self, $pkg, $argv) = @_;
1172
1173 no strict 'refs';
1174
1175 urxvt::verbose 6, "register package $pkg to $self";
1176
1177 @{"$pkg\::ISA"} = urxvt::term::extension::;
875 1178
876 my $proxy = bless { 1179 my $proxy = bless {
877 _pkg => $pkg, 1180 _pkg => $pkg,
878 argv => $argv, 1181 argv => $argv,
879 }, $pkg; 1182 }, $pkg;
895hash which defines the environment of the new terminal. 1198hash which defines the environment of the new terminal.
896 1199
897Croaks (and probably outputs an error message) if the new instance 1200Croaks (and probably outputs an error message) if the new instance
898couldn't be created. Returns C<undef> if the new instance didn't 1201couldn't be created. Returns C<undef> if the new instance didn't
899initialise perl, and the terminal object otherwise. The C<init> and 1202initialise perl, and the terminal object otherwise. The C<init> and
900C<start> hooks will be called during this call. 1203C<start> hooks will be called before this call returns, and are free to
1204refer to global data (which is race free).
901 1205
902=cut 1206=cut
903 1207
904sub new { 1208sub new {
905 my ($class, $env, @args) = @_; 1209 my ($class, $env, @args) = @_;
906 1210
1211 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1212 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1213
907 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1214 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
908} 1215}
909 1216
910=item $term->destroy 1217=item $term->destroy
911 1218
912Destroy the terminal object (close the window, free resources 1219Destroy the terminal object (close the window, free resources
913etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1220etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
914watchers (timers, io watchers) are still active. 1221watchers (timers, io watchers) are still active.
915 1222
1223=item $term->exec_async ($cmd[, @args])
1224
1225Works like the combination of the C<fork>/C<exec> builtins, which executes
1226("starts") programs in the background. This function takes care of setting
1227the user environment before exec'ing the command (e.g. C<PATH>) and should
1228be preferred over explicit calls to C<exec> or C<system>.
1229
1230Returns the pid of the subprocess or C<undef> on error.
1231
1232=cut
1233
1234sub exec_async {
1235 my $self = shift;
1236
1237 my $pid = fork;
1238
1239 return $pid
1240 if !defined $pid or $pid;
1241
1242 %ENV = %{ $self->env };
1243
1244 exec @_;
1245 urxvt::_exit 255;
1246}
1247
916=item $isset = $term->option ($optval[, $set]) 1248=item $isset = $term->option ($optval[, $set])
917 1249
918Returns true if the option specified by C<$optval> is enabled, and 1250Returns true if the option specified by C<$optval> is enabled, and
919optionally change it. All option values are stored by name in the hash 1251optionally change it. All option values are stored by name in the hash
920C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1252C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
921 1253
922Here is a a likely non-exhaustive list of option names, please see the 1254Here is a likely non-exhaustive list of option names, please see the
923source file F</src/optinc.h> to see the actual list: 1255source file F</src/optinc.h> to see the actual list:
924 1256
925 borderLess console cursorBlink cursorUnderline hold iconic insecure 1257 borderLess console cursorBlink cursorUnderline hold iconic insecure
926 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1258 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
927 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1259 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
928 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1260 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
929 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1261 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
930 tripleclickwords utmpInhibit visualBell 1262 transparent tripleclickwords utmpInhibit visualBell
931 1263
932=item $value = $term->resource ($name[, $newval]) 1264=item $value = $term->resource ($name[, $newval])
933 1265
934Returns the current resource value associated with a given name and 1266Returns the current resource value associated with a given name and
935optionally sets a new value. Setting values is most useful in the C<init> 1267optionally sets a new value. Setting values is most useful in the C<init>
944likely change). 1276likely change).
945 1277
946Please note that resource strings will currently only be freed when the 1278Please note that resource strings will currently only be freed when the
947terminal is destroyed, so changing options frequently will eat memory. 1279terminal is destroyed, so changing options frequently will eat memory.
948 1280
949Here is a a likely non-exhaustive list of resource names, not all of which 1281Here is a likely non-exhaustive list of resource names, not all of which
950are supported in every build, please see the source file F</src/rsinc.h> 1282are supported in every build, please see the source file F</src/rsinc.h>
951to see the actual list: 1283to see the actual list:
952 1284
953 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
954 borderLess color cursorBlink cursorUnderline cutchars delete_key 1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
955 display_name embed ext_bwidth fade font geometry hold iconName 1287 display_name embed ext_bwidth fade font geometry hold iconName
956 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles
957 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
958 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
959 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
960 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
961 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
962 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
963 shade term_name title transparent transparent_all tripleclickwords 1295 secondaryScreen secondaryScroll shade term_name title
964 utmpInhibit visualBell 1296 transient_for transparent transparent_all tripleclickwords utmpInhibit
1297 visualBell
965 1298
966=cut 1299=cut
967 1300
968sub resource($$;$) { 1301sub resource($$;$) {
969 my ($self, $name) = (shift, shift); 1302 my ($self, $name) = (shift, shift);
970 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1303 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
971 &urxvt::term::_resource 1304 goto &urxvt::term::_resource
972} 1305}
973 1306
974=item $value = $term->x_resource ($pattern) 1307=item $value = $term->x_resource ($pattern)
975 1308
976Returns the X-Resource for the given pattern, excluding the program or 1309Returns the X-Resource for the given pattern, excluding the program or
1059 1392
1060The methods currently supported on C<urxvt::overlay> objects are: 1393The methods currently supported on C<urxvt::overlay> objects are:
1061 1394
1062=over 4 1395=over 4
1063 1396
1064=item $overlay->set ($x, $y, $text, $rend) 1397=item $overlay->set ($x, $y, $text[, $rend])
1065 1398
1066Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1399Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1067text in rxvt-unicode's special encoding and an array of rendition values 1400text in rxvt-unicode's special encoding and an array of rendition values
1068at a specific position inside the overlay. 1401at a specific position inside the overlay.
1402
1403If C<$rend> is missing, then the rendition will not be changed.
1069 1404
1070=item $overlay->hide 1405=item $overlay->hide
1071 1406
1072If visible, hide the overlay, but do not destroy it. 1407If visible, hide the overlay, but do not destroy it.
1073 1408
1143 1478
1144Normally its not a good idea to use this function, as programs might be 1479Normally its not a good idea to use this function, as programs might be
1145confused by changes in cursor position or scrolling. Its useful inside a 1480confused by changes in cursor position or scrolling. Its useful inside a
1146C<on_add_lines> hook, though. 1481C<on_add_lines> hook, though.
1147 1482
1483=item $term->scr_change_screen ($screen)
1484
1485Switch to given screen - 0 primary, 1 secondary.
1486
1148=item $term->cmd_parse ($octets) 1487=item $term->cmd_parse ($octets)
1149 1488
1150Similar to C<scr_add_lines>, but the argument must be in the 1489Similar to C<scr_add_lines>, but the argument must be in the
1151locale-specific encoding of the terminal and can contain command sequences 1490locale-specific encoding of the terminal and can contain command sequences
1152(escape codes) that will be interpreted. 1491(escape codes) that will be interpreted.
1162Replaces the event mask of the pty watcher by the given event mask. Can 1501Replaces the event mask of the pty watcher by the given event mask. Can
1163be used to suppress input and output handling to the pty/tty. See the 1502be used to suppress input and output handling to the pty/tty. See the
1164description of C<< urxvt::timer->events >>. Make sure to always restore 1503description of C<< urxvt::timer->events >>. Make sure to always restore
1165the previous value. 1504the previous value.
1166 1505
1506=item $fd = $term->pty_fd
1507
1508Returns the master file descriptor for the pty in use, or C<-1> if no pty
1509is used.
1510
1167=item $windowid = $term->parent 1511=item $windowid = $term->parent
1168 1512
1169Return the window id of the toplevel window. 1513Return the window id of the toplevel window.
1170 1514
1171=item $windowid = $term->vt 1515=item $windowid = $term->vt
1177Adds the specified events to the vt event mask. Useful e.g. when you want 1521Adds the specified events to the vt event mask. Useful e.g. when you want
1178to receive pointer events all the times: 1522to receive pointer events all the times:
1179 1523
1180 $term->vt_emask_add (urxvt::PointerMotionMask); 1524 $term->vt_emask_add (urxvt::PointerMotionMask);
1181 1525
1526=item $term->focus_in
1527
1528=item $term->focus_out
1529
1530=item $term->key_press ($state, $keycode[, $time])
1531
1532=item $term->key_release ($state, $keycode[, $time])
1533
1534Deliver various fake events to to terminal.
1535
1182=item $window_width = $term->width 1536=item $window_width = $term->width
1183 1537
1184=item $window_height = $term->height 1538=item $window_height = $term->height
1185 1539
1186=item $font_width = $term->fwidth 1540=item $font_width = $term->fwidth
1216=item $env = $term->env 1570=item $env = $term->env
1217 1571
1218Returns a copy of the environment in effect for the terminal as a hashref 1572Returns a copy of the environment in effect for the terminal as a hashref
1219similar to C<\%ENV>. 1573similar to C<\%ENV>.
1220 1574
1575=item @envv = $term->envv
1576
1577Returns the environment as array of strings of the form C<VAR=VALUE>.
1578
1579=item @argv = $term->argv
1580
1581Return the argument vector as this terminal, similar to @ARGV, but
1582includes the program name as first element.
1583
1221=cut 1584=cut
1222 1585
1223sub env { 1586sub env {
1224 if (my $env = $_[0]->_env) {
1225 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1587 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1226 } else {
1227 +{ %ENV }
1228 }
1229} 1588}
1230 1589
1231=item $modifiermask = $term->ModLevel3Mask 1590=item $modifiermask = $term->ModLevel3Mask
1232 1591
1233=item $modifiermask = $term->ModMetaMask 1592=item $modifiermask = $term->ModMetaMask
1234 1593
1235=item $modifiermask = $term->ModNumLockMask 1594=item $modifiermask = $term->ModNumLockMask
1236 1595
1237Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1596Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1238AltGr), the meta key (often Alt) and the num lock key, if applicable. 1597AltGr), the meta key (often Alt) and the num lock key, if applicable.
1598
1599=item $screen = $term->current_screen
1600
1601Returns the currently displayed screen (0 primary, 1 secondary).
1602
1603=item $cursor_is_hidden = $term->hidden_cursor
1604
1605Returns whether the cursor is currently hidden or not.
1239 1606
1240=item $view_start = $term->view_start ([$newvalue]) 1607=item $view_start = $term->view_start ([$newvalue])
1241 1608
1242Returns the row number of the topmost displayed line. Maximum value is 1609Returns the row number of the topmost displayed line. Maximum value is
1243C<0>, which displays the normal terminal contents. Lower values scroll 1610C<0>, which displays the normal terminal contents. Lower values scroll
1251 1618
1252Used after changing terminal contents to display them. 1619Used after changing terminal contents to display them.
1253 1620
1254=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1255 1622
1256Returns the text of the entire row with number C<$row_number>. Row C<0> 1623Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1257is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1624is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1258terminal line. The scrollback buffer starts at line C<-1> and extends to
1259line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1625terminal line. Nothing will be returned if a nonexistent line
1260is requested. 1626is requested.
1261 1627
1262If C<$new_text> is specified, it will replace characters in the current 1628If C<$new_text> is specified, it will replace characters in the current
1263line, starting at column C<$start_col> (default C<0>), which is useful 1629line, starting at column C<$start_col> (default C<0>), which is useful
1264to replace only parts of a line. The font index in the rendition will 1630to replace only parts of a line. The font index in the rendition will
1265automatically be updated. 1631automatically be updated.
1266 1632
1267C<$text> is in a special encoding: tabs and wide characters that use more 1633C<$text> is in a special encoding: tabs and wide characters that use more
1268than one cell when displayed are padded with urxvt::NOCHAR characters 1634than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1269(C<chr 65535>). Characters with combining characters and other characters 1635characters. Characters with combining characters and other characters that
1270that do not fit into the normal tetx encoding will be replaced with 1636do not fit into the normal text encoding will be replaced with characters
1271characters in the private use area. 1637in the private use area.
1272 1638
1273You have to obey this encoding when changing text. The advantage is 1639You have to obey this encoding when changing text. The advantage is
1274that C<substr> and similar functions work on screen cells and not on 1640that C<substr> and similar functions work on screen cells and not on
1275characters. 1641characters.
1276 1642
1420where one character corresponds to one screen cell. See 1786where one character corresponds to one screen cell. See
1421C<< $term->ROW_t >> for details. 1787C<< $term->ROW_t >> for details.
1422 1788
1423=item $string = $term->special_decode $text 1789=item $string = $term->special_decode $text
1424 1790
1425Converts rxvt-unicodes text reprsentation into a perl string. See 1791Converts rxvt-unicodes text representation into a perl string. See
1426C<< $term->ROW_t >> for details. 1792C<< $term->ROW_t >> for details.
1427 1793
1428=item $success = $term->grab_button ($button, $modifiermask) 1794=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1429 1795
1796=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1797
1430Registers a synchronous button grab. See the XGrabButton manpage. 1798Register/unregister a synchronous button grab. See the XGrabButton
1799manpage.
1431 1800
1432=item $success = $term->grab ($eventtime[, $sync]) 1801=item $success = $term->grab ($eventtime[, $sync])
1433 1802
1434Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1803Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1435synchronous (C<$sync> is true). Also remembers the grab timestampe. 1804synchronous (C<$sync> is true). Also remembers the grab timestamp.
1436 1805
1437=item $term->allow_events_async 1806=item $term->allow_events_async
1438 1807
1439Calls XAllowEvents with AsyncBoth for the most recent grab. 1808Calls XAllowEvents with AsyncBoth for the most recent grab.
1440 1809
1450=item $term->ungrab 1819=item $term->ungrab
1451 1820
1452Calls XUngrab for the most recent grab. Is called automatically on 1821Calls XUngrab for the most recent grab. Is called automatically on
1453evaluation errors, as it is better to lose the grab in the error case as 1822evaluation errors, as it is better to lose the grab in the error case as
1454the session. 1823the session.
1824
1825=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826
1827=item $atom_name = $term->XGetAtomName ($atom)
1828
1829=item @atoms = $term->XListProperties ($window)
1830
1831=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1832
1833=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1834
1835=item $term->XDeleteProperty ($window, $property)
1836
1837=item $window = $term->DefaultRootWindow
1838
1839=item $term->XReparentWindow ($window, $parent, [$x, $y])
1840
1841=item $term->XMapWindow ($window)
1842
1843=item $term->XUnmapWindow ($window)
1844
1845=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1846
1847=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1848
1849=item $term->XChangeInput ($window, $add_events[, $del_events])
1850
1851Various X or X-related functions. The C<$term> object only serves as
1852the source of the display, otherwise those functions map more-or-less
1853directory onto the X functions of the same name.
1455 1854
1456=back 1855=back
1457 1856
1458=cut 1857=cut
1459 1858
1523 my ($self, $text, $cb) = @_; 1922 my ($self, $text, $cb) = @_;
1524 1923
1525 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1924 $self->add_item ({ type => "button", text => $text, activate => $cb});
1526} 1925}
1527 1926
1528=item $popup->add_toggle ($text, $cb, $initial_value) 1927=item $popup->add_toggle ($text, $initial_value, $cb)
1529 1928
1530Adds a toggle/checkbox item to the popup. Teh callback gets called 1929Adds a toggle/checkbox item to the popup. The callback gets called
1531whenever it gets toggled, with a boolean indicating its value as its first 1930whenever it gets toggled, with a boolean indicating its new value as its
1532argument. 1931first argument.
1533 1932
1534=cut 1933=cut
1535 1934
1536sub add_toggle { 1935sub add_toggle {
1537 my ($self, $text, $cb, $value) = @_; 1936 my ($self, $text, $value, $cb) = @_;
1538 1937
1539 my $item; $item = { 1938 my $item; $item = {
1540 type => "button", 1939 type => "button",
1541 text => " $text", 1940 text => " $text",
1542 value => $value, 1941 value => $value,
1561 my $env = $self->{term}->env; 1960 my $env = $self->{term}->env;
1562 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1961 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1563 delete $env->{LC_ALL}; 1962 delete $env->{LC_ALL};
1564 $env->{LC_CTYPE} = $self->{term}->locale; 1963 $env->{LC_CTYPE} = $self->{term}->locale;
1565 1964
1566 urxvt::term->new ($env, $self->{term}->resource ("name"), 1965 my $term = urxvt::term->new (
1567 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1966 $env, "popup",
1967 "--perl-lib" => "", "--perl-ext-common" => "",
1968 "-pty-fd" => -1, "-sl" => 0,
1969 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1568 "--transient-for" => $self->{term}->parent, 1970 "--transient-for" => $self->{term}->parent,
1569 "-display" => $self->{term}->display_id, 1971 "-display" => $self->{term}->display_id,
1570 "-pe" => "urxvt-popup") 1972 "-pe" => "urxvt-popup",
1571 or die "unable to create popup window\n"; 1973 ) or die "unable to create popup window\n";
1974
1975 unless (delete $term->{urxvt_popup_init_done}) {
1976 $term->ungrab;
1977 $term->destroy;
1978 die "unable to initialise popup window\n";
1979 }
1572} 1980}
1573 1981
1574sub DESTROY { 1982sub DESTROY {
1575 my ($self) = @_; 1983 my ($self) = @_;
1576 1984
1577 delete $self->{term}{_destroy}{$self}; 1985 delete $self->{term}{_destroy}{$self};
1578 $self->{term}->ungrab; 1986 $self->{term}->ungrab;
1579} 1987}
1580 1988
1581=back 1989=back
1990
1991=cut
1992
1993package urxvt::watcher;
1582 1994
1583=head2 The C<urxvt::timer> Class 1995=head2 The C<urxvt::timer> Class
1584 1996
1585This class implements timer watchers/events. Time is represented as a 1997This class implements timer watchers/events. Time is represented as a
1586fractional number of seconds since the epoch. Example: 1998fractional number of seconds since the epoch. Example:
1590 ->new 2002 ->new
1591 ->interval (1) 2003 ->interval (1)
1592 ->cb (sub { 2004 ->cb (sub {
1593 $term->{overlay}->set (0, 0, 2005 $term->{overlay}->set (0, 0,
1594 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1595 }); 2007 });
1596 2008
1597=over 4 2009=over 4
1598 2010
1599=item $timer = new urxvt::timer 2011=item $timer = new urxvt::timer
1600 2012
1624Start the timer. 2036Start the timer.
1625 2037
1626=item $timer = $timer->start ($tstamp) 2038=item $timer = $timer->start ($tstamp)
1627 2039
1628Set the event trigger time to C<$tstamp> and start the timer. 2040Set the event trigger time to C<$tstamp> and start the timer.
2041
2042=item $timer = $timer->after ($delay)
2043
2044Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1629 2045
1630=item $timer = $timer->stop 2046=item $timer = $timer->stop
1631 2047
1632Stop the timer. 2048Stop the timer.
1633 2049
1639 2055
1640 $term->{socket} = ... 2056 $term->{socket} = ...
1641 $term->{iow} = urxvt::iow 2057 $term->{iow} = urxvt::iow
1642 ->new 2058 ->new
1643 ->fd (fileno $term->{socket}) 2059 ->fd (fileno $term->{socket})
1644 ->events (urxvt::EVENT_READ) 2060 ->events (urxvt::EV_READ)
1645 ->start 2061 ->start
1646 ->cb (sub { 2062 ->cb (sub {
1647 my ($iow, $revents) = @_; 2063 my ($iow, $revents) = @_;
1648 # $revents must be 1 here, no need to check 2064 # $revents must be 1 here, no need to check
1649 sysread $term->{socket}, my $buf, 8192 2065 sysread $term->{socket}, my $buf, 8192
1662Set the callback to be called when io events are triggered. C<$reventmask> 2078Set the callback to be called when io events are triggered. C<$reventmask>
1663is a bitset as described in the C<events> method. 2079is a bitset as described in the C<events> method.
1664 2080
1665=item $iow = $iow->fd ($fd) 2081=item $iow = $iow->fd ($fd)
1666 2082
1667Set the filedescriptor (not handle) to watch. 2083Set the file descriptor (not handle) to watch.
1668 2084
1669=item $iow = $iow->events ($eventmask) 2085=item $iow = $iow->events ($eventmask)
1670 2086
1671Set the event mask to watch. The only allowed values are 2087Set the event mask to watch. The only allowed values are
1672C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2088C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1673together, or C<urxvt::EVENT_NONE>. 2089together, or C<urxvt::EV_NONE>.
1674 2090
1675=item $iow = $iow->start 2091=item $iow = $iow->start
1676 2092
1677Start watching for requested events on the given handle. 2093Start watching for requested events on the given handle.
1678 2094
1679=item $iow = $iow->stop 2095=item $iow = $iow->stop
1680 2096
1681Stop watching for events on the given filehandle. 2097Stop watching for events on the given file handle.
2098
2099=back
2100
2101=head2 The C<urxvt::iw> Class
2102
2103This class implements idle watchers, that get called automatically when
2104the process is idle. They should return as fast as possible, after doing
2105some useful work.
2106
2107=over 4
2108
2109=item $iw = new urxvt::iw
2110
2111Create a new idle watcher object in stopped state.
2112
2113=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2114
2115Set the callback to be called when the watcher triggers.
2116
2117=item $timer = $timer->start
2118
2119Start the watcher.
2120
2121=item $timer = $timer->stop
2122
2123Stop the watcher.
2124
2125=back
2126
2127=head2 The C<urxvt::pw> Class
2128
2129This class implements process watchers. They create an event whenever a
2130process exits, after which they stop automatically.
2131
2132 my $pid = fork;
2133 ...
2134 $term->{pw} = urxvt::pw
2135 ->new
2136 ->start ($pid)
2137 ->cb (sub {
2138 my ($pw, $exit_status) = @_;
2139 ...
2140 });
2141
2142=over 4
2143
2144=item $pw = new urxvt::pw
2145
2146Create a new process watcher in stopped state.
2147
2148=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2149
2150Set the callback to be called when the timer triggers.
2151
2152=item $pw = $timer->start ($pid)
2153
2154Tells the watcher to start watching for process C<$pid>.
2155
2156=item $pw = $pw->stop
2157
2158Stop the watcher.
1682 2159
1683=back 2160=back
1684 2161
1685=head1 ENVIRONMENT 2162=head1 ENVIRONMENT
1686 2163
1695 2172
1696=item >= 3 - script loading and management 2173=item >= 3 - script loading and management
1697 2174
1698=item >=10 - all called hooks 2175=item >=10 - all called hooks
1699 2176
1700=item >=11 - hook reutrn values 2177=item >=11 - hook return values
1701 2178
1702=back 2179=back
1703 2180
1704=head1 AUTHOR 2181=head1 AUTHOR
1705 2182
1707 http://software.schmorp.de/pkg/rxvt-unicode 2184 http://software.schmorp.de/pkg/rxvt-unicode
1708 2185
1709=cut 2186=cut
1710 2187
17111 21881
2189
2190# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines