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.88 by root, Thu Jan 12 12:05:28 2006 UTC vs.
Revision 1.162 by ayin, Mon Dec 17 16:57:57 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,selection-autotransform
39 46
40=over 4 47=over 4
41 48
42=item selection (enabled by default) 49=item selection (enabled by default)
43 50
58 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
59 ... 66 ...
60 67
61The index number (0, 1...) must not have any holes, and each regex must 68The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for 69contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
64between two vertical bars: 71between two vertical bars:
65 72
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
67 81
68You can look at the source of the selection extension to see more 82You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 83interesting uses, such as parsing a line from beginning to end.
70 84
71This extension also offers the following bindable keyboard command: 85This extension also offers following bindable keyboard commands:
72 86
73=over 4 87=over 4
74 88
75=item rot13 89=item rot13
76 90
83=item option-popup (enabled by default) 97=item option-popup (enabled by default)
84 98
85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86runtime. 100runtime.
87 101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
118
88=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
89 120
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<a>s:
138
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : ()
142 };
93 143
94=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
95 145
96Adds regex search functionality to the scrollback buffer, triggered 146Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 147by a hotkey (default: C<M-s>). While in search mode, normal terminal
102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
107selection. 157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
164
165=item readline (enabled by default)
166
167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters).
172
173To avoid too many false positives, this is only done when:
174
175=over 4
176
177=item - the tty is in ICANON state.
178
179=item - the text cursor is visible.
180
181=item - the primary screen is currently being displayed.
182
183=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
108 189
109=item selection-autotransform 190=item selection-autotransform
110 191
111This selection allows you to do automatic transforms on a selection 192This selection allows you to do automatic transforms on a selection
112whenever a selection is made. 193whenever a selection is made.
117 URxvt.selection-autotransform.0: transform 198 URxvt.selection-autotransform.0: transform
118 URxvt.selection-autotransform.1: transform 199 URxvt.selection-autotransform.1: transform
119 ... 200 ...
120 201
121For example, the following will transform selections of the form 202For example, the following will transform selections of the form
122C<word:number> into C<vi +$number $word>: 203C<filename:number>, often seen in compiler messages, into C<vi +$filename
204$word>:
123 205
124 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/vi +$2 $1\\x0d/ 206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
125 207
126And 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
127paste directory into your (vi :) editor: 209paste directly into your (vi :) editor:
128 210
129 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e $1\\x0d:$2\\x0d/ 211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
130 212
131=item mark-urls 213Of course, this can be modified to suit your needs and your editor :)
132 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
133Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
134make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
135resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
136the 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).
137 307
138=item block-graphics-to-ascii 308=item block-graphics-to-ascii
139 309
140A 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
141by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
142similar-looking ascii character. 312similar-looking ascii character.
143 313
144=item digital-clock 314=item digital-clock
145 315
146Displays 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.
147 371
148=item example-refresh-hooks 372=item example-refresh-hooks
149 373
150Displays 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
151window. Illustrates overwriting the refresh callbacks to create your own 375window. Illustrates overwriting the refresh callbacks to create your own
191 415
192=back 416=back
193 417
194=head2 Extension Objects 418=head2 Extension Objects
195 419
196Very 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
197for 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,
198hooks. 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
199about 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
200begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
201use. 426internal use.
202 427
203Although 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
204C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
205 430
206It has the following methods and data members: 431It has the following methods and data members:
227=head2 Hooks 452=head2 Hooks
228 453
229The following subroutines can be declared in extension files, and will be 454The following subroutines can be declared in extension files, and will be
230called whenever the relevant event happens. 455called whenever the relevant event happens.
231 456
232The 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
233the in the C<Extension Objects> section. 458the in the C<Extension Objects> section.
234 459
235B<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
236event 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
237skipped, and the relevant action might not be carried out by the C++ code. 462relevant action might not be carried out by the C++ code.
238 463
239I<< When in doubt, return a false value (preferably C<()>). >> 464I<< When in doubt, return a false value (preferably C<()>). >>
240 465
241=over 4 466=over 4
242 467
243=item on_init $term 468=item on_init $term
244 469
245Called after a new terminal object has been initialized, but before 470Called after a new terminal object has been initialized, but before
246windows 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
247call or deliver senseless data, as terminal size and other characteristics 472call or deliver senseless data, as terminal size and other characteristics
248have not yet been determined. You can safely query and change resources, 473have not yet been determined. You can safely query and change resources
249though. 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).
250 486
251=item on_reset $term 487=item on_reset $term
252 488
253Called 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
254control 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
255variables. 491variables.
256 492
257=item on_start $term 493=item on_child_start $term, $pid
258 494
259Called at the very end of initialisation of a new terminal, just before 495Called just after the child process has been C<fork>ed.
260returning 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>.
261 501
262=item on_sel_make $term, $eventtime 502=item on_sel_make $term, $eventtime
263 503
264Called 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
265selection 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
272 512
273Called whenever a selection has been copied, but before the selection is 513Called whenever a selection has been copied, but before the selection is
274requested from the server. The selection text can be queried and changed 514requested from the server. The selection text can be queried and changed
275by calling C<< $term->selection >>. 515by calling C<< $term->selection >>.
276 516
277Returning a true value aborts selection grabbing. It will still be hilighted. 517Returning a true value aborts selection grabbing. It will still be highlighted.
278 518
279=item on_sel_extend $term 519=item on_sel_extend $term
280 520
281Called 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
282click) and is either supposed to return false (normal operation), or 522click) and is either supposed to return false (normal operation), or
283should 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
284processing. This can happen multiple times, as long as the callback 524processing. This can happen multiple times, as long as the callback
285returns 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
286supposed to enlarge the selection more and more, if possible. 526supposed to enlarge the selection more and more, if possible.
287 527
288See the F<selection> example extension. 528See the F<selection> example extension.
289 529
290=item on_view_change $term, $offset 530=item on_view_change $term, $offset
291 531
292Called whenever the view offset changes, i..e the user or program 532Called whenever the view offset changes, i.e. the user or program
293scrolls. Offset C<0> means display the normal terminal, positive values 533scrolls. Offset C<0> means display the normal terminal, positive values
294show this many lines of scrollback. 534show this many lines of scrollback.
295 535
296=item on_scroll_back $term, $lines, $saved 536=item on_scroll_back $term, $lines, $saved
297 537
301 541
302It 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,
303$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
304number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
305 545
546=item on_osc_seq $term, $op, $args
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
306=item on_osc_seq $term, $string 556=item on_osc_seq_perl $term, $string
307 557
308Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
309operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
310information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
311string should start with the extension name and a colon, to distinguish 561string should start with the extension name and a colon, to distinguish
312it from commands for other extensions, and this might be enforced in the 562it from commands for other extensions, and this might be enforced in the
313future. 563future.
314 564
315Be careful not ever to trust (in a security sense) the data you receive, 565Be careful not ever to trust (in a security sense) the data you receive,
316as its source can not easily be controleld (e-mail content, messages from 566as its source can not easily be controlled (e-mail content, messages from
317other users on the same system etc.). 567other users on the same system etc.).
318 568
319=item on_add_lines $term, $string 569=item on_add_lines $term, $string
320 570
321Called whenever text is about to be output, with the text as argument. You 571Called whenever text is about to be output, with the text as argument. You
352 602
353=item on_refresh_end $term 603=item on_refresh_end $term
354 604
355Called just after the screen gets redrawn. See C<on_refresh_begin>. 605Called just after the screen gets redrawn. See C<on_refresh_begin>.
356 606
357=item on_keyboard_command $term, $string 607=item on_user_command $term, $string
358 608
359Called whenever the user presses a key combination that has a 609Called whenever a user-configured event is being activated (e.g. via
360C<perl:string> action bound to it (see description of the B<keysym> 610a C<perl:string> action bound to a key, see description of the B<keysym>
361resource in the @@RXVT_NAME@@(1) manpage). 611resource in the @@RXVT_NAME@@(1) manpage).
612
613The event is simply the action string. This interface is assumed to change
614slightly in the future.
615
616=item on_resize_all_windows $tern, $new_width, $new_height
617
618Called just after the new window size has been calculated, but before
619windows are actually being resized or hints are being set. If this hook
620returns TRUE, setting of the window hints is being skipped.
621
622=item on_x_event $term, $event
623
624Called on every X event received on the vt window (and possibly other
625windows). Should only be used as a last resort. Most event structure
626members are not passed.
627
628=item on_root_event $term, $event
629
630Like C<on_x_event>, but is called for events on the root window.
362 631
363=item on_focus_in $term 632=item on_focus_in $term
364 633
365Called whenever the window gets the keyboard focus, before rxvt-unicode 634Called whenever the window gets the keyboard focus, before rxvt-unicode
366does focus in processing. 635does focus in processing.
367 636
368=item on_focus_out $term 637=item on_focus_out $term
369 638
370Called wheneever the window loses keyboard focus, before rxvt-unicode does 639Called whenever the window loses keyboard focus, before rxvt-unicode does
371focus out processing. 640focus out processing.
641
642=item on_configure_notify $term, $event
643
644=item on_property_notify $term, $event
372 645
373=item on_key_press $term, $event, $keysym, $octets 646=item on_key_press $term, $event, $keysym, $octets
374 647
375=item on_key_release $term, $event, $keysym 648=item on_key_release $term, $event, $keysym
376 649
386 659
387Called whenever the corresponding X event is received for the terminal If 660Called whenever the corresponding X event is received for the terminal If
388the hook returns true, then the even will be ignored by rxvt-unicode. 661the hook returns true, then the even will be ignored by rxvt-unicode.
389 662
390The event is a hash with most values as named by Xlib (see the XEvent 663The event is a hash with most values as named by Xlib (see the XEvent
391manpage), with the additional members C<row> and C<col>, which are the row 664manpage), with the additional members C<row> and C<col>, which are the
392and column under the mouse cursor. 665(real, not screen-based) row and column under the mouse cursor.
393 666
394C<on_key_press> additionally receives the string rxvt-unicode would 667C<on_key_press> additionally receives the string rxvt-unicode would
395output, if any, in locale-specific encoding. 668output, if any, in locale-specific encoding.
396 669
397subwindow. 670subwindow.
671
672=item on_client_message $term, $event
673
674=item on_wm_protocols $term, $event
675
676=item on_wm_delete_window $term, $event
677
678Called when various types of ClientMessage events are received (all with
679format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
398 680
399=back 681=back
400 682
401=cut 683=cut
402 684
408use Scalar::Util (); 690use Scalar::Util ();
409use List::Util (); 691use List::Util ();
410 692
411our $VERSION = 1; 693our $VERSION = 1;
412our $TERM; 694our $TERM;
695our @TERM_INIT;
696our @TERM_EXT;
413our @HOOKNAME; 697our @HOOKNAME;
414our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 698our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
415our %OPTION; 699our %OPTION;
416 700
417our $LIBDIR; 701our $LIBDIR;
418our $RESNAME; 702our $RESNAME;
419our $RESCLASS; 703our $RESCLASS;
420our $RXVTNAME; 704our $RXVTNAME;
421 705
706our $NOCHAR = chr 0xffff;
707
422=head2 Variables in the C<urxvt> Package 708=head2 Variables in the C<urxvt> Package
423 709
424=over 4 710=over 4
425 711
426=item $urxvt::LIBDIR 712=item $urxvt::LIBDIR
438 724
439=item $urxvt::TERM 725=item $urxvt::TERM
440 726
441The current terminal. This variable stores the current C<urxvt::term> 727The current terminal. This variable stores the current C<urxvt::term>
442object, whenever a callback/hook is executing. 728object, whenever a callback/hook is executing.
729
730=item @urxvt::TERM_INIT
731
732All code references in this array will be called as methods of the next newly
733created C<urxvt::term> object (during the C<on_init> phase). The array
734gets cleared before the code references that were in it are being executed,
735so references can push themselves onto it again if they so desire.
736
737This complements to the perl-eval command line option, but gets executed
738first.
739
740=item @urxvt::TERM_EXT
741
742Works similar to C<@TERM_INIT>, but contains perl package/class names, which
743get registered as normal extensions after calling the hooks in C<@TERM_INIT>
744but before other extensions. Gets cleared just like C<@TERM_INIT>.
443 745
444=back 746=back
445 747
446=head2 Functions in the C<urxvt> Package 748=head2 Functions in the C<urxvt> Package
447 749
462Using this function has the advantage that its output ends up in the 764Using this function has the advantage that its output ends up in the
463correct place, e.g. on stderr of the connecting urxvtc client. 765correct place, e.g. on stderr of the connecting urxvtc client.
464 766
465Messages have a size limit of 1023 bytes currently. 767Messages have a size limit of 1023 bytes currently.
466 768
467=item $is_safe = urxvt::safe 769=item @terms = urxvt::termlist
468 770
469Returns true when it is safe to do potentially unsafe things, such as 771Returns all urxvt::term objects that exist in this process, regardless of
470evaluating perl code specified by the user. This is true when urxvt was 772whether they are started, being destroyed etc., so be careful. Only term
471started setuid or setgid. 773objects that have perl extensions attached will be returned (because there
774is no urxvt::term objet associated with others).
472 775
473=item $time = urxvt::NOW 776=item $time = urxvt::NOW
474 777
475Returns the "current time" (as per the event loop). 778Returns the "current time" (as per the event loop).
476 779
477=item urxvt::CurrentTime 780=item urxvt::CurrentTime
478 781
479=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 782=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
480Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 783Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
481Button4Mask, Button5Mask, AnyModifier 784Button4Mask, Button5Mask, AnyModifier
785
786=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
787ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
788PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
789Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
790KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
791ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
792FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
793
794=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
795EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
796GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
797UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
798ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
799CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
800SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
482 801
483Various constants for use in X calls and event processing. 802Various constants for use in X calls and event processing.
484 803
485=back 804=back
486 805
519 838
520=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 839=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
521 840
522=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 841=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
523 842
843=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
844
524Replace the foreground/background colour in the rendition mask with the 845Replace the foreground/background colour in the rendition mask with the
525specified one. 846specified one.
526 847
527=item $value = urxvt::GET_CUSTOM $rend 848=item $value = urxvt::GET_CUSTOM $rend
528 849
537=back 858=back
538 859
539=cut 860=cut
540 861
541BEGIN { 862BEGIN {
542 urxvt->bootstrap;
543
544 # overwrite perl's warn 863 # overwrite perl's warn
545 *CORE::GLOBAL::warn = sub { 864 *CORE::GLOBAL::warn = sub {
546 my $msg = join "", @_; 865 my $msg = join "", @_;
547 $msg .= "\n" 866 $msg .= "\n"
548 unless $msg =~ /\n$/; 867 unless $msg =~ /\n$/;
549 urxvt::warn ($msg); 868 urxvt::warn ($msg);
550 }; 869 };
551
552 # %ENV is the original startup environment
553 delete $ENV{IFS};
554 delete $ENV{CDPATH};
555 delete $ENV{BASH_ENV};
556 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
557} 870}
558 871
559my @hook_count; 872no warnings 'utf8';
873
560my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 874my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
561 875
562sub verbose { 876sub verbose {
563 my ($level, $msg) = @_; 877 my ($level, $msg) = @_;
564 warn "$msg\n" if $level <= $verbosity; 878 warn "$msg\n" if $level <= $verbosity;
565} 879}
566 880
567my $extension_pkg = "extension0000";
568my %extension_pkg; 881my %extension_pkg;
569 882
570# load a single script into its own package, once only 883# load a single script into its own package, once only
571sub extension_package($) { 884sub extension_package($) {
572 my ($path) = @_; 885 my ($path) = @_;
573 886
574 $extension_pkg{$path} ||= do { 887 $extension_pkg{$path} ||= do {
575 my $pkg = "urxvt::" . ($extension_pkg++); 888 $path =~ /([^\/\\]+)$/;
889 my $pkg = $1;
890 $pkg =~ s/[^[:word:]]/_/g;
891 $pkg = "urxvt::ext::$pkg";
576 892
577 verbose 3, "loading extension '$path' into package '$pkg'"; 893 verbose 3, "loading extension '$path' into package '$pkg'";
578 894
579 open my $fh, "<:raw", $path 895 open my $fh, "<:raw", $path
580 or die "$path: $!"; 896 or die "$path: $!";
581 897
582 my $source = untaint 898 my $source =
583 "package $pkg; use strict; use utf8;\n" 899 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
584 . "use base urxvt::term::extension::;\n"
585 . "#line 1 \"$path\"\n{\n" 900 . "#line 1 \"$path\"\n{\n"
586 . (do { local $/; <$fh> }) 901 . (do { local $/; <$fh> })
587 . "\n};\n1"; 902 . "\n};\n1";
588 903
589 eval $source 904 eval $source
600 local $TERM = shift; 915 local $TERM = shift;
601 my $htype = shift; 916 my $htype = shift;
602 917
603 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
604 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
605 920
606 my %ext_arg; 921 my %ext_arg;
607 922
923 {
924 my @init = @TERM_INIT;
925 @TERM_INIT = ();
926 $_->($TERM) for @init;
927 my @pkg = @TERM_EXT;
928 @TERM_EXT = ();
929 $TERM->register_package ($_) for @pkg;
930 }
931
608 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 932 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
609 if ($_ eq "default") { 933 if ($_ eq "default") {
610 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 934 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
611 } elsif (/^-(.*)$/) { 935 } elsif (/^-(.*)$/) {
612 delete $ext_arg{$1}; 936 delete $ext_arg{$1};
613 } elsif (/^([^<]+)<(.*)>$/) { 937 } elsif (/^([^<]+)<(.*)>$/) {
614 push @{ $ext_arg{$1} }, $2; 938 push @{ $ext_arg{$1} }, $2;
615 } else { 939 } else {
616 $ext_arg{$_} ||= []; 940 $ext_arg{$_} ||= [];
617 } 941 }
618 } 942 }
619 943
620 while (my ($ext, $argv) = each %ext_arg) { 944 for my $ext (sort keys %ext_arg) {
621 my @files = grep -f $_, map "$_/$ext", @dirs; 945 my @files = grep -f $_, map "$_/$ext", @dirs;
622 946
623 if (@files) { 947 if (@files) {
624 $TERM->register_package (extension_package $files[0], $argv); 948 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
625 } else { 949 } else {
626 warn "perl extension '$ext' not found in perl library search path\n"; 950 warn "perl extension '$ext' not found in perl library search path\n";
627 } 951 }
628 } 952 }
629 953
635 959
636 if (my $cb = $TERM->{_hook}[$htype]) { 960 if (my $cb = $TERM->{_hook}[$htype]) {
637 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 961 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
638 if $verbosity >= 10; 962 if $verbosity >= 10;
639 963
640 keys %$cb; 964 for my $pkg (keys %$cb) {
641
642 while (my ($pkg, $cb) = each %$cb) {
643 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 965 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
644 and last; 966 $retval ||= $retval_;
645 967
646 if ($@) { 968 if ($@) {
647 $TERM->ungrab; # better to lose the grab than the session 969 $TERM->ungrab; # better to lose the grab than the session
648 warn $@; 970 warn $@;
649 } 971 }
652 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 974 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
653 if $verbosity >= 11; 975 if $verbosity >= 11;
654 } 976 }
655 977
656 if ($htype == 1) { # DESTROY 978 if ($htype == 1) { # DESTROY
657 if (my $hook = delete $TERM->{_hook}) {
658 for my $htype (0..$#$hook) {
659 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
660 or set_should_invoke $htype, 0;
661 }
662 }
663
664 # clear package objects 979 # clear package objects
665 %$_ = () for values %{ $TERM->{_pkg} }; 980 %$_ = () for values %{ $TERM->{_pkg} };
666 981
667 # clear package 982 # clear package
668 %$TERM = (); 983 %$TERM = ();
669 } 984 }
670 985
671 $retval 986 $retval
672} 987}
673 988
674sub exec_async(@) { 989sub SET_COLOR($$$) {
675 my $pid = fork; 990 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
991}
676 992
677 return 993sub rend2mask {
678 if !defined $pid or $pid; 994 no strict 'refs';
679 995 my ($str, $mask) = (@_, 0);
680 %ENV = %{ $TERM->env }; 996 my %color = ( fg => undef, bg => undef );
681 997 my @failed;
682 exec @_; 998 for my $spec ( split /\s+/, $str ) {
683 _exit 255; 999 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1000 $color{lc($1)} = $2;
1001 } else {
1002 my $neg = $spec =~ s/^[-^]//;
1003 unless ( exists &{"RS_$spec"} ) {
1004 push @failed, $spec;
1005 next;
1006 }
1007 my $cur = &{"RS_$spec"};
1008 if ( $neg ) {
1009 $mask &= ~$cur;
1010 } else {
1011 $mask |= $cur;
1012 }
1013 }
1014 }
1015 ($mask, @color{qw(fg bg)}, \@failed)
684} 1016}
685 1017
686# urxvt::term::extension 1018# urxvt::term::extension
687 1019
688package urxvt::term::extension; 1020package urxvt::term::extension;
694 while (my ($name, $cb) = each %hook) { 1026 while (my ($name, $cb) = each %hook) {
695 my $htype = $HOOKTYPE{uc $name}; 1027 my $htype = $HOOKTYPE{uc $name};
696 defined $htype 1028 defined $htype
697 or Carp::croak "unsupported hook type '$name'"; 1029 or Carp::croak "unsupported hook type '$name'";
698 1030
1031 $self->set_should_invoke ($htype, +1)
699 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 1032 unless exists $self->{term}{_hook}[$htype]{$pkg};
700 $hook_count[$htype]++
701 or urxvt::set_should_invoke $htype, 1;
702 }
703 1033
704 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1034 $self->{term}{_hook}[$htype]{$pkg} = $cb;
705 } 1035 }
706} 1036}
707 1037
712 for my $name (@hook) { 1042 for my $name (@hook) {
713 my $htype = $HOOKTYPE{uc $name}; 1043 my $htype = $HOOKTYPE{uc $name};
714 defined $htype 1044 defined $htype
715 or Carp::croak "unsupported hook type '$name'"; 1045 or Carp::croak "unsupported hook type '$name'";
716 1046
1047 $self->set_should_invoke ($htype, -1)
717 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 1048 if delete $self->{term}{_hook}[$htype]{$pkg};
718 --$hook_count[$htype]
719 or urxvt::set_should_invoke $htype, 0;
720 }
721 } 1049 }
722} 1050}
723 1051
724our $AUTOLOAD; 1052our $AUTOLOAD;
725 1053
805sub DESTROY { 1133sub DESTROY {
806 $_[0][1]->stop; 1134 $_[0][1]->stop;
807} 1135}
808 1136
809sub condvar { 1137sub condvar {
810 bless \my $flag, urxvt::anyevent::condvar:: 1138 bless \my $flag, urxvt::anyevent::
811} 1139}
812 1140
813sub urxvt::anyevent::condvar::broadcast { 1141sub broadcast {
814 ${$_[0]}++; 1142 ${$_[0]}++;
815} 1143}
816 1144
817sub urxvt::anyevent::condvar::wait { 1145sub wait {
818 unless (${$_[0]}) { 1146 unless (${$_[0]}) {
819 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1147 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
820 } 1148 }
1149}
1150
1151sub one_event {
1152 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
821} 1153}
822 1154
823package urxvt::term; 1155package urxvt::term;
824 1156
825=head2 The C<urxvt::term> Class 1157=head2 The C<urxvt::term> Class
830 1162
831# find on_xxx subs in the package and register them 1163# find on_xxx subs in the package and register them
832# as hooks 1164# as hooks
833sub register_package { 1165sub register_package {
834 my ($self, $pkg, $argv) = @_; 1166 my ($self, $pkg, $argv) = @_;
1167
1168 no strict 'refs';
1169
1170 urxvt::verbose 6, "register package $pkg to $self";
1171
1172 @{"$pkg\::ISA"} = urxvt::term::extension::;
835 1173
836 my $proxy = bless { 1174 my $proxy = bless {
837 _pkg => $pkg, 1175 _pkg => $pkg,
838 argv => $argv, 1176 argv => $argv,
839 }, $pkg; 1177 }, $pkg;
855hash which defines the environment of the new terminal. 1193hash which defines the environment of the new terminal.
856 1194
857Croaks (and probably outputs an error message) if the new instance 1195Croaks (and probably outputs an error message) if the new instance
858couldn't be created. Returns C<undef> if the new instance didn't 1196couldn't be created. Returns C<undef> if the new instance didn't
859initialise perl, and the terminal object otherwise. The C<init> and 1197initialise perl, and the terminal object otherwise. The C<init> and
860C<start> hooks will be called during this call. 1198C<start> hooks will be called before this call returns, and are free to
1199refer to global data (which is race free).
861 1200
862=cut 1201=cut
863 1202
864sub new { 1203sub new {
865 my ($class, $env, @args) = @_; 1204 my ($class, $env, @args) = @_;
866 1205
1206 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1207 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1208
867 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1209 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
868} 1210}
869 1211
870=item $term->destroy 1212=item $term->destroy
871 1213
872Destroy the terminal object (close the window, free resources 1214Destroy the terminal object (close the window, free resources
873etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1215etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
874watchers (timers, io watchers) are still active. 1216watchers (timers, io watchers) are still active.
875 1217
1218=item $term->exec_async ($cmd[, @args])
1219
1220Works like the combination of the C<fork>/C<exec> builtins, which executes
1221("starts") programs in the background. This function takes care of setting
1222the user environment before exec'ing the command (e.g. C<PATH>) and should
1223be preferred over explicit calls to C<exec> or C<system>.
1224
1225Returns the pid of the subprocess or C<undef> on error.
1226
1227=cut
1228
1229sub exec_async {
1230 my $self = shift;
1231
1232 my $pid = fork;
1233
1234 return $pid
1235 if !defined $pid or $pid;
1236
1237 %ENV = %{ $self->env };
1238
1239 exec @_;
1240 urxvt::_exit 255;
1241}
1242
876=item $isset = $term->option ($optval[, $set]) 1243=item $isset = $term->option ($optval[, $set])
877 1244
878Returns true if the option specified by C<$optval> is enabled, and 1245Returns true if the option specified by C<$optval> is enabled, and
879optionally change it. All option values are stored by name in the hash 1246optionally change it. All option values are stored by name in the hash
880C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1247C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
881 1248
882Here is a a likely non-exhaustive list of option names, please see the 1249Here is a likely non-exhaustive list of option names, please see the
883source file F</src/optinc.h> to see the actual list: 1250source file F</src/optinc.h> to see the actual list:
884 1251
885 borderLess console cursorBlink cursorUnderline hold iconic insecure 1252 borderLess console cursorBlink cursorUnderline hold iconic insecure
886 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1253 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
887 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1254 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
888 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1255 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
889 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1256 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
890 tripleclickwords utmpInhibit visualBell 1257 transparent tripleclickwords utmpInhibit visualBell
891 1258
892=item $value = $term->resource ($name[, $newval]) 1259=item $value = $term->resource ($name[, $newval])
893 1260
894Returns the current resource value associated with a given name and 1261Returns the current resource value associated with a given name and
895optionally sets a new value. Setting values is most useful in the C<init> 1262optionally sets a new value. Setting values is most useful in the C<init>
904likely change). 1271likely change).
905 1272
906Please note that resource strings will currently only be freed when the 1273Please note that resource strings will currently only be freed when the
907terminal is destroyed, so changing options frequently will eat memory. 1274terminal is destroyed, so changing options frequently will eat memory.
908 1275
909Here is a a likely non-exhaustive list of resource names, not all of which 1276Here is a likely non-exhaustive list of resource names, not all of which
910are supported in every build, please see the source file F</src/rsinc.h> 1277are supported in every build, please see the source file F</src/rsinc.h>
911to see the actual list: 1278to see the actual list:
912 1279
913 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1280 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
914 borderLess color cursorBlink cursorUnderline cutchars delete_key 1281 borderLess color cursorBlink cursorUnderline cutchars delete_key
915 display_name embed ext_bwidth fade font geometry hold iconName 1282 display_name embed ext_bwidth fade font geometry hold iconName
916 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1283 imFont imLocale inputMethod insecure int_bwidth intensityStyles
917 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1284 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
918 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1285 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
919 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1286 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
920 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1287 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
921 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1288 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
922 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1289 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
923 shade term_name title transparent transparent_all tripleclickwords 1290 secondaryScreen secondaryScroll selectstyle shade term_name title
924 utmpInhibit visualBell 1291 transient_for transparent transparent_all tripleclickwords utmpInhibit
1292 visualBell
925 1293
926=cut 1294=cut
927 1295
928sub resource($$;$) { 1296sub resource($$;$) {
929 my ($self, $name) = (shift, shift); 1297 my ($self, $name) = (shift, shift);
1103 1471
1104Normally its not a good idea to use this function, as programs might be 1472Normally its not a good idea to use this function, as programs might be
1105confused by changes in cursor position or scrolling. Its useful inside a 1473confused by changes in cursor position or scrolling. Its useful inside a
1106C<on_add_lines> hook, though. 1474C<on_add_lines> hook, though.
1107 1475
1476=item $term->scr_change_screen ($screen)
1477
1478Switch to given screen - 0 primary, 1 secondary.
1479
1108=item $term->cmd_parse ($octets) 1480=item $term->cmd_parse ($octets)
1109 1481
1110Similar to C<scr_add_lines>, but the argument must be in the 1482Similar to C<scr_add_lines>, but the argument must be in the
1111locale-specific encoding of the terminal and can contain command sequences 1483locale-specific encoding of the terminal and can contain command sequences
1112(escape codes) that will be interpreted. 1484(escape codes) that will be interpreted.
1122Replaces the event mask of the pty watcher by the given event mask. Can 1494Replaces the event mask of the pty watcher by the given event mask. Can
1123be used to suppress input and output handling to the pty/tty. See the 1495be used to suppress input and output handling to the pty/tty. See the
1124description of C<< urxvt::timer->events >>. Make sure to always restore 1496description of C<< urxvt::timer->events >>. Make sure to always restore
1125the previous value. 1497the previous value.
1126 1498
1499=item $fd = $term->pty_fd
1500
1501Returns the master file descriptor for the pty in use, or C<-1> if no pty
1502is used.
1503
1127=item $windowid = $term->parent 1504=item $windowid = $term->parent
1128 1505
1129Return the window id of the toplevel window. 1506Return the window id of the toplevel window.
1130 1507
1131=item $windowid = $term->vt 1508=item $windowid = $term->vt
1132 1509
1133Return the window id of the terminal window. 1510Return the window id of the terminal window.
1134 1511
1512=item $term->vt_emask_add ($x_event_mask)
1513
1514Adds the specified events to the vt event mask. Useful e.g. when you want
1515to receive pointer events all the times:
1516
1517 $term->vt_emask_add (urxvt::PointerMotionMask);
1518
1519=item $term->focus_in
1520
1521=item $term->focus_out
1522
1523=item $term->key_press ($state, $keycode[, $time])
1524
1525=item $term->key_release ($state, $keycode[, $time])
1526
1527Deliver various fake events to to terminal.
1528
1135=item $window_width = $term->width 1529=item $window_width = $term->width
1136 1530
1137=item $window_height = $term->height 1531=item $window_height = $term->height
1138 1532
1139=item $font_width = $term->fwidth 1533=item $font_width = $term->fwidth
1152 1546
1153=item $max_scrollback = $term->saveLines 1547=item $max_scrollback = $term->saveLines
1154 1548
1155=item $nrow_plus_saveLines = $term->total_rows 1549=item $nrow_plus_saveLines = $term->total_rows
1156 1550
1157=item $lines_in_scrollback = $term->nsaved 1551=item $topmost_scrollback_row = $term->top_row
1158 1552
1159Return various integers describing terminal characteristics. 1553Return various integers describing terminal characteristics.
1160 1554
1161=item $x_display = $term->display_id 1555=item $x_display = $term->display_id
1162 1556
1169=item $env = $term->env 1563=item $env = $term->env
1170 1564
1171Returns a copy of the environment in effect for the terminal as a hashref 1565Returns a copy of the environment in effect for the terminal as a hashref
1172similar to C<\%ENV>. 1566similar to C<\%ENV>.
1173 1567
1568=item @envv = $term->envv
1569
1570Returns the environment as array of strings of the form C<VAR=VALUE>.
1571
1572=item @argv = $term->argv
1573
1574Return the argument vector as this terminal, similar to @ARGV, but
1575includes the program name as first element.
1576
1174=cut 1577=cut
1175 1578
1176sub env { 1579sub env {
1177 if (my $env = $_[0]->_env) {
1178 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1580 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1179 } else {
1180 +{ %ENV }
1181 }
1182} 1581}
1183 1582
1184=item $modifiermask = $term->ModLevel3Mask 1583=item $modifiermask = $term->ModLevel3Mask
1185 1584
1186=item $modifiermask = $term->ModMetaMask 1585=item $modifiermask = $term->ModMetaMask
1188=item $modifiermask = $term->ModNumLockMask 1587=item $modifiermask = $term->ModNumLockMask
1189 1588
1190Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1589Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1191AltGr), the meta key (often Alt) and the num lock key, if applicable. 1590AltGr), the meta key (often Alt) and the num lock key, if applicable.
1192 1591
1592=item $screen = $term->current_screen
1593
1594Returns the currently displayed screen (0 primary, 1 secondary).
1595
1596=item $cursor_is_hidden = $term->hidden_cursor
1597
1598Returns whether the cursor is currently hidden or not.
1599
1193=item $view_start = $term->view_start ([$newvalue]) 1600=item $view_start = $term->view_start ([$newvalue])
1194 1601
1195Returns the negative row number of the topmost line. Minimum value is 1602Returns the row number of the topmost displayed line. Maximum value is
1196C<0>, which displays the normal terminal contents. Larger values scroll 1603C<0>, which displays the normal terminal contents. Lower values scroll
1197this many lines into the scrollback buffer. 1604this many lines into the scrollback buffer.
1198 1605
1199=item $term->want_refresh 1606=item $term->want_refresh
1200 1607
1201Requests a screen refresh. At the next opportunity, rxvt-unicode will 1608Requests a screen refresh. At the next opportunity, rxvt-unicode will
1216line, starting at column C<$start_col> (default C<0>), which is useful 1623line, starting at column C<$start_col> (default C<0>), which is useful
1217to replace only parts of a line. The font index in the rendition will 1624to replace only parts of a line. The font index in the rendition will
1218automatically be updated. 1625automatically be updated.
1219 1626
1220C<$text> is in a special encoding: tabs and wide characters that use more 1627C<$text> is in a special encoding: tabs and wide characters that use more
1221than one cell when displayed are padded with urxvt::NOCHAR characters 1628than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1222(C<chr 65535>). Characters with combining characters and other characters 1629characters. Characters with combining characters and other characters that
1223that do not fit into the normal tetx encoding will be replaced with 1630do not fit into the normal text encoding will be replaced with characters
1224characters in the private use area. 1631in the private use area.
1225 1632
1226You have to obey this encoding when changing text. The advantage is 1633You have to obey this encoding when changing text. The advantage is
1227that C<substr> and similar functions work on screen cells and not on 1634that C<substr> and similar functions work on screen cells and not on
1228characters. 1635characters.
1229 1636
1373where one character corresponds to one screen cell. See 1780where one character corresponds to one screen cell. See
1374C<< $term->ROW_t >> for details. 1781C<< $term->ROW_t >> for details.
1375 1782
1376=item $string = $term->special_decode $text 1783=item $string = $term->special_decode $text
1377 1784
1378Converts rxvt-unicodes text reprsentation into a perl string. See 1785Converts rxvt-unicodes text representation into a perl string. See
1379C<< $term->ROW_t >> for details. 1786C<< $term->ROW_t >> for details.
1380 1787
1381=item $success = $term->grab_button ($button, $modifiermask) 1788=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1382 1789
1790=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1791
1383Registers a synchronous button grab. See the XGrabButton manpage. 1792Register/unregister a synchronous button grab. See the XGrabButton
1793manpage.
1384 1794
1385=item $success = $term->grab ($eventtime[, $sync]) 1795=item $success = $term->grab ($eventtime[, $sync])
1386 1796
1387Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1797Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1388synchronous (C<$sync> is true). Also remembers the grab timestampe. 1798synchronous (C<$sync> is true). Also remembers the grab timestamp.
1389 1799
1390=item $term->allow_events_async 1800=item $term->allow_events_async
1391 1801
1392Calls XAllowEvents with AsyncBoth for the most recent grab. 1802Calls XAllowEvents with AsyncBoth for the most recent grab.
1393 1803
1403=item $term->ungrab 1813=item $term->ungrab
1404 1814
1405Calls XUngrab for the most recent grab. Is called automatically on 1815Calls XUngrab for the most recent grab. Is called automatically on
1406evaluation errors, as it is better to lose the grab in the error case as 1816evaluation errors, as it is better to lose the grab in the error case as
1407the session. 1817the session.
1818
1819=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820
1821=item $atom_name = $term->XGetAtomName ($atom)
1822
1823=item @atoms = $term->XListProperties ($window)
1824
1825=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826
1827=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1828
1829=item $term->XDeleteProperty ($window, $property)
1830
1831=item $window = $term->DefaultRootWindow
1832
1833=item $term->XReparentWindow ($window, $parent, [$x, $y])
1834
1835=item $term->XMapWindow ($window)
1836
1837=item $term->XUnmapWindow ($window)
1838
1839=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1840
1841=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842
1843=item $term->XChangeInput ($window, $add_events[, $del_events])
1844
1845Various X or X-related functions. The C<$term> object only serves as
1846the source of the display, otherwise those functions map more-or-less
1847directory onto the X functions of the same name.
1408 1848
1409=back 1849=back
1410 1850
1411=cut 1851=cut
1412 1852
1476 my ($self, $text, $cb) = @_; 1916 my ($self, $text, $cb) = @_;
1477 1917
1478 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1918 $self->add_item ({ type => "button", text => $text, activate => $cb});
1479} 1919}
1480 1920
1481=item $popup->add_toggle ($text, $cb, $initial_value) 1921=item $popup->add_toggle ($text, $initial_value, $cb)
1482 1922
1483Adds a toggle/checkbox item to the popup. Teh callback gets called 1923Adds a toggle/checkbox item to the popup. The callback gets called
1484whenever it gets toggled, with a boolean indicating its value as its first 1924whenever it gets toggled, with a boolean indicating its new value as its
1485argument. 1925first argument.
1486 1926
1487=cut 1927=cut
1488 1928
1489sub add_toggle { 1929sub add_toggle {
1490 my ($self, $text, $cb, $value) = @_; 1930 my ($self, $text, $value, $cb) = @_;
1491 1931
1492 my $item; $item = { 1932 my $item; $item = {
1493 type => "button", 1933 type => "button",
1494 text => " $text", 1934 text => " $text",
1495 value => $value, 1935 value => $value,
1514 my $env = $self->{term}->env; 1954 my $env = $self->{term}->env;
1515 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1955 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1516 delete $env->{LC_ALL}; 1956 delete $env->{LC_ALL};
1517 $env->{LC_CTYPE} = $self->{term}->locale; 1957 $env->{LC_CTYPE} = $self->{term}->locale;
1518 1958
1519 urxvt::term->new ($env, $self->{term}->resource ("name"), 1959 urxvt::term->new ($env, "popup",
1520 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1960 "--perl-lib" => "", "--perl-ext-common" => "",
1961 "-pty-fd" => -1, "-sl" => 0,
1962 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1521 "--transient-for" => $self->{term}->parent, 1963 "--transient-for" => $self->{term}->parent,
1522 "-display" => $self->{term}->display_id, 1964 "-display" => $self->{term}->display_id,
1523 "-pe" => "urxvt-popup") 1965 "-pe" => "urxvt-popup")
1524 or die "unable to create popup window\n"; 1966 or die "unable to create popup window\n";
1525} 1967}
1530 delete $self->{term}{_destroy}{$self}; 1972 delete $self->{term}{_destroy}{$self};
1531 $self->{term}->ungrab; 1973 $self->{term}->ungrab;
1532} 1974}
1533 1975
1534=back 1976=back
1977
1978=cut
1979
1980package urxvt::watcher;
1535 1981
1536=head2 The C<urxvt::timer> Class 1982=head2 The C<urxvt::timer> Class
1537 1983
1538This class implements timer watchers/events. Time is represented as a 1984This class implements timer watchers/events. Time is represented as a
1539fractional number of seconds since the epoch. Example: 1985fractional number of seconds since the epoch. Example:
1543 ->new 1989 ->new
1544 ->interval (1) 1990 ->interval (1)
1545 ->cb (sub { 1991 ->cb (sub {
1546 $term->{overlay}->set (0, 0, 1992 $term->{overlay}->set (0, 0,
1547 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1993 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1548 }); 1994 });
1549 1995
1550=over 4 1996=over 4
1551 1997
1552=item $timer = new urxvt::timer 1998=item $timer = new urxvt::timer
1553 1999
1577Start the timer. 2023Start the timer.
1578 2024
1579=item $timer = $timer->start ($tstamp) 2025=item $timer = $timer->start ($tstamp)
1580 2026
1581Set the event trigger time to C<$tstamp> and start the timer. 2027Set the event trigger time to C<$tstamp> and start the timer.
2028
2029=item $timer = $timer->after ($delay)
2030
2031Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1582 2032
1583=item $timer = $timer->stop 2033=item $timer = $timer->stop
1584 2034
1585Stop the timer. 2035Stop the timer.
1586 2036
1592 2042
1593 $term->{socket} = ... 2043 $term->{socket} = ...
1594 $term->{iow} = urxvt::iow 2044 $term->{iow} = urxvt::iow
1595 ->new 2045 ->new
1596 ->fd (fileno $term->{socket}) 2046 ->fd (fileno $term->{socket})
1597 ->events (urxvt::EVENT_READ) 2047 ->events (urxvt::EV_READ)
1598 ->start 2048 ->start
1599 ->cb (sub { 2049 ->cb (sub {
1600 my ($iow, $revents) = @_; 2050 my ($iow, $revents) = @_;
1601 # $revents must be 1 here, no need to check 2051 # $revents must be 1 here, no need to check
1602 sysread $term->{socket}, my $buf, 8192 2052 sysread $term->{socket}, my $buf, 8192
1615Set the callback to be called when io events are triggered. C<$reventmask> 2065Set the callback to be called when io events are triggered. C<$reventmask>
1616is a bitset as described in the C<events> method. 2066is a bitset as described in the C<events> method.
1617 2067
1618=item $iow = $iow->fd ($fd) 2068=item $iow = $iow->fd ($fd)
1619 2069
1620Set the filedescriptor (not handle) to watch. 2070Set the file descriptor (not handle) to watch.
1621 2071
1622=item $iow = $iow->events ($eventmask) 2072=item $iow = $iow->events ($eventmask)
1623 2073
1624Set the event mask to watch. The only allowed values are 2074Set the event mask to watch. The only allowed values are
1625C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2075C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1626together, or C<urxvt::EVENT_NONE>. 2076together, or C<urxvt::EV_NONE>.
1627 2077
1628=item $iow = $iow->start 2078=item $iow = $iow->start
1629 2079
1630Start watching for requested events on the given handle. 2080Start watching for requested events on the given handle.
1631 2081
1632=item $iow = $iow->stop 2082=item $iow = $iow->stop
1633 2083
1634Stop watching for events on the given filehandle. 2084Stop watching for events on the given file handle.
2085
2086=back
2087
2088=head2 The C<urxvt::iw> Class
2089
2090This class implements idle watchers, that get called automatically when
2091the process is idle. They should return as fast as possible, after doing
2092some useful work.
2093
2094=over 4
2095
2096=item $iw = new urxvt::iw
2097
2098Create a new idle watcher object in stopped state.
2099
2100=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2101
2102Set the callback to be called when the watcher triggers.
2103
2104=item $timer = $timer->start
2105
2106Start the watcher.
2107
2108=item $timer = $timer->stop
2109
2110Stop the watcher.
2111
2112=back
2113
2114=head2 The C<urxvt::pw> Class
2115
2116This class implements process watchers. They create an event whenever a
2117process exits, after which they stop automatically.
2118
2119 my $pid = fork;
2120 ...
2121 $term->{pw} = urxvt::pw
2122 ->new
2123 ->start ($pid)
2124 ->cb (sub {
2125 my ($pw, $exit_status) = @_;
2126 ...
2127 });
2128
2129=over 4
2130
2131=item $pw = new urxvt::pw
2132
2133Create a new process watcher in stopped state.
2134
2135=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2136
2137Set the callback to be called when the timer triggers.
2138
2139=item $pw = $timer->start ($pid)
2140
2141Tells the watcher to start watching for process C<$pid>.
2142
2143=item $pw = $pw->stop
2144
2145Stop the watcher.
1635 2146
1636=back 2147=back
1637 2148
1638=head1 ENVIRONMENT 2149=head1 ENVIRONMENT
1639 2150
1648 2159
1649=item >= 3 - script loading and management 2160=item >= 3 - script loading and management
1650 2161
1651=item >=10 - all called hooks 2162=item >=10 - all called hooks
1652 2163
1653=item >=11 - hook reutrn values 2164=item >=11 - hook return values
1654 2165
1655=back 2166=back
1656 2167
1657=head1 AUTHOR 2168=head1 AUTHOR
1658 2169
1660 http://software.schmorp.de/pkg/rxvt-unicode 2171 http://software.schmorp.de/pkg/rxvt-unicode
1661 2172
1662=cut 2173=cut
1663 2174
16641 21751
2176
2177# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines