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.54 by root, Sun Jan 8 01:59:29 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
58 94
59=back 95=back
60 96
61=item option-popup (enabled by default) 97=item option-popup (enabled by default)
62 98
63Binds a popup menu to Ctrl-Button3 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
66=item digital-clock 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.
67 105
68Displays a digital clock using the built-in overlay. 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.
69 111
70=item mark-urls 112The following will add an entry C<myoption> that changes
113C<< $self->{myoption} >>:
71 114
115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 };
118
119=item selection-popup (enabled by default)
120
121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122text into various other formats/action (such as uri unescaping, perl
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 };
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
72Uses 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.
73 313
74=item block-graphics-to-ascii 314=item block-graphics-to-ascii
75 315
76A 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
77by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
78similar-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.
79 391
80=item example-refresh-hooks 392=item example-refresh-hooks
81 393
82Displays 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
83window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
84overlays or changes. 396overlays or changes.
85 397
398=item confirm-paste
399
400Displays a confirmation dialog when a paste containing at least a full
401line is detected.
402
86=back 403=back
404
405=head1 API DOCUMENTATION
87 406
88=head2 General API Considerations 407=head2 General API Considerations
89 408
90All objects (such as terminals, time watchers etc.) are typical 409All objects (such as terminals, time watchers etc.) are typical
91reference-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
103 422
104=over 4 423=over 4
105 424
106=item $text 425=item $text
107 426
108Rxvt-unicodes special way of encoding text, where one "unicode" character 427Rxvt-unicode's special way of encoding text, where one "unicode" character
109always 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.
110 429
111=item $string 430=item $string
112 431
113A 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
114characters and is to be distinguished with text encoded in a specific 433characters and is to be distinguished with text encoded in a specific
119Either binary data or - more common - a text string encoded in a 438Either binary data or - more common - a text string encoded in a
120locale-specific way. 439locale-specific way.
121 440
122=back 441=back
123 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
124=head2 Hooks 477=head2 Hooks
125 478
126The following subroutines can be declared in extension files, and will be 479The following subroutines can be declared in extension files, and will be
127called whenever the relevant event happens. 480called whenever the relevant event happens.
128 481
129The 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
130and extension package. You can call all C<urxvt::term> methods on it, but 483the in the C<Extension Objects> section.
131its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
132object that is shared between all packages is stored in the C<term>
133member. It is, however, blessed intot he package of the extension script,
134so for all practical purposes you can treat an extension script as a class.
135 484
136All 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
137counts 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
138and the relevant action might not be carried out by the C++ code. 487relevant action might not be carried out by the C++ code.
139 488
140When in doubt, return a false value (preferably C<()>). 489I<< When in doubt, return a false value (preferably C<()>). >>
141 490
142=over 4 491=over 4
143 492
144=item on_init $term 493=item on_init $term
145 494
146Called after a new terminal object has been initialized, but before 495Called after a new terminal object has been initialized, but before
147windows 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
148call or deliver senseless data, as terminal size and other characteristics 497call or deliver senseless data, as terminal size and other characteristics
149have not yet been determined. You can safely query and change resources, 498have not yet been determined. You can safely query and change resources
150though. 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).
151 511
152=item on_reset $term 512=item on_reset $term
153 513
154Called 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
155control 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
156variables. 516variables.
157 517
158=item on_start $term 518=item on_child_start $term, $pid
159 519
160Called at the very end of initialisation of a new terminal, just before 520Called just after the child process has been C<fork>ed.
161returning 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>.
162 526
163=item on_sel_make $term, $eventtime 527=item on_sel_make $term, $eventtime
164 528
165Called 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
166selection 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
173 537
174Called whenever a selection has been copied, but before the selection is 538Called whenever a selection has been copied, but before the selection is
175requested from the server. The selection text can be queried and changed 539requested from the server. The selection text can be queried and changed
176by calling C<< $term->selection >>. 540by calling C<< $term->selection >>.
177 541
178Returning a true value aborts selection grabbing. It will still be hilighted. 542Returning a true value aborts selection grabbing. It will still be highlighted.
179 543
180=item on_sel_extend $term 544=item on_sel_extend $term
181 545
182Called 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
183click) and is either supposed to return false (normal operation), or 547click) and is either supposed to return false (normal operation), or
184should 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
185processing. 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.
186 552
187See the F<selection> example extension. 553See the F<selection> example extension.
188 554
189=item on_view_change $term, $offset 555=item on_view_change $term, $offset
190 556
191Called whenever the view offset changes, i..e the user or program 557Called whenever the view offset changes, i.e. the user or program
192scrolls. Offset C<0> means display the normal terminal, positive values 558scrolls. Offset C<0> means display the normal terminal, positive values
193show this many lines of scrollback. 559show this many lines of scrollback.
194 560
195=item on_scroll_back $term, $lines, $saved 561=item on_scroll_back $term, $lines, $saved
196 562
200 566
201It 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,
202$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
203number of lines that will be in the scrollback buffer. 569number of lines that will be in the scrollback buffer.
204 570
205=item on_tty_activity $term *NYI*
206
207Called whenever the program(s) running in the urxvt window send output.
208
209=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
210 582
211Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 583Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
212operating system command) is processed. Cursor position and other state 584operating system command) is processed. Cursor position and other state
213information is up-to-date when this happens. For interoperability, the 585information is up-to-date when this happens. For interoperability, the
214string should start with the extension name and a colon, to distinguish 586string should start with the extension name (sans -osc) and a semicolon,
215it from commands for other extensions, and this might be enforced in the 587to distinguish it from commands for other extensions, and this might be
216future. 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 }
217 599
218Be 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,
219as 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
220other 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.
221 606
222=item on_add_lines $term, $string 607=item on_add_lines $term, $string
223 608
224Called 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
225can 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
226and calling C<< $term->scr_add_lines >> yourself. Please note that this 611and calling C<< $term->scr_add_lines >> yourself. Please note that this
227might 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
228output. 613output.
229 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
230=item on_line_update $term, $row 627=item on_line_update $term, $row
231 628
232Called 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
233screen output (e.g. underline urls or other useless stuff). Only lines 630screen output (e.g. underline urls or other useless stuff). Only lines
234that are being shown will be filtered, and, due to performance reasons, 631that are being shown will be filtered, and, due to performance reasons,
241later 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
242you cannot just toggle rendition bits, but only set them. 639you cannot just toggle rendition bits, but only set them.
243 640
244=item on_refresh_begin $term 641=item on_refresh_begin $term
245 642
246Called just before the screen gets redrawn. Can be used for overlay 643Called just before the screen gets redrawn. Can be used for overlay or
247or similar effects by modify terminal contents in refresh_begin, and 644similar effects by modifying the terminal contents in refresh_begin, and
248restoring them in refresh_end. The built-in overlay and selection display 645restoring them in refresh_end. The built-in overlay and selection display
249code is run after this hook, and takes precedence. 646code is run after this hook, and takes precedence.
250 647
251=item on_refresh_end $term 648=item on_refresh_end $term
252 649
253Called just after the screen gets redrawn. See C<on_refresh_begin>. 650Called just after the screen gets redrawn. See C<on_refresh_begin>.
254 651
255=item on_keyboard_command $term, $string 652=item on_user_command $term, $string
256 653
257Called whenever the user presses a key combination that has a 654Called whenever a user-configured event is being activated (e.g. via
258C<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>
259resource 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.
260 676
261=item on_focus_in $term 677=item on_focus_in $term
262 678
263Called whenever the window gets the keyboard focus, before rxvt-unicode 679Called whenever the window gets the keyboard focus, before rxvt-unicode
264does focus in processing. 680does focus in processing.
265 681
266=item on_focus_out $term 682=item on_focus_out $term
267 683
268Called wheneever the window loses keyboard focus, before rxvt-unicode does 684Called whenever the window loses keyboard focus, before rxvt-unicode does
269focus out processing. 685focus out processing.
270 686
687=item on_configure_notify $term, $event
688
689=item on_property_notify $term, $event
690
271=item on_key_press $term, $event, $octets 691=item on_key_press $term, $event, $keysym, $octets
272 692
273=item on_key_release $term, $event 693=item on_key_release $term, $event, $keysym
274 694
275=item on_button_press $term, $event 695=item on_button_press $term, $event
276 696
277=item on_button_release $term, $event 697=item on_button_release $term, $event
278 698
280 700
281=item on_map_notify $term, $event 701=item on_map_notify $term, $event
282 702
283=item on_unmap_notify $term, $event 703=item on_unmap_notify $term, $event
284 704
285Called whenever the corresponding X event is received for the terminal If 705Called whenever the corresponding X event is received for the terminal. If
286the 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.
287 707
288The 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
289manpage), 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
290and column under the mouse cursor. 710(real, not screen-based) row and column under the mouse cursor.
291 711
292C<on_key_press> additionally receives the string rxvt-unicode would 712C<on_key_press> additionally receives the string rxvt-unicode would
293output, if any, in locale-specific encoding. 713output, if any, in locale-specific encoding.
294 714
295subwindow. 715subwindow.
296 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
297=back 730=back
298 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
299=head2 Variables in the C<urxvt> Package 757=head2 Variables in the C<urxvt> Package
300 758
301=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>.
302 773
303=item $urxvt::TERM 774=item $urxvt::TERM
304 775
305The current terminal. This variable stores the current C<urxvt::term> 776The current terminal. This variable stores the current C<urxvt::term>
306object, whenever a callback/hook is executing. 777object, whenever a callback/hook is executing.
307 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
308=back 795=back
309 796
310=head2 Functions in the C<urxvt> Package 797=head2 Functions in the C<urxvt> Package
311 798
312=over 4 799=over 4
313
314=item $term = new urxvt [arg...]
315
316Creates a new terminal, very similar as if you had started it with
317C<system $binfile, arg...>. Croaks (and probably outputs an error message)
318if the new instance couldn't be created. Returns C<undef> if the new
319instance didn't initialise perl, and the terminal object otherwise. The
320C<init> and C<start> hooks will be called during the call.
321 800
322=item urxvt::fatal $errormessage 801=item urxvt::fatal $errormessage
323 802
324Fatally aborts execution with the given error message. Avoid at all 803Fatally aborts execution with the given error message. Avoid at all
325costs! The only time this is acceptable is when the terminal process 804costs! The only time this is acceptable is when the terminal process
332that calls this function. 811that calls this function.
333 812
334Using 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
335correct place, e.g. on stderr of the connecting urxvtc client. 814correct place, e.g. on stderr of the connecting urxvtc client.
336 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
337=item $time = urxvt::NOW 825=item $time = urxvt::NOW
338 826
339Returns the "current time" (as per the event loop). 827Returns the "current time" (as per the event loop).
340 828
341=item urxvt::CurrentTime 829=item urxvt::CurrentTime
342 830
343=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, 831=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
344Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, 832Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
345Button4Mask, Button5Mask, AnyModifier 833Button4Mask, Button5Mask, AnyModifier
346 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
850
347Various constants for use in X events. 851Various constants for use in X calls and event processing.
348 852
349=back 853=back
350 854
351=head2 RENDITION 855=head2 RENDITION
352 856
379 883
380=item $background = urxvt::GET_BASEBG $rend 884=item $background = urxvt::GET_BASEBG $rend
381 885
382Return the foreground/background colour index, respectively. 886Return the foreground/background colour index, respectively.
383 887
384=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 888=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
385 889
386=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
387 893
388Replace the foreground/background colour in the rendition mask with the 894Replace the foreground/background colour in the rendition mask with the
389specified one. 895specified one.
390 896
391=item $value = urxvt::GET_CUSTOM ($rend) 897=item $value = urxvt::GET_CUSTOM $rend
392 898
393Return the "custom" value: Every rendition has 5 bits for use by 899Return the "custom" value: Every rendition has 5 bits for use by
394extensions. 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
395zero. 901zero.
396 902
397=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 903=item $rend = urxvt::SET_CUSTOM $rend, $new_value
398 904
399Change the custom value. 905Change the custom value.
400 906
401=back 907=back
402 908
403=cut 909=cut
404 910
405package urxvt;
406
407use utf8;
408use strict;
409use Scalar::Util ();
410use List::Util ();
411
412our $TERM;
413our @HOOKNAME;
414our %OPTION;
415our $LIBDIR;
416
417BEGIN { 911BEGIN {
418 urxvt->bootstrap;
419
420 # overwrite perl's warn 912 # overwrite perl's warn
421 *CORE::GLOBAL::warn = sub { 913 *CORE::GLOBAL::warn = sub {
422 my $msg = join "", @_; 914 my $msg = join "", @_;
423 $msg .= "\n" 915 $msg .= "\n"
424 unless $msg =~ /\n$/; 916 unless $msg =~ /\n$/;
425 urxvt::warn ($msg); 917 urxvt::warn ($msg);
426 }; 918 };
427} 919}
428 920
429my @hook_count; 921no warnings 'utf8';
922
430my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 923my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
431 924
432sub verbose { 925sub verbose {
433 my ($level, $msg) = @_; 926 my ($level, $msg) = @_;
434 warn "$msg\n" if $level <= $verbosity; 927 warn "$msg\n" if $level <= $verbosity;
435} 928}
436 929
437# find on_xxx subs in the package and register them
438# as hooks
439sub register_package($) {
440 my ($pkg) = @_;
441
442 for my $htype (0.. $#HOOKNAME) {
443 my $name = $HOOKNAME[$htype];
444
445 my $ref = $pkg->can ("on_" . lc $name)
446 or next;
447
448 $TERM->{_hook}[$htype]{$pkg} = $ref;
449 $hook_count[$htype]++
450 or set_should_invoke $htype, 1;
451 }
452}
453
454my $extension_pkg = "extension0000";
455my %extension_pkg; 930my %extension_pkg;
456 931
457# load a single script into its own package, once only 932# load a single script into its own package, once only
458sub extension_package($) { 933sub extension_package($) {
459 my ($path) = @_; 934 my ($path) = @_;
460 935
461 $extension_pkg{$path} ||= do { 936 $extension_pkg{$path} ||= do {
462 my $pkg = "urxvt::" . ($extension_pkg++); 937 $path =~ /([^\/\\]+)$/;
938 my $pkg = $1;
939 $pkg =~ s/[^[:word:]]/_/g;
940 $pkg = "urxvt::ext::$pkg";
463 941
464 verbose 3, "loading extension '$path' into package '$pkg'"; 942 verbose 3, "loading extension '$path' into package '$pkg'";
465 943
466 open my $fh, "<:raw", $path 944 open my $fh, "<:raw", $path
467 or die "$path: $!"; 945 or die "$path: $!";
468 946
469 my $source = "package $pkg; use strict; use utf8;\n" 947 my $source =
470 . "use base urxvt::term::proxy::;\n" 948 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
471 . "#line 1 \"$path\"\n{\n" 949 . "#line 1 \"$path\"\n{\n"
472 . (do { local $/; <$fh> }) 950 . (do { local $/; <$fh> })
473 . "\n};\n1"; 951 . "\n};\n1";
474 952
953 eval $source
475 eval $source or die "$path: $@"; 954 or die "$path: $@";
476 955
477 $pkg 956 $pkg
478 } 957 }
479} 958}
480 959
485 local $TERM = shift; 964 local $TERM = shift;
486 my $htype = shift; 965 my $htype = shift;
487 966
488 if ($htype == 0) { # INIT 967 if ($htype == 0) { # INIT
489 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
490 972 {
491 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 }
492 980
493 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 981 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
494 if ($_ eq "default") { 982 if ($_ eq "default") {
495 $want_ext{$_}++ for qw(selection option-popup); 983 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
496 } elsif (/^-(.*)$/) { 984 } elsif (/^-(.*)$/) {
497 delete $want_ext{$1}; 985 delete $ext_arg{$1};
986 } elsif (/^([^<]+)<(.*)>$/) {
987 push @{ $ext_arg{$1} }, $2;
498 } else { 988 } else {
499 $want_ext{$_}++; 989 $ext_arg{$_} ||= [];
500 } 990 }
501 } 991 }
502 992
503 for my $ext (keys %want_ext) { 993 for my $ext (sort keys %ext_arg) {
504 my @files = grep -f $_, map "$_/$ext", @dirs; 994 my @files = grep -f $_, map "$_/$ext", @dirs;
505 995
506 if (@files) { 996 if (@files) {
507 register_package extension_package $files[0]; 997 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
508 } else { 998 } else {
509 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";
510 } 1000 }
511 } 1001 }
1002
1003 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
1004 warn $@ if $@;
512 } 1005 }
513 1006
514 $retval = undef; 1007 $retval = undef;
515 1008
516 if (my $cb = $TERM->{_hook}[$htype]) { 1009 if (my $cb = $TERM->{_hook}[$htype]) {
517 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1010 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
518 if $verbosity >= 10; 1011 if $verbosity >= 10;
519 1012
520 keys %$cb; 1013 for my $pkg (keys %$cb) {
1014 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
1015 $retval ||= $retval_;
521 1016
522 while (my ($pkg, $cb) = each %$cb) { 1017 if ($@) {
523 eval { 1018 $TERM->ungrab; # better to lose the grab than the session
524 $retval = $cb->( 1019 warn $@;
525 $TERM->{_pkg}{$pkg} ||= do {
526 my $proxy = bless { }, $pkg;
527 Scalar::Util::weaken ($proxy->{term} = $TERM);
528 $proxy
529 },
530 @_,
531 ) and last;
532 };
533 warn $@ if $@;#d#
534 }
535 }
536
537 if ($htype == 1) { # DESTROY
538 # remove hooks if unused
539 if (my $hook = $TERM->{_hook}) {
540 for my $htype (0..$#$hook) {
541 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
542 or set_should_invoke $htype, 0;
543 } 1020 }
544 } 1021 }
545 1022
1023 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1024 if $verbosity >= 11;
1025 }
1026
1027 if ($htype == 1) { # DESTROY
546 # clear package objects 1028 # clear package objects
547 %$_ = () for values %{ $TERM->{_pkg} }; 1029 %$_ = () for values %{ $TERM->{_pkg} };
548 1030
549 # clear package 1031 # clear package
550 %$TERM = (); 1032 %$TERM = ();
551 } 1033 }
552 1034
553 $retval 1035 $retval
554} 1036}
555 1037
556sub urxvt::term::proxy::AUTOLOAD { 1038sub SET_COLOR($$$) {
557 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 1039 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1040}
1041
1042sub rend2mask {
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 =~ /:([^:]+)$/
558 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 1105 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
559 1106
560 eval qq{ 1107 eval qq{
561 sub $urxvt::term::proxy::AUTOLOAD { 1108 sub $AUTOLOAD {
562 my \$proxy = shift; 1109 my \$proxy = shift;
563 \$proxy->{term}->$1 (\@_) 1110 \$proxy->{term}->$1 (\@_)
564 } 1111 }
565 1 1112 1
566 } or die "FATAL: unable to compile method forwarder: $@"; 1113 } or die "FATAL: unable to compile method forwarder: $@";
567 1114
568 goto &$urxvt::term::proxy::AUTOLOAD; 1115 goto &$AUTOLOAD;
569} 1116}
1117
1118sub DESTROY {
1119 # nop
1120}
1121
1122# urxvt::destroy_hook
570 1123
571sub urxvt::destroy_hook::DESTROY { 1124sub urxvt::destroy_hook::DESTROY {
572 ${$_[0]}->(); 1125 ${$_[0]}->();
573} 1126}
574 1127
575sub urxvt::destroy_hook(&) { 1128sub urxvt::destroy_hook(&) {
576 bless \shift, urxvt::destroy_hook:: 1129 bless \shift, urxvt::destroy_hook::
577} 1130}
578 1131
1132package urxvt::anyevent;
1133
1134=head2 The C<urxvt::anyevent> Class
1135
1136The sole purpose of this class is to deliver an interface to the
1137C<AnyEvent> module - any module using it will work inside urxvt without
1138further programming. The only exception is that you cannot wait on
1139condition variables, but non-blocking condvar use is ok. What this means
1140is that you cannot use blocking APIs, but the non-blocking variant should
1141work.
1142
1143=cut
1144
1145our $VERSION = '5.23';
1146
1147$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1148push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1149
1150sub timer {
1151 my ($class, %arg) = @_;
1152
1153 my $cb = $arg{cb};
1154
1155 urxvt::timer
1156 ->new
1157 ->after ($arg{after}, $arg{interval})
1158 ->cb ($arg{interval} ? $cb : sub {
1159 $_[0]->stop; # need to cancel manually
1160 $cb->();
1161 })
1162}
1163
1164sub io {
1165 my ($class, %arg) = @_;
1166
1167 my $cb = $arg{cb};
1168 my $fd = fileno $arg{fh};
1169 defined $fd or $fd = $arg{fh};
1170
1171 bless [$arg{fh}, urxvt::iow
1172 ->new
1173 ->fd ($fd)
1174 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1175 | ($arg{poll} =~ /w/ ? 2 : 0))
1176 ->start
1177 ->cb ($cb)
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 })
1204}
1205
1206sub DESTROY {
1207 $_[0][1]->stop;
1208}
1209
1210sub one_event {
1211 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1212}
1213
1214package urxvt::term;
1215
579=head2 The C<urxvt::term> Class 1216=head2 The C<urxvt::term> Class
580 1217
581=over 4 1218=over 4
582 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 }
1245 }
1246}
1247
1248=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1249
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.
1253
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}
1270
583=item $term->destroy 1271=item $term->destroy
584 1272
585Destroy 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}
586 1301
587=item $isset = $term->option ($optval[, $set]) 1302=item $isset = $term->option ($optval[, $set])
588 1303
589Returns true if the option specified by C<$optval> is enabled, and 1304Returns true if the option specified by C<$optval> is enabled, and
590optionally 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
591C<%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.
592 1307
593Here 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
594source file F</src/optinc.h> to see the actual list: 1309source file F</src/optinc.h> to see the actual list:
595 1310
596 borderLess console cursorBlink cursorUnderline hold iconic insecure 1311 borderLess console cursorBlink cursorUnderline hold iconic insecure
597 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1312 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
598 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1313 override-redirect pastableTabs pointerBlank reverseVideo scrollBar
599 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1314 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
600 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1315 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
601 tripleclickwords utmpInhibit visualBell 1316 transparent tripleclickwords utmpInhibit visualBell
602 1317
603=item $value = $term->resource ($name[, $newval]) 1318=item $value = $term->resource ($name[, $newval])
604 1319
605Returns the current resource value associated with a given name and 1320Returns the current resource value associated with a given name and
606optionally 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>
615likely change). 1330likely change).
616 1331
617Please note that resource strings will currently only be freed when the 1332Please note that resource strings will currently only be freed when the
618terminal is destroyed, so changing options frequently will eat memory. 1333terminal is destroyed, so changing options frequently will eat memory.
619 1334
620Here 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
621are 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>
622to see the actual list: 1337to see the actual list:
623 1338
624 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1339 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
625 borderLess color cursorBlink cursorUnderline cutchars delete_key 1340 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
626 display_name embed ext_bwidth fade font geometry hold iconName 1341 display_name embed ext_bwidth fade font geometry hold iconName
627 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1342 imFont imLocale inputMethod insecure int_bwidth intensityStyles
628 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1343 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
629 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1344 modifier mouseWheelScrollPage name override_redirect pastableTabs path
630 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1345 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
631 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1346 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
632 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1347 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
633 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1348 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
634 shade term_name title transparent transparent_all tripleclickwords 1349 secondaryScreen secondaryScroll shade term_name title
635 utmpInhibit visualBell 1350 transient_for transparent transparent_all tripleclickwords utmpInhibit
1351 visualBell
636 1352
637=cut 1353=cut
638 1354
639sub urxvt::term::resource($$;$) { 1355sub resource($$;$) {
640 my ($self, $name) = (shift, shift); 1356 my ($self, $name) = (shift, shift);
641 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1357 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
642 &urxvt::term::_resource 1358 goto &urxvt::term::_resource
643} 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.
644 1376
645=item $rend = $term->rstyle ([$new_rstyle]) 1377=item $rend = $term->rstyle ([$new_rstyle])
646 1378
647Return and optionally change the current rendition. Text that is output by 1379Return and optionally change the current rendition. Text that is output by
648the terminal application will use this style. 1380the terminal application will use this style.
656 1388
657=item ($row, $col) = $term->selection_beg ([$row, $col]) 1389=item ($row, $col) = $term->selection_beg ([$row, $col])
658 1390
659=item ($row, $col) = $term->selection_end ([$row, $col]) 1391=item ($row, $col) = $term->selection_end ([$row, $col])
660 1392
661Return the current values of the selection mark, begin or end positions, 1393Return the current values of the selection mark, begin or end positions.
662and optionally set them to new values.
663 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
664=item $success = $term->selection_grab ($eventtime) 1410=item $success = $term->selection_grab ($eventtime[, $clipboard])
665 1411
666Try to request the primary selection from the server (for example, as set 1412Try to acquire ownership of the primary (clipboard if C<$clipboard> is
667by 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.
668 1416
669=item $oldtext = $term->selection ([$newtext]) 1417=item $oldtext = $term->selection ([$newtext, $clipboard])
670 1418
671Return 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>.
672 1421
1422=item $term->selection_clear ([$clipboard])
1423
1424Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1425
673#=item $term->overlay ($x, $y, $text) 1426=item $term->overlay_simple ($x, $y, $text)
674# 1427
675#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.
676# 1429
677#=cut 1430=cut
678# 1431
679#sub urxvt::term::scr_overlay { 1432sub overlay_simple {
680# my ($self, $x, $y, $text) = @_; 1433 my ($self, $x, $y, $text) = @_;
681# 1434
682# my @lines = split /\n/, $text; 1435 my @lines = split /\n/, $text;
683# 1436
684# my $w = 0; 1437 my $w = List::Util::max map $self->strwidth ($_), @lines;
685# for (map $self->strwidth ($_), @lines) { 1438
686# $w = $_ if $w < $_;
687# }
688#
689# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1439 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
690# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1440 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
691#} 1441
1442 $overlay
1443}
692 1444
693=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1445=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
694 1446
695Create a new (empty) overlay at the given position with the given 1447Create a new (empty) overlay at the given position with the given
696width/height. C<$rstyle> defines the initial rendition style 1448width/height. C<$rstyle> defines the initial rendition style
707 1459
708The methods currently supported on C<urxvt::overlay> objects are: 1460The methods currently supported on C<urxvt::overlay> objects are:
709 1461
710=over 4 1462=over 4
711 1463
712=item $overlay->set ($x, $y, $text, $rend) 1464=item $overlay->set ($x, $y, $text[, $rend])
713 1465
714Similar 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
715text 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
716at a specific position inside the overlay. 1468at a specific position inside the overlay.
717 1469
1470If C<$rend> is missing, then the rendition will not be changed.
1471
718=item $overlay->hide 1472=item $overlay->hide
719 1473
720If visible, hide the overlay, but do not destroy it. 1474If visible, hide the overlay, but do not destroy it.
721 1475
722=item $overlay->show 1476=item $overlay->show
731C<$event> I<must> be the event causing the menu to pop up (a button event, 1485C<$event> I<must> be the event causing the menu to pop up (a button event,
732currently). 1486currently).
733 1487
734=cut 1488=cut
735 1489
736sub urxvt::term::popup { 1490sub popup {
737 my ($self, $event) = @_; 1491 my ($self, $event) = @_;
738 1492
739 $self->grab ($event->{time}, 1) 1493 $self->grab ($event->{time}, 1)
740 or return; 1494 or return;
741 1495
763 1517
764=item $string = $term->locale_decode ($octets) 1518=item $string = $term->locale_decode ($octets)
765 1519
766Convert the given locale-encoded octets into a perl string. 1520Convert the given locale-encoded octets into a perl string.
767 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
768=item $term->scr_add_lines ($string) 1539=item $term->scr_add_lines ($string)
769 1540
770Write 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
771running inside the terminal. It may not contain command sequences (escape 1542running inside the terminal. It may not contain command sequences (escape
772codes), 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
774 1545
775Normally 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
776confused by changes in cursor position or scrolling. Its useful inside a 1547confused by changes in cursor position or scrolling. Its useful inside a
777C<on_add_lines> hook, though. 1548C<on_add_lines> hook, though.
778 1549
1550=item $term->scr_change_screen ($screen)
1551
1552Switch to given screen - 0 primary, 1 secondary.
1553
779=item $term->cmd_parse ($octets) 1554=item $term->cmd_parse ($octets)
780 1555
781Similar 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
782locale-specific encoding of the terminal and can contain command sequences 1557locale-specific encoding of the terminal and can contain command sequences
783(escape codes) that will be interpreted. 1558(escape codes) that will be interpreted.
784 1559
785=item $term->tt_write ($octets) 1560=item $term->tt_write ($octets)
786 1561
787Write 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
788pass characters instead of octets, you should convert your strings first 1563pass characters instead of octets, you should convert your strings first
789to the locale-specific encoding using C<< $term->locale_encode >>. 1564to the locale-specific encoding using C<< $term->locale_encode >>.
790 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
791=item $windowid = $term->parent 1584=item $windowid = $term->parent
792 1585
793Return the window id of the toplevel window. 1586Return the window id of the toplevel window.
794 1587
795=item $windowid = $term->vt 1588=item $windowid = $term->vt
796 1589
797Return the window id of the terminal window. 1590Return the window id of the terminal window.
798 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
799=item $window_width = $term->width 1609=item $window_width = $term->width
800 1610
801=item $window_height = $term->height 1611=item $window_height = $term->height
802 1612
803=item $font_width = $term->fwidth 1613=item $font_width = $term->fwidth
816 1626
817=item $max_scrollback = $term->saveLines 1627=item $max_scrollback = $term->saveLines
818 1628
819=item $nrow_plus_saveLines = $term->total_rows 1629=item $nrow_plus_saveLines = $term->total_rows
820 1630
821=item $lines_in_scrollback = $term->nsaved 1631=item $topmost_scrollback_row = $term->top_row
822 1632
823Return 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}
824 1662
825=item $modifiermask = $term->ModLevel3Mask 1663=item $modifiermask = $term->ModLevel3Mask
826 1664
827=item $modifiermask = $term->ModMetaMask 1665=item $modifiermask = $term->ModMetaMask
828 1666
829=item $modifiermask = $term->ModNumLockMask 1667=item $modifiermask = $term->ModNumLockMask
830 1668
831Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1669Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
832AltGr), 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.
833 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
834=item $view_start = $term->view_start ([$newvalue]) 1680=item $view_start = $term->view_start ([$newvalue])
835 1681
836Returns the negative row number of the topmost line. Minimum value is 1682Returns the row number of the topmost displayed line. Maximum value is
837C<0>, which displays the normal terminal contents. Larger values scroll 1683C<0>, which displays the normal terminal contents. Lower values scroll
838this many lines into the scrollback buffer. 1684this many lines into the scrollback buffer.
839 1685
840=item $term->want_refresh 1686=item $term->want_refresh
841 1687
842Requests a screen refresh. At the next opportunity, rxvt-unicode will 1688Requests a screen refresh. At the next opportunity, rxvt-unicode will
845 1691
846Used after changing terminal contents to display them. 1692Used after changing terminal contents to display them.
847 1693
848=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1694=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
849 1695
850Returns 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 >>
851is 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
852terminal line. The scrollback buffer starts at line C<-1> and extends to
853line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1698terminal line. Nothing will be returned if a nonexistent line
854is requested. 1699is requested.
855 1700
856If 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
857line, 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
858to 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
859automatically be updated. 1704automatically be updated.
860 1705
861C<$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
862than one cell when displayed are padded with urxvt::NOCHAR characters 1707than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
863(C<chr 65535>). Characters with combining characters and other characters 1708characters. Characters with combining characters and other characters that
864that 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
865characters in the private use area. 1710in the private use area.
866 1711
867You have to obey this encoding when changing text. The advantage is 1712You have to obey this encoding when changing text. The advantage is
868that 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
869characters. 1714characters.
870 1715
921Return 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.
922 1767
923=item $offset = $line->offset_of ($row, $col) 1768=item $offset = $line->offset_of ($row, $col)
924 1769
925Returns 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
926line. 1771line. Works for rows outside the line, too, and returns corresponding
1772offsets outside the string.
927 1773
928=item ($row, $col) = $line->coord_of ($offset) 1774=item ($row, $col) = $line->coord_of ($offset)
929 1775
930Translates a string offset into terminal coordinates again. 1776Translates a string offset into terminal coordinates again.
931 1777
932=back 1778=back
933 1779
934=cut 1780=cut
935 1781
936sub urxvt::term::line { 1782sub line {
937 my ($self, $row) = @_; 1783 my ($self, $row) = @_;
938 1784
939 my $maxrow = $self->nrow - 1; 1785 my $maxrow = $self->nrow - 1;
940 1786
941 my ($beg, $end) = ($row, $row); 1787 my ($beg, $end) = ($row, $row);
1005 $offset / $self->{ncol} + $self->{beg}, 1851 $offset / $self->{ncol} + $self->{beg},
1006 $offset % $self->{ncol} 1852 $offset % $self->{ncol}
1007 ) 1853 )
1008} 1854}
1009 1855
1010=item ($row, $col) = $line->coord_of ($offset)
1011=item $text = $term->special_encode $string 1856=item $text = $term->special_encode $string
1012 1857
1013Converts a perl string into the special encoding used by rxvt-unicode, 1858Converts a perl string into the special encoding used by rxvt-unicode,
1014where one character corresponds to one screen cell. See 1859where one character corresponds to one screen cell. See
1015C<< $term->ROW_t >> for details. 1860C<< $term->ROW_t >> for details.
1016 1861
1017=item $string = $term->special_decode $text 1862=item $string = $term->special_decode $text
1018 1863
1019Converts rxvt-unicodes text reprsentation into a perl string. See 1864Converts rxvt-unicodes text representation into a perl string. See
1020C<< $term->ROW_t >> for details. 1865C<< $term->ROW_t >> for details.
1021 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.
1927
1022=back 1928=back
1023 1929
1930=cut
1931
1932package urxvt::popup;
1933
1024=head2 The C<urxvt::popup> Class 1934=head2 The C<urxvt::popup> Class
1025 1935
1026=over 4 1936=over 4
1027 1937
1028=cut 1938=cut
1029
1030package urxvt::popup;
1031 1939
1032sub add_item { 1940sub add_item {
1033 my ($self, $item) = @_; 1941 my ($self, $item) = @_;
1034 1942
1035 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal}; 1943 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1039 $item->{render} ||= sub { $_[0]{text} }; 1947 $item->{render} ||= sub { $_[0]{text} };
1040 1948
1041 push @{ $self->{item} }, $item; 1949 push @{ $self->{item} }, $item;
1042} 1950}
1043 1951
1044sub add_separator { 1952=item $popup->add_title ($title)
1045 my ($self, $sep) = @_;
1046 1953
1047 $sep ||= "═"; 1954Adds a non-clickable title to the popup.
1048 1955
1049 $self->add_item ({ 1956=cut
1050 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1051 text => "",
1052 render => sub { $sep x $urxvt::TERM->ncol },
1053 activate => sub { },
1054 });
1055}
1056 1957
1057sub add_title { 1958sub add_title {
1058 my ($self, $title) = @_; 1959 my ($self, $title) = @_;
1059 1960
1060 $self->add_item ({ 1961 $self->add_item ({
1062 text => $title, 1963 text => $title,
1063 activate => sub { }, 1964 activate => sub { },
1064 }); 1965 });
1065} 1966}
1066 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
1067sub add_button { 1994sub add_button {
1068 my ($self, $text, $cb) = @_; 1995 my ($self, $text, $cb) = @_;
1069 1996
1070 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb}); 1997 $self->add_item ({ type => "button", text => $text, activate => $cb});
1071} 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
1072 2007
1073sub add_toggle { 2008sub add_toggle {
1074 my ($self, $text, $cb, $value) = @_; 2009 my ($self, $text, $value, $cb) = @_;
1075 2010
1076 my $item; $item = { 2011 my $item; $item = {
1077 type => "button", 2012 type => "button",
1078 text => " $text", 2013 text => " $text",
1079 value => $value, 2014 value => $value,
1080 render => sub { ($item->{value} ? "* " : " ") . $text }, 2015 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1081 activate => sub { $cb->($item->{value} = !$item->{value}); }, 2016 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1082 }; 2017 };
1083 2018
1084 $self->add_item ($item); 2019 $self->add_item ($item);
1085} 2020}
2021
2022=item $popup->show
2023
2024Displays the popup (which is initially hidden).
2025
2026=cut
1086 2027
1087sub show { 2028sub show {
1088 my ($self) = @_; 2029 my ($self) = @_;
1089 2030
1090 local $urxvt::popup::self = $self; 2031 local $urxvt::popup::self = $self;
1091 2032
1092 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",
1093 "--transient-for" => $self->{term}->parent, 2043 "--transient-for" => $self->{term}->parent,
2044 "-display" => $self->{term}->display_id,
1094 "-pe" => "urxvt-popup") 2045 "-pe" => "urxvt-popup",
1095 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 }
1096} 2053}
1097 2054
1098sub DESTROY { 2055sub DESTROY {
1099 my ($self) = @_; 2056 my ($self) = @_;
1100 2057
2058 delete $self->{term}{_destroy}{$self};
1101 $self->{term}->ungrab; 2059 $self->{term}->ungrab;
1102} 2060}
2061
2062=back
2063
2064=cut
2065
2066package urxvt::watcher;
1103 2067
1104=head2 The C<urxvt::timer> Class 2068=head2 The C<urxvt::timer> Class
1105 2069
1106This class implements timer watchers/events. Time is represented as a 2070This class implements timer watchers/events. Time is represented as a
1107fractional number of seconds since the epoch. Example: 2071fractional number of seconds since the epoch. Example:
1111 ->new 2075 ->new
1112 ->interval (1) 2076 ->interval (1)
1113 ->cb (sub { 2077 ->cb (sub {
1114 $term->{overlay}->set (0, 0, 2078 $term->{overlay}->set (0, 0,
1115 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2079 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1116 }); 2080 });
1117 2081
1118=over 4 2082=over 4
1119 2083
1120=item $timer = new urxvt::timer 2084=item $timer = new urxvt::timer
1121 2085
1124 2088
1125=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2089=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1126 2090
1127Set the callback to be called when the timer triggers. 2091Set the callback to be called when the timer triggers.
1128 2092
1129=item $tstamp = $timer->at
1130
1131Return the time this watcher will fire next.
1132
1133=item $timer = $timer->set ($tstamp) 2093=item $timer = $timer->set ($tstamp[, $interval])
1134 2094
1135Set the time the event is generated to $tstamp. 2095Set the time the event is generated to $tstamp (and optionally specifies a
2096new $interval).
1136 2097
1137=item $timer = $timer->interval ($interval) 2098=item $timer = $timer->interval ($interval)
1138 2099
1139Normally (and when C<$interval> is C<0>), the timer will automatically 2100By default (and when C<$interval> is C<0>), the timer will automatically
1140stop 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
1141is automatically rescheduled at the given intervals. 2102is automatically rescheduled at the given intervals.
1142 2103
1143=item $timer = $timer->start 2104=item $timer = $timer->start
1144 2105
1145Start the timer. 2106Start the timer.
1146 2107
1147=item $timer = $timer->start ($tstamp) 2108=item $timer = $timer->start ($tstamp[, $interval])
1148 2109
1149Set 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>.
1150 2116
1151=item $timer = $timer->stop 2117=item $timer = $timer->stop
1152 2118
1153Stop the timer. 2119Stop the timer.
1154 2120
1160 2126
1161 $term->{socket} = ... 2127 $term->{socket} = ...
1162 $term->{iow} = urxvt::iow 2128 $term->{iow} = urxvt::iow
1163 ->new 2129 ->new
1164 ->fd (fileno $term->{socket}) 2130 ->fd (fileno $term->{socket})
1165 ->events (1) # wait for read data 2131 ->events (urxvt::EV_READ)
1166 ->start 2132 ->start
1167 ->cb (sub { 2133 ->cb (sub {
1168 my ($iow, $revents) = @_; 2134 my ($iow, $revents) = @_;
1169 # $revents must be 1 here, no need to check 2135 # $revents must be 1 here, no need to check
1170 sysread $term->{socket}, my $buf, 8192 2136 sysread $term->{socket}, my $buf, 8192
1183Set 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>
1184is a bitset as described in the C<events> method. 2150is a bitset as described in the C<events> method.
1185 2151
1186=item $iow = $iow->fd ($fd) 2152=item $iow = $iow->fd ($fd)
1187 2153
1188Set the filedescriptor (not handle) to watch. 2154Set the file descriptor (not handle) to watch.
1189 2155
1190=item $iow = $iow->events ($eventmask) 2156=item $iow = $iow->events ($eventmask)
1191 2157
1192Set 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
1193data, 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>.
1194 2161
1195=item $iow = $iow->start 2162=item $iow = $iow->start
1196 2163
1197Start watching for requested events on the given handle. 2164Start watching for requested events on the given handle.
1198 2165
1199=item $iow = $iow->stop 2166=item $iow = $iow->stop
1200 2167
1201Stop 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.
1202 2230
1203=back 2231=back
1204 2232
1205=head1 ENVIRONMENT 2233=head1 ENVIRONMENT
1206 2234
1209This variable controls the verbosity level of the perl extension. Higher 2237This variable controls the verbosity level of the perl extension. Higher
1210numbers indicate more verbose output. 2238numbers indicate more verbose output.
1211 2239
1212=over 4 2240=over 4
1213 2241
1214=item =0 - only fatal messages 2242=item == 0 - fatal messages
1215 2243
1216=item =3 - script loading and management 2244=item >= 3 - script loading and management
1217 2245
1218=item =10 - all events received 2246=item >=10 - all called hooks
2247
2248=item >=11 - hook return values
1219 2249
1220=back 2250=back
1221 2251
1222=head1 AUTHOR 2252=head1 AUTHOR
1223 2253
1225 http://software.schmorp.de/pkg/rxvt-unicode 2255 http://software.schmorp.de/pkg/rxvt-unicode
1226 2256
1227=cut 2257=cut
1228 2258
12291 22591
2260
2261# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines