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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines