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.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.203 by sf-exg, Fri Dec 2 09:03:43 2011 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
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. 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
44(More) intelligent selection. This extension tries to be more intelligent 51(More) intelligent selection. This extension tries to be more intelligent
45when the user extends selections (double-click). Right now, it tries to 52when the user extends selections (double-click and further clicks). Right
46select urls and complete shell-quoted arguments, which is very convenient, 53now, it tries to select words, urls and complete shell-quoted
47too, if 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
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
49It also offers the following bindable keyboard command: 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 (such as uri unescaping, perl 122text into various other formats/action (such as uri unescaping, perl
70evalution, web-browser starting etc.), depending on content. 123evaluation, web-browser starting etc.), depending on content.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<a>s:
138
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : ()
142 };
71 143
72=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
73 145
74Adds regex search functionality to the scrollback buffer, triggered 146Adds regex search functionality to the scrollback buffer, triggered
75by a hotkey (default: C<M-s>). When in search mode, normal terminal 147by a hotkey (default: C<M-s>). While in search mode, normal terminal
76input/output is suspended. 148input/output is suspended and a regex is displayed at the bottom of the
149screen.
77 150
78C</> starts an incremental regex search, C<n> searches further, C<p> or 151Inputting characters appends them to the regex and continues incremental
79C<N> jump to the previous match, C<G> jumps to the bottom and clears the 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
80history, C<enter> leaves search mode at the current position and C<escape> 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
81returns to the original position. 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.
82 158
83=item digital-clock 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.
84 162
85Displays a digital clock using the built-in overlay. 163See L<perlre> for more info about perl regular expression syntax.
86 164
87=item mark-urls 165=item readline (enabled by default)
88 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
89Uses 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 or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
268Example configuration:
269
270 URxvt.perl-ext: default,matcher
271 URxvt.urlLauncher: sensible-browser
272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
274 URxvt.matcher.button: 1
275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277 URxvt.matcher.launcher.2: gvim +$2 $1
278
279=item xim-onthespot
280
281This (experimental) perl extension implements OnTheSpot editing. It does
282not work perfectly, and some input methods don't seem to work well with
283OnTheSpot editing in general, but it seems to work at least for SCIM and
284kinput2.
285
286You enable it by specifying this extension and a preedit style of
287C<OnTheSpot>, i.e.:
288
289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291=item kuake<hotkey>
292
293A very primitive quake-console-like extension. It was inspired by a
294description of how the programs C<kuake> and C<yakuake> work: Whenever the
295user presses a global accelerator key (by default C<F10>), the terminal
296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
298
299Initially, the window will not be shown when using this extension.
300
301This is useful if you need a single terminal that is not using any desktop
302space most of the time but is quickly available at the press of a key.
303
304The accelerator key is grabbed regardless of any modifiers, so this
305extension will actually grab a physical key just for this function.
306
307If you want a quake-like animation, tell your window manager to do so
308(fvwm can do it).
309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
90 315
91=item block-graphics-to-ascii 316=item block-graphics-to-ascii
92 317
93A not very useful example of filtering all text output to the terminal, 318A not very useful example of filtering all text output to the terminal
94by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
95similar-looking ascii character. 320similar-looking ascii character.
321
322=item digital-clock
323
324Displays a digital clock using the built-in overlay.
325
326=item remote-clipboard
327
328Somewhat of a misnomer, this extension adds two menu entries to the
329selection popup that allows one to run external commands to store the
330selection somewhere and fetch it again.
331
332We use it to implement a "distributed selection mechanism", which just
333means that one command uploads the file to a remote server, and another
334reads it.
335
336The commands can be set using the C<URxvt.remote-selection.store> and
337C<URxvt.remote-selection.fetch> resources. The first should read the
338selection to store from STDIN (always in UTF-8), the second should provide
339the selection data on STDOUT (also in UTF-8).
340
341The defaults (which are likely useless to you) use rsh and cat:
342
343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346=item selection-pastebin
347
348This is a little rarely useful extension that uploads the selection as
349textfile to a remote site (or does other things). (The implementation is
350not currently secure for use in a multiuser environment as it writes to
351F</tmp> directly.).
352
353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354i.e.
355
356 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358Pressing this combination runs a command with C<%> replaced by the name of
359the textfile. This command can be set via a resource:
360
361 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363And the default is likely not useful to anybody but the few people around
364here :)
365
366The name of the textfile is the hex encoded md5 sum of the selection, so
367the same content should lead to the same filename.
368
369After a successful upload the selection will be replaced by the text given
370in the C<selection-pastebin-url> resource (again, the % is the placeholder
371for the filename):
372
373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376the double C</> characters as comment start. Use C<\057\057> instead,
377which works regardless of whether xrdb is used to parse the resource file
378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
96 393
97=item example-refresh-hooks 394=item example-refresh-hooks
98 395
99Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
100window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
101overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
102 412
103=back 413=back
104 414
105=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
106 416
122 432
123=over 4 433=over 4
124 434
125=item $text 435=item $text
126 436
127Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
128always represents one screen cell. See L<row_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
129 439
130=item $string 440=item $string
131 441
132A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
133characters and is to be distinguished with text encoded in a specific 443characters and is to be distinguished with text encoded in a specific
136=item $octets 446=item $octets
137 447
138Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
139locale-specific way. 449locale-specific way.
140 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
141=back 457=back
142 458
143=head2 Extension Objects 459=head2 Extension Objects
144 460
145Very perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
146for each terminal and each extension and passed as the first parameter to 462for each terminal, and each terminal has its own set of extension objects,
147hooks. So extensions can use their C<$self> object without having to think 463which are passed as the first parameter to hooks. So extensions can use
148about other extensions, with the exception of methods and members that 464their C<$self> object without having to think about clashes with other
465extensions or other terminals, with the exception of methods and members
149begin with an underscore character C<_>: these are reserved for internal 466that begin with an underscore character C<_>: these are reserved for
150use. 467internal use.
151 468
152Although it isn't a C<urxvt::term> object, you can call all methods of the 469Although it isn't a C<urxvt::term> object, you can call all methods of the
153C<urxvt::term> class on this object. 470C<urxvt::term> class on this object.
154 471
155It has the following methods and data members: 472It has the following methods and data members:
176=head2 Hooks 493=head2 Hooks
177 494
178The following subroutines can be declared in extension files, and will be 495The following subroutines can be declared in extension files, and will be
179called whenever the relevant event happens. 496called whenever the relevant event happens.
180 497
181The first argument passed to them is an extension oject as described in 498The first argument passed to them is an extension object as described in
182the in the C<Extension Objects> section. 499the in the C<Extension Objects> section.
183 500
184B<All> of these hooks must return a boolean value. If it is true, then the 501B<All> of these hooks must return a boolean value. If any of the called
185event counts as being I<consumed>, and the invocation of other hooks is 502hooks returns true, then the event counts as being I<consumed>, and the
186skipped, and the relevant action might not be carried out by the C++ code. 503relevant action might not be carried out by the C++ code.
187 504
188I<< When in doubt, return a false value (preferably C<()>). >> 505I<< When in doubt, return a false value (preferably C<()>). >>
189 506
190=over 4 507=over 4
191 508
192=item on_init $term 509=item on_init $term
193 510
194Called after a new terminal object has been initialized, but before 511Called after a new terminal object has been initialized, but before
195windows are created or the command gets run. Most methods are unsafe to 512windows are created or the command gets run. Most methods are unsafe to
196call or deliver senseless data, as terminal size and other characteristics 513call or deliver senseless data, as terminal size and other characteristics
197have not yet been determined. You can safely query and change resources, 514have not yet been determined. You can safely query and change resources
198though. 515and options, though. For many purposes the C<on_start> hook is a better
516place.
517
518=item on_start $term
519
520Called at the very end of initialisation of a new terminal, just before
521trying to map (display) the toplevel and returning to the main loop.
522
523=item on_destroy $term
524
525Called whenever something tries to destroy terminal, when the terminal is
526still fully functional (not for long, though).
199 527
200=item on_reset $term 528=item on_reset $term
201 529
202Called after the screen is "reset" for any reason, such as resizing or 530Called after the screen is "reset" for any reason, such as resizing or
203control sequences. Here is where you can react on changes to size-related 531control sequences. Here is where you can react on changes to size-related
204variables. 532variables.
205 533
206=item on_start $term 534=item on_child_start $term, $pid
207 535
208Called at the very end of initialisation of a new terminal, just before 536Called just after the child process has been C<fork>ed.
209returning to the mainloop. 537
538=item on_child_exit $term, $status
539
540Called just after the child process has exited. C<$status> is the status
541from C<waitpid>.
210 542
211=item on_sel_make $term, $eventtime 543=item on_sel_make $term, $eventtime
212 544
213Called whenever a selection has been made by the user, but before the 545Called whenever a selection has been made by the user, but before the
214selection text is copied, so changes to the beginning, end or type of the 546selection text is copied, so changes to the beginning, end or type of the
221 553
222Called whenever a selection has been copied, but before the selection is 554Called whenever a selection has been copied, but before the selection is
223requested from the server. The selection text can be queried and changed 555requested from the server. The selection text can be queried and changed
224by calling C<< $term->selection >>. 556by calling C<< $term->selection >>.
225 557
226Returning a true value aborts selection grabbing. It will still be hilighted. 558Returning a true value aborts selection grabbing. It will still be highlighted.
227 559
228=item on_sel_extend $term 560=item on_sel_extend $term
229 561
230Called whenever the user tries to extend the selection (e.g. with a double 562Called whenever the user tries to extend the selection (e.g. with a double
231click) and is either supposed to return false (normal operation), or 563click) and is either supposed to return false (normal operation), or
232should extend the selection itelf and return true to suppress the built-in 564should extend the selection itself and return true to suppress the built-in
233processing. 565processing. This can happen multiple times, as long as the callback
566returns true, it will be called on every further click by the user and is
567supposed to enlarge the selection more and more, if possible.
234 568
235See the F<selection> example extension. 569See the F<selection> example extension.
236 570
237=item on_view_change $term, $offset 571=item on_view_change $term, $offset
238 572
239Called whenever the view offset changes, i..e the user or program 573Called whenever the view offset changes, i.e. the user or program
240scrolls. Offset C<0> means display the normal terminal, positive values 574scrolls. Offset C<0> means display the normal terminal, positive values
241show this many lines of scrollback. 575show this many lines of scrollback.
242 576
243=item on_scroll_back $term, $lines, $saved 577=item on_scroll_back $term, $lines, $saved
244 578
248 582
249It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 583It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
250$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 584$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
251number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
252 586
253=item on_osc_seq $term, $string 587=item on_osc_seq $term, $op, $args, $resp
588
589Called on every OSC sequence and can be used to suppress it or modify its
590behaviour. The default should be to return an empty list. A true value
591suppresses execution of the request completely. Make sure you don't get
592confused by recursive invocations when you output an OSC sequence within
593this callback.
594
595C<on_osc_seq_perl> should be used for new behaviour.
596
597=item on_osc_seq_perl $term, $args, $resp
254 598
255Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
256operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
257information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
258string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
259it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
260future. 604enforced in the future.
605
606For example, C<overlay-osc> uses this:
607
608 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_;
610
611 return unless $osc =~ s/^overlay;//;
612
613 ... process remaining $osc string
614 }
261 615
262Be careful not ever to trust (in a security sense) the data you receive, 616Be careful not ever to trust (in a security sense) the data you receive,
263as its source can not easily be controleld (e-mail content, messages from 617as its source can not easily be controlled (e-mail content, messages from
264other users on the same system etc.). 618other users on the same system etc.).
619
620For responses, C<$resp> contains the end-of-args separator used by the
621sender.
265 622
266=item on_add_lines $term, $string 623=item on_add_lines $term, $string
267 624
268Called whenever text is about to be output, with the text as argument. You 625Called whenever text is about to be output, with the text as argument. You
269can filter/change and output the text yourself by returning a true value 626can filter/change and output the text yourself by returning a true value
274=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
275 632
276Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
277suppress or filter tty input. 634suppress or filter tty input.
278 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
279=item on_line_update $term, $row 643=item on_line_update $term, $row
280 644
281Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
282screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
283that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
290later with the already-modified line (e.g. if unrelated parts change), so 654later with the already-modified line (e.g. if unrelated parts change), so
291you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
292 656
293=item on_refresh_begin $term 657=item on_refresh_begin $term
294 658
295Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
296or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
297restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
298code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
299 663
300=item on_refresh_end $term 664=item on_refresh_end $term
301 665
302Called just after the screen gets redrawn. See C<on_refresh_begin>. 666Called just after the screen gets redrawn. See C<on_refresh_begin>.
303 667
304=item on_keyboard_command $term, $string 668=item on_user_command $term, $string
305 669
306Called whenever the user presses a key combination that has a 670Called whenever a user-configured event is being activated (e.g. via
307C<perl:string> action bound to it (see description of the B<keysym> 671a C<perl:string> action bound to a key, see description of the B<keysym>
308resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
673
674The event is simply the action string. This interface is assumed to change
675slightly in the future.
676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
684=item on_resize_all_windows $term, $new_width, $new_height
685
686Called just after the new window size has been calculated, but before
687windows are actually being resized or hints are being set. If this hook
688returns TRUE, setting of the window hints is being skipped.
689
690=item on_x_event $term, $event
691
692Called on every X event received on the vt window (and possibly other
693windows). Should only be used as a last resort. Most event structure
694members are not passed.
695
696=item on_root_event $term, $event
697
698Like C<on_x_event>, but is called for events on the root window.
309 699
310=item on_focus_in $term 700=item on_focus_in $term
311 701
312Called whenever the window gets the keyboard focus, before rxvt-unicode 702Called whenever the window gets the keyboard focus, before rxvt-unicode
313does focus in processing. 703does focus in processing.
314 704
315=item on_focus_out $term 705=item on_focus_out $term
316 706
317Called wheneever the window loses keyboard focus, before rxvt-unicode does 707Called whenever the window loses keyboard focus, before rxvt-unicode does
318focus out processing. 708focus out processing.
319 709
710=item on_configure_notify $term, $event
711
712=item on_property_notify $term, $event
713
320=item on_key_press $term, $event, $keysym, $octets 714=item on_key_press $term, $event, $keysym, $octets
321 715
322=item on_key_release $term, $event, $keysym 716=item on_key_release $term, $event, $keysym
323 717
324=item on_button_press $term, $event 718=item on_button_press $term, $event
329 723
330=item on_map_notify $term, $event 724=item on_map_notify $term, $event
331 725
332=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
333 727
334Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
335the hook returns true, then the even will be ignored by rxvt-unicode. 729the hook returns true, then the event will be ignored by rxvt-unicode.
336 730
337The event is a hash with most values as named by Xlib (see the XEvent 731The event is a hash with most values as named by Xlib (see the XEvent
338manpage), with the additional members C<row> and C<col>, which are the row 732manpage), with the additional members C<row> and C<col>, which are the
339and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
340 734
341C<on_key_press> additionally receives the string rxvt-unicode would 735C<on_key_press> additionally receives the string rxvt-unicode would
342output, if any, in locale-specific encoding. 736output, if any, in locale-specific encoding.
343 737
344subwindow. 738subwindow.
345 739
346=back 740=item on_client_message $term, $event
347 741
348=head2 Variables in the C<urxvt> Package 742=item on_wm_protocols $term, $event
349 743
350=over 4 744=item on_wm_delete_window $term, $event
351 745
352=item $urxvt::LIBDIR 746Called when various types of ClientMessage events are received (all with
747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
353 748
354The rxvt-unicode library directory, where, among other things, the perl 749=item on_bell $term
355modules and scripts are stored.
356 750
357=item $urxvt::RESCLASS, $urxvt::RESCLASS 751Called on receipt of a bell character.
358
359The resource class and name rxvt-unicode uses to look up X resources.
360
361=item $urxvt::RXVTNAME
362
363The basename of the installed binaries, usually C<urxvt>.
364
365=item $urxvt::TERM
366
367The current terminal. This variable stores the current C<urxvt::term>
368object, whenever a callback/hook is executing.
369
370=item
371
372=back
373
374=head2 Functions in the C<urxvt> Package
375
376=over 4
377
378=item $term = new urxvt [arg...]
379
380Creates a new terminal, very similar as if you had started it with
381C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382if the new instance couldn't be created. Returns C<undef> if the new
383instance didn't initialise perl, and the terminal object otherwise. The
384C<init> and C<start> hooks will be called during the call.
385
386=item urxvt::fatal $errormessage
387
388Fatally aborts execution with the given error message. Avoid at all
389costs! The only time this is acceptable is when the terminal process
390starts up.
391
392=item urxvt::warn $string
393
394Calls C<rxvt_warn> with the given string which should not include a
395newline. The module also overwrites the C<warn> builtin with a function
396that calls this function.
397
398Using this function has the advantage that its output ends up in the
399correct place, e.g. on stderr of the connecting urxvtc client.
400
401=item $is_safe = urxvt::safe
402
403Returns true when it is safe to do potentially unsafe things, such as
404evaluating perl code specified by the user. This is true when urxvt was
405started setuid or setgid.
406
407=item $time = urxvt::NOW
408
409Returns the "current time" (as per the event loop).
410
411=item urxvt::CurrentTime
412
413=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415Button4Mask, Button5Mask, AnyModifier
416
417Various constants for use in X calls and event processing.
418
419=back
420
421=head2 RENDITION
422
423Rendition bitsets contain information about colour, font, font styles and
424similar information for each screen cell.
425
426The following "macros" deal with changes in rendition sets. You should
427never just create a bitset, you should always modify an existing one,
428as they contain important information required for correct operation of
429rxvt-unicode.
430
431=over 4
432
433=item $rend = urxvt::DEFAULT_RSTYLE
434
435Returns the default rendition, as used when the terminal is starting up or
436being reset. Useful as a base to start when creating renditions.
437
438=item $rend = urxvt::OVERLAY_RSTYLE
439
440Return the rendition mask used for overlays by default.
441
442=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444Return the bit that enabled bold, italic, blink, reverse-video and
445underline, respectively. To enable such a style, just logically OR it into
446the bitset.
447
448=item $foreground = urxvt::GET_BASEFG $rend
449
450=item $background = urxvt::GET_BASEBG $rend
451
452Return the foreground/background colour index, respectively.
453
454=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458Replace the foreground/background colour in the rendition mask with the
459specified one.
460
461=item $value = urxvt::GET_CUSTOM $rend
462
463Return the "custom" value: Every rendition has 5 bits for use by
464extensions. They can be set and changed as you like and are initially
465zero.
466
467=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469Change the custom value.
470 752
471=back 753=back
472 754
473=cut 755=cut
474 756
480use Scalar::Util (); 762use Scalar::Util ();
481use List::Util (); 763use List::Util ();
482 764
483our $VERSION = 1; 765our $VERSION = 1;
484our $TERM; 766our $TERM;
767our @TERM_INIT;
768our @TERM_EXT;
485our @HOOKNAME; 769our @HOOKNAME;
486our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 770our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
487our %OPTION; 771our %OPTION;
488 772
489our $LIBDIR; 773our $LIBDIR;
490our $RESNAME; 774our $RESNAME;
491our $RESCLASS; 775our $RESCLASS;
492our $RXVTNAME; 776our $RXVTNAME;
493 777
778our $NOCHAR = chr 0xffff;
779
780=head2 Variables in the C<urxvt> Package
781
782=over 4
783
784=item $urxvt::LIBDIR
785
786The rxvt-unicode library directory, where, among other things, the perl
787modules and scripts are stored.
788
789=item $urxvt::RESCLASS, $urxvt::RESCLASS
790
791The resource class and name rxvt-unicode uses to look up X resources.
792
793=item $urxvt::RXVTNAME
794
795The basename of the installed binaries, usually C<urxvt>.
796
797=item $urxvt::TERM
798
799The current terminal. This variable stores the current C<urxvt::term>
800object, whenever a callback/hook is executing.
801
802=item @urxvt::TERM_INIT
803
804All code references in this array will be called as methods of the next newly
805created C<urxvt::term> object (during the C<on_init> phase). The array
806gets cleared before the code references that were in it are being executed,
807so references can push themselves onto it again if they so desire.
808
809This complements to the perl-eval command line option, but gets executed
810first.
811
812=item @urxvt::TERM_EXT
813
814Works similar to C<@TERM_INIT>, but contains perl package/class names, which
815get registered as normal extensions after calling the hooks in C<@TERM_INIT>
816but before other extensions. Gets cleared just like C<@TERM_INIT>.
817
818=back
819
820=head2 Functions in the C<urxvt> Package
821
822=over 4
823
824=item urxvt::fatal $errormessage
825
826Fatally aborts execution with the given error message (which should
827include a trailing newline). Avoid at all costs! The only time this
828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
830
831=item urxvt::warn $string
832
833Calls C<rxvt_warn> with the given string which should include a trailing
834newline. The module also overwrites the C<warn> builtin with a function
835that calls this function.
836
837Using this function has the advantage that its output ends up in the
838correct place, e.g. on stderr of the connecting urxvtc client.
839
840Messages have a size limit of 1023 bytes currently.
841
842=item @terms = urxvt::termlist
843
844Returns all urxvt::term objects that exist in this process, regardless of
845whether they are started, being destroyed etc., so be careful. Only term
846objects that have perl extensions attached will be returned (because there
847is no urxvt::term object associated with others).
848
849=item $time = urxvt::NOW
850
851Returns the "current time" (as per the event loop).
852
853=item urxvt::CurrentTime
854
855=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
856Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
857Button4Mask, Button5Mask, AnyModifier
858
859=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
860ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
861PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
862Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
863KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
864ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
865FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
866
867=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
868EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
869GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
870UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
871ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
872CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
873SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
874
875Various constants for use in X calls and event processing.
876
877=back
878
879=head2 RENDITION
880
881Rendition bitsets contain information about colour, font, font styles and
882similar information for each screen cell.
883
884The following "macros" deal with changes in rendition sets. You should
885never just create a bitset, you should always modify an existing one,
886as they contain important information required for correct operation of
887rxvt-unicode.
888
889=over 4
890
891=item $rend = urxvt::DEFAULT_RSTYLE
892
893Returns the default rendition, as used when the terminal is starting up or
894being reset. Useful as a base to start when creating renditions.
895
896=item $rend = urxvt::OVERLAY_RSTYLE
897
898Return the rendition mask used for overlays by default.
899
900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
902
903Return the bit that enabled bold, italic, blink, reverse-video and
904underline, respectively. To enable such a style, just logically OR it into
905the bitset.
906
907=item $foreground = urxvt::GET_BASEFG $rend
908
909=item $background = urxvt::GET_BASEBG $rend
910
911Return the foreground/background colour index, respectively.
912
913=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
914
915=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
916
917=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
918
919Replace the foreground/background colour in the rendition mask with the
920specified one.
921
922=item $value = urxvt::GET_CUSTOM $rend
923
924Return the "custom" value: Every rendition has 5 bits for use by
925extensions. They can be set and changed as you like and are initially
926zero.
927
928=item $rend = urxvt::SET_CUSTOM $rend, $new_value
929
930Change the custom value.
931
932=back
933
934=cut
935
494BEGIN { 936BEGIN {
495 urxvt->bootstrap;
496
497 # overwrite perl's warn 937 # overwrite perl's warn
498 *CORE::GLOBAL::warn = sub { 938 *CORE::GLOBAL::warn = sub {
499 my $msg = join "", @_; 939 my $msg = join "", @_;
500 $msg .= "\n" 940 $msg .= "\n"
501 unless $msg =~ /\n$/; 941 unless $msg =~ /\n$/;
502 urxvt::warn ($msg); 942 urxvt::warn ($msg);
503 }; 943 };
504
505 delete $ENV{IFS};
506 delete $ENV{CDPATH};
507 delete $ENV{BASH_ENV};
508 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
509} 944}
510 945
511my @hook_count; 946no warnings 'utf8';
947
512my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 948my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
513 949
514sub verbose { 950sub verbose {
515 my ($level, $msg) = @_; 951 my ($level, $msg) = @_;
516 warn "$msg\n" if $level <= $verbosity; 952 warn "$msg\n" if $level <= $verbosity;
517} 953}
518 954
519my $extension_pkg = "extension0000";
520my %extension_pkg; 955my %extension_pkg;
521 956
522# load a single script into its own package, once only 957# load a single script into its own package, once only
523sub extension_package($) { 958sub extension_package($) {
524 my ($path) = @_; 959 my ($path) = @_;
525 960
526 $extension_pkg{$path} ||= do { 961 $extension_pkg{$path} ||= do {
527 my $pkg = "urxvt::" . ($extension_pkg++); 962 $path =~ /([^\/\\]+)$/;
963 my $pkg = $1;
964 $pkg =~ s/[^[:word:]]/_/g;
965 $pkg = "urxvt::ext::$pkg";
528 966
529 verbose 3, "loading extension '$path' into package '$pkg'"; 967 verbose 3, "loading extension '$path' into package '$pkg'";
530 968
531 open my $fh, "<:raw", $path 969 open my $fh, "<:raw", $path
532 or die "$path: $!"; 970 or die "$path: $!";
533 971
534 my $source = untaint 972 my $source =
535 "package $pkg; use strict; use utf8;\n" 973 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
536 . "use base urxvt::term::extension::;\n"
537 . "#line 1 \"$path\"\n{\n" 974 . "#line 1 \"$path\"\n{\n"
538 . (do { local $/; <$fh> }) 975 . (do { local $/; <$fh> })
539 . "\n};\n1"; 976 . "\n};\n1";
540 977
541 eval $source 978 eval $source
551sub invoke { 988sub invoke {
552 local $TERM = shift; 989 local $TERM = shift;
553 my $htype = shift; 990 my $htype = shift;
554 991
555 if ($htype == 0) { # INIT 992 if ($htype == 0) { # INIT
556 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 993 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
557 994
558 my %ext_arg; 995 my %ext_arg;
559 996
997 {
998 my @init = @TERM_INIT;
999 @TERM_INIT = ();
1000 $_->($TERM) for @init;
1001 my @pkg = @TERM_EXT;
1002 @TERM_EXT = ();
1003 $TERM->register_package ($_) for @pkg;
1004 }
1005
560 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 1006 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
561 if ($_ eq "default") { 1007 if ($_ eq "default") {
562 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 1008 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
563 } elsif (/^-(.*)$/) { 1009 } elsif (/^-(.*)$/) {
564 delete $ext_arg{$1}; 1010 delete $ext_arg{$1};
565 } elsif (/^([^<]+)<(.*)>$/) { 1011 } elsif (/^([^<]+)<(.*)>$/) {
566 push @{ $ext_arg{$1} }, $2; 1012 push @{ $ext_arg{$1} }, $2;
567 } else { 1013 } else {
568 $ext_arg{$_} ||= []; 1014 $ext_arg{$_} ||= [];
569 } 1015 }
570 } 1016 }
571 1017
572 while (my ($ext, $argv) = each %ext_arg) { 1018 for my $ext (sort keys %ext_arg) {
573 my @files = grep -f $_, map "$_/$ext", @dirs; 1019 my @files = grep -f $_, map "$_/$ext", @dirs;
574 1020
575 if (@files) { 1021 if (@files) {
576 $TERM->register_package (extension_package $files[0], $argv); 1022 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
577 } else { 1023 } else {
578 warn "perl extension '$ext' not found in perl library search path\n"; 1024 warn "perl extension '$ext' not found in perl library search path\n";
579 } 1025 }
580 } 1026 }
581 1027
587 1033
588 if (my $cb = $TERM->{_hook}[$htype]) { 1034 if (my $cb = $TERM->{_hook}[$htype]) {
589 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 1035 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
590 if $verbosity >= 10; 1036 if $verbosity >= 10;
591 1037
592 keys %$cb; 1038 for my $pkg (keys %$cb) {
593
594 while (my ($pkg, $cb) = each %$cb) {
595 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 1039 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
596 and last; 1040 $retval ||= $retval_;
597 1041
598 if ($@) { 1042 if ($@) {
599 $TERM->ungrab; # better to lose the grab than the session 1043 $TERM->ungrab; # better to lose the grab than the session
600 warn $@; 1044 warn $@;
601 } 1045 }
602 } 1046 }
1047
1048 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1049 if $verbosity >= 11;
603 } 1050 }
604 1051
605 if ($htype == 1) { # DESTROY 1052 if ($htype == 1) { # DESTROY
606 if (my $hook = delete $TERM->{_hook}) {
607 for my $htype (0..$#$hook) {
608 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
609 or set_should_invoke $htype, 0;
610 }
611 }
612
613 # clear package objects 1053 # clear package objects
614 %$_ = () for values %{ $TERM->{_pkg} }; 1054 %$_ = () for values %{ $TERM->{_pkg} };
615 1055
616 # clear package 1056 # clear package
617 %$TERM = (); 1057 %$TERM = ();
618 } 1058 }
619 1059
620 $retval 1060 $retval
1061}
1062
1063sub SET_COLOR($$$) {
1064 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
1065}
1066
1067sub rend2mask {
1068 no strict 'refs';
1069 my ($str, $mask) = (@_, 0);
1070 my %color = ( fg => undef, bg => undef );
1071 my @failed;
1072 for my $spec ( split /\s+/, $str ) {
1073 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
1074 $color{lc($1)} = $2;
1075 } else {
1076 my $neg = $spec =~ s/^[-^]//;
1077 unless ( exists &{"RS_$spec"} ) {
1078 push @failed, $spec;
1079 next;
1080 }
1081 my $cur = &{"RS_$spec"};
1082 if ( $neg ) {
1083 $mask &= ~$cur;
1084 } else {
1085 $mask |= $cur;
1086 }
1087 }
1088 }
1089 ($mask, @color{qw(fg bg)}, \@failed)
621} 1090}
622 1091
623# urxvt::term::extension 1092# urxvt::term::extension
624 1093
625package urxvt::term::extension; 1094package urxvt::term::extension;
631 while (my ($name, $cb) = each %hook) { 1100 while (my ($name, $cb) = each %hook) {
632 my $htype = $HOOKTYPE{uc $name}; 1101 my $htype = $HOOKTYPE{uc $name};
633 defined $htype 1102 defined $htype
634 or Carp::croak "unsupported hook type '$name'"; 1103 or Carp::croak "unsupported hook type '$name'";
635 1104
1105 $self->set_should_invoke ($htype, +1)
636 unless (exists $self->{term}{_hook}[$htype]{$pkg}) { 1106 unless exists $self->{term}{_hook}[$htype]{$pkg};
637 $hook_count[$htype]++
638 or urxvt::set_should_invoke $htype, 1;
639 }
640 1107
641 $self->{term}{_hook}[$htype]{$pkg} = $cb; 1108 $self->{term}{_hook}[$htype]{$pkg} = $cb;
642 } 1109 }
643} 1110}
644 1111
649 for my $name (@hook) { 1116 for my $name (@hook) {
650 my $htype = $HOOKTYPE{uc $name}; 1117 my $htype = $HOOKTYPE{uc $name};
651 defined $htype 1118 defined $htype
652 or Carp::croak "unsupported hook type '$name'"; 1119 or Carp::croak "unsupported hook type '$name'";
653 1120
1121 $self->set_should_invoke ($htype, -1)
654 if (delete $self->{term}{_hook}[$htype]{$pkg}) { 1122 if delete $self->{term}{_hook}[$htype]{$pkg};
655 --$hook_count[$htype]
656 or urxvt::set_should_invoke $htype, 0;
657 }
658 } 1123 }
659} 1124}
660 1125
661our $AUTOLOAD; 1126our $AUTOLOAD;
662 1127
700is that you cannot use blocking APIs, but the non-blocking variant should 1165is that you cannot use blocking APIs, but the non-blocking variant should
701work. 1166work.
702 1167
703=cut 1168=cut
704 1169
705our $VERSION = 1; 1170our $VERSION = '5.23';
706 1171
707$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1172$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
708push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1173push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
709 1174
710sub timer { 1175sub timer {
712 1177
713 my $cb = $arg{cb}; 1178 my $cb = $arg{cb};
714 1179
715 urxvt::timer 1180 urxvt::timer
716 ->new 1181 ->new
717 ->start (urxvt::NOW + $arg{after}) 1182 ->after ($arg{after}, $arg{interval})
718 ->cb (sub { 1183 ->cb ($arg{interval} ? $cb : sub {
719 $_[0]->stop; # need to cancel manually 1184 $_[0]->stop; # need to cancel manually
720 $cb->(); 1185 $cb->();
721 }) 1186 })
722} 1187}
723 1188
724sub io { 1189sub io {
725 my ($class, %arg) = @_; 1190 my ($class, %arg) = @_;
726 1191
727 my $cb = $arg{cb}; 1192 my $cb = $arg{cb};
1193 my $fd = fileno $arg{fh};
1194 defined $fd or $fd = $arg{fh};
728 1195
729 bless [$arg{fh}, urxvt::iow 1196 bless [$arg{fh}, urxvt::iow
730 ->new 1197 ->new
731 ->fd (fileno $arg{fh}) 1198 ->fd ($fd)
732 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1199 ->events (($arg{poll} =~ /r/ ? 1 : 0)
733 | ($arg{poll} =~ /w/ ? 2 : 0)) 1200 | ($arg{poll} =~ /w/ ? 2 : 0))
734 ->start 1201 ->start
735 ->cb (sub { 1202 ->cb ($cb)
736 $cb->(($_[1] & 1 ? 'r' : '')
737 . ($_[1] & 2 ? 'w' : ''));
738 })],
739 urxvt::anyevent:: 1203 ], urxvt::anyevent::
1204}
1205
1206sub idle {
1207 my ($class, %arg) = @_;
1208
1209 my $cb = $arg{cb};
1210
1211 urxvt::iw
1212 ->new
1213 ->start
1214 ->cb ($cb)
1215}
1216
1217sub child {
1218 my ($class, %arg) = @_;
1219
1220 my $cb = $arg{cb};
1221
1222 urxvt::pw
1223 ->new
1224 ->start ($arg{pid})
1225 ->cb (sub {
1226 $_[0]->stop; # need to cancel manually
1227 $cb->($_[0]->rpid, $_[0]->rstatus);
1228 })
740} 1229}
741 1230
742sub DESTROY { 1231sub DESTROY {
743 $_[0][1]->stop; 1232 $_[0][1]->stop;
744} 1233}
745 1234
746sub condvar { 1235# only needed for AnyEvent < 6 compatibility
747 bless \my $flag, urxvt::anyevent::condvar:: 1236sub one_event {
748}
749
750sub urxvt::anyevent::condvar::broadcast {
751 ${$_[0]}++;
752}
753
754sub urxvt::anyevent::condvar::wait {
755 unless (${$_[0]}) {
756 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"; 1237 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
757 }
758} 1238}
759 1239
760package urxvt::term; 1240package urxvt::term;
761 1241
762=head2 The C<urxvt::term> Class 1242=head2 The C<urxvt::term> Class
767 1247
768# find on_xxx subs in the package and register them 1248# find on_xxx subs in the package and register them
769# as hooks 1249# as hooks
770sub register_package { 1250sub register_package {
771 my ($self, $pkg, $argv) = @_; 1251 my ($self, $pkg, $argv) = @_;
1252
1253 no strict 'refs';
1254
1255 urxvt::verbose 6, "register package $pkg to $self";
1256
1257 @{"$pkg\::ISA"} = urxvt::term::extension::;
772 1258
773 my $proxy = bless { 1259 my $proxy = bless {
774 _pkg => $pkg, 1260 _pkg => $pkg,
775 argv => $argv, 1261 argv => $argv,
776 }, $pkg; 1262 }, $pkg;
783 $proxy->enable ($name => $ref); 1269 $proxy->enable ($name => $ref);
784 } 1270 }
785 } 1271 }
786} 1272}
787 1273
1274=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1275
1276Creates a new terminal, very similar as if you had started it with system
1277C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1278hash which defines the environment of the new terminal.
1279
1280Croaks (and probably outputs an error message) if the new instance
1281couldn't be created. Returns C<undef> if the new instance didn't
1282initialise perl, and the terminal object otherwise. The C<init> and
1283C<start> hooks will be called before this call returns, and are free to
1284refer to global data (which is race free).
1285
1286=cut
1287
1288sub new {
1289 my ($class, $env, @args) = @_;
1290
1291 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1292 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1293
1294 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1295}
1296
788=item $term->destroy 1297=item $term->destroy
789 1298
790Destroy the terminal object (close the window, free resources 1299Destroy the terminal object (close the window, free resources
791etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1300etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
792watchers (timers, io watchers) are still active. 1301watchers (timers, io watchers) are still active.
793 1302
1303=item $term->exec_async ($cmd[, @args])
1304
1305Works like the combination of the C<fork>/C<exec> builtins, which executes
1306("starts") programs in the background. This function takes care of setting
1307the user environment before exec'ing the command (e.g. C<PATH>) and should
1308be preferred over explicit calls to C<exec> or C<system>.
1309
1310Returns the pid of the subprocess or C<undef> on error.
1311
1312=cut
1313
1314sub exec_async {
1315 my $self = shift;
1316
1317 my $pid = fork;
1318
1319 return $pid
1320 if !defined $pid or $pid;
1321
1322 %ENV = %{ $self->env };
1323
1324 exec @_;
1325 urxvt::_exit 255;
1326}
1327
794=item $isset = $term->option ($optval[, $set]) 1328=item $isset = $term->option ($optval[, $set])
795 1329
796Returns true if the option specified by C<$optval> is enabled, and 1330Returns true if the option specified by C<$optval> is enabled, and
797optionally change it. All option values are stored by name in the hash 1331optionally change it. All option values are stored by name in the hash
798C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1332C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
799 1333
800Here is a a likely non-exhaustive list of option names, please see the 1334Here is a likely non-exhaustive list of option names, please see the
801source file F</src/optinc.h> to see the actual list: 1335source file F</src/optinc.h> to see the actual list:
802 1336
803 borderLess console cursorBlink cursorUnderline hold iconic insecure 1337 borderLess buffered console cursorBlink cursorUnderline hold iconic
804 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1338 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1339 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
805 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1340 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
806 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1341 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
807 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1342 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
808 tripleclickwords utmpInhibit visualBell 1343 urgentOnBell utmpInhibit visualBell
809 1344
810=item $value = $term->resource ($name[, $newval]) 1345=item $value = $term->resource ($name[, $newval])
811 1346
812Returns the current resource value associated with a given name and 1347Returns the current resource value associated with a given name and
813optionally sets a new value. Setting values is most useful in the C<init> 1348optionally sets a new value. Setting values is most useful in the C<init>
822likely change). 1357likely change).
823 1358
824Please note that resource strings will currently only be freed when the 1359Please note that resource strings will currently only be freed when the
825terminal is destroyed, so changing options frequently will eat memory. 1360terminal is destroyed, so changing options frequently will eat memory.
826 1361
827Here is a a likely non-exhaustive list of resource names, not all of which 1362Here is a likely non-exhaustive list of resource names, not all of which
828are supported in every build, please see the source file F</src/rsinc.h> 1363are supported in every build, please see the source file F</src/rsinc.h>
829to see the actual list: 1364to see the actual list:
830 1365
831 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1366 answerbackstring backgroundPixmap backspace_key blendtype blurradius
832 borderLess color cursorBlink cursorUnderline cutchars delete_key 1367 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
833 display_name embed ext_bwidth fade font geometry hold iconName 1368 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
834 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1369 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1370 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
835 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1371 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
836 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1372 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
837 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1373 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
838 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1374 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
839 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1375 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
840 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1376 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
841 shade term_name title transparent transparent_all tripleclickwords 1377 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1378 term_name title transient_for transparent tripleclickwords urgentOnBell
842 utmpInhibit visualBell 1379 utmpInhibit visualBell
843 1380
844=cut 1381=cut
845 1382
846sub resource($$;$) { 1383sub resource($$;$) {
847 my ($self, $name) = (shift, shift); 1384 my ($self, $name) = (shift, shift);
848 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1385 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
849 &urxvt::term::_resource 1386 goto &urxvt::term::_resource
850} 1387}
851 1388
852=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1389=item $value = $term->x_resource ($pattern)
853 1390
1391Returns the X-Resource for the given pattern, excluding the program or
1392class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1393same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1394resource with that pattern exists.
1395
1396This method should only be called during the C<on_start> hook, as there is
1397only one resource database per display, and later invocations might return
1398the wrong resources.
1399
1400=item $success = $term->parse_keysym ($key, $octets)
1401
854Adds a keymap translation exactly as specified via a resource. See the 1402Adds a key binding exactly as specified via a resource. See the
855C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1403C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1404
1405=item $term->register_command ($keysym, $modifiermask, $string)
1406
1407Adds a key binding. This is a lower level api compared to
1408C<parse_keysym>, as it expects a parsed key description, and can be
1409used only inside either the C<on_init> hook, to add a binding, or the
1410C<on_register_command> hook, to modify a parsed binding.
856 1411
857=item $rend = $term->rstyle ([$new_rstyle]) 1412=item $rend = $term->rstyle ([$new_rstyle])
858 1413
859Return and optionally change the current rendition. Text that is output by 1414Return and optionally change the current rendition. Text that is output by
860the terminal application will use this style. 1415the terminal application will use this style.
868 1423
869=item ($row, $col) = $term->selection_beg ([$row, $col]) 1424=item ($row, $col) = $term->selection_beg ([$row, $col])
870 1425
871=item ($row, $col) = $term->selection_end ([$row, $col]) 1426=item ($row, $col) = $term->selection_end ([$row, $col])
872 1427
873Return the current values of the selection mark, begin or end positions, 1428Return the current values of the selection mark, begin or end positions.
874and optionally set them to new values.
875 1429
1430When arguments are given, then the selection coordinates are set to
1431C<$row> and C<$col>, and the selection screen is set to the current
1432screen.
1433
1434=item $screen = $term->selection_screen ([$screen])
1435
1436Returns the current selection screen, and then optionally sets it.
1437
1438=item $term->selection_make ($eventtime[, $rectangular])
1439
1440Tries to make a selection as set by C<selection_beg> and
1441C<selection_end>. If C<$rectangular> is true (default: false), a
1442rectangular selection will be made. This is the preferred function to make
1443a selection.
1444
876=item $success = $term->selection_grab ($eventtime) 1445=item $success = $term->selection_grab ($eventtime[, $clipboard])
877 1446
878Try to request the primary selection from the server (for example, as set 1447Try to acquire ownership of the primary (clipboard if C<$clipboard> is
879by the next method). 1448true) selection from the server. The corresponding text can be set
1449with the next method. No visual feedback will be given. This function
1450is mostly useful from within C<on_sel_grab> hooks.
880 1451
881=item $oldtext = $term->selection ([$newtext]) 1452=item $oldtext = $term->selection ([$newtext, $clipboard])
882 1453
883Return the current selection text and optionally replace it by C<$newtext>. 1454Return the current selection (clipboard if C<$clipboard> is true) text
1455and optionally replace it by C<$newtext>.
1456
1457=item $term->selection_clear ([$clipboard])
1458
1459Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
884 1460
885=item $term->overlay_simple ($x, $y, $text) 1461=item $term->overlay_simple ($x, $y, $text)
886 1462
887Create a simple multi-line overlay box. See the next method for details. 1463Create a simple multi-line overlay box. See the next method for details.
888 1464
918 1494
919The methods currently supported on C<urxvt::overlay> objects are: 1495The methods currently supported on C<urxvt::overlay> objects are:
920 1496
921=over 4 1497=over 4
922 1498
923=item $overlay->set ($x, $y, $text, $rend) 1499=item $overlay->set ($x, $y, $text[, $rend])
924 1500
925Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1501Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
926text in rxvt-unicode's special encoding and an array of rendition values 1502text in rxvt-unicode's special encoding and an array of rendition values
927at a specific position inside the overlay. 1503at a specific position inside the overlay.
1504
1505If C<$rend> is missing, then the rendition will not be changed.
928 1506
929=item $overlay->hide 1507=item $overlay->hide
930 1508
931If visible, hide the overlay, but do not destroy it. 1509If visible, hide the overlay, but do not destroy it.
932 1510
977Convert the given locale-encoded octets into a perl string. 1555Convert the given locale-encoded octets into a perl string.
978 1556
979=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1557=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
980 1558
981XORs the rendition values in the given span with the provided value 1559XORs the rendition values in the given span with the provided value
982(default: C<RS_RVid>). Useful in refresh hooks to provide effects similar 1560(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
983to the selection. 1561refresh hooks to provide effects similar to the selection.
984 1562
985=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]]) 1563=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
986 1564
987Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing 1565Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
988whitespace will additionally be xored with the C<$rstyle2>, which defaults 1566whitespace will additionally be xored with the C<$rstyle2>, which defaults
989to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines 1567to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
990it instead. 1568it instead. Both styles I<MUST NOT> contain font styles.
991 1569
992=item $term->scr_bell 1570=item $term->scr_bell
993 1571
994Ring the bell! 1572Ring the bell!
995 1573
1002 1580
1003Normally its not a good idea to use this function, as programs might be 1581Normally its not a good idea to use this function, as programs might be
1004confused by changes in cursor position or scrolling. Its useful inside a 1582confused by changes in cursor position or scrolling. Its useful inside a
1005C<on_add_lines> hook, though. 1583C<on_add_lines> hook, though.
1006 1584
1585=item $term->scr_change_screen ($screen)
1586
1587Switch to given screen - 0 primary, 1 secondary.
1588
1007=item $term->cmd_parse ($octets) 1589=item $term->cmd_parse ($octets)
1008 1590
1009Similar to C<scr_add_lines>, but the argument must be in the 1591Similar to C<scr_add_lines>, but the argument must be in the
1010locale-specific encoding of the terminal and can contain command sequences 1592locale-specific encoding of the terminal and can contain command sequences
1011(escape codes) that will be interpreted. 1593(escape codes) that will be interpreted.
1012 1594
1013=item $term->tt_write ($octets) 1595=item $term->tt_write ($octets)
1014 1596
1015Write the octets given in C<$data> to the tty (i.e. as program input). To 1597Write the octets given in C<$octets> to the tty (i.e. as program input). To
1016pass characters instead of octets, you should convert your strings first 1598pass characters instead of octets, you should convert your strings first
1017to the locale-specific encoding using C<< $term->locale_encode >>. 1599to the locale-specific encoding using C<< $term->locale_encode >>.
1600
1601=item $term->tt_paste ($octets)
1602
1603Write the octets given in C<$octets> to the tty as a paste, converting NL to
1604CR and bracketing the data with control sequences if bracketed paste mode
1605is set.
1018 1606
1019=item $old_events = $term->pty_ev_events ([$new_events]) 1607=item $old_events = $term->pty_ev_events ([$new_events])
1020 1608
1021Replaces the event mask of the pty watcher by the given event mask. Can 1609Replaces the event mask of the pty watcher by the given event mask. Can
1022be used to suppress input and output handling to the pty/tty. See the 1610be used to suppress input and output handling to the pty/tty. See the
1023description of C<< urxvt::timer->events >>. Make sure to always restore 1611description of C<< urxvt::timer->events >>. Make sure to always restore
1024the previous value. 1612the previous value.
1025 1613
1614=item $fd = $term->pty_fd
1615
1616Returns the master file descriptor for the pty in use, or C<-1> if no pty
1617is used.
1618
1026=item $windowid = $term->parent 1619=item $windowid = $term->parent
1027 1620
1028Return the window id of the toplevel window. 1621Return the window id of the toplevel window.
1029 1622
1030=item $windowid = $term->vt 1623=item $windowid = $term->vt
1031 1624
1032Return the window id of the terminal window. 1625Return the window id of the terminal window.
1033 1626
1627=item $term->vt_emask_add ($x_event_mask)
1628
1629Adds the specified events to the vt event mask. Useful e.g. when you want
1630to receive pointer events all the times:
1631
1632 $term->vt_emask_add (urxvt::PointerMotionMask);
1633
1634=item $term->focus_in
1635
1636=item $term->focus_out
1637
1638=item $term->key_press ($state, $keycode[, $time])
1639
1640=item $term->key_release ($state, $keycode[, $time])
1641
1642Deliver various fake events to to terminal.
1643
1034=item $window_width = $term->width 1644=item $window_width = $term->width
1035 1645
1036=item $window_height = $term->height 1646=item $window_height = $term->height
1037 1647
1038=item $font_width = $term->fwidth 1648=item $font_width = $term->fwidth
1051 1661
1052=item $max_scrollback = $term->saveLines 1662=item $max_scrollback = $term->saveLines
1053 1663
1054=item $nrow_plus_saveLines = $term->total_rows 1664=item $nrow_plus_saveLines = $term->total_rows
1055 1665
1056=item $lines_in_scrollback = $term->nsaved 1666=item $topmost_scrollback_row = $term->top_row
1057 1667
1058Return various integers describing terminal characteristics. 1668Return various integers describing terminal characteristics.
1059 1669
1670=item $x_display = $term->display_id
1671
1672Return the DISPLAY used by rxvt-unicode.
1673
1060=item $lc_ctype = $term->locale 1674=item $lc_ctype = $term->locale
1061 1675
1062Returns the LC_CTYPE category string used by this rxvt-unicode. 1676Returns the LC_CTYPE category string used by this rxvt-unicode.
1063 1677
1064=item $x_display = $term->display_id 1678=item $env = $term->env
1065 1679
1066Return the DISPLAY used by rxvt-unicode. 1680Returns a copy of the environment in effect for the terminal as a hashref
1681similar to C<\%ENV>.
1682
1683=item @envv = $term->envv
1684
1685Returns the environment as array of strings of the form C<VAR=VALUE>.
1686
1687=item @argv = $term->argv
1688
1689Return the argument vector as this terminal, similar to @ARGV, but
1690includes the program name as first element.
1691
1692=cut
1693
1694sub env {
1695 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1696}
1067 1697
1068=item $modifiermask = $term->ModLevel3Mask 1698=item $modifiermask = $term->ModLevel3Mask
1069 1699
1070=item $modifiermask = $term->ModMetaMask 1700=item $modifiermask = $term->ModMetaMask
1071 1701
1072=item $modifiermask = $term->ModNumLockMask 1702=item $modifiermask = $term->ModNumLockMask
1073 1703
1074Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1704Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1075AltGr), the meta key (often Alt) and the num lock key, if applicable. 1705AltGr), the meta key (often Alt) and the num lock key, if applicable.
1076 1706
1707=item $screen = $term->current_screen
1708
1709Returns the currently displayed screen (0 primary, 1 secondary).
1710
1711=item $cursor_is_hidden = $term->hidden_cursor
1712
1713Returns whether the cursor is currently hidden or not.
1714
1077=item $view_start = $term->view_start ([$newvalue]) 1715=item $view_start = $term->view_start ([$newvalue])
1078 1716
1079Returns the negative row number of the topmost line. Minimum value is 1717Returns the row number of the topmost displayed line. Maximum value is
1080C<0>, which displays the normal terminal contents. Larger values scroll 1718C<0>, which displays the normal terminal contents. Lower values scroll
1081this many lines into the scrollback buffer. 1719this many lines into the scrollback buffer.
1082 1720
1083=item $term->want_refresh 1721=item $term->want_refresh
1084 1722
1085Requests a screen refresh. At the next opportunity, rxvt-unicode will 1723Requests a screen refresh. At the next opportunity, rxvt-unicode will
1088 1726
1089Used after changing terminal contents to display them. 1727Used after changing terminal contents to display them.
1090 1728
1091=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1729=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1092 1730
1093Returns the text of the entire row with number C<$row_number>. Row C<0> 1731Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1094is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1732is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1095terminal line. The scrollback buffer starts at line C<-1> and extends to
1096line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1733terminal line. Nothing will be returned if a nonexistent line
1097is requested. 1734is requested.
1098 1735
1099If C<$new_text> is specified, it will replace characters in the current 1736If C<$new_text> is specified, it will replace characters in the current
1100line, starting at column C<$start_col> (default C<0>), which is useful 1737line, starting at column C<$start_col> (default C<0>), which is useful
1101to replace only parts of a line. The font index in the rendition will 1738to replace only parts of a line. The font index in the rendition will
1102automatically be updated. 1739automatically be updated.
1103 1740
1104C<$text> is in a special encoding: tabs and wide characters that use more 1741C<$text> is in a special encoding: tabs and wide characters that use more
1105than one cell when displayed are padded with urxvt::NOCHAR characters 1742than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1106(C<chr 65535>). Characters with combining characters and other characters 1743characters. Characters with combining characters and other characters that
1107that do not fit into the normal tetx encoding will be replaced with 1744do not fit into the normal text encoding will be replaced with characters
1108characters in the private use area. 1745in the private use area.
1109 1746
1110You have to obey this encoding when changing text. The advantage is 1747You have to obey this encoding when changing text. The advantage is
1111that C<substr> and similar functions work on screen cells and not on 1748that C<substr> and similar functions work on screen cells and not on
1112characters. 1749characters.
1113 1750
1164Return the row number of the first/last row of the line, respectively. 1801Return the row number of the first/last row of the line, respectively.
1165 1802
1166=item $offset = $line->offset_of ($row, $col) 1803=item $offset = $line->offset_of ($row, $col)
1167 1804
1168Returns the character offset of the given row|col pair within the logical 1805Returns the character offset of the given row|col pair within the logical
1169line. 1806line. Works for rows outside the line, too, and returns corresponding
1807offsets outside the string.
1170 1808
1171=item ($row, $col) = $line->coord_of ($offset) 1809=item ($row, $col) = $line->coord_of ($offset)
1172 1810
1173Translates a string offset into terminal coordinates again. 1811Translates a string offset into terminal coordinates again.
1174 1812
1256where one character corresponds to one screen cell. See 1894where one character corresponds to one screen cell. See
1257C<< $term->ROW_t >> for details. 1895C<< $term->ROW_t >> for details.
1258 1896
1259=item $string = $term->special_decode $text 1897=item $string = $term->special_decode $text
1260 1898
1261Converts rxvt-unicodes text reprsentation into a perl string. See 1899Converts rxvt-unicodes text representation into a perl string. See
1262C<< $term->ROW_t >> for details. 1900C<< $term->ROW_t >> for details.
1263 1901
1264=item $success = $term->grab_button ($button, $modifiermask) 1902=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1265 1903
1904=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1905
1266Registers a synchronous button grab. See the XGrabButton manpage. 1906Register/unregister a synchronous button grab. See the XGrabButton
1907manpage.
1267 1908
1268=item $success = $term->grab ($eventtime[, $sync]) 1909=item $success = $term->grab ($eventtime[, $sync])
1269 1910
1270Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1911Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1271synchronous (C<$sync> is true). Also remembers the grab timestampe. 1912synchronous (C<$sync> is true). Also remembers the grab timestamp.
1272 1913
1273=item $term->allow_events_async 1914=item $term->allow_events_async
1274 1915
1275Calls XAllowEvents with AsyncBoth for the most recent grab. 1916Calls XAllowEvents with AsyncBoth for the most recent grab.
1276 1917
1283Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1924Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1284recent grab. 1925recent grab.
1285 1926
1286=item $term->ungrab 1927=item $term->ungrab
1287 1928
1288Calls XUngrab for the most recent grab. Is called automatically on 1929Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1289evaluation errors, as it is better to lose the grab in the error case as 1930evaluation errors, as it is better to lose the grab in the error case as
1290the session. 1931the session.
1932
1933=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1934
1935=item $atom_name = $term->XGetAtomName ($atom)
1936
1937=item @atoms = $term->XListProperties ($window)
1938
1939=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1940
1941=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1942
1943=item $term->XDeleteProperty ($window, $property)
1944
1945=item $window = $term->DefaultRootWindow
1946
1947=item $term->XReparentWindow ($window, $parent, [$x, $y])
1948
1949=item $term->XMapWindow ($window)
1950
1951=item $term->XUnmapWindow ($window)
1952
1953=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1954
1955=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1956
1957=item $term->XChangeInput ($window, $add_events[, $del_events])
1958
1959=item $keysym = $term->XStringToKeysym ($string)
1960
1961=item $string = $term->XKeysymToString ($keysym)
1962
1963Various X or X-related functions. The C<$term> object only serves as
1964the source of the display, otherwise those functions map more-or-less
1965directly onto the X functions of the same name.
1291 1966
1292=back 1967=back
1293 1968
1294=cut 1969=cut
1295 1970
1359 my ($self, $text, $cb) = @_; 2034 my ($self, $text, $cb) = @_;
1360 2035
1361 $self->add_item ({ type => "button", text => $text, activate => $cb}); 2036 $self->add_item ({ type => "button", text => $text, activate => $cb});
1362} 2037}
1363 2038
1364=item $popup->add_toggle ($text, $cb, $initial_value) 2039=item $popup->add_toggle ($text, $initial_value, $cb)
1365 2040
1366Adds a toggle/checkbox item to the popup. Teh callback gets called 2041Adds a toggle/checkbox item to the popup. The callback gets called
1367whenever it gets toggled, with a boolean indicating its value as its first 2042whenever it gets toggled, with a boolean indicating its new value as its
1368argument. 2043first argument.
1369 2044
1370=cut 2045=cut
1371 2046
1372sub add_toggle { 2047sub add_toggle {
1373 my ($self, $text, $cb, $value) = @_; 2048 my ($self, $text, $value, $cb) = @_;
1374 2049
1375 my $item; $item = { 2050 my $item; $item = {
1376 type => "button", 2051 type => "button",
1377 text => " $text", 2052 text => " $text",
1378 value => $value, 2053 value => $value,
1392sub show { 2067sub show {
1393 my ($self) = @_; 2068 my ($self) = @_;
1394 2069
1395 local $urxvt::popup::self = $self; 2070 local $urxvt::popup::self = $self;
1396 2071
2072 my $env = $self->{term}->env;
2073 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
2074 delete $env->{LC_ALL};
1397 local $ENV{LC_ALL} = $self->{term}->locale; 2075 $env->{LC_CTYPE} = $self->{term}->locale;
1398 2076
1399 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 2077 my $term = urxvt::term->new (
2078 $env, "popup",
2079 "--perl-lib" => "", "--perl-ext-common" => "",
2080 "-pty-fd" => -1, "-sl" => 0,
2081 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1400 "--transient-for" => $self->{term}->parent, 2082 "--transient-for" => $self->{term}->parent,
1401 "-display" => $self->{term}->display_id, 2083 "-display" => $self->{term}->display_id,
1402 "-pe" => "urxvt-popup") 2084 "-pe" => "urxvt-popup",
1403 or die "unable to create popup window\n"; 2085 ) or die "unable to create popup window\n";
2086
2087 unless (delete $term->{urxvt_popup_init_done}) {
2088 $term->ungrab;
2089 $term->destroy;
2090 die "unable to initialise popup window\n";
2091 }
1404} 2092}
1405 2093
1406sub DESTROY { 2094sub DESTROY {
1407 my ($self) = @_; 2095 my ($self) = @_;
1408 2096
1409 delete $self->{term}{_destroy}{$self}; 2097 delete $self->{term}{_destroy}{$self};
1410 $self->{term}->ungrab; 2098 $self->{term}->ungrab;
1411} 2099}
2100
2101=back
2102
2103=cut
2104
2105package urxvt::watcher;
1412 2106
1413=head2 The C<urxvt::timer> Class 2107=head2 The C<urxvt::timer> Class
1414 2108
1415This class implements timer watchers/events. Time is represented as a 2109This class implements timer watchers/events. Time is represented as a
1416fractional number of seconds since the epoch. Example: 2110fractional number of seconds since the epoch. Example:
1420 ->new 2114 ->new
1421 ->interval (1) 2115 ->interval (1)
1422 ->cb (sub { 2116 ->cb (sub {
1423 $term->{overlay}->set (0, 0, 2117 $term->{overlay}->set (0, 0,
1424 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2118 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1425 }); 2119 });
1426 2120
1427=over 4 2121=over 4
1428 2122
1429=item $timer = new urxvt::timer 2123=item $timer = new urxvt::timer
1430 2124
1433 2127
1434=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2128=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1435 2129
1436Set the callback to be called when the timer triggers. 2130Set the callback to be called when the timer triggers.
1437 2131
1438=item $tstamp = $timer->at
1439
1440Return the time this watcher will fire next.
1441
1442=item $timer = $timer->set ($tstamp) 2132=item $timer = $timer->set ($tstamp[, $interval])
1443 2133
1444Set the time the event is generated to $tstamp. 2134Set the time the event is generated to $tstamp (and optionally specifies a
2135new $interval).
1445 2136
1446=item $timer = $timer->interval ($interval) 2137=item $timer = $timer->interval ($interval)
1447 2138
1448Normally (and when C<$interval> is C<0>), the timer will automatically 2139By default (and when C<$interval> is C<0>), the timer will automatically
1449stop after it has fired once. If C<$interval> is non-zero, then the timer 2140stop after it has fired once. If C<$interval> is non-zero, then the timer
1450is automatically rescheduled at the given intervals. 2141is automatically rescheduled at the given intervals.
1451 2142
1452=item $timer = $timer->start 2143=item $timer = $timer->start
1453 2144
1454Start the timer. 2145Start the timer.
1455 2146
1456=item $timer = $timer->start ($tstamp) 2147=item $timer = $timer->start ($tstamp[, $interval])
1457 2148
1458Set the event trigger time to C<$tstamp> and start the timer. 2149Set the event trigger time to C<$tstamp> and start the timer. Optionally
2150also replaces the interval.
2151
2152=item $timer = $timer->after ($delay[, $interval])
2153
2154Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1459 2155
1460=item $timer = $timer->stop 2156=item $timer = $timer->stop
1461 2157
1462Stop the timer. 2158Stop the timer.
1463 2159
1469 2165
1470 $term->{socket} = ... 2166 $term->{socket} = ...
1471 $term->{iow} = urxvt::iow 2167 $term->{iow} = urxvt::iow
1472 ->new 2168 ->new
1473 ->fd (fileno $term->{socket}) 2169 ->fd (fileno $term->{socket})
1474 ->events (urxvt::EVENT_READ) 2170 ->events (urxvt::EV_READ)
1475 ->start 2171 ->start
1476 ->cb (sub { 2172 ->cb (sub {
1477 my ($iow, $revents) = @_; 2173 my ($iow, $revents) = @_;
1478 # $revents must be 1 here, no need to check 2174 # $revents must be 1 here, no need to check
1479 sysread $term->{socket}, my $buf, 8192 2175 sysread $term->{socket}, my $buf, 8192
1492Set the callback to be called when io events are triggered. C<$reventmask> 2188Set the callback to be called when io events are triggered. C<$reventmask>
1493is a bitset as described in the C<events> method. 2189is a bitset as described in the C<events> method.
1494 2190
1495=item $iow = $iow->fd ($fd) 2191=item $iow = $iow->fd ($fd)
1496 2192
1497Set the filedescriptor (not handle) to watch. 2193Set the file descriptor (not handle) to watch.
1498 2194
1499=item $iow = $iow->events ($eventmask) 2195=item $iow = $iow->events ($eventmask)
1500 2196
1501Set the event mask to watch. The only allowed values are 2197Set the event mask to watch. The only allowed values are
1502C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2198C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
1503together, or C<urxvt::EVENT_NONE>. 2199together, or C<urxvt::EV_NONE>.
1504 2200
1505=item $iow = $iow->start 2201=item $iow = $iow->start
1506 2202
1507Start watching for requested events on the given handle. 2203Start watching for requested events on the given handle.
1508 2204
1509=item $iow = $iow->stop 2205=item $iow = $iow->stop
1510 2206
1511Stop watching for events on the given filehandle. 2207Stop watching for events on the given file handle.
2208
2209=back
2210
2211=head2 The C<urxvt::iw> Class
2212
2213This class implements idle watchers, that get called automatically when
2214the process is idle. They should return as fast as possible, after doing
2215some useful work.
2216
2217=over 4
2218
2219=item $iw = new urxvt::iw
2220
2221Create a new idle watcher object in stopped state.
2222
2223=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2224
2225Set the callback to be called when the watcher triggers.
2226
2227=item $timer = $timer->start
2228
2229Start the watcher.
2230
2231=item $timer = $timer->stop
2232
2233Stop the watcher.
2234
2235=back
2236
2237=head2 The C<urxvt::pw> Class
2238
2239This class implements process watchers. They create an event whenever a
2240process exits, after which they stop automatically.
2241
2242 my $pid = fork;
2243 ...
2244 $term->{pw} = urxvt::pw
2245 ->new
2246 ->start ($pid)
2247 ->cb (sub {
2248 my ($pw, $exit_status) = @_;
2249 ...
2250 });
2251
2252=over 4
2253
2254=item $pw = new urxvt::pw
2255
2256Create a new process watcher in stopped state.
2257
2258=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2259
2260Set the callback to be called when the timer triggers.
2261
2262=item $pw = $timer->start ($pid)
2263
2264Tells the watcher to start watching for process C<$pid>.
2265
2266=item $pw = $pw->stop
2267
2268Stop the watcher.
1512 2269
1513=back 2270=back
1514 2271
1515=head1 ENVIRONMENT 2272=head1 ENVIRONMENT
1516 2273
1523 2280
1524=item == 0 - fatal messages 2281=item == 0 - fatal messages
1525 2282
1526=item >= 3 - script loading and management 2283=item >= 3 - script loading and management
1527 2284
1528=item >=10 - all events received 2285=item >=10 - all called hooks
2286
2287=item >=11 - hook return values
1529 2288
1530=back 2289=back
1531 2290
1532=head1 AUTHOR 2291=head1 AUTHOR
1533 2292
1534 Marc Lehmann <pcg@goof.com> 2293 Marc Lehmann <schmorp@schmorp.de>
1535 http://software.schmorp.de/pkg/rxvt-unicode 2294 http://software.schmorp.de/pkg/rxvt-unicode
1536 2295
1537=cut 2296=cut
1538 2297
15391 22981
2299
2300# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines