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.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.253 by sf-exg, Fri Jan 16 20:13:01 2015 UTC

1=encoding utf8 1=encoding utf8
2 2
3=head1 NAME 3=head1 NAME
4 4
5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5urxvtperl - rxvt-unicode's embedded perl interpreter
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 # create a file grab_test in $HOME: 9 # create a file grab_test in $HOME:
10 10
11 sub on_sel_grab { 11 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
13 () 13 ()
14 } 14 }
15 15
16 # start a @@RXVT_NAME@@ using it: 16 # start a urxvt using it:
17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 urxvt --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Every time 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 "vars"' 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 urxvtd, 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" 31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string. 32and "perl-ext-common" resources to the empty string.
33 33
34=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
35 35
36This section describes the extensions delivered with this release. You can 36A number of extensions are delivered with this release. You can find them
37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38F<< man urxvt-<EXTENSIONNAME> >>.
38 39
39You can activate them like this: 40You can activate them like this:
40 41
41 @@RXVT_NAME@@ -pe <extensionname> 42 urxvt -pe <extensionname>
42 43
43Or by adding them to the resource for extensions loaded by default: 44Or by adding them to the resource for extensions loaded by default:
44 45
45 URxvt.perl-ext-common: default,selection-autotransform 46 URxvt.perl-ext-common: default,selection-autotransform
46 47
47=over 4 48Extensions may add additional resources and C<actions>, i.e., methods
48 49which can be bound to a key and invoked by the user. An extension can
49=item selection (enabled by default) 50define the resources it support using so called META comments,
50 51described below. Similarly to builtin resources, extension resources
51(More) intelligent selection. This extension tries to be more intelligent 52can also be specified on the command line as long options (with C<.>
52when the user extends selections (double-click and further clicks). Right 53replaced by C<->), in which case the corresponding extension is loaded
53now, it tries to select words, urls and complete shell-quoted 54automatically. For this to work the extension B<must> define META
54arguments, which is very convenient, too, if your F<ls> supports 55comments for its resources.
55C<--quoting-style=shell>.
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
85This extension also offers following bindable keyboard commands:
86
87=over 4
88
89=item rot13
90
91Rot-13 the selection when activated. Used via keyboard trigger:
92
93 URxvt.keysym.C-M-r: perl:selection:rot13
94
95=back
96
97=item option-popup (enabled by default)
98
99Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100runtime.
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
119=item selection-popup (enabled by default)
120
121Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122text into various other formats/action (such as uri unescaping, perl
123evaluation, web-browser starting etc.), depending on content.
124
125Other extensions can extend this popup menu by pushing a code reference
126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127popup is being displayed.
128
129Its sole argument is the popup menu, which can be modified. The selection
130is in C<$_>, which can be used to decide whether to add something or not.
131It should either return nothing or a string and a code reference. The
132string will be used as button text and the code reference will be called
133when the button gets activated and should transform C<$_>.
134
135The following will add an entry C<a to b> that transforms all C<a>s in
136the selection to C<b>s, but only if the selection currently contains any
137C<a>s:
138
139 push @{ $self->{term}{selection_popup_hook} }, sub {
140 /a/ ? ("a to b" => sub { s/a/b/g }
141 : ()
142 };
143
144=item searchable-scrollback<hotkey> (enabled by default)
145
146Adds regex search functionality to the scrollback buffer, triggered
147by a hotkey (default: C<M-s>). While in search mode, normal terminal
148input/output is suspended and a regex is displayed at the bottom of the
149screen.
150
151Inputting characters appends them to the regex and continues incremental
152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153search upwards/downwards in the scrollback buffer, C<End> jumps to the
154bottom. C<Escape> leaves search mode and returns to the point where search
155was started, while C<Enter> or C<Return> stay at the current position and
156additionally stores the first match in the current line into the primary
157selection if the C<Shift> modifier is active.
158
159The regex defaults to "(?i)", resulting in a case-insensitive search. To
160get a case-sensitive search you can delete this prefix using C<BackSpace>
161or simply use an uppercase character which removes the "(?i)" prefix.
162
163See L<perlre> for more info about perl regular expression syntax.
164
165=item readline (enabled by default)
166
167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters).
172
173To avoid too many false positives, this is only done when:
174
175=over 4
176
177=item - the tty is in ICANON state.
178
179=item - the text cursor is visible.
180
181=item - the primary screen is currently being displayed.
182
183=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185=back
186
187The normal selection mechanism isn't disabled, so quick successive clicks
188might interfere with selection creation in harmless ways.
189
190=item selection-autotransform
191
192This selection allows you to do automatic transforms on a selection
193whenever a selection is made.
194
195It works by specifying perl snippets (most useful is a single C<s///>
196operator) that modify C<$_> as resources:
197
198 URxvt.selection-autotransform.0: transform
199 URxvt.selection-autotransform.1: transform
200 ...
201
202For example, the following will transform selections of the form
203C<filename:number>, often seen in compiler messages, into C<vi +$filename
204$word>:
205
206 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208And this example matches the same,but replaces it with vi-commands you can
209paste directly into your (vi :) editor:
210
211 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213Of course, this can be modified to suit your needs and your editor :)
214
215To expand the example above to typical perl error messages ("XXX at
216FILENAME line YYY."), you need a slightly more elaborate solution:
217
218 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221The first line tells the selection code to treat the unchanging part of
222every error message as a selection pattern, and the second line transforms
223the message into vi commands to load the file.
224
225=item tabbed
226
227This transforms the terminal into a tabbar with additional terminals, that
228is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230button per tab.
231
232Clicking a button will activate that tab. Pressing B<Shift-Left> and
233B<Shift-Right> will switch to the tab left or right of the current one,
234while B<Shift-Down> creates a new tab.
235
236The tabbar itself can be configured similarly to a normal terminal, but
237with a resource class of C<URxvt.tabbed>. In addition, it supports the
238following four resources (shown with defaults):
239
240 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242 URxvt.tabbed.tab-fg: <colour-index, default 0>
243 URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246indices.
247
248=item matcher
249
250Uses per-line display filtering (C<on_line_update>) to underline text
251matching a certain pattern and make it clickable. When clicked with the
252mouse button specified in the C<matcher.button> resource (default 2, or
253middle), the program specified in the C<matcher.launcher> resource
254(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255with the matched text as first argument. The default configuration is
256suitable for matching URLs and launching a web browser, like the
257former "mark-urls" extension.
258
259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis.
263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
267Example configuration:
268
269 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher
272 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1
276
277=item xim-onthespot
278
279This (experimental) perl extension implements OnTheSpot editing. It does
280not work perfectly, and some input methods don't seem to work well with
281OnTheSpot editing in general, but it seems to work at least for SCIM and
282kinput2.
283
284You enable it by specifying this extension and a preedit style of
285C<OnTheSpot>, i.e.:
286
287 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
288
289=item kuake<hotkey>
290
291A very primitive quake-console-like extension. It was inspired by a
292description of how the programs C<kuake> and C<yakuake> work: Whenever the
293user presses a global accelerator key (by default C<F10>), the terminal
294will show or hide itself. Another press of the accelerator key will hide
295or show it again.
296
297Initially, the window will not be shown when using this extension.
298
299This is useful if you need a single terminal that is not using any desktop
300space most of the time but is quickly available at the press of a key.
301
302The accelerator key is grabbed regardless of any modifiers, so this
303extension will actually grab a physical key just for this function.
304
305If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it).
307
308=item overlay-osc
309
310This extension implements some OSC commands to display timed popups on the
311screen - useful for status displays from within scripts. You have to read
312the sources for more info.
313
314=item block-graphics-to-ascii
315
316A not very useful example of filtering all text output to the terminal
317by replacing all line-drawing characters (U+2500 .. U+259F) by a
318similar-looking ascii character.
319
320=item digital-clock
321
322Displays a digital clock using the built-in overlay.
323
324=item remote-clipboard
325
326Somewhat of a misnomer, this extension adds two menu entries to the
327selection popup that allows one to run external commands to store the
328selection somewhere and fetch it again.
329
330We use it to implement a "distributed selection mechanism", which just
331means that one command uploads the file to a remote server, and another
332reads it.
333
334The commands can be set using the C<URxvt.remote-selection.store> and
335C<URxvt.remote-selection.fetch> resources. The first should read the
336selection to store from STDIN (always in UTF-8), the second should provide
337the selection data on STDOUT (also in UTF-8).
338
339The defaults (which are likely useless to you) use rsh and cat:
340
341 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343
344=item selection-pastebin
345
346This is a little rarely useful extension that Uploads the selection as
347textfile to a remote site (or does other things). (The implementation is
348not currently secure for use in a multiuser environment as it writes to
349F</tmp> directly.).
350
351It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
352i.e.
353
354 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
355
356Pressing this combination runs a command with C<%> replaced by the name of
357the textfile. This command can be set via a resource:
358
359 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
360
361And the default is likely not useful to anybody but the few people around
362here :)
363
364The name of the textfile is the hex encoded md5 sum of the selection, so
365the same content should lead to the same filename.
366
367After a successful upload the selection will be replaced by the text given
368in the C<selection-pastebin-url> resource (again, the % is the placeholder
369for the filename):
370
371 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372
373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374the double C</> characters as comment start. Use C<\057\057> instead,
375which works regardless of wether xrdb is used to parse the resource file
376or not.
377
378=item example-refresh-hooks
379
380Displays a very simple digital clock in the upper right corner of the
381window. Illustrates overwriting the refresh callbacks to create your own
382overlays or changes.
383
384=back
385 56
386=head1 API DOCUMENTATION 57=head1 API DOCUMENTATION
387 58
388=head2 General API Considerations 59=head2 General API Considerations
389 60
403 74
404=over 4 75=over 4
405 76
406=item $text 77=item $text
407 78
408Rxvt-unicodes special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
409always represents one screen cell. See L<ROW_t> for a discussion of this format. 80always represents one screen cell. See L<ROW_t> for a discussion of this format.
410 81
411=item $string 82=item $string
412 83
413A perl text string, with an emphasis on I<text>. It can store all unicode 84A perl text string, with an emphasis on I<text>. It can store all unicode
417=item $octets 88=item $octets
418 89
419Either binary data or - more common - a text string encoded in a 90Either binary data or - more common - a text string encoded in a
420locale-specific way. 91locale-specific way.
421 92
93=item $keysym
94
95an integer that is a valid X11 keysym code. You can convert a string
96into a keysym and viceversa by using C<XStringToKeysym> and
97C<XKeysymToString>.
98
422=back 99=back
423 100
424=head2 Extension Objects 101=head2 Extension Objects
425 102
426Every perl extension is a perl class. A separate perl object is created 103Every perl extension is a perl class. A separate perl object is created
427for each terminal, and each terminal has its own set of extenion objects, 104for each terminal, and each terminal has its own set of extension objects,
428which are passed as the first parameter to hooks. So extensions can use 105which are passed as the first parameter to hooks. So extensions can use
429their C<$self> object without having to think about clashes with other 106their C<$self> object without having to think about clashes with other
430extensions or other terminals, with the exception of methods and members 107extensions or other terminals, with the exception of methods and members
431that begin with an underscore character C<_>: these are reserved for 108that begin with an underscore character C<_>: these are reserved for
432internal use. 109internal use.
433 110
434Although it isn't a C<urxvt::term> object, you can call all methods of the 111Although it isn't a C<urxvt::term> object, you can call all methods of the
435C<urxvt::term> class on this object. 112C<urxvt::term> class on this object.
436 113
437It has the following methods and data members: 114Additional methods only supported for extension objects are described in
115the C<urxvt::extension> section below.
116
117=head2 META comments
118
119Rxvt-unicode recognizes special meta comments in extensions that define
120different types of metadata.
121
122Currently, it recognises only one such comment:
438 123
439=over 4 124=over 4
440 125
441=item $urxvt_term = $self->{term} 126=item #:META:RESOURCE:name:type:desc
442 127
443Returns the C<urxvt::term> object associated with this instance of the 128The RESOURCE comment defines a resource used by the extension, where
444extension. This member I<must not> be changed in any way. 129C<name> is the resource name, C<type> is the resource type, C<boolean>
445 130or C<string>, and C<desc> is the resource description.
446=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
447
448Dynamically enable the given hooks (named without the C<on_> prefix) for
449this extension, replacing any previous hook. This is useful when you want
450to overwrite time-critical hooks only temporarily.
451
452=item $self->disable ($hook_name[, $hook_name..])
453
454Dynamically disable the given hooks.
455 131
456=back 132=back
457 133
458=head2 Hooks 134=head2 Hooks
459 135
596=item on_tt_write $term, $octets 272=item on_tt_write $term, $octets
597 273
598Called whenever some data is written to the tty/pty and can be used to 274Called whenever some data is written to the tty/pty and can be used to
599suppress or filter tty input. 275suppress or filter tty input.
600 276
277=item on_tt_paste $term, $octets
278
279Called whenever text is about to be pasted, with the text as argument. You
280can filter/change and paste the text yourself by returning a true value
281and calling C<< $term->tt_paste >> yourself. C<$octets> is
282locale-encoded.
283
601=item on_line_update $term, $row 284=item on_line_update $term, $row
602 285
603Called whenever a line was updated or changed. Can be used to filter 286Called whenever a line was updated or changed. Can be used to filter
604screen output (e.g. underline urls or other useless stuff). Only lines 287screen output (e.g. underline urls or other useless stuff). Only lines
605that are being shown will be filtered, and, due to performance reasons, 288that are being shown will be filtered, and, due to performance reasons,
621 304
622=item on_refresh_end $term 305=item on_refresh_end $term
623 306
624Called just after the screen gets redrawn. See C<on_refresh_begin>. 307Called just after the screen gets redrawn. See C<on_refresh_begin>.
625 308
309=item on_action $term, $string
310
311Called whenever an action is invoked for the corresponding extension
312(e.g. via a C<extension:string> builtin action bound to a key, see
313description of the B<keysym> resource in the urxvt(1) manpage). The
314event is simply the action string. Note that an action event is always
315associated to a single extension.
316
626=item on_user_command $term, $string 317=item on_user_command $term, $string *DEPRECATED*
627 318
628Called whenever a user-configured event is being activated (e.g. via 319Called whenever a user-configured event is being activated (e.g. via
629a C<perl:string> action bound to a key, see description of the B<keysym> 320a C<perl:string> action bound to a key, see description of the B<keysym>
630resource in the @@RXVT_NAME@@(1) manpage). 321resource in the urxvt(1) manpage).
631 322
632The event is simply the action string. This interface is assumed to change 323The event is simply the action string. This interface is going away in
633slightly in the future. 324preference to the C<on_action> hook.
634 325
635=item on_resize_all_windows $tern, $new_width, $new_height 326=item on_resize_all_windows $term, $new_width, $new_height
636 327
637Called just after the new window size has been calculated, but before 328Called just after the new window size has been calculated, but before
638windows are actually being resized or hints are being set. If this hook 329windows are actually being resized or hints are being set. If this hook
639returns TRUE, setting of the window hints is being skipped. 330returns a true value, setting of the window hints is being skipped.
640 331
641=item on_x_event $term, $event 332=item on_x_event $term, $event
642 333
643Called on every X event received on the vt window (and possibly other 334Called on every X event received on the vt window (and possibly other
644windows). Should only be used as a last resort. Most event structure 335windows). Should only be used as a last resort. Most event structure
674 365
675=item on_map_notify $term, $event 366=item on_map_notify $term, $event
676 367
677=item on_unmap_notify $term, $event 368=item on_unmap_notify $term, $event
678 369
679Called whenever the corresponding X event is received for the terminal If 370Called whenever the corresponding X event is received for the terminal. If
680the hook returns true, then the even will be ignored by rxvt-unicode. 371the hook returns true, then the event will be ignored by rxvt-unicode.
681 372
682The event is a hash with most values as named by Xlib (see the XEvent 373The event is a hash with most values as named by Xlib (see the XEvent
683manpage), with the additional members C<row> and C<col>, which are the 374manpage), with the additional members C<row> and C<col>, which are the
684(real, not screen-based) row and column under the mouse cursor. 375(real, not screen-based) row and column under the mouse cursor.
685 376
686C<on_key_press> additionally receives the string rxvt-unicode would 377C<on_key_press> additionally receives the string rxvt-unicode would
687output, if any, in locale-specific encoding. 378output, if any, in locale-specific encoding.
688 379
689subwindow.
690
691=item on_client_message $term, $event 380=item on_client_message $term, $event
692 381
693=item on_wm_protocols $term, $event 382=item on_wm_protocols $term, $event
694 383
695=item on_wm_delete_window $term, $event 384=item on_wm_delete_window $term, $event
696 385
697Called when various types of ClientMessage events are received (all with 386Called when various types of ClientMessage events are received (all with
698format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 387format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
699 388
389=item on_bell $term
390
391Called on receipt of a bell character.
392
700=back 393=back
701 394
702=cut 395=cut
703 396
704package urxvt; 397package urxvt;
705 398
706use utf8; 399use utf8;
707use strict; 400use strict 'vars';
708use Carp (); 401use Carp ();
709use Scalar::Util (); 402use Scalar::Util ();
710use List::Util (); 403use List::Util ();
711 404
712our $VERSION = 1; 405our $VERSION = 1;
713our $TERM; 406our $TERM;
714our @TERM_INIT; 407our @TERM_INIT; # should go, prevents async I/O etc.
715our @TERM_EXT; 408our @TERM_EXT; # should go, prevents async I/O etc.
716our @HOOKNAME; 409our @HOOKNAME;
717our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 410our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
718our %OPTION; 411our %OPTION;
719 412
720our $LIBDIR; 413our $LIBDIR;
768 461
769=over 4 462=over 4
770 463
771=item urxvt::fatal $errormessage 464=item urxvt::fatal $errormessage
772 465
773Fatally aborts execution with the given error message. Avoid at all 466Fatally aborts execution with the given error message (which should
774costs! The only time this is acceptable is when the terminal process 467include a trailing newline). Avoid at all costs! The only time this
775starts up. 468is acceptable (and useful) is in the init hook, where it prevents the
469terminal from starting up.
776 470
777=item urxvt::warn $string 471=item urxvt::warn $string
778 472
779Calls C<rxvt_warn> with the given string which should not include a 473Calls C<rxvt_warn> with the given string which should include a trailing
780newline. The module also overwrites the C<warn> builtin with a function 474newline. The module also overwrites the C<warn> builtin with a function
781that calls this function. 475that calls this function.
782 476
783Using this function has the advantage that its output ends up in the 477Using this function has the advantage that its output ends up in the
784correct place, e.g. on stderr of the connecting urxvtc client. 478correct place, e.g. on stderr of the connecting urxvtc client.
788=item @terms = urxvt::termlist 482=item @terms = urxvt::termlist
789 483
790Returns all urxvt::term objects that exist in this process, regardless of 484Returns all urxvt::term objects that exist in this process, regardless of
791whether they are started, being destroyed etc., so be careful. Only term 485whether they are started, being destroyed etc., so be careful. Only term
792objects that have perl extensions attached will be returned (because there 486objects that have perl extensions attached will be returned (because there
793is no urxvt::term objet associated with others). 487is no urxvt::term object associated with others).
794 488
795=item $time = urxvt::NOW 489=item $time = urxvt::NOW
796 490
797Returns the "current time" (as per the event loop). 491Returns the "current time" (as per the event loop).
798 492
841 535
842=item $rend = urxvt::OVERLAY_RSTYLE 536=item $rend = urxvt::OVERLAY_RSTYLE
843 537
844Return the rendition mask used for overlays by default. 538Return the rendition mask used for overlays by default.
845 539
846=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 540=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
541urxvt::RS_RVid, urxvt::RS_Uline
847 542
848Return the bit that enabled bold, italic, blink, reverse-video and 543Return the bit that enabled bold, italic, blink, reverse-video and
849underline, respectively. To enable such a style, just logically OR it into 544underline, respectively. To enable such a style, just logically OR it into
850the bitset. 545the bitset.
851 546
888 }; 583 };
889} 584}
890 585
891no warnings 'utf8'; 586no warnings 'utf8';
892 587
588sub parse_resource {
589 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
590
591 $term->scan_extensions;
592
593 my $r = $term->{meta}{resource};
594 keys %$r; # reset iterator
595 while (my ($k, $v) = each %$r) {
596 my $pattern = $k;
597 $pattern =~ y/./-/ if $isarg;
598 my $prefix = $name;
599 my $suffix;
600 if ($pattern =~ /\-$/) {
601 $prefix = substr $name, 0, length $pattern;
602 $suffix = substr $name, length $pattern;
603 }
604 if ($pattern eq $prefix) {
605 $name = "$urxvt::RESCLASS.$k$suffix";
606
607 push @{ $term->{perl_ext_3} }, $v->[0];
608
609 if ($v->[1] eq "boolean") {
610 $term->put_option_db ($name, $flag ? "true" : "false");
611 return 1;
612 } else {
613 $term->put_option_db ($name, $value);
614 return 1 + 2;
615 }
616 }
617 }
618
619 0
620}
621
622sub usage {
623 my ($term, $usage_type) = @_;
624
625 $term->scan_extensions;
626
627 my $r = $term->{meta}{resource};
628
629 for my $pattern (sort keys %$r) {
630 my ($ext, $type, $desc) = @{ $r->{$pattern} };
631
632 $desc .= " (-pe $ext)";
633
634 if ($usage_type == 1) {
635 $pattern =~ y/./-/;
636 $pattern =~ s/-$/-.../g;
637
638 if ($type eq "boolean") {
639 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
640 } else {
641 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
642 }
643 } else {
644 $pattern =~ s/\.$/.*/g;
645 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
646 }
647 }
648}
649
893my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 650my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
894 651
895sub verbose { 652sub verbose {
896 my ($level, $msg) = @_; 653 my ($level, $msg) = @_;
897 warn "$msg\n" if $level <= $verbosity; 654 warn "$msg\n" if $level <= $verbosity;
909 $pkg =~ s/[^[:word:]]/_/g; 666 $pkg =~ s/[^[:word:]]/_/g;
910 $pkg = "urxvt::ext::$pkg"; 667 $pkg = "urxvt::ext::$pkg";
911 668
912 verbose 3, "loading extension '$path' into package '$pkg'"; 669 verbose 3, "loading extension '$path' into package '$pkg'";
913 670
671 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
672
914 open my $fh, "<:raw", $path 673 open my $fh, "<:raw", $path
915 or die "$path: $!"; 674 or die "$path: $!";
916 675
917 my $source = 676 my $source =
918 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 677 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
919 . "#line 1 \"$path\"\n{\n" 678 . "#line 1 \"$path\"\n{\n"
920 . (do { local $/; <$fh> }) 679 . (do { local $/; <$fh> })
921 . "\n};\n1"; 680 . "\n};\n1";
922 681
923 eval $source 682 eval $source
932# called by the rxvt core 691# called by the rxvt core
933sub invoke { 692sub invoke {
934 local $TERM = shift; 693 local $TERM = shift;
935 my $htype = shift; 694 my $htype = shift;
936 695
937 if ($htype == 0) { # INIT 696 if ($htype == HOOK_INIT) {
938 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 697 my @dirs = $TERM->perl_libdirs;
698
699 $TERM->scan_extensions;
939 700
940 my %ext_arg; 701 my %ext_arg;
941 702
942 { 703 {
943 my @init = @TERM_INIT; 704 my @init = @TERM_INIT;
946 my @pkg = @TERM_EXT; 707 my @pkg = @TERM_EXT;
947 @TERM_EXT = (); 708 @TERM_EXT = ();
948 $TERM->register_package ($_) for @pkg; 709 $TERM->register_package ($_) for @pkg;
949 } 710 }
950 711
712 for (
951 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 713 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
714 @{ delete $TERM->{perl_ext_3} }
715 ) {
952 if ($_ eq "default") { 716 if ($_ eq "default") {
717
718 $ext_arg{$_} = []
953 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 719 for qw(selection option-popup selection-popup readline searchable-scrollback);
720
721 for ($TERM->_keysym_resources) {
722 next if /^(?:string|command|builtin|builtin-string|perl)/;
723 next unless /^([A-Za-z0-9_\-]+):/;
724
725 my $ext = $1;
726
727 $ext_arg{$ext} = [];
728 }
729
954 } elsif (/^-(.*)$/) { 730 } elsif (/^-(.*)$/) {
955 delete $ext_arg{$1}; 731 delete $ext_arg{$1};
732
956 } elsif (/^([^<]+)<(.*)>$/) { 733 } elsif (/^([^<]+)<(.*)>$/) {
957 push @{ $ext_arg{$1} }, $2; 734 push @{ $ext_arg{$1} }, $2;
735
958 } else { 736 } else {
959 $ext_arg{$_} ||= []; 737 $ext_arg{$_} ||= [];
960 } 738 }
961 } 739 }
962 740
978 756
979 if (my $cb = $TERM->{_hook}[$htype]) { 757 if (my $cb = $TERM->{_hook}[$htype]) {
980 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 758 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
981 if $verbosity >= 10; 759 if $verbosity >= 10;
982 760
761 if ($htype == HOOK_ACTION) {
762 # this hook is only sent to the extension with the name
763 # matching the first arg
764 my $pkg = shift;
765 $pkg =~ y/-/_/;
766 $pkg = "urxvt::ext::$pkg";
767
768 $cb = $cb->{$pkg}
769 or return undef; #TODO: maybe warn user?
770
771 $cb = { $pkg => $cb };
772 }
773
983 for my $pkg (keys %$cb) { 774 for my $pkg (keys %$cb) {
984 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 775 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
985 $retval ||= $retval_; 776 $retval ||= $retval_;
986 777
987 if ($@) { 778 if ($@) {
988 $TERM->ungrab; # better to lose the grab than the session 779 $TERM->ungrab; # better to lose the grab than the session
989 warn $@; 780 warn $@;
992 783
993 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 784 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
994 if $verbosity >= 11; 785 if $verbosity >= 11;
995 } 786 }
996 787
997 if ($htype == 1) { # DESTROY 788 if ($htype == HOOK_DESTROY) {
998 # clear package objects 789 # clear package objects
999 %$_ = () for values %{ $TERM->{_pkg} }; 790 %$_ = () for values %{ $TERM->{_pkg} };
1000 791
1001 # clear package 792 # clear package
1002 %$TERM = (); 793 %$TERM = ();
1032 } 823 }
1033 } 824 }
1034 ($mask, @color{qw(fg bg)}, \@failed) 825 ($mask, @color{qw(fg bg)}, \@failed)
1035} 826}
1036 827
1037# urxvt::term::extension
1038
1039package urxvt::term::extension; 828package urxvt::term::extension;
1040 829
1041sub enable { 830=head2 The C<urxvt::term::extension> class
1042 my ($self, %hook) = @_;
1043 my $pkg = $self->{_pkg};
1044 831
1045 while (my ($name, $cb) = each %hook) { 832Each extension attached to a terminal object is represented by
1046 my $htype = $HOOKTYPE{uc $name}; 833a C<urxvt::term::extension> object.
1047 defined $htype
1048 or Carp::croak "unsupported hook type '$name'";
1049 834
1050 $self->set_should_invoke ($htype, +1) 835You can use these objects, which are passed to all callbacks to store any
1051 unless exists $self->{term}{_hook}[$htype]{$pkg}; 836state related to the terminal and extension instance.
1052 837
1053 $self->{term}{_hook}[$htype]{$pkg} = $cb; 838The methods (And data members) documented below can be called on extension
1054 } 839objects, in addition to call methods documented for the <urxvt::term>
1055} 840class.
1056 841
1057sub disable { 842=over 4
1058 my ($self, @hook) = @_;
1059 my $pkg = $self->{_pkg};
1060 843
1061 for my $name (@hook) { 844=item $urxvt_term = $self->{term}
1062 my $htype = $HOOKTYPE{uc $name};
1063 defined $htype
1064 or Carp::croak "unsupported hook type '$name'";
1065 845
1066 $self->set_should_invoke ($htype, -1) 846Returns the C<urxvt::term> object associated with this instance of the
1067 if delete $self->{term}{_hook}[$htype]{$pkg}; 847extension. This member I<must not> be changed in any way.
1068 } 848
1069} 849=cut
1070 850
1071our $AUTOLOAD; 851our $AUTOLOAD;
1072 852
1073sub AUTOLOAD { 853sub AUTOLOAD {
1074 $AUTOLOAD =~ /:([^:]+)$/ 854 $AUTOLOAD =~ /:([^:]+)$/
1087 867
1088sub DESTROY { 868sub DESTROY {
1089 # nop 869 # nop
1090} 870}
1091 871
1092# urxvt::destroy_hook 872# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1093 873
1094sub urxvt::destroy_hook::DESTROY { 874sub urxvt::destroy_hook::DESTROY {
1095 ${$_[0]}->(); 875 ${$_[0]}->();
1096} 876}
1097 877
1098sub urxvt::destroy_hook(&) { 878sub urxvt::destroy_hook(&) {
1099 bless \shift, urxvt::destroy_hook:: 879 bless \shift, urxvt::destroy_hook::
1100} 880}
881
882=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
883
884Dynamically enable the given hooks (named without the C<on_> prefix) for
885this extension, replacing any hook previously installed via C<enable> in
886this extension.
887
888This is useful when you want to overwrite time-critical hooks only
889temporarily.
890
891To install additional callbacks for the same hook, you can use the C<on>
892method of the C<urxvt::term> class.
893
894=item $self->disable ($hook_name[, $hook_name..])
895
896Dynamically disable the given hooks.
897
898=cut
899
900sub enable {
901 my ($self, %hook) = @_;
902 my $pkg = $self->{_pkg};
903
904 while (my ($name, $cb) = each %hook) {
905 my $htype = $HOOKTYPE{uc $name};
906 defined $htype
907 or Carp::croak "unsupported hook type '$name'";
908
909 $self->set_should_invoke ($htype, +1)
910 unless exists $self->{term}{_hook}[$htype]{$pkg};
911
912 $self->{term}{_hook}[$htype]{$pkg} = $cb;
913 }
914}
915
916sub disable {
917 my ($self, @hook) = @_;
918 my $pkg = $self->{_pkg};
919
920 for my $name (@hook) {
921 my $htype = $HOOKTYPE{uc $name};
922 defined $htype
923 or Carp::croak "unsupported hook type '$name'";
924
925 $self->set_should_invoke ($htype, -1)
926 if delete $self->{term}{_hook}[$htype]{$pkg};
927 }
928}
929
930=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
931
932Similar to the C<enable> enable, but installs additional callbacks for
933the given hook(s) (that is, it doesn't replace existing callbacks), and
934returns a guard object. When the guard object is destroyed the callbacks
935are disabled again.
936
937=cut
938
939sub urxvt::extension::on_disable::DESTROY {
940 my $disable = shift;
941
942 my $term = delete $disable->{""};
943
944 while (my ($htype, $id) = each %$disable) {
945 delete $term->{_hook}[$htype]{$id};
946 $term->set_should_invoke ($htype, -1);
947 }
948}
949
950sub on {
951 my ($self, %hook) = @_;
952
953 my $term = $self->{term};
954
955 my %disable = ( "" => $term );
956
957 while (my ($name, $cb) = each %hook) {
958 my $htype = $HOOKTYPE{uc $name};
959 defined $htype
960 or Carp::croak "unsupported hook type '$name'";
961
962 $term->set_should_invoke ($htype, +1);
963 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
964 = sub { shift; $cb->($self, @_) }; # very ugly indeed
965 }
966
967 bless \%disable, "urxvt::extension::on_disable"
968}
969
970=item $self->bind_action ($hotkey, $action)
971
972=item $self->x_resource ($pattern)
973
974=item $self->x_resource_boolean ($pattern)
975
976These methods support an additional C<%> prefix for C<$action> or
977C<$pattern> when called on an extension object, compared to the
978C<urxvt::term> methods of the same name - see the description of these
979methods in the C<urxvt::term> class for details.
980
981=cut
982
983sub bind_action {
984 my ($self, $hotkey, $action) = @_;
985 $action =~ s/^%:/$_[0]{_name}:/;
986 $self->{term}->bind_action ($hotkey, $action)
987}
988
989sub x_resource {
990 my ($self, $name) = @_;
991 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
992 $self->{term}->x_resource ($name)
993}
994
995sub x_resource_boolean {
996 my ($self, $name) = @_;
997 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
998 $self->{term}->x_resource_boolean ($name)
999}
1000
1001=back
1002
1003=cut
1101 1004
1102package urxvt::anyevent; 1005package urxvt::anyevent;
1103 1006
1104=head2 The C<urxvt::anyevent> Class 1007=head2 The C<urxvt::anyevent> Class
1105 1008
1106The sole purpose of this class is to deliver an interface to the 1009The sole purpose of this class is to deliver an interface to the
1107C<AnyEvent> module - any module using it will work inside urxvt without 1010C<AnyEvent> module - any module using it will work inside urxvt without
1108further programming. The only exception is that you cannot wait on 1011further programming. The only exception is that you cannot wait on
1109condition variables, but non-blocking condvar use is ok. What this means 1012condition variables, but non-blocking condvar use is ok.
1110is that you cannot use blocking APIs, but the non-blocking variant should
1111work.
1112 1013
1113=cut 1014In practical terms this means is that you cannot use blocking APIs, but
1015the non-blocking variant should work.
1114 1016
1017=cut
1018
1115our $VERSION = '3.4'; 1019our $VERSION = '5.23';
1116 1020
1117$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1021$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1022push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119 1023
1120sub timer { 1024sub timer {
1122 1026
1123 my $cb = $arg{cb}; 1027 my $cb = $arg{cb};
1124 1028
1125 urxvt::timer 1029 urxvt::timer
1126 ->new 1030 ->new
1127 ->start (urxvt::NOW + $arg{after}) 1031 ->after ($arg{after}, $arg{interval})
1128 ->cb (sub { 1032 ->cb ($arg{interval} ? $cb : sub {
1129 $_[0]->stop; # need to cancel manually 1033 $_[0]->stop; # need to cancel manually
1130 $cb->(); 1034 $cb->();
1131 }) 1035 })
1132} 1036}
1133 1037
1134sub io { 1038sub io {
1135 my ($class, %arg) = @_; 1039 my ($class, %arg) = @_;
1136 1040
1137 my $cb = $arg{cb}; 1041 my $cb = $arg{cb};
1042 my $fd = fileno $arg{fh};
1043 defined $fd or $fd = $arg{fh};
1138 1044
1139 bless [$arg{fh}, urxvt::iow 1045 bless [$arg{fh}, urxvt::iow
1140 ->new 1046 ->new
1141 ->fd (fileno $arg{fh}) 1047 ->fd ($fd)
1142 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1048 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1143 | ($arg{poll} =~ /w/ ? 2 : 0)) 1049 | ($arg{poll} =~ /w/ ? 2 : 0))
1144 ->start 1050 ->start
1145 ->cb (sub { 1051 ->cb ($cb)
1146 $cb->(($_[1] & 1 ? 'r' : '')
1147 . ($_[1] & 2 ? 'w' : ''));
1148 })],
1149 urxvt::anyevent:: 1052 ], urxvt::anyevent::
1053}
1054
1055sub idle {
1056 my ($class, %arg) = @_;
1057
1058 my $cb = $arg{cb};
1059
1060 urxvt::iw
1061 ->new
1062 ->start
1063 ->cb ($cb)
1064}
1065
1066sub child {
1067 my ($class, %arg) = @_;
1068
1069 my $cb = $arg{cb};
1070
1071 urxvt::pw
1072 ->new
1073 ->start ($arg{pid})
1074 ->cb (sub {
1075 $_[0]->stop; # need to cancel manually
1076 $cb->($_[0]->rpid, $_[0]->rstatus);
1077 })
1150} 1078}
1151 1079
1152sub DESTROY { 1080sub DESTROY {
1153 $_[0][1]->stop; 1081 $_[0][1]->stop;
1154} 1082}
1155 1083
1084# only needed for AnyEvent < 6 compatibility
1156sub one_event { 1085sub one_event {
1157 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1086 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1158} 1087}
1159 1088
1160package urxvt::term; 1089package urxvt::term;
1175 urxvt::verbose 6, "register package $pkg to $self"; 1104 urxvt::verbose 6, "register package $pkg to $self";
1176 1105
1177 @{"$pkg\::ISA"} = urxvt::term::extension::; 1106 @{"$pkg\::ISA"} = urxvt::term::extension::;
1178 1107
1179 my $proxy = bless { 1108 my $proxy = bless {
1180 _pkg => $pkg, 1109 _pkg => $pkg,
1110 _name => ${"$pkg\::_NAME"}, # hackish
1181 argv => $argv, 1111 argv => $argv,
1182 }, $pkg; 1112 }, $pkg;
1183 Scalar::Util::weaken ($proxy->{term} = $self); 1113 Scalar::Util::weaken ($proxy->{term} = $self);
1184 1114
1185 $self->{_pkg}{$pkg} = $proxy; 1115 $self->{_pkg}{$pkg} = $proxy;
1186 1116
1189 $proxy->enable ($name => $ref); 1119 $proxy->enable ($name => $ref);
1190 } 1120 }
1191 } 1121 }
1192} 1122}
1193 1123
1124sub perl_libdirs {
1125 map { split /:/ }
1126 $_[0]->resource ("perl_lib"),
1127 $ENV{URXVT_PERL_LIB},
1128 "$ENV{HOME}/.urxvt/ext",
1129 "$LIBDIR/perl"
1130}
1131
1132# scan for available extensions and collect their metadata
1133sub scan_extensions {
1134 my ($self) = @_;
1135
1136 return if exists $self->{meta};
1137
1138 my @urxvtdirs = perl_libdirs $self;
1139# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1140
1141 $self->{meta} = \my %meta;
1142
1143 # first gather extensions
1144
1145 my $gather = sub {
1146 my ($dir, $core) = @_;
1147
1148 opendir my $fh, $dir
1149 or return;
1150
1151 for my $ext (readdir $fh) {
1152 $ext !~ /^\./
1153 or next;
1154
1155 open my $fh, "<", "$dir/$ext"
1156 or next;
1157
1158 -f $fh
1159 or next;
1160
1161 $ext =~ s/\.uext$// or $core
1162 or next;
1163
1164 my %ext = (dir => $dir);
1165
1166 while (<$fh>) {
1167 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1168 my ($pattern, $type, $desc) = split /:/, $1;
1169 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1170 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1171 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1172 } else {
1173 $ext{resource}{$pattern} = [$ext, $type, $desc];
1174 }
1175 } elsif (/^\s*(?:#|$)/) {
1176 # skip other comments and empty lines
1177 } else {
1178 last; # stop parsing on first non-empty non-comment line
1179 }
1180 }
1181
1182 $meta{ext}{$ext} = \%ext;
1183 }
1184 };
1185
1186# $gather->($_, 0) for @cpandirs;
1187 $gather->($_, 1) for @urxvtdirs;
1188
1189 # and now merge resources
1190
1191 $meta{resource} = \my %resource;
1192
1193 while (my ($k, $v) = each %{ $meta{ext} }) {
1194 #TODO: should check for extensions overriding each other
1195 %resource = (%resource, %{ $v->{resource} });
1196 }
1197}
1198
1194=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1199=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1195 1200
1196Creates a new terminal, very similar as if you had started it with system 1201Creates a new terminal, very similar as if you had started it with system
1197C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1202C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1198hash which defines the environment of the new terminal. 1203hash which defines the environment of the new terminal.
1215} 1220}
1216 1221
1217=item $term->destroy 1222=item $term->destroy
1218 1223
1219Destroy the terminal object (close the window, free resources 1224Destroy the terminal object (close the window, free resources
1220etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1225etc.). Please note that urxvt will not exit as long as any event
1221watchers (timers, io watchers) are still active. 1226watchers (timers, io watchers) are still active.
1222 1227
1223=item $term->exec_async ($cmd[, @args]) 1228=item $term->exec_async ($cmd[, @args])
1224 1229
1225Works like the combination of the C<fork>/C<exec> builtins, which executes 1230Works like the combination of the C<fork>/C<exec> builtins, which executes
1252C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1257C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1253 1258
1254Here is a likely non-exhaustive list of option names, please see the 1259Here is a likely non-exhaustive list of option names, please see the
1255source file F</src/optinc.h> to see the actual list: 1260source file F</src/optinc.h> to see the actual list:
1256 1261
1257 borderLess console cursorBlink cursorUnderline hold iconic insecure 1262 borderLess buffered console cursorBlink cursorUnderline hold iconic
1258 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1263 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1259 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1264 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1260 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1265 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1261 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1262 transparent tripleclickwords utmpInhibit visualBell 1267 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1268 urgentOnBell utmpInhibit visualBell
1263 1269
1264=item $value = $term->resource ($name[, $newval]) 1270=item $value = $term->resource ($name[, $newval])
1265 1271
1266Returns the current resource value associated with a given name and 1272Returns the current resource value associated with a given name and
1267optionally sets a new value. Setting values is most useful in the C<init> 1273optionally sets a new value. Setting values is most useful in the C<init>
1280 1286
1281Here is a likely non-exhaustive list of resource names, not all of which 1287Here is a likely non-exhaustive list of resource names, not all of which
1282are supported in every build, please see the source file F</src/rsinc.h> 1288are supported in every build, please see the source file F</src/rsinc.h>
1283to see the actual list: 1289to see the actual list:
1284 1290
1285 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1291 answerbackstring backgroundPixmap backspace_key blurradius
1286 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1292 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1287 display_name embed ext_bwidth fade font geometry hold iconName 1293 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1288 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1294 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1295 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1289 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1296 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1290 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1297 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1291 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1298 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1299 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1300 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1301 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295 secondaryScreen secondaryScroll shade term_name title 1302 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1296 transient_for transparent transparent_all tripleclickwords utmpInhibit 1303 term_name title transient_for transparent tripleclickwords urgentOnBell
1297 visualBell 1304 utmpInhibit visualBell
1298 1305
1299=cut 1306=cut
1300 1307
1301sub resource($$;$) { 1308sub resource($$;$) {
1302 my ($self, $name) = (shift, shift); 1309 my ($self, $name) = (shift, shift);
1309Returns the X-Resource for the given pattern, excluding the program or 1316Returns the X-Resource for the given pattern, excluding the program or
1310class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1317class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1311same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1318same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1312resource with that pattern exists. 1319resource with that pattern exists.
1313 1320
1321Extensions that define extra resources also need to call this method
1322to access their values.
1323
1324If the method is called on an extension object (basically, from an
1325extension), then the special prefix C<%.> will be replaced by the name of
1326the extension and a dot, and the lone string C<%> will be replaced by the
1327extension name itself. This makes it possible to code extensions so you
1328can rename them and get a new set of resources without having to change
1329the actual code.
1330
1314This method should only be called during the C<on_start> hook, as there is 1331This method should only be called during the C<on_start> hook, as there is
1315only one resource database per display, and later invocations might return 1332only one resource database per display, and later invocations might return
1316the wrong resources. 1333the wrong resources.
1317 1334
1318=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1335=item $value = $term->x_resource_boolean ($pattern)
1319 1336
1337Like C<x_resource>, above, but interprets the string value as a boolean
1338and returns C<1> for true values, C<0> for false values and C<undef> if
1339the resource or option isn't specified.
1340
1341You should always use this method to parse boolean resources.
1342
1343=cut
1344
1345sub x_resource_boolean {
1346 my $res = &x_resource;
1347
1348 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1349}
1350
1351=item $success = $term->bind_action ($key, $action)
1352
1320Adds a keymap translation exactly as specified via a resource. See the 1353Adds a key binding exactly as specified via a C<keysym> resource. See the
1321C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1354C<keysym> resource in the urxvt(1) manpage.
1355
1356To add default bindings for actions, an extension should call C<<
1357->bind_action >> in its C<init> hook for every such binding. Doing it
1358in the C<init> hook allows users to override or remove the binding
1359again.
1360
1361Example: the C<searchable-scrollback> by default binds itself
1362on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1363$term->bind_action >>.
1364
1365 sub init {
1366 my ($self) = @_;
1367
1368 $self->bind_action ("M-s" => "%:start");
1369 }
1322 1370
1323=item $rend = $term->rstyle ([$new_rstyle]) 1371=item $rend = $term->rstyle ([$new_rstyle])
1324 1372
1325Return and optionally change the current rendition. Text that is output by 1373Return and optionally change the current rendition. Text that is output by
1326the terminal application will use this style. 1374the terminal application will use this style.
1334 1382
1335=item ($row, $col) = $term->selection_beg ([$row, $col]) 1383=item ($row, $col) = $term->selection_beg ([$row, $col])
1336 1384
1337=item ($row, $col) = $term->selection_end ([$row, $col]) 1385=item ($row, $col) = $term->selection_end ([$row, $col])
1338 1386
1339Return the current values of the selection mark, begin or end positions, 1387Return the current values of the selection mark, begin or end positions.
1340and optionally set them to new values. 1388
1389When arguments are given, then the selection coordinates are set to
1390C<$row> and C<$col>, and the selection screen is set to the current
1391screen.
1392
1393=item $screen = $term->selection_screen ([$screen])
1394
1395Returns the current selection screen, and then optionally sets it.
1341 1396
1342=item $term->selection_make ($eventtime[, $rectangular]) 1397=item $term->selection_make ($eventtime[, $rectangular])
1343 1398
1344Tries to make a selection as set by C<selection_beg> and 1399Tries to make a selection as set by C<selection_beg> and
1345C<selection_end>. If C<$rectangular> is true (default: false), a 1400C<selection_end>. If C<$rectangular> is true (default: false), a
1346rectangular selection will be made. This is the prefered function to make 1401rectangular selection will be made. This is the preferred function to make
1347a selection. 1402a selection.
1348 1403
1349=item $success = $term->selection_grab ($eventtime) 1404=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350 1405
1351Try to request the primary selection text from the server (for example, as 1406Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1407true) selection from the server. The corresponding text can be set
1352set by the next method). No visual feedback will be given. This function 1408with the next method. No visual feedback will be given. This function
1353is mostly useful from within C<on_sel_grab> hooks. 1409is mostly useful from within C<on_sel_grab> hooks.
1354 1410
1355=item $oldtext = $term->selection ([$newtext]) 1411=item $oldtext = $term->selection ([$newtext, $clipboard])
1356 1412
1357Return the current selection text and optionally replace it by C<$newtext>. 1413Return the current selection (clipboard if C<$clipboard> is true) text
1414and optionally replace it by C<$newtext>.
1415
1416=item $term->selection_clear ([$clipboard])
1417
1418Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358 1419
1359=item $term->overlay_simple ($x, $y, $text) 1420=item $term->overlay_simple ($x, $y, $text)
1360 1421
1361Create a simple multi-line overlay box. See the next method for details. 1422Create a simple multi-line overlay box. See the next method for details.
1362 1423
1471 1532
1472=item $term->scr_add_lines ($string) 1533=item $term->scr_add_lines ($string)
1473 1534
1474Write the given text string to the screen, as if output by the application 1535Write the given text string to the screen, as if output by the application
1475running inside the terminal. It may not contain command sequences (escape 1536running inside the terminal. It may not contain command sequences (escape
1476codes), but is free to use line feeds, carriage returns and tabs. The 1537codes - see C<cmd_parse> for that), but is free to use line feeds,
1477string is a normal text string, not in locale-dependent encoding. 1538carriage returns and tabs. The string is a normal text string, not in
1539locale-dependent encoding.
1478 1540
1479Normally its not a good idea to use this function, as programs might be 1541Normally its not a good idea to use this function, as programs might be
1480confused by changes in cursor position or scrolling. Its useful inside a 1542confused by changes in cursor position or scrolling. Its useful inside a
1481C<on_add_lines> hook, though. 1543C<on_add_lines> hook, though.
1482 1544
1490locale-specific encoding of the terminal and can contain command sequences 1552locale-specific encoding of the terminal and can contain command sequences
1491(escape codes) that will be interpreted. 1553(escape codes) that will be interpreted.
1492 1554
1493=item $term->tt_write ($octets) 1555=item $term->tt_write ($octets)
1494 1556
1495Write the octets given in C<$data> to the tty (i.e. as program input). To 1557Write the octets given in C<$octets> to the tty (i.e. as user input
1558to the program, see C<cmd_parse> for the opposite direction). To pass
1496pass characters instead of octets, you should convert your strings first 1559characters instead of octets, you should convert your strings first to the
1497to the locale-specific encoding using C<< $term->locale_encode >>. 1560locale-specific encoding using C<< $term->locale_encode >>.
1561
1562=item $term->tt_write_user_input ($octets)
1563
1564Like C<tt_write>, but should be used when writing strings in response to
1565the user pressing a key, to invoke the additional actions requested by
1566the user for that case (C<tt_write> doesn't do that).
1567
1568The typical use case would be inside C<on_action> hooks.
1569
1570=item $term->tt_paste ($octets)
1571
1572Write the octets given in C<$octets> to the tty as a paste, converting NL to
1573CR and bracketing the data with control sequences if bracketed paste mode
1574is set.
1498 1575
1499=item $old_events = $term->pty_ev_events ([$new_events]) 1576=item $old_events = $term->pty_ev_events ([$new_events])
1500 1577
1501Replaces the event mask of the pty watcher by the given event mask. Can 1578Replaces the event mask of the pty watcher by the given event mask. Can
1502be used to suppress input and output handling to the pty/tty. See the 1579be used to suppress input and output handling to the pty/tty. See the
1521Adds the specified events to the vt event mask. Useful e.g. when you want 1598Adds the specified events to the vt event mask. Useful e.g. when you want
1522to receive pointer events all the times: 1599to receive pointer events all the times:
1523 1600
1524 $term->vt_emask_add (urxvt::PointerMotionMask); 1601 $term->vt_emask_add (urxvt::PointerMotionMask);
1525 1602
1603=item $term->set_urgency ($set)
1604
1605Enable/disable the urgency hint on the toplevel window.
1606
1526=item $term->focus_in 1607=item $term->focus_in
1527 1608
1528=item $term->focus_out 1609=item $term->focus_out
1529 1610
1530=item $term->key_press ($state, $keycode[, $time]) 1611=item $term->key_press ($state, $keycode[, $time])
1615Requests a screen refresh. At the next opportunity, rxvt-unicode will 1696Requests a screen refresh. At the next opportunity, rxvt-unicode will
1616compare the on-screen display with its stored representation. If they 1697compare the on-screen display with its stored representation. If they
1617differ, it redraws the differences. 1698differ, it redraws the differences.
1618 1699
1619Used after changing terminal contents to display them. 1700Used after changing terminal contents to display them.
1701
1702=item $term->refresh_check
1703
1704Checks if a refresh has been requested and, if so, schedules one.
1620 1705
1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1706=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622 1707
1623Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> 1708Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1624is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost 1709is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1726} 1811}
1727 1812
1728sub urxvt::line::t { 1813sub urxvt::line::t {
1729 my ($self) = @_; 1814 my ($self) = @_;
1730 1815
1731 if (@_ > 1) 1816 if (@_ > 1) {
1732 {
1733 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1817 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1734 for $self->{beg} .. $self->{end}; 1818 for $self->{beg} .. $self->{end};
1735 } 1819 }
1736 1820
1737 defined wantarray && 1821 defined wantarray &&
1738 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1822 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1739 0, $self->{len} 1823 0, $self->{len}
1740} 1824}
1741 1825
1742sub urxvt::line::r { 1826sub urxvt::line::r {
1743 my ($self) = @_; 1827 my ($self) = @_;
1744 1828
1745 if (@_ > 1) 1829 if (@_ > 1) {
1746 {
1747 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1830 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1748 for $self->{beg} .. $self->{end}; 1831 for $self->{beg} .. $self->{end};
1749 } 1832 }
1750 1833
1751 if (defined wantarray) { 1834 if (defined wantarray) {
1752 my $rend = [ 1835 my $rend = [
1753 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1836 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1754 ]; 1837 ];
1816Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1899Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817recent grab. 1900recent grab.
1818 1901
1819=item $term->ungrab 1902=item $term->ungrab
1820 1903
1821Calls XUngrab for the most recent grab. Is called automatically on 1904Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1822evaluation errors, as it is better to lose the grab in the error case as 1905evaluation errors, as it is better to lose the grab in the error case as
1823the session. 1906the session.
1824 1907
1825=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1908=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826 1909
1846 1929
1847=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1930=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1848 1931
1849=item $term->XChangeInput ($window, $add_events[, $del_events]) 1932=item $term->XChangeInput ($window, $add_events[, $del_events])
1850 1933
1934=item $keysym = $term->XStringToKeysym ($string)
1935
1936=item $string = $term->XKeysymToString ($keysym)
1937
1851Various X or X-related functions. The C<$term> object only serves as 1938Various X or X-related functions. The C<$term> object only serves as
1852the source of the display, otherwise those functions map more-or-less 1939the source of the display, otherwise those functions map more-or-less
1853directory onto the X functions of the same name. 1940directly onto the X functions of the same name.
1854 1941
1855=back 1942=back
1856 1943
1857=cut 1944=cut
1858 1945
2015 2102
2016=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2103=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017 2104
2018Set the callback to be called when the timer triggers. 2105Set the callback to be called when the timer triggers.
2019 2106
2020=item $tstamp = $timer->at
2021
2022Return the time this watcher will fire next.
2023
2024=item $timer = $timer->set ($tstamp) 2107=item $timer = $timer->set ($tstamp[, $interval])
2025 2108
2026Set the time the event is generated to $tstamp. 2109Set the time the event is generated to $tstamp (and optionally specifies a
2110new $interval).
2027 2111
2028=item $timer = $timer->interval ($interval) 2112=item $timer = $timer->interval ($interval)
2029 2113
2030Normally (and when C<$interval> is C<0>), the timer will automatically 2114By default (and when C<$interval> is C<0>), the timer will automatically
2031stop after it has fired once. If C<$interval> is non-zero, then the timer 2115stop after it has fired once. If C<$interval> is non-zero, then the timer
2032is automatically rescheduled at the given intervals. 2116is automatically rescheduled at the given intervals.
2033 2117
2034=item $timer = $timer->start 2118=item $timer = $timer->start
2035 2119
2036Start the timer. 2120Start the timer.
2037 2121
2038=item $timer = $timer->start ($tstamp) 2122=item $timer = $timer->start ($tstamp[, $interval])
2039 2123
2040Set the event trigger time to C<$tstamp> and start the timer. 2124Set the event trigger time to C<$tstamp> and start the timer. Optionally
2125also replaces the interval.
2041 2126
2042=item $timer = $timer->after ($delay) 2127=item $timer = $timer->after ($delay[, $interval])
2043 2128
2044Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2129Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045 2130
2046=item $timer = $timer->stop 2131=item $timer = $timer->stop
2047 2132
2178 2263
2179=back 2264=back
2180 2265
2181=head1 AUTHOR 2266=head1 AUTHOR
2182 2267
2183 Marc Lehmann <pcg@goof.com> 2268 Marc Lehmann <schmorp@schmorp.de>
2184 http://software.schmorp.de/pkg/rxvt-unicode 2269 http://software.schmorp.de/pkg/rxvt-unicode
2185 2270
2186=cut 2271=cut
2187 2272
21881 22731

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines