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.98 by root, Tue Jan 17 17:01:54 2006 UTC vs.
Revision 1.171 by root, Fri Oct 10 00:11:44 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:
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
165overlays or changes. 376overlays or changes.
166
167=item selection-pastebin
168
169This is a little rarely useful extension that Uploads the selection as
170textfile to a remote site (or does other things).
171
172It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
173i.e.
174
175 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
176
177Pressing this combination runs a command with C<%> replaced by the name of
178the textfile. This command can be set via a resource:
179
180 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
181
182And the default is likely not useful to anybody but the few people around
183here :)
184
185The name of the textfile is the hex encoded md5 sum of the selection, so
186the same content should lead to the same filename.
187
188After a successful upload the selection will be replaced by the text given
189in the C<selection-pastebin-url> resource (again, the % is the placeholder
190for the filename):
191
192 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
193 377
194=back 378=back
195 379
196=head1 API DOCUMENTATION 380=head1 API DOCUMENTATION
197 381
231 415
232=back 416=back
233 417
234=head2 Extension Objects 418=head2 Extension Objects
235 419
236Very 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
237for 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,
238hooks. 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
239about 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
240begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
241use. 426internal use.
242 427
243Although 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
244C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
245 430
246It has the following methods and data members: 431It has the following methods and data members:
267=head2 Hooks 452=head2 Hooks
268 453
269The following subroutines can be declared in extension files, and will be 454The following subroutines can be declared in extension files, and will be
270called whenever the relevant event happens. 455called whenever the relevant event happens.
271 456
272The 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
273the in the C<Extension Objects> section. 458the in the C<Extension Objects> section.
274 459
275B<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
276event 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
277skipped, and the relevant action might not be carried out by the C++ code. 462relevant action might not be carried out by the C++ code.
278 463
279I<< When in doubt, return a false value (preferably C<()>). >> 464I<< When in doubt, return a false value (preferably C<()>). >>
280 465
281=over 4 466=over 4
282 467
283=item on_init $term 468=item on_init $term
284 469
285Called after a new terminal object has been initialized, but before 470Called after a new terminal object has been initialized, but before
286windows 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
287call or deliver senseless data, as terminal size and other characteristics 472call or deliver senseless data, as terminal size and other characteristics
288have not yet been determined. You can safely query and change resources, 473have not yet been determined. You can safely query and change resources
289though. 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).
290 486
291=item on_reset $term 487=item on_reset $term
292 488
293Called 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
294control 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
295variables. 491variables.
296 492
297=item on_start $term 493=item on_child_start $term, $pid
298 494
299Called at the very end of initialisation of a new terminal, just before 495Called just after the child process has been C<fork>ed.
300returning 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>.
301 501
302=item on_sel_make $term, $eventtime 502=item on_sel_make $term, $eventtime
303 503
304Called 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
305selection 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
312 512
313Called whenever a selection has been copied, but before the selection is 513Called whenever a selection has been copied, but before the selection is
314requested from the server. The selection text can be queried and changed 514requested from the server. The selection text can be queried and changed
315by calling C<< $term->selection >>. 515by calling C<< $term->selection >>.
316 516
317Returning a true value aborts selection grabbing. It will still be hilighted. 517Returning a true value aborts selection grabbing. It will still be highlighted.
318 518
319=item on_sel_extend $term 519=item on_sel_extend $term
320 520
321Called 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
322click) and is either supposed to return false (normal operation), or 522click) and is either supposed to return false (normal operation), or
323should 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
324processing. This can happen multiple times, as long as the callback 524processing. This can happen multiple times, as long as the callback
325returns 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
326supposed to enlarge the selection more and more, if possible. 526supposed to enlarge the selection more and more, if possible.
327 527
328See the F<selection> example extension. 528See the F<selection> example extension.
329 529
330=item on_view_change $term, $offset 530=item on_view_change $term, $offset
331 531
332Called whenever the view offset changes, i..e the user or program 532Called whenever the view offset changes, i.e. the user or program
333scrolls. Offset C<0> means display the normal terminal, positive values 533scrolls. Offset C<0> means display the normal terminal, positive values
334show this many lines of scrollback. 534show this many lines of scrollback.
335 535
336=item on_scroll_back $term, $lines, $saved 536=item on_scroll_back $term, $lines, $saved
337 537
341 541
342It 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,
343$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
344number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
345 545
346=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
347 557
348Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
349operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
350information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
351string should start with the extension name and a colon, to distinguish 561string should start with the extension name (sans -osc) and a semicolon,
352it from commands for other extensions, and this might be enforced in the 562to distinguish it from commands for other extensions, and this might be
353future. 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 }
354 574
355Be 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,
356as 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
357other 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.
358 581
359=item on_add_lines $term, $string 582=item on_add_lines $term, $string
360 583
361Called 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
362can 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
383later 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
384you cannot just toggle rendition bits, but only set them. 607you cannot just toggle rendition bits, but only set them.
385 608
386=item on_refresh_begin $term 609=item on_refresh_begin $term
387 610
388Called just before the screen gets redrawn. Can be used for overlay 611Called just before the screen gets redrawn. Can be used for overlay or
389or similar effects by modify terminal contents in refresh_begin, and 612similar effects by modifying the terminal contents in refresh_begin, and
390restoring them in refresh_end. The built-in overlay and selection display 613restoring them in refresh_end. The built-in overlay and selection display
391code is run after this hook, and takes precedence. 614code is run after this hook, and takes precedence.
392 615
393=item on_refresh_end $term 616=item on_refresh_end $term
394 617
395Called just after the screen gets redrawn. See C<on_refresh_begin>. 618Called just after the screen gets redrawn. See C<on_refresh_begin>.
396 619
397=item on_keyboard_command $term, $string 620=item on_user_command $term, $string
398 621
399Called whenever the user presses a key combination that has a 622Called whenever a user-configured event is being activated (e.g. via
400C<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>
401resource 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.
402 634
403=item on_x_event $term, $event 635=item on_x_event $term, $event
404 636
405Called 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
406windows). Should only be used as a last resort. Most event structure 638windows). Should only be used as a last resort. Most event structure
407members are not passed. 639members are not passed.
408 640
641=item on_root_event $term, $event
642
643Like C<on_x_event>, but is called for events on the root window.
644
409=item on_focus_in $term 645=item on_focus_in $term
410 646
411Called whenever the window gets the keyboard focus, before rxvt-unicode 647Called whenever the window gets the keyboard focus, before rxvt-unicode
412does focus in processing. 648does focus in processing.
413 649
414=item on_focus_out $term 650=item on_focus_out $term
415 651
416Called wheneever the window loses keyboard focus, before rxvt-unicode does 652Called whenever the window loses keyboard focus, before rxvt-unicode does
417focus out processing. 653focus out processing.
654
655=item on_configure_notify $term, $event
656
657=item on_property_notify $term, $event
418 658
419=item on_key_press $term, $event, $keysym, $octets 659=item on_key_press $term, $event, $keysym, $octets
420 660
421=item on_key_release $term, $event, $keysym 661=item on_key_release $term, $event, $keysym
422 662
432 672
433Called whenever the corresponding X event is received for the terminal If 673Called whenever the corresponding X event is received for the terminal If
434the 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.
435 675
436The 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
437manpage), 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
438and column under the mouse cursor. 678(real, not screen-based) row and column under the mouse cursor.
439 679
440C<on_key_press> additionally receives the string rxvt-unicode would 680C<on_key_press> additionally receives the string rxvt-unicode would
441output, if any, in locale-specific encoding. 681output, if any, in locale-specific encoding.
442 682
443subwindow. 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).
444 693
445=back 694=back
446 695
447=cut 696=cut
448 697
454use Scalar::Util (); 703use Scalar::Util ();
455use List::Util (); 704use List::Util ();
456 705
457our $VERSION = 1; 706our $VERSION = 1;
458our $TERM; 707our $TERM;
708our @TERM_INIT;
709our @TERM_EXT;
459our @HOOKNAME; 710our @HOOKNAME;
460our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 711our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461our %OPTION; 712our %OPTION;
462 713
463our $LIBDIR; 714our $LIBDIR;
464our $RESNAME; 715our $RESNAME;
465our $RESCLASS; 716our $RESCLASS;
466our $RXVTNAME; 717our $RXVTNAME;
467 718
719our $NOCHAR = chr 0xffff;
720
468=head2 Variables in the C<urxvt> Package 721=head2 Variables in the C<urxvt> Package
469 722
470=over 4 723=over 4
471 724
472=item $urxvt::LIBDIR 725=item $urxvt::LIBDIR
484 737
485=item $urxvt::TERM 738=item $urxvt::TERM
486 739
487The current terminal. This variable stores the current C<urxvt::term> 740The current terminal. This variable stores the current C<urxvt::term>
488object, 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>.
489 758
490=back 759=back
491 760
492=head2 Functions in the C<urxvt> Package 761=head2 Functions in the C<urxvt> Package
493 762
507 776
508Using 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
509correct place, e.g. on stderr of the connecting urxvtc client. 778correct place, e.g. on stderr of the connecting urxvtc client.
510 779
511Messages have a size limit of 1023 bytes currently. 780Messages have a size limit of 1023 bytes currently.
781
782=item @terms = urxvt::termlist
783
784Returns all urxvt::term objects that exist in this process, regardless of
785whether they are started, being destroyed etc., so be careful. Only term
786objects that have perl extensions attached will be returned (because there
787is no urxvt::term objet associated with others).
512 788
513=item $time = urxvt::NOW 789=item $time = urxvt::NOW
514 790
515Returns the "current time" (as per the event loop). 791Returns the "current time" (as per the event loop).
516 792
575 851
576=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 852=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
577 853
578=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 854=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
579 855
856=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
857
580Replace the foreground/background colour in the rendition mask with the 858Replace the foreground/background colour in the rendition mask with the
581specified one. 859specified one.
582 860
583=item $value = urxvt::GET_CUSTOM $rend 861=item $value = urxvt::GET_CUSTOM $rend
584 862
593=back 871=back
594 872
595=cut 873=cut
596 874
597BEGIN { 875BEGIN {
598 urxvt->bootstrap;
599
600 # overwrite perl's warn 876 # overwrite perl's warn
601 *CORE::GLOBAL::warn = sub { 877 *CORE::GLOBAL::warn = sub {
602 my $msg = join "", @_; 878 my $msg = join "", @_;
603 $msg .= "\n" 879 $msg .= "\n"
604 unless $msg =~ /\n$/; 880 unless $msg =~ /\n$/;
605 urxvt::warn ($msg); 881 urxvt::warn ($msg);
606 }; 882 };
607
608 # %ENV is the original startup environment
609 delete $ENV{IFS};
610 delete $ENV{CDPATH};
611 delete $ENV{BASH_ENV};
612 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
613} 883}
884
885no warnings 'utf8';
614 886
615my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 887my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
616 888
617sub verbose { 889sub verbose {
618 my ($level, $msg) = @_; 890 my ($level, $msg) = @_;
619 warn "$msg\n" if $level <= $verbosity; 891 warn "$msg\n" if $level <= $verbosity;
620} 892}
621 893
622my $extension_pkg = "extension0000";
623my %extension_pkg; 894my %extension_pkg;
624 895
625# load a single script into its own package, once only 896# load a single script into its own package, once only
626sub extension_package($) { 897sub extension_package($) {
627 my ($path) = @_; 898 my ($path) = @_;
628 899
629 $extension_pkg{$path} ||= do { 900 $extension_pkg{$path} ||= do {
630 my $pkg = "urxvt::" . ($extension_pkg++); 901 $path =~ /([^\/\\]+)$/;
902 my $pkg = $1;
903 $pkg =~ s/[^[:word:]]/_/g;
904 $pkg = "urxvt::ext::$pkg";
631 905
632 verbose 3, "loading extension '$path' into package '$pkg'"; 906 verbose 3, "loading extension '$path' into package '$pkg'";
633 907
634 open my $fh, "<:raw", $path 908 open my $fh, "<:raw", $path
635 or die "$path: $!"; 909 or die "$path: $!";
636 910
637 my $source = 911 my $source =
638 "package $pkg; use strict; use utf8;\n" 912 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
639 . "use base urxvt::term::extension::;\n"
640 . "#line 1 \"$path\"\n{\n" 913 . "#line 1 \"$path\"\n{\n"
641 . (do { local $/; <$fh> }) 914 . (do { local $/; <$fh> })
642 . "\n};\n1"; 915 . "\n};\n1";
643 916
644 eval $source 917 eval $source
655 local $TERM = shift; 928 local $TERM = shift;
656 my $htype = shift; 929 my $htype = shift;
657 930
658 if ($htype == 0) { # INIT 931 if ($htype == 0) { # INIT
659 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
660 933
661 my %ext_arg; 934 my %ext_arg;
662 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
663 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 945 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
664 if ($_ eq "default") { 946 if ($_ eq "default") {
665 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 947 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
666 } elsif (/^-(.*)$/) { 948 } elsif (/^-(.*)$/) {
667 delete $ext_arg{$1}; 949 delete $ext_arg{$1};
668 } elsif (/^([^<]+)<(.*)>$/) { 950 } elsif (/^([^<]+)<(.*)>$/) {
669 push @{ $ext_arg{$1} }, $2; 951 push @{ $ext_arg{$1} }, $2;
670 } else { 952 } else {
671 $ext_arg{$_} ||= []; 953 $ext_arg{$_} ||= [];
672 } 954 }
673 } 955 }
674 956
675 while (my ($ext, $argv) = each %ext_arg) { 957 for my $ext (sort keys %ext_arg) {
676 my @files = grep -f $_, map "$_/$ext", @dirs; 958 my @files = grep -f $_, map "$_/$ext", @dirs;
677 959
678 if (@files) { 960 if (@files) {
679 $TERM->register_package (extension_package $files[0], $argv); 961 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
680 } else { 962 } else {
681 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";
682 } 964 }
683 } 965 }
684 966
690 972
691 if (my $cb = $TERM->{_hook}[$htype]) { 973 if (my $cb = $TERM->{_hook}[$htype]) {
692 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 974 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
693 if $verbosity >= 10; 975 if $verbosity >= 10;
694 976
695 keys %$cb; 977 for my $pkg (keys %$cb) {
696
697 while (my ($pkg, $cb) = each %$cb) {
698 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 978 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
699 and last; 979 $retval ||= $retval_;
700 980
701 if ($@) { 981 if ($@) {
702 $TERM->ungrab; # better to lose the grab than the session 982 $TERM->ungrab; # better to lose the grab than the session
703 warn $@; 983 warn $@;
704 } 984 }
717 } 997 }
718 998
719 $retval 999 $retval
720} 1000}
721 1001
722sub exec_async(@) { 1002sub SET_COLOR($$$) {
723 my $pid = fork; 1003 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1004}
724 1005
725 return 1006sub rend2mask {
726 if !defined $pid or $pid; 1007 no strict 'refs';
727 1008 my ($str, $mask) = (@_, 0);
728 %ENV = %{ $TERM->env }; 1009 my %color = ( fg => undef, bg => undef );
729 1010 my @failed;
730 exec @_; 1011 for my $spec ( split /\s+/, $str ) {
731 _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)
732} 1029}
733 1030
734# urxvt::term::extension 1031# urxvt::term::extension
735 1032
736package urxvt::term::extension; 1033package urxvt::term::extension;
807is 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
808work. 1105work.
809 1106
810=cut 1107=cut
811 1108
812our $VERSION = 1; 1109our $VERSION = '3.4';
813 1110
814$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
815push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
816 1113
817sub timer { 1114sub timer {
848 1145
849sub DESTROY { 1146sub DESTROY {
850 $_[0][1]->stop; 1147 $_[0][1]->stop;
851} 1148}
852 1149
853sub condvar { 1150sub one_event {
854 bless \my $flag, urxvt::anyevent::condvar::
855}
856
857sub urxvt::anyevent::condvar::broadcast {
858 ${$_[0]}++;
859}
860
861sub urxvt::anyevent::condvar::wait {
862 unless (${$_[0]}) {
863 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";
864 }
865} 1152}
866 1153
867package urxvt::term; 1154package urxvt::term;
868 1155
869=head2 The C<urxvt::term> Class 1156=head2 The C<urxvt::term> Class
874 1161
875# find on_xxx subs in the package and register them 1162# find on_xxx subs in the package and register them
876# as hooks 1163# as hooks
877sub register_package { 1164sub register_package {
878 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::;
879 1172
880 my $proxy = bless { 1173 my $proxy = bless {
881 _pkg => $pkg, 1174 _pkg => $pkg,
882 argv => $argv, 1175 argv => $argv,
883 }, $pkg; 1176 }, $pkg;
899hash which defines the environment of the new terminal. 1192hash which defines the environment of the new terminal.
900 1193
901Croaks (and probably outputs an error message) if the new instance 1194Croaks (and probably outputs an error message) if the new instance
902couldn'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
903initialise perl, and the terminal object otherwise. The C<init> and 1196initialise perl, and the terminal object otherwise. The C<init> and
904C<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).
905 1199
906=cut 1200=cut
907 1201
908sub new { 1202sub new {
909 my ($class, $env, @args) = @_; 1203 my ($class, $env, @args) = @_;
910 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
911 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1208 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
912} 1209}
913 1210
914=item $term->destroy 1211=item $term->destroy
915 1212
916Destroy the terminal object (close the window, free resources 1213Destroy the terminal object (close the window, free resources
917etc.). 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
918watchers (timers, io watchers) are still active. 1215watchers (timers, io watchers) are still active.
919 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
920=item $isset = $term->option ($optval[, $set]) 1242=item $isset = $term->option ($optval[, $set])
921 1243
922Returns true if the option specified by C<$optval> is enabled, and 1244Returns true if the option specified by C<$optval> is enabled, and
923optionally 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
924C<%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.
925 1247
926Here 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
927source file F</src/optinc.h> to see the actual list: 1249source file F</src/optinc.h> to see the actual list:
928 1250
929 borderLess console cursorBlink cursorUnderline hold iconic insecure 1251 borderLess console cursorBlink cursorUnderline hold iconic insecure
930 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1252 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
931 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1253 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
932 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1254 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
933 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1255 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
934 tripleclickwords utmpInhibit visualBell 1256 transparent tripleclickwords utmpInhibit visualBell
935 1257
936=item $value = $term->resource ($name[, $newval]) 1258=item $value = $term->resource ($name[, $newval])
937 1259
938Returns the current resource value associated with a given name and 1260Returns the current resource value associated with a given name and
939optionally 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>
948likely change). 1270likely change).
949 1271
950Please note that resource strings will currently only be freed when the 1272Please note that resource strings will currently only be freed when the
951terminal is destroyed, so changing options frequently will eat memory. 1273terminal is destroyed, so changing options frequently will eat memory.
952 1274
953Here 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
954are 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>
955to see the actual list: 1277to see the actual list:
956 1278
957 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
958 borderLess color cursorBlink cursorUnderline cutchars delete_key 1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
959 display_name embed ext_bwidth fade font geometry hold iconName 1281 display_name embed ext_bwidth fade font geometry hold iconName
960 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles
961 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
962 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
963 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
964 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
965 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
966 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
967 shade term_name title transparent transparent_all tripleclickwords 1289 secondaryScreen secondaryScroll shade term_name title
968 utmpInhibit visualBell 1290 transient_for transparent transparent_all tripleclickwords utmpInhibit
1291 visualBell
969 1292
970=cut 1293=cut
971 1294
972sub resource($$;$) { 1295sub resource($$;$) {
973 my ($self, $name) = (shift, shift); 1296 my ($self, $name) = (shift, shift);
974 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1297 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
975 &urxvt::term::_resource 1298 goto &urxvt::term::_resource
976} 1299}
977 1300
978=item $value = $term->x_resource ($pattern) 1301=item $value = $term->x_resource ($pattern)
979 1302
980Returns the X-Resource for the given pattern, excluding the program or 1303Returns the X-Resource for the given pattern, excluding the program or
1147 1470
1148Normally its not a good idea to use this function, as programs might be 1471Normally its not a good idea to use this function, as programs might be
1149confused by changes in cursor position or scrolling. Its useful inside a 1472confused by changes in cursor position or scrolling. Its useful inside a
1150C<on_add_lines> hook, though. 1473C<on_add_lines> hook, though.
1151 1474
1475=item $term->scr_change_screen ($screen)
1476
1477Switch to given screen - 0 primary, 1 secondary.
1478
1152=item $term->cmd_parse ($octets) 1479=item $term->cmd_parse ($octets)
1153 1480
1154Similar to C<scr_add_lines>, but the argument must be in the 1481Similar to C<scr_add_lines>, but the argument must be in the
1155locale-specific encoding of the terminal and can contain command sequences 1482locale-specific encoding of the terminal and can contain command sequences
1156(escape codes) that will be interpreted. 1483(escape codes) that will be interpreted.
1166Replaces the event mask of the pty watcher by the given event mask. Can 1493Replaces the event mask of the pty watcher by the given event mask. Can
1167be used to suppress input and output handling to the pty/tty. See the 1494be used to suppress input and output handling to the pty/tty. See the
1168description of C<< urxvt::timer->events >>. Make sure to always restore 1495description of C<< urxvt::timer->events >>. Make sure to always restore
1169the previous value. 1496the previous value.
1170 1497
1498=item $fd = $term->pty_fd
1499
1500Returns the master file descriptor for the pty in use, or C<-1> if no pty
1501is used.
1502
1171=item $windowid = $term->parent 1503=item $windowid = $term->parent
1172 1504
1173Return the window id of the toplevel window. 1505Return the window id of the toplevel window.
1174 1506
1175=item $windowid = $term->vt 1507=item $windowid = $term->vt
1181Adds the specified events to the vt event mask. Useful e.g. when you want 1513Adds the specified events to the vt event mask. Useful e.g. when you want
1182to receive pointer events all the times: 1514to receive pointer events all the times:
1183 1515
1184 $term->vt_emask_add (urxvt::PointerMotionMask); 1516 $term->vt_emask_add (urxvt::PointerMotionMask);
1185 1517
1518=item $term->focus_in
1519
1520=item $term->focus_out
1521
1522=item $term->key_press ($state, $keycode[, $time])
1523
1524=item $term->key_release ($state, $keycode[, $time])
1525
1526Deliver various fake events to to terminal.
1527
1186=item $window_width = $term->width 1528=item $window_width = $term->width
1187 1529
1188=item $window_height = $term->height 1530=item $window_height = $term->height
1189 1531
1190=item $font_width = $term->fwidth 1532=item $font_width = $term->fwidth
1220=item $env = $term->env 1562=item $env = $term->env
1221 1563
1222Returns a copy of the environment in effect for the terminal as a hashref 1564Returns a copy of the environment in effect for the terminal as a hashref
1223similar to C<\%ENV>. 1565similar to C<\%ENV>.
1224 1566
1567=item @envv = $term->envv
1568
1569Returns the environment as array of strings of the form C<VAR=VALUE>.
1570
1571=item @argv = $term->argv
1572
1573Return the argument vector as this terminal, similar to @ARGV, but
1574includes the program name as first element.
1575
1225=cut 1576=cut
1226 1577
1227sub env { 1578sub env {
1228 if (my $env = $_[0]->_env) {
1229 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1579 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1230 } else {
1231 +{ %ENV }
1232 }
1233} 1580}
1234 1581
1235=item $modifiermask = $term->ModLevel3Mask 1582=item $modifiermask = $term->ModLevel3Mask
1236 1583
1237=item $modifiermask = $term->ModMetaMask 1584=item $modifiermask = $term->ModMetaMask
1238 1585
1239=item $modifiermask = $term->ModNumLockMask 1586=item $modifiermask = $term->ModNumLockMask
1240 1587
1241Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1588Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1242AltGr), the meta key (often Alt) and the num lock key, if applicable. 1589AltGr), the meta key (often Alt) and the num lock key, if applicable.
1590
1591=item $screen = $term->current_screen
1592
1593Returns the currently displayed screen (0 primary, 1 secondary).
1594
1595=item $cursor_is_hidden = $term->hidden_cursor
1596
1597Returns whether the cursor is currently hidden or not.
1243 1598
1244=item $view_start = $term->view_start ([$newvalue]) 1599=item $view_start = $term->view_start ([$newvalue])
1245 1600
1246Returns the row number of the topmost displayed line. Maximum value is 1601Returns the row number of the topmost displayed line. Maximum value is
1247C<0>, which displays the normal terminal contents. Lower values scroll 1602C<0>, which displays the normal terminal contents. Lower values scroll
1255 1610
1256Used after changing terminal contents to display them. 1611Used after changing terminal contents to display them.
1257 1612
1258=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1613=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1259 1614
1260Returns the text of the entire row with number C<$row_number>. Row C<0> 1615Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1261is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1616is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1262terminal line. The scrollback buffer starts at line C<-1> and extends to
1263line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1617terminal line. Nothing will be returned if a nonexistent line
1264is requested. 1618is requested.
1265 1619
1266If C<$new_text> is specified, it will replace characters in the current 1620If C<$new_text> is specified, it will replace characters in the current
1267line, starting at column C<$start_col> (default C<0>), which is useful 1621line, starting at column C<$start_col> (default C<0>), which is useful
1268to replace only parts of a line. The font index in the rendition will 1622to replace only parts of a line. The font index in the rendition will
1269automatically be updated. 1623automatically be updated.
1270 1624
1271C<$text> is in a special encoding: tabs and wide characters that use more 1625C<$text> is in a special encoding: tabs and wide characters that use more
1272than one cell when displayed are padded with urxvt::NOCHAR characters 1626than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1273(C<chr 65535>). Characters with combining characters and other characters 1627characters. Characters with combining characters and other characters that
1274that do not fit into the normal tetx encoding will be replaced with 1628do not fit into the normal text encoding will be replaced with characters
1275characters in the private use area. 1629in the private use area.
1276 1630
1277You have to obey this encoding when changing text. The advantage is 1631You have to obey this encoding when changing text. The advantage is
1278that C<substr> and similar functions work on screen cells and not on 1632that C<substr> and similar functions work on screen cells and not on
1279characters. 1633characters.
1280 1634
1424where one character corresponds to one screen cell. See 1778where one character corresponds to one screen cell. See
1425C<< $term->ROW_t >> for details. 1779C<< $term->ROW_t >> for details.
1426 1780
1427=item $string = $term->special_decode $text 1781=item $string = $term->special_decode $text
1428 1782
1429Converts rxvt-unicodes text reprsentation into a perl string. See 1783Converts rxvt-unicodes text representation into a perl string. See
1430C<< $term->ROW_t >> for details. 1784C<< $term->ROW_t >> for details.
1431 1785
1432=item $success = $term->grab_button ($button, $modifiermask) 1786=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1433 1787
1788=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1789
1434Registers a synchronous button grab. See the XGrabButton manpage. 1790Register/unregister a synchronous button grab. See the XGrabButton
1791manpage.
1435 1792
1436=item $success = $term->grab ($eventtime[, $sync]) 1793=item $success = $term->grab ($eventtime[, $sync])
1437 1794
1438Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1795Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1439synchronous (C<$sync> is true). Also remembers the grab timestampe. 1796synchronous (C<$sync> is true). Also remembers the grab timestamp.
1440 1797
1441=item $term->allow_events_async 1798=item $term->allow_events_async
1442 1799
1443Calls XAllowEvents with AsyncBoth for the most recent grab. 1800Calls XAllowEvents with AsyncBoth for the most recent grab.
1444 1801
1454=item $term->ungrab 1811=item $term->ungrab
1455 1812
1456Calls XUngrab for the most recent grab. Is called automatically on 1813Calls XUngrab for the most recent grab. Is called automatically on
1457evaluation errors, as it is better to lose the grab in the error case as 1814evaluation errors, as it is better to lose the grab in the error case as
1458the session. 1815the session.
1816
1817=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1818
1819=item $atom_name = $term->XGetAtomName ($atom)
1820
1821=item @atoms = $term->XListProperties ($window)
1822
1823=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1824
1825=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1826
1827=item $term->XDeleteProperty ($window, $property)
1828
1829=item $window = $term->DefaultRootWindow
1830
1831=item $term->XReparentWindow ($window, $parent, [$x, $y])
1832
1833=item $term->XMapWindow ($window)
1834
1835=item $term->XUnmapWindow ($window)
1836
1837=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1838
1839=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1840
1841=item $term->XChangeInput ($window, $add_events[, $del_events])
1842
1843Various X or X-related functions. The C<$term> object only serves as
1844the source of the display, otherwise those functions map more-or-less
1845directory onto the X functions of the same name.
1459 1846
1460=back 1847=back
1461 1848
1462=cut 1849=cut
1463 1850
1527 my ($self, $text, $cb) = @_; 1914 my ($self, $text, $cb) = @_;
1528 1915
1529 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1916 $self->add_item ({ type => "button", text => $text, activate => $cb});
1530} 1917}
1531 1918
1532=item $popup->add_toggle ($text, $cb, $initial_value) 1919=item $popup->add_toggle ($text, $initial_value, $cb)
1533 1920
1534Adds a toggle/checkbox item to the popup. Teh callback gets called 1921Adds a toggle/checkbox item to the popup. The callback gets called
1535whenever it gets toggled, with a boolean indicating its value as its first 1922whenever it gets toggled, with a boolean indicating its new value as its
1536argument. 1923first argument.
1537 1924
1538=cut 1925=cut
1539 1926
1540sub add_toggle { 1927sub add_toggle {
1541 my ($self, $text, $cb, $value) = @_; 1928 my ($self, $text, $value, $cb) = @_;
1542 1929
1543 my $item; $item = { 1930 my $item; $item = {
1544 type => "button", 1931 type => "button",
1545 text => " $text", 1932 text => " $text",
1546 value => $value, 1933 value => $value,
1565 my $env = $self->{term}->env; 1952 my $env = $self->{term}->env;
1566 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1953 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1567 delete $env->{LC_ALL}; 1954 delete $env->{LC_ALL};
1568 $env->{LC_CTYPE} = $self->{term}->locale; 1955 $env->{LC_CTYPE} = $self->{term}->locale;
1569 1956
1570 urxvt::term->new ($env, $self->{term}->resource ("name"), 1957 my $term = urxvt::term->new (
1571 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1958 $env, "popup",
1959 "--perl-lib" => "", "--perl-ext-common" => "",
1960 "-pty-fd" => -1, "-sl" => 0,
1961 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1572 "--transient-for" => $self->{term}->parent, 1962 "--transient-for" => $self->{term}->parent,
1573 "-display" => $self->{term}->display_id, 1963 "-display" => $self->{term}->display_id,
1574 "-pe" => "urxvt-popup") 1964 "-pe" => "urxvt-popup",
1575 or die "unable to create popup window\n"; 1965 ) or die "unable to create popup window\n";
1966
1967 unless (delete $term->{urxvt_popup_init_done}) {
1968 $term->ungrab;
1969 $term->destroy;
1970 die "unable to initialise popup window\n";
1971 }
1576} 1972}
1577 1973
1578sub DESTROY { 1974sub DESTROY {
1579 my ($self) = @_; 1975 my ($self) = @_;
1580 1976
1581 delete $self->{term}{_destroy}{$self}; 1977 delete $self->{term}{_destroy}{$self};
1582 $self->{term}->ungrab; 1978 $self->{term}->ungrab;
1583} 1979}
1584 1980
1585=back 1981=back
1982
1983=cut
1984
1985package urxvt::watcher;
1586 1986
1587=head2 The C<urxvt::timer> Class 1987=head2 The C<urxvt::timer> Class
1588 1988
1589This class implements timer watchers/events. Time is represented as a 1989This class implements timer watchers/events. Time is represented as a
1590fractional number of seconds since the epoch. Example: 1990fractional number of seconds since the epoch. Example:
1594 ->new 1994 ->new
1595 ->interval (1) 1995 ->interval (1)
1596 ->cb (sub { 1996 ->cb (sub {
1597 $term->{overlay}->set (0, 0, 1997 $term->{overlay}->set (0, 0,
1598 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1998 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1599 }); 1999 });
1600 2000
1601=over 4 2001=over 4
1602 2002
1603=item $timer = new urxvt::timer 2003=item $timer = new urxvt::timer
1604 2004
1628Start the timer. 2028Start the timer.
1629 2029
1630=item $timer = $timer->start ($tstamp) 2030=item $timer = $timer->start ($tstamp)
1631 2031
1632Set the event trigger time to C<$tstamp> and start the timer. 2032Set the event trigger time to C<$tstamp> and start the timer.
2033
2034=item $timer = $timer->after ($delay)
2035
2036Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1633 2037
1634=item $timer = $timer->stop 2038=item $timer = $timer->stop
1635 2039
1636Stop the timer. 2040Stop the timer.
1637 2041
1643 2047
1644 $term->{socket} = ... 2048 $term->{socket} = ...
1645 $term->{iow} = urxvt::iow 2049 $term->{iow} = urxvt::iow
1646 ->new 2050 ->new
1647 ->fd (fileno $term->{socket}) 2051 ->fd (fileno $term->{socket})
1648 ->events (urxvt::EVENT_READ) 2052 ->events (urxvt::EV_READ)
1649 ->start 2053 ->start
1650 ->cb (sub { 2054 ->cb (sub {
1651 my ($iow, $revents) = @_; 2055 my ($iow, $revents) = @_;
1652 # $revents must be 1 here, no need to check 2056 # $revents must be 1 here, no need to check
1653 sysread $term->{socket}, my $buf, 8192 2057 sysread $term->{socket}, my $buf, 8192
1666Set the callback to be called when io events are triggered. C<$reventmask> 2070Set the callback to be called when io events are triggered. C<$reventmask>
1667is a bitset as described in the C<events> method. 2071is a bitset as described in the C<events> method.
1668 2072
1669=item $iow = $iow->fd ($fd) 2073=item $iow = $iow->fd ($fd)
1670 2074
1671Set the filedescriptor (not handle) to watch. 2075Set the file descriptor (not handle) to watch.
1672 2076
1673=item $iow = $iow->events ($eventmask) 2077=item $iow = $iow->events ($eventmask)
1674 2078
1675Set the event mask to watch. The only allowed values are 2079Set the event mask to watch. The only allowed values are
1676C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2080C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1677together, or C<urxvt::EVENT_NONE>. 2081together, or C<urxvt::EV_NONE>.
1678 2082
1679=item $iow = $iow->start 2083=item $iow = $iow->start
1680 2084
1681Start watching for requested events on the given handle. 2085Start watching for requested events on the given handle.
1682 2086
1683=item $iow = $iow->stop 2087=item $iow = $iow->stop
1684 2088
1685Stop watching for events on the given filehandle. 2089Stop watching for events on the given file handle.
2090
2091=back
2092
2093=head2 The C<urxvt::iw> Class
2094
2095This class implements idle watchers, that get called automatically when
2096the process is idle. They should return as fast as possible, after doing
2097some useful work.
2098
2099=over 4
2100
2101=item $iw = new urxvt::iw
2102
2103Create a new idle watcher object in stopped state.
2104
2105=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2106
2107Set the callback to be called when the watcher triggers.
2108
2109=item $timer = $timer->start
2110
2111Start the watcher.
2112
2113=item $timer = $timer->stop
2114
2115Stop the watcher.
2116
2117=back
2118
2119=head2 The C<urxvt::pw> Class
2120
2121This class implements process watchers. They create an event whenever a
2122process exits, after which they stop automatically.
2123
2124 my $pid = fork;
2125 ...
2126 $term->{pw} = urxvt::pw
2127 ->new
2128 ->start ($pid)
2129 ->cb (sub {
2130 my ($pw, $exit_status) = @_;
2131 ...
2132 });
2133
2134=over 4
2135
2136=item $pw = new urxvt::pw
2137
2138Create a new process watcher in stopped state.
2139
2140=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2141
2142Set the callback to be called when the timer triggers.
2143
2144=item $pw = $timer->start ($pid)
2145
2146Tells the watcher to start watching for process C<$pid>.
2147
2148=item $pw = $pw->stop
2149
2150Stop the watcher.
1686 2151
1687=back 2152=back
1688 2153
1689=head1 ENVIRONMENT 2154=head1 ENVIRONMENT
1690 2155
1699 2164
1700=item >= 3 - script loading and management 2165=item >= 3 - script loading and management
1701 2166
1702=item >=10 - all called hooks 2167=item >=10 - all called hooks
1703 2168
1704=item >=11 - hook reutrn values 2169=item >=11 - hook return values
1705 2170
1706=back 2171=back
1707 2172
1708=head1 AUTHOR 2173=head1 AUTHOR
1709 2174
1711 http://software.schmorp.de/pkg/rxvt-unicode 2176 http://software.schmorp.de/pkg/rxvt-unicode
1712 2177
1713=cut 2178=cut
1714 2179
17151 21801
2181
2182# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines