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.90 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.210 by root, Wed Jun 6 11:46:11 2012 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
36You can activate them like this: 39You can activate them like this:
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
42
43Or by adding them to the resource for extensions loaded by default:
44
45 URxvt.perl-ext-common: default,selection-autotransform
39 46
40=over 4 47=over 4
41 48
42=item selection (enabled by default) 49=item selection (enabled by default)
43 50
58 URxvt.selection.pattern-1: perl-regex 65 URxvt.selection.pattern-1: perl-regex
59 ... 66 ...
60 67
61The index number (0, 1...) must not have any holes, and each regex must 68The index number (0, 1...) must not have any holes, and each regex must
62contain at least one pair of capturing parentheses, which will be used for 69contain at least one pair of capturing parentheses, which will be used for
63the match. For example, the followign adds a regex that matches everything 70the match. For example, the following adds a regex that matches everything
64between two vertical bars: 71between two vertical bars:
65 72
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
67 81
68You can look at the source of the selection extension to see more 82You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 83interesting uses, such as parsing a line from beginning to end.
70 84
71This extension also offers the following bindable keyboard command: 85This extension also offers following bindable keyboard commands:
72 86
73=over 4 87=over 4
74 88
75=item rot13 89=item rot13
76 90
83=item option-popup (enabled by default) 97=item option-popup (enabled by default)
84 98
85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86runtime. 100runtime.
87 101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<< $self->{myoption} >>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
118
88=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
89 120
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<a>s:
138
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : ()
142 };
93 143
94=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
95 145
96Adds regex search functionality to the scrollback buffer, triggered 146Adds regex search functionality to the scrollback buffer, triggered
97by a hotkey (default: C<M-s>). While in search mode, normal terminal 147by a hotkey (default: C<M-s>). While in search mode, normal terminal
102search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
103search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
104bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
105was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
106additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
107selection. 157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
164
165=item readline (enabled by default)
166
167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters).
172
173To avoid too many false positives, this is only done when:
174
175=over 4
176
177=item - the tty is in ICANON state.
178
179=item - the text cursor is visible.
180
181=item - the primary screen is currently being displayed.
182
183=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
108 189
109=item selection-autotransform 190=item selection-autotransform
110 191
111This selection allows you to do automatic transforms on a selection 192This selection allows you to do automatic transforms on a selection
112whenever a selection is made. 193whenever a selection is made.
120 201
121For example, the following will transform selections of the form 202For example, the following will transform selections of the form
122C<filename:number>, often seen in compiler messages, into C<vi +$filename 203C<filename:number>, often seen in compiler messages, into C<vi +$filename
123$word>: 204$word>:
124 205
125 URxvt.selection-autotransform.0: s/^(\\S+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
126 207
127And this example matches the same,but replaces it with vi-commands you can 208And this example matches the same,but replaces it with vi-commands you can
128paste directly into your (vi :) editor: 209paste directly into your (vi :) editor:
129 210
130 URxvt.selection-autotransform.0: s/^(S+):(d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
131 212
132Of course, this can be modified to suit your needs and your editor :) 213Of course, this can be modified to suit your needs and your editor :)
133 214
134=item mark-urls 215To expand the example above to typical perl error messages ("XXX at
216FILENAME line YYY."), you need a slightly more elaborate solution:
135 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
136Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
137make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
138resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
139the URL as first argument. 253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
268Example configuration:
269
270 URxvt.perl-ext: default,matcher
271 URxvt.urlLauncher: sensible-browser
272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
274 URxvt.matcher.button: 1
275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277 URxvt.matcher.launcher.2: gvim +$2 $1
278
279=item xim-onthespot
280
281This (experimental) perl extension implements OnTheSpot editing. It does
282not work perfectly, and some input methods don't seem to work well with
283OnTheSpot editing in general, but it seems to work at least for SCIM and
284kinput2.
285
286You enable it by specifying this extension and a preedit style of
287C<OnTheSpot>, i.e.:
288
289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291=item kuake<hotkey>
292
293A very primitive quake-console-like extension. It was inspired by a
294description of how the programs C<kuake> and C<yakuake> work: Whenever the
295user presses a global accelerator key (by default C<F10>), the terminal
296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
298
299Initially, the window will not be shown when using this extension.
300
301This is useful if you need a single terminal that is not using any desktop
302space most of the time but is quickly available at the press of a key.
303
304The accelerator key is grabbed regardless of any modifiers, so this
305extension will actually grab a physical key just for this function.
306
307If you want a quake-like animation, tell your window manager to do so
308(fvwm can do it).
309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
140 315
141=item block-graphics-to-ascii 316=item block-graphics-to-ascii
142 317
143A not very useful example of filtering all text output to the terminal, 318A not very useful example of filtering all text output to the terminal
144by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
145similar-looking ascii character. 320similar-looking ascii character.
146 321
147=item digital-clock 322=item digital-clock
148 323
149Displays a digital clock using the built-in overlay. 324Displays a digital clock using the built-in overlay.
325
326=item remote-clipboard
327
328Somewhat of a misnomer, this extension adds two menu entries to the
329selection popup that allows one to run external commands to store the
330selection somewhere and fetch it again.
331
332We use it to implement a "distributed selection mechanism", which just
333means that one command uploads the file to a remote server, and another
334reads it.
335
336The commands can be set using the C<URxvt.remote-selection.store> and
337C<URxvt.remote-selection.fetch> resources. The first should read the
338selection to store from STDIN (always in UTF-8), the second should provide
339the selection data on STDOUT (also in UTF-8).
340
341The defaults (which are likely useless to you) use rsh and cat:
342
343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346=item selection-pastebin
347
348This is a little rarely useful extension that uploads the selection as
349textfile to a remote site (or does other things). (The implementation is
350not currently secure for use in a multiuser environment as it writes to
351F</tmp> directly.).
352
353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354i.e.
355
356 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358Pressing this combination runs a command with C<%> replaced by the name of
359the textfile. This command can be set via a resource:
360
361 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363And the default is likely not useful to anybody but the few people around
364here :)
365
366The name of the textfile is the hex encoded md5 sum of the selection, so
367the same content should lead to the same filename.
368
369After a successful upload the selection will be replaced by the text given
370in the C<selection-pastebin-url> resource (again, the % is the placeholder
371for the filename):
372
373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376the double C</> characters as comment start. Use C<\057\057> instead,
377which works regardless of whether xrdb is used to parse the resource file
378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
150 393
151=item example-refresh-hooks 394=item example-refresh-hooks
152 395
153Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
154window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
155overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
156 412
157=back 413=back
158 414
159=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
160 416
176 432
177=over 4 433=over 4
178 434
179=item $text 435=item $text
180 436
181Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
182always represents one screen cell. See L<ROW_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
183 439
184=item $string 440=item $string
185 441
186A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
190=item $octets 446=item $octets
191 447
192Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
193locale-specific way. 449locale-specific way.
194 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
195=back 457=back
196 458
197=head2 Extension Objects 459=head2 Extension Objects
198 460
199Very perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
200for each terminal and each extension and passed as the first parameter to 462for each terminal, and each terminal has its own set of extension objects,
201hooks. So extensions can use their C<$self> object without having to think 463which are passed as the first parameter to hooks. So extensions can use
202about other extensions, with the exception of methods and members that 464their C<$self> object without having to think about clashes with other
465extensions or other terminals, with the exception of methods and members
203begin with an underscore character C<_>: these are reserved for internal 466that begin with an underscore character C<_>: these are reserved for
204use. 467internal use.
205 468
206Although it isn't a C<urxvt::term> object, you can call all methods of the 469Although it isn't a C<urxvt::term> object, you can call all methods of the
207C<urxvt::term> class on this object. 470C<urxvt::term> class on this object.
208 471
209It has the following methods and data members: 472It has the following methods and data members:
230=head2 Hooks 493=head2 Hooks
231 494
232The following subroutines can be declared in extension files, and will be 495The following subroutines can be declared in extension files, and will be
233called whenever the relevant event happens. 496called whenever the relevant event happens.
234 497
235The first argument passed to them is an extension oject as described in 498The first argument passed to them is an extension object as described in
236the in the C<Extension Objects> section. 499the in the C<Extension Objects> section.
237 500
238B<All> of these hooks must return a boolean value. If it is true, then the 501B<All> of these hooks must return a boolean value. If any of the called
239event counts as being I<consumed>, and the invocation of other hooks is 502hooks returns true, then the event counts as being I<consumed>, and the
240skipped, and the relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
241 504
242I<< When in doubt, return a false value (preferably C<()>). >> 505I<< When in doubt, return a false value (preferably C<()>). >>
243 506
244=over 4 507=over 4
245 508
246=item on_init $term 509=item on_init $term
247 510
248Called after a new terminal object has been initialized, but before 511Called after a new terminal object has been initialized, but before
249windows are created or the command gets run. Most methods are unsafe to 512windows are created or the command gets run. Most methods are unsafe to
250call or deliver senseless data, as terminal size and other characteristics 513call or deliver senseless data, as terminal size and other characteristics
251have not yet been determined. You can safely query and change resources, 514have not yet been determined. You can safely query and change resources
252though. 515and options, though. For many purposes the C<on_start> hook is a better
516place.
517
518=item on_start $term
519
520Called at the very end of initialisation of a new terminal, just before
521trying to map (display) the toplevel and returning to the main loop.
522
523=item on_destroy $term
524
525Called whenever something tries to destroy terminal, when the terminal is
526still fully functional (not for long, though).
253 527
254=item on_reset $term 528=item on_reset $term
255 529
256Called after the screen is "reset" for any reason, such as resizing or 530Called after the screen is "reset" for any reason, such as resizing or
257control sequences. Here is where you can react on changes to size-related 531control sequences. Here is where you can react on changes to size-related
258variables. 532variables.
259 533
260=item on_start $term 534=item on_child_start $term, $pid
261 535
262Called at the very end of initialisation of a new terminal, just before 536Called just after the child process has been C<fork>ed.
263returning to the mainloop. 537
538=item on_child_exit $term, $status
539
540Called just after the child process has exited. C<$status> is the status
541from C<waitpid>.
264 542
265=item on_sel_make $term, $eventtime 543=item on_sel_make $term, $eventtime
266 544
267Called whenever a selection has been made by the user, but before the 545Called whenever a selection has been made by the user, but before the
268selection text is copied, so changes to the beginning, end or type of the 546selection text is copied, so changes to the beginning, end or type of the
275 553
276Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
277requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
278by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
279 557
280Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
281 559
282=item on_sel_extend $term 560=item on_sel_extend $term
283 561
284Called whenever the user tries to extend the selection (e.g. with a double 562Called whenever the user tries to extend the selection (e.g. with a double
285click) and is either supposed to return false (normal operation), or 563click) and is either supposed to return false (normal operation), or
286should extend the selection itelf and return true to suppress the built-in 564should extend the selection itself and return true to suppress the built-in
287processing. This can happen multiple times, as long as the callback 565processing. This can happen multiple times, as long as the callback
288returns true, it will be called on every further click by the user and is 566returns true, it will be called on every further click by the user and is
289supposed to enlarge the selection more and more, if possible. 567supposed to enlarge the selection more and more, if possible.
290 568
291See the F<selection> example extension. 569See the F<selection> example extension.
292 570
293=item on_view_change $term, $offset 571=item on_view_change $term, $offset
294 572
295Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
296scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
297show this many lines of scrollback. 575show this many lines of scrollback.
298 576
299=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
300 578
304 582
305It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 583It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
306$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 584$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
307number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
308 586
309=item on_osc_seq $term, $string 587=item on_osc_seq $term, $op, $args, $resp
588
589Called on every OSC sequence and can be used to suppress it or modify its
590behaviour. The default should be to return an empty list. A true value
591suppresses execution of the request completely. Make sure you don't get
592confused by recursive invocations when you output an OSC sequence within
593this callback.
594
595C<on_osc_seq_perl> should be used for new behaviour.
596
597=item on_osc_seq_perl $term, $args, $resp
310 598
311Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
312operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
313information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
314string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
315it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
316future. 604enforced in the future.
605
606For example, C<overlay-osc> uses this:
607
608 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_;
610
611 return unless $osc =~ s/^overlay;//;
612
613 ... process remaining $osc string
614 }
317 615
318Be careful not ever to trust (in a security sense) the data you receive, 616Be careful not ever to trust (in a security sense) the data you receive,
319as its source can not easily be controleld (e-mail content, messages from 617as its source can not easily be controlled (e-mail content, messages from
320other users on the same system etc.). 618other users on the same system etc.).
619
620For responses, C<$resp> contains the end-of-args separator used by the
621sender.
321 622
322=item on_add_lines $term, $string 623=item on_add_lines $term, $string
323 624
324Called whenever text is about to be output, with the text as argument. You 625Called whenever text is about to be output, with the text as argument. You
325can filter/change and output the text yourself by returning a true value 626can filter/change and output the text yourself by returning a true value
330=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
331 632
332Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
333suppress or filter tty input. 634suppress or filter tty input.
334 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
335=item on_line_update $term, $row 643=item on_line_update $term, $row
336 644
337Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
338screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
339that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
346later with the already-modified line (e.g. if unrelated parts change), so 654later with the already-modified line (e.g. if unrelated parts change), so
347you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
348 656
349=item on_refresh_begin $term 657=item on_refresh_begin $term
350 658
351Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
352or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
353restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
354code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
355 663
356=item on_refresh_end $term 664=item on_refresh_end $term
357 665
358Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
359 667
360=item on_keyboard_command $term, $string 668=item on_user_command $term, $string
361 669
362Called whenever the user presses a key combination that has a 670Called whenever a user-configured event is being activated (e.g. via
363C<perl:string> action bound to it (see description of the B<keysym> 671a C<perl:string> action bound to a key, see description of the B<keysym>
364resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
673
674The event is simply the action string. This interface is assumed to change
675slightly in the future.
676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
684=item on_resize_all_windows $term, $new_width, $new_height
685
686Called just after the new window size has been calculated, but before
687windows are actually being resized or hints are being set. If this hook
688returns TRUE, setting of the window hints is being skipped.
689
690=item on_x_event $term, $event
691
692Called on every X event received on the vt window (and possibly other
693windows). Should only be used as a last resort. Most event structure
694members are not passed.
695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
365 699
366=item on_focus_in $term 700=item on_focus_in $term
367 701
368Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
369does focus in processing. 703does focus in processing.
370 704
371=item on_focus_out $term 705=item on_focus_out $term
372 706
373Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
374focus out processing. 708focus out processing.
375 709
710=item on_configure_notify $term, $event
711
712=item on_property_notify $term, $event
713
376=item on_key_press $term, $event, $keysym, $octets 714=item on_key_press $term, $event, $keysym, $octets
377 715
378=item on_key_release $term, $event, $keysym 716=item on_key_release $term, $event, $keysym
379 717
380=item on_button_press $term, $event 718=item on_button_press $term, $event
385 723
386=item on_map_notify $term, $event 724=item on_map_notify $term, $event
387 725
388=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
389 727
390Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
391the hook returns true, then the even will be ignored by rxvt-unicode. 729the hook returns true, then the event will be ignored by rxvt-unicode.
392 730
393The event is a hash with most values as named by Xlib (see the XEvent 731The event is a hash with most values as named by Xlib (see the XEvent
394manpage), with the additional members C<row> and C<col>, which are the row 732manpage), with the additional members C<row> and C<col>, which are the
395and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
396 734
397C<on_key_press> additionally receives the string rxvt-unicode would 735C<on_key_press> additionally receives the string rxvt-unicode would
398output, if any, in locale-specific encoding. 736output, if any, in locale-specific encoding.
399 737
400subwindow. 738subwindow.
739
740=item on_client_message $term, $event
741
742=item on_wm_protocols $term, $event
743
744=item on_wm_delete_window $term, $event
745
746Called when various types of ClientMessage events are received (all with
747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
748
749=item on_bell $term
750
751Called on receipt of a bell character.
401 752
402=back 753=back
403 754
404=cut 755=cut
405 756
411use Scalar::Util (); 762use Scalar::Util ();
412use List::Util (); 763use List::Util ();
413 764
414our $VERSION = 1; 765our $VERSION = 1;
415our $TERM; 766our $TERM;
767our @TERM_INIT;
768our @TERM_EXT;
416our @HOOKNAME; 769our @HOOKNAME;
417our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
418our %OPTION; 771our %OPTION;
419 772
420our $LIBDIR; 773our $LIBDIR;
421our $RESNAME; 774our $RESNAME;
422our $RESCLASS; 775our $RESCLASS;
423our $RXVTNAME; 776our $RXVTNAME;
424 777
778our $NOCHAR = chr 0xffff;
779
425=head2 Variables in the C<urxvt> Package 780=head2 Variables in the C<urxvt> Package
426 781
427=over 4 782=over 4
428 783
429=item $urxvt::LIBDIR 784=item $urxvt::LIBDIR
442=item $urxvt::TERM 797=item $urxvt::TERM
443 798
444The current terminal. This variable stores the current C<urxvt::term> 799The current terminal. This variable stores the current C<urxvt::term>
445object, whenever a callback/hook is executing. 800object, whenever a callback/hook is executing.
446 801
802=item @urxvt::TERM_INIT
803
804All code references in this array will be called as methods of the next newly
805created C<urxvt::term> object (during the C<on_init> phase). The array
806gets cleared before the code references that were in it are being executed,
807so references can push themselves onto it again if they so desire.
808
809This complements to the perl-eval command line option, but gets executed
810first.
811
812=item @urxvt::TERM_EXT
813
814Works similar to C<@TERM_INIT>, but contains perl package/class names, which
815get registered as normal extensions after calling the hooks in C<@TERM_INIT>
816but before other extensions. Gets cleared just like C<@TERM_INIT>.
817
447=back 818=back
448 819
449=head2 Functions in the C<urxvt> Package 820=head2 Functions in the C<urxvt> Package
450 821
451=over 4 822=over 4
452 823
453=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
454 825
455Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
456costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
457starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
458 830
459=item urxvt::warn $string 831=item urxvt::warn $string
460 832
461Calls C<rxvt_warn> with the given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
462newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
463that calls this function. 835that calls this function.
464 836
465Using this function has the advantage that its output ends up in the 837Using this function has the advantage that its output ends up in the
466correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
467 839
468Messages have a size limit of 1023 bytes currently. 840Messages have a size limit of 1023 bytes currently.
469 841
470=item $is_safe = urxvt::safe 842=item @terms = urxvt::termlist
471 843
472Returns true when it is safe to do potentially unsafe things, such as 844Returns all urxvt::term objects that exist in this process, regardless of
473evaluating perl code specified by the user. This is true when urxvt was 845whether they are started, being destroyed etc., so be careful. Only term
474started setuid or setgid. 846objects that have perl extensions attached will be returned (because there
847is no urxvt::term object associated with others).
475 848
476=item $time = urxvt::NOW 849=item $time = urxvt::NOW
477 850
478Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
479 852
480=item urxvt::CurrentTime 853=item urxvt::CurrentTime
481 854
482=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 855=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
483Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 856Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
484Button4Mask, Button5Mask, AnyModifier 857Button4Mask, Button5Mask, AnyModifier
858
859=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
860ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
861PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
862Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
863KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
864ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
865FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
866
867=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
868EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
869GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
870UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
871ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
872CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
873SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
485 874
486Various constants for use in X calls and event processing. 875Various constants for use in X calls and event processing.
487 876
488=back 877=back
489 878
506 895
507=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
508 897
509Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
510 899
511=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
512 902
513Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
514underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
515the bitset. 905the bitset.
516 906
522 912
523=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 913=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
524 914
525=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 915=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
526 916
917=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
918
527Replace the foreground/background colour in the rendition mask with the 919Replace the foreground/background colour in the rendition mask with the
528specified one. 920specified one.
529 921
530=item $value = urxvt::GET_CUSTOM $rend 922=item $value = urxvt::GET_CUSTOM $rend
531 923
540=back 932=back
541 933
542=cut 934=cut
543 935
544BEGIN { 936BEGIN {
545 urxvt->bootstrap;
546
547 # overwrite perl's warn 937 # overwrite perl's warn
548 *CORE::GLOBAL::warn = sub { 938 *CORE::GLOBAL::warn = sub {
549 my $msg = join "", @_; 939 my $msg = join "", @_;
550 $msg .= "\n" 940 $msg .= "\n"
551 unless $msg =~ /\n$/; 941 unless $msg =~ /\n$/;
552 urxvt::warn ($msg); 942 urxvt::warn ($msg);
553 }; 943 };
554
555 # %ENV is the original startup environment
556 delete $ENV{IFS};
557 delete $ENV{CDPATH};
558 delete $ENV{BASH_ENV};
559 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
560} 944}
561 945
562my @hook_count; 946no warnings 'utf8';
947
948sub parse_resource {
949 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 warn "resourece<@_>\n";#d#
954
955 my $r = $term->{meta}{resource};
956 while (my ($pattern, $v) = each %$r) {
957 $name =~ y/-/./ if $isarg;
958
959 if (
960 $pattern =~ s/\*$//
961 ? $pattern eq substr $name, 0, length $pattern
962 : $pattern eq $name
963 ) {
964 $name = "$urxvt::RESCLASS.$name";
965 warn "set option <$name=$value>\n";#d#
966 #TODO: queue $v->[0] for loading
967 if ($v->[1] eq "boolean") {
968 $term->put_option_db ($name, $flag ? "true" : "false");
969 return 1;
970 } else {
971 $term->put_option_db ($name, $value);
972 return 1 + 2;
973 }
974 }
975 }
976
977 0
978}
979
980sub usage {
981 my ($term, $usage_type) = @_;
982
983 $term->scan_meta;
984
985 my $r = $term->{meta}{resource};
986
987 for my $pattern (sort keys %$r) {
988 my ($ext, $type, $desc) = @{ $r->{$pattern} };
989
990 $desc .= " (-pe $ext)";
991
992 if ($usage_type == 1) {
993 $pattern =~ y/./-/;
994 $pattern =~ s/\*/.../g;
995
996 if ($type eq "boolean") {
997 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
998 } else {
999 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
1000 }
1001 } else {
1002 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1003 }
1004 }
1005}
1006
563my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1007my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
564 1008
565sub verbose { 1009sub verbose {
566 my ($level, $msg) = @_; 1010 my ($level, $msg) = @_;
567 warn "$msg\n" if $level <= $verbosity; 1011 warn "$msg\n" if $level <= $verbosity;
568} 1012}
569 1013
570my $extension_pkg = "extension0000";
571my %extension_pkg; 1014my %extension_pkg;
572 1015
573# load a single script into its own package, once only 1016# load a single script into its own package, once only
574sub extension_package($) { 1017sub extension_package($) {
575 my ($path) = @_; 1018 my ($path) = @_;
576 1019
577 $extension_pkg{$path} ||= do { 1020 $extension_pkg{$path} ||= do {
578 my $pkg = "urxvt::" . ($extension_pkg++); 1021 $path =~ /([^\/\\]+)$/;
1022 my $pkg = $1;
1023 $pkg =~ s/[^[:word:]]/_/g;
1024 $pkg = "urxvt::ext::$pkg";
579 1025
580 verbose 3, "loading extension '$path' into package '$pkg'"; 1026 verbose 3, "loading extension '$path' into package '$pkg'";
581 1027
582 open my $fh, "<:raw", $path 1028 open my $fh, "<:raw", $path
583 or die "$path: $!"; 1029 or die "$path: $!";
584 1030
585 my $source = untaint 1031 my $source =
586 "package $pkg; use strict; use utf8;\n" 1032 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
587 . "use base urxvt::term::extension::;\n"
588 . "#line 1 \"$path\"\n{\n" 1033 . "#line 1 \"$path\"\n{\n"
589 . (do { local $/; <$fh> }) 1034 . (do { local $/; <$fh> })
590 . "\n};\n1"; 1035 . "\n};\n1";
591 1036
592 eval $source 1037 eval $source
602sub invoke { 1047sub invoke {
603 local $TERM = shift; 1048 local $TERM = shift;
604 my $htype = shift; 1049 my $htype = shift;
605 1050
606 if ($htype == 0) { # INIT 1051 if ($htype == 0) { # INIT
607 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1052 my @dirs = $TERM->perl_libdirs;
608 1053
609 my %ext_arg; 1054 my %ext_arg;
610 1055
1056 {
1057 my @init = @TERM_INIT;
1058 @TERM_INIT = ();
1059 $_->($TERM) for @init;
1060 my @pkg = @TERM_EXT;
1061 @TERM_EXT = ();
1062 $TERM->register_package ($_) for @pkg;
1063 }
1064
611 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1065 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
612 if ($_ eq "default") { 1066 if ($_ eq "default") {
613 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 1067 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
614 } elsif (/^-(.*)$/) { 1068 } elsif (/^-(.*)$/) {
615 delete $ext_arg{$1}; 1069 delete $ext_arg{$1};
616 } elsif (/^([^<]+)<(.*)>$/) { 1070 } elsif (/^([^<]+)<(.*)>$/) {
617 push @{ $ext_arg{$1} }, $2; 1071 push @{ $ext_arg{$1} }, $2;
618 } else { 1072 } else {
619 $ext_arg{$_} ||= []; 1073 $ext_arg{$_} ||= [];
620 } 1074 }
621 } 1075 }
622 1076
623 while (my ($ext, $argv) = each %ext_arg) { 1077 for my $ext (sort keys %ext_arg) {
624 my @files = grep -f $_, map "$_/$ext", @dirs; 1078 my @files = grep -f $_, map "$_/$ext", @dirs;
625 1079
626 if (@files) { 1080 if (@files) {
627 $TERM->register_package (extension_package $files[0], $argv); 1081 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
628 } else { 1082 } else {
629 warn "perl extension '$ext' not found in perl library search path\n"; 1083 warn "perl extension '$ext' not found in perl library search path\n";
630 } 1084 }
631 } 1085 }
632 1086
638 1092
639 if (my $cb = $TERM->{_hook}[$htype]) { 1093 if (my $cb = $TERM->{_hook}[$htype]) {
640 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1094 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
641 if $verbosity >= 10; 1095 if $verbosity >= 10;
642 1096
643 keys %$cb; 1097 for my $pkg (keys %$cb) {
644
645 while (my ($pkg, $cb) = each %$cb) {
646 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 1098 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
647 and last; 1099 $retval ||= $retval_;
648 1100
649 if ($@) { 1101 if ($@) {
650 $TERM->ungrab; # better to lose the grab than the session 1102 $TERM->ungrab; # better to lose the grab than the session
651 warn $@; 1103 warn $@;
652 } 1104 }
655 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 1107 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
656 if $verbosity >= 11; 1108 if $verbosity >= 11;
657 } 1109 }
658 1110
659 if ($htype == 1) { # DESTROY 1111 if ($htype == 1) { # DESTROY
660 if (my $hook = delete $TERM->{_hook}) {
661 for my $htype (0..$#$hook) {
662 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
663 or set_should_invoke $htype, 0;
664 }
665 }
666
667 # clear package objects 1112 # clear package objects
668 %$_ = () for values %{ $TERM->{_pkg} }; 1113 %$_ = () for values %{ $TERM->{_pkg} };
669 1114
670 # clear package 1115 # clear package
671 %$TERM = (); 1116 %$TERM = ();
672 } 1117 }
673 1118
674 $retval 1119 $retval
675} 1120}
676 1121
677sub exec_async(@) { 1122sub SET_COLOR($$$) {
678 my $pid = fork; 1123 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1124}
679 1125
680 return 1126sub rend2mask {
681 if !defined $pid or $pid; 1127 no strict 'refs';
682 1128 my ($str, $mask) = (@_, 0);
683 %ENV = %{ $TERM->env }; 1129 my %color = ( fg => undef, bg => undef );
684 1130 my @failed;
685 exec @_; 1131 for my $spec ( split /\s+/, $str ) {
686 _exit 255; 1132 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1133 $color{lc($1)} = $2;
1134 } else {
1135 my $neg = $spec =~ s/^[-^]//;
1136 unless ( exists &{"RS_$spec"} ) {
1137 push @failed, $spec;
1138 next;
1139 }
1140 my $cur = &{"RS_$spec"};
1141 if ( $neg ) {
1142 $mask &= ~$cur;
1143 } else {
1144 $mask |= $cur;
1145 }
1146 }
1147 }
1148 ($mask, @color{qw(fg bg)}, \@failed)
687} 1149}
688 1150
689# urxvt::term::extension 1151# urxvt::term::extension
690 1152
691package urxvt::term::extension; 1153package urxvt::term::extension;
697 while (my ($name, $cb) = each %hook) { 1159 while (my ($name, $cb) = each %hook) {
698 my $htype = $HOOKTYPE{uc $name}; 1160 my $htype = $HOOKTYPE{uc $name};
699 defined $htype 1161 defined $htype
700 or Carp::croak "unsupported hook type '$name'"; 1162 or Carp::croak "unsupported hook type '$name'";
701 1163
1164 $self->set_should_invoke ($htype, +1)
702 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 1165 unless exists $self->{term}{_hook}[$htype]{$pkg};
703 $hook_count[$htype]++
704 or urxvt::set_should_invoke $htype, 1;
705 }
706 1166
707 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1167 $self->{term}{_hook}[$htype]{$pkg} = $cb;
708 } 1168 }
709} 1169}
710 1170
715 for my $name (@hook) { 1175 for my $name (@hook) {
716 my $htype = $HOOKTYPE{uc $name}; 1176 my $htype = $HOOKTYPE{uc $name};
717 defined $htype 1177 defined $htype
718 or Carp::croak "unsupported hook type '$name'"; 1178 or Carp::croak "unsupported hook type '$name'";
719 1179
1180 $self->set_should_invoke ($htype, -1)
720 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 1181 if delete $self->{term}{_hook}[$htype]{$pkg};
721 --$hook_count[$htype]
722 or urxvt::set_should_invoke $htype, 0;
723 }
724 } 1182 }
725} 1183}
726 1184
727our $AUTOLOAD; 1185our $AUTOLOAD;
728 1186
760=head2 The C<urxvt::anyevent> Class 1218=head2 The C<urxvt::anyevent> Class
761 1219
762The sole purpose of this class is to deliver an interface to the 1220The sole purpose of this class is to deliver an interface to the
763C<AnyEvent> module - any module using it will work inside urxvt without 1221C<AnyEvent> module - any module using it will work inside urxvt without
764further programming. The only exception is that you cannot wait on 1222further programming. The only exception is that you cannot wait on
765condition variables, but non-blocking condvar use is ok. What this means 1223condition variables, but non-blocking condvar use is ok.
766is that you cannot use blocking APIs, but the non-blocking variant should 1224
767work. 1225In practical terms this means is that you cannot use blocking APIs, but
1226the non-blocking variant should work.
768 1227
769=cut 1228=cut
770 1229
771our $VERSION = 1; 1230our $VERSION = '5.23';
772 1231
773$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1232$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
774push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1233push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
775 1234
776sub timer { 1235sub timer {
778 1237
779 my $cb = $arg{cb}; 1238 my $cb = $arg{cb};
780 1239
781 urxvt::timer 1240 urxvt::timer
782 ->new 1241 ->new
783 ->start (urxvt::NOW + $arg{after}) 1242 ->after ($arg{after}, $arg{interval})
784 ->cb (sub { 1243 ->cb ($arg{interval} ? $cb : sub {
785 $_[0]->stop; # need to cancel manually 1244 $_[0]->stop; # need to cancel manually
786 $cb->(); 1245 $cb->();
787 }) 1246 })
788} 1247}
789 1248
790sub io { 1249sub io {
791 my ($class, %arg) = @_; 1250 my ($class, %arg) = @_;
792 1251
793 my $cb = $arg{cb}; 1252 my $cb = $arg{cb};
1253 my $fd = fileno $arg{fh};
1254 defined $fd or $fd = $arg{fh};
794 1255
795 bless [$arg{fh}, urxvt::iow 1256 bless [$arg{fh}, urxvt::iow
796 ->new 1257 ->new
797 ->fd (fileno $arg{fh}) 1258 ->fd ($fd)
798 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1259 ->events (($arg{poll} =~ /r/ ? 1 : 0)
799 | ($arg{poll} =~ /w/ ? 2 : 0)) 1260 | ($arg{poll} =~ /w/ ? 2 : 0))
800 ->start 1261 ->start
801 ->cb (sub { 1262 ->cb ($cb)
802 $cb->(($_[1] & 1 ? 'r' : '')
803 . ($_[1] & 2 ? 'w' : ''));
804 })],
805 urxvt::anyevent:: 1263 ], urxvt::anyevent::
1264}
1265
1266sub idle {
1267 my ($class, %arg) = @_;
1268
1269 my $cb = $arg{cb};
1270
1271 urxvt::iw
1272 ->new
1273 ->start
1274 ->cb ($cb)
1275}
1276
1277sub child {
1278 my ($class, %arg) = @_;
1279
1280 my $cb = $arg{cb};
1281
1282 urxvt::pw
1283 ->new
1284 ->start ($arg{pid})
1285 ->cb (sub {
1286 $_[0]->stop; # need to cancel manually
1287 $cb->($_[0]->rpid, $_[0]->rstatus);
1288 })
806} 1289}
807 1290
808sub DESTROY { 1291sub DESTROY {
809 $_[0][1]->stop; 1292 $_[0][1]->stop;
810} 1293}
811 1294
812sub condvar { 1295# only needed for AnyEvent < 6 compatibility
813 bless \my $flag, urxvt::anyevent::condvar:: 1296sub one_event {
814}
815
816sub urxvt::anyevent::condvar::broadcast {
817 ${$_[0]}++;
818}
819
820sub urxvt::anyevent::condvar::wait {
821 unless (${$_[0]}) {
822 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1297 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
823 }
824} 1298}
825 1299
826package urxvt::term; 1300package urxvt::term;
827 1301
828=head2 The C<urxvt::term> Class 1302=head2 The C<urxvt::term> Class
833 1307
834# find on_xxx subs in the package and register them 1308# find on_xxx subs in the package and register them
835# as hooks 1309# as hooks
836sub register_package { 1310sub register_package {
837 my ($self, $pkg, $argv) = @_; 1311 my ($self, $pkg, $argv) = @_;
1312
1313 no strict 'refs';
1314
1315 urxvt::verbose 6, "register package $pkg to $self";
1316
1317 @{"$pkg\::ISA"} = urxvt::term::extension::;
838 1318
839 my $proxy = bless { 1319 my $proxy = bless {
840 _pkg => $pkg, 1320 _pkg => $pkg,
841 argv => $argv, 1321 argv => $argv,
842 }, $pkg; 1322 }, $pkg;
849 $proxy->enable ($name => $ref); 1329 $proxy->enable ($name => $ref);
850 } 1330 }
851 } 1331 }
852} 1332}
853 1333
1334sub perl_libdirs {
1335 map { split /:/ }
1336 $_[0]->resource ("perl_lib"),
1337 $ENV{URXVT_PERL_LIB},
1338 "$ENV{HOME}/.urxvt/ext",
1339 "$LIBDIR/perl"
1340}
1341
1342sub scan_meta {
1343 my ($self) = @_;
1344 my @libdirs = perl_libdirs $self;
1345
1346 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1347
1348 my %meta;
1349
1350 $self->{meta_libdirs} = join "\x00", @libdirs;
1351 $self->{meta} = \%meta;
1352
1353 for my $dir (reverse @libdirs) {
1354 opendir my $fh, $dir
1355 or next;
1356 for my $ext (readdir $fh) {
1357 $ext ne "."
1358 and $ext ne ".."
1359 and open my $fh, "<", "$dir/$ext"
1360 or next;
1361
1362 while (<$fh>) {
1363 if (/^#:META:X_RESOURCE:(.*)/) {
1364 my ($pattern, $type, $desc) = split /:/, $1;
1365 $pattern =~ s/^%\./$ext./g; # $$ in pattern == extension name
1366 if ($pattern =~ /[^a-zA-Z\*\.]/) {
1367 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1368 } else {
1369 $meta{resource}{$pattern} = [$ext, $type, $desc];
1370 }
1371 } elsif (/^\s*(?:#|$)/) {
1372 # skip other comments and empty lines
1373 } else {
1374 last; # stop parsing on first non-empty non-comment line
1375 }
1376 }
1377 }
1378 }
1379}
1380
854=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1381=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
855 1382
856Creates a new terminal, very similar as if you had started it with system 1383Creates a new terminal, very similar as if you had started it with system
857C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1384C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
858hash which defines the environment of the new terminal. 1385hash which defines the environment of the new terminal.
859 1386
860Croaks (and probably outputs an error message) if the new instance 1387Croaks (and probably outputs an error message) if the new instance
861couldn't be created. Returns C<undef> if the new instance didn't 1388couldn't be created. Returns C<undef> if the new instance didn't
862initialise perl, and the terminal object otherwise. The C<init> and 1389initialise perl, and the terminal object otherwise. The C<init> and
863C<start> hooks will be called during this call. 1390C<start> hooks will be called before this call returns, and are free to
1391refer to global data (which is race free).
864 1392
865=cut 1393=cut
866 1394
867sub new { 1395sub new {
868 my ($class, $env, @args) = @_; 1396 my ($class, $env, @args) = @_;
869 1397
1398 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1399 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1400
870 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1401 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
871} 1402}
872 1403
873=item $term->destroy 1404=item $term->destroy
874 1405
875Destroy the terminal object (close the window, free resources 1406Destroy the terminal object (close the window, free resources
876etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1407etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
877watchers (timers, io watchers) are still active. 1408watchers (timers, io watchers) are still active.
878 1409
1410=item $term->exec_async ($cmd[, @args])
1411
1412Works like the combination of the C<fork>/C<exec> builtins, which executes
1413("starts") programs in the background. This function takes care of setting
1414the user environment before exec'ing the command (e.g. C<PATH>) and should
1415be preferred over explicit calls to C<exec> or C<system>.
1416
1417Returns the pid of the subprocess or C<undef> on error.
1418
1419=cut
1420
1421sub exec_async {
1422 my $self = shift;
1423
1424 my $pid = fork;
1425
1426 return $pid
1427 if !defined $pid or $pid;
1428
1429 %ENV = %{ $self->env };
1430
1431 exec @_;
1432 urxvt::_exit 255;
1433}
1434
879=item $isset = $term->option ($optval[, $set]) 1435=item $isset = $term->option ($optval[, $set])
880 1436
881Returns true if the option specified by C<$optval> is enabled, and 1437Returns true if the option specified by C<$optval> is enabled, and
882optionally change it. All option values are stored by name in the hash 1438optionally change it. All option values are stored by name in the hash
883C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1439C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
884 1440
885Here is a a likely non-exhaustive list of option names, please see the 1441Here is a likely non-exhaustive list of option names, please see the
886source file F</src/optinc.h> to see the actual list: 1442source file F</src/optinc.h> to see the actual list:
887 1443
888 borderLess console cursorBlink cursorUnderline hold iconic insecure 1444 borderLess buffered console cursorBlink cursorUnderline hold iconic
889 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1445 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1446 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
890 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1447 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
891 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1448 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
892 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1449 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
893 tripleclickwords utmpInhibit visualBell 1450 urgentOnBell utmpInhibit visualBell
894 1451
895=item $value = $term->resource ($name[, $newval]) 1452=item $value = $term->resource ($name[, $newval])
896 1453
897Returns the current resource value associated with a given name and 1454Returns the current resource value associated with a given name and
898optionally sets a new value. Setting values is most useful in the C<init> 1455optionally sets a new value. Setting values is most useful in the C<init>
907likely change). 1464likely change).
908 1465
909Please note that resource strings will currently only be freed when the 1466Please note that resource strings will currently only be freed when the
910terminal is destroyed, so changing options frequently will eat memory. 1467terminal is destroyed, so changing options frequently will eat memory.
911 1468
912Here is a a likely non-exhaustive list of resource names, not all of which 1469Here is a likely non-exhaustive list of resource names, not all of which
913are supported in every build, please see the source file F</src/rsinc.h> 1470are supported in every build, please see the source file F</src/rsinc.h>
914to see the actual list: 1471to see the actual list:
915 1472
916 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1473 answerbackstring backgroundPixmap backspace_key blendtype blurradius
917 borderLess color cursorBlink cursorUnderline cutchars delete_key 1474 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
918 display_name embed ext_bwidth fade font geometry hold iconName 1475 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
919 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1476 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1477 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
920 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1478 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
921 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1479 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
922 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1480 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
923 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1481 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
924 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1482 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
925 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1483 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
926 shade term_name title transparent transparent_all tripleclickwords 1484 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1485 term_name title transient_for transparent tripleclickwords urgentOnBell
927 utmpInhibit visualBell 1486 utmpInhibit visualBell
928 1487
929=cut 1488=cut
930 1489
931sub resource($$;$) { 1490sub resource($$;$) {
932 my ($self, $name) = (shift, shift); 1491 my ($self, $name) = (shift, shift);
933 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1492 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
934 &urxvt::term::_resource 1493 goto &urxvt::term::_resource
935} 1494}
936 1495
937=item $value = $term->x_resource ($pattern) 1496=item $value = $term->x_resource ($pattern)
938 1497
939Returns the X-Resource for the given pattern, excluding the program or 1498Returns the X-Resource for the given pattern, excluding the program or
943 1502
944This method should only be called during the C<on_start> hook, as there is 1503This method should only be called during the C<on_start> hook, as there is
945only one resource database per display, and later invocations might return 1504only one resource database per display, and later invocations might return
946the wrong resources. 1505the wrong resources.
947 1506
948=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1507=item $success = $term->parse_keysym ($key, $octets)
949 1508
950Adds a keymap translation exactly as specified via a resource. See the 1509Adds a key binding exactly as specified via a resource. See the
951C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1510C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1511
1512=item $term->register_command ($keysym, $modifiermask, $string)
1513
1514Adds a key binding. This is a lower level api compared to
1515C<parse_keysym>, as it expects a parsed key description, and can be
1516used only inside either the C<on_init> hook, to add a binding, or the
1517C<on_register_command> hook, to modify a parsed binding.
952 1518
953=item $rend = $term->rstyle ([$new_rstyle]) 1519=item $rend = $term->rstyle ([$new_rstyle])
954 1520
955Return and optionally change the current rendition. Text that is output by 1521Return and optionally change the current rendition. Text that is output by
956the terminal application will use this style. 1522the terminal application will use this style.
964 1530
965=item ($row, $col) = $term->selection_beg ([$row, $col]) 1531=item ($row, $col) = $term->selection_beg ([$row, $col])
966 1532
967=item ($row, $col) = $term->selection_end ([$row, $col]) 1533=item ($row, $col) = $term->selection_end ([$row, $col])
968 1534
969Return the current values of the selection mark, begin or end positions, 1535Return the current values of the selection mark, begin or end positions.
970and optionally set them to new values. 1536
1537When arguments are given, then the selection coordinates are set to
1538C<$row> and C<$col>, and the selection screen is set to the current
1539screen.
1540
1541=item $screen = $term->selection_screen ([$screen])
1542
1543Returns the current selection screen, and then optionally sets it.
971 1544
972=item $term->selection_make ($eventtime[, $rectangular]) 1545=item $term->selection_make ($eventtime[, $rectangular])
973 1546
974Tries to make a selection as set by C<selection_beg> and 1547Tries to make a selection as set by C<selection_beg> and
975C<selection_end>. If C<$rectangular> is true (default: false), a 1548C<selection_end>. If C<$rectangular> is true (default: false), a
976rectangular selection will be made. This is the prefered function to make 1549rectangular selection will be made. This is the preferred function to make
977a selection. 1550a selection.
978 1551
979=item $success = $term->selection_grab ($eventtime) 1552=item $success = $term->selection_grab ($eventtime[, $clipboard])
980 1553
981Try to request the primary selection text from the server (for example, as 1554Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1555true) selection from the server. The corresponding text can be set
982set by the next method). No visual feedback will be given. This function 1556with the next method. No visual feedback will be given. This function
983is mostly useful from within C<on_sel_grab> hooks. 1557is mostly useful from within C<on_sel_grab> hooks.
984 1558
985=item $oldtext = $term->selection ([$newtext]) 1559=item $oldtext = $term->selection ([$newtext, $clipboard])
986 1560
987Return the current selection text and optionally replace it by C<$newtext>. 1561Return the current selection (clipboard if C<$clipboard> is true) text
1562and optionally replace it by C<$newtext>.
1563
1564=item $term->selection_clear ([$clipboard])
1565
1566Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
988 1567
989=item $term->overlay_simple ($x, $y, $text) 1568=item $term->overlay_simple ($x, $y, $text)
990 1569
991Create a simple multi-line overlay box. See the next method for details. 1570Create a simple multi-line overlay box. See the next method for details.
992 1571
1022 1601
1023The methods currently supported on C<urxvt::overlay> objects are: 1602The methods currently supported on C<urxvt::overlay> objects are:
1024 1603
1025=over 4 1604=over 4
1026 1605
1027=item $overlay->set ($x, $y, $text, $rend) 1606=item $overlay->set ($x, $y, $text[, $rend])
1028 1607
1029Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1608Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1030text in rxvt-unicode's special encoding and an array of rendition values 1609text in rxvt-unicode's special encoding and an array of rendition values
1031at a specific position inside the overlay. 1610at a specific position inside the overlay.
1611
1612If C<$rend> is missing, then the rendition will not be changed.
1032 1613
1033=item $overlay->hide 1614=item $overlay->hide
1034 1615
1035If visible, hide the overlay, but do not destroy it. 1616If visible, hide the overlay, but do not destroy it.
1036 1617
1106 1687
1107Normally its not a good idea to use this function, as programs might be 1688Normally its not a good idea to use this function, as programs might be
1108confused by changes in cursor position or scrolling. Its useful inside a 1689confused by changes in cursor position or scrolling. Its useful inside a
1109C<on_add_lines> hook, though. 1690C<on_add_lines> hook, though.
1110 1691
1692=item $term->scr_change_screen ($screen)
1693
1694Switch to given screen - 0 primary, 1 secondary.
1695
1111=item $term->cmd_parse ($octets) 1696=item $term->cmd_parse ($octets)
1112 1697
1113Similar to C<scr_add_lines>, but the argument must be in the 1698Similar to C<scr_add_lines>, but the argument must be in the
1114locale-specific encoding of the terminal and can contain command sequences 1699locale-specific encoding of the terminal and can contain command sequences
1115(escape codes) that will be interpreted. 1700(escape codes) that will be interpreted.
1116 1701
1117=item $term->tt_write ($octets) 1702=item $term->tt_write ($octets)
1118 1703
1119Write the octets given in C<$data> to the tty (i.e. as program input). To 1704Write the octets given in C<$octets> to the tty (i.e. as program input). To
1120pass characters instead of octets, you should convert your strings first 1705pass characters instead of octets, you should convert your strings first
1121to the locale-specific encoding using C<< $term->locale_encode >>. 1706to the locale-specific encoding using C<< $term->locale_encode >>.
1707
1708=item $term->tt_paste ($octets)
1709
1710Write the octets given in C<$octets> to the tty as a paste, converting NL to
1711CR and bracketing the data with control sequences if bracketed paste mode
1712is set.
1122 1713
1123=item $old_events = $term->pty_ev_events ([$new_events]) 1714=item $old_events = $term->pty_ev_events ([$new_events])
1124 1715
1125Replaces the event mask of the pty watcher by the given event mask. Can 1716Replaces the event mask of the pty watcher by the given event mask. Can
1126be used to suppress input and output handling to the pty/tty. See the 1717be used to suppress input and output handling to the pty/tty. See the
1127description of C<< urxvt::timer->events >>. Make sure to always restore 1718description of C<< urxvt::timer->events >>. Make sure to always restore
1128the previous value. 1719the previous value.
1129 1720
1721=item $fd = $term->pty_fd
1722
1723Returns the master file descriptor for the pty in use, or C<-1> if no pty
1724is used.
1725
1130=item $windowid = $term->parent 1726=item $windowid = $term->parent
1131 1727
1132Return the window id of the toplevel window. 1728Return the window id of the toplevel window.
1133 1729
1134=item $windowid = $term->vt 1730=item $windowid = $term->vt
1135 1731
1136Return the window id of the terminal window. 1732Return the window id of the terminal window.
1137 1733
1734=item $term->vt_emask_add ($x_event_mask)
1735
1736Adds the specified events to the vt event mask. Useful e.g. when you want
1737to receive pointer events all the times:
1738
1739 $term->vt_emask_add (urxvt::PointerMotionMask);
1740
1741=item $term->set_urgency ($set)
1742
1743Enable/disable the urgency hint on the toplevel window.
1744
1745=item $term->focus_in
1746
1747=item $term->focus_out
1748
1749=item $term->key_press ($state, $keycode[, $time])
1750
1751=item $term->key_release ($state, $keycode[, $time])
1752
1753Deliver various fake events to to terminal.
1754
1138=item $window_width = $term->width 1755=item $window_width = $term->width
1139 1756
1140=item $window_height = $term->height 1757=item $window_height = $term->height
1141 1758
1142=item $font_width = $term->fwidth 1759=item $font_width = $term->fwidth
1155 1772
1156=item $max_scrollback = $term->saveLines 1773=item $max_scrollback = $term->saveLines
1157 1774
1158=item $nrow_plus_saveLines = $term->total_rows 1775=item $nrow_plus_saveLines = $term->total_rows
1159 1776
1160=item $lines_in_scrollback = $term->nsaved 1777=item $topmost_scrollback_row = $term->top_row
1161 1778
1162Return various integers describing terminal characteristics. 1779Return various integers describing terminal characteristics.
1163 1780
1164=item $x_display = $term->display_id 1781=item $x_display = $term->display_id
1165 1782
1172=item $env = $term->env 1789=item $env = $term->env
1173 1790
1174Returns a copy of the environment in effect for the terminal as a hashref 1791Returns a copy of the environment in effect for the terminal as a hashref
1175similar to C<\%ENV>. 1792similar to C<\%ENV>.
1176 1793
1794=item @envv = $term->envv
1795
1796Returns the environment as array of strings of the form C<VAR=VALUE>.
1797
1798=item @argv = $term->argv
1799
1800Return the argument vector as this terminal, similar to @ARGV, but
1801includes the program name as first element.
1802
1177=cut 1803=cut
1178 1804
1179sub env { 1805sub env {
1180 if (my $env = $_[0]->_env) {
1181 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1806 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1182 } else {
1183 +{ %ENV }
1184 }
1185} 1807}
1186 1808
1187=item $modifiermask = $term->ModLevel3Mask 1809=item $modifiermask = $term->ModLevel3Mask
1188 1810
1189=item $modifiermask = $term->ModMetaMask 1811=item $modifiermask = $term->ModMetaMask
1191=item $modifiermask = $term->ModNumLockMask 1813=item $modifiermask = $term->ModNumLockMask
1192 1814
1193Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1815Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1194AltGr), the meta key (often Alt) and the num lock key, if applicable. 1816AltGr), the meta key (often Alt) and the num lock key, if applicable.
1195 1817
1818=item $screen = $term->current_screen
1819
1820Returns the currently displayed screen (0 primary, 1 secondary).
1821
1822=item $cursor_is_hidden = $term->hidden_cursor
1823
1824Returns whether the cursor is currently hidden or not.
1825
1196=item $view_start = $term->view_start ([$newvalue]) 1826=item $view_start = $term->view_start ([$newvalue])
1197 1827
1198Returns the negative row number of the topmost line. Minimum value is 1828Returns the row number of the topmost displayed line. Maximum value is
1199C<0>, which displays the normal terminal contents. Larger values scroll 1829C<0>, which displays the normal terminal contents. Lower values scroll
1200this many lines into the scrollback buffer. 1830this many lines into the scrollback buffer.
1201 1831
1202=item $term->want_refresh 1832=item $term->want_refresh
1203 1833
1204Requests a screen refresh. At the next opportunity, rxvt-unicode will 1834Requests a screen refresh. At the next opportunity, rxvt-unicode will
1207 1837
1208Used after changing terminal contents to display them. 1838Used after changing terminal contents to display them.
1209 1839
1210=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1840=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1211 1841
1212Returns the text of the entire row with number C<$row_number>. Row C<0> 1842Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1213is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1843is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1214terminal line. The scrollback buffer starts at line C<-1> and extends to
1215line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1844terminal line. Nothing will be returned if a nonexistent line
1216is requested. 1845is requested.
1217 1846
1218If C<$new_text> is specified, it will replace characters in the current 1847If C<$new_text> is specified, it will replace characters in the current
1219line, starting at column C<$start_col> (default C<0>), which is useful 1848line, starting at column C<$start_col> (default C<0>), which is useful
1220to replace only parts of a line. The font index in the rendition will 1849to replace only parts of a line. The font index in the rendition will
1221automatically be updated. 1850automatically be updated.
1222 1851
1223C<$text> is in a special encoding: tabs and wide characters that use more 1852C<$text> is in a special encoding: tabs and wide characters that use more
1224than one cell when displayed are padded with urxvt::NOCHAR characters 1853than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1225(C<chr 65535>). Characters with combining characters and other characters 1854characters. Characters with combining characters and other characters that
1226that do not fit into the normal tetx encoding will be replaced with 1855do not fit into the normal text encoding will be replaced with characters
1227characters in the private use area. 1856in the private use area.
1228 1857
1229You have to obey this encoding when changing text. The advantage is 1858You have to obey this encoding when changing text. The advantage is
1230that C<substr> and similar functions work on screen cells and not on 1859that C<substr> and similar functions work on screen cells and not on
1231characters. 1860characters.
1232 1861
1376where one character corresponds to one screen cell. See 2005where one character corresponds to one screen cell. See
1377C<< $term->ROW_t >> for details. 2006C<< $term->ROW_t >> for details.
1378 2007
1379=item $string = $term->special_decode $text 2008=item $string = $term->special_decode $text
1380 2009
1381Converts rxvt-unicodes text reprsentation into a perl string. See 2010Converts rxvt-unicodes text representation into a perl string. See
1382C<< $term->ROW_t >> for details. 2011C<< $term->ROW_t >> for details.
1383 2012
1384=item $success = $term->grab_button ($button, $modifiermask) 2013=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1385 2014
2015=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
2016
1386Registers a synchronous button grab. See the XGrabButton manpage. 2017Register/unregister a synchronous button grab. See the XGrabButton
2018manpage.
1387 2019
1388=item $success = $term->grab ($eventtime[, $sync]) 2020=item $success = $term->grab ($eventtime[, $sync])
1389 2021
1390Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 2022Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1391synchronous (C<$sync> is true). Also remembers the grab timestampe. 2023synchronous (C<$sync> is true). Also remembers the grab timestamp.
1392 2024
1393=item $term->allow_events_async 2025=item $term->allow_events_async
1394 2026
1395Calls XAllowEvents with AsyncBoth for the most recent grab. 2027Calls XAllowEvents with AsyncBoth for the most recent grab.
1396 2028
1403Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2035Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1404recent grab. 2036recent grab.
1405 2037
1406=item $term->ungrab 2038=item $term->ungrab
1407 2039
1408Calls XUngrab for the most recent grab. Is called automatically on 2040Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1409evaluation errors, as it is better to lose the grab in the error case as 2041evaluation errors, as it is better to lose the grab in the error case as
1410the session. 2042the session.
2043
2044=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
2045
2046=item $atom_name = $term->XGetAtomName ($atom)
2047
2048=item @atoms = $term->XListProperties ($window)
2049
2050=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
2051
2052=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
2053
2054=item $term->XDeleteProperty ($window, $property)
2055
2056=item $window = $term->DefaultRootWindow
2057
2058=item $term->XReparentWindow ($window, $parent, [$x, $y])
2059
2060=item $term->XMapWindow ($window)
2061
2062=item $term->XUnmapWindow ($window)
2063
2064=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
2065
2066=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
2067
2068=item $term->XChangeInput ($window, $add_events[, $del_events])
2069
2070=item $keysym = $term->XStringToKeysym ($string)
2071
2072=item $string = $term->XKeysymToString ($keysym)
2073
2074Various X or X-related functions. The C<$term> object only serves as
2075the source of the display, otherwise those functions map more-or-less
2076directly onto the X functions of the same name.
1411 2077
1412=back 2078=back
1413 2079
1414=cut 2080=cut
1415 2081
1479 my ($self, $text, $cb) = @_; 2145 my ($self, $text, $cb) = @_;
1480 2146
1481 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2147 $self->add_item ({ type => "button", text => $text, activate => $cb});
1482} 2148}
1483 2149
1484=item $popup->add_toggle ($text, $cb, $initial_value) 2150=item $popup->add_toggle ($text, $initial_value, $cb)
1485 2151
1486Adds a toggle/checkbox item to the popup. Teh callback gets called 2152Adds a toggle/checkbox item to the popup. The callback gets called
1487whenever it gets toggled, with a boolean indicating its value as its first 2153whenever it gets toggled, with a boolean indicating its new value as its
1488argument. 2154first argument.
1489 2155
1490=cut 2156=cut
1491 2157
1492sub add_toggle { 2158sub add_toggle {
1493 my ($self, $text, $cb, $value) = @_; 2159 my ($self, $text, $value, $cb) = @_;
1494 2160
1495 my $item; $item = { 2161 my $item; $item = {
1496 type => "button", 2162 type => "button",
1497 text => " $text", 2163 text => " $text",
1498 value => $value, 2164 value => $value,
1517 my $env = $self->{term}->env; 2183 my $env = $self->{term}->env;
1518 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2184 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1519 delete $env->{LC_ALL}; 2185 delete $env->{LC_ALL};
1520 $env->{LC_CTYPE} = $self->{term}->locale; 2186 $env->{LC_CTYPE} = $self->{term}->locale;
1521 2187
1522 urxvt::term->new ($env, $self->{term}->resource ("name"), 2188 my $term = urxvt::term->new (
1523 "--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 2189 $env, "popup",
2190 "--perl-lib" => "", "--perl-ext-common" => "",
2191 "-pty-fd" => -1, "-sl" => 0,
2192 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1524 "--transient-for" => $self->{term}->parent, 2193 "--transient-for" => $self->{term}->parent,
1525 "-display" => $self->{term}->display_id, 2194 "-display" => $self->{term}->display_id,
1526 "-pe" => "urxvt-popup") 2195 "-pe" => "urxvt-popup",
1527 or die "unable to create popup window\n"; 2196 ) or die "unable to create popup window\n";
2197
2198 unless (delete $term->{urxvt_popup_init_done}) {
2199 $term->ungrab;
2200 $term->destroy;
2201 die "unable to initialise popup window\n";
2202 }
1528} 2203}
1529 2204
1530sub DESTROY { 2205sub DESTROY {
1531 my ($self) = @_; 2206 my ($self) = @_;
1532 2207
1533 delete $self->{term}{_destroy}{$self}; 2208 delete $self->{term}{_destroy}{$self};
1534 $self->{term}->ungrab; 2209 $self->{term}->ungrab;
1535} 2210}
1536 2211
1537=back 2212=back
2213
2214=cut
2215
2216package urxvt::watcher;
1538 2217
1539=head2 The C<urxvt::timer> Class 2218=head2 The C<urxvt::timer> Class
1540 2219
1541This class implements timer watchers/events. Time is represented as a 2220This class implements timer watchers/events. Time is represented as a
1542fractional number of seconds since the epoch. Example: 2221fractional number of seconds since the epoch. Example:
1546 ->new 2225 ->new
1547 ->interval (1) 2226 ->interval (1)
1548 ->cb (sub { 2227 ->cb (sub {
1549 $term->{overlay}->set (0, 0, 2228 $term->{overlay}->set (0, 0,
1550 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2229 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1551 }); 2230 });
1552 2231
1553=over 4 2232=over 4
1554 2233
1555=item $timer = new urxvt::timer 2234=item $timer = new urxvt::timer
1556 2235
1559 2238
1560=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2239=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1561 2240
1562Set the callback to be called when the timer triggers. 2241Set the callback to be called when the timer triggers.
1563 2242
1564=item $tstamp = $timer->at
1565
1566Return the time this watcher will fire next.
1567
1568=item $timer = $timer->set ($tstamp) 2243=item $timer = $timer->set ($tstamp[, $interval])
1569 2244
1570Set the time the event is generated to $tstamp. 2245Set the time the event is generated to $tstamp (and optionally specifies a
2246new $interval).
1571 2247
1572=item $timer = $timer->interval ($interval) 2248=item $timer = $timer->interval ($interval)
1573 2249
1574Normally (and when C<$interval> is C<0>), the timer will automatically 2250By default (and when C<$interval> is C<0>), the timer will automatically
1575stop after it has fired once. If C<$interval> is non-zero, then the timer 2251stop after it has fired once. If C<$interval> is non-zero, then the timer
1576is automatically rescheduled at the given intervals. 2252is automatically rescheduled at the given intervals.
1577 2253
1578=item $timer = $timer->start 2254=item $timer = $timer->start
1579 2255
1580Start the timer. 2256Start the timer.
1581 2257
1582=item $timer = $timer->start ($tstamp) 2258=item $timer = $timer->start ($tstamp[, $interval])
1583 2259
1584Set the event trigger time to C<$tstamp> and start the timer. 2260Set the event trigger time to C<$tstamp> and start the timer. Optionally
2261also replaces the interval.
2262
2263=item $timer = $timer->after ($delay[, $interval])
2264
2265Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1585 2266
1586=item $timer = $timer->stop 2267=item $timer = $timer->stop
1587 2268
1588Stop the timer. 2269Stop the timer.
1589 2270
1595 2276
1596 $term->{socket} = ... 2277 $term->{socket} = ...
1597 $term->{iow} = urxvt::iow 2278 $term->{iow} = urxvt::iow
1598 ->new 2279 ->new
1599 ->fd (fileno $term->{socket}) 2280 ->fd (fileno $term->{socket})
1600 ->events (urxvt::EVENT_READ) 2281 ->events (urxvt::EV_READ)
1601 ->start 2282 ->start
1602 ->cb (sub { 2283 ->cb (sub {
1603 my ($iow, $revents) = @_; 2284 my ($iow, $revents) = @_;
1604 # $revents must be 1 here, no need to check 2285 # $revents must be 1 here, no need to check
1605 sysread $term->{socket}, my $buf, 8192 2286 sysread $term->{socket}, my $buf, 8192
1618Set the callback to be called when io events are triggered. C<$reventmask> 2299Set the callback to be called when io events are triggered. C<$reventmask>
1619is a bitset as described in the C<events> method. 2300is a bitset as described in the C<events> method.
1620 2301
1621=item $iow = $iow->fd ($fd) 2302=item $iow = $iow->fd ($fd)
1622 2303
1623Set the filedescriptor (not handle) to watch. 2304Set the file descriptor (not handle) to watch.
1624 2305
1625=item $iow = $iow->events ($eventmask) 2306=item $iow = $iow->events ($eventmask)
1626 2307
1627Set the event mask to watch. The only allowed values are 2308Set the event mask to watch. The only allowed values are
1628C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2309C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1629together, or C<urxvt::EVENT_NONE>. 2310together, or C<urxvt::EV_NONE>.
1630 2311
1631=item $iow = $iow->start 2312=item $iow = $iow->start
1632 2313
1633Start watching for requested events on the given handle. 2314Start watching for requested events on the given handle.
1634 2315
1635=item $iow = $iow->stop 2316=item $iow = $iow->stop
1636 2317
1637Stop watching for events on the given filehandle. 2318Stop watching for events on the given file handle.
2319
2320=back
2321
2322=head2 The C<urxvt::iw> Class
2323
2324This class implements idle watchers, that get called automatically when
2325the process is idle. They should return as fast as possible, after doing
2326some useful work.
2327
2328=over 4
2329
2330=item $iw = new urxvt::iw
2331
2332Create a new idle watcher object in stopped state.
2333
2334=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2335
2336Set the callback to be called when the watcher triggers.
2337
2338=item $timer = $timer->start
2339
2340Start the watcher.
2341
2342=item $timer = $timer->stop
2343
2344Stop the watcher.
2345
2346=back
2347
2348=head2 The C<urxvt::pw> Class
2349
2350This class implements process watchers. They create an event whenever a
2351process exits, after which they stop automatically.
2352
2353 my $pid = fork;
2354 ...
2355 $term->{pw} = urxvt::pw
2356 ->new
2357 ->start ($pid)
2358 ->cb (sub {
2359 my ($pw, $exit_status) = @_;
2360 ...
2361 });
2362
2363=over 4
2364
2365=item $pw = new urxvt::pw
2366
2367Create a new process watcher in stopped state.
2368
2369=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2370
2371Set the callback to be called when the timer triggers.
2372
2373=item $pw = $timer->start ($pid)
2374
2375Tells the watcher to start watching for process C<$pid>.
2376
2377=item $pw = $pw->stop
2378
2379Stop the watcher.
1638 2380
1639=back 2381=back
1640 2382
1641=head1 ENVIRONMENT 2383=head1 ENVIRONMENT
1642 2384
1651 2393
1652=item >= 3 - script loading and management 2394=item >= 3 - script loading and management
1653 2395
1654=item >=10 - all called hooks 2396=item >=10 - all called hooks
1655 2397
1656=item >=11 - hook reutrn values 2398=item >=11 - hook return values
1657 2399
1658=back 2400=back
1659 2401
1660=head1 AUTHOR 2402=head1 AUTHOR
1661 2403
1662 Marc Lehmann <pcg@goof.com> 2404 Marc Lehmann <schmorp@schmorp.de>
1663 http://software.schmorp.de/pkg/rxvt-unicode 2405 http://software.schmorp.de/pkg/rxvt-unicode
1664 2406
1665=cut 2407=cut
1666 2408
16671 24091
2410
2411# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines