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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines