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.89 by root, Thu Jan 12 12:10:06 2006 UTC vs.
Revision 1.157 by ayin, Wed Oct 31 09:55:24 2007 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,automove-background,selection-autotransform
39 46
40=over 4 47=over 4
41 48
42=item selection (enabled by default) 49=item selection (enabled by default)
43 50
58 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
59 ... 66 ...
60 67
61The index number (0, 1...) must not have any holes, and each regex must 68The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for 69contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
64between two vertical bars: 71between two vertical bars:
65 72
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
67 81
68You can look at the source of the selection extension to see more 82You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 83interesting uses, such as parsing a line from beginning to end.
70 84
71This extension also offers the following bindable keyboard command: 85This extension also offers following bindable keyboard commands:
72 86
73=over 4 87=over 4
74 88
75=item rot13 89=item rot13
76 90
83=item option-popup (enabled by default) 97=item option-popup (enabled by default)
84 98
85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86runtime. 100runtime.
87 101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106It's 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
129It's 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 be" => 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 (the 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.
120 201
121For example, the following will transform selections of the form 202For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename 203C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>: 204$word>:
124 205
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\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/^(S+):(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
132=item mark-urls 213Of course, this can be modified to suit your needs and your editor :)
133 214
215To expand the example above to typical perl error messages ("XXX at
216FILENAME line YYY."), you need a slightly more elaborate solution:
217
218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221The first line tells the selection code to treat the unchanging part of
222every error message as a selection pattern, and the second line transforms
223the message into vi commands to load the file.
224
225=item tabbed
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
134Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
135make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
136resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
137the 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 leats 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 thats 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 automove-background
309
310This is basically a very small extension that dynamically changes the
311background pixmap offset to the window position, in effect creating the
312same effect as pseudo transparency with a custom pixmap. No scaling is
313supported in this mode. Example:
314
315 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
316
317L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
318shows how this extension can be used to implement an automatically blurred
319transparent background.
138 320
139=item block-graphics-to-ascii 321=item block-graphics-to-ascii
140 322
141A not very useful example of filtering all text output to the terminal, 323A not very useful example of filtering all text output to the terminal
142by replacing all line-drawing characters (U+2500 .. U+259F) by a 324by replacing all line-drawing characters (U+2500 .. U+259F) by a
143similar-looking ascii character. 325similar-looking ascii character.
144 326
145=item digital-clock 327=item digital-clock
146 328
147Displays a digital clock using the built-in overlay. 329Displays a digital clock using the built-in overlay.
330
331=item remote-clipboard
332
333Somewhat of a misnomer, this extension adds two menu entries to the
334selection popup that allows one ti run external commands to store the
335selection somewhere and fetch it again.
336
337We use it to implement a "distributed selection mechanism", which just
338means that one command uploads the file to a remote server, and another
339reads it.
340
341The commands can be set using the C<URxvt.remote-selection.store> and
342C<URxvt.remote-selection.fetch> resources. The first should read the
343selection to store from STDIN (always in UTF-8), the second should provide
344the selection data on STDOUT (also in UTF-8).
345
346The defaults (which are likely useless to you) use rsh and cat:
347
348 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
349 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
350
351=item selection-pastebin
352
353This is a little rarely useful extension that Uploads the selection as
354textfile to a remote site (or does other things). (The implementation is
355not currently secure for use in a multiuser environment as it writes to
356F</tmp> directly.).
357
358It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
359i.e.
360
361 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
362
363Pressing this combination runs a command with C<%> replaced by the name of
364the textfile. This command can be set via a resource:
365
366 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
367
368And the default is likely not useful to anybody but the few people around
369here :)
370
371The name of the textfile is the hex encoded md5 sum of the selection, so
372the same content should lead to the same filename.
373
374After a successful upload the selection will be replaced by the text given
375in the C<selection-pastebin-url> resource (again, the % is the placeholder
376for the filename):
377
378 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
379
380I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
381the double C</> characters as comment start. Use C<\057\057> instead,
382which works regardless of wether xrdb is used to parse the resource file
383or not.
148 384
149=item example-refresh-hooks 385=item example-refresh-hooks
150 386
151Displays a very simple digital clock in the upper right corner of the 387Displays a very simple digital clock in the upper right corner of the
152window. Illustrates overwriting the refresh callbacks to create your own 388window. Illustrates overwriting the refresh callbacks to create your own
192 428
193=back 429=back
194 430
195=head2 Extension Objects 431=head2 Extension Objects
196 432
197Very perl extension is a perl class. A separate perl object is created 433Every perl extension is a perl class. A separate perl object is created
198for each terminal and each extension and passed as the first parameter to 434for each terminal, and each terminal has its own set of extenion objects,
199hooks. So extensions can use their C<$self> object without having to think 435which are passed as the first parameter to hooks. So extensions can use
200about other extensions, with the exception of methods and members that 436their C<$self> object without having to think about clashes with other
437extensions or other terminals, with the exception of methods and members
201begin with an underscore character C<_>: these are reserved for internal 438that begin with an underscore character C<_>: these are reserved for
202use. 439internal use.
203 440
204Although it isn't a C<urxvt::term> object, you can call all methods of the 441Although it isn't a C<urxvt::term> object, you can call all methods of the
205C<urxvt::term> class on this object. 442C<urxvt::term> class on this object.
206 443
207It has the following methods and data members: 444It has the following methods and data members:
228=head2 Hooks 465=head2 Hooks
229 466
230The following subroutines can be declared in extension files, and will be 467The following subroutines can be declared in extension files, and will be
231called whenever the relevant event happens. 468called whenever the relevant event happens.
232 469
233The first argument passed to them is an extension oject as described in 470The first argument passed to them is an extension object as described in
234the in the C<Extension Objects> section. 471the in the C<Extension Objects> section.
235 472
236B<All> of these hooks must return a boolean value. If it is true, then the 473B<All> of these hooks must return a boolean value. If any of the called
237event counts as being I<consumed>, and the invocation of other hooks is 474hooks returns true, then the event counts as being I<consumed>, and the
238skipped, and the relevant action might not be carried out by the C++ code. 475relevant action might not be carried out by the C++ code.
239 476
240I<< When in doubt, return a false value (preferably C<()>). >> 477I<< When in doubt, return a false value (preferably C<()>). >>
241 478
242=over 4 479=over 4
243 480
244=item on_init $term 481=item on_init $term
245 482
246Called after a new terminal object has been initialized, but before 483Called after a new terminal object has been initialized, but before
247windows are created or the command gets run. Most methods are unsafe to 484windows are created or the command gets run. Most methods are unsafe to
248call or deliver senseless data, as terminal size and other characteristics 485call or deliver senseless data, as terminal size and other characteristics
249have not yet been determined. You can safely query and change resources, 486have not yet been determined. You can safely query and change resources
250though. 487and options, though. For many purposes the C<on_start> hook is a better
488place.
489
490=item on_start $term
491
492Called at the very end of initialisation of a new terminal, just before
493trying to map (display) the toplevel and returning to the main loop.
494
495=item on_destroy $term
496
497Called whenever something tries to destroy terminal, when the terminal is
498still fully functional (not for long, though).
251 499
252=item on_reset $term 500=item on_reset $term
253 501
254Called after the screen is "reset" for any reason, such as resizing or 502Called after the screen is "reset" for any reason, such as resizing or
255control sequences. Here is where you can react on changes to size-related 503control sequences. Here is where you can react on changes to size-related
256variables. 504variables.
257 505
258=item on_start $term 506=item on_child_start $term, $pid
259 507
260Called at the very end of initialisation of a new terminal, just before 508Called just after the child process has been C<fork>ed.
261returning to the mainloop. 509
510=item on_child_exit $term, $status
511
512Called just after the child process has exited. C<$status> is the status
513from C<waitpid>.
262 514
263=item on_sel_make $term, $eventtime 515=item on_sel_make $term, $eventtime
264 516
265Called whenever a selection has been made by the user, but before the 517Called whenever a selection has been made by the user, but before the
266selection text is copied, so changes to the beginning, end or type of the 518selection text is copied, so changes to the beginning, end or type of the
273 525
274Called whenever a selection has been copied, but before the selection is 526Called whenever a selection has been copied, but before the selection is
275requested from the server. The selection text can be queried and changed 527requested from the server. The selection text can be queried and changed
276by calling C<< $term->selection >>. 528by calling C<< $term->selection >>.
277 529
278Returning a true value aborts selection grabbing. It will still be hilighted. 530Returning a true value aborts selection grabbing. It will still be highlighted.
279 531
280=item on_sel_extend $term 532=item on_sel_extend $term
281 533
282Called whenever the user tries to extend the selection (e.g. with a double 534Called whenever the user tries to extend the selection (e.g. with a double
283click) and is either supposed to return false (normal operation), or 535click) and is either supposed to return false (normal operation), or
284should extend the selection itelf and return true to suppress the built-in 536should extend the selection itself and return true to suppress the built-in
285processing. This can happen multiple times, as long as the callback 537processing. This can happen multiple times, as long as the callback
286returns true, it will be called on every further click by the user and is 538returns true, it will be called on every further click by the user and is
287supposed to enlarge the selection more and more, if possible. 539supposed to enlarge the selection more and more, if possible.
288 540
289See the F<selection> example extension. 541See the F<selection> example extension.
290 542
291=item on_view_change $term, $offset 543=item on_view_change $term, $offset
292 544
293Called whenever the view offset changes, i..e the user or program 545Called whenever the view offset changes, i.e. the user or program
294scrolls. Offset C<0> means display the normal terminal, positive values 546scrolls. Offset C<0> means display the normal terminal, positive values
295show this many lines of scrollback. 547show this many lines of scrollback.
296 548
297=item on_scroll_back $term, $lines, $saved 549=item on_scroll_back $term, $lines, $saved
298 550
302 554
303It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 555It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
304$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 556$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
305number of lines that will be in the scrollback buffer. 557number of lines that will be in the scrollback buffer.
306 558
559=item on_osc_seq $term, $op, $args
560
561Called on every OSC sequence and can be used to suppress it or modify its
562behaviour. The default should be to return an empty list. A true value
563suppresses execution of the request completely. Make sure you don't get
564confused by recursive invocations when you output an osc sequence within
565this callback.
566
567C<on_osc_seq_perl> should be used for new behaviour.
568
307=item on_osc_seq $term, $string 569=item on_osc_seq_perl $term, $string
308 570
309Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 571Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
310operating system command) is processed. Cursor position and other state 572operating system command) is processed. Cursor position and other state
311information is up-to-date when this happens. For interoperability, the 573information is up-to-date when this happens. For interoperability, the
312string should start with the extension name and a colon, to distinguish 574string should start with the extension name and a colon, to distinguish
313it from commands for other extensions, and this might be enforced in the 575it from commands for other extensions, and this might be enforced in the
314future. 576future.
315 577
316Be careful not ever to trust (in a security sense) the data you receive, 578Be careful not ever to trust (in a security sense) the data you receive,
317as its source can not easily be controleld (e-mail content, messages from 579as its source can not easily be controlled (e-mail content, messages from
318other users on the same system etc.). 580other users on the same system etc.).
319 581
320=item on_add_lines $term, $string 582=item on_add_lines $term, $string
321 583
322Called 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
353 615
354=item on_refresh_end $term 616=item on_refresh_end $term
355 617
356Called just after the screen gets redrawn. See C<on_refresh_begin>. 618Called just after the screen gets redrawn. See C<on_refresh_begin>.
357 619
358=item on_keyboard_command $term, $string 620=item on_user_command $term, $string
359 621
360Called whenever the user presses a key combination that has a 622Called whenever a user-configured event is being activated (e.g. via
361C<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>
362resource 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.
634
635=item on_x_event $term, $event
636
637Called on every X event received on the vt window (and possibly other
638windows). Should only be used as a last resort. Most event structure
639members are not passed.
640
641=item on_root_event $term, $event
642
643Like C<on_x_event>, but is called for events on the root window.
363 644
364=item on_focus_in $term 645=item on_focus_in $term
365 646
366Called whenever the window gets the keyboard focus, before rxvt-unicode 647Called whenever the window gets the keyboard focus, before rxvt-unicode
367does focus in processing. 648does focus in processing.
368 649
369=item on_focus_out $term 650=item on_focus_out $term
370 651
371Called wheneever the window loses keyboard focus, before rxvt-unicode does 652Called whenever the window loses keyboard focus, before rxvt-unicode does
372focus out processing. 653focus out processing.
654
655=item on_configure_notify $term, $event
656
657=item on_property_notify $term, $event
373 658
374=item on_key_press $term, $event, $keysym, $octets 659=item on_key_press $term, $event, $keysym, $octets
375 660
376=item on_key_release $term, $event, $keysym 661=item on_key_release $term, $event, $keysym
377 662
387 672
388Called whenever the corresponding X event is received for the terminal If 673Called whenever the corresponding X event is received for the terminal If
389the 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.
390 675
391The 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
392manpage), 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
393and column under the mouse cursor. 678(real, not screen-based) row and column under the mouse cursor.
394 679
395C<on_key_press> additionally receives the string rxvt-unicode would 680C<on_key_press> additionally receives the string rxvt-unicode would
396output, if any, in locale-specific encoding. 681output, if any, in locale-specific encoding.
397 682
398subwindow. 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).
399 693
400=back 694=back
401 695
402=cut 696=cut
403 697
409use Scalar::Util (); 703use Scalar::Util ();
410use List::Util (); 704use List::Util ();
411 705
412our $VERSION = 1; 706our $VERSION = 1;
413our $TERM; 707our $TERM;
708our @TERM_INIT;
709our @TERM_EXT;
414our @HOOKNAME; 710our @HOOKNAME;
415our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 711our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
416our %OPTION; 712our %OPTION;
417 713
418our $LIBDIR; 714our $LIBDIR;
419our $RESNAME; 715our $RESNAME;
420our $RESCLASS; 716our $RESCLASS;
421our $RXVTNAME; 717our $RXVTNAME;
422 718
719our $NOCHAR = chr 0xffff;
720
423=head2 Variables in the C<urxvt> Package 721=head2 Variables in the C<urxvt> Package
424 722
425=over 4 723=over 4
426 724
427=item $urxvt::LIBDIR 725=item $urxvt::LIBDIR
439 737
440=item $urxvt::TERM 738=item $urxvt::TERM
441 739
442The current terminal. This variable stores the current C<urxvt::term> 740The current terminal. This variable stores the current C<urxvt::term>
443object, 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>.
444 758
445=back 759=back
446 760
447=head2 Functions in the C<urxvt> Package 761=head2 Functions in the C<urxvt> Package
448 762
463Using 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
464correct place, e.g. on stderr of the connecting urxvtc client. 778correct place, e.g. on stderr of the connecting urxvtc client.
465 779
466Messages have a size limit of 1023 bytes currently. 780Messages have a size limit of 1023 bytes currently.
467 781
468=item $is_safe = urxvt::safe 782=item @terms = urxvt::termlist
469 783
470Returns true when it is safe to do potentially unsafe things, such as 784Returns all urxvt::term objects that exist in this process, regardless of
471evaluating perl code specified by the user. This is true when urxvt was 785whether they are started, being destroyed etc., so be careful. Only term
472started setuid or setgid. 786objects that have perl extensions attached will be returned (because there
787is no urxvt::term objet associated with others).
473 788
474=item $time = urxvt::NOW 789=item $time = urxvt::NOW
475 790
476Returns the "current time" (as per the event loop). 791Returns the "current time" (as per the event loop).
477 792
478=item urxvt::CurrentTime 793=item urxvt::CurrentTime
479 794
480=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 795=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
481Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 796Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
482Button4Mask, Button5Mask, AnyModifier 797Button4Mask, Button5Mask, AnyModifier
798
799=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
800ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
801PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
802Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
803KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
804ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
805FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
806
807=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
808EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
809GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
810UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
811ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
812CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
813SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
483 814
484Various constants for use in X calls and event processing. 815Various constants for use in X calls and event processing.
485 816
486=back 817=back
487 818
520 851
521=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 852=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
522 853
523=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 854=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
524 855
856=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
857
525Replace the foreground/background colour in the rendition mask with the 858Replace the foreground/background colour in the rendition mask with the
526specified one. 859specified one.
527 860
528=item $value = urxvt::GET_CUSTOM $rend 861=item $value = urxvt::GET_CUSTOM $rend
529 862
538=back 871=back
539 872
540=cut 873=cut
541 874
542BEGIN { 875BEGIN {
543 urxvt->bootstrap;
544
545 # overwrite perl's warn 876 # overwrite perl's warn
546 *CORE::GLOBAL::warn = sub { 877 *CORE::GLOBAL::warn = sub {
547 my $msg = join "", @_; 878 my $msg = join "", @_;
548 $msg .= "\n" 879 $msg .= "\n"
549 unless $msg =~ /\n$/; 880 unless $msg =~ /\n$/;
550 urxvt::warn ($msg); 881 urxvt::warn ($msg);
551 }; 882 };
552
553 # %ENV is the original startup environment
554 delete $ENV{IFS};
555 delete $ENV{CDPATH};
556 delete $ENV{BASH_ENV};
557 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
558} 883}
559 884
560my @hook_count; 885no warnings 'utf8';
886
561my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 887my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
562 888
563sub verbose { 889sub verbose {
564 my ($level, $msg) = @_; 890 my ($level, $msg) = @_;
565 warn "$msg\n" if $level <= $verbosity; 891 warn "$msg\n" if $level <= $verbosity;
566} 892}
567 893
568my $extension_pkg = "extension0000";
569my %extension_pkg; 894my %extension_pkg;
570 895
571# load a single script into its own package, once only 896# load a single script into its own package, once only
572sub extension_package($) { 897sub extension_package($) {
573 my ($path) = @_; 898 my ($path) = @_;
574 899
575 $extension_pkg{$path} ||= do { 900 $extension_pkg{$path} ||= do {
576 my $pkg = "urxvt::" . ($extension_pkg++); 901 $path =~ /([^\/\\]+)$/;
902 my $pkg = $1;
903 $pkg =~ s/[^[:word:]]/_/g;
904 $pkg = "urxvt::ext::$pkg";
577 905
578 verbose 3, "loading extension '$path' into package '$pkg'"; 906 verbose 3, "loading extension '$path' into package '$pkg'";
579 907
580 open my $fh, "<:raw", $path 908 open my $fh, "<:raw", $path
581 or die "$path: $!"; 909 or die "$path: $!";
582 910
583 my $source = untaint 911 my $source =
584 "package $pkg; use strict; use utf8;\n" 912 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
585 . "use base urxvt::term::extension::;\n"
586 . "#line 1 \"$path\"\n{\n" 913 . "#line 1 \"$path\"\n{\n"
587 . (do { local $/; <$fh> }) 914 . (do { local $/; <$fh> })
588 . "\n};\n1"; 915 . "\n};\n1";
589 916
590 eval $source 917 eval $source
601 local $TERM = shift; 928 local $TERM = shift;
602 my $htype = shift; 929 my $htype = shift;
603 930
604 if ($htype == 0) { # INIT 931 if ($htype == 0) { # INIT
605 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
606 933
607 my %ext_arg; 934 my %ext_arg;
608 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
609 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 945 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
610 if ($_ eq "default") { 946 if ($_ eq "default") {
611 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 947 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
612 } elsif (/^-(.*)$/) { 948 } elsif (/^-(.*)$/) {
613 delete $ext_arg{$1}; 949 delete $ext_arg{$1};
614 } elsif (/^([^<]+)<(.*)>$/) { 950 } elsif (/^([^<]+)<(.*)>$/) {
615 push @{ $ext_arg{$1} }, $2; 951 push @{ $ext_arg{$1} }, $2;
616 } else { 952 } else {
617 $ext_arg{$_} ||= []; 953 $ext_arg{$_} ||= [];
618 } 954 }
619 } 955 }
620 956
621 while (my ($ext, $argv) = each %ext_arg) { 957 for my $ext (sort keys %ext_arg) {
622 my @files = grep -f $_, map "$_/$ext", @dirs; 958 my @files = grep -f $_, map "$_/$ext", @dirs;
623 959
624 if (@files) { 960 if (@files) {
625 $TERM->register_package (extension_package $files[0], $argv); 961 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
626 } else { 962 } else {
627 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";
628 } 964 }
629 } 965 }
630 966
636 972
637 if (my $cb = $TERM->{_hook}[$htype]) { 973 if (my $cb = $TERM->{_hook}[$htype]) {
638 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 974 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
639 if $verbosity >= 10; 975 if $verbosity >= 10;
640 976
641 keys %$cb; 977 for my $pkg (keys %$cb) {
642
643 while (my ($pkg, $cb) = each %$cb) {
644 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 978 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
645 and last; 979 $retval ||= $retval_;
646 980
647 if ($@) { 981 if ($@) {
648 $TERM->ungrab; # better to lose the grab than the session 982 $TERM->ungrab; # better to lose the grab than the session
649 warn $@; 983 warn $@;
650 } 984 }
653 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 987 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
654 if $verbosity >= 11; 988 if $verbosity >= 11;
655 } 989 }
656 990
657 if ($htype == 1) { # DESTROY 991 if ($htype == 1) { # DESTROY
658 if (my $hook = delete $TERM->{_hook}) {
659 for my $htype (0..$#$hook) {
660 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
661 or set_should_invoke $htype, 0;
662 }
663 }
664
665 # clear package objects 992 # clear package objects
666 %$_ = () for values %{ $TERM->{_pkg} }; 993 %$_ = () for values %{ $TERM->{_pkg} };
667 994
668 # clear package 995 # clear package
669 %$TERM = (); 996 %$TERM = ();
670 } 997 }
671 998
672 $retval 999 $retval
673} 1000}
674 1001
675sub exec_async(@) { 1002sub SET_COLOR($$$) {
676 my $pid = fork; 1003 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1004}
677 1005
678 return 1006sub rend2mask {
679 if !defined $pid or $pid; 1007 no strict 'refs';
680 1008 my ($str, $mask) = (@_, 0);
681 %ENV = %{ $TERM->env }; 1009 my %color = ( fg => undef, bg => undef );
682 1010 my @failed;
683 exec @_; 1011 for my $spec ( split /\s+/, $str ) {
684 _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)
685} 1029}
686 1030
687# urxvt::term::extension 1031# urxvt::term::extension
688 1032
689package urxvt::term::extension; 1033package urxvt::term::extension;
695 while (my ($name, $cb) = each %hook) { 1039 while (my ($name, $cb) = each %hook) {
696 my $htype = $HOOKTYPE{uc $name}; 1040 my $htype = $HOOKTYPE{uc $name};
697 defined $htype 1041 defined $htype
698 or Carp::croak "unsupported hook type '$name'"; 1042 or Carp::croak "unsupported hook type '$name'";
699 1043
1044 $self->set_should_invoke ($htype, +1)
700 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 1045 unless exists $self->{term}{_hook}[$htype]{$pkg};
701 $hook_count[$htype]++
702 or urxvt::set_should_invoke $htype, 1;
703 }
704 1046
705 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1047 $self->{term}{_hook}[$htype]{$pkg} = $cb;
706 } 1048 }
707} 1049}
708 1050
713 for my $name (@hook) { 1055 for my $name (@hook) {
714 my $htype = $HOOKTYPE{uc $name}; 1056 my $htype = $HOOKTYPE{uc $name};
715 defined $htype 1057 defined $htype
716 or Carp::croak "unsupported hook type '$name'"; 1058 or Carp::croak "unsupported hook type '$name'";
717 1059
1060 $self->set_should_invoke ($htype, -1)
718 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 1061 if delete $self->{term}{_hook}[$htype]{$pkg};
719 --$hook_count[$htype]
720 or urxvt::set_should_invoke $htype, 0;
721 }
722 } 1062 }
723} 1063}
724 1064
725our $AUTOLOAD; 1065our $AUTOLOAD;
726 1066
806sub DESTROY { 1146sub DESTROY {
807 $_[0][1]->stop; 1147 $_[0][1]->stop;
808} 1148}
809 1149
810sub condvar { 1150sub condvar {
811 bless \my $flag, urxvt::anyevent::condvar:: 1151 bless \my $flag, urxvt::anyevent::
812} 1152}
813 1153
814sub urxvt::anyevent::condvar::broadcast { 1154sub broadcast {
815 ${$_[0]}++; 1155 ${$_[0]}++;
816} 1156}
817 1157
818sub urxvt::anyevent::condvar::wait { 1158sub wait {
819 unless (${$_[0]}) { 1159 unless (${$_[0]}) {
820 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1160 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
821 } 1161 }
1162}
1163
1164sub one_event {
1165 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
822} 1166}
823 1167
824package urxvt::term; 1168package urxvt::term;
825 1169
826=head2 The C<urxvt::term> Class 1170=head2 The C<urxvt::term> Class
831 1175
832# find on_xxx subs in the package and register them 1176# find on_xxx subs in the package and register them
833# as hooks 1177# as hooks
834sub register_package { 1178sub register_package {
835 my ($self, $pkg, $argv) = @_; 1179 my ($self, $pkg, $argv) = @_;
1180
1181 no strict 'refs';
1182
1183 urxvt::verbose 6, "register package $pkg to $self";
1184
1185 @{"$pkg\::ISA"} = urxvt::term::extension::;
836 1186
837 my $proxy = bless { 1187 my $proxy = bless {
838 _pkg => $pkg, 1188 _pkg => $pkg,
839 argv => $argv, 1189 argv => $argv,
840 }, $pkg; 1190 }, $pkg;
856hash which defines the environment of the new terminal. 1206hash which defines the environment of the new terminal.
857 1207
858Croaks (and probably outputs an error message) if the new instance 1208Croaks (and probably outputs an error message) if the new instance
859couldn't be created. Returns C<undef> if the new instance didn't 1209couldn't be created. Returns C<undef> if the new instance didn't
860initialise perl, and the terminal object otherwise. The C<init> and 1210initialise perl, and the terminal object otherwise. The C<init> and
861C<start> hooks will be called during this call. 1211C<start> hooks will be called before this call returns, and are free to
1212refer to global data (which is race free).
862 1213
863=cut 1214=cut
864 1215
865sub new { 1216sub new {
866 my ($class, $env, @args) = @_; 1217 my ($class, $env, @args) = @_;
867 1218
1219 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1220 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1221
868 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1222 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
869} 1223}
870 1224
871=item $term->destroy 1225=item $term->destroy
872 1226
873Destroy the terminal object (close the window, free resources 1227Destroy the terminal object (close the window, free resources
874etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1228etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
875watchers (timers, io watchers) are still active. 1229watchers (timers, io watchers) are still active.
876 1230
1231=item $term->exec_async ($cmd[, @args])
1232
1233Works like the combination of the C<fork>/C<exec> builtins, which executes
1234("starts") programs in the background. This function takes care of setting
1235the user environment before exec'ing the command (e.g. C<PATH>) and should
1236be preferred over explicit calls to C<exec> or C<system>.
1237
1238Returns the pid of the subprocess or C<undef> on error.
1239
1240=cut
1241
1242sub exec_async {
1243 my $self = shift;
1244
1245 my $pid = fork;
1246
1247 return $pid
1248 if !defined $pid or $pid;
1249
1250 %ENV = %{ $self->env };
1251
1252 exec @_;
1253 urxvt::_exit 255;
1254}
1255
877=item $isset = $term->option ($optval[, $set]) 1256=item $isset = $term->option ($optval[, $set])
878 1257
879Returns true if the option specified by C<$optval> is enabled, and 1258Returns true if the option specified by C<$optval> is enabled, and
880optionally change it. All option values are stored by name in the hash 1259optionally change it. All option values are stored by name in the hash
881C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1260C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
882 1261
883Here is a a likely non-exhaustive list of option names, please see the 1262Here is a likely non-exhaustive list of option names, please see the
884source file F</src/optinc.h> to see the actual list: 1263source file F</src/optinc.h> to see the actual list:
885 1264
886 borderLess console cursorBlink cursorUnderline hold iconic insecure 1265 borderLess console cursorBlink cursorUnderline hold iconic insecure
887 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1266 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
888 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1267 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
889 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1268 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
890 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1269 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
891 tripleclickwords utmpInhibit visualBell 1270 transparent tripleclickwords utmpInhibit visualBell
892 1271
893=item $value = $term->resource ($name[, $newval]) 1272=item $value = $term->resource ($name[, $newval])
894 1273
895Returns the current resource value associated with a given name and 1274Returns the current resource value associated with a given name and
896optionally sets a new value. Setting values is most useful in the C<init> 1275optionally sets a new value. Setting values is most useful in the C<init>
905likely change). 1284likely change).
906 1285
907Please note that resource strings will currently only be freed when the 1286Please note that resource strings will currently only be freed when the
908terminal is destroyed, so changing options frequently will eat memory. 1287terminal is destroyed, so changing options frequently will eat memory.
909 1288
910Here is a a likely non-exhaustive list of resource names, not all of which 1289Here is a likely non-exhaustive list of resource names, not all of which
911are supported in every build, please see the source file F</src/rsinc.h> 1290are supported in every build, please see the source file F</src/rsinc.h>
912to see the actual list: 1291to see the actual list:
913 1292
914 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1293 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
915 borderLess color cursorBlink cursorUnderline cutchars delete_key 1294 borderLess color cursorBlink cursorUnderline cutchars delete_key
916 display_name embed ext_bwidth fade font geometry hold iconName 1295 display_name embed ext_bwidth fade font geometry hold iconName
917 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1296 imFont imLocale inputMethod insecure int_bwidth intensityStyles
918 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1297 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
919 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1298 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
920 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1299 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
921 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1300 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
922 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1301 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
923 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1302 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
924 shade term_name title transparent transparent_all tripleclickwords 1303 secondaryScreen secondaryScroll selectstyle shade term_name title
925 utmpInhibit visualBell 1304 transient_for transparent transparent_all tripleclickwords utmpInhibit
1305 visualBell
926 1306
927=cut 1307=cut
928 1308
929sub resource($$;$) { 1309sub resource($$;$) {
930 my ($self, $name) = (shift, shift); 1310 my ($self, $name) = (shift, shift);
1104 1484
1105Normally its not a good idea to use this function, as programs might be 1485Normally its not a good idea to use this function, as programs might be
1106confused by changes in cursor position or scrolling. Its useful inside a 1486confused by changes in cursor position or scrolling. Its useful inside a
1107C<on_add_lines> hook, though. 1487C<on_add_lines> hook, though.
1108 1488
1489=item $term->scr_change_screen ($screen)
1490
1491Switch to given screen - 0 primary, 1 secondary.
1492
1109=item $term->cmd_parse ($octets) 1493=item $term->cmd_parse ($octets)
1110 1494
1111Similar to C<scr_add_lines>, but the argument must be in the 1495Similar to C<scr_add_lines>, but the argument must be in the
1112locale-specific encoding of the terminal and can contain command sequences 1496locale-specific encoding of the terminal and can contain command sequences
1113(escape codes) that will be interpreted. 1497(escape codes) that will be interpreted.
1123Replaces the event mask of the pty watcher by the given event mask. Can 1507Replaces the event mask of the pty watcher by the given event mask. Can
1124be used to suppress input and output handling to the pty/tty. See the 1508be used to suppress input and output handling to the pty/tty. See the
1125description of C<< urxvt::timer->events >>. Make sure to always restore 1509description of C<< urxvt::timer->events >>. Make sure to always restore
1126the previous value. 1510the previous value.
1127 1511
1512=item $fd = $term->pty_fd
1513
1514Returns the master file descriptor for the pty in use, or C<-1> if no pty
1515is used.
1516
1128=item $windowid = $term->parent 1517=item $windowid = $term->parent
1129 1518
1130Return the window id of the toplevel window. 1519Return the window id of the toplevel window.
1131 1520
1132=item $windowid = $term->vt 1521=item $windowid = $term->vt
1133 1522
1134Return the window id of the terminal window. 1523Return the window id of the terminal window.
1135 1524
1525=item $term->vt_emask_add ($x_event_mask)
1526
1527Adds the specified events to the vt event mask. Useful e.g. when you want
1528to receive pointer events all the times:
1529
1530 $term->vt_emask_add (urxvt::PointerMotionMask);
1531
1532=item $term->focus_in
1533
1534=item $term->focus_out
1535
1536=item $term->key_press ($state, $keycode[, $time])
1537
1538=item $term->key_release ($state, $keycode[, $time])
1539
1540Deliver various fake events to to terminal.
1541
1136=item $window_width = $term->width 1542=item $window_width = $term->width
1137 1543
1138=item $window_height = $term->height 1544=item $window_height = $term->height
1139 1545
1140=item $font_width = $term->fwidth 1546=item $font_width = $term->fwidth
1153 1559
1154=item $max_scrollback = $term->saveLines 1560=item $max_scrollback = $term->saveLines
1155 1561
1156=item $nrow_plus_saveLines = $term->total_rows 1562=item $nrow_plus_saveLines = $term->total_rows
1157 1563
1158=item $lines_in_scrollback = $term->nsaved 1564=item $topmost_scrollback_row = $term->top_row
1159 1565
1160Return various integers describing terminal characteristics. 1566Return various integers describing terminal characteristics.
1161 1567
1162=item $x_display = $term->display_id 1568=item $x_display = $term->display_id
1163 1569
1170=item $env = $term->env 1576=item $env = $term->env
1171 1577
1172Returns a copy of the environment in effect for the terminal as a hashref 1578Returns a copy of the environment in effect for the terminal as a hashref
1173similar to C<\%ENV>. 1579similar to C<\%ENV>.
1174 1580
1581=item @envv = $term->envv
1582
1583Returns the environment as array of strings of the form C<VAR=VALUE>.
1584
1585=item @argv = $term->argv
1586
1587Return the argument vector as this terminal, similar to @ARGV, but
1588includes the program name as first element.
1589
1175=cut 1590=cut
1176 1591
1177sub env { 1592sub env {
1178 if (my $env = $_[0]->_env) {
1179 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1593 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1180 } else {
1181 +{ %ENV }
1182 }
1183} 1594}
1184 1595
1185=item $modifiermask = $term->ModLevel3Mask 1596=item $modifiermask = $term->ModLevel3Mask
1186 1597
1187=item $modifiermask = $term->ModMetaMask 1598=item $modifiermask = $term->ModMetaMask
1189=item $modifiermask = $term->ModNumLockMask 1600=item $modifiermask = $term->ModNumLockMask
1190 1601
1191Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1602Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1192AltGr), the meta key (often Alt) and the num lock key, if applicable. 1603AltGr), the meta key (often Alt) and the num lock key, if applicable.
1193 1604
1605=item $screen = $term->current_screen
1606
1607Returns the currently displayed screen (0 primary, 1 secondary).
1608
1609=item $cursor_is_hidden = $term->hidden_cursor
1610
1611Returns whether the cursor is currently hidden or not.
1612
1194=item $view_start = $term->view_start ([$newvalue]) 1613=item $view_start = $term->view_start ([$newvalue])
1195 1614
1196Returns the negative row number of the topmost line. Minimum value is 1615Returns the row number of the topmost displayed line. Maximum value is
1197C<0>, which displays the normal terminal contents. Larger values scroll 1616C<0>, which displays the normal terminal contents. Lower values scroll
1198this many lines into the scrollback buffer. 1617this many lines into the scrollback buffer.
1199 1618
1200=item $term->want_refresh 1619=item $term->want_refresh
1201 1620
1202Requests a screen refresh. At the next opportunity, rxvt-unicode will 1621Requests a screen refresh. At the next opportunity, rxvt-unicode will
1217line, starting at column C<$start_col> (default C<0>), which is useful 1636line, starting at column C<$start_col> (default C<0>), which is useful
1218to replace only parts of a line. The font index in the rendition will 1637to replace only parts of a line. The font index in the rendition will
1219automatically be updated. 1638automatically be updated.
1220 1639
1221C<$text> is in a special encoding: tabs and wide characters that use more 1640C<$text> is in a special encoding: tabs and wide characters that use more
1222than one cell when displayed are padded with urxvt::NOCHAR characters 1641than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1223(C<chr 65535>). Characters with combining characters and other characters 1642characters. Characters with combining characters and other characters that
1224that do not fit into the normal tetx encoding will be replaced with 1643do not fit into the normal tetx encoding will be replaced with characters
1225characters in the private use area. 1644in the private use area.
1226 1645
1227You have to obey this encoding when changing text. The advantage is 1646You have to obey this encoding when changing text. The advantage is
1228that C<substr> and similar functions work on screen cells and not on 1647that C<substr> and similar functions work on screen cells and not on
1229characters. 1648characters.
1230 1649
1374where one character corresponds to one screen cell. See 1793where one character corresponds to one screen cell. See
1375C<< $term->ROW_t >> for details. 1794C<< $term->ROW_t >> for details.
1376 1795
1377=item $string = $term->special_decode $text 1796=item $string = $term->special_decode $text
1378 1797
1379Converts rxvt-unicodes text reprsentation into a perl string. See 1798Converts rxvt-unicodes text representation into a perl string. See
1380C<< $term->ROW_t >> for details. 1799C<< $term->ROW_t >> for details.
1381 1800
1382=item $success = $term->grab_button ($button, $modifiermask) 1801=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1383 1802
1803=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1804
1384Registers a synchronous button grab. See the XGrabButton manpage. 1805Register/unregister a synchronous button grab. See the XGrabButton
1806manpage.
1385 1807
1386=item $success = $term->grab ($eventtime[, $sync]) 1808=item $success = $term->grab ($eventtime[, $sync])
1387 1809
1388Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1810Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1389synchronous (C<$sync> is true). Also remembers the grab timestampe. 1811synchronous (C<$sync> is true). Also remembers the grab timestamp.
1390 1812
1391=item $term->allow_events_async 1813=item $term->allow_events_async
1392 1814
1393Calls XAllowEvents with AsyncBoth for the most recent grab. 1815Calls XAllowEvents with AsyncBoth for the most recent grab.
1394 1816
1404=item $term->ungrab 1826=item $term->ungrab
1405 1827
1406Calls XUngrab for the most recent grab. Is called automatically on 1828Calls XUngrab for the most recent grab. Is called automatically on
1407evaluation errors, as it is better to lose the grab in the error case as 1829evaluation errors, as it is better to lose the grab in the error case as
1408the session. 1830the session.
1831
1832=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1833
1834=item $atom_name = $term->XGetAtomName ($atom)
1835
1836=item @atoms = $term->XListProperties ($window)
1837
1838=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1839
1840=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1841
1842=item $term->XDeleteProperty ($window, $property)
1843
1844=item $window = $term->DefaultRootWindow
1845
1846=item $term->XReparentWindow ($window, $parent, [$x, $y])
1847
1848=item $term->XMapWindow ($window)
1849
1850=item $term->XUnmapWindow ($window)
1851
1852=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1853
1854=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1855
1856=item $term->XChangeInput ($window, $add_events[, $del_events])
1857
1858Various X or X-related functions. The C<$term> object only serves as
1859the source of the display, otherwise those functions map more-or-less
1860directory onto the X functions of the same name.
1409 1861
1410=back 1862=back
1411 1863
1412=cut 1864=cut
1413 1865
1477 my ($self, $text, $cb) = @_; 1929 my ($self, $text, $cb) = @_;
1478 1930
1479 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1931 $self->add_item ({ type => "button", text => $text, activate => $cb});
1480} 1932}
1481 1933
1482=item $popup->add_toggle ($text, $cb, $initial_value) 1934=item $popup->add_toggle ($text, $initial_value, $cb)
1483 1935
1484Adds a toggle/checkbox item to the popup. Teh callback gets called 1936Adds a toggle/checkbox item to the popup. The callback gets called
1485whenever it gets toggled, with a boolean indicating its value as its first 1937whenever it gets toggled, with a boolean indicating its new value as its
1486argument. 1938first argument.
1487 1939
1488=cut 1940=cut
1489 1941
1490sub add_toggle { 1942sub add_toggle {
1491 my ($self, $text, $cb, $value) = @_; 1943 my ($self, $text, $value, $cb) = @_;
1492 1944
1493 my $item; $item = { 1945 my $item; $item = {
1494 type => "button", 1946 type => "button",
1495 text => " $text", 1947 text => " $text",
1496 value => $value, 1948 value => $value,
1515 my $env = $self->{term}->env; 1967 my $env = $self->{term}->env;
1516 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1968 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1517 delete $env->{LC_ALL}; 1969 delete $env->{LC_ALL};
1518 $env->{LC_CTYPE} = $self->{term}->locale; 1970 $env->{LC_CTYPE} = $self->{term}->locale;
1519 1971
1520 urxvt::term->new ($env, $self->{term}->resource ("name"), 1972 urxvt::term->new ($env, "popup",
1521 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1973 "--perl-lib" => "", "--perl-ext-common" => "",
1974 "-pty-fd" => -1, "-sl" => 0,
1975 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1522 "--transient-for" => $self->{term}->parent, 1976 "--transient-for" => $self->{term}->parent,
1523 "-display" => $self->{term}->display_id, 1977 "-display" => $self->{term}->display_id,
1524 "-pe" => "urxvt-popup") 1978 "-pe" => "urxvt-popup")
1525 or die "unable to create popup window\n"; 1979 or die "unable to create popup window\n";
1526} 1980}
1531 delete $self->{term}{_destroy}{$self}; 1985 delete $self->{term}{_destroy}{$self};
1532 $self->{term}->ungrab; 1986 $self->{term}->ungrab;
1533} 1987}
1534 1988
1535=back 1989=back
1990
1991=cut
1992
1993package urxvt::watcher;
1536 1994
1537=head2 The C<urxvt::timer> Class 1995=head2 The C<urxvt::timer> Class
1538 1996
1539This class implements timer watchers/events. Time is represented as a 1997This class implements timer watchers/events. Time is represented as a
1540fractional number of seconds since the epoch. Example: 1998fractional number of seconds since the epoch. Example:
1544 ->new 2002 ->new
1545 ->interval (1) 2003 ->interval (1)
1546 ->cb (sub { 2004 ->cb (sub {
1547 $term->{overlay}->set (0, 0, 2005 $term->{overlay}->set (0, 0,
1548 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2006 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1549 }); 2007 });
1550 2008
1551=over 4 2009=over 4
1552 2010
1553=item $timer = new urxvt::timer 2011=item $timer = new urxvt::timer
1554 2012
1578Start the timer. 2036Start the timer.
1579 2037
1580=item $timer = $timer->start ($tstamp) 2038=item $timer = $timer->start ($tstamp)
1581 2039
1582Set 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>.
1583 2045
1584=item $timer = $timer->stop 2046=item $timer = $timer->stop
1585 2047
1586Stop the timer. 2048Stop the timer.
1587 2049
1616Set 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>
1617is a bitset as described in the C<events> method. 2079is a bitset as described in the C<events> method.
1618 2080
1619=item $iow = $iow->fd ($fd) 2081=item $iow = $iow->fd ($fd)
1620 2082
1621Set the filedescriptor (not handle) to watch. 2083Set the file descriptor (not handle) to watch.
1622 2084
1623=item $iow = $iow->events ($eventmask) 2085=item $iow = $iow->events ($eventmask)
1624 2086
1625Set the event mask to watch. The only allowed values are 2087Set the event mask to watch. The only allowed values are
1626C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2088C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1630 2092
1631Start watching for requested events on the given handle. 2093Start watching for requested events on the given handle.
1632 2094
1633=item $iow = $iow->stop 2095=item $iow = $iow->stop
1634 2096
1635Stop 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.
1636 2159
1637=back 2160=back
1638 2161
1639=head1 ENVIRONMENT 2162=head1 ENVIRONMENT
1640 2163
1649 2172
1650=item >= 3 - script loading and management 2173=item >= 3 - script loading and management
1651 2174
1652=item >=10 - all called hooks 2175=item >=10 - all called hooks
1653 2176
1654=item >=11 - hook reutrn values 2177=item >=11 - hook return values
1655 2178
1656=back 2179=back
1657 2180
1658=head1 AUTHOR 2181=head1 AUTHOR
1659 2182
1661 http://software.schmorp.de/pkg/rxvt-unicode 2184 http://software.schmorp.de/pkg/rxvt-unicode
1662 2185
1663=cut 2186=cut
1664 2187
16651 21881
2189
2190# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines