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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines