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.106 by root, Wed Jan 18 19:44:22 2006 UTC vs.
Revision 1.217 by root, Sun Jun 10 13:58:05 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 "vars"' 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 following bindable keyboard commands: 85This extension also offers following bindable keyboard commands:
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.
93 124
94Other extensions can extend this popup menu by pushing a code reference onto 125Other extensions can extend this popup menu by pushing a code reference
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
96 128
97It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
99It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
101when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
102 134
103The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
105C<a>s: 137C<a>s:
106 138
107 push urxvt::ext::selection_popup::hook, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
109 : () 141 : ()
110 }; 142 };
111 143
112=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
113 145
120search. 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>
121search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
122bottom. 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
123was 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
124additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
125selection. 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.
126 189
127=item selection-autotransform 190=item selection-autotransform
128 191
129This selection allows you to do automatic transforms on a selection 192This selection allows you to do automatic transforms on a selection
130whenever a selection is made. 193whenever a selection is made.
143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144 207
145And 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
146paste directly into your (vi :) editor: 209paste directly into your (vi :) editor:
147 210
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149 212
150Of 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 :)
151 214
152To expand the example above to typical perl error messages ("XXX at 215To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution: 216FILENAME line YYY."), you need a slightly more elaborate solution:
154 217
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 219 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157 220
158The first line tells the selection code to treat the unchanging part of 221The first line tells the selection code to treat the unchanging part of
159every error message as a selection pattern, and the second line transforms 222every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file. 223the message into vi commands to load the file.
161 224
162=item mark-urls 225=item tabbed
163 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
164Uses per-line display filtering (C<on_line_update>) to underline urls and 250Uses per-line display filtering (C<on_line_update>) to underline text
165make them clickable. When middle-clicked, the program specified in the 251matching a certain pattern and make it clickable. When clicked with the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with 252mouse button specified in the C<matcher.button> resource (default 2, or
167the 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.
168 258
169=item automove-background 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.
170 263
171This is basically a one-line extension that dynamically changes the background pixmap offset 264It is possible to activate the most recently seen match or a list of matches
172to the window position, in effect creating the same effect as pseudo transparency with 265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
173a custom pixmap. No scaling is supported in this mode. Exmaple: 266"perl:matcher:list" as seen in the example below.
174 267
175 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 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.
176 315
177=item block-graphics-to-ascii 316=item block-graphics-to-ascii
178 317
179A 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
180by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
181similar-looking ascii character. 320similar-looking ascii character.
182 321
183=item digital-clock 322=item digital-clock
184 323
185Displays 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.
186 393
187=item example-refresh-hooks 394=item example-refresh-hooks
188 395
189Displays 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
190window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
191overlays or changes. 398overlays or changes.
192 399
193=item selection-pastebin 400=item confirm-paste
194 401
195This is a little rarely useful extension that Uploads the selection as 402Displays a confirmation dialog when a paste containing at least a full
196textfile to a remote site (or does other things). (The implementation is 403line is detected.
197not currently secure for use in a multiuser environment as it writes to
198F</tmp> directly.).
199 404
200It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 405=item bell-command
201i.e.
202 406
203 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin 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:
204 410
205Pressing this combination runs a command with C<%> replaced by the name of 411 URxvt.bell-command: notify-send "Beep, Beep"
206the textfile. This command can be set via a resource:
207
208 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
209
210And the default is likely not useful to anybody but the few people around
211here :)
212
213The name of the textfile is the hex encoded md5 sum of the selection, so
214the same content should lead to the same filename.
215
216After a successful upload the selection will be replaced by the text given
217in the C<selection-pastebin-url> resource (again, the % is the placeholder
218for the filename):
219
220 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
221 412
222=back 413=back
223 414
224=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
225 416
241 432
242=over 4 433=over 4
243 434
244=item $text 435=item $text
245 436
246Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
247always 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.
248 439
249=item $string 440=item $string
250 441
251A 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
255=item $octets 446=item $octets
256 447
257Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
258locale-specific way. 449locale-specific way.
259 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
260=back 457=back
261 458
262=head2 Extension Objects 459=head2 Extension Objects
263 460
264Very 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
265for 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,
266hooks. 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
267about 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
268begin with an underscore character C<_>: these are reserved for internal 466that begin with an underscore character C<_>: these are reserved for
269use. 467internal use.
270 468
271Although 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
272C<urxvt::term> class on this object. 470C<urxvt::term> class on this object.
273 471
274It has the following methods and data members: 472It has the following methods and data members:
295=head2 Hooks 493=head2 Hooks
296 494
297The following subroutines can be declared in extension files, and will be 495The following subroutines can be declared in extension files, and will be
298called whenever the relevant event happens. 496called whenever the relevant event happens.
299 497
300The 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
301the in the C<Extension Objects> section. 499the in the C<Extension Objects> section.
302 500
303B<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
304event 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
305skipped, and the relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
306 504
307I<< When in doubt, return a false value (preferably C<()>). >> 505I<< When in doubt, return a false value (preferably C<()>). >>
308 506
309=over 4 507=over 4
310 508
311=item on_init $term 509=item on_init $term
312 510
313Called after a new terminal object has been initialized, but before 511Called after a new terminal object has been initialized, but before
314windows 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
315call or deliver senseless data, as terminal size and other characteristics 513call or deliver senseless data, as terminal size and other characteristics
316have not yet been determined. You can safely query and change resources, 514have not yet been determined. You can safely query and change resources
317though. 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).
318 527
319=item on_reset $term 528=item on_reset $term
320 529
321Called 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
322control 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
323variables. 532variables.
324 533
325=item on_start $term 534=item on_child_start $term, $pid
326 535
327Called at the very end of initialisation of a new terminal, just before 536Called just after the child process has been C<fork>ed.
328returning 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>.
329 542
330=item on_sel_make $term, $eventtime 543=item on_sel_make $term, $eventtime
331 544
332Called 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
333selection 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
340 553
341Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
342requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
343by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
344 557
345Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
346 559
347=item on_sel_extend $term 560=item on_sel_extend $term
348 561
349Called 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
350click) and is either supposed to return false (normal operation), or 563click) and is either supposed to return false (normal operation), or
351should 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
352processing. This can happen multiple times, as long as the callback 565processing. This can happen multiple times, as long as the callback
353returns 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
354supposed to enlarge the selection more and more, if possible. 567supposed to enlarge the selection more and more, if possible.
355 568
356See the F<selection> example extension. 569See the F<selection> example extension.
357 570
358=item on_view_change $term, $offset 571=item on_view_change $term, $offset
359 572
360Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
361scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
362show this many lines of scrollback. 575show this many lines of scrollback.
363 576
364=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
365 578
369 582
370It 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,
371$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
372number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
373 586
374=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
375 598
376Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
377operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
378information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
379string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
380it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
381future. 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 }
382 615
383Be 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,
384as 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
385other 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.
386 622
387=item on_add_lines $term, $string 623=item on_add_lines $term, $string
388 624
389Called 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
390can 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
395=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
396 632
397Called 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
398suppress or filter tty input. 634suppress or filter tty input.
399 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
400=item on_line_update $term, $row 643=item on_line_update $term, $row
401 644
402Called 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
403screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
404that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
411later 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
412you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
413 656
414=item on_refresh_begin $term 657=item on_refresh_begin $term
415 658
416Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
417or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
418restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
419code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
420 663
421=item on_refresh_end $term 664=item on_refresh_end $term
422 665
423Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
424 667
425=item on_keyboard_command $term, $string 668=item on_user_command $term, $string
426 669
427Called whenever the user presses a key combination that has a 670Called whenever a user-configured event is being activated (e.g. via
428C<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>
429resource 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.
430 689
431=item on_x_event $term, $event 690=item on_x_event $term, $event
432 691
433Called on every X event received on the vt window (and possibly other 692Called on every X event received on the vt window (and possibly other
434windows). Should only be used as a last resort. Most event structure 693windows). Should only be used as a last resort. Most event structure
435members are not passed. 694members are not passed.
436 695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
699
437=item on_focus_in $term 700=item on_focus_in $term
438 701
439Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
440does focus in processing. 703does focus in processing.
441 704
442=item on_focus_out $term 705=item on_focus_out $term
443 706
444Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
445focus out processing. 708focus out processing.
446 709
447=item on_configure_notify $term, $event 710=item on_configure_notify $term, $event
448 711
712=item on_property_notify $term, $event
713
449=item on_key_press $term, $event, $keysym, $octets 714=item on_key_press $term, $event, $keysym, $octets
450 715
451=item on_key_release $term, $event, $keysym 716=item on_key_release $term, $event, $keysym
452 717
453=item on_button_press $term, $event 718=item on_button_press $term, $event
458 723
459=item on_map_notify $term, $event 724=item on_map_notify $term, $event
460 725
461=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
462 727
463Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
464the 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.
465 730
466The 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
467manpage), 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
468and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
469 734
470C<on_key_press> additionally receives the string rxvt-unicode would 735C<on_key_press> additionally receives the string rxvt-unicode would
471output, if any, in locale-specific encoding. 736output, if any, in locale-specific encoding.
472 737
473subwindow. 738subwindow.
474 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.
752
475=back 753=back
476 754
477=cut 755=cut
478 756
479package urxvt; 757package urxvt;
480 758
481use utf8; 759use utf8;
482use strict; 760use strict 'vars';
483use Carp (); 761use Carp ();
484use Scalar::Util (); 762use Scalar::Util ();
485use List::Util (); 763use List::Util ();
486 764
487our $VERSION = 1; 765our $VERSION = 1;
488our $TERM; 766our $TERM;
767our @TERM_INIT; # should go, prevents async I/O etc.
768our @TERM_EXT; # should go, prevents async I/O etc.
489our @HOOKNAME; 769our @HOOKNAME;
490our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491our %OPTION; 771our %OPTION;
492 772
493our $LIBDIR; 773our $LIBDIR;
494our $RESNAME; 774our $RESNAME;
495our $RESCLASS; 775our $RESCLASS;
496our $RXVTNAME; 776our $RXVTNAME;
497 777
778our $NOCHAR = chr 0xffff;
779
498=head2 Variables in the C<urxvt> Package 780=head2 Variables in the C<urxvt> Package
499 781
500=over 4 782=over 4
501 783
502=item $urxvt::LIBDIR 784=item $urxvt::LIBDIR
515=item $urxvt::TERM 797=item $urxvt::TERM
516 798
517The current terminal. This variable stores the current C<urxvt::term> 799The current terminal. This variable stores the current C<urxvt::term>
518object, whenever a callback/hook is executing. 800object, whenever a callback/hook is executing.
519 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
520=back 818=back
521 819
522=head2 Functions in the C<urxvt> Package 820=head2 Functions in the C<urxvt> Package
523 821
524=over 4 822=over 4
525 823
526=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
527 825
528Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
529costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
530starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
531 830
532=item urxvt::warn $string 831=item urxvt::warn $string
533 832
534Calls 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
535newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
536that calls this function. 835that calls this function.
537 836
538Using 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
539correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
540 839
541Messages have a size limit of 1023 bytes currently. 840Messages have a size limit of 1023 bytes currently.
841
842=item @terms = urxvt::termlist
843
844Returns all urxvt::term objects that exist in this process, regardless of
845whether they are started, being destroyed etc., so be careful. Only term
846objects that have perl extensions attached will be returned (because there
847is no urxvt::term object associated with others).
542 848
543=item $time = urxvt::NOW 849=item $time = urxvt::NOW
544 850
545Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
546 852
589 895
590=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
591 897
592Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
593 899
594=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
595 902
596Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
597underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
598the bitset. 905the bitset.
599 906
604Return the foreground/background colour index, respectively. 911Return the foreground/background colour index, respectively.
605 912
606=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 913=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607 914
608=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 915=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
916
917=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
609 918
610Replace the foreground/background colour in the rendition mask with the 919Replace the foreground/background colour in the rendition mask with the
611specified one. 920specified one.
612 921
613=item $value = urxvt::GET_CUSTOM $rend 922=item $value = urxvt::GET_CUSTOM $rend
630 my $msg = join "", @_; 939 my $msg = join "", @_;
631 $msg .= "\n" 940 $msg .= "\n"
632 unless $msg =~ /\n$/; 941 unless $msg =~ /\n$/;
633 urxvt::warn ($msg); 942 urxvt::warn ($msg);
634 }; 943 };
944}
635 945
636 # %ENV is the original startup environment 946no warnings 'utf8';
637 delete $ENV{IFS}; 947
638 delete $ENV{CDPATH}; 948sub parse_resource {
639 delete $ENV{BASH_ENV}; 949 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
640 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin"; 950
951 $name =~ y/-/./ if $isarg;
952
953 $term->scan_meta;
954
955 my $r = $term->{meta}{resource};
956 keys %$r; # reste iterator
957 while (my ($pattern, $v) = each %$r) {
958 if (
959 $pattern =~ /\.$/
960 ? $pattern eq substr $name, 0, length $pattern
961 : $pattern eq $name
962 ) {
963 $name = "$urxvt::RESCLASS.$name";
964
965 push @{ $term->{perl_ext_3} }, $v->[0];
966
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 $pattern =~ s/\.$/.*/g;
1003 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1004 }
1005 }
641} 1006}
642 1007
643my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 1008my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
644 1009
645sub verbose { 1010sub verbose {
650my %extension_pkg; 1015my %extension_pkg;
651 1016
652# load a single script into its own package, once only 1017# load a single script into its own package, once only
653sub extension_package($) { 1018sub extension_package($) {
654 my ($path) = @_; 1019 my ($path) = @_;
655
656 no strict 'refs';
657 1020
658 $extension_pkg{$path} ||= do { 1021 $extension_pkg{$path} ||= do {
659 $path =~ /([^\/\\]+)$/; 1022 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1; 1023 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g; 1024 $pkg =~ s/[^[:word:]]/_/g;
662 $pkg = "urxvt::ext::$pkg"; 1025 $pkg = "urxvt::ext::$pkg";
663 1026
664 verbose 3, "loading extension '$path' into package '$pkg'"; 1027 verbose 3, "loading extension '$path' into package '$pkg'";
665 1028
1029 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
1030
666 open my $fh, "<:raw", $path 1031 open my $fh, "<:raw", $path
667 or die "$path: $!"; 1032 or die "$path: $!";
668 1033
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
671 my $source = 1034 my $source =
672 "package $pkg; use strict; use utf8;\n" 1035 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
673 . "#line 1 \"$path\"\n{\n" 1036 . "#line 1 \"$path\"\n{\n"
674 . (do { local $/; <$fh> }) 1037 . (do { local $/; <$fh> })
675 . "\n};\n1"; 1038 . "\n};\n1";
676 1039
677 eval $source 1040 eval $source
687sub invoke { 1050sub invoke {
688 local $TERM = shift; 1051 local $TERM = shift;
689 my $htype = shift; 1052 my $htype = shift;
690 1053
691 if ($htype == 0) { # INIT 1054 if ($htype == 0) { # INIT
692 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1055 my @dirs = $TERM->perl_libdirs;
693 1056
694 my %ext_arg; 1057 my %ext_arg;
695 1058
1059 {
1060 my @init = @TERM_INIT;
1061 @TERM_INIT = ();
1062 $_->($TERM) for @init;
1063 my @pkg = @TERM_EXT;
1064 @TERM_EXT = ();
1065 $TERM->register_package ($_) for @pkg;
1066 }
1067
1068 for (
1069 @{ delete $TERM->{perl_ext_3} },
696 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1070 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
1071 ) {
697 if ($_ eq "default") { 1072 if ($_ eq "default") {
698 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 1073 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
699 } elsif (/^-(.*)$/) { 1074 } elsif (/^-(.*)$/) {
700 delete $ext_arg{$1}; 1075 delete $ext_arg{$1};
701 } elsif (/^([^<]+)<(.*)>$/) { 1076 } elsif (/^([^<]+)<(.*)>$/) {
702 push @{ $ext_arg{$1} }, $2; 1077 push @{ $ext_arg{$1} }, $2;
703 } else { 1078 } else {
704 $ext_arg{$_} ||= []; 1079 $ext_arg{$_} ||= [];
705 } 1080 }
706 } 1081 }
707 1082
708 while (my ($ext, $argv) = each %ext_arg) { 1083 for my $ext (sort keys %ext_arg) {
709 my @files = grep -f $_, map "$_/$ext", @dirs; 1084 my @files = grep -f $_, map "$_/$ext", @dirs;
710 1085
711 if (@files) { 1086 if (@files) {
712 $TERM->register_package (extension_package $files[0], $argv); 1087 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
713 } else { 1088 } else {
714 warn "perl extension '$ext' not found in perl library search path\n"; 1089 warn "perl extension '$ext' not found in perl library search path\n";
715 } 1090 }
716 } 1091 }
717 1092
723 1098
724 if (my $cb = $TERM->{_hook}[$htype]) { 1099 if (my $cb = $TERM->{_hook}[$htype]) {
725 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1100 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
726 if $verbosity >= 10; 1101 if $verbosity >= 10;
727 1102
728 keys %$cb; 1103 for my $pkg (keys %$cb) {
729
730 while (my ($pkg, $cb) = each %$cb) {
731 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 1104 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
732 and last; 1105 $retval ||= $retval_;
733 1106
734 if ($@) { 1107 if ($@) {
735 $TERM->ungrab; # better to lose the grab than the session 1108 $TERM->ungrab; # better to lose the grab than the session
736 warn $@; 1109 warn $@;
737 } 1110 }
750 } 1123 }
751 1124
752 $retval 1125 $retval
753} 1126}
754 1127
755sub exec_async(@) { 1128sub SET_COLOR($$$) {
756 my $pid = fork; 1129 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
757
758 return
759 if !defined $pid or $pid;
760
761 %ENV = %{ $TERM->env };
762
763 exec @_;
764 _exit 255;
765} 1130}
766 1131
767# urxvt::term::extension 1132sub rend2mask {
1133 no strict 'refs';
1134 my ($str, $mask) = (@_, 0);
1135 my %color = ( fg => undef, bg => undef );
1136 my @failed;
1137 for my $spec ( split /\s+/, $str ) {
1138 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1139 $color{lc($1)} = $2;
1140 } else {
1141 my $neg = $spec =~ s/^[-^]//;
1142 unless ( exists &{"RS_$spec"} ) {
1143 push @failed, $spec;
1144 next;
1145 }
1146 my $cur = &{"RS_$spec"};
1147 if ( $neg ) {
1148 $mask &= ~$cur;
1149 } else {
1150 $mask |= $cur;
1151 }
1152 }
1153 }
1154 ($mask, @color{qw(fg bg)}, \@failed)
1155}
768 1156
769package urxvt::term::extension; 1157package urxvt::term::extension;
770 1158
771sub enable { 1159sub enable {
772 my ($self, %hook) = @_; 1160 my ($self, %hook) = @_;
827 1215
828sub urxvt::destroy_hook(&) { 1216sub urxvt::destroy_hook(&) {
829 bless \shift, urxvt::destroy_hook:: 1217 bless \shift, urxvt::destroy_hook::
830} 1218}
831 1219
1220sub x_resource {
1221 my ($self, $name) = @_;
1222 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1223 $self->{term}->x_resource ($name)
1224}
1225
1226sub x_resource_boolean {
1227 my ($self, $name) = @_;
1228 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1229 $self->{term}->x_resource_boolean ($name)
1230}
1231
832package urxvt::anyevent; 1232package urxvt::anyevent;
833 1233
834=head2 The C<urxvt::anyevent> Class 1234=head2 The C<urxvt::anyevent> Class
835 1235
836The sole purpose of this class is to deliver an interface to the 1236The sole purpose of this class is to deliver an interface to the
837C<AnyEvent> module - any module using it will work inside urxvt without 1237C<AnyEvent> module - any module using it will work inside urxvt without
838further programming. The only exception is that you cannot wait on 1238further programming. The only exception is that you cannot wait on
839condition variables, but non-blocking condvar use is ok. What this means 1239condition variables, but non-blocking condvar use is ok.
840is that you cannot use blocking APIs, but the non-blocking variant should 1240
841work. 1241In practical terms this means is that you cannot use blocking APIs, but
1242the non-blocking variant should work.
842 1243
843=cut 1244=cut
844 1245
845our $VERSION = 1; 1246our $VERSION = '5.23';
846 1247
847$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1248$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
848push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1249push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
849 1250
850sub timer { 1251sub timer {
852 1253
853 my $cb = $arg{cb}; 1254 my $cb = $arg{cb};
854 1255
855 urxvt::timer 1256 urxvt::timer
856 ->new 1257 ->new
857 ->start (urxvt::NOW + $arg{after}) 1258 ->after ($arg{after}, $arg{interval})
858 ->cb (sub { 1259 ->cb ($arg{interval} ? $cb : sub {
859 $_[0]->stop; # need to cancel manually 1260 $_[0]->stop; # need to cancel manually
860 $cb->(); 1261 $cb->();
861 }) 1262 })
862} 1263}
863 1264
864sub io { 1265sub io {
865 my ($class, %arg) = @_; 1266 my ($class, %arg) = @_;
866 1267
867 my $cb = $arg{cb}; 1268 my $cb = $arg{cb};
1269 my $fd = fileno $arg{fh};
1270 defined $fd or $fd = $arg{fh};
868 1271
869 bless [$arg{fh}, urxvt::iow 1272 bless [$arg{fh}, urxvt::iow
870 ->new 1273 ->new
871 ->fd (fileno $arg{fh}) 1274 ->fd ($fd)
872 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1275 ->events (($arg{poll} =~ /r/ ? 1 : 0)
873 | ($arg{poll} =~ /w/ ? 2 : 0)) 1276 | ($arg{poll} =~ /w/ ? 2 : 0))
874 ->start 1277 ->start
875 ->cb (sub { 1278 ->cb ($cb)
876 $cb->(($_[1] & 1 ? 'r' : '')
877 . ($_[1] & 2 ? 'w' : ''));
878 })],
879 urxvt::anyevent:: 1279 ], urxvt::anyevent::
1280}
1281
1282sub idle {
1283 my ($class, %arg) = @_;
1284
1285 my $cb = $arg{cb};
1286
1287 urxvt::iw
1288 ->new
1289 ->start
1290 ->cb ($cb)
1291}
1292
1293sub child {
1294 my ($class, %arg) = @_;
1295
1296 my $cb = $arg{cb};
1297
1298 urxvt::pw
1299 ->new
1300 ->start ($arg{pid})
1301 ->cb (sub {
1302 $_[0]->stop; # need to cancel manually
1303 $cb->($_[0]->rpid, $_[0]->rstatus);
1304 })
880} 1305}
881 1306
882sub DESTROY { 1307sub DESTROY {
883 $_[0][1]->stop; 1308 $_[0][1]->stop;
884} 1309}
885 1310
886sub condvar { 1311# only needed for AnyEvent < 6 compatibility
887 bless \my $flag, urxvt::anyevent::condvar:: 1312sub one_event {
888}
889
890sub urxvt::anyevent::condvar::broadcast {
891 ${$_[0]}++;
892}
893
894sub urxvt::anyevent::condvar::wait {
895 unless (${$_[0]}) {
896 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1313 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
897 }
898} 1314}
899 1315
900package urxvt::term; 1316package urxvt::term;
901 1317
902=head2 The C<urxvt::term> Class 1318=head2 The C<urxvt::term> Class
908# find on_xxx subs in the package and register them 1324# find on_xxx subs in the package and register them
909# as hooks 1325# as hooks
910sub register_package { 1326sub register_package {
911 my ($self, $pkg, $argv) = @_; 1327 my ($self, $pkg, $argv) = @_;
912 1328
1329 no strict 'refs';
1330
1331 urxvt::verbose 6, "register package $pkg to $self";
1332
1333 @{"$pkg\::ISA"} = urxvt::term::extension::;
1334
913 my $proxy = bless { 1335 my $proxy = bless {
914 _pkg => $pkg, 1336 _pkg => $pkg,
1337 _name => ${"$pkg\::_NAME"}, # hackish
915 argv => $argv, 1338 argv => $argv,
916 }, $pkg; 1339 }, $pkg;
917 Scalar::Util::weaken ($proxy->{term} = $self); 1340 Scalar::Util::weaken ($proxy->{term} = $self);
918 1341
919 $self->{_pkg}{$pkg} = $proxy; 1342 $self->{_pkg}{$pkg} = $proxy;
920 1343
923 $proxy->enable ($name => $ref); 1346 $proxy->enable ($name => $ref);
924 } 1347 }
925 } 1348 }
926} 1349}
927 1350
1351sub perl_libdirs {
1352 map { split /:/ }
1353 $_[0]->resource ("perl_lib"),
1354 $ENV{URXVT_PERL_LIB},
1355 "$ENV{HOME}/.urxvt/ext",
1356 "$LIBDIR/perl"
1357}
1358
1359sub scan_meta {
1360 my ($self) = @_;
1361 my @libdirs = perl_libdirs $self;
1362
1363 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1364
1365 my %meta;
1366
1367 $self->{meta_libdirs} = join "\x00", @libdirs;
1368 $self->{meta} = \%meta;
1369
1370 for my $dir (reverse @libdirs) {
1371 opendir my $fh, $dir
1372 or next;
1373 for my $ext (readdir $fh) {
1374 $ext ne "."
1375 and $ext ne ".."
1376 and open my $fh, "<", "$dir/$ext"
1377 or next;
1378
1379 while (<$fh>) {
1380 if (/^#:META:X_RESOURCE:(.*)/) {
1381 my ($pattern, $type, $desc) = split /:/, $1;
1382 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1383 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1384 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1385 } else {
1386 $meta{resource}{$pattern} = [$ext, $type, $desc];
1387 }
1388 } elsif (/^\s*(?:#|$)/) {
1389 # skip other comments and empty lines
1390 } else {
1391 last; # stop parsing on first non-empty non-comment line
1392 }
1393 }
1394 }
1395 }
1396}
1397
928=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1398=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
929 1399
930Creates a new terminal, very similar as if you had started it with system 1400Creates a new terminal, very similar as if you had started it with system
931C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1401C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
932hash which defines the environment of the new terminal. 1402hash which defines the environment of the new terminal.
933 1403
934Croaks (and probably outputs an error message) if the new instance 1404Croaks (and probably outputs an error message) if the new instance
935couldn't be created. Returns C<undef> if the new instance didn't 1405couldn't be created. Returns C<undef> if the new instance didn't
936initialise perl, and the terminal object otherwise. The C<init> and 1406initialise perl, and the terminal object otherwise. The C<init> and
937C<start> hooks will be called during this call. 1407C<start> hooks will be called before this call returns, and are free to
1408refer to global data (which is race free).
938 1409
939=cut 1410=cut
940 1411
941sub new { 1412sub new {
942 my ($class, $env, @args) = @_; 1413 my ($class, $env, @args) = @_;
943 1414
1415 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1416 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1417
944 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1418 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
945} 1419}
946 1420
947=item $term->destroy 1421=item $term->destroy
948 1422
949Destroy the terminal object (close the window, free resources 1423Destroy the terminal object (close the window, free resources
950etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1424etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
951watchers (timers, io watchers) are still active. 1425watchers (timers, io watchers) are still active.
952 1426
1427=item $term->exec_async ($cmd[, @args])
1428
1429Works like the combination of the C<fork>/C<exec> builtins, which executes
1430("starts") programs in the background. This function takes care of setting
1431the user environment before exec'ing the command (e.g. C<PATH>) and should
1432be preferred over explicit calls to C<exec> or C<system>.
1433
1434Returns the pid of the subprocess or C<undef> on error.
1435
1436=cut
1437
1438sub exec_async {
1439 my $self = shift;
1440
1441 my $pid = fork;
1442
1443 return $pid
1444 if !defined $pid or $pid;
1445
1446 %ENV = %{ $self->env };
1447
1448 exec @_;
1449 urxvt::_exit 255;
1450}
1451
953=item $isset = $term->option ($optval[, $set]) 1452=item $isset = $term->option ($optval[, $set])
954 1453
955Returns true if the option specified by C<$optval> is enabled, and 1454Returns true if the option specified by C<$optval> is enabled, and
956optionally change it. All option values are stored by name in the hash 1455optionally change it. All option values are stored by name in the hash
957C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1456C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
958 1457
959Here is a a likely non-exhaustive list of option names, please see the 1458Here is a likely non-exhaustive list of option names, please see the
960source file F</src/optinc.h> to see the actual list: 1459source file F</src/optinc.h> to see the actual list:
961 1460
962 borderLess console cursorBlink cursorUnderline hold iconic insecure 1461 borderLess buffered console cursorBlink cursorUnderline hold iconic
963 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1462 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
964 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1463 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
965 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1464 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
966 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1465 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
967 transparent tripleclickwords utmpInhibit visualBell 1466 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1467 urgentOnBell utmpInhibit visualBell
968 1468
969=item $value = $term->resource ($name[, $newval]) 1469=item $value = $term->resource ($name[, $newval])
970 1470
971Returns the current resource value associated with a given name and 1471Returns the current resource value associated with a given name and
972optionally sets a new value. Setting values is most useful in the C<init> 1472optionally sets a new value. Setting values is most useful in the C<init>
981likely change). 1481likely change).
982 1482
983Please note that resource strings will currently only be freed when the 1483Please note that resource strings will currently only be freed when the
984terminal is destroyed, so changing options frequently will eat memory. 1484terminal is destroyed, so changing options frequently will eat memory.
985 1485
986Here is a a likely non-exhaustive list of resource names, not all of which 1486Here is a likely non-exhaustive list of resource names, not all of which
987are supported in every build, please see the source file F</src/rsinc.h> 1487are supported in every build, please see the source file F</src/rsinc.h>
988to see the actual list: 1488to see the actual list:
989 1489
990 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1490 answerbackstring backgroundPixmap backspace_key blendtype blurradius
991 borderLess color cursorBlink cursorUnderline cutchars delete_key 1491 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
992 display_name embed ext_bwidth fade font geometry hold iconName 1492 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
993 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1493 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1494 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
994 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1495 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
995 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1496 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
996 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1497 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
997 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1498 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
998 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1499 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
999 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1500 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1000 secondaryScreen secondaryScroll selectstyle shade term_name title 1501 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1001 transient_for transparent transparent_all tripleclickwords utmpInhibit 1502 term_name title transient_for transparent tripleclickwords urgentOnBell
1002 visualBell 1503 utmpInhibit visualBell
1003 1504
1004=cut 1505=cut
1005 1506
1006sub resource($$;$) { 1507sub resource($$;$) {
1007 my ($self, $name) = (shift, shift); 1508 my ($self, $name) = (shift, shift);
1008 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1509 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1009 &urxvt::term::_resource 1510 goto &urxvt::term::_resource
1010} 1511}
1011 1512
1012=item $value = $term->x_resource ($pattern) 1513=item $value = $term->x_resource ($pattern)
1013 1514
1014Returns the X-Resource for the given pattern, excluding the program or 1515Returns the X-Resource for the given pattern, excluding the program or
1015class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1516class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1016same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1517same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1017resource with that pattern exists. 1518resource with that pattern exists.
1018 1519
1520Extensions that define extra resource or command line arguments also need
1521to call this method to access their values.
1522
1523If the method is called on an extension object (basically, from an
1524extension), then the special prefix C<%.> will be replaced by the name of
1525the extension and a dot, and the lone string C<%> will be replcaed by the
1526extension name itself. This makes it possible to code extensions so you
1527can rename them and get a new set of commandline switches and resources
1528without having to change the actual code.
1529
1019This method should only be called during the C<on_start> hook, as there is 1530This method should only be called during the C<on_start> hook, as there is
1020only one resource database per display, and later invocations might return 1531only one resource database per display, and later invocations might return
1021the wrong resources. 1532the wrong resources.
1022 1533
1023=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1534=item $value = $term->x_resource_boolean ($pattern)
1024 1535
1536Like C<x_resource>, above, but interprets the string value as a boolean
1537and returns C<1> for true values, C<0> for false values and C<undef> if
1538the resource or option isn't specified.
1539
1540You should always use this method to parse boolean resources.
1541
1542=cut
1543
1544sub x_resource_boolean {
1545 my $res = &x_resource;
1546
1547 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1548}
1549
1550=item $success = $term->parse_keysym ($key, $octets)
1551
1025Adds a keymap translation exactly as specified via a resource. See the 1552Adds a key binding exactly as specified via a resource. See the
1026C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1553C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1554
1555=item $term->register_command ($keysym, $modifiermask, $string)
1556
1557Adds a key binding. This is a lower level api compared to
1558C<parse_keysym>, as it expects a parsed key description, and can be
1559used only inside either the C<on_init> hook, to add a binding, or the
1560C<on_register_command> hook, to modify a parsed binding.
1027 1561
1028=item $rend = $term->rstyle ([$new_rstyle]) 1562=item $rend = $term->rstyle ([$new_rstyle])
1029 1563
1030Return and optionally change the current rendition. Text that is output by 1564Return and optionally change the current rendition. Text that is output by
1031the terminal application will use this style. 1565the terminal application will use this style.
1039 1573
1040=item ($row, $col) = $term->selection_beg ([$row, $col]) 1574=item ($row, $col) = $term->selection_beg ([$row, $col])
1041 1575
1042=item ($row, $col) = $term->selection_end ([$row, $col]) 1576=item ($row, $col) = $term->selection_end ([$row, $col])
1043 1577
1044Return the current values of the selection mark, begin or end positions, 1578Return the current values of the selection mark, begin or end positions.
1045and optionally set them to new values. 1579
1580When arguments are given, then the selection coordinates are set to
1581C<$row> and C<$col>, and the selection screen is set to the current
1582screen.
1583
1584=item $screen = $term->selection_screen ([$screen])
1585
1586Returns the current selection screen, and then optionally sets it.
1046 1587
1047=item $term->selection_make ($eventtime[, $rectangular]) 1588=item $term->selection_make ($eventtime[, $rectangular])
1048 1589
1049Tries to make a selection as set by C<selection_beg> and 1590Tries to make a selection as set by C<selection_beg> and
1050C<selection_end>. If C<$rectangular> is true (default: false), a 1591C<selection_end>. If C<$rectangular> is true (default: false), a
1051rectangular selection will be made. This is the prefered function to make 1592rectangular selection will be made. This is the preferred function to make
1052a selection. 1593a selection.
1053 1594
1054=item $success = $term->selection_grab ($eventtime) 1595=item $success = $term->selection_grab ($eventtime[, $clipboard])
1055 1596
1056Try to request the primary selection text from the server (for example, as 1597Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1598true) selection from the server. The corresponding text can be set
1057set by the next method). No visual feedback will be given. This function 1599with the next method. No visual feedback will be given. This function
1058is mostly useful from within C<on_sel_grab> hooks. 1600is mostly useful from within C<on_sel_grab> hooks.
1059 1601
1060=item $oldtext = $term->selection ([$newtext]) 1602=item $oldtext = $term->selection ([$newtext, $clipboard])
1061 1603
1062Return the current selection text and optionally replace it by C<$newtext>. 1604Return the current selection (clipboard if C<$clipboard> is true) text
1605and optionally replace it by C<$newtext>.
1606
1607=item $term->selection_clear ([$clipboard])
1608
1609Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1063 1610
1064=item $term->overlay_simple ($x, $y, $text) 1611=item $term->overlay_simple ($x, $y, $text)
1065 1612
1066Create a simple multi-line overlay box. See the next method for details. 1613Create a simple multi-line overlay box. See the next method for details.
1067 1614
1097 1644
1098The methods currently supported on C<urxvt::overlay> objects are: 1645The methods currently supported on C<urxvt::overlay> objects are:
1099 1646
1100=over 4 1647=over 4
1101 1648
1102=item $overlay->set ($x, $y, $text, $rend) 1649=item $overlay->set ($x, $y, $text[, $rend])
1103 1650
1104Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1651Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1105text in rxvt-unicode's special encoding and an array of rendition values 1652text in rxvt-unicode's special encoding and an array of rendition values
1106at a specific position inside the overlay. 1653at a specific position inside the overlay.
1654
1655If C<$rend> is missing, then the rendition will not be changed.
1107 1656
1108=item $overlay->hide 1657=item $overlay->hide
1109 1658
1110If visible, hide the overlay, but do not destroy it. 1659If visible, hide the overlay, but do not destroy it.
1111 1660
1181 1730
1182Normally its not a good idea to use this function, as programs might be 1731Normally its not a good idea to use this function, as programs might be
1183confused by changes in cursor position or scrolling. Its useful inside a 1732confused by changes in cursor position or scrolling. Its useful inside a
1184C<on_add_lines> hook, though. 1733C<on_add_lines> hook, though.
1185 1734
1735=item $term->scr_change_screen ($screen)
1736
1737Switch to given screen - 0 primary, 1 secondary.
1738
1186=item $term->cmd_parse ($octets) 1739=item $term->cmd_parse ($octets)
1187 1740
1188Similar to C<scr_add_lines>, but the argument must be in the 1741Similar to C<scr_add_lines>, but the argument must be in the
1189locale-specific encoding of the terminal and can contain command sequences 1742locale-specific encoding of the terminal and can contain command sequences
1190(escape codes) that will be interpreted. 1743(escape codes) that will be interpreted.
1191 1744
1192=item $term->tt_write ($octets) 1745=item $term->tt_write ($octets)
1193 1746
1194Write the octets given in C<$data> to the tty (i.e. as program input). To 1747Write the octets given in C<$octets> to the tty (i.e. as program input). To
1195pass characters instead of octets, you should convert your strings first 1748pass characters instead of octets, you should convert your strings first
1196to the locale-specific encoding using C<< $term->locale_encode >>. 1749to the locale-specific encoding using C<< $term->locale_encode >>.
1750
1751=item $term->tt_paste ($octets)
1752
1753Write the octets given in C<$octets> to the tty as a paste, converting NL to
1754CR and bracketing the data with control sequences if bracketed paste mode
1755is set.
1197 1756
1198=item $old_events = $term->pty_ev_events ([$new_events]) 1757=item $old_events = $term->pty_ev_events ([$new_events])
1199 1758
1200Replaces the event mask of the pty watcher by the given event mask. Can 1759Replaces the event mask of the pty watcher by the given event mask. Can
1201be used to suppress input and output handling to the pty/tty. See the 1760be used to suppress input and output handling to the pty/tty. See the
1202description of C<< urxvt::timer->events >>. Make sure to always restore 1761description of C<< urxvt::timer->events >>. Make sure to always restore
1203the previous value. 1762the previous value.
1204 1763
1764=item $fd = $term->pty_fd
1765
1766Returns the master file descriptor for the pty in use, or C<-1> if no pty
1767is used.
1768
1205=item $windowid = $term->parent 1769=item $windowid = $term->parent
1206 1770
1207Return the window id of the toplevel window. 1771Return the window id of the toplevel window.
1208 1772
1209=item $windowid = $term->vt 1773=item $windowid = $term->vt
1215Adds the specified events to the vt event mask. Useful e.g. when you want 1779Adds the specified events to the vt event mask. Useful e.g. when you want
1216to receive pointer events all the times: 1780to receive pointer events all the times:
1217 1781
1218 $term->vt_emask_add (urxvt::PointerMotionMask); 1782 $term->vt_emask_add (urxvt::PointerMotionMask);
1219 1783
1784=item $term->set_urgency ($set)
1785
1786Enable/disable the urgency hint on the toplevel window.
1787
1788=item $term->focus_in
1789
1790=item $term->focus_out
1791
1792=item $term->key_press ($state, $keycode[, $time])
1793
1794=item $term->key_release ($state, $keycode[, $time])
1795
1796Deliver various fake events to to terminal.
1797
1220=item $window_width = $term->width 1798=item $window_width = $term->width
1221 1799
1222=item $window_height = $term->height 1800=item $window_height = $term->height
1223 1801
1224=item $font_width = $term->fwidth 1802=item $font_width = $term->fwidth
1254=item $env = $term->env 1832=item $env = $term->env
1255 1833
1256Returns a copy of the environment in effect for the terminal as a hashref 1834Returns a copy of the environment in effect for the terminal as a hashref
1257similar to C<\%ENV>. 1835similar to C<\%ENV>.
1258 1836
1837=item @envv = $term->envv
1838
1839Returns the environment as array of strings of the form C<VAR=VALUE>.
1840
1841=item @argv = $term->argv
1842
1843Return the argument vector as this terminal, similar to @ARGV, but
1844includes the program name as first element.
1845
1259=cut 1846=cut
1260 1847
1261sub env { 1848sub env {
1262 if (my $env = $_[0]->_env) {
1263 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1849 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1264 } else {
1265 +{ %ENV }
1266 }
1267} 1850}
1268 1851
1269=item $modifiermask = $term->ModLevel3Mask 1852=item $modifiermask = $term->ModLevel3Mask
1270 1853
1271=item $modifiermask = $term->ModMetaMask 1854=item $modifiermask = $term->ModMetaMask
1272 1855
1273=item $modifiermask = $term->ModNumLockMask 1856=item $modifiermask = $term->ModNumLockMask
1274 1857
1275Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1858Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1276AltGr), the meta key (often Alt) and the num lock key, if applicable. 1859AltGr), the meta key (often Alt) and the num lock key, if applicable.
1860
1861=item $screen = $term->current_screen
1862
1863Returns the currently displayed screen (0 primary, 1 secondary).
1864
1865=item $cursor_is_hidden = $term->hidden_cursor
1866
1867Returns whether the cursor is currently hidden or not.
1277 1868
1278=item $view_start = $term->view_start ([$newvalue]) 1869=item $view_start = $term->view_start ([$newvalue])
1279 1870
1280Returns the row number of the topmost displayed line. Maximum value is 1871Returns the row number of the topmost displayed line. Maximum value is
1281C<0>, which displays the normal terminal contents. Lower values scroll 1872C<0>, which displays the normal terminal contents. Lower values scroll
1289 1880
1290Used after changing terminal contents to display them. 1881Used after changing terminal contents to display them.
1291 1882
1292=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1883=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1293 1884
1294Returns the text of the entire row with number C<$row_number>. Row C<0> 1885Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1295is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1886is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1296terminal line. The scrollback buffer starts at line C<-1> and extends to
1297line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1887terminal line. Nothing will be returned if a nonexistent line
1298is requested. 1888is requested.
1299 1889
1300If C<$new_text> is specified, it will replace characters in the current 1890If C<$new_text> is specified, it will replace characters in the current
1301line, starting at column C<$start_col> (default C<0>), which is useful 1891line, starting at column C<$start_col> (default C<0>), which is useful
1302to replace only parts of a line. The font index in the rendition will 1892to replace only parts of a line. The font index in the rendition will
1303automatically be updated. 1893automatically be updated.
1304 1894
1305C<$text> is in a special encoding: tabs and wide characters that use more 1895C<$text> is in a special encoding: tabs and wide characters that use more
1306than one cell when displayed are padded with urxvt::NOCHAR characters 1896than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1307(C<chr 65535>). Characters with combining characters and other characters 1897characters. Characters with combining characters and other characters that
1308that do not fit into the normal tetx encoding will be replaced with 1898do not fit into the normal text encoding will be replaced with characters
1309characters in the private use area. 1899in the private use area.
1310 1900
1311You have to obey this encoding when changing text. The advantage is 1901You have to obey this encoding when changing text. The advantage is
1312that C<substr> and similar functions work on screen cells and not on 1902that C<substr> and similar functions work on screen cells and not on
1313characters. 1903characters.
1314 1904
1458where one character corresponds to one screen cell. See 2048where one character corresponds to one screen cell. See
1459C<< $term->ROW_t >> for details. 2049C<< $term->ROW_t >> for details.
1460 2050
1461=item $string = $term->special_decode $text 2051=item $string = $term->special_decode $text
1462 2052
1463Converts rxvt-unicodes text reprsentation into a perl string. See 2053Converts rxvt-unicodes text representation into a perl string. See
1464C<< $term->ROW_t >> for details. 2054C<< $term->ROW_t >> for details.
1465 2055
1466=item $success = $term->grab_button ($button, $modifiermask) 2056=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1467 2057
2058=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
2059
1468Registers a synchronous button grab. See the XGrabButton manpage. 2060Register/unregister a synchronous button grab. See the XGrabButton
2061manpage.
1469 2062
1470=item $success = $term->grab ($eventtime[, $sync]) 2063=item $success = $term->grab ($eventtime[, $sync])
1471 2064
1472Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 2065Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1473synchronous (C<$sync> is true). Also remembers the grab timestampe. 2066synchronous (C<$sync> is true). Also remembers the grab timestamp.
1474 2067
1475=item $term->allow_events_async 2068=item $term->allow_events_async
1476 2069
1477Calls XAllowEvents with AsyncBoth for the most recent grab. 2070Calls XAllowEvents with AsyncBoth for the most recent grab.
1478 2071
1485Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2078Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1486recent grab. 2079recent grab.
1487 2080
1488=item $term->ungrab 2081=item $term->ungrab
1489 2082
1490Calls XUngrab for the most recent grab. Is called automatically on 2083Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1491evaluation errors, as it is better to lose the grab in the error case as 2084evaluation errors, as it is better to lose the grab in the error case as
1492the session. 2085the session.
2086
2087=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
2088
2089=item $atom_name = $term->XGetAtomName ($atom)
2090
2091=item @atoms = $term->XListProperties ($window)
2092
2093=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
2094
2095=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
2096
2097=item $term->XDeleteProperty ($window, $property)
2098
2099=item $window = $term->DefaultRootWindow
2100
2101=item $term->XReparentWindow ($window, $parent, [$x, $y])
2102
2103=item $term->XMapWindow ($window)
2104
2105=item $term->XUnmapWindow ($window)
2106
2107=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
2108
2109=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
2110
2111=item $term->XChangeInput ($window, $add_events[, $del_events])
2112
2113=item $keysym = $term->XStringToKeysym ($string)
2114
2115=item $string = $term->XKeysymToString ($keysym)
2116
2117Various X or X-related functions. The C<$term> object only serves as
2118the source of the display, otherwise those functions map more-or-less
2119directly onto the X functions of the same name.
1493 2120
1494=back 2121=back
1495 2122
1496=cut 2123=cut
1497 2124
1561 my ($self, $text, $cb) = @_; 2188 my ($self, $text, $cb) = @_;
1562 2189
1563 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2190 $self->add_item ({ type => "button", text => $text, activate => $cb});
1564} 2191}
1565 2192
1566=item $popup->add_toggle ($text, $cb, $initial_value) 2193=item $popup->add_toggle ($text, $initial_value, $cb)
1567 2194
1568Adds a toggle/checkbox item to the popup. Teh callback gets called 2195Adds a toggle/checkbox item to the popup. The callback gets called
1569whenever it gets toggled, with a boolean indicating its value as its first 2196whenever it gets toggled, with a boolean indicating its new value as its
1570argument. 2197first argument.
1571 2198
1572=cut 2199=cut
1573 2200
1574sub add_toggle { 2201sub add_toggle {
1575 my ($self, $text, $cb, $value) = @_; 2202 my ($self, $text, $value, $cb) = @_;
1576 2203
1577 my $item; $item = { 2204 my $item; $item = {
1578 type => "button", 2205 type => "button",
1579 text => " $text", 2206 text => " $text",
1580 value => $value, 2207 value => $value,
1599 my $env = $self->{term}->env; 2226 my $env = $self->{term}->env;
1600 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2227 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1601 delete $env->{LC_ALL}; 2228 delete $env->{LC_ALL};
1602 $env->{LC_CTYPE} = $self->{term}->locale; 2229 $env->{LC_CTYPE} = $self->{term}->locale;
1603 2230
1604 urxvt::term->new ($env, "popup", 2231 my $term = urxvt::term->new (
2232 $env, "popup",
1605 "--perl-lib" => "", "--perl-ext-common" => "", 2233 "--perl-lib" => "", "--perl-ext-common" => "",
1606 "-pty-fd" => -1, "-sl" => 0, 2234 "-pty-fd" => -1, "-sl" => 0,
1607 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2235 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1608 "--transient-for" => $self->{term}->parent, 2236 "--transient-for" => $self->{term}->parent,
1609 "-display" => $self->{term}->display_id, 2237 "-display" => $self->{term}->display_id,
1610 "-pe" => "urxvt-popup") 2238 "-pe" => "urxvt-popup",
1611 or die "unable to create popup window\n"; 2239 ) or die "unable to create popup window\n";
2240
2241 unless (delete $term->{urxvt_popup_init_done}) {
2242 $term->ungrab;
2243 $term->destroy;
2244 die "unable to initialise popup window\n";
2245 }
1612} 2246}
1613 2247
1614sub DESTROY { 2248sub DESTROY {
1615 my ($self) = @_; 2249 my ($self) = @_;
1616 2250
1617 delete $self->{term}{_destroy}{$self}; 2251 delete $self->{term}{_destroy}{$self};
1618 $self->{term}->ungrab; 2252 $self->{term}->ungrab;
1619} 2253}
1620 2254
1621=back 2255=back
2256
2257=cut
2258
2259package urxvt::watcher;
1622 2260
1623=head2 The C<urxvt::timer> Class 2261=head2 The C<urxvt::timer> Class
1624 2262
1625This class implements timer watchers/events. Time is represented as a 2263This class implements timer watchers/events. Time is represented as a
1626fractional number of seconds since the epoch. Example: 2264fractional number of seconds since the epoch. Example:
1630 ->new 2268 ->new
1631 ->interval (1) 2269 ->interval (1)
1632 ->cb (sub { 2270 ->cb (sub {
1633 $term->{overlay}->set (0, 0, 2271 $term->{overlay}->set (0, 0,
1634 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2272 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1635 }); 2273 });
1636 2274
1637=over 4 2275=over 4
1638 2276
1639=item $timer = new urxvt::timer 2277=item $timer = new urxvt::timer
1640 2278
1643 2281
1644=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2282=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1645 2283
1646Set the callback to be called when the timer triggers. 2284Set the callback to be called when the timer triggers.
1647 2285
1648=item $tstamp = $timer->at
1649
1650Return the time this watcher will fire next.
1651
1652=item $timer = $timer->set ($tstamp) 2286=item $timer = $timer->set ($tstamp[, $interval])
1653 2287
1654Set the time the event is generated to $tstamp. 2288Set the time the event is generated to $tstamp (and optionally specifies a
2289new $interval).
1655 2290
1656=item $timer = $timer->interval ($interval) 2291=item $timer = $timer->interval ($interval)
1657 2292
1658Normally (and when C<$interval> is C<0>), the timer will automatically 2293By default (and when C<$interval> is C<0>), the timer will automatically
1659stop after it has fired once. If C<$interval> is non-zero, then the timer 2294stop after it has fired once. If C<$interval> is non-zero, then the timer
1660is automatically rescheduled at the given intervals. 2295is automatically rescheduled at the given intervals.
1661 2296
1662=item $timer = $timer->start 2297=item $timer = $timer->start
1663 2298
1664Start the timer. 2299Start the timer.
1665 2300
1666=item $timer = $timer->start ($tstamp) 2301=item $timer = $timer->start ($tstamp[, $interval])
1667 2302
1668Set the event trigger time to C<$tstamp> and start the timer. 2303Set the event trigger time to C<$tstamp> and start the timer. Optionally
2304also replaces the interval.
1669 2305
1670=item $timer = $timer->after ($delay) 2306=item $timer = $timer->after ($delay[, $interval])
1671 2307
1672Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2308Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1673 2309
1674=item $timer = $timer->stop 2310=item $timer = $timer->stop
1675 2311
1683 2319
1684 $term->{socket} = ... 2320 $term->{socket} = ...
1685 $term->{iow} = urxvt::iow 2321 $term->{iow} = urxvt::iow
1686 ->new 2322 ->new
1687 ->fd (fileno $term->{socket}) 2323 ->fd (fileno $term->{socket})
1688 ->events (urxvt::EVENT_READ) 2324 ->events (urxvt::EV_READ)
1689 ->start 2325 ->start
1690 ->cb (sub { 2326 ->cb (sub {
1691 my ($iow, $revents) = @_; 2327 my ($iow, $revents) = @_;
1692 # $revents must be 1 here, no need to check 2328 # $revents must be 1 here, no need to check
1693 sysread $term->{socket}, my $buf, 8192 2329 sysread $term->{socket}, my $buf, 8192
1706Set the callback to be called when io events are triggered. C<$reventmask> 2342Set the callback to be called when io events are triggered. C<$reventmask>
1707is a bitset as described in the C<events> method. 2343is a bitset as described in the C<events> method.
1708 2344
1709=item $iow = $iow->fd ($fd) 2345=item $iow = $iow->fd ($fd)
1710 2346
1711Set the filedescriptor (not handle) to watch. 2347Set the file descriptor (not handle) to watch.
1712 2348
1713=item $iow = $iow->events ($eventmask) 2349=item $iow = $iow->events ($eventmask)
1714 2350
1715Set the event mask to watch. The only allowed values are 2351Set the event mask to watch. The only allowed values are
1716C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2352C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1717together, or C<urxvt::EVENT_NONE>. 2353together, or C<urxvt::EV_NONE>.
1718 2354
1719=item $iow = $iow->start 2355=item $iow = $iow->start
1720 2356
1721Start watching for requested events on the given handle. 2357Start watching for requested events on the given handle.
1722 2358
1723=item $iow = $iow->stop 2359=item $iow = $iow->stop
1724 2360
1725Stop watching for events on the given filehandle. 2361Stop watching for events on the given file handle.
2362
2363=back
2364
2365=head2 The C<urxvt::iw> Class
2366
2367This class implements idle watchers, that get called automatically when
2368the process is idle. They should return as fast as possible, after doing
2369some useful work.
2370
2371=over 4
2372
2373=item $iw = new urxvt::iw
2374
2375Create a new idle watcher object in stopped state.
2376
2377=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2378
2379Set the callback to be called when the watcher triggers.
2380
2381=item $timer = $timer->start
2382
2383Start the watcher.
2384
2385=item $timer = $timer->stop
2386
2387Stop the watcher.
2388
2389=back
2390
2391=head2 The C<urxvt::pw> Class
2392
2393This class implements process watchers. They create an event whenever a
2394process exits, after which they stop automatically.
2395
2396 my $pid = fork;
2397 ...
2398 $term->{pw} = urxvt::pw
2399 ->new
2400 ->start ($pid)
2401 ->cb (sub {
2402 my ($pw, $exit_status) = @_;
2403 ...
2404 });
2405
2406=over 4
2407
2408=item $pw = new urxvt::pw
2409
2410Create a new process watcher in stopped state.
2411
2412=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2413
2414Set the callback to be called when the timer triggers.
2415
2416=item $pw = $timer->start ($pid)
2417
2418Tells the watcher to start watching for process C<$pid>.
2419
2420=item $pw = $pw->stop
2421
2422Stop the watcher.
1726 2423
1727=back 2424=back
1728 2425
1729=head1 ENVIRONMENT 2426=head1 ENVIRONMENT
1730 2427
1739 2436
1740=item >= 3 - script loading and management 2437=item >= 3 - script loading and management
1741 2438
1742=item >=10 - all called hooks 2439=item >=10 - all called hooks
1743 2440
1744=item >=11 - hook reutrn values 2441=item >=11 - hook return values
1745 2442
1746=back 2443=back
1747 2444
1748=head1 AUTHOR 2445=head1 AUTHOR
1749 2446
1750 Marc Lehmann <pcg@goof.com> 2447 Marc Lehmann <schmorp@schmorp.de>
1751 http://software.schmorp.de/pkg/rxvt-unicode 2448 http://software.schmorp.de/pkg/rxvt-unicode
1752 2449
1753=cut 2450=cut
1754 2451
17551 24521
2453
2454# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines