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.78 by root, Wed Jan 11 01:01:52 2006 UTC vs.
Revision 1.146 by root, Thu Aug 17 21:56:11 2006 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
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39 39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
44(More) intelligent selection. This extension tries to be more intelligent 48(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 49when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 50now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 51arguments, which is very convenient, too, if your F<ls> supports
52C<--quoting-style=shell>.
48 53
54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the following adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
79You can look at the source of the selection extension to see more
80interesting uses, such as parsing a line from beginning to end.
81
49It also offers the following bindable keyboard command: 82This extension also offers following bindable keyboard commands:
50 83
51=over 4 84=over 4
52 85
53=item rot13 86=item rot13
54 87
61=item option-popup (enabled by default) 94=item option-popup (enabled by default)
62 95
63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 97runtime.
65 98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
115
66=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
67 117
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
121
122Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed.
125
126It's sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>.
131
132The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any
134C<a>s:
135
136 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g }
138 : ()
139 };
71 140
72=item searchable-scrollback<hotkey> (enabled by default) 141=item searchable-scrollback<hotkey> (enabled by default)
73 142
74Adds regex search functionality to the scrollback buffer, triggered 143Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 144by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 145input/output is suspended and a regex is displayed at the bottom of the
146screen.
77 147
78C</> starts an incremental regex search, C<n> searches further, C<p> or 148Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 150search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 151bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary
154selection.
82 155
83=item digital-clock 156The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix.
84 159
85Displays a digital clock using the built-in overlay. 160See L<perlre> for more info about perl regular expression syntax.
161
162=item readline (enabled by default)
163
164A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to
166move the text cursor to this position. It does so by generating as many
167cursor-left or cursor-right keypresses as required (the this only works
168for programs that correctly support wide characters).
169
170To avoid too many false positives, this is only done when:
171
172=over 4
173
174=item - the tty is in ICANON state.
175
176=item - the text cursor is visible.
177
178=item - the primary screen is currently being displayed.
179
180=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182=back
183
184The normal selection mechanism isn't disabled, so quick successive clicks
185might interfere with selection creation in harmless ways.
186
187=item selection-autotransform
188
189This selection allows you to do automatic transforms on a selection
190whenever a selection is made.
191
192It works by specifying perl snippets (most useful is a single C<s///>
193operator) that modify C<$_> as resources:
194
195 URxvt.selection-autotransform.0: transform
196 URxvt.selection-autotransform.1: transform
197 ...
198
199For example, the following will transform selections of the form
200C<filename:number>, often seen in compiler messages, into C<vi +$filename
201$word>:
202
203 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205And this example matches the same,but replaces it with vi-commands you can
206paste directly into your (vi :) editor:
207
208 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210Of course, this can be modified to suit your needs and your editor :)
211
212To expand the example above to typical perl error messages ("XXX at
213FILENAME line YYY."), you need a slightly more elaborate solution:
214
215 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218The first line tells the selection code to treat the unchanging part of
219every error message as a selection pattern, and the second line transforms
220the message into vi commands to load the file.
221
222=item tabbed
223
224This transforms the terminal into a tabbar with additional terminals, that
225is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227button per tab.
228
229Clicking a button will activate that tab. Pressing B<Shift-Left> and
230B<Shift-Right> will switch to the tab left or right of the current one,
231while B<Shift-Down> creates a new tab.
232
233The tabbar itself can be configured similarly to a normal terminal, but
234with a resource class of C<URxvt.tabbed>. In addition, it supports the
235following four resources (shown with defaults):
236
237 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239 URxvt.tabbed.tab-fg: <colour-index, default 0>
240 URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices.
86 244
87=item mark-urls 245=item mark-urls
88 246
89Uses per-line display filtering (C<on_line_update>) to underline urls. 247Uses per-line display filtering (C<on_line_update>) to underline urls and
248make them clickable. When middle-clicked, the program specified in the
249resource C<urlLauncher> (default C<x-www-browser>) will be started with
250the URL as first argument.
251
252=item xim-onthespot
253
254This (experimental) perl extension implements OnTheSpot editing. It does
255not work perfectly, and some input methods don't seem to work well with
256OnTheSpot editing in general, but it seems to work at leats for SCIM and
257kinput2.
258
259You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.:
261
262 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
264=item kuake<hotkey>
265
266A very primitive quake-console-like extension. It was inspired by a
267description of how the programs C<kuake> and C<yakuake> work: Whenever the
268user presses a global accelerator key (by default C<F10>), the terminal
269will show or hide itself. Another press of the accelerator key will hide
270or show it again.
271
272Initially, the window will not be shown when using this extension.
273
274This is useful if you need a single terminal thats not using any desktop
275space most of the time but is quickly available at the press of a key.
276
277The accelerator key is grabbed regardless of any modifiers, so this
278extension will actually grab a physical key just for this function.
279
280If you want a quake-like animation, tell your window manager to do so
281(fvwm can do it).
282
283=item automove-background
284
285This is basically a very small extension that dynamically changes the
286background pixmap offset to the window position, in effect creating the
287same effect as pseudo transparency with a custom pixmap. No scaling is
288supported in this mode. Example:
289
290 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
90 291
91=item block-graphics-to-ascii 292=item block-graphics-to-ascii
92 293
93A not very useful example of filtering all text output to the terminal, 294A not very useful example of filtering all text output to the terminal
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 295by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 296similar-looking ascii character.
297
298=item digital-clock
299
300Displays a digital clock using the built-in overlay.
301
302=item remote-clipboard
303
304Somewhat of a misnomer, this extension adds two menu entries to the
305selection popup that allows one ti run external commands to store the
306selection somewhere and fetch it again.
307
308We use it to implement a "distributed selection mechanism", which just
309means that one command uploads the file to a remote server, and another
310reads it.
311
312The commands can be set using the C<URxvt.remote-selection.store> and
313C<URxvt.remote-selection.fetch> resources. The first should read the
314selection to store from STDIN (always in UTF-8), the second should provide
315the selection data on STDOUT (also in UTF-8).
316
317The defaults (which are likely useless to you) use rsh and cat:
318
319 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
320 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
321
322=item selection-pastebin
323
324This is a little rarely useful extension that Uploads the selection as
325textfile to a remote site (or does other things). (The implementation is
326not currently secure for use in a multiuser environment as it writes to
327F</tmp> directly.).
328
329It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
330i.e.
331
332 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
333
334Pressing this combination runs a command with C<%> replaced by the name of
335the textfile. This command can be set via a resource:
336
337 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
338
339And the default is likely not useful to anybody but the few people around
340here :)
341
342The name of the textfile is the hex encoded md5 sum of the selection, so
343the same content should lead to the same filename.
344
345After a successful upload the selection will be replaced by the text given
346in the C<selection-pastebin-url> resource (again, the % is the placeholder
347for the filename):
348
349 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
350
351I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
352the double C</> characters as comment start. Use C<\057\057> instead,
353which works regardless of wether xrdb is used to parse the resource file
354or not.
96 355
97=item example-refresh-hooks 356=item example-refresh-hooks
98 357
99Displays a very simple digital clock in the upper right corner of the 358Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 359window. Illustrates overwriting the refresh callbacks to create your own
140 399
141=back 400=back
142 401
143=head2 Extension Objects 402=head2 Extension Objects
144 403
145Very perl extension is a perl class. A separate perl object is created 404Every perl extension is a perl class. A separate perl object is created
146for each terminal and each extension and passed as the first parameter to 405for each terminal, and each terminal has its own set of extenion objects,
147hooks. So extensions can use their C<$self> object without having to think 406which are passed as the first parameter to hooks. So extensions can use
148about other extensions, with the exception of methods and members that 407their C<$self> object without having to think about clashes with other
408extensions or other terminals, with the exception of methods and members
149begin with an underscore character C<_>: these are reserved for internal 409that begin with an underscore character C<_>: these are reserved for
150use. 410internal use.
151 411
152Although it isn't a C<urxvt::term> object, you can call all methods of the 412Although it isn't a C<urxvt::term> object, you can call all methods of the
153C<urxvt::term> class on this object. 413C<urxvt::term> class on this object.
154 414
155It has the following methods and data members: 415It has the following methods and data members:
176=head2 Hooks 436=head2 Hooks
177 437
178The following subroutines can be declared in extension files, and will be 438The following subroutines can be declared in extension files, and will be
179called whenever the relevant event happens. 439called whenever the relevant event happens.
180 440
181The first argument passed to them is an extension oject as described in 441The first argument passed to them is an extension object as described in
182the in the C<Extension Objects> section. 442the in the C<Extension Objects> section.
183 443
184B<All> of these hooks must return a boolean value. If it is true, then the 444B<All> of these hooks must return a boolean value. If any of the called
185event counts as being I<consumed>, and the invocation of other hooks is 445hooks returns true, then the event counts as being I<consumed>, and the
186skipped, and the relevant action might not be carried out by the C++ code. 446relevant action might not be carried out by the C++ code.
187 447
188I<< When in doubt, return a false value (preferably C<()>). >> 448I<< When in doubt, return a false value (preferably C<()>). >>
189 449
190=over 4 450=over 4
191 451
192=item on_init $term 452=item on_init $term
193 453
194Called after a new terminal object has been initialized, but before 454Called after a new terminal object has been initialized, but before
195windows are created or the command gets run. Most methods are unsafe to 455windows are created or the command gets run. Most methods are unsafe to
196call or deliver senseless data, as terminal size and other characteristics 456call or deliver senseless data, as terminal size and other characteristics
197have not yet been determined. You can safely query and change resources, 457have not yet been determined. You can safely query and change resources
198though. 458and options, though. For many purposes the C<on_start> hook is a better
459place.
460
461=item on_start $term
462
463Called at the very end of initialisation of a new terminal, just before
464trying to map (display) the toplevel and returning to the main loop.
465
466=item on_destroy $term
467
468Called whenever something tries to destroy terminal, when the terminal is
469still fully functional (not for long, though).
199 470
200=item on_reset $term 471=item on_reset $term
201 472
202Called after the screen is "reset" for any reason, such as resizing or 473Called after the screen is "reset" for any reason, such as resizing or
203control sequences. Here is where you can react on changes to size-related 474control sequences. Here is where you can react on changes to size-related
204variables. 475variables.
205 476
206=item on_start $term 477=item on_child_start $term, $pid
207 478
208Called at the very end of initialisation of a new terminal, just before 479Called just after the child process has been C<fork>ed.
209returning to the mainloop. 480
481=item on_child_exit $term, $status
482
483Called just after the child process has exited. C<$status> is the status
484from C<waitpid>.
210 485
211=item on_sel_make $term, $eventtime 486=item on_sel_make $term, $eventtime
212 487
213Called whenever a selection has been made by the user, but before the 488Called whenever a selection has been made by the user, but before the
214selection text is copied, so changes to the beginning, end or type of the 489selection text is copied, so changes to the beginning, end or type of the
221 496
222Called whenever a selection has been copied, but before the selection is 497Called whenever a selection has been copied, but before the selection is
223requested from the server. The selection text can be queried and changed 498requested from the server. The selection text can be queried and changed
224by calling C<< $term->selection >>. 499by calling C<< $term->selection >>.
225 500
226Returning a true value aborts selection grabbing. It will still be hilighted. 501Returning a true value aborts selection grabbing. It will still be highlighted.
227 502
228=item on_sel_extend $term 503=item on_sel_extend $term
229 504
230Called whenever the user tries to extend the selection (e.g. with a double 505Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 506click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 507should extend the selection itself and return true to suppress the built-in
233processing. 508processing. This can happen multiple times, as long as the callback
509returns true, it will be called on every further click by the user and is
510supposed to enlarge the selection more and more, if possible.
234 511
235See the F<selection> example extension. 512See the F<selection> example extension.
236 513
237=item on_view_change $term, $offset 514=item on_view_change $term, $offset
238 515
239Called whenever the view offset changes, i..e the user or program 516Called whenever the view offset changes, i.e. the user or program
240scrolls. Offset C<0> means display the normal terminal, positive values 517scrolls. Offset C<0> means display the normal terminal, positive values
241show this many lines of scrollback. 518show this many lines of scrollback.
242 519
243=item on_scroll_back $term, $lines, $saved 520=item on_scroll_back $term, $lines, $saved
244 521
248 525
249It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 526It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 527$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251number of lines that will be in the scrollback buffer. 528number of lines that will be in the scrollback buffer.
252 529
530=item on_osc_seq $term, $op, $args
531
532Called on every OSC sequence and can be used to suppress it or modify its
533behaviour. The default should be to return an empty list. A true value
534suppresses execution of the request completely. Make sure you don't get
535confused by recursive invocations when you output an osc sequence within
536this callback.
537
538C<on_osc_seq_perl> should be used for new behaviour.
539
253=item on_osc_seq $term, $string 540=item on_osc_seq_perl $term, $string
254 541
255Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 542Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256operating system command) is processed. Cursor position and other state 543operating system command) is processed. Cursor position and other state
257information is up-to-date when this happens. For interoperability, the 544information is up-to-date when this happens. For interoperability, the
258string should start with the extension name and a colon, to distinguish 545string should start with the extension name and a colon, to distinguish
259it from commands for other extensions, and this might be enforced in the 546it from commands for other extensions, and this might be enforced in the
260future. 547future.
261 548
262Be careful not ever to trust (in a security sense) the data you receive, 549Be careful not ever to trust (in a security sense) the data you receive,
263as its source can not easily be controleld (e-mail content, messages from 550as its source can not easily be controlled (e-mail content, messages from
264other users on the same system etc.). 551other users on the same system etc.).
265 552
266=item on_add_lines $term, $string 553=item on_add_lines $term, $string
267 554
268Called whenever text is about to be output, with the text as argument. You 555Called whenever text is about to be output, with the text as argument. You
299 586
300=item on_refresh_end $term 587=item on_refresh_end $term
301 588
302Called just after the screen gets redrawn. See C<on_refresh_begin>. 589Called just after the screen gets redrawn. See C<on_refresh_begin>.
303 590
304=item on_keyboard_command $term, $string 591=item on_user_command $term, $string
305 592
306Called whenever the user presses a key combination that has a 593Called whenever a user-configured event is being activated (e.g. via
307C<perl:string> action bound to it (see description of the B<keysym> 594a C<perl:string> action bound to a key, see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 595resource in the @@RXVT_NAME@@(1) manpage).
596
597The event is simply the action string. This interface is assumed to change
598slightly in the future.
599
600=item on_resize_all_windows $tern, $new_width, $new_height
601
602Called just after the new window size has been calculated, but before
603windows are actually being resized or hints are being set. If this hook
604returns TRUE, setting of the window hints is being skipped.
605
606=item on_x_event $term, $event
607
608Called on every X event received on the vt window (and possibly other
609windows). Should only be used as a last resort. Most event structure
610members are not passed.
611
612=item on_root_event $term, $event
613
614Like C<on_x_event>, but is called for events on the root window.
309 615
310=item on_focus_in $term 616=item on_focus_in $term
311 617
312Called whenever the window gets the keyboard focus, before rxvt-unicode 618Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 619does focus in processing.
314 620
315=item on_focus_out $term 621=item on_focus_out $term
316 622
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 623Called whenever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 624focus out processing.
625
626=item on_configure_notify $term, $event
627
628=item on_property_notify $term, $event
319 629
320=item on_key_press $term, $event, $keysym, $octets 630=item on_key_press $term, $event, $keysym, $octets
321 631
322=item on_key_release $term, $event, $keysym 632=item on_key_release $term, $event, $keysym
323 633
333 643
334Called whenever the corresponding X event is received for the terminal If 644Called whenever the corresponding X event is received for the terminal If
335the hook returns true, then the even will be ignored by rxvt-unicode. 645the hook returns true, then the even will be ignored by rxvt-unicode.
336 646
337The event is a hash with most values as named by Xlib (see the XEvent 647The event is a hash with most values as named by Xlib (see the XEvent
338manpage), with the additional members C<row> and C<col>, which are the row 648manpage), with the additional members C<row> and C<col>, which are the
339and column under the mouse cursor. 649(real, not screen-based) row and column under the mouse cursor.
340 650
341C<on_key_press> additionally receives the string rxvt-unicode would 651C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 652output, if any, in locale-specific encoding.
343 653
344subwindow. 654subwindow.
655
656=item on_client_message $term, $event
657
658=item on_wm_protocols $term, $event
659
660=item on_wm_delete_window $term, $event
661
662Called when various types of ClientMessage events are received (all with
663format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
345 664
346=back 665=back
347 666
348=cut 667=cut
349 668
355use Scalar::Util (); 674use Scalar::Util ();
356use List::Util (); 675use List::Util ();
357 676
358our $VERSION = 1; 677our $VERSION = 1;
359our $TERM; 678our $TERM;
679our @TERM_INIT;
680our @TERM_EXT;
360our @HOOKNAME; 681our @HOOKNAME;
361our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 682our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
362our %OPTION; 683our %OPTION;
363 684
364our $LIBDIR; 685our $LIBDIR;
365our $RESNAME; 686our $RESNAME;
366our $RESCLASS; 687our $RESCLASS;
367our $RXVTNAME; 688our $RXVTNAME;
368 689
690our $NOCHAR = chr 0xffff;
691
369=head2 Variables in the C<urxvt> Package 692=head2 Variables in the C<urxvt> Package
370 693
371=over 4 694=over 4
372 695
373=item $urxvt::LIBDIR 696=item $urxvt::LIBDIR
385 708
386=item $urxvt::TERM 709=item $urxvt::TERM
387 710
388The current terminal. This variable stores the current C<urxvt::term> 711The current terminal. This variable stores the current C<urxvt::term>
389object, whenever a callback/hook is executing. 712object, whenever a callback/hook is executing.
713
714=item @urxvt::TERM_INIT
715
716All code references in this array will be called as methods of the next newly
717created C<urxvt::term> object (during the C<on_init> phase). The array
718gets cleared before the code references that were in it are being executed,
719so references can push themselves onto it again if they so desire.
720
721This complements to the perl-eval command line option, but gets executed
722first.
723
724=item @urxvt::TERM_EXT
725
726Works similar to C<@TERM_INIT>, but contains perl package/class names, which
727get registered as normal extensions after calling the hooks in C<@TERM_INIT>
728but before other extensions. Gets cleared just like C<@TERM_INIT>.
390 729
391=back 730=back
392 731
393=head2 Functions in the C<urxvt> Package 732=head2 Functions in the C<urxvt> Package
394 733
409Using this function has the advantage that its output ends up in the 748Using this function has the advantage that its output ends up in the
410correct place, e.g. on stderr of the connecting urxvtc client. 749correct place, e.g. on stderr of the connecting urxvtc client.
411 750
412Messages have a size limit of 1023 bytes currently. 751Messages have a size limit of 1023 bytes currently.
413 752
414=item $is_safe = urxvt::safe 753=item @terms = urxvt::termlist
415 754
416Returns true when it is safe to do potentially unsafe things, such as 755Returns all urxvt::term objects that exist in this process, regardless of
417evaluating perl code specified by the user. This is true when urxvt was 756whether they are started, being destroyed etc., so be careful. Only term
418started setuid or setgid. 757objects that have perl extensions attached will be returned (because there
758is no urxvt::term objet associated with others).
419 759
420=item $time = urxvt::NOW 760=item $time = urxvt::NOW
421 761
422Returns the "current time" (as per the event loop). 762Returns the "current time" (as per the event loop).
423 763
424=item urxvt::CurrentTime 764=item urxvt::CurrentTime
425 765
426=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 766=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
427Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 767Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
428Button4Mask, Button5Mask, AnyModifier 768Button4Mask, Button5Mask, AnyModifier
769
770=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
771ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
772PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
773Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
774KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
775ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
776FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
777
778=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
779EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
780GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
781UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
782ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
783CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
784SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
429 785
430Various constants for use in X calls and event processing. 786Various constants for use in X calls and event processing.
431 787
432=back 788=back
433 789
466 822
467=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 823=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
468 824
469=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 825=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
470 826
827=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
828
471Replace the foreground/background colour in the rendition mask with the 829Replace the foreground/background colour in the rendition mask with the
472specified one. 830specified one.
473 831
474=item $value = urxvt::GET_CUSTOM $rend 832=item $value = urxvt::GET_CUSTOM $rend
475 833
484=back 842=back
485 843
486=cut 844=cut
487 845
488BEGIN { 846BEGIN {
489 urxvt->bootstrap;
490
491 # overwrite perl's warn 847 # overwrite perl's warn
492 *CORE::GLOBAL::warn = sub { 848 *CORE::GLOBAL::warn = sub {
493 my $msg = join "", @_; 849 my $msg = join "", @_;
494 $msg .= "\n" 850 $msg .= "\n"
495 unless $msg =~ /\n$/; 851 unless $msg =~ /\n$/;
496 urxvt::warn ($msg); 852 urxvt::warn ($msg);
497 }; 853 };
498
499 delete $ENV{IFS};
500 delete $ENV{CDPATH};
501 delete $ENV{BASH_ENV};
502 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
503} 854}
504 855
505my @hook_count; 856no warnings 'utf8';
857
506my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 858my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
507 859
508sub verbose { 860sub verbose {
509 my ($level, $msg) = @_; 861 my ($level, $msg) = @_;
510 warn "$msg\n" if $level <= $verbosity; 862 warn "$msg\n" if $level <= $verbosity;
511} 863}
512 864
513my $extension_pkg = "extension0000";
514my %extension_pkg; 865my %extension_pkg;
515 866
516# load a single script into its own package, once only 867# load a single script into its own package, once only
517sub extension_package($) { 868sub extension_package($) {
518 my ($path) = @_; 869 my ($path) = @_;
519 870
520 $extension_pkg{$path} ||= do { 871 $extension_pkg{$path} ||= do {
521 my $pkg = "urxvt::" . ($extension_pkg++); 872 $path =~ /([^\/\\]+)$/;
873 my $pkg = $1;
874 $pkg =~ s/[^[:word:]]/_/g;
875 $pkg = "urxvt::ext::$pkg";
522 876
523 verbose 3, "loading extension '$path' into package '$pkg'"; 877 verbose 3, "loading extension '$path' into package '$pkg'";
524 878
525 open my $fh, "<:raw", $path 879 open my $fh, "<:raw", $path
526 or die "$path: $!"; 880 or die "$path: $!";
527 881
528 my $source = untaint 882 my $source =
529 "package $pkg; use strict; use utf8;\n" 883 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
530 . "use base urxvt::term::extension::;\n"
531 . "#line 1 \"$path\"\n{\n" 884 . "#line 1 \"$path\"\n{\n"
532 . (do { local $/; <$fh> }) 885 . (do { local $/; <$fh> })
533 . "\n};\n1"; 886 . "\n};\n1";
534 887
535 eval $source 888 eval $source
549 if ($htype == 0) { # INIT 902 if ($htype == 0) { # INIT
550 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 903 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
551 904
552 my %ext_arg; 905 my %ext_arg;
553 906
907 {
908 my @init = @TERM_INIT;
909 @TERM_INIT = ();
910 $_->($TERM) for @init;
911 my @pkg = @TERM_EXT;
912 @TERM_EXT = ();
913 $TERM->register_package ($_) for @pkg;
914 }
915
554 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 916 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
555 if ($_ eq "default") { 917 if ($_ eq "default") {
556 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 918 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
557 } elsif (/^-(.*)$/) { 919 } elsif (/^-(.*)$/) {
558 delete $ext_arg{$1}; 920 delete $ext_arg{$1};
559 } elsif (/^([^<]+)<(.*)>$/) { 921 } elsif (/^([^<]+)<(.*)>$/) {
560 push @{ $ext_arg{$1} }, $2; 922 push @{ $ext_arg{$1} }, $2;
561 } else { 923 } else {
562 $ext_arg{$_} ||= []; 924 $ext_arg{$_} ||= [];
563 } 925 }
564 } 926 }
565 927
566 while (my ($ext, $argv) = each %ext_arg) { 928 for my $ext (sort keys %ext_arg) {
567 my @files = grep -f $_, map "$_/$ext", @dirs; 929 my @files = grep -f $_, map "$_/$ext", @dirs;
568 930
569 if (@files) { 931 if (@files) {
570 $TERM->register_package (extension_package $files[0], $argv); 932 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
571 } else { 933 } else {
572 warn "perl extension '$ext' not found in perl library search path\n"; 934 warn "perl extension '$ext' not found in perl library search path\n";
573 } 935 }
574 } 936 }
575 937
581 943
582 if (my $cb = $TERM->{_hook}[$htype]) { 944 if (my $cb = $TERM->{_hook}[$htype]) {
583 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 945 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
584 if $verbosity >= 10; 946 if $verbosity >= 10;
585 947
586 keys %$cb; 948 for my $pkg (keys %$cb) {
587
588 while (my ($pkg, $cb) = each %$cb) {
589 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 949 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
590 and last; 950 $retval ||= $retval_;
591 951
592 if ($@) { 952 if ($@) {
593 $TERM->ungrab; # better to lose the grab than the session 953 $TERM->ungrab; # better to lose the grab than the session
594 warn $@; 954 warn $@;
595 } 955 }
596 } 956 }
957
958 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
959 if $verbosity >= 11;
597 } 960 }
598 961
599 if ($htype == 1) { # DESTROY 962 if ($htype == 1) { # DESTROY
600 if (my $hook = delete $TERM->{_hook}) {
601 for my $htype (0..$#$hook) {
602 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
603 or set_should_invoke $htype, 0;
604 }
605 }
606
607 # clear package objects 963 # clear package objects
608 %$_ = () for values %{ $TERM->{_pkg} }; 964 %$_ = () for values %{ $TERM->{_pkg} };
609 965
610 # clear package 966 # clear package
611 %$TERM = (); 967 %$TERM = ();
612 } 968 }
613 969
614 $retval 970 $retval
971}
972
973sub SET_COLOR($$$) {
974 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
615} 975}
616 976
617# urxvt::term::extension 977# urxvt::term::extension
618 978
619package urxvt::term::extension; 979package urxvt::term::extension;
625 while (my ($name, $cb) = each %hook) { 985 while (my ($name, $cb) = each %hook) {
626 my $htype = $HOOKTYPE{uc $name}; 986 my $htype = $HOOKTYPE{uc $name};
627 defined $htype 987 defined $htype
628 or Carp::croak "unsupported hook type '$name'"; 988 or Carp::croak "unsupported hook type '$name'";
629 989
990 $self->set_should_invoke ($htype, +1)
630 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 991 unless exists $self->{term}{_hook}[$htype]{$pkg};
631 $hook_count[$htype]++
632 or urxvt::set_should_invoke $htype, 1;
633 }
634 992
635 $self->{term}{_hook}[$htype]{$pkg} = $cb; 993 $self->{term}{_hook}[$htype]{$pkg} = $cb;
636 } 994 }
637} 995}
638 996
643 for my $name (@hook) { 1001 for my $name (@hook) {
644 my $htype = $HOOKTYPE{uc $name}; 1002 my $htype = $HOOKTYPE{uc $name};
645 defined $htype 1003 defined $htype
646 or Carp::croak "unsupported hook type '$name'"; 1004 or Carp::croak "unsupported hook type '$name'";
647 1005
1006 $self->set_should_invoke ($htype, -1)
648 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 1007 if delete $self->{term}{_hook}[$htype]{$pkg};
649 --$hook_count[$htype]
650 or urxvt::set_should_invoke $htype, 0;
651 }
652 } 1008 }
653} 1009}
654 1010
655our $AUTOLOAD; 1011our $AUTOLOAD;
656 1012
762# find on_xxx subs in the package and register them 1118# find on_xxx subs in the package and register them
763# as hooks 1119# as hooks
764sub register_package { 1120sub register_package {
765 my ($self, $pkg, $argv) = @_; 1121 my ($self, $pkg, $argv) = @_;
766 1122
1123 no strict 'refs';
1124
1125 urxvt::verbose 6, "register package $pkg to $self";
1126
1127 @{"$pkg\::ISA"} = urxvt::term::extension::;
1128
767 my $proxy = bless { 1129 my $proxy = bless {
768 _pkg => $pkg, 1130 _pkg => $pkg,
769 argv => $argv, 1131 argv => $argv,
770 }, $pkg; 1132 }, $pkg;
771 Scalar::Util::weaken ($proxy->{term} = $self); 1133 Scalar::Util::weaken ($proxy->{term} = $self);
786hash which defines the environment of the new terminal. 1148hash which defines the environment of the new terminal.
787 1149
788Croaks (and probably outputs an error message) if the new instance 1150Croaks (and probably outputs an error message) if the new instance
789couldn't be created. Returns C<undef> if the new instance didn't 1151couldn't be created. Returns C<undef> if the new instance didn't
790initialise perl, and the terminal object otherwise. The C<init> and 1152initialise perl, and the terminal object otherwise. The C<init> and
791C<start> hooks will be called during this call. 1153C<start> hooks will be called before this call returns, and are free to
1154refer to global data (which is race free).
792 1155
793=cut 1156=cut
794 1157
795sub new { 1158sub new {
796 my ($class, $env, @args) = @_; 1159 my ($class, $env, @args) = @_;
797 1160
1161 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1162 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1163
798 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1164 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
799} 1165}
800 1166
801=item $term->destroy 1167=item $term->destroy
802 1168
803Destroy the terminal object (close the window, free resources 1169Destroy the terminal object (close the window, free resources
804etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1170etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
805watchers (timers, io watchers) are still active. 1171watchers (timers, io watchers) are still active.
806 1172
1173=item $term->exec_async ($cmd[, @args])
1174
1175Works like the combination of the C<fork>/C<exec> builtins, which executes
1176("starts") programs in the background. This function takes care of setting
1177the user environment before exec'ing the command (e.g. C<PATH>) and should
1178be preferred over explicit calls to C<exec> or C<system>.
1179
1180Returns the pid of the subprocess or C<undef> on error.
1181
1182=cut
1183
1184sub exec_async {
1185 my $self = shift;
1186
1187 my $pid = fork;
1188
1189 return $pid
1190 if !defined $pid or $pid;
1191
1192 %ENV = %{ $self->env };
1193
1194 exec @_;
1195 urxvt::_exit 255;
1196}
1197
807=item $isset = $term->option ($optval[, $set]) 1198=item $isset = $term->option ($optval[, $set])
808 1199
809Returns true if the option specified by C<$optval> is enabled, and 1200Returns true if the option specified by C<$optval> is enabled, and
810optionally change it. All option values are stored by name in the hash 1201optionally change it. All option values are stored by name in the hash
811C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1202C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
812 1203
813Here is a a likely non-exhaustive list of option names, please see the 1204Here is a likely non-exhaustive list of option names, please see the
814source file F</src/optinc.h> to see the actual list: 1205source file F</src/optinc.h> to see the actual list:
815 1206
816 borderLess console cursorBlink cursorUnderline hold iconic insecure 1207 borderLess console cursorBlink cursorUnderline hold iconic insecure
817 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1208 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
818 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1209 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
819 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1210 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
820 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1211 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
821 tripleclickwords utmpInhibit visualBell 1212 transparent tripleclickwords utmpInhibit visualBell
822 1213
823=item $value = $term->resource ($name[, $newval]) 1214=item $value = $term->resource ($name[, $newval])
824 1215
825Returns the current resource value associated with a given name and 1216Returns the current resource value associated with a given name and
826optionally sets a new value. Setting values is most useful in the C<init> 1217optionally sets a new value. Setting values is most useful in the C<init>
835likely change). 1226likely change).
836 1227
837Please note that resource strings will currently only be freed when the 1228Please note that resource strings will currently only be freed when the
838terminal is destroyed, so changing options frequently will eat memory. 1229terminal is destroyed, so changing options frequently will eat memory.
839 1230
840Here is a a likely non-exhaustive list of resource names, not all of which 1231Here is a likely non-exhaustive list of resource names, not all of which
841are supported in every build, please see the source file F</src/rsinc.h> 1232are supported in every build, please see the source file F</src/rsinc.h>
842to see the actual list: 1233to see the actual list:
843 1234
844 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1235 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
845 borderLess color cursorBlink cursorUnderline cutchars delete_key 1236 borderLess color cursorBlink cursorUnderline cutchars delete_key
846 display_name embed ext_bwidth fade font geometry hold iconName 1237 display_name embed ext_bwidth fade font geometry hold iconName
847 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1238 imFont imLocale inputMethod insecure int_bwidth intensityStyles
848 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1239 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
849 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1240 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
850 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1241 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
851 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1242 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
852 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1243 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
853 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1244 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
854 shade term_name title transparent transparent_all tripleclickwords 1245 secondaryScreen secondaryScroll selectstyle shade term_name title
855 utmpInhibit visualBell 1246 transient_for transparent transparent_all tripleclickwords utmpInhibit
1247 visualBell
856 1248
857=cut 1249=cut
858 1250
859sub resource($$;$) { 1251sub resource($$;$) {
860 my ($self, $name) = (shift, shift); 1252 my ($self, $name) = (shift, shift);
861 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1253 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
862 &urxvt::term::_resource 1254 &urxvt::term::_resource
863} 1255}
864 1256
1257=item $value = $term->x_resource ($pattern)
1258
1259Returns the X-Resource for the given pattern, excluding the program or
1260class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1261same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1262resource with that pattern exists.
1263
1264This method should only be called during the C<on_start> hook, as there is
1265only one resource database per display, and later invocations might return
1266the wrong resources.
1267
865=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1268=item $success = $term->parse_keysym ($keysym_spec, $command_string)
866 1269
867Adds a keymap translation exactly as specified via a resource. See the 1270Adds a keymap translation exactly as specified via a resource. See the
868C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1271C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
869 1272
884=item ($row, $col) = $term->selection_end ([$row, $col]) 1287=item ($row, $col) = $term->selection_end ([$row, $col])
885 1288
886Return the current values of the selection mark, begin or end positions, 1289Return the current values of the selection mark, begin or end positions,
887and optionally set them to new values. 1290and optionally set them to new values.
888 1291
1292=item $term->selection_make ($eventtime[, $rectangular])
1293
1294Tries to make a selection as set by C<selection_beg> and
1295C<selection_end>. If C<$rectangular> is true (default: false), a
1296rectangular selection will be made. This is the prefered function to make
1297a selection.
1298
889=item $success = $term->selection_grab ($eventtime) 1299=item $success = $term->selection_grab ($eventtime)
890 1300
891Try to request the primary selection from the server (for example, as set 1301Try to request the primary selection text from the server (for example, as
892by the next method). 1302set by the next method). No visual feedback will be given. This function
1303is mostly useful from within C<on_sel_grab> hooks.
893 1304
894=item $oldtext = $term->selection ([$newtext]) 1305=item $oldtext = $term->selection ([$newtext])
895 1306
896Return the current selection text and optionally replace it by C<$newtext>. 1307Return the current selection text and optionally replace it by C<$newtext>.
897 1308
990Convert the given locale-encoded octets into a perl string. 1401Convert the given locale-encoded octets into a perl string.
991 1402
992=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1403=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
993 1404
994XORs the rendition values in the given span with the provided value 1405XORs the rendition values in the given span with the provided value
995(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1406(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
996to the selection. 1407refresh hooks to provide effects similar to the selection.
997 1408
998=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1409=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
999 1410
1000Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1411Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1001whitespace will additionally be xored with the C<$rstyle2>, which defaults 1412whitespace will additionally be xored with the C<$rstyle2>, which defaults
1002to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1413to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1003it instead. 1414it instead. Both styles I<MUST NOT> contain font styles.
1004 1415
1005=item $term->scr_bell 1416=item $term->scr_bell
1006 1417
1007Ring the bell! 1418Ring the bell!
1008 1419
1015 1426
1016Normally its not a good idea to use this function, as programs might be 1427Normally its not a good idea to use this function, as programs might be
1017confused by changes in cursor position or scrolling. Its useful inside a 1428confused by changes in cursor position or scrolling. Its useful inside a
1018C<on_add_lines> hook, though. 1429C<on_add_lines> hook, though.
1019 1430
1431=item $term->scr_change_screen ($screen)
1432
1433Switch to given screen - 0 primary, 1 secondary.
1434
1020=item $term->cmd_parse ($octets) 1435=item $term->cmd_parse ($octets)
1021 1436
1022Similar to C<scr_add_lines>, but the argument must be in the 1437Similar to C<scr_add_lines>, but the argument must be in the
1023locale-specific encoding of the terminal and can contain command sequences 1438locale-specific encoding of the terminal and can contain command sequences
1024(escape codes) that will be interpreted. 1439(escape codes) that will be interpreted.
1034Replaces the event mask of the pty watcher by the given event mask. Can 1449Replaces the event mask of the pty watcher by the given event mask. Can
1035be used to suppress input and output handling to the pty/tty. See the 1450be used to suppress input and output handling to the pty/tty. See the
1036description of C<< urxvt::timer->events >>. Make sure to always restore 1451description of C<< urxvt::timer->events >>. Make sure to always restore
1037the previous value. 1452the previous value.
1038 1453
1454=item $fd = $term->pty_fd
1455
1456Returns the master file descriptor for the pty in use, or C<-1> if no pty
1457is used.
1458
1039=item $windowid = $term->parent 1459=item $windowid = $term->parent
1040 1460
1041Return the window id of the toplevel window. 1461Return the window id of the toplevel window.
1042 1462
1043=item $windowid = $term->vt 1463=item $windowid = $term->vt
1044 1464
1045Return the window id of the terminal window. 1465Return the window id of the terminal window.
1046 1466
1467=item $term->vt_emask_add ($x_event_mask)
1468
1469Adds the specified events to the vt event mask. Useful e.g. when you want
1470to receive pointer events all the times:
1471
1472 $term->vt_emask_add (urxvt::PointerMotionMask);
1473
1474=item $term->focus_in
1475
1476=item $term->focus_out
1477
1478=item $term->key_press ($state, $keycode[, $time])
1479
1480=item $term->key_release ($state, $keycode[, $time])
1481
1482Deliver various fake events to to terminal.
1483
1047=item $window_width = $term->width 1484=item $window_width = $term->width
1048 1485
1049=item $window_height = $term->height 1486=item $window_height = $term->height
1050 1487
1051=item $font_width = $term->fwidth 1488=item $font_width = $term->fwidth
1064 1501
1065=item $max_scrollback = $term->saveLines 1502=item $max_scrollback = $term->saveLines
1066 1503
1067=item $nrow_plus_saveLines = $term->total_rows 1504=item $nrow_plus_saveLines = $term->total_rows
1068 1505
1069=item $lines_in_scrollback = $term->nsaved 1506=item $topmost_scrollback_row = $term->top_row
1070 1507
1071Return various integers describing terminal characteristics. 1508Return various integers describing terminal characteristics.
1072 1509
1073=item $x_display = $term->display_id 1510=item $x_display = $term->display_id
1074 1511
1081=item $env = $term->env 1518=item $env = $term->env
1082 1519
1083Returns a copy of the environment in effect for the terminal as a hashref 1520Returns a copy of the environment in effect for the terminal as a hashref
1084similar to C<\%ENV>. 1521similar to C<\%ENV>.
1085 1522
1523=item @envv = $term->envv
1524
1525Returns the environment as array of strings of the form C<VAR=VALUE>.
1526
1527=item @argv = $term->argv
1528
1529Return the argument vector as this terminal, similar to @ARGV, but
1530includes the program name as first element.
1531
1086=cut 1532=cut
1087 1533
1088sub env { 1534sub env {
1089 if (my $env = $_[0]->_env) {
1090 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1535 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1091 } else {
1092 +{ %ENV }
1093 }
1094} 1536}
1095 1537
1096=item $modifiermask = $term->ModLevel3Mask 1538=item $modifiermask = $term->ModLevel3Mask
1097 1539
1098=item $modifiermask = $term->ModMetaMask 1540=item $modifiermask = $term->ModMetaMask
1100=item $modifiermask = $term->ModNumLockMask 1542=item $modifiermask = $term->ModNumLockMask
1101 1543
1102Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1544Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1103AltGr), the meta key (often Alt) and the num lock key, if applicable. 1545AltGr), the meta key (often Alt) and the num lock key, if applicable.
1104 1546
1547=item $screen = $term->current_screen
1548
1549Returns the currently displayed screen (0 primary, 1 secondary).
1550
1551=item $cursor_is_hidden = $term->hidden_cursor
1552
1553Returns whether the cursor is currently hidden or not.
1554
1105=item $view_start = $term->view_start ([$newvalue]) 1555=item $view_start = $term->view_start ([$newvalue])
1106 1556
1107Returns the negative row number of the topmost line. Minimum value is 1557Returns the row number of the topmost displayed line. Maximum value is
1108C<0>, which displays the normal terminal contents. Larger values scroll 1558C<0>, which displays the normal terminal contents. Lower values scroll
1109this many lines into the scrollback buffer. 1559this many lines into the scrollback buffer.
1110 1560
1111=item $term->want_refresh 1561=item $term->want_refresh
1112 1562
1113Requests a screen refresh. At the next opportunity, rxvt-unicode will 1563Requests a screen refresh. At the next opportunity, rxvt-unicode will
1128line, starting at column C<$start_col> (default C<0>), which is useful 1578line, starting at column C<$start_col> (default C<0>), which is useful
1129to replace only parts of a line. The font index in the rendition will 1579to replace only parts of a line. The font index in the rendition will
1130automatically be updated. 1580automatically be updated.
1131 1581
1132C<$text> is in a special encoding: tabs and wide characters that use more 1582C<$text> is in a special encoding: tabs and wide characters that use more
1133than one cell when displayed are padded with urxvt::NOCHAR characters 1583than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1134(C<chr 65535>). Characters with combining characters and other characters 1584characters. Characters with combining characters and other characters that
1135that do not fit into the normal tetx encoding will be replaced with 1585do not fit into the normal tetx encoding will be replaced with characters
1136characters in the private use area. 1586in the private use area.
1137 1587
1138You have to obey this encoding when changing text. The advantage is 1588You have to obey this encoding when changing text. The advantage is
1139that C<substr> and similar functions work on screen cells and not on 1589that C<substr> and similar functions work on screen cells and not on
1140characters. 1590characters.
1141 1591
1192Return the row number of the first/last row of the line, respectively. 1642Return the row number of the first/last row of the line, respectively.
1193 1643
1194=item $offset = $line->offset_of ($row, $col) 1644=item $offset = $line->offset_of ($row, $col)
1195 1645
1196Returns the character offset of the given row|col pair within the logical 1646Returns the character offset of the given row|col pair within the logical
1197line. 1647line. Works for rows outside the line, too, and returns corresponding
1648offsets outside the string.
1198 1649
1199=item ($row, $col) = $line->coord_of ($offset) 1650=item ($row, $col) = $line->coord_of ($offset)
1200 1651
1201Translates a string offset into terminal coordinates again. 1652Translates a string offset into terminal coordinates again.
1202 1653
1284where one character corresponds to one screen cell. See 1735where one character corresponds to one screen cell. See
1285C<< $term->ROW_t >> for details. 1736C<< $term->ROW_t >> for details.
1286 1737
1287=item $string = $term->special_decode $text 1738=item $string = $term->special_decode $text
1288 1739
1289Converts rxvt-unicodes text reprsentation into a perl string. See 1740Converts rxvt-unicodes text representation into a perl string. See
1290C<< $term->ROW_t >> for details. 1741C<< $term->ROW_t >> for details.
1291 1742
1292=item $success = $term->grab_button ($button, $modifiermask) 1743=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1293 1744
1745=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1746
1294Registers a synchronous button grab. See the XGrabButton manpage. 1747Register/unregister a synchronous button grab. See the XGrabButton
1748manpage.
1295 1749
1296=item $success = $term->grab ($eventtime[, $sync]) 1750=item $success = $term->grab ($eventtime[, $sync])
1297 1751
1298Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1752Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1299synchronous (C<$sync> is true). Also remembers the grab timestampe. 1753synchronous (C<$sync> is true). Also remembers the grab timestamp.
1300 1754
1301=item $term->allow_events_async 1755=item $term->allow_events_async
1302 1756
1303Calls XAllowEvents with AsyncBoth for the most recent grab. 1757Calls XAllowEvents with AsyncBoth for the most recent grab.
1304 1758
1314=item $term->ungrab 1768=item $term->ungrab
1315 1769
1316Calls XUngrab for the most recent grab. Is called automatically on 1770Calls XUngrab for the most recent grab. Is called automatically on
1317evaluation errors, as it is better to lose the grab in the error case as 1771evaluation errors, as it is better to lose the grab in the error case as
1318the session. 1772the session.
1773
1774=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1775
1776=item $atom_name = $term->XGetAtomName ($atom)
1777
1778=item @atoms = $term->XListProperties ($window)
1779
1780=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1781
1782=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1783
1784=item $term->XDeleteProperty ($window, $property)
1785
1786=item $window = $term->DefaultRootWindow
1787
1788=item $term->XReparentWindow ($window, $parent, [$x, $y])
1789
1790=item $term->XMapWindow ($window)
1791
1792=item $term->XUnmapWindow ($window)
1793
1794=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1795
1796=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1797
1798=item $term->XChangeInput ($window, $add_events[, $del_events])
1799
1800Various X or X-related functions. The C<$term> object only serves as
1801the source of the display, otherwise those functions map more-or-less
1802directory onto the X functions of the same name.
1319 1803
1320=back 1804=back
1321 1805
1322=cut 1806=cut
1323 1807
1387 my ($self, $text, $cb) = @_; 1871 my ($self, $text, $cb) = @_;
1388 1872
1389 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1873 $self->add_item ({ type => "button", text => $text, activate => $cb});
1390} 1874}
1391 1875
1392=item $popup->add_toggle ($text, $cb, $initial_value) 1876=item $popup->add_toggle ($text, $initial_value, $cb)
1393 1877
1394Adds a toggle/checkbox item to the popup. Teh callback gets called 1878Adds a toggle/checkbox item to the popup. The callback gets called
1395whenever it gets toggled, with a boolean indicating its value as its first 1879whenever it gets toggled, with a boolean indicating its new value as its
1396argument. 1880first argument.
1397 1881
1398=cut 1882=cut
1399 1883
1400sub add_toggle { 1884sub add_toggle {
1401 my ($self, $text, $cb, $value) = @_; 1885 my ($self, $text, $value, $cb) = @_;
1402 1886
1403 my $item; $item = { 1887 my $item; $item = {
1404 type => "button", 1888 type => "button",
1405 text => " $text", 1889 text => " $text",
1406 value => $value, 1890 value => $value,
1425 my $env = $self->{term}->env; 1909 my $env = $self->{term}->env;
1426 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1910 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1427 delete $env->{LC_ALL}; 1911 delete $env->{LC_ALL};
1428 $env->{LC_CTYPE} = $self->{term}->locale; 1912 $env->{LC_CTYPE} = $self->{term}->locale;
1429 1913
1430 urxvt::term->new ($env, $self->{term}->resource ("name"), 1914 urxvt::term->new ($env, "popup",
1431 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1915 "--perl-lib" => "", "--perl-ext-common" => "",
1916 "-pty-fd" => -1, "-sl" => 0,
1917 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1432 "--transient-for" => $self->{term}->parent, 1918 "--transient-for" => $self->{term}->parent,
1433 "-display" => $self->{term}->display_id, 1919 "-display" => $self->{term}->display_id,
1434 "-pe" => "urxvt-popup") 1920 "-pe" => "urxvt-popup")
1435 or die "unable to create popup window\n"; 1921 or die "unable to create popup window\n";
1436} 1922}
1441 delete $self->{term}{_destroy}{$self}; 1927 delete $self->{term}{_destroy}{$self};
1442 $self->{term}->ungrab; 1928 $self->{term}->ungrab;
1443} 1929}
1444 1930
1445=back 1931=back
1932
1933=cut
1934
1935package urxvt::watcher;
1936
1937@urxvt::timer::ISA = __PACKAGE__;
1938@urxvt::iow::ISA = __PACKAGE__;
1939@urxvt::pw::ISA = __PACKAGE__;
1940@urxvt::iw::ISA = __PACKAGE__;
1446 1941
1447=head2 The C<urxvt::timer> Class 1942=head2 The C<urxvt::timer> Class
1448 1943
1449This class implements timer watchers/events. Time is represented as a 1944This class implements timer watchers/events. Time is represented as a
1450fractional number of seconds since the epoch. Example: 1945fractional number of seconds since the epoch. Example:
1488Start the timer. 1983Start the timer.
1489 1984
1490=item $timer = $timer->start ($tstamp) 1985=item $timer = $timer->start ($tstamp)
1491 1986
1492Set the event trigger time to C<$tstamp> and start the timer. 1987Set the event trigger time to C<$tstamp> and start the timer.
1988
1989=item $timer = $timer->after ($delay)
1990
1991Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1493 1992
1494=item $timer = $timer->stop 1993=item $timer = $timer->stop
1495 1994
1496Stop the timer. 1995Stop the timer.
1497 1996
1526Set the callback to be called when io events are triggered. C<$reventmask> 2025Set the callback to be called when io events are triggered. C<$reventmask>
1527is a bitset as described in the C<events> method. 2026is a bitset as described in the C<events> method.
1528 2027
1529=item $iow = $iow->fd ($fd) 2028=item $iow = $iow->fd ($fd)
1530 2029
1531Set the filedescriptor (not handle) to watch. 2030Set the file descriptor (not handle) to watch.
1532 2031
1533=item $iow = $iow->events ($eventmask) 2032=item $iow = $iow->events ($eventmask)
1534 2033
1535Set the event mask to watch. The only allowed values are 2034Set the event mask to watch. The only allowed values are
1536C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2035C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed
1540 2039
1541Start watching for requested events on the given handle. 2040Start watching for requested events on the given handle.
1542 2041
1543=item $iow = $iow->stop 2042=item $iow = $iow->stop
1544 2043
1545Stop watching for events on the given filehandle. 2044Stop watching for events on the given file handle.
2045
2046=back
2047
2048=head2 The C<urxvt::iw> Class
2049
2050This class implements idle watchers, that get called automatically when
2051the process is idle. They should return as fast as possible, after doing
2052some useful work.
2053
2054=over 4
2055
2056=item $iw = new urxvt::iw
2057
2058Create a new idle watcher object in stopped state.
2059
2060=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2061
2062Set the callback to be called when the watcher triggers.
2063
2064=item $timer = $timer->start
2065
2066Start the watcher.
2067
2068=item $timer = $timer->stop
2069
2070Stop the watcher.
2071
2072=back
2073
2074=head2 The C<urxvt::pw> Class
2075
2076This class implements process watchers. They create an event whenever a
2077process exits, after which they stop automatically.
2078
2079 my $pid = fork;
2080 ...
2081 $term->{pw} = urxvt::pw
2082 ->new
2083 ->start ($pid)
2084 ->cb (sub {
2085 my ($pw, $exit_status) = @_;
2086 ...
2087 });
2088
2089=over 4
2090
2091=item $pw = new urxvt::pw
2092
2093Create a new process watcher in stopped state.
2094
2095=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2096
2097Set the callback to be called when the timer triggers.
2098
2099=item $pw = $timer->start ($pid)
2100
2101Tells the watcher to start watching for process C<$pid>.
2102
2103=item $pw = $pw->stop
2104
2105Stop the watcher.
1546 2106
1547=back 2107=back
1548 2108
1549=head1 ENVIRONMENT 2109=head1 ENVIRONMENT
1550 2110
1557 2117
1558=item == 0 - fatal messages 2118=item == 0 - fatal messages
1559 2119
1560=item >= 3 - script loading and management 2120=item >= 3 - script loading and management
1561 2121
1562=item >=10 - all events received 2122=item >=10 - all called hooks
2123
2124=item >=11 - hook return values
1563 2125
1564=back 2126=back
1565 2127
1566=head1 AUTHOR 2128=head1 AUTHOR
1567 2129

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines