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.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC

17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
36You can activate them like this: 39You can activate them like this:
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
43Or by adding them to the resource for extensions loaded by default:
44
45 URxvt.perl-ext-common: default,selection-autotransform
46
40=over 4 47=over 4
41 48
42=item selection (enabled by default) 49=item selection (enabled by default)
43 50
44(More) intelligent selection. This extension tries to be more intelligent 51(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 52when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 53now, it tries to select words, urls and complete shell-quoted
47too, if your F<ls> supports C<--quoting-style=shell>. 54arguments, which is very convenient, too, if your F<ls> supports
55C<--quoting-style=shell>.
48 56
57A double-click usually selects the word under the cursor, further clicks
58will enlarge the selection.
59
60The selection works by trying to match a number of regexes and displaying
61them in increasing order of length. You can add your own regexes by
62specifying resources of the form:
63
64 URxvt.selection.pattern-0: perl-regex
65 URxvt.selection.pattern-1: perl-regex
66 ...
67
68The index number (0, 1...) must not have any holes, and each regex must
69contain at least one pair of capturing parentheses, which will be used for
70the match. For example, the following adds a regex that matches everything
71between two vertical bars:
72
73 URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75Another example: Programs I use often output "absolute path: " at the
76beginning of a line when they process multiple files. The following
77pattern matches the filename (note, there is a single space at the very
78end):
79
80 URxvt.selection.pattern-0: ^(/[^:]+):\
81
82You can look at the source of the selection extension to see more
83interesting uses, such as parsing a line from beginning to end.
84
49It also offers the following bindable keyboard command: 85This extension also offers following bindable keyboard commands:
50 86
51=over 4 87=over 4
52 88
53=item rot13 89=item rot13
54 90
61=item option-popup (enabled by default) 97=item option-popup (enabled by default)
62 98
63Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
64runtime. 100runtime.
65 101
102Other extensions can extend this popup menu by pushing a code reference
103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104popup is being displayed.
105
106Its sole argument is the popup menu, which can be modified. It should
107either return nothing or a string, the initial boolean value and a code
108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as
110first argument.
111
112The following will add an entry C<myoption> that changes
113C<< $self->{myoption} >>:
114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
118
66=item selection-popup (enabled by default) 119=item selection-popup (enabled by default)
67 120
68Binds a popup menu to Ctrl-Button3 that lets you convert the selection 121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69text into various other formats/action (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<a>s:
138
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : ()
142 };
71 143
72=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
73 145
74Adds regex search functionality to the scrollback buffer, triggered 146Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 147by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 148input/output is suspended and a regex is displayed at the bottom of the
149screen.
77 150
78C</> starts an incremental regex search, C<n> searches further, C<p> or 151Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 154bottom. C<Escape> leaves search mode and returns to the point where search
155was started, while C<Enter> or C<Return> stay at the current position and
156additionally stores the first match in the current line into the primary
157selection if the C<Shift> modifier is active.
82 158
83=item digital-clock 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
84 162
85Displays a digital clock using the built-in overlay. 163See L<perlre> for more info about perl regular expression syntax.
86 164
87=item mark-urls 165=item readline (enabled by default)
88 166
167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters).
172
173To avoid too many false positives, this is only done when:
174
175=over 4
176
177=item - the tty is in ICANON state.
178
179=item - the text cursor is visible.
180
181=item - the primary screen is currently being displayed.
182
183=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
189
190=item selection-autotransform
191
192This selection allows you to do automatic transforms on a selection
193whenever a selection is made.
194
195It works by specifying perl snippets (most useful is a single C<s///>
196operator) that modify C<$_> as resources:
197
198 URxvt.selection-autotransform.0: transform
199 URxvt.selection-autotransform.1: transform
200 ...
201
202For example, the following will transform selections of the form
203C<filename:number>, often seen in compiler messages, into C<vi +$filename
204$word>:
205
206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208And this example matches the same,but replaces it with vi-commands you can
209paste directly into your (vi :) editor:
210
211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213Of course, this can be modified to suit your needs and your editor :)
214
215To expand the example above to typical perl error messages ("XXX at
216FILENAME line YYY."), you need a slightly more elaborate solution:
217
218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221The first line tells the selection code to treat the unchanging part of
222every error message as a selection pattern, and the second line transforms
223the message into vi commands to load the file.
224
225=item tabbed
226
227This transforms the terminal into a tabbar with additional terminals, that
228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230button per tab.
231
232Clicking a button will activate that tab. Pressing B<Shift-Left> and
233B<Shift-Right> will switch to the tab left or right of the current one,
234while B<Shift-Down> creates a new tab.
235
236The tabbar itself can be configured similarly to a normal terminal, but
237with a resource class of C<URxvt.tabbed>. In addition, it supports the
238following four resources (shown with defaults):
239
240 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242 URxvt.tabbed.tab-fg: <colour-index, default 0>
243 URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246indices.
247
248=item matcher
249
89Uses per-line display filtering (C<on_line_update>) to underline urls. 250Uses per-line display filtering (C<on_line_update>) to underline text
251matching a certain pattern and make it clickable. When clicked with the
252mouse button specified in the C<matcher.button> resource (default 2, or
253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
276
277=item xim-onthespot
278
279This (experimental) perl extension implements OnTheSpot editing. It does
280not work perfectly, and some input methods don't seem to work well with
281OnTheSpot editing in general, but it seems to work at least for SCIM and
282kinput2.
283
284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.:
286
287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289=item kuake<hotkey>
290
291A very primitive quake-console-like extension. It was inspired by a
292description of how the programs C<kuake> and C<yakuake> work: Whenever the
293user presses a global accelerator key (by default C<F10>), the terminal
294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
296
297Initially, the window will not be shown when using this extension.
298
299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key.
301
302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function.
304
305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it).
307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
90 313
91=item block-graphics-to-ascii 314=item block-graphics-to-ascii
92 315
93A not very useful example of filtering all text output to the terminal, 316A not very useful example of filtering all text output to the terminal
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 318similar-looking ascii character.
319
320=item digital-clock
321
322Displays a digital clock using the built-in overlay.
323
324=item remote-clipboard
325
326Somewhat of a misnomer, this extension adds two menu entries to the
327selection popup that allows one to run external commands to store the
328selection somewhere and fetch it again.
329
330We use it to implement a "distributed selection mechanism", which just
331means that one command uploads the file to a remote server, and another
332reads it.
333
334The commands can be set using the C<URxvt.remote-selection.store> and
335C<URxvt.remote-selection.fetch> resources. The first should read the
336selection to store from STDIN (always in UTF-8), the second should provide
337the selection data on STDOUT (also in UTF-8).
338
339The defaults (which are likely useless to you) use rsh and cat:
340
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343
344=item selection-pastebin
345
346This is a little rarely useful extension that uploads the selection as
347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.).
350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
352i.e.
353
354 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
355
356Pressing this combination runs a command with C<%> replaced by the name of
357the textfile. This command can be set via a resource:
358
359 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
360
361And the default is likely not useful to anybody but the few people around
362here :)
363
364The name of the textfile is the hex encoded md5 sum of the selection, so
365the same content should lead to the same filename.
366
367After a successful upload the selection will be replaced by the text given
368in the C<selection-pastebin-url> resource (again, the % is the placeholder
369for the filename):
370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of whether xrdb is used to parse the resource file
376or not.
377
378=item macosx-clipboard and macosx-clipboard-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<macosx-clipboard> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
96 391
97=item example-refresh-hooks 392=item example-refresh-hooks
98 393
99Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 396overlays or changes.
397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
102 402
103=back 403=back
104 404
105=head1 API DOCUMENTATION 405=head1 API DOCUMENTATION
106 406
122 422
123=over 4 423=over 4
124 424
125=item $text 425=item $text
126 426
127Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
128always represents one screen cell. See L<row_t> for a discussion of this format. 428always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 429
130=item $string 430=item $string
131 431
132A perl text string, with an emphasis on I<text>. It can store all unicode 432A perl text string, with an emphasis on I<text>. It can store all unicode
133characters and is to be distinguished with text encoded in a specific 433characters and is to be distinguished with text encoded in a specific
140 440
141=back 441=back
142 442
143=head2 Extension Objects 443=head2 Extension Objects
144 444
145Very perl extension is a perl class. A separate perl object is created 445Every perl extension is a perl class. A separate perl object is created
146for each terminal and each extension and passed as the first parameter to 446for each terminal, and each terminal has its own set of extension objects,
147hooks. So extensions can use their C<$self> object without having to think 447which are passed as the first parameter to hooks. So extensions can use
148about other extensions, with the exception of methods and members that 448their C<$self> object without having to think about clashes with other
449extensions or other terminals, with the exception of methods and members
149begin with an underscore character C<_>: these are reserved for internal 450that begin with an underscore character C<_>: these are reserved for
150use. 451internal use.
151 452
152Although it isn't a C<urxvt::term> object, you can call all methods of the 453Although it isn't a C<urxvt::term> object, you can call all methods of the
153C<urxvt::term> class on this object. 454C<urxvt::term> class on this object.
154 455
155It has the following methods and data members: 456It has the following methods and data members:
176=head2 Hooks 477=head2 Hooks
177 478
178The following subroutines can be declared in extension files, and will be 479The following subroutines can be declared in extension files, and will be
179called whenever the relevant event happens. 480called whenever the relevant event happens.
180 481
181The first argument passed to them is an extension oject as described in 482The first argument passed to them is an extension object as described in
182the in the C<Extension Objects> section. 483the in the C<Extension Objects> section.
183 484
184B<All> of these hooks must return a boolean value. If it is true, then the 485B<All> of these hooks must return a boolean value. If any of the called
185event counts as being I<consumed>, and the invocation of other hooks is 486hooks returns true, then the event counts as being I<consumed>, and the
186skipped, and the relevant action might not be carried out by the C++ code. 487relevant action might not be carried out by the C++ code.
187 488
188I<< When in doubt, return a false value (preferably C<()>). >> 489I<< When in doubt, return a false value (preferably C<()>). >>
189 490
190=over 4 491=over 4
191 492
192=item on_init $term 493=item on_init $term
193 494
194Called after a new terminal object has been initialized, but before 495Called after a new terminal object has been initialized, but before
195windows are created or the command gets run. Most methods are unsafe to 496windows are created or the command gets run. Most methods are unsafe to
196call or deliver senseless data, as terminal size and other characteristics 497call or deliver senseless data, as terminal size and other characteristics
197have not yet been determined. You can safely query and change resources, 498have not yet been determined. You can safely query and change resources
198though. 499and options, though. For many purposes the C<on_start> hook is a better
500place.
501
502=item on_start $term
503
504Called at the very end of initialisation of a new terminal, just before
505trying to map (display) the toplevel and returning to the main loop.
506
507=item on_destroy $term
508
509Called whenever something tries to destroy terminal, when the terminal is
510still fully functional (not for long, though).
199 511
200=item on_reset $term 512=item on_reset $term
201 513
202Called after the screen is "reset" for any reason, such as resizing or 514Called after the screen is "reset" for any reason, such as resizing or
203control sequences. Here is where you can react on changes to size-related 515control sequences. Here is where you can react on changes to size-related
204variables. 516variables.
205 517
206=item on_start $term 518=item on_child_start $term, $pid
207 519
208Called at the very end of initialisation of a new terminal, just before 520Called just after the child process has been C<fork>ed.
209returning to the mainloop. 521
522=item on_child_exit $term, $status
523
524Called just after the child process has exited. C<$status> is the status
525from C<waitpid>.
210 526
211=item on_sel_make $term, $eventtime 527=item on_sel_make $term, $eventtime
212 528
213Called whenever a selection has been made by the user, but before the 529Called whenever a selection has been made by the user, but before the
214selection text is copied, so changes to the beginning, end or type of the 530selection text is copied, so changes to the beginning, end or type of the
221 537
222Called whenever a selection has been copied, but before the selection is 538Called whenever a selection has been copied, but before the selection is
223requested from the server. The selection text can be queried and changed 539requested from the server. The selection text can be queried and changed
224by calling C<< $term->selection >>. 540by calling C<< $term->selection >>.
225 541
226Returning a true value aborts selection grabbing. It will still be hilighted. 542Returning a true value aborts selection grabbing. It will still be highlighted.
227 543
228=item on_sel_extend $term 544=item on_sel_extend $term
229 545
230Called whenever the user tries to extend the selection (e.g. with a double 546Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 547click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 548should extend the selection itself and return true to suppress the built-in
233processing. 549processing. This can happen multiple times, as long as the callback
550returns true, it will be called on every further click by the user and is
551supposed to enlarge the selection more and more, if possible.
234 552
235See the F<selection> example extension. 553See the F<selection> example extension.
236 554
237=item on_view_change $term, $offset 555=item on_view_change $term, $offset
238 556
239Called whenever the view offset changes, i..e the user or program 557Called whenever the view offset changes, i.e. the user or program
240scrolls. Offset C<0> means display the normal terminal, positive values 558scrolls. Offset C<0> means display the normal terminal, positive values
241show this many lines of scrollback. 559show this many lines of scrollback.
242 560
243=item on_scroll_back $term, $lines, $saved 561=item on_scroll_back $term, $lines, $saved
244 562
248 566
249It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 567It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 568$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
252 570
253=item on_osc_seq $term, $string 571=item on_osc_seq $term, $op, $args, $resp
572
573Called on every OSC sequence and can be used to suppress it or modify its
574behaviour. The default should be to return an empty list. A true value
575suppresses execution of the request completely. Make sure you don't get
576confused by recursive invocations when you output an OSC sequence within
577this callback.
578
579C<on_osc_seq_perl> should be used for new behaviour.
580
581=item on_osc_seq_perl $term, $args, $resp
254 582
255Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
257information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
258string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
259it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
260future. 588enforced in the future.
589
590For example, C<overlay-osc> uses this:
591
592 sub on_osc_seq_perl {
593 my ($self, $osc, $resp) = @_;
594
595 return unless $osc =~ s/^overlay;//;
596
597 ... process remaining $osc string
598 }
261 599
262Be careful not ever to trust (in a security sense) the data you receive, 600Be careful not ever to trust (in a security sense) the data you receive,
263as its source can not easily be controleld (e-mail content, messages from 601as its source can not easily be controlled (e-mail content, messages from
264other users on the same system etc.). 602other users on the same system etc.).
603
604For responses, C<$resp> contains the end-of-args separator used by the
605sender.
265 606
266=item on_add_lines $term, $string 607=item on_add_lines $term, $string
267 608
268Called whenever text is about to be output, with the text as argument. You 609Called whenever text is about to be output, with the text as argument. You
269can filter/change and output the text yourself by returning a true value 610can filter/change and output the text yourself by returning a true value
274=item on_tt_write $term, $octets 615=item on_tt_write $term, $octets
275 616
276Called whenever some data is written to the tty/pty and can be used to 617Called whenever some data is written to the tty/pty and can be used to
277suppress or filter tty input. 618suppress or filter tty input.
278 619
620=item on_tt_paste $term, $octets
621
622Called whenever text is about to be pasted, with the text as argument. You
623can filter/change and paste the text yourself by returning a true value
624and calling C<< $term->tt_paste >> yourself. C<$octets> is
625locale-encoded.
626
279=item on_line_update $term, $row 627=item on_line_update $term, $row
280 628
281Called whenever a line was updated or changed. Can be used to filter 629Called whenever a line was updated or changed. Can be used to filter
282screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
283that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
290later with the already-modified line (e.g. if unrelated parts change), so 638later with the already-modified line (e.g. if unrelated parts change), so
291you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
292 640
293=item on_refresh_begin $term 641=item on_refresh_begin $term
294 642
295Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
296or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
297restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
298code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
299 647
300=item on_refresh_end $term 648=item on_refresh_end $term
301 649
302Called just after the screen gets redrawn. See C<on_refresh_begin>. 650Called just after the screen gets redrawn. See C<on_refresh_begin>.
303 651
304=item on_keyboard_command $term, $string 652=item on_user_command $term, $string
305 653
306Called whenever the user presses a key combination that has a 654Called whenever a user-configured event is being activated (e.g. via
307C<perl:string> action bound to it (see description of the B<keysym> 655a C<perl:string> action bound to a key, see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 656resource in the @@RXVT_NAME@@(1) manpage).
657
658The event is simply the action string. This interface is assumed to change
659slightly in the future.
660
661=item on_resize_all_windows $term, $new_width, $new_height
662
663Called just after the new window size has been calculated, but before
664windows are actually being resized or hints are being set. If this hook
665returns TRUE, setting of the window hints is being skipped.
666
667=item on_x_event $term, $event
668
669Called on every X event received on the vt window (and possibly other
670windows). Should only be used as a last resort. Most event structure
671members are not passed.
672
673=item on_root_event $term, $event
674
675Like C<on_x_event>, but is called for events on the root window.
309 676
310=item on_focus_in $term 677=item on_focus_in $term
311 678
312Called whenever the window gets the keyboard focus, before rxvt-unicode 679Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 680does focus in processing.
314 681
315=item on_focus_out $term 682=item on_focus_out $term
316 683
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called whenever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 685focus out processing.
319 686
687=item on_configure_notify $term, $event
688
689=item on_property_notify $term, $event
690
320=item on_key_press $term, $event, $keysym, $octets 691=item on_key_press $term, $event, $keysym, $octets
321 692
322=item on_key_release $term, $event, $keysym 693=item on_key_release $term, $event, $keysym
323 694
324=item on_button_press $term, $event 695=item on_button_press $term, $event
329 700
330=item on_map_notify $term, $event 701=item on_map_notify $term, $event
331 702
332=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
333 704
334Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
335the hook returns true, then the even will be ignored by rxvt-unicode. 706the hook returns true, then the event will be ignored by rxvt-unicode.
336 707
337The event is a hash with most values as named by Xlib (see the XEvent 708The event is a hash with most values as named by Xlib (see the XEvent
338manpage), with the additional members C<row> and C<col>, which are the row 709manpage), with the additional members C<row> and C<col>, which are the
339and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
340 711
341C<on_key_press> additionally receives the string rxvt-unicode would 712C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 713output, if any, in locale-specific encoding.
343 714
344subwindow. 715subwindow.
345 716
346=back 717=item on_client_message $term, $event
347 718
348=head2 Variables in the C<urxvt> Package 719=item on_wm_protocols $term, $event
349 720
350=over 4 721=item on_wm_delete_window $term, $event
351 722
352=item $urxvt::LIBDIR 723Called when various types of ClientMessage events are received (all with
724format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
353 725
354The rxvt-unicode library directory, where, among other things, the perl 726=item on_bell $term
355modules and scripts are stored.
356 727
357=item $urxvt::RESCLASS, $urxvt::RESCLASS 728Called on receipt of a bell character.
358
359The resource class and name rxvt-unicode uses to look up X resources.
360
361=item $urxvt::RXVTNAME
362
363The basename of the installed binaries, usually C<urxvt>.
364
365=item $urxvt::TERM
366
367The current terminal. This variable stores the current C<urxvt::term>
368object, whenever a callback/hook is executing.
369
370=item
371
372=back
373
374=head2 Functions in the C<urxvt> Package
375
376=over 4
377
378=item $term = new urxvt [arg...]
379
380Creates a new terminal, very similar as if you had started it with
381C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382if the new instance couldn't be created. Returns C<undef> if the new
383instance didn't initialise perl, and the terminal object otherwise. The
384C<init> and C<start> hooks will be called during the call.
385
386=item urxvt::fatal $errormessage
387
388Fatally aborts execution with the given error message. Avoid at all
389costs! The only time this is acceptable is when the terminal process
390starts up.
391
392=item urxvt::warn $string
393
394Calls C<rxvt_warn> with the given string which should not include a
395newline. The module also overwrites the C<warn> builtin with a function
396that calls this function.
397
398Using this function has the advantage that its output ends up in the
399correct place, e.g. on stderr of the connecting urxvtc client.
400
401=item $is_safe = urxvt::safe
402
403Returns true when it is safe to do potentially unsafe things, such as
404evaluating perl code specified by the user. This is true when urxvt was
405started setuid or setgid.
406
407=item $time = urxvt::NOW
408
409Returns the "current time" (as per the event loop).
410
411=item urxvt::CurrentTime
412
413=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415Button4Mask, Button5Mask, AnyModifier
416
417Various constants for use in X calls and event processing.
418
419=back
420
421=head2 RENDITION
422
423Rendition bitsets contain information about colour, font, font styles and
424similar information for each screen cell.
425
426The following "macros" deal with changes in rendition sets. You should
427never just create a bitset, you should always modify an existing one,
428as they contain important information required for correct operation of
429rxvt-unicode.
430
431=over 4
432
433=item $rend = urxvt::DEFAULT_RSTYLE
434
435Returns the default rendition, as used when the terminal is starting up or
436being reset. Useful as a base to start when creating renditions.
437
438=item $rend = urxvt::OVERLAY_RSTYLE
439
440Return the rendition mask used for overlays by default.
441
442=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444Return the bit that enabled bold, italic, blink, reverse-video and
445underline, respectively. To enable such a style, just logically OR it into
446the bitset.
447
448=item $foreground = urxvt::GET_BASEFG $rend
449
450=item $background = urxvt::GET_BASEBG $rend
451
452Return the foreground/background colour index, respectively.
453
454=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458Replace the foreground/background colour in the rendition mask with the
459specified one.
460
461=item $value = urxvt::GET_CUSTOM $rend
462
463Return the "custom" value: Every rendition has 5 bits for use by
464extensions. They can be set and changed as you like and are initially
465zero.
466
467=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469Change the custom value.
470 729
471=back 730=back
472 731
473=cut 732=cut
474 733
480use Scalar::Util (); 739use Scalar::Util ();
481use List::Util (); 740use List::Util ();
482 741
483our $VERSION = 1; 742our $VERSION = 1;
484our $TERM; 743our $TERM;
744our @TERM_INIT;
745our @TERM_EXT;
485our @HOOKNAME; 746our @HOOKNAME;
486our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 747our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487our %OPTION; 748our %OPTION;
488 749
489our $LIBDIR; 750our $LIBDIR;
490our $RESNAME; 751our $RESNAME;
491our $RESCLASS; 752our $RESCLASS;
492our $RXVTNAME; 753our $RXVTNAME;
493 754
755our $NOCHAR = chr 0xffff;
756
757=head2 Variables in the C<urxvt> Package
758
759=over 4
760
761=item $urxvt::LIBDIR
762
763The rxvt-unicode library directory, where, among other things, the perl
764modules and scripts are stored.
765
766=item $urxvt::RESCLASS, $urxvt::RESCLASS
767
768The resource class and name rxvt-unicode uses to look up X resources.
769
770=item $urxvt::RXVTNAME
771
772The basename of the installed binaries, usually C<urxvt>.
773
774=item $urxvt::TERM
775
776The current terminal. This variable stores the current C<urxvt::term>
777object, whenever a callback/hook is executing.
778
779=item @urxvt::TERM_INIT
780
781All code references in this array will be called as methods of the next newly
782created C<urxvt::term> object (during the C<on_init> phase). The array
783gets cleared before the code references that were in it are being executed,
784so references can push themselves onto it again if they so desire.
785
786This complements to the perl-eval command line option, but gets executed
787first.
788
789=item @urxvt::TERM_EXT
790
791Works similar to C<@TERM_INIT>, but contains perl package/class names, which
792get registered as normal extensions after calling the hooks in C<@TERM_INIT>
793but before other extensions. Gets cleared just like C<@TERM_INIT>.
794
795=back
796
797=head2 Functions in the C<urxvt> Package
798
799=over 4
800
801=item urxvt::fatal $errormessage
802
803Fatally aborts execution with the given error message (which should
804include a trailing newline). Avoid at all costs! The only time this
805is acceptable (and useful) is in the init hook, where it prevents the
806terminal from starting up.
807
808=item urxvt::warn $string
809
810Calls C<rxvt_warn> with the given string which should include a trailing
811newline. The module also overwrites the C<warn> builtin with a function
812that calls this function.
813
814Using this function has the advantage that its output ends up in the
815correct place, e.g. on stderr of the connecting urxvtc client.
816
817Messages have a size limit of 1023 bytes currently.
818
819=item @terms = urxvt::termlist
820
821Returns all urxvt::term objects that exist in this process, regardless of
822whether they are started, being destroyed etc., so be careful. Only term
823objects that have perl extensions attached will be returned (because there
824is no urxvt::term object associated with others).
825
826=item $time = urxvt::NOW
827
828Returns the "current time" (as per the event loop).
829
830=item urxvt::CurrentTime
831
832=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
833Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
834Button4Mask, Button5Mask, AnyModifier
835
836=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
837ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
838PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
839Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
840KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
841ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
842FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
843
844=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
845EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
846GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
847UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
848ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
849CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
850SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
851
852Various constants for use in X calls and event processing.
853
854=back
855
856=head2 RENDITION
857
858Rendition bitsets contain information about colour, font, font styles and
859similar information for each screen cell.
860
861The following "macros" deal with changes in rendition sets. You should
862never just create a bitset, you should always modify an existing one,
863as they contain important information required for correct operation of
864rxvt-unicode.
865
866=over 4
867
868=item $rend = urxvt::DEFAULT_RSTYLE
869
870Returns the default rendition, as used when the terminal is starting up or
871being reset. Useful as a base to start when creating renditions.
872
873=item $rend = urxvt::OVERLAY_RSTYLE
874
875Return the rendition mask used for overlays by default.
876
877=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
878urxvt::RS_RVid, urxvt::RS_Uline
879
880Return the bit that enabled bold, italic, blink, reverse-video and
881underline, respectively. To enable such a style, just logically OR it into
882the bitset.
883
884=item $foreground = urxvt::GET_BASEFG $rend
885
886=item $background = urxvt::GET_BASEBG $rend
887
888Return the foreground/background colour index, respectively.
889
890=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
891
892=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
893
894=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
895
896Replace the foreground/background colour in the rendition mask with the
897specified one.
898
899=item $value = urxvt::GET_CUSTOM $rend
900
901Return the "custom" value: Every rendition has 5 bits for use by
902extensions. They can be set and changed as you like and are initially
903zero.
904
905=item $rend = urxvt::SET_CUSTOM $rend, $new_value
906
907Change the custom value.
908
909=back
910
911=cut
912
494BEGIN { 913BEGIN {
495 urxvt->bootstrap;
496
497 # overwrite perl's warn 914 # overwrite perl's warn
498 *CORE::GLOBAL::warn = sub { 915 *CORE::GLOBAL::warn = sub {
499 my $msg = join "", @_; 916 my $msg = join "", @_;
500 $msg .= "\n" 917 $msg .= "\n"
501 unless $msg =~ /\n$/; 918 unless $msg =~ /\n$/;
502 urxvt::warn ($msg); 919 urxvt::warn ($msg);
503 }; 920 };
504
505 delete $ENV{IFS};
506 delete $ENV{CDPATH};
507 delete $ENV{BASH_ENV};
508 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509} 921}
510 922
511my @hook_count; 923no warnings 'utf8';
924
512my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 925my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513 926
514sub verbose { 927sub verbose {
515 my ($level, $msg) = @_; 928 my ($level, $msg) = @_;
516 warn "$msg\n" if $level <= $verbosity; 929 warn "$msg\n" if $level <= $verbosity;
517} 930}
518 931
519my $extension_pkg = "extension0000";
520my %extension_pkg; 932my %extension_pkg;
521 933
522# load a single script into its own package, once only 934# load a single script into its own package, once only
523sub extension_package($) { 935sub extension_package($) {
524 my ($path) = @_; 936 my ($path) = @_;
525 937
526 $extension_pkg{$path} ||= do { 938 $extension_pkg{$path} ||= do {
527 my $pkg = "urxvt::" . ($extension_pkg++); 939 $path =~ /([^\/\\]+)$/;
940 my $pkg = $1;
941 $pkg =~ s/[^[:word:]]/_/g;
942 $pkg = "urxvt::ext::$pkg";
528 943
529 verbose 3, "loading extension '$path' into package '$pkg'"; 944 verbose 3, "loading extension '$path' into package '$pkg'";
530 945
531 open my $fh, "<:raw", $path 946 open my $fh, "<:raw", $path
532 or die "$path: $!"; 947 or die "$path: $!";
533 948
534 my $source = untaint 949 my $source =
535 "package $pkg; use strict; use utf8;\n" 950 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
536 . "use base urxvt::term::extension::;\n"
537 . "#line 1 \"$path\"\n{\n" 951 . "#line 1 \"$path\"\n{\n"
538 . (do { local $/; <$fh> }) 952 . (do { local $/; <$fh> })
539 . "\n};\n1"; 953 . "\n};\n1";
540 954
541 eval $source 955 eval $source
552 local $TERM = shift; 966 local $TERM = shift;
553 my $htype = shift; 967 my $htype = shift;
554 968
555 if ($htype == 0) { # INIT 969 if ($htype == 0) { # INIT
556 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 970 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
557 971
558 my %ext_arg; 972 my %ext_arg;
559 973
974 {
975 my @init = @TERM_INIT;
976 @TERM_INIT = ();
977 $_->($TERM) for @init;
978 my @pkg = @TERM_EXT;
979 @TERM_EXT = ();
980 $TERM->register_package ($_) for @pkg;
981 }
982
560 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 983 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561 if ($_ eq "default") { 984 if ($_ eq "default") {
562 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 985 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563 } elsif (/^-(.*)$/) { 986 } elsif (/^-(.*)$/) {
564 delete $ext_arg{$1}; 987 delete $ext_arg{$1};
565 } elsif (/^([^<]+)<(.*)>$/) { 988 } elsif (/^([^<]+)<(.*)>$/) {
566 push @{ $ext_arg{$1} }, $2; 989 push @{ $ext_arg{$1} }, $2;
567 } else { 990 } else {
568 $ext_arg{$_} ||= []; 991 $ext_arg{$_} ||= [];
569 } 992 }
570 } 993 }
571 994
572 while (my ($ext, $argv) = each %ext_arg) { 995 for my $ext (sort keys %ext_arg) {
573 my @files = grep -f $_, map "$_/$ext", @dirs; 996 my @files = grep -f $_, map "$_/$ext", @dirs;
574 997
575 if (@files) { 998 if (@files) {
576 $TERM->register_package (extension_package $files[0], $argv); 999 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
577 } else { 1000 } else {
578 warn "perl extension '$ext' not found in perl library search path\n"; 1001 warn "perl extension '$ext' not found in perl library search path\n";
579 } 1002 }
580 } 1003 }
581 1004
587 1010
588 if (my $cb = $TERM->{_hook}[$htype]) { 1011 if (my $cb = $TERM->{_hook}[$htype]) {
589 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1012 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
590 if $verbosity >= 10; 1013 if $verbosity >= 10;
591 1014
592 keys %$cb; 1015 for my $pkg (keys %$cb) {
593
594 while (my ($pkg, $cb) = each %$cb) {
595 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 1016 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
596 and last; 1017 $retval ||= $retval_;
597 1018
598 if ($@) { 1019 if ($@) {
599 $TERM->ungrab; # better to lose the grab than the session 1020 $TERM->ungrab; # better to lose the grab than the session
600 warn $@; 1021 warn $@;
601 } 1022 }
602 } 1023 }
1024
1025 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1026 if $verbosity >= 11;
603 } 1027 }
604 1028
605 if ($htype == 1) { # DESTROY 1029 if ($htype == 1) { # DESTROY
606 if (my $hook = delete $TERM->{_hook}) {
607 for my $htype (0..$#$hook) {
608 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
609 or set_should_invoke $htype, 0;
610 }
611 }
612
613 # clear package objects 1030 # clear package objects
614 %$_ = () for values %{ $TERM->{_pkg} }; 1031 %$_ = () for values %{ $TERM->{_pkg} };
615 1032
616 # clear package 1033 # clear package
617 %$TERM = (); 1034 %$TERM = ();
618 } 1035 }
619 1036
620 $retval 1037 $retval
1038}
1039
1040sub SET_COLOR($$$) {
1041 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1042}
1043
1044sub rend2mask {
1045 no strict 'refs';
1046 my ($str, $mask) = (@_, 0);
1047 my %color = ( fg => undef, bg => undef );
1048 my @failed;
1049 for my $spec ( split /\s+/, $str ) {
1050 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1051 $color{lc($1)} = $2;
1052 } else {
1053 my $neg = $spec =~ s/^[-^]//;
1054 unless ( exists &{"RS_$spec"} ) {
1055 push @failed, $spec;
1056 next;
1057 }
1058 my $cur = &{"RS_$spec"};
1059 if ( $neg ) {
1060 $mask &= ~$cur;
1061 } else {
1062 $mask |= $cur;
1063 }
1064 }
1065 }
1066 ($mask, @color{qw(fg bg)}, \@failed)
621} 1067}
622 1068
623# urxvt::term::extension 1069# urxvt::term::extension
624 1070
625package urxvt::term::extension; 1071package urxvt::term::extension;
631 while (my ($name, $cb) = each %hook) { 1077 while (my ($name, $cb) = each %hook) {
632 my $htype = $HOOKTYPE{uc $name}; 1078 my $htype = $HOOKTYPE{uc $name};
633 defined $htype 1079 defined $htype
634 or Carp::croak "unsupported hook type '$name'"; 1080 or Carp::croak "unsupported hook type '$name'";
635 1081
1082 $self->set_should_invoke ($htype, +1)
636 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 1083 unless exists $self->{term}{_hook}[$htype]{$pkg};
637 $hook_count[$htype]++
638 or urxvt::set_should_invoke $htype, 1;
639 }
640 1084
641 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1085 $self->{term}{_hook}[$htype]{$pkg} = $cb;
642 } 1086 }
643} 1087}
644 1088
649 for my $name (@hook) { 1093 for my $name (@hook) {
650 my $htype = $HOOKTYPE{uc $name}; 1094 my $htype = $HOOKTYPE{uc $name};
651 defined $htype 1095 defined $htype
652 or Carp::croak "unsupported hook type '$name'"; 1096 or Carp::croak "unsupported hook type '$name'";
653 1097
1098 $self->set_should_invoke ($htype, -1)
654 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 1099 if delete $self->{term}{_hook}[$htype]{$pkg};
655 --$hook_count[$htype]
656 or urxvt::set_should_invoke $htype, 0;
657 }
658 } 1100 }
659} 1101}
660 1102
661our $AUTOLOAD; 1103our $AUTOLOAD;
662 1104
700is that you cannot use blocking APIs, but the non-blocking variant should 1142is that you cannot use blocking APIs, but the non-blocking variant should
701work. 1143work.
702 1144
703=cut 1145=cut
704 1146
705our $VERSION = 1; 1147our $VERSION = '5.23';
706 1148
707$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1149$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
708push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1150push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
709 1151
710sub timer { 1152sub timer {
712 1154
713 my $cb = $arg{cb}; 1155 my $cb = $arg{cb};
714 1156
715 urxvt::timer 1157 urxvt::timer
716 ->new 1158 ->new
717 ->start (urxvt::NOW + $arg{after}) 1159 ->after ($arg{after}, $arg{interval})
718 ->cb (sub { 1160 ->cb ($arg{interval} ? $cb : sub {
719 $_[0]->stop; # need to cancel manually 1161 $_[0]->stop; # need to cancel manually
720 $cb->(); 1162 $cb->();
721 }) 1163 })
722} 1164}
723 1165
724sub io { 1166sub io {
725 my ($class, %arg) = @_; 1167 my ($class, %arg) = @_;
726 1168
727 my $cb = $arg{cb}; 1169 my $cb = $arg{cb};
1170 my $fd = fileno $arg{fh};
1171 defined $fd or $fd = $arg{fh};
728 1172
729 bless [$arg{fh}, urxvt::iow 1173 bless [$arg{fh}, urxvt::iow
730 ->new 1174 ->new
731 ->fd (fileno $arg{fh}) 1175 ->fd ($fd)
732 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1176 ->events (($arg{poll} =~ /r/ ? 1 : 0)
733 | ($arg{poll} =~ /w/ ? 2 : 0)) 1177 | ($arg{poll} =~ /w/ ? 2 : 0))
734 ->start 1178 ->start
735 ->cb (sub { 1179 ->cb ($cb)
736 $cb->(($_[1] & 1 ? 'r' : '')
737 . ($_[1] & 2 ? 'w' : ''));
738 })],
739 urxvt::anyevent:: 1180 ], urxvt::anyevent::
1181}
1182
1183sub idle {
1184 my ($class, %arg) = @_;
1185
1186 my $cb = $arg{cb};
1187
1188 urxvt::iw
1189 ->new
1190 ->start
1191 ->cb ($cb)
1192}
1193
1194sub child {
1195 my ($class, %arg) = @_;
1196
1197 my $cb = $arg{cb};
1198
1199 urxvt::pw
1200 ->new
1201 ->start ($arg{pid})
1202 ->cb (sub {
1203 $_[0]->stop; # need to cancel manually
1204 $cb->($_[0]->rpid, $_[0]->rstatus);
1205 })
740} 1206}
741 1207
742sub DESTROY { 1208sub DESTROY {
743 $_[0][1]->stop; 1209 $_[0][1]->stop;
744} 1210}
745 1211
746sub condvar { 1212sub one_event {
747 bless \my $flag, urxvt::anyevent::condvar::
748}
749
750sub urxvt::anyevent::condvar::broadcast {
751 ${$_[0]}++;
752}
753
754sub urxvt::anyevent::condvar::wait {
755 unless (${$_[0]}) {
756 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1213 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
757 }
758} 1214}
759 1215
760package urxvt::term; 1216package urxvt::term;
761 1217
762=head2 The C<urxvt::term> Class 1218=head2 The C<urxvt::term> Class
767 1223
768# find on_xxx subs in the package and register them 1224# find on_xxx subs in the package and register them
769# as hooks 1225# as hooks
770sub register_package { 1226sub register_package {
771 my ($self, $pkg, $argv) = @_; 1227 my ($self, $pkg, $argv) = @_;
1228
1229 no strict 'refs';
1230
1231 urxvt::verbose 6, "register package $pkg to $self";
1232
1233 @{"$pkg\::ISA"} = urxvt::term::extension::;
772 1234
773 my $proxy = bless { 1235 my $proxy = bless {
774 _pkg => $pkg, 1236 _pkg => $pkg,
775 argv => $argv, 1237 argv => $argv,
776 }, $pkg; 1238 }, $pkg;
783 $proxy->enable ($name => $ref); 1245 $proxy->enable ($name => $ref);
784 } 1246 }
785 } 1247 }
786} 1248}
787 1249
1250=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1251
1252Creates a new terminal, very similar as if you had started it with system
1253C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1254hash which defines the environment of the new terminal.
1255
1256Croaks (and probably outputs an error message) if the new instance
1257couldn't be created. Returns C<undef> if the new instance didn't
1258initialise perl, and the terminal object otherwise. The C<init> and
1259C<start> hooks will be called before this call returns, and are free to
1260refer to global data (which is race free).
1261
1262=cut
1263
1264sub new {
1265 my ($class, $env, @args) = @_;
1266
1267 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1268 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1269
1270 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1271}
1272
788=item $term->destroy 1273=item $term->destroy
789 1274
790Destroy the terminal object (close the window, free resources 1275Destroy the terminal object (close the window, free resources
791etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1276etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792watchers (timers, io watchers) are still active. 1277watchers (timers, io watchers) are still active.
793 1278
1279=item $term->exec_async ($cmd[, @args])
1280
1281Works like the combination of the C<fork>/C<exec> builtins, which executes
1282("starts") programs in the background. This function takes care of setting
1283the user environment before exec'ing the command (e.g. C<PATH>) and should
1284be preferred over explicit calls to C<exec> or C<system>.
1285
1286Returns the pid of the subprocess or C<undef> on error.
1287
1288=cut
1289
1290sub exec_async {
1291 my $self = shift;
1292
1293 my $pid = fork;
1294
1295 return $pid
1296 if !defined $pid or $pid;
1297
1298 %ENV = %{ $self->env };
1299
1300 exec @_;
1301 urxvt::_exit 255;
1302}
1303
794=item $isset = $term->option ($optval[, $set]) 1304=item $isset = $term->option ($optval[, $set])
795 1305
796Returns true if the option specified by C<$optval> is enabled, and 1306Returns true if the option specified by C<$optval> is enabled, and
797optionally change it. All option values are stored by name in the hash 1307optionally change it. All option values are stored by name in the hash
798C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1308C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
799 1309
800Here is a a likely non-exhaustive list of option names, please see the 1310Here is a likely non-exhaustive list of option names, please see the
801source file F</src/optinc.h> to see the actual list: 1311source file F</src/optinc.h> to see the actual list:
802 1312
803 borderLess console cursorBlink cursorUnderline hold iconic insecure 1313 borderLess console cursorBlink cursorUnderline hold iconic insecure
804 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1314 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
805 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1315 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
806 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1316 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
807 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1317 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
808 tripleclickwords utmpInhibit visualBell 1318 transparent tripleclickwords utmpInhibit visualBell
809 1319
810=item $value = $term->resource ($name[, $newval]) 1320=item $value = $term->resource ($name[, $newval])
811 1321
812Returns the current resource value associated with a given name and 1322Returns the current resource value associated with a given name and
813optionally sets a new value. Setting values is most useful in the C<init> 1323optionally sets a new value. Setting values is most useful in the C<init>
822likely change). 1332likely change).
823 1333
824Please note that resource strings will currently only be freed when the 1334Please note that resource strings will currently only be freed when the
825terminal is destroyed, so changing options frequently will eat memory. 1335terminal is destroyed, so changing options frequently will eat memory.
826 1336
827Here is a a likely non-exhaustive list of resource names, not all of which 1337Here is a likely non-exhaustive list of resource names, not all of which
828are supported in every build, please see the source file F</src/rsinc.h> 1338are supported in every build, please see the source file F</src/rsinc.h>
829to see the actual list: 1339to see the actual list:
830 1340
831 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1341 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
832 borderLess color cursorBlink cursorUnderline cutchars delete_key 1342 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
833 display_name embed ext_bwidth fade font geometry hold iconName 1343 display_name embed ext_bwidth fade font geometry hold iconName
834 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1344 imFont imLocale inputMethod insecure int_bwidth intensityStyles
835 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1345 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
836 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1346 modifier mouseWheelScrollPage name override_redirect pastableTabs path
837 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1347 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1348 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1349 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1350 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841 shade term_name title transparent transparent_all tripleclickwords 1351 secondaryScreen secondaryScroll shade term_name title
842 utmpInhibit visualBell 1352 transient_for transparent transparent_all tripleclickwords utmpInhibit
1353 visualBell
843 1354
844=cut 1355=cut
845 1356
846sub resource($$;$) { 1357sub resource($$;$) {
847 my ($self, $name) = (shift, shift); 1358 my ($self, $name) = (shift, shift);
848 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1359 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849 &urxvt::term::_resource 1360 goto &urxvt::term::_resource
850} 1361}
1362
1363=item $value = $term->x_resource ($pattern)
1364
1365Returns the X-Resource for the given pattern, excluding the program or
1366class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1367same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1368resource with that pattern exists.
1369
1370This method should only be called during the C<on_start> hook, as there is
1371only one resource database per display, and later invocations might return
1372the wrong resources.
851 1373
852=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1374=item $success = $term->parse_keysym ($keysym_spec, $command_string)
853 1375
854Adds a keymap translation exactly as specified via a resource. See the 1376Adds a keymap translation exactly as specified via a resource. See the
855C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1377C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
868 1390
869=item ($row, $col) = $term->selection_beg ([$row, $col]) 1391=item ($row, $col) = $term->selection_beg ([$row, $col])
870 1392
871=item ($row, $col) = $term->selection_end ([$row, $col]) 1393=item ($row, $col) = $term->selection_end ([$row, $col])
872 1394
873Return the current values of the selection mark, begin or end positions, 1395Return the current values of the selection mark, begin or end positions.
874and optionally set them to new values.
875 1396
1397When arguments are given, then the selection coordinates are set to
1398C<$row> and C<$col>, and the selection screen is set to the current
1399screen.
1400
1401=item $screen = $term->selection_screen ([$screen])
1402
1403Returns the current selection screen, and then optionally sets it.
1404
1405=item $term->selection_make ($eventtime[, $rectangular])
1406
1407Tries to make a selection as set by C<selection_beg> and
1408C<selection_end>. If C<$rectangular> is true (default: false), a
1409rectangular selection will be made. This is the preferred function to make
1410a selection.
1411
876=item $success = $term->selection_grab ($eventtime) 1412=item $success = $term->selection_grab ($eventtime[, $clipboard])
877 1413
878Try to request the primary selection from the server (for example, as set 1414Try to acquire ownership of the primary (clipboard if C<$clipboard> is
879by the next method). 1415true) selection from the server. The corresponding text can be set
1416with the next method. No visual feedback will be given. This function
1417is mostly useful from within C<on_sel_grab> hooks.
880 1418
881=item $oldtext = $term->selection ([$newtext]) 1419=item $oldtext = $term->selection ([$newtext, $clipboard])
882 1420
883Return the current selection text and optionally replace it by C<$newtext>. 1421Return the current selection (clipboard if C<$clipboard> is true) text
1422and optionally replace it by C<$newtext>.
1423
1424=item $term->selection_clear ([$clipboard])
1425
1426Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
884 1427
885=item $term->overlay_simple ($x, $y, $text) 1428=item $term->overlay_simple ($x, $y, $text)
886 1429
887Create a simple multi-line overlay box. See the next method for details. 1430Create a simple multi-line overlay box. See the next method for details.
888 1431
918 1461
919The methods currently supported on C<urxvt::overlay> objects are: 1462The methods currently supported on C<urxvt::overlay> objects are:
920 1463
921=over 4 1464=over 4
922 1465
923=item $overlay->set ($x, $y, $text, $rend) 1466=item $overlay->set ($x, $y, $text[, $rend])
924 1467
925Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1468Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
926text in rxvt-unicode's special encoding and an array of rendition values 1469text in rxvt-unicode's special encoding and an array of rendition values
927at a specific position inside the overlay. 1470at a specific position inside the overlay.
1471
1472If C<$rend> is missing, then the rendition will not be changed.
928 1473
929=item $overlay->hide 1474=item $overlay->hide
930 1475
931If visible, hide the overlay, but do not destroy it. 1476If visible, hide the overlay, but do not destroy it.
932 1477
977Convert the given locale-encoded octets into a perl string. 1522Convert the given locale-encoded octets into a perl string.
978 1523
979=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1524=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980 1525
981XORs the rendition values in the given span with the provided value 1526XORs the rendition values in the given span with the provided value
982(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1527(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983to the selection. 1528refresh hooks to provide effects similar to the selection.
984 1529
985=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1530=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986 1531
987Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1532Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988whitespace will additionally be xored with the C<$rstyle2>, which defaults 1533whitespace will additionally be xored with the C<$rstyle2>, which defaults
989to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1534to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990it instead. 1535it instead. Both styles I<MUST NOT> contain font styles.
991 1536
992=item $term->scr_bell 1537=item $term->scr_bell
993 1538
994Ring the bell! 1539Ring the bell!
995 1540
1002 1547
1003Normally its not a good idea to use this function, as programs might be 1548Normally its not a good idea to use this function, as programs might be
1004confused by changes in cursor position or scrolling. Its useful inside a 1549confused by changes in cursor position or scrolling. Its useful inside a
1005C<on_add_lines> hook, though. 1550C<on_add_lines> hook, though.
1006 1551
1552=item $term->scr_change_screen ($screen)
1553
1554Switch to given screen - 0 primary, 1 secondary.
1555
1007=item $term->cmd_parse ($octets) 1556=item $term->cmd_parse ($octets)
1008 1557
1009Similar to C<scr_add_lines>, but the argument must be in the 1558Similar to C<scr_add_lines>, but the argument must be in the
1010locale-specific encoding of the terminal and can contain command sequences 1559locale-specific encoding of the terminal and can contain command sequences
1011(escape codes) that will be interpreted. 1560(escape codes) that will be interpreted.
1012 1561
1013=item $term->tt_write ($octets) 1562=item $term->tt_write ($octets)
1014 1563
1015Write the octets given in C<$data> to the tty (i.e. as program input). To 1564Write the octets given in C<$octets> to the tty (i.e. as program input). To
1016pass characters instead of octets, you should convert your strings first 1565pass characters instead of octets, you should convert your strings first
1017to the locale-specific encoding using C<< $term->locale_encode >>. 1566to the locale-specific encoding using C<< $term->locale_encode >>.
1567
1568=item $term->tt_paste ($octets)
1569
1570Write the octets given in C<$octets> to the tty as a paste, converting NL to
1571CR and bracketing the data with control sequences if bracketed paste mode
1572is set.
1018 1573
1019=item $old_events = $term->pty_ev_events ([$new_events]) 1574=item $old_events = $term->pty_ev_events ([$new_events])
1020 1575
1021Replaces the event mask of the pty watcher by the given event mask. Can 1576Replaces the event mask of the pty watcher by the given event mask. Can
1022be used to suppress input and output handling to the pty/tty. See the 1577be used to suppress input and output handling to the pty/tty. See the
1023description of C<< urxvt::timer->events >>. Make sure to always restore 1578description of C<< urxvt::timer->events >>. Make sure to always restore
1024the previous value. 1579the previous value.
1025 1580
1581=item $fd = $term->pty_fd
1582
1583Returns the master file descriptor for the pty in use, or C<-1> if no pty
1584is used.
1585
1026=item $windowid = $term->parent 1586=item $windowid = $term->parent
1027 1587
1028Return the window id of the toplevel window. 1588Return the window id of the toplevel window.
1029 1589
1030=item $windowid = $term->vt 1590=item $windowid = $term->vt
1031 1591
1032Return the window id of the terminal window. 1592Return the window id of the terminal window.
1033 1593
1594=item $term->vt_emask_add ($x_event_mask)
1595
1596Adds the specified events to the vt event mask. Useful e.g. when you want
1597to receive pointer events all the times:
1598
1599 $term->vt_emask_add (urxvt::PointerMotionMask);
1600
1601=item $term->focus_in
1602
1603=item $term->focus_out
1604
1605=item $term->key_press ($state, $keycode[, $time])
1606
1607=item $term->key_release ($state, $keycode[, $time])
1608
1609Deliver various fake events to to terminal.
1610
1034=item $window_width = $term->width 1611=item $window_width = $term->width
1035 1612
1036=item $window_height = $term->height 1613=item $window_height = $term->height
1037 1614
1038=item $font_width = $term->fwidth 1615=item $font_width = $term->fwidth
1051 1628
1052=item $max_scrollback = $term->saveLines 1629=item $max_scrollback = $term->saveLines
1053 1630
1054=item $nrow_plus_saveLines = $term->total_rows 1631=item $nrow_plus_saveLines = $term->total_rows
1055 1632
1056=item $lines_in_scrollback = $term->nsaved 1633=item $topmost_scrollback_row = $term->top_row
1057 1634
1058Return various integers describing terminal characteristics. 1635Return various integers describing terminal characteristics.
1059 1636
1637=item $x_display = $term->display_id
1638
1639Return the DISPLAY used by rxvt-unicode.
1640
1060=item $lc_ctype = $term->locale 1641=item $lc_ctype = $term->locale
1061 1642
1062Returns the LC_CTYPE category string used by this rxvt-unicode. 1643Returns the LC_CTYPE category string used by this rxvt-unicode.
1063 1644
1064=item $x_display = $term->display_id 1645=item $env = $term->env
1065 1646
1066Return the DISPLAY used by rxvt-unicode. 1647Returns a copy of the environment in effect for the terminal as a hashref
1648similar to C<\%ENV>.
1649
1650=item @envv = $term->envv
1651
1652Returns the environment as array of strings of the form C<VAR=VALUE>.
1653
1654=item @argv = $term->argv
1655
1656Return the argument vector as this terminal, similar to @ARGV, but
1657includes the program name as first element.
1658
1659=cut
1660
1661sub env {
1662 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1663}
1067 1664
1068=item $modifiermask = $term->ModLevel3Mask 1665=item $modifiermask = $term->ModLevel3Mask
1069 1666
1070=item $modifiermask = $term->ModMetaMask 1667=item $modifiermask = $term->ModMetaMask
1071 1668
1072=item $modifiermask = $term->ModNumLockMask 1669=item $modifiermask = $term->ModNumLockMask
1073 1670
1074Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1671Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075AltGr), the meta key (often Alt) and the num lock key, if applicable. 1672AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076 1673
1674=item $screen = $term->current_screen
1675
1676Returns the currently displayed screen (0 primary, 1 secondary).
1677
1678=item $cursor_is_hidden = $term->hidden_cursor
1679
1680Returns whether the cursor is currently hidden or not.
1681
1077=item $view_start = $term->view_start ([$newvalue]) 1682=item $view_start = $term->view_start ([$newvalue])
1078 1683
1079Returns the negative row number of the topmost line. Minimum value is 1684Returns the row number of the topmost displayed line. Maximum value is
1080C<0>, which displays the normal terminal contents. Larger values scroll 1685C<0>, which displays the normal terminal contents. Lower values scroll
1081this many lines into the scrollback buffer. 1686this many lines into the scrollback buffer.
1082 1687
1083=item $term->want_refresh 1688=item $term->want_refresh
1084 1689
1085Requests a screen refresh. At the next opportunity, rxvt-unicode will 1690Requests a screen refresh. At the next opportunity, rxvt-unicode will
1088 1693
1089Used after changing terminal contents to display them. 1694Used after changing terminal contents to display them.
1090 1695
1091=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1696=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1092 1697
1093Returns the text of the entire row with number C<$row_number>. Row C<0> 1698Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1094is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1699is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1095terminal line. The scrollback buffer starts at line C<-1> and extends to
1096line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1700terminal line. Nothing will be returned if a nonexistent line
1097is requested. 1701is requested.
1098 1702
1099If C<$new_text> is specified, it will replace characters in the current 1703If C<$new_text> is specified, it will replace characters in the current
1100line, starting at column C<$start_col> (default C<0>), which is useful 1704line, starting at column C<$start_col> (default C<0>), which is useful
1101to replace only parts of a line. The font index in the rendition will 1705to replace only parts of a line. The font index in the rendition will
1102automatically be updated. 1706automatically be updated.
1103 1707
1104C<$text> is in a special encoding: tabs and wide characters that use more 1708C<$text> is in a special encoding: tabs and wide characters that use more
1105than one cell when displayed are padded with urxvt::NOCHAR characters 1709than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106(C<chr 65535>). Characters with combining characters and other characters 1710characters. Characters with combining characters and other characters that
1107that do not fit into the normal tetx encoding will be replaced with 1711do not fit into the normal text encoding will be replaced with characters
1108characters in the private use area. 1712in the private use area.
1109 1713
1110You have to obey this encoding when changing text. The advantage is 1714You have to obey this encoding when changing text. The advantage is
1111that C<substr> and similar functions work on screen cells and not on 1715that C<substr> and similar functions work on screen cells and not on
1112characters. 1716characters.
1113 1717
1164Return the row number of the first/last row of the line, respectively. 1768Return the row number of the first/last row of the line, respectively.
1165 1769
1166=item $offset = $line->offset_of ($row, $col) 1770=item $offset = $line->offset_of ($row, $col)
1167 1771
1168Returns the character offset of the given row|col pair within the logical 1772Returns the character offset of the given row|col pair within the logical
1169line. 1773line. Works for rows outside the line, too, and returns corresponding
1774offsets outside the string.
1170 1775
1171=item ($row, $col) = $line->coord_of ($offset) 1776=item ($row, $col) = $line->coord_of ($offset)
1172 1777
1173Translates a string offset into terminal coordinates again. 1778Translates a string offset into terminal coordinates again.
1174 1779
1256where one character corresponds to one screen cell. See 1861where one character corresponds to one screen cell. See
1257C<< $term->ROW_t >> for details. 1862C<< $term->ROW_t >> for details.
1258 1863
1259=item $string = $term->special_decode $text 1864=item $string = $term->special_decode $text
1260 1865
1261Converts rxvt-unicodes text reprsentation into a perl string. See 1866Converts rxvt-unicodes text representation into a perl string. See
1262C<< $term->ROW_t >> for details. 1867C<< $term->ROW_t >> for details.
1263 1868
1264=item $success = $term->grab_button ($button, $modifiermask) 1869=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1265 1870
1871=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1872
1266Registers a synchronous button grab. See the XGrabButton manpage. 1873Register/unregister a synchronous button grab. See the XGrabButton
1874manpage.
1267 1875
1268=item $success = $term->grab ($eventtime[, $sync]) 1876=item $success = $term->grab ($eventtime[, $sync])
1269 1877
1270Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1878Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1271synchronous (C<$sync> is true). Also remembers the grab timestampe. 1879synchronous (C<$sync> is true). Also remembers the grab timestamp.
1272 1880
1273=item $term->allow_events_async 1881=item $term->allow_events_async
1274 1882
1275Calls XAllowEvents with AsyncBoth for the most recent grab. 1883Calls XAllowEvents with AsyncBoth for the most recent grab.
1276 1884
1283Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1891Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1284recent grab. 1892recent grab.
1285 1893
1286=item $term->ungrab 1894=item $term->ungrab
1287 1895
1288Calls XUngrab for the most recent grab. Is called automatically on 1896Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1289evaluation errors, as it is better to lose the grab in the error case as 1897evaluation errors, as it is better to lose the grab in the error case as
1290the session. 1898the session.
1899
1900=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1901
1902=item $atom_name = $term->XGetAtomName ($atom)
1903
1904=item @atoms = $term->XListProperties ($window)
1905
1906=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1907
1908=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1909
1910=item $term->XDeleteProperty ($window, $property)
1911
1912=item $window = $term->DefaultRootWindow
1913
1914=item $term->XReparentWindow ($window, $parent, [$x, $y])
1915
1916=item $term->XMapWindow ($window)
1917
1918=item $term->XUnmapWindow ($window)
1919
1920=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1921
1922=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1923
1924=item $term->XChangeInput ($window, $add_events[, $del_events])
1925
1926Various X or X-related functions. The C<$term> object only serves as
1927the source of the display, otherwise those functions map more-or-less
1928directly onto the X functions of the same name.
1291 1929
1292=back 1930=back
1293 1931
1294=cut 1932=cut
1295 1933
1310 1948
1311 $item->{render} ||= sub { $_[0]{text} }; 1949 $item->{render} ||= sub { $_[0]{text} };
1312 1950
1313 push @{ $self->{item} }, $item; 1951 push @{ $self->{item} }, $item;
1314} 1952}
1953
1954=item $popup->add_title ($title)
1955
1956Adds a non-clickable title to the popup.
1957
1958=cut
1959
1960sub add_title {
1961 my ($self, $title) = @_;
1962
1963 $self->add_item ({
1964 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1965 text => $title,
1966 activate => sub { },
1967 });
1968}
1969
1970=item $popup->add_separator ([$sepchr])
1971
1972Creates a separator, optionally using the character given as C<$sepchr>.
1973
1974=cut
1315 1975
1316sub add_separator { 1976sub add_separator {
1317 my ($self, $sep) = @_; 1977 my ($self, $sep) = @_;
1318 1978
1319 $sep ||= "="; 1979 $sep ||= "=";
1324 render => sub { $sep x $self->{term}->ncol }, 1984 render => sub { $sep x $self->{term}->ncol },
1325 activate => sub { }, 1985 activate => sub { },
1326 }); 1986 });
1327} 1987}
1328 1988
1329sub add_title { 1989=item $popup->add_button ($text, $cb)
1330 my ($self, $title) = @_;
1331 1990
1332 $self->add_item ({ 1991Adds a clickable button to the popup. C<$cb> is called whenever it is
1333 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1992selected.
1334 text => $title, 1993
1335 activate => sub { }, 1994=cut
1336 });
1337}
1338 1995
1339sub add_button { 1996sub add_button {
1340 my ($self, $text, $cb) = @_; 1997 my ($self, $text, $cb) = @_;
1341 1998
1342 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1999 $self->add_item ({ type => "button", text => $text, activate => $cb});
1343} 2000}
1344 2001
2002=item $popup->add_toggle ($text, $initial_value, $cb)
2003
2004Adds a toggle/checkbox item to the popup. The callback gets called
2005whenever it gets toggled, with a boolean indicating its new value as its
2006first argument.
2007
2008=cut
2009
1345sub add_toggle { 2010sub add_toggle {
1346 my ($self, $text, $cb, $value) = @_; 2011 my ($self, $text, $value, $cb) = @_;
1347 2012
1348 my $item; $item = { 2013 my $item; $item = {
1349 type => "button", 2014 type => "button",
1350 text => " $text", 2015 text => " $text",
1351 value => $value, 2016 value => $value,
1352 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 2017 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 2018 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354 }; 2019 };
1355 2020
1356 $self->add_item ($item); 2021 $self->add_item ($item);
1357} 2022}
2023
2024=item $popup->show
2025
2026Displays the popup (which is initially hidden).
2027
2028=cut
1358 2029
1359sub show { 2030sub show {
1360 my ($self) = @_; 2031 my ($self) = @_;
1361 2032
1362 local $urxvt::popup::self = $self; 2033 local $urxvt::popup::self = $self;
1363 2034
2035 my $env = $self->{term}->env;
2036 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
2037 delete $env->{LC_ALL};
1364 local $ENV{LC_ALL} = $self->{term}->locale; 2038 $env->{LC_CTYPE} = $self->{term}->locale;
1365 2039
1366 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 2040 my $term = urxvt::term->new (
2041 $env, "popup",
2042 "--perl-lib" => "", "--perl-ext-common" => "",
2043 "-pty-fd" => -1, "-sl" => 0,
2044 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1367 "--transient-for" => $self->{term}->parent, 2045 "--transient-for" => $self->{term}->parent,
1368 "-display" => $self->{term}->display_id, 2046 "-display" => $self->{term}->display_id,
1369 "-pe" => "urxvt-popup") 2047 "-pe" => "urxvt-popup",
1370 or die "unable to create popup window\n"; 2048 ) or die "unable to create popup window\n";
2049
2050 unless (delete $term->{urxvt_popup_init_done}) {
2051 $term->ungrab;
2052 $term->destroy;
2053 die "unable to initialise popup window\n";
2054 }
1371} 2055}
1372 2056
1373sub DESTROY { 2057sub DESTROY {
1374 my ($self) = @_; 2058 my ($self) = @_;
1375 2059
1376 delete $self->{term}{_destroy}{$self}; 2060 delete $self->{term}{_destroy}{$self};
1377 $self->{term}->ungrab; 2061 $self->{term}->ungrab;
1378} 2062}
2063
2064=back
2065
2066=cut
2067
2068package urxvt::watcher;
1379 2069
1380=head2 The C<urxvt::timer> Class 2070=head2 The C<urxvt::timer> Class
1381 2071
1382This class implements timer watchers/events. Time is represented as a 2072This class implements timer watchers/events. Time is represented as a
1383fractional number of seconds since the epoch. Example: 2073fractional number of seconds since the epoch. Example:
1387 ->new 2077 ->new
1388 ->interval (1) 2078 ->interval (1)
1389 ->cb (sub { 2079 ->cb (sub {
1390 $term->{overlay}->set (0, 0, 2080 $term->{overlay}->set (0, 0,
1391 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2081 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1392 }); 2082 });
1393 2083
1394=over 4 2084=over 4
1395 2085
1396=item $timer = new urxvt::timer 2086=item $timer = new urxvt::timer
1397 2087
1400 2090
1401=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2091=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1402 2092
1403Set the callback to be called when the timer triggers. 2093Set the callback to be called when the timer triggers.
1404 2094
1405=item $tstamp = $timer->at
1406
1407Return the time this watcher will fire next.
1408
1409=item $timer = $timer->set ($tstamp) 2095=item $timer = $timer->set ($tstamp[, $interval])
1410 2096
1411Set the time the event is generated to $tstamp. 2097Set the time the event is generated to $tstamp (and optionally specifies a
2098new $interval).
1412 2099
1413=item $timer = $timer->interval ($interval) 2100=item $timer = $timer->interval ($interval)
1414 2101
1415Normally (and when C<$interval> is C<0>), the timer will automatically 2102By default (and when C<$interval> is C<0>), the timer will automatically
1416stop after it has fired once. If C<$interval> is non-zero, then the timer 2103stop after it has fired once. If C<$interval> is non-zero, then the timer
1417is automatically rescheduled at the given intervals. 2104is automatically rescheduled at the given intervals.
1418 2105
1419=item $timer = $timer->start 2106=item $timer = $timer->start
1420 2107
1421Start the timer. 2108Start the timer.
1422 2109
1423=item $timer = $timer->start ($tstamp) 2110=item $timer = $timer->start ($tstamp[, $interval])
1424 2111
1425Set the event trigger time to C<$tstamp> and start the timer. 2112Set the event trigger time to C<$tstamp> and start the timer. Optionally
2113also replaces the interval.
2114
2115=item $timer = $timer->after ($delay[, $interval])
2116
2117Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1426 2118
1427=item $timer = $timer->stop 2119=item $timer = $timer->stop
1428 2120
1429Stop the timer. 2121Stop the timer.
1430 2122
1436 2128
1437 $term->{socket} = ... 2129 $term->{socket} = ...
1438 $term->{iow} = urxvt::iow 2130 $term->{iow} = urxvt::iow
1439 ->new 2131 ->new
1440 ->fd (fileno $term->{socket}) 2132 ->fd (fileno $term->{socket})
1441 ->events (urxvt::EVENT_READ) 2133 ->events (urxvt::EV_READ)
1442 ->start 2134 ->start
1443 ->cb (sub { 2135 ->cb (sub {
1444 my ($iow, $revents) = @_; 2136 my ($iow, $revents) = @_;
1445 # $revents must be 1 here, no need to check 2137 # $revents must be 1 here, no need to check
1446 sysread $term->{socket}, my $buf, 8192 2138 sysread $term->{socket}, my $buf, 8192
1459Set the callback to be called when io events are triggered. C<$reventmask> 2151Set the callback to be called when io events are triggered. C<$reventmask>
1460is a bitset as described in the C<events> method. 2152is a bitset as described in the C<events> method.
1461 2153
1462=item $iow = $iow->fd ($fd) 2154=item $iow = $iow->fd ($fd)
1463 2155
1464Set the filedescriptor (not handle) to watch. 2156Set the file descriptor (not handle) to watch.
1465 2157
1466=item $iow = $iow->events ($eventmask) 2158=item $iow = $iow->events ($eventmask)
1467 2159
1468Set the event mask to watch. The only allowed values are 2160Set the event mask to watch. The only allowed values are
1469C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2161C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1470together, or C<urxvt::EVENT_NONE>. 2162together, or C<urxvt::EV_NONE>.
1471 2163
1472=item $iow = $iow->start 2164=item $iow = $iow->start
1473 2165
1474Start watching for requested events on the given handle. 2166Start watching for requested events on the given handle.
1475 2167
1476=item $iow = $iow->stop 2168=item $iow = $iow->stop
1477 2169
1478Stop watching for events on the given filehandle. 2170Stop watching for events on the given file handle.
2171
2172=back
2173
2174=head2 The C<urxvt::iw> Class
2175
2176This class implements idle watchers, that get called automatically when
2177the process is idle. They should return as fast as possible, after doing
2178some useful work.
2179
2180=over 4
2181
2182=item $iw = new urxvt::iw
2183
2184Create a new idle watcher object in stopped state.
2185
2186=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2187
2188Set the callback to be called when the watcher triggers.
2189
2190=item $timer = $timer->start
2191
2192Start the watcher.
2193
2194=item $timer = $timer->stop
2195
2196Stop the watcher.
2197
2198=back
2199
2200=head2 The C<urxvt::pw> Class
2201
2202This class implements process watchers. They create an event whenever a
2203process exits, after which they stop automatically.
2204
2205 my $pid = fork;
2206 ...
2207 $term->{pw} = urxvt::pw
2208 ->new
2209 ->start ($pid)
2210 ->cb (sub {
2211 my ($pw, $exit_status) = @_;
2212 ...
2213 });
2214
2215=over 4
2216
2217=item $pw = new urxvt::pw
2218
2219Create a new process watcher in stopped state.
2220
2221=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2222
2223Set the callback to be called when the timer triggers.
2224
2225=item $pw = $timer->start ($pid)
2226
2227Tells the watcher to start watching for process C<$pid>.
2228
2229=item $pw = $pw->stop
2230
2231Stop the watcher.
1479 2232
1480=back 2233=back
1481 2234
1482=head1 ENVIRONMENT 2235=head1 ENVIRONMENT
1483 2236
1490 2243
1491=item == 0 - fatal messages 2244=item == 0 - fatal messages
1492 2245
1493=item >= 3 - script loading and management 2246=item >= 3 - script loading and management
1494 2247
1495=item >=10 - all events received 2248=item >=10 - all called hooks
2249
2250=item >=11 - hook return values
1496 2251
1497=back 2252=back
1498 2253
1499=head1 AUTHOR 2254=head1 AUTHOR
1500 2255
1501 Marc Lehmann <pcg@goof.com> 2256 Marc Lehmann <schmorp@schmorp.de>
1502 http://software.schmorp.de/pkg/rxvt-unicode 2257 http://software.schmorp.de/pkg/rxvt-unicode
1503 2258
1504=cut 2259=cut
1505 2260
15061 22611
2262
2263# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines