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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines