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.86 by root, Thu Jan 12 05:22:47 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>
39 42
43Or by adding them to the resource for extensions loaded by default:
44
45 URxvt.perl-ext-common: default,selection-autotransform
46
40=over 4 47=over 4
41 48
42=item selection (enabled by default) 49=item selection (enabled by default)
43 50
44(More) intelligent selection. This extension tries to be more intelligent 51(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 52when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 53now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 54arguments, which is very convenient, too, if your F<ls> supports
55C<--quoting-style=shell>.
48 56
57A double-click usually selects the word under the cursor, further clicks
58will enlarge the selection.
59
60The selection works by trying to match a number of regexes and displaying
61them in increasing order of length. You can add your own regexes by
62specifying resources of the form:
63
64 URxvt.selection.pattern-0: perl-regex
65 URxvt.selection.pattern-1: perl-regex
66 ...
67
68The index number (0, 1...) must not have any holes, and each regex must
69contain at least one pair of capturing parentheses, which will be used for
70the match. For example, the following adds a regex that matches everything
71between two vertical bars:
72
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: ^(/[^:]+):\
81
82You can look at the source of the selection extension to see more
83interesting uses, such as parsing a line from beginning to end.
84
49It also offers the following bindable keyboard command: 85This extension also offers following bindable keyboard commands:
50 86
51=over 4 87=over 4
52 88
53=item rot13 89=item rot13
54 90
61=item option-popup (enabled by default) 97=item option-popup (enabled by default)
62 98
63Binds 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
64runtime. 100runtime.
65 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
66=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
67 120
68Binds 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
69text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
70evalution, 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 };
71 143
72=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
73 145
74Adds regex search functionality to the scrollback buffer, triggered 146Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 147by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 148input/output is suspended and a regex is displayed at the bottom of the
149screen.
77 150
78C</> starts an incremental regex search, C<n> searches further, C<p> or 151Inputting 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 152search. 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> 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 154bottom. C<Escape> leaves search mode and returns to the point where search
155was started, while C<Enter> or C<Return> stay at the current position and
156additionally stores the first match in the current line into the primary
157selection if the C<Shift> modifier is active.
82 158
83=item digital-clock 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.
84 162
85Displays a digital clock using the built-in overlay. 163See L<perlre> for more info about perl regular expression syntax.
86 164
87=item mark-urls 165=item readline (enabled by default)
88 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.
189
190=item selection-autotransform
191
192This selection allows you to do automatic transforms on a selection
193whenever a selection is made.
194
195It works by specifying perl snippets (most useful is a single C<s///>
196operator) that modify C<$_> as resources:
197
198 URxvt.selection-autotransform.0: transform
199 URxvt.selection-autotransform.1: transform
200 ...
201
202For example, the following will transform selections of the form
203C<filename:number>, often seen in compiler messages, into C<vi +$filename
204$word>:
205
206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208And this example matches the same,but replaces it with vi-commands you can
209paste directly into your (vi :) editor:
210
211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213Of course, this can be modified to suit your needs and your editor :)
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
89Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
90make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
91resource C<urlLauncher> (default C<x-www-browser>) will be started. 252mouse button specified in the C<matcher.button> resource (default 2, or
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).
92 307
93=item block-graphics-to-ascii 308=item block-graphics-to-ascii
94 309
95A 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
96by replacing all line-drawing characters (U+2500 .. U+259F) by a 311by replacing all line-drawing characters (U+2500 .. U+259F) by a
97similar-looking ascii character. 312similar-looking ascii character.
313
314=item digital-clock
315
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.
98 371
99=item example-refresh-hooks 372=item example-refresh-hooks
100 373
101Displays 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
102window. Illustrates overwriting the refresh callbacks to create your own 375window. Illustrates overwriting the refresh callbacks to create your own
142 415
143=back 416=back
144 417
145=head2 Extension Objects 418=head2 Extension Objects
146 419
147Very 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
148for 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,
149hooks. 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
150about 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
151begin with an underscore character C<_>: these are reserved for internal 425that begin with an underscore character C<_>: these are reserved for
152use. 426internal use.
153 427
154Although 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
155C<urxvt::term> class on this object. 429C<urxvt::term> class on this object.
156 430
157It has the following methods and data members: 431It has the following methods and data members:
178=head2 Hooks 452=head2 Hooks
179 453
180The following subroutines can be declared in extension files, and will be 454The following subroutines can be declared in extension files, and will be
181called whenever the relevant event happens. 455called whenever the relevant event happens.
182 456
183The 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
184the in the C<Extension Objects> section. 458the in the C<Extension Objects> section.
185 459
186B<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
187event 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
188skipped, and the relevant action might not be carried out by the C++ code. 462relevant action might not be carried out by the C++ code.
189 463
190I<< When in doubt, return a false value (preferably C<()>). >> 464I<< When in doubt, return a false value (preferably C<()>). >>
191 465
192=over 4 466=over 4
193 467
194=item on_init $term 468=item on_init $term
195 469
196Called after a new terminal object has been initialized, but before 470Called after a new terminal object has been initialized, but before
197windows 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
198call or deliver senseless data, as terminal size and other characteristics 472call or deliver senseless data, as terminal size and other characteristics
199have not yet been determined. You can safely query and change resources, 473have not yet been determined. You can safely query and change resources
200though. 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).
201 486
202=item on_reset $term 487=item on_reset $term
203 488
204Called 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
205control 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
206variables. 491variables.
207 492
208=item on_start $term 493=item on_child_start $term, $pid
209 494
210Called at the very end of initialisation of a new terminal, just before 495Called just after the child process has been C<fork>ed.
211returning 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>.
212 501
213=item on_sel_make $term, $eventtime 502=item on_sel_make $term, $eventtime
214 503
215Called 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
216selection 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
223 512
224Called whenever a selection has been copied, but before the selection is 513Called whenever a selection has been copied, but before the selection is
225requested from the server. The selection text can be queried and changed 514requested from the server. The selection text can be queried and changed
226by calling C<< $term->selection >>. 515by calling C<< $term->selection >>.
227 516
228Returning a true value aborts selection grabbing. It will still be hilighted. 517Returning a true value aborts selection grabbing. It will still be highlighted.
229 518
230=item on_sel_extend $term 519=item on_sel_extend $term
231 520
232Called 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
233click) and is either supposed to return false (normal operation), or 522click) and is either supposed to return false (normal operation), or
234should 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
235processing. This can happen multiple times, as long as the callback 524processing. This can happen multiple times, as long as the callback
236returns 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
237supposed to enlarge the selection more and more, if possible. 526supposed to enlarge the selection more and more, if possible.
238 527
239See the F<selection> example extension. 528See the F<selection> example extension.
240 529
241=item on_view_change $term, $offset 530=item on_view_change $term, $offset
242 531
243Called whenever the view offset changes, i..e the user or program 532Called whenever the view offset changes, i.e. the user or program
244scrolls. Offset C<0> means display the normal terminal, positive values 533scrolls. Offset C<0> means display the normal terminal, positive values
245show this many lines of scrollback. 534show this many lines of scrollback.
246 535
247=item on_scroll_back $term, $lines, $saved 536=item on_scroll_back $term, $lines, $saved
248 537
252 541
253It 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,
254$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
255number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
256 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
257=item on_osc_seq $term, $string 556=item on_osc_seq_perl $term, $string
258 557
259Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
260operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
261information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
262string should start with the extension name and a colon, to distinguish 561string should start with the extension name and a colon, to distinguish
263it 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
264future. 563future.
265 564
266Be 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,
267as 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
268other users on the same system etc.). 567other users on the same system etc.).
269 568
270=item on_add_lines $term, $string 569=item on_add_lines $term, $string
271 570
272Called 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
303 602
304=item on_refresh_end $term 603=item on_refresh_end $term
305 604
306Called just after the screen gets redrawn. See C<on_refresh_begin>. 605Called just after the screen gets redrawn. See C<on_refresh_begin>.
307 606
308=item on_keyboard_command $term, $string 607=item on_user_command $term, $string
309 608
310Called whenever the user presses a key combination that has a 609Called whenever a user-configured event is being activated (e.g. via
311C<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>
312resource 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.
313 631
314=item on_focus_in $term 632=item on_focus_in $term
315 633
316Called whenever the window gets the keyboard focus, before rxvt-unicode 634Called whenever the window gets the keyboard focus, before rxvt-unicode
317does focus in processing. 635does focus in processing.
318 636
319=item on_focus_out $term 637=item on_focus_out $term
320 638
321Called wheneever the window loses keyboard focus, before rxvt-unicode does 639Called whenever the window loses keyboard focus, before rxvt-unicode does
322focus out processing. 640focus out processing.
641
642=item on_configure_notify $term, $event
643
644=item on_property_notify $term, $event
323 645
324=item on_key_press $term, $event, $keysym, $octets 646=item on_key_press $term, $event, $keysym, $octets
325 647
326=item on_key_release $term, $event, $keysym 648=item on_key_release $term, $event, $keysym
327 649
337 659
338Called whenever the corresponding X event is received for the terminal If 660Called whenever the corresponding X event is received for the terminal If
339the 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.
340 662
341The 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
342manpage), 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
343and column under the mouse cursor. 665(real, not screen-based) row and column under the mouse cursor.
344 666
345C<on_key_press> additionally receives the string rxvt-unicode would 667C<on_key_press> additionally receives the string rxvt-unicode would
346output, if any, in locale-specific encoding. 668output, if any, in locale-specific encoding.
347 669
348subwindow. 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).
349 680
350=back 681=back
351 682
352=cut 683=cut
353 684
359use Scalar::Util (); 690use Scalar::Util ();
360use List::Util (); 691use List::Util ();
361 692
362our $VERSION = 1; 693our $VERSION = 1;
363our $TERM; 694our $TERM;
695our @TERM_INIT;
696our @TERM_EXT;
364our @HOOKNAME; 697our @HOOKNAME;
365our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 698our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
366our %OPTION; 699our %OPTION;
367 700
368our $LIBDIR; 701our $LIBDIR;
369our $RESNAME; 702our $RESNAME;
370our $RESCLASS; 703our $RESCLASS;
371our $RXVTNAME; 704our $RXVTNAME;
372 705
706our $NOCHAR = chr 0xffff;
707
373=head2 Variables in the C<urxvt> Package 708=head2 Variables in the C<urxvt> Package
374 709
375=over 4 710=over 4
376 711
377=item $urxvt::LIBDIR 712=item $urxvt::LIBDIR
389 724
390=item $urxvt::TERM 725=item $urxvt::TERM
391 726
392The current terminal. This variable stores the current C<urxvt::term> 727The current terminal. This variable stores the current C<urxvt::term>
393object, 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>.
394 745
395=back 746=back
396 747
397=head2 Functions in the C<urxvt> Package 748=head2 Functions in the C<urxvt> Package
398 749
413Using 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
414correct place, e.g. on stderr of the connecting urxvtc client. 765correct place, e.g. on stderr of the connecting urxvtc client.
415 766
416Messages have a size limit of 1023 bytes currently. 767Messages have a size limit of 1023 bytes currently.
417 768
418=item $is_safe = urxvt::safe 769=item @terms = urxvt::termlist
419 770
420Returns true when it is safe to do potentially unsafe things, such as 771Returns all urxvt::term objects that exist in this process, regardless of
421evaluating perl code specified by the user. This is true when urxvt was 772whether they are started, being destroyed etc., so be careful. Only term
422started setuid or setgid. 773objects that have perl extensions attached will be returned (because there
774is no urxvt::term objet associated with others).
423 775
424=item $time = urxvt::NOW 776=item $time = urxvt::NOW
425 777
426Returns the "current time" (as per the event loop). 778Returns the "current time" (as per the event loop).
427 779
428=item urxvt::CurrentTime 780=item urxvt::CurrentTime
429 781
430=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 782=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
431Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 783Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
432Button4Mask, 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
433 801
434Various constants for use in X calls and event processing. 802Various constants for use in X calls and event processing.
435 803
436=back 804=back
437 805
470 838
471=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 839=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
472 840
473=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 841=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
474 842
843=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
844
475Replace the foreground/background colour in the rendition mask with the 845Replace the foreground/background colour in the rendition mask with the
476specified one. 846specified one.
477 847
478=item $value = urxvt::GET_CUSTOM $rend 848=item $value = urxvt::GET_CUSTOM $rend
479 849
488=back 858=back
489 859
490=cut 860=cut
491 861
492BEGIN { 862BEGIN {
493 urxvt->bootstrap;
494
495 # overwrite perl's warn 863 # overwrite perl's warn
496 *CORE::GLOBAL::warn = sub { 864 *CORE::GLOBAL::warn = sub {
497 my $msg = join "", @_; 865 my $msg = join "", @_;
498 $msg .= "\n" 866 $msg .= "\n"
499 unless $msg =~ /\n$/; 867 unless $msg =~ /\n$/;
500 urxvt::warn ($msg); 868 urxvt::warn ($msg);
501 }; 869 };
502
503 # %ENV is the original startup environment
504 delete $ENV{IFS};
505 delete $ENV{CDPATH};
506 delete $ENV{BASH_ENV};
507 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
508} 870}
509 871
510my @hook_count; 872no warnings 'utf8';
873
511my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 874my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
512 875
513sub verbose { 876sub verbose {
514 my ($level, $msg) = @_; 877 my ($level, $msg) = @_;
515 warn "$msg\n" if $level <= $verbosity; 878 warn "$msg\n" if $level <= $verbosity;
516} 879}
517 880
518my $extension_pkg = "extension0000";
519my %extension_pkg; 881my %extension_pkg;
520 882
521# load a single script into its own package, once only 883# load a single script into its own package, once only
522sub extension_package($) { 884sub extension_package($) {
523 my ($path) = @_; 885 my ($path) = @_;
524 886
525 $extension_pkg{$path} ||= do { 887 $extension_pkg{$path} ||= do {
526 my $pkg = "urxvt::" . ($extension_pkg++); 888 $path =~ /([^\/\\]+)$/;
889 my $pkg = $1;
890 $pkg =~ s/[^[:word:]]/_/g;
891 $pkg = "urxvt::ext::$pkg";
527 892
528 verbose 3, "loading extension '$path' into package '$pkg'"; 893 verbose 3, "loading extension '$path' into package '$pkg'";
529 894
530 open my $fh, "<:raw", $path 895 open my $fh, "<:raw", $path
531 or die "$path: $!"; 896 or die "$path: $!";
532 897
533 my $source = untaint 898 my $source =
534 "package $pkg; use strict; use utf8;\n" 899 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
535 . "use base urxvt::term::extension::;\n"
536 . "#line 1 \"$path\"\n{\n" 900 . "#line 1 \"$path\"\n{\n"
537 . (do { local $/; <$fh> }) 901 . (do { local $/; <$fh> })
538 . "\n};\n1"; 902 . "\n};\n1";
539 903
540 eval $source 904 eval $source
551 local $TERM = shift; 915 local $TERM = shift;
552 my $htype = shift; 916 my $htype = shift;
553 917
554 if ($htype == 0) { # INIT 918 if ($htype == 0) { # INIT
555 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
556 920
557 my %ext_arg; 921 my %ext_arg;
558 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
559 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 932 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
560 if ($_ eq "default") { 933 if ($_ eq "default") {
561 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 934 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
562 } elsif (/^-(.*)$/) { 935 } elsif (/^-(.*)$/) {
563 delete $ext_arg{$1}; 936 delete $ext_arg{$1};
564 } elsif (/^([^<]+)<(.*)>$/) { 937 } elsif (/^([^<]+)<(.*)>$/) {
565 push @{ $ext_arg{$1} }, $2; 938 push @{ $ext_arg{$1} }, $2;
566 } else { 939 } else {
567 $ext_arg{$_} ||= []; 940 $ext_arg{$_} ||= [];
568 } 941 }
569 } 942 }
570 943
571 while (my ($ext, $argv) = each %ext_arg) { 944 for my $ext (sort keys %ext_arg) {
572 my @files = grep -f $_, map "$_/$ext", @dirs; 945 my @files = grep -f $_, map "$_/$ext", @dirs;
573 946
574 if (@files) { 947 if (@files) {
575 $TERM->register_package (extension_package $files[0], $argv); 948 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
576 } else { 949 } else {
577 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";
578 } 951 }
579 } 952 }
580 953
586 959
587 if (my $cb = $TERM->{_hook}[$htype]) { 960 if (my $cb = $TERM->{_hook}[$htype]) {
588 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 961 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
589 if $verbosity >= 10; 962 if $verbosity >= 10;
590 963
591 keys %$cb; 964 for my $pkg (keys %$cb) {
592
593 while (my ($pkg, $cb) = each %$cb) {
594 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 965 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
595 and last; 966 $retval ||= $retval_;
596 967
597 if ($@) { 968 if ($@) {
598 $TERM->ungrab; # better to lose the grab than the session 969 $TERM->ungrab; # better to lose the grab than the session
599 warn $@; 970 warn $@;
600 } 971 }
603 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 974 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
604 if $verbosity >= 11; 975 if $verbosity >= 11;
605 } 976 }
606 977
607 if ($htype == 1) { # DESTROY 978 if ($htype == 1) { # DESTROY
608 if (my $hook = delete $TERM->{_hook}) {
609 for my $htype (0..$#$hook) {
610 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
611 or set_should_invoke $htype, 0;
612 }
613 }
614
615 # clear package objects 979 # clear package objects
616 %$_ = () for values %{ $TERM->{_pkg} }; 980 %$_ = () for values %{ $TERM->{_pkg} };
617 981
618 # clear package 982 # clear package
619 %$TERM = (); 983 %$TERM = ();
620 } 984 }
621 985
622 $retval 986 $retval
623} 987}
624 988
625sub exec_async(@) { 989sub SET_COLOR($$$) {
626 my $pid = fork; 990 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
991}
627 992
628 return 993sub rend2mask {
629 if !defined $pid or $pid; 994 no strict 'refs';
630 995 my ($str, $mask) = (@_, 0);
631 %ENV = %{ $TERM->env }; 996 my %color = ( fg => undef, bg => undef );
632 997 my @failed;
633 exec @_; 998 for my $spec ( split /\s+/, $str ) {
634 _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)
635} 1016}
636 1017
637# urxvt::term::extension 1018# urxvt::term::extension
638 1019
639package urxvt::term::extension; 1020package urxvt::term::extension;
645 while (my ($name, $cb) = each %hook) { 1026 while (my ($name, $cb) = each %hook) {
646 my $htype = $HOOKTYPE{uc $name}; 1027 my $htype = $HOOKTYPE{uc $name};
647 defined $htype 1028 defined $htype
648 or Carp::croak "unsupported hook type '$name'"; 1029 or Carp::croak "unsupported hook type '$name'";
649 1030
1031 $self->set_should_invoke ($htype, +1)
650 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 1032 unless exists $self->{term}{_hook}[$htype]{$pkg};
651 $hook_count[$htype]++
652 or urxvt::set_should_invoke $htype, 1;
653 }
654 1033
655 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1034 $self->{term}{_hook}[$htype]{$pkg} = $cb;
656 } 1035 }
657} 1036}
658 1037
663 for my $name (@hook) { 1042 for my $name (@hook) {
664 my $htype = $HOOKTYPE{uc $name}; 1043 my $htype = $HOOKTYPE{uc $name};
665 defined $htype 1044 defined $htype
666 or Carp::croak "unsupported hook type '$name'"; 1045 or Carp::croak "unsupported hook type '$name'";
667 1046
1047 $self->set_should_invoke ($htype, -1)
668 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 1048 if delete $self->{term}{_hook}[$htype]{$pkg};
669 --$hook_count[$htype]
670 or urxvt::set_should_invoke $htype, 0;
671 }
672 } 1049 }
673} 1050}
674 1051
675our $AUTOLOAD; 1052our $AUTOLOAD;
676 1053
756sub DESTROY { 1133sub DESTROY {
757 $_[0][1]->stop; 1134 $_[0][1]->stop;
758} 1135}
759 1136
760sub condvar { 1137sub condvar {
761 bless \my $flag, urxvt::anyevent::condvar:: 1138 bless \my $flag, urxvt::anyevent::
762} 1139}
763 1140
764sub urxvt::anyevent::condvar::broadcast { 1141sub broadcast {
765 ${$_[0]}++; 1142 ${$_[0]}++;
766} 1143}
767 1144
768sub urxvt::anyevent::condvar::wait { 1145sub wait {
769 unless (${$_[0]}) { 1146 unless (${$_[0]}) {
770 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";
771 } 1148 }
1149}
1150
1151sub one_event {
1152 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
772} 1153}
773 1154
774package urxvt::term; 1155package urxvt::term;
775 1156
776=head2 The C<urxvt::term> Class 1157=head2 The C<urxvt::term> Class
781 1162
782# find on_xxx subs in the package and register them 1163# find on_xxx subs in the package and register them
783# as hooks 1164# as hooks
784sub register_package { 1165sub register_package {
785 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::;
786 1173
787 my $proxy = bless { 1174 my $proxy = bless {
788 _pkg => $pkg, 1175 _pkg => $pkg,
789 argv => $argv, 1176 argv => $argv,
790 }, $pkg; 1177 }, $pkg;
806hash which defines the environment of the new terminal. 1193hash which defines the environment of the new terminal.
807 1194
808Croaks (and probably outputs an error message) if the new instance 1195Croaks (and probably outputs an error message) if the new instance
809couldn'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
810initialise perl, and the terminal object otherwise. The C<init> and 1197initialise perl, and the terminal object otherwise. The C<init> and
811C<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).
812 1200
813=cut 1201=cut
814 1202
815sub new { 1203sub new {
816 my ($class, $env, @args) = @_; 1204 my ($class, $env, @args) = @_;
817 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
818 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1209 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
819} 1210}
820 1211
821=item $term->destroy 1212=item $term->destroy
822 1213
823Destroy the terminal object (close the window, free resources 1214Destroy the terminal object (close the window, free resources
824etc.). 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
825watchers (timers, io watchers) are still active. 1216watchers (timers, io watchers) are still active.
826 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
827=item $isset = $term->option ($optval[, $set]) 1243=item $isset = $term->option ($optval[, $set])
828 1244
829Returns true if the option specified by C<$optval> is enabled, and 1245Returns true if the option specified by C<$optval> is enabled, and
830optionally 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
831C<%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.
832 1248
833Here 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
834source file F</src/optinc.h> to see the actual list: 1250source file F</src/optinc.h> to see the actual list:
835 1251
836 borderLess console cursorBlink cursorUnderline hold iconic insecure 1252 borderLess console cursorBlink cursorUnderline hold iconic insecure
837 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1253 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
838 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1254 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
839 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1255 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
840 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1256 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
841 tripleclickwords utmpInhibit visualBell 1257 transparent tripleclickwords utmpInhibit visualBell
842 1258
843=item $value = $term->resource ($name[, $newval]) 1259=item $value = $term->resource ($name[, $newval])
844 1260
845Returns the current resource value associated with a given name and 1261Returns the current resource value associated with a given name and
846optionally 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>
855likely change). 1271likely change).
856 1272
857Please note that resource strings will currently only be freed when the 1273Please note that resource strings will currently only be freed when the
858terminal is destroyed, so changing options frequently will eat memory. 1274terminal is destroyed, so changing options frequently will eat memory.
859 1275
860Here 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
861are 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>
862to see the actual list: 1278to see the actual list:
863 1279
864 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1280 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
865 borderLess color cursorBlink cursorUnderline cutchars delete_key 1281 borderLess color cursorBlink cursorUnderline cutchars delete_key
866 display_name embed ext_bwidth fade font geometry hold iconName 1282 display_name embed ext_bwidth fade font geometry hold iconName
867 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1283 imFont imLocale inputMethod insecure int_bwidth intensityStyles
868 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1284 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
869 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1285 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
870 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1286 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
871 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1287 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
872 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1288 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
873 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1289 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
874 shade term_name title transparent transparent_all tripleclickwords 1290 secondaryScreen secondaryScroll selectstyle shade term_name title
875 utmpInhibit visualBell 1291 transient_for transparent transparent_all tripleclickwords utmpInhibit
1292 visualBell
876 1293
877=cut 1294=cut
878 1295
879sub resource($$;$) { 1296sub resource($$;$) {
880 my ($self, $name) = (shift, shift); 1297 my ($self, $name) = (shift, shift);
1054 1471
1055Normally 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
1056confused by changes in cursor position or scrolling. Its useful inside a 1473confused by changes in cursor position or scrolling. Its useful inside a
1057C<on_add_lines> hook, though. 1474C<on_add_lines> hook, though.
1058 1475
1476=item $term->scr_change_screen ($screen)
1477
1478Switch to given screen - 0 primary, 1 secondary.
1479
1059=item $term->cmd_parse ($octets) 1480=item $term->cmd_parse ($octets)
1060 1481
1061Similar 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
1062locale-specific encoding of the terminal and can contain command sequences 1483locale-specific encoding of the terminal and can contain command sequences
1063(escape codes) that will be interpreted. 1484(escape codes) that will be interpreted.
1073Replaces 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
1074be 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
1075description of C<< urxvt::timer->events >>. Make sure to always restore 1496description of C<< urxvt::timer->events >>. Make sure to always restore
1076the previous value. 1497the previous value.
1077 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
1078=item $windowid = $term->parent 1504=item $windowid = $term->parent
1079 1505
1080Return the window id of the toplevel window. 1506Return the window id of the toplevel window.
1081 1507
1082=item $windowid = $term->vt 1508=item $windowid = $term->vt
1083 1509
1084Return the window id of the terminal window. 1510Return the window id of the terminal window.
1085 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
1086=item $window_width = $term->width 1529=item $window_width = $term->width
1087 1530
1088=item $window_height = $term->height 1531=item $window_height = $term->height
1089 1532
1090=item $font_width = $term->fwidth 1533=item $font_width = $term->fwidth
1103 1546
1104=item $max_scrollback = $term->saveLines 1547=item $max_scrollback = $term->saveLines
1105 1548
1106=item $nrow_plus_saveLines = $term->total_rows 1549=item $nrow_plus_saveLines = $term->total_rows
1107 1550
1108=item $lines_in_scrollback = $term->nsaved 1551=item $topmost_scrollback_row = $term->top_row
1109 1552
1110Return various integers describing terminal characteristics. 1553Return various integers describing terminal characteristics.
1111 1554
1112=item $x_display = $term->display_id 1555=item $x_display = $term->display_id
1113 1556
1120=item $env = $term->env 1563=item $env = $term->env
1121 1564
1122Returns 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
1123similar to C<\%ENV>. 1566similar to C<\%ENV>.
1124 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
1125=cut 1577=cut
1126 1578
1127sub env { 1579sub env {
1128 if (my $env = $_[0]->_env) {
1129 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1580 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1130 } else {
1131 +{ %ENV }
1132 }
1133} 1581}
1134 1582
1135=item $modifiermask = $term->ModLevel3Mask 1583=item $modifiermask = $term->ModLevel3Mask
1136 1584
1137=item $modifiermask = $term->ModMetaMask 1585=item $modifiermask = $term->ModMetaMask
1139=item $modifiermask = $term->ModNumLockMask 1587=item $modifiermask = $term->ModNumLockMask
1140 1588
1141Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1589Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1142AltGr), 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.
1143 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
1144=item $view_start = $term->view_start ([$newvalue]) 1600=item $view_start = $term->view_start ([$newvalue])
1145 1601
1146Returns the negative row number of the topmost line. Minimum value is 1602Returns the row number of the topmost displayed line. Maximum value is
1147C<0>, which displays the normal terminal contents. Larger values scroll 1603C<0>, which displays the normal terminal contents. Lower values scroll
1148this many lines into the scrollback buffer. 1604this many lines into the scrollback buffer.
1149 1605
1150=item $term->want_refresh 1606=item $term->want_refresh
1151 1607
1152Requests a screen refresh. At the next opportunity, rxvt-unicode will 1608Requests a screen refresh. At the next opportunity, rxvt-unicode will
1167line, 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
1168to 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
1169automatically be updated. 1625automatically be updated.
1170 1626
1171C<$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
1172than one cell when displayed are padded with urxvt::NOCHAR characters 1628than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1173(C<chr 65535>). Characters with combining characters and other characters 1629characters. Characters with combining characters and other characters that
1174that 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
1175characters in the private use area. 1631in the private use area.
1176 1632
1177You have to obey this encoding when changing text. The advantage is 1633You have to obey this encoding when changing text. The advantage is
1178that 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
1179characters. 1635characters.
1180 1636
1324where one character corresponds to one screen cell. See 1780where one character corresponds to one screen cell. See
1325C<< $term->ROW_t >> for details. 1781C<< $term->ROW_t >> for details.
1326 1782
1327=item $string = $term->special_decode $text 1783=item $string = $term->special_decode $text
1328 1784
1329Converts rxvt-unicodes text reprsentation into a perl string. See 1785Converts rxvt-unicodes text representation into a perl string. See
1330C<< $term->ROW_t >> for details. 1786C<< $term->ROW_t >> for details.
1331 1787
1332=item $success = $term->grab_button ($button, $modifiermask) 1788=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1333 1789
1790=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1791
1334Registers a synchronous button grab. See the XGrabButton manpage. 1792Register/unregister a synchronous button grab. See the XGrabButton
1793manpage.
1335 1794
1336=item $success = $term->grab ($eventtime[, $sync]) 1795=item $success = $term->grab ($eventtime[, $sync])
1337 1796
1338Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1797Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1339synchronous (C<$sync> is true). Also remembers the grab timestampe. 1798synchronous (C<$sync> is true). Also remembers the grab timestamp.
1340 1799
1341=item $term->allow_events_async 1800=item $term->allow_events_async
1342 1801
1343Calls XAllowEvents with AsyncBoth for the most recent grab. 1802Calls XAllowEvents with AsyncBoth for the most recent grab.
1344 1803
1354=item $term->ungrab 1813=item $term->ungrab
1355 1814
1356Calls XUngrab for the most recent grab. Is called automatically on 1815Calls XUngrab for the most recent grab. Is called automatically on
1357evaluation 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
1358the 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.
1359 1848
1360=back 1849=back
1361 1850
1362=cut 1851=cut
1363 1852
1427 my ($self, $text, $cb) = @_; 1916 my ($self, $text, $cb) = @_;
1428 1917
1429 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1918 $self->add_item ({ type => "button", text => $text, activate => $cb});
1430} 1919}
1431 1920
1432=item $popup->add_toggle ($text, $cb, $initial_value) 1921=item $popup->add_toggle ($text, $initial_value, $cb)
1433 1922
1434Adds a toggle/checkbox item to the popup. Teh callback gets called 1923Adds a toggle/checkbox item to the popup. The callback gets called
1435whenever 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
1436argument. 1925first argument.
1437 1926
1438=cut 1927=cut
1439 1928
1440sub add_toggle { 1929sub add_toggle {
1441 my ($self, $text, $cb, $value) = @_; 1930 my ($self, $text, $value, $cb) = @_;
1442 1931
1443 my $item; $item = { 1932 my $item; $item = {
1444 type => "button", 1933 type => "button",
1445 text => " $text", 1934 text => " $text",
1446 value => $value, 1935 value => $value,
1465 my $env = $self->{term}->env; 1954 my $env = $self->{term}->env;
1466 # 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.
1467 delete $env->{LC_ALL}; 1956 delete $env->{LC_ALL};
1468 $env->{LC_CTYPE} = $self->{term}->locale; 1957 $env->{LC_CTYPE} = $self->{term}->locale;
1469 1958
1470 urxvt::term->new ($env, $self->{term}->resource ("name"), 1959 urxvt::term->new ($env, "popup",
1471 "--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",
1472 "--transient-for" => $self->{term}->parent, 1963 "--transient-for" => $self->{term}->parent,
1473 "-display" => $self->{term}->display_id, 1964 "-display" => $self->{term}->display_id,
1474 "-pe" => "urxvt-popup") 1965 "-pe" => "urxvt-popup")
1475 or die "unable to create popup window\n"; 1966 or die "unable to create popup window\n";
1476} 1967}
1481 delete $self->{term}{_destroy}{$self}; 1972 delete $self->{term}{_destroy}{$self};
1482 $self->{term}->ungrab; 1973 $self->{term}->ungrab;
1483} 1974}
1484 1975
1485=back 1976=back
1977
1978=cut
1979
1980package urxvt::watcher;
1486 1981
1487=head2 The C<urxvt::timer> Class 1982=head2 The C<urxvt::timer> Class
1488 1983
1489This class implements timer watchers/events. Time is represented as a 1984This class implements timer watchers/events. Time is represented as a
1490fractional number of seconds since the epoch. Example: 1985fractional number of seconds since the epoch. Example:
1494 ->new 1989 ->new
1495 ->interval (1) 1990 ->interval (1)
1496 ->cb (sub { 1991 ->cb (sub {
1497 $term->{overlay}->set (0, 0, 1992 $term->{overlay}->set (0, 0,
1498 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1993 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1499 }); 1994 });
1500 1995
1501=over 4 1996=over 4
1502 1997
1503=item $timer = new urxvt::timer 1998=item $timer = new urxvt::timer
1504 1999
1528Start the timer. 2023Start the timer.
1529 2024
1530=item $timer = $timer->start ($tstamp) 2025=item $timer = $timer->start ($tstamp)
1531 2026
1532Set 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>.
1533 2032
1534=item $timer = $timer->stop 2033=item $timer = $timer->stop
1535 2034
1536Stop the timer. 2035Stop the timer.
1537 2036
1543 2042
1544 $term->{socket} = ... 2043 $term->{socket} = ...
1545 $term->{iow} = urxvt::iow 2044 $term->{iow} = urxvt::iow
1546 ->new 2045 ->new
1547 ->fd (fileno $term->{socket}) 2046 ->fd (fileno $term->{socket})
1548 ->events (urxvt::EVENT_READ) 2047 ->events (urxvt::EV_READ)
1549 ->start 2048 ->start
1550 ->cb (sub { 2049 ->cb (sub {
1551 my ($iow, $revents) = @_; 2050 my ($iow, $revents) = @_;
1552 # $revents must be 1 here, no need to check 2051 # $revents must be 1 here, no need to check
1553 sysread $term->{socket}, my $buf, 8192 2052 sysread $term->{socket}, my $buf, 8192
1566Set 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>
1567is a bitset as described in the C<events> method. 2066is a bitset as described in the C<events> method.
1568 2067
1569=item $iow = $iow->fd ($fd) 2068=item $iow = $iow->fd ($fd)
1570 2069
1571Set the filedescriptor (not handle) to watch. 2070Set the file descriptor (not handle) to watch.
1572 2071
1573=item $iow = $iow->events ($eventmask) 2072=item $iow = $iow->events ($eventmask)
1574 2073
1575Set the event mask to watch. The only allowed values are 2074Set the event mask to watch. The only allowed values are
1576C<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
1577together, or C<urxvt::EVENT_NONE>. 2076together, or C<urxvt::EV_NONE>.
1578 2077
1579=item $iow = $iow->start 2078=item $iow = $iow->start
1580 2079
1581Start watching for requested events on the given handle. 2080Start watching for requested events on the given handle.
1582 2081
1583=item $iow = $iow->stop 2082=item $iow = $iow->stop
1584 2083
1585Stop 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.
1586 2146
1587=back 2147=back
1588 2148
1589=head1 ENVIRONMENT 2149=head1 ENVIRONMENT
1590 2150
1599 2159
1600=item >= 3 - script loading and management 2160=item >= 3 - script loading and management
1601 2161
1602=item >=10 - all called hooks 2162=item >=10 - all called hooks
1603 2163
1604=item >=11 - hook reutrn values 2164=item >=11 - hook return values
1605 2165
1606=back 2166=back
1607 2167
1608=head1 AUTHOR 2168=head1 AUTHOR
1609 2169
1611 http://software.schmorp.de/pkg/rxvt-unicode 2171 http://software.schmorp.de/pkg/rxvt-unicode
1612 2172
1613=cut 2173=cut
1614 2174
16151 21751
2176
2177# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines