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.171 by root, Fri Oct 10 00:11:44 2008 UTC vs.
Revision 1.246 by root, Fri Dec 26 18:58:19 2014 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 and also default bindings for one or
50 51more actions it provides using so called META comments, described
51(More) intelligent selection. This extension tries to be more intelligent 52below. Similarly to builtin resources, extension resources can also be
52when the user extends selections (double-click and further clicks). Right 53specified on the command line as long options (with C<.> replaced by
53now, it tries to select words, urls and complete shell-quoted 54C<->), in which case the corresponding extension is loaded
54arguments, which is very convenient, too, if your F<ls> supports 55automatically. For this to work the extension B<must> define META
55C<--quoting-style=shell>. 56comments for its resources.
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 block-graphics-to-ascii
309
310A not very useful example of filtering all text output to the terminal
311by replacing all line-drawing characters (U+2500 .. U+259F) by a
312similar-looking ascii character.
313
314=item digital-clock
315
316Displays a digital clock using the built-in overlay.
317
318=item remote-clipboard
319
320Somewhat of a misnomer, this extension adds two menu entries to the
321selection popup that allows one to run external commands to store the
322selection somewhere and fetch it again.
323
324We use it to implement a "distributed selection mechanism", which just
325means that one command uploads the file to a remote server, and another
326reads it.
327
328The commands can be set using the C<URxvt.remote-selection.store> and
329C<URxvt.remote-selection.fetch> resources. The first should read the
330selection to store from STDIN (always in UTF-8), the second should provide
331the selection data on STDOUT (also in UTF-8).
332
333The defaults (which are likely useless to you) use rsh and cat:
334
335 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337
338=item selection-pastebin
339
340This is a little rarely useful extension that Uploads the selection as
341textfile to a remote site (or does other things). (The implementation is
342not currently secure for use in a multiuser environment as it writes to
343F</tmp> directly.).
344
345It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
346i.e.
347
348 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
349
350Pressing this combination runs a command with C<%> replaced by the name of
351the textfile. This command can be set via a resource:
352
353 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
354
355And the default is likely not useful to anybody but the few people around
356here :)
357
358The name of the textfile is the hex encoded md5 sum of the selection, so
359the same content should lead to the same filename.
360
361After a successful upload the selection will be replaced by the text given
362in the C<selection-pastebin-url> resource (again, the % is the placeholder
363for the filename):
364
365 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366
367I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368the double C</> characters as comment start. Use C<\057\057> instead,
369which works regardless of wether xrdb is used to parse the resource file
370or not.
371
372=item example-refresh-hooks
373
374Displays a very simple digital clock in the upper right corner of the
375window. Illustrates overwriting the refresh callbacks to create your own
376overlays or changes.
377
378=back
379 57
380=head1 API DOCUMENTATION 58=head1 API DOCUMENTATION
381 59
382=head2 General API Considerations 60=head2 General API Considerations
383 61
397 75
398=over 4 76=over 4
399 77
400=item $text 78=item $text
401 79
402Rxvt-unicodes special way of encoding text, where one "unicode" character 80Rxvt-unicode's special way of encoding text, where one "unicode" character
403always represents one screen cell. See L<ROW_t> for a discussion of this format. 81always represents one screen cell. See L<ROW_t> for a discussion of this format.
404 82
405=item $string 83=item $string
406 84
407A perl text string, with an emphasis on I<text>. It can store all unicode 85A perl text string, with an emphasis on I<text>. It can store all unicode
411=item $octets 89=item $octets
412 90
413Either binary data or - more common - a text string encoded in a 91Either binary data or - more common - a text string encoded in a
414locale-specific way. 92locale-specific way.
415 93
94=item $keysym
95
96an integer that is a valid X11 keysym code. You can convert a string
97into a keysym and viceversa by using C<XStringToKeysym> and
98C<XKeysymToString>.
99
416=back 100=back
417 101
418=head2 Extension Objects 102=head2 Extension Objects
419 103
420Every perl extension is a perl class. A separate perl object is created 104Every perl extension is a perl class. A separate perl object is created
421for each terminal, and each terminal has its own set of extenion objects, 105for each terminal, and each terminal has its own set of extension objects,
422which are passed as the first parameter to hooks. So extensions can use 106which are passed as the first parameter to hooks. So extensions can use
423their C<$self> object without having to think about clashes with other 107their C<$self> object without having to think about clashes with other
424extensions or other terminals, with the exception of methods and members 108extensions or other terminals, with the exception of methods and members
425that begin with an underscore character C<_>: these are reserved for 109that begin with an underscore character C<_>: these are reserved for
426internal use. 110internal use.
427 111
428Although it isn't a C<urxvt::term> object, you can call all methods of the 112Although it isn't a C<urxvt::term> object, you can call all methods of the
429C<urxvt::term> class on this object. 113C<urxvt::term> class on this object.
430 114
431It has the following methods and data members: 115Additional methods only supported for extension objects are described in
116the C<urxvt::extension> section below.
117
118=head2 META comments
119
120rxvt-unicode recognizes special comments in extensions that define
121different types of metadata:
432 122
433=over 4 123=over 4
434 124
435=item $urxvt_term = $self->{term} 125=item #:META:RESOURCE:name:type:desc
436 126
437Returns the C<urxvt::term> object associated with this instance of the 127The RESOURCE comment defines a resource used by the extension, where
438extension. This member I<must not> be changed in any way. 128C<name> is the resource name, C<type> is the resource type, C<boolean>
129or C<string>, and C<desc> is the resource description.
439 130
440=item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) 131=item #:META:BINDING:sym:action
441 132
442Dynamically enable the given hooks (named without the C<on_> prefix) for 133The BINDING comment defines a default binding for an action provided
443this extension, replacing any previous hook. This is useful when you want 134by the extension, where C<sym> is the key combination that triggers
444to overwrite time-critical hooks only temporarily. 135the action, whose format is defined in the description of the
445 136B<keysym> resource in the urxvt(1) manpage, and C<action> is the name
446=item $self->disable ($hook_name[, $hook_name..]) 137of the action method.
447
448Dynamically disable the given hooks.
449 138
450=back 139=back
451 140
452=head2 Hooks 141=head2 Hooks
453 142
590=item on_tt_write $term, $octets 279=item on_tt_write $term, $octets
591 280
592Called whenever some data is written to the tty/pty and can be used to 281Called whenever some data is written to the tty/pty and can be used to
593suppress or filter tty input. 282suppress or filter tty input.
594 283
284=item on_tt_paste $term, $octets
285
286Called whenever text is about to be pasted, with the text as argument. You
287can filter/change and paste the text yourself by returning a true value
288and calling C<< $term->tt_paste >> yourself. C<$octets> is
289locale-encoded.
290
595=item on_line_update $term, $row 291=item on_line_update $term, $row
596 292
597Called whenever a line was updated or changed. Can be used to filter 293Called whenever a line was updated or changed. Can be used to filter
598screen output (e.g. underline urls or other useless stuff). Only lines 294screen output (e.g. underline urls or other useless stuff). Only lines
599that are being shown will be filtered, and, due to performance reasons, 295that are being shown will be filtered, and, due to performance reasons,
615 311
616=item on_refresh_end $term 312=item on_refresh_end $term
617 313
618Called just after the screen gets redrawn. See C<on_refresh_begin>. 314Called just after the screen gets redrawn. See C<on_refresh_begin>.
619 315
316=item on_action $term, $string
317
318Called whenever an action is invoked for the corresponding extension
319(e.g. via a C<extension:string> builtin action bound to a key, see
320description of the B<keysym> resource in the urxvt(1) manpage). The
321event is simply the action string. Note that an action event is always
322associated to a single extension.
323
620=item on_user_command $term, $string 324=item on_user_command $term, $string *DEPRECATED*
621 325
622Called whenever a user-configured event is being activated (e.g. via 326Called whenever a user-configured event is being activated (e.g. via
623a C<perl:string> action bound to a key, see description of the B<keysym> 327a C<perl:string> action bound to a key, see description of the B<keysym>
624resource in the @@RXVT_NAME@@(1) manpage). 328resource in the urxvt(1) manpage).
625 329
626The event is simply the action string. This interface is assumed to change 330The event is simply the action string. This interface is going away in
627slightly in the future. 331preference to the C<on_action> hook.
628 332
629=item on_resize_all_windows $tern, $new_width, $new_height 333=item on_resize_all_windows $term, $new_width, $new_height
630 334
631Called just after the new window size has been calculated, but before 335Called just after the new window size has been calculated, but before
632windows are actually being resized or hints are being set. If this hook 336windows are actually being resized or hints are being set. If this hook
633returns TRUE, setting of the window hints is being skipped. 337returns a true value, setting of the window hints is being skipped.
634 338
635=item on_x_event $term, $event 339=item on_x_event $term, $event
636 340
637Called on every X event received on the vt window (and possibly other 341Called on every X event received on the vt window (and possibly other
638windows). Should only be used as a last resort. Most event structure 342windows). Should only be used as a last resort. Most event structure
668 372
669=item on_map_notify $term, $event 373=item on_map_notify $term, $event
670 374
671=item on_unmap_notify $term, $event 375=item on_unmap_notify $term, $event
672 376
673Called whenever the corresponding X event is received for the terminal If 377Called whenever the corresponding X event is received for the terminal. If
674the hook returns true, then the even will be ignored by rxvt-unicode. 378the hook returns true, then the event will be ignored by rxvt-unicode.
675 379
676The event is a hash with most values as named by Xlib (see the XEvent 380The event is a hash with most values as named by Xlib (see the XEvent
677manpage), with the additional members C<row> and C<col>, which are the 381manpage), with the additional members C<row> and C<col>, which are the
678(real, not screen-based) row and column under the mouse cursor. 382(real, not screen-based) row and column under the mouse cursor.
679 383
680C<on_key_press> additionally receives the string rxvt-unicode would 384C<on_key_press> additionally receives the string rxvt-unicode would
681output, if any, in locale-specific encoding. 385output, if any, in locale-specific encoding.
682 386
683subwindow.
684
685=item on_client_message $term, $event 387=item on_client_message $term, $event
686 388
687=item on_wm_protocols $term, $event 389=item on_wm_protocols $term, $event
688 390
689=item on_wm_delete_window $term, $event 391=item on_wm_delete_window $term, $event
690 392
691Called when various types of ClientMessage events are received (all with 393Called when various types of ClientMessage events are received (all with
692format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 394format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
693 395
396=item on_bell $term
397
398Called on receipt of a bell character.
399
694=back 400=back
695 401
696=cut 402=cut
697 403
698package urxvt; 404package urxvt;
699 405
700use utf8; 406use utf8;
701use strict; 407use strict 'vars';
702use Carp (); 408use Carp ();
703use Scalar::Util (); 409use Scalar::Util ();
704use List::Util (); 410use List::Util ();
705 411
706our $VERSION = 1; 412our $VERSION = 1;
707our $TERM; 413our $TERM;
708our @TERM_INIT; 414our @TERM_INIT; # should go, prevents async I/O etc.
709our @TERM_EXT; 415our @TERM_EXT; # should go, prevents async I/O etc.
710our @HOOKNAME; 416our @HOOKNAME;
711our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 417our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
712our %OPTION; 418our %OPTION;
713 419
714our $LIBDIR; 420our $LIBDIR;
762 468
763=over 4 469=over 4
764 470
765=item urxvt::fatal $errormessage 471=item urxvt::fatal $errormessage
766 472
767Fatally aborts execution with the given error message. Avoid at all 473Fatally aborts execution with the given error message (which should
768costs! The only time this is acceptable is when the terminal process 474include a trailing newline). Avoid at all costs! The only time this
769starts up. 475is acceptable (and useful) is in the init hook, where it prevents the
476terminal from starting up.
770 477
771=item urxvt::warn $string 478=item urxvt::warn $string
772 479
773Calls C<rxvt_warn> with the given string which should not include a 480Calls C<rxvt_warn> with the given string which should include a trailing
774newline. The module also overwrites the C<warn> builtin with a function 481newline. The module also overwrites the C<warn> builtin with a function
775that calls this function. 482that calls this function.
776 483
777Using this function has the advantage that its output ends up in the 484Using this function has the advantage that its output ends up in the
778correct place, e.g. on stderr of the connecting urxvtc client. 485correct place, e.g. on stderr of the connecting urxvtc client.
782=item @terms = urxvt::termlist 489=item @terms = urxvt::termlist
783 490
784Returns all urxvt::term objects that exist in this process, regardless of 491Returns all urxvt::term objects that exist in this process, regardless of
785whether they are started, being destroyed etc., so be careful. Only term 492whether they are started, being destroyed etc., so be careful. Only term
786objects that have perl extensions attached will be returned (because there 493objects that have perl extensions attached will be returned (because there
787is no urxvt::term objet associated with others). 494is no urxvt::term object associated with others).
788 495
789=item $time = urxvt::NOW 496=item $time = urxvt::NOW
790 497
791Returns the "current time" (as per the event loop). 498Returns the "current time" (as per the event loop).
792 499
835 542
836=item $rend = urxvt::OVERLAY_RSTYLE 543=item $rend = urxvt::OVERLAY_RSTYLE
837 544
838Return the rendition mask used for overlays by default. 545Return the rendition mask used for overlays by default.
839 546
840=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 547=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
548urxvt::RS_RVid, urxvt::RS_Uline
841 549
842Return the bit that enabled bold, italic, blink, reverse-video and 550Return the bit that enabled bold, italic, blink, reverse-video and
843underline, respectively. To enable such a style, just logically OR it into 551underline, respectively. To enable such a style, just logically OR it into
844the bitset. 552the bitset.
845 553
882 }; 590 };
883} 591}
884 592
885no warnings 'utf8'; 593no warnings 'utf8';
886 594
595sub parse_resource {
596 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597
598 $term->scan_extensions;
599
600 my $r = $term->{meta}{resource};
601 keys %$r; # reset iterator
602 while (my ($k, $v) = each %$r) {
603 my $pattern = $k;
604 $pattern =~ y/./-/ if $isarg;
605 my $prefix = $name;
606 my $suffix;
607 if ($pattern =~ /\-$/) {
608 $prefix = substr $name, 0, length $pattern;
609 $suffix = substr $name, length $pattern;
610 }
611 if ($pattern eq $prefix) {
612 $name = "$urxvt::RESCLASS.$k$suffix";
613
614 push @{ $term->{perl_ext_3} }, $v->[0];
615
616 if ($v->[1] eq "boolean") {
617 $term->put_option_db ($name, $flag ? "true" : "false");
618 return 1;
619 } else {
620 $term->put_option_db ($name, $value);
621 return 1 + 2;
622 }
623 }
624 }
625
626 0
627}
628
629sub usage {
630 my ($term, $usage_type) = @_;
631
632 $term->scan_extensions;
633
634 my $r = $term->{meta}{resource};
635
636 for my $pattern (sort keys %$r) {
637 my ($ext, $type, $desc) = @{ $r->{$pattern} };
638
639 $desc .= " (-pe $ext)";
640
641 if ($usage_type == 1) {
642 $pattern =~ y/./-/;
643 $pattern =~ s/-$/-.../g;
644
645 if ($type eq "boolean") {
646 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
647 } else {
648 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
649 }
650 } else {
651 $pattern =~ s/\.$/.*/g;
652 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
653 }
654 }
655}
656
887my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 657my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
888 658
889sub verbose { 659sub verbose {
890 my ($level, $msg) = @_; 660 my ($level, $msg) = @_;
891 warn "$msg\n" if $level <= $verbosity; 661 warn "$msg\n" if $level <= $verbosity;
903 $pkg =~ s/[^[:word:]]/_/g; 673 $pkg =~ s/[^[:word:]]/_/g;
904 $pkg = "urxvt::ext::$pkg"; 674 $pkg = "urxvt::ext::$pkg";
905 675
906 verbose 3, "loading extension '$path' into package '$pkg'"; 676 verbose 3, "loading extension '$path' into package '$pkg'";
907 677
678 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
679
908 open my $fh, "<:raw", $path 680 open my $fh, "<:raw", $path
909 or die "$path: $!"; 681 or die "$path: $!";
910 682
911 my $source = 683 my $source =
912 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 684 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
913 . "#line 1 \"$path\"\n{\n" 685 . "#line 1 \"$path\"\n{\n"
914 . (do { local $/; <$fh> }) 686 . (do { local $/; <$fh> })
915 . "\n};\n1"; 687 . "\n};\n1";
916 688
917 eval $source 689 eval $source
926# called by the rxvt core 698# called by the rxvt core
927sub invoke { 699sub invoke {
928 local $TERM = shift; 700 local $TERM = shift;
929 my $htype = shift; 701 my $htype = shift;
930 702
931 if ($htype == 0) { # INIT 703 if ($htype == HOOK_INIT) {
932 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 704 my @dirs = $TERM->perl_libdirs;
705
706 $TERM->scan_extensions;
933 707
934 my %ext_arg; 708 my %ext_arg;
935 709
936 { 710 {
937 my @init = @TERM_INIT; 711 my @init = @TERM_INIT;
940 my @pkg = @TERM_EXT; 714 my @pkg = @TERM_EXT;
941 @TERM_EXT = (); 715 @TERM_EXT = ();
942 $TERM->register_package ($_) for @pkg; 716 $TERM->register_package ($_) for @pkg;
943 } 717 }
944 718
719 for (
945 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 720 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
721 @{ delete $TERM->{perl_ext_3} }
722 ) {
946 if ($_ eq "default") { 723 if ($_ eq "default") {
724
725 $ext_arg{$_} = []
726 for
947 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 727 qw(selection option-popup selection-popup readline searchable-scrollback),
728 map $_->[0], values %{ $TERM->{meta}{binding} };
729
730 for ($TERM->_keysym_resources) {
731 next if /^(?:string|command|builtin|builtin-string|perl)/;
732 next unless /^([A-Za-z0-9_\-]+):/;
733
734 my $ext = $1;
735
736 $ext_arg{$ext} = [];
737 }
738
948 } elsif (/^-(.*)$/) { 739 } elsif (/^-(.*)$/) {
949 delete $ext_arg{$1}; 740 delete $ext_arg{$1};
741
950 } elsif (/^([^<]+)<(.*)>$/) { 742 } elsif (/^([^<]+)<(.*)>$/) {
951 push @{ $ext_arg{$1} }, $2; 743 push @{ $ext_arg{$1} }, $2;
744
952 } else { 745 } else {
953 $ext_arg{$_} ||= []; 746 $ext_arg{$_} ||= [];
747 }
748 }
749
750 # now register default key bindings
751 for my $ext (sort keys %ext_arg) {
752 while (my ($k, $v) = each %{ $TERM->{meta}{ext}{$ext}{binding} }) {
753 $TERM->bind_action ($k, "$v->[0]:$v->[1]");
954 } 754 }
955 } 755 }
956 756
957 for my $ext (sort keys %ext_arg) { 757 for my $ext (sort keys %ext_arg) {
958 my @files = grep -f $_, map "$_/$ext", @dirs; 758 my @files = grep -f $_, map "$_/$ext", @dirs;
972 772
973 if (my $cb = $TERM->{_hook}[$htype]) { 773 if (my $cb = $TERM->{_hook}[$htype]) {
974 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 774 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
975 if $verbosity >= 10; 775 if $verbosity >= 10;
976 776
777 if ($htype == HOOK_ACTION) {
778 # this hook is only sent to the extension with the name
779 # matching the first arg
780 my $pkg = shift;
781 $pkg =~ y/-/_/;
782 $pkg = "urxvt::ext::$pkg";
783
784 $cb = $cb->{$pkg}
785 or return undef; #TODO: maybe warn user?
786
787 $cb = { $pkg => $cb };
788 }
789
977 for my $pkg (keys %$cb) { 790 for my $pkg (keys %$cb) {
978 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 791 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
979 $retval ||= $retval_; 792 $retval ||= $retval_;
980 793
981 if ($@) { 794 if ($@) {
982 $TERM->ungrab; # better to lose the grab than the session 795 $TERM->ungrab; # better to lose the grab than the session
983 warn $@; 796 warn $@;
986 799
987 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 800 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
988 if $verbosity >= 11; 801 if $verbosity >= 11;
989 } 802 }
990 803
991 if ($htype == 1) { # DESTROY 804 if ($htype == HOOK_DESTROY) {
992 # clear package objects 805 # clear package objects
993 %$_ = () for values %{ $TERM->{_pkg} }; 806 %$_ = () for values %{ $TERM->{_pkg} };
994 807
995 # clear package 808 # clear package
996 %$TERM = (); 809 %$TERM = ();
1026 } 839 }
1027 } 840 }
1028 ($mask, @color{qw(fg bg)}, \@failed) 841 ($mask, @color{qw(fg bg)}, \@failed)
1029} 842}
1030 843
1031# urxvt::term::extension
1032
1033package urxvt::term::extension; 844package urxvt::term::extension;
1034 845
1035sub enable { 846=head2 The C<urxvt::term::extension> class
1036 my ($self, %hook) = @_;
1037 my $pkg = $self->{_pkg};
1038 847
1039 while (my ($name, $cb) = each %hook) { 848Each extension attached to a terminal object is represented by
1040 my $htype = $HOOKTYPE{uc $name}; 849a C<urxvt::term::extension> object.
1041 defined $htype
1042 or Carp::croak "unsupported hook type '$name'";
1043 850
1044 $self->set_should_invoke ($htype, +1) 851You can use these objects, which are passed to all callbacks to store any
1045 unless exists $self->{term}{_hook}[$htype]{$pkg}; 852state related to the terminal and extension instance.
1046 853
1047 $self->{term}{_hook}[$htype]{$pkg} = $cb; 854The methods (And data members) documented below can be called on extension
1048 } 855objects, in addition to call methods documented for the <urxvt::term>
1049} 856class.
1050 857
1051sub disable { 858=over 4
1052 my ($self, @hook) = @_;
1053 my $pkg = $self->{_pkg};
1054 859
1055 for my $name (@hook) { 860=item $urxvt_term = $self->{term}
1056 my $htype = $HOOKTYPE{uc $name};
1057 defined $htype
1058 or Carp::croak "unsupported hook type '$name'";
1059 861
1060 $self->set_should_invoke ($htype, -1) 862Returns the C<urxvt::term> object associated with this instance of the
1061 if delete $self->{term}{_hook}[$htype]{$pkg}; 863extension. This member I<must not> be changed in any way.
1062 } 864
1063} 865=cut
1064 866
1065our $AUTOLOAD; 867our $AUTOLOAD;
1066 868
1067sub AUTOLOAD { 869sub AUTOLOAD {
1068 $AUTOLOAD =~ /:([^:]+)$/ 870 $AUTOLOAD =~ /:([^:]+)$/
1081 883
1082sub DESTROY { 884sub DESTROY {
1083 # nop 885 # nop
1084} 886}
1085 887
1086# urxvt::destroy_hook 888# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1087 889
1088sub urxvt::destroy_hook::DESTROY { 890sub urxvt::destroy_hook::DESTROY {
1089 ${$_[0]}->(); 891 ${$_[0]}->();
1090} 892}
1091 893
1092sub urxvt::destroy_hook(&) { 894sub urxvt::destroy_hook(&) {
1093 bless \shift, urxvt::destroy_hook:: 895 bless \shift, urxvt::destroy_hook::
1094} 896}
897
898=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
899
900Dynamically enable the given hooks (named without the C<on_> prefix) for
901this extension, replacing any hook previously installed via C<enable> in
902this extension.
903
904This is useful when you want to overwrite time-critical hooks only
905temporarily.
906
907To install additional callbacks for the same hook, you can use the C<on>
908method of the C<urxvt::term> class.
909
910=item $self->disable ($hook_name[, $hook_name..])
911
912Dynamically disable the given hooks.
913
914=cut
915
916sub enable {
917 my ($self, %hook) = @_;
918 my $pkg = $self->{_pkg};
919
920 while (my ($name, $cb) = each %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 unless exists $self->{term}{_hook}[$htype]{$pkg};
927
928 $self->{term}{_hook}[$htype]{$pkg} = $cb;
929 }
930}
931
932sub disable {
933 my ($self, @hook) = @_;
934 my $pkg = $self->{_pkg};
935
936 for my $name (@hook) {
937 my $htype = $HOOKTYPE{uc $name};
938 defined $htype
939 or Carp::croak "unsupported hook type '$name'";
940
941 $self->set_should_invoke ($htype, -1)
942 if delete $self->{term}{_hook}[$htype]{$pkg};
943 }
944}
945
946=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
947
948Similar to the C<enable> enable, but installs additional callbacks for
949the given hook(s) (that is, it doesn't replace existing callbacks), and
950returns a guard object. When the guard object is destroyed the callbacks
951are disabled again.
952
953=cut
954
955sub urxvt::extension::on_disable::DESTROY {
956 my $disable = shift;
957
958 my $term = delete $disable->{""};
959
960 while (my ($htype, $id) = each %$disable) {
961 delete $term->{_hook}[$htype]{$id};
962 $term->set_should_invoke ($htype, -1);
963 }
964}
965
966sub on {
967 my ($self, %hook) = @_;
968
969 my $term = $self->{term};
970
971 my %disable = ( "" => $term );
972
973 while (my ($name, $cb) = each %hook) {
974 my $htype = $HOOKTYPE{uc $name};
975 defined $htype
976 or Carp::croak "unsupported hook type '$name'";
977
978 $term->set_should_invoke ($htype, +1);
979 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
980 = sub { shift; $cb->($self, @_) }; # very ugly indeed
981 }
982
983 bless \%disable, "urxvt::extension::on_disable"
984}
985
986=item $self->x_resource ($pattern)
987
988=item $self->x_resource_boolean ($pattern)
989
990These methods support an additional C<%> prefix when called on an
991extension object - see the description of these methods in the
992C<urxvt::term> class for details.
993
994=cut
995
996sub x_resource {
997 my ($self, $name) = @_;
998 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
999 $self->{term}->x_resource ($name)
1000}
1001
1002sub x_resource_boolean {
1003 my ($self, $name) = @_;
1004 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1005 $self->{term}->x_resource_boolean ($name)
1006}
1007
1008=back
1009
1010=cut
1095 1011
1096package urxvt::anyevent; 1012package urxvt::anyevent;
1097 1013
1098=head2 The C<urxvt::anyevent> Class 1014=head2 The C<urxvt::anyevent> Class
1099 1015
1100The sole purpose of this class is to deliver an interface to the 1016The sole purpose of this class is to deliver an interface to the
1101C<AnyEvent> module - any module using it will work inside urxvt without 1017C<AnyEvent> module - any module using it will work inside urxvt without
1102further programming. The only exception is that you cannot wait on 1018further programming. The only exception is that you cannot wait on
1103condition variables, but non-blocking condvar use is ok. What this means 1019condition variables, but non-blocking condvar use is ok.
1104is that you cannot use blocking APIs, but the non-blocking variant should
1105work.
1106 1020
1107=cut 1021In practical terms this means is that you cannot use blocking APIs, but
1022the non-blocking variant should work.
1108 1023
1024=cut
1025
1109our $VERSION = '3.4'; 1026our $VERSION = '5.23';
1110 1027
1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1028$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1029push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1113 1030
1114sub timer { 1031sub timer {
1116 1033
1117 my $cb = $arg{cb}; 1034 my $cb = $arg{cb};
1118 1035
1119 urxvt::timer 1036 urxvt::timer
1120 ->new 1037 ->new
1121 ->start (urxvt::NOW + $arg{after}) 1038 ->after ($arg{after}, $arg{interval})
1122 ->cb (sub { 1039 ->cb ($arg{interval} ? $cb : sub {
1123 $_[0]->stop; # need to cancel manually 1040 $_[0]->stop; # need to cancel manually
1124 $cb->(); 1041 $cb->();
1125 }) 1042 })
1126} 1043}
1127 1044
1128sub io { 1045sub io {
1129 my ($class, %arg) = @_; 1046 my ($class, %arg) = @_;
1130 1047
1131 my $cb = $arg{cb}; 1048 my $cb = $arg{cb};
1049 my $fd = fileno $arg{fh};
1050 defined $fd or $fd = $arg{fh};
1132 1051
1133 bless [$arg{fh}, urxvt::iow 1052 bless [$arg{fh}, urxvt::iow
1134 ->new 1053 ->new
1135 ->fd (fileno $arg{fh}) 1054 ->fd ($fd)
1136 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1055 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1137 | ($arg{poll} =~ /w/ ? 2 : 0)) 1056 | ($arg{poll} =~ /w/ ? 2 : 0))
1138 ->start 1057 ->start
1139 ->cb (sub { 1058 ->cb ($cb)
1140 $cb->(($_[1] & 1 ? 'r' : '')
1141 . ($_[1] & 2 ? 'w' : ''));
1142 })],
1143 urxvt::anyevent:: 1059 ], urxvt::anyevent::
1060}
1061
1062sub idle {
1063 my ($class, %arg) = @_;
1064
1065 my $cb = $arg{cb};
1066
1067 urxvt::iw
1068 ->new
1069 ->start
1070 ->cb ($cb)
1071}
1072
1073sub child {
1074 my ($class, %arg) = @_;
1075
1076 my $cb = $arg{cb};
1077
1078 urxvt::pw
1079 ->new
1080 ->start ($arg{pid})
1081 ->cb (sub {
1082 $_[0]->stop; # need to cancel manually
1083 $cb->($_[0]->rpid, $_[0]->rstatus);
1084 })
1144} 1085}
1145 1086
1146sub DESTROY { 1087sub DESTROY {
1147 $_[0][1]->stop; 1088 $_[0][1]->stop;
1148} 1089}
1149 1090
1091# only needed for AnyEvent < 6 compatibility
1150sub one_event { 1092sub one_event {
1151 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1093 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1152} 1094}
1153 1095
1154package urxvt::term; 1096package urxvt::term;
1169 urxvt::verbose 6, "register package $pkg to $self"; 1111 urxvt::verbose 6, "register package $pkg to $self";
1170 1112
1171 @{"$pkg\::ISA"} = urxvt::term::extension::; 1113 @{"$pkg\::ISA"} = urxvt::term::extension::;
1172 1114
1173 my $proxy = bless { 1115 my $proxy = bless {
1174 _pkg => $pkg, 1116 _pkg => $pkg,
1117 _name => ${"$pkg\::_NAME"}, # hackish
1175 argv => $argv, 1118 argv => $argv,
1176 }, $pkg; 1119 }, $pkg;
1177 Scalar::Util::weaken ($proxy->{term} = $self); 1120 Scalar::Util::weaken ($proxy->{term} = $self);
1178 1121
1179 $self->{_pkg}{$pkg} = $proxy; 1122 $self->{_pkg}{$pkg} = $proxy;
1180 1123
1183 $proxy->enable ($name => $ref); 1126 $proxy->enable ($name => $ref);
1184 } 1127 }
1185 } 1128 }
1186} 1129}
1187 1130
1131sub perl_libdirs {
1132 map { split /:/ }
1133 $_[0]->resource ("perl_lib"),
1134 $ENV{URXVT_PERL_LIB},
1135 "$ENV{HOME}/.urxvt/ext",
1136 "$LIBDIR/perl"
1137}
1138
1139# scan for available extensions and collect their metadata
1140sub scan_extensions {
1141 my ($self) = @_;
1142
1143 return if exists $self->{meta};
1144
1145 my @libdirs = perl_libdirs $self;
1146
1147# return if $self->{meta_libdirs} eq join "\x00", @libdirs;#d#
1148
1149# $self->{meta_libdirs} = join "\x00", @libdirs;#d#
1150 $self->{meta} = \my %meta;
1151
1152 # first gather extensions
1153 for my $dir (reverse @libdirs) {
1154 opendir my $fh, $dir
1155 or next;
1156 for my $ext (readdir $fh) {
1157 $ext !~ /^\./
1158 and open my $fh, "<", "$dir/$ext"
1159 or next;
1160
1161 my %ext = (dir => $dir);
1162
1163 while (<$fh>) {
1164 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1165 my ($pattern, $type, $desc) = split /:/, $1;
1166 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1167 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1168 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1169 } else {
1170 $ext{resource}{$pattern} = [$ext, $type, $desc];
1171 }
1172 } elsif (/^#:META:BINDING:(.*)/) {
1173 my ($keysym, $action) = split /:/, $1;
1174 $ext{binding}{$keysym} = [$ext, $action];
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 # and now merge resources and bindings
1187 while (my ($k, $v) = each %{ $meta{ext} }) {
1188 #TODO: should check for extensions overriding each other
1189 %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
1190 %{ $meta{binding} } = (%{ $meta{binding} }, %{ $v->{binding} });
1191 }
1192}
1193
1188=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1194=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1189 1195
1190Creates a new terminal, very similar as if you had started it with system 1196Creates a new terminal, very similar as if you had started it with system
1191C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1197C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1192hash which defines the environment of the new terminal. 1198hash which defines the environment of the new terminal.
1209} 1215}
1210 1216
1211=item $term->destroy 1217=item $term->destroy
1212 1218
1213Destroy the terminal object (close the window, free resources 1219Destroy the terminal object (close the window, free resources
1214etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1220etc.). Please note that urxvt will not exit as long as any event
1215watchers (timers, io watchers) are still active. 1221watchers (timers, io watchers) are still active.
1216 1222
1217=item $term->exec_async ($cmd[, @args]) 1223=item $term->exec_async ($cmd[, @args])
1218 1224
1219Works like the combination of the C<fork>/C<exec> builtins, which executes 1225Works like the combination of the C<fork>/C<exec> builtins, which executes
1246C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1252C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1247 1253
1248Here is a likely non-exhaustive list of option names, please see the 1254Here is a likely non-exhaustive list of option names, please see the
1249source file F</src/optinc.h> to see the actual list: 1255source file F</src/optinc.h> to see the actual list:
1250 1256
1251 borderLess console cursorBlink cursorUnderline hold iconic insecure 1257 borderLess buffered console cursorBlink cursorUnderline hold iconic
1252 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1258 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1253 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1259 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1254 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1260 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1255 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1261 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1256 transparent tripleclickwords utmpInhibit visualBell 1262 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1263 urgentOnBell utmpInhibit visualBell
1257 1264
1258=item $value = $term->resource ($name[, $newval]) 1265=item $value = $term->resource ($name[, $newval])
1259 1266
1260Returns the current resource value associated with a given name and 1267Returns the current resource value associated with a given name and
1261optionally sets a new value. Setting values is most useful in the C<init> 1268optionally sets a new value. Setting values is most useful in the C<init>
1274 1281
1275Here is a likely non-exhaustive list of resource names, not all of which 1282Here is a likely non-exhaustive list of resource names, not all of which
1276are supported in every build, please see the source file F</src/rsinc.h> 1283are supported in every build, please see the source file F</src/rsinc.h>
1277to see the actual list: 1284to see the actual list:
1278 1285
1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1286 answerbackstring backgroundPixmap backspace_key blurradius
1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key 1287 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1281 display_name embed ext_bwidth fade font geometry hold iconName 1288 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1289 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1290 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1291 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1292 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1293 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1294 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1295 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1296 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1289 secondaryScreen secondaryScroll shade term_name title 1297 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1290 transient_for transparent transparent_all tripleclickwords utmpInhibit 1298 term_name title transient_for transparent tripleclickwords urgentOnBell
1291 visualBell 1299 utmpInhibit visualBell
1292 1300
1293=cut 1301=cut
1294 1302
1295sub resource($$;$) { 1303sub resource($$;$) {
1296 my ($self, $name) = (shift, shift); 1304 my ($self, $name) = (shift, shift);
1303Returns the X-Resource for the given pattern, excluding the program or 1311Returns the X-Resource for the given pattern, excluding the program or
1304class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1312class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1305same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1313same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1306resource with that pattern exists. 1314resource with that pattern exists.
1307 1315
1316Extensions that define extra resources also need to call this method
1317to access their values.
1318
1319If the method is called on an extension object (basically, from an
1320extension), then the special prefix C<%.> will be replaced by the name of
1321the extension and a dot, and the lone string C<%> will be replaced by the
1322extension name itself. This makes it possible to code extensions so you
1323can rename them and get a new set of resources without having to change
1324the actual code.
1325
1308This method should only be called during the C<on_start> hook, as there is 1326This method should only be called during the C<on_start> hook, as there is
1309only one resource database per display, and later invocations might return 1327only one resource database per display, and later invocations might return
1310the wrong resources. 1328the wrong resources.
1311 1329
1312=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1330=item $value = $term->x_resource_boolean ($pattern)
1313 1331
1332Like C<x_resource>, above, but interprets the string value as a boolean
1333and returns C<1> for true values, C<0> for false values and C<undef> if
1334the resource or option isn't specified.
1335
1336You should always use this method to parse boolean resources.
1337
1338=cut
1339
1340sub x_resource_boolean {
1341 my $res = &x_resource;
1342
1343 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1344}
1345
1346=item $success = $term->bind_action ($key, $octets)
1347
1314Adds a keymap translation exactly as specified via a resource. See the 1348Adds a key binding exactly as specified via a C<keysym> resource. See the
1315C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1349C<keysym> resource in the urxvt(1) manpage.
1316 1350
1317=item $rend = $term->rstyle ([$new_rstyle]) 1351=item $rend = $term->rstyle ([$new_rstyle])
1318 1352
1319Return and optionally change the current rendition. Text that is output by 1353Return and optionally change the current rendition. Text that is output by
1320the terminal application will use this style. 1354the terminal application will use this style.
1328 1362
1329=item ($row, $col) = $term->selection_beg ([$row, $col]) 1363=item ($row, $col) = $term->selection_beg ([$row, $col])
1330 1364
1331=item ($row, $col) = $term->selection_end ([$row, $col]) 1365=item ($row, $col) = $term->selection_end ([$row, $col])
1332 1366
1333Return the current values of the selection mark, begin or end positions, 1367Return the current values of the selection mark, begin or end positions.
1334and optionally set them to new values. 1368
1369When arguments are given, then the selection coordinates are set to
1370C<$row> and C<$col>, and the selection screen is set to the current
1371screen.
1372
1373=item $screen = $term->selection_screen ([$screen])
1374
1375Returns the current selection screen, and then optionally sets it.
1335 1376
1336=item $term->selection_make ($eventtime[, $rectangular]) 1377=item $term->selection_make ($eventtime[, $rectangular])
1337 1378
1338Tries to make a selection as set by C<selection_beg> and 1379Tries to make a selection as set by C<selection_beg> and
1339C<selection_end>. If C<$rectangular> is true (default: false), a 1380C<selection_end>. If C<$rectangular> is true (default: false), a
1340rectangular selection will be made. This is the prefered function to make 1381rectangular selection will be made. This is the preferred function to make
1341a selection. 1382a selection.
1342 1383
1343=item $success = $term->selection_grab ($eventtime) 1384=item $success = $term->selection_grab ($eventtime[, $clipboard])
1344 1385
1345Try to request the primary selection text from the server (for example, as 1386Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1387true) selection from the server. The corresponding text can be set
1346set by the next method). No visual feedback will be given. This function 1388with the next method. No visual feedback will be given. This function
1347is mostly useful from within C<on_sel_grab> hooks. 1389is mostly useful from within C<on_sel_grab> hooks.
1348 1390
1349=item $oldtext = $term->selection ([$newtext]) 1391=item $oldtext = $term->selection ([$newtext, $clipboard])
1350 1392
1351Return the current selection text and optionally replace it by C<$newtext>. 1393Return the current selection (clipboard if C<$clipboard> is true) text
1394and optionally replace it by C<$newtext>.
1395
1396=item $term->selection_clear ([$clipboard])
1397
1398Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1352 1399
1353=item $term->overlay_simple ($x, $y, $text) 1400=item $term->overlay_simple ($x, $y, $text)
1354 1401
1355Create a simple multi-line overlay box. See the next method for details. 1402Create a simple multi-line overlay box. See the next method for details.
1356 1403
1386 1433
1387The methods currently supported on C<urxvt::overlay> objects are: 1434The methods currently supported on C<urxvt::overlay> objects are:
1388 1435
1389=over 4 1436=over 4
1390 1437
1391=item $overlay->set ($x, $y, $text, $rend) 1438=item $overlay->set ($x, $y, $text[, $rend])
1392 1439
1393Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1440Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1394text in rxvt-unicode's special encoding and an array of rendition values 1441text in rxvt-unicode's special encoding and an array of rendition values
1395at a specific position inside the overlay. 1442at a specific position inside the overlay.
1443
1444If C<$rend> is missing, then the rendition will not be changed.
1396 1445
1397=item $overlay->hide 1446=item $overlay->hide
1398 1447
1399If visible, hide the overlay, but do not destroy it. 1448If visible, hide the overlay, but do not destroy it.
1400 1449
1463 1512
1464=item $term->scr_add_lines ($string) 1513=item $term->scr_add_lines ($string)
1465 1514
1466Write the given text string to the screen, as if output by the application 1515Write the given text string to the screen, as if output by the application
1467running inside the terminal. It may not contain command sequences (escape 1516running inside the terminal. It may not contain command sequences (escape
1468codes), but is free to use line feeds, carriage returns and tabs. The 1517codes - see C<cmd_parse> for that), but is free to use line feeds,
1469string is a normal text string, not in locale-dependent encoding. 1518carriage returns and tabs. The string is a normal text string, not in
1519locale-dependent encoding.
1470 1520
1471Normally its not a good idea to use this function, as programs might be 1521Normally its not a good idea to use this function, as programs might be
1472confused by changes in cursor position or scrolling. Its useful inside a 1522confused by changes in cursor position or scrolling. Its useful inside a
1473C<on_add_lines> hook, though. 1523C<on_add_lines> hook, though.
1474 1524
1482locale-specific encoding of the terminal and can contain command sequences 1532locale-specific encoding of the terminal and can contain command sequences
1483(escape codes) that will be interpreted. 1533(escape codes) that will be interpreted.
1484 1534
1485=item $term->tt_write ($octets) 1535=item $term->tt_write ($octets)
1486 1536
1487Write the octets given in C<$data> to the tty (i.e. as program input). To 1537Write the octets given in C<$octets> to the tty (i.e. as user input
1538to the program, see C<cmd_parse> for the opposite direction). To pass
1488pass characters instead of octets, you should convert your strings first 1539characters instead of octets, you should convert your strings first to the
1489to the locale-specific encoding using C<< $term->locale_encode >>. 1540locale-specific encoding using C<< $term->locale_encode >>.
1541
1542=item $term->tt_write_user_input ($octets)
1543
1544Like C<tt_write>, but should be used when writing strings in response to
1545the user pressing a key, to invoke the additional actions requested by
1546the user for that case (C<tt_write> doesn't do that).
1547
1548The typical use case would be inside C<on_action> hooks.
1549
1550=item $term->tt_paste ($octets)
1551
1552Write the octets given in C<$octets> to the tty as a paste, converting NL to
1553CR and bracketing the data with control sequences if bracketed paste mode
1554is set.
1490 1555
1491=item $old_events = $term->pty_ev_events ([$new_events]) 1556=item $old_events = $term->pty_ev_events ([$new_events])
1492 1557
1493Replaces the event mask of the pty watcher by the given event mask. Can 1558Replaces the event mask of the pty watcher by the given event mask. Can
1494be used to suppress input and output handling to the pty/tty. See the 1559be used to suppress input and output handling to the pty/tty. See the
1512 1577
1513Adds the specified events to the vt event mask. Useful e.g. when you want 1578Adds the specified events to the vt event mask. Useful e.g. when you want
1514to receive pointer events all the times: 1579to receive pointer events all the times:
1515 1580
1516 $term->vt_emask_add (urxvt::PointerMotionMask); 1581 $term->vt_emask_add (urxvt::PointerMotionMask);
1582
1583=item $term->set_urgency ($set)
1584
1585Enable/disable the urgency hint on the toplevel window.
1517 1586
1518=item $term->focus_in 1587=item $term->focus_in
1519 1588
1520=item $term->focus_out 1589=item $term->focus_out
1521 1590
1718} 1787}
1719 1788
1720sub urxvt::line::t { 1789sub urxvt::line::t {
1721 my ($self) = @_; 1790 my ($self) = @_;
1722 1791
1723 if (@_ > 1) 1792 if (@_ > 1) {
1724 {
1725 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1793 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1726 for $self->{beg} .. $self->{end}; 1794 for $self->{beg} .. $self->{end};
1727 } 1795 }
1728 1796
1729 defined wantarray && 1797 defined wantarray &&
1730 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1798 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1731 0, $self->{len} 1799 0, $self->{len}
1732} 1800}
1733 1801
1734sub urxvt::line::r { 1802sub urxvt::line::r {
1735 my ($self) = @_; 1803 my ($self) = @_;
1736 1804
1737 if (@_ > 1) 1805 if (@_ > 1) {
1738 {
1739 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1806 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1740 for $self->{beg} .. $self->{end}; 1807 for $self->{beg} .. $self->{end};
1741 } 1808 }
1742 1809
1743 if (defined wantarray) { 1810 if (defined wantarray) {
1744 my $rend = [ 1811 my $rend = [
1745 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1812 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1746 ]; 1813 ];
1808Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1875Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1809recent grab. 1876recent grab.
1810 1877
1811=item $term->ungrab 1878=item $term->ungrab
1812 1879
1813Calls XUngrab for the most recent grab. Is called automatically on 1880Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1814evaluation errors, as it is better to lose the grab in the error case as 1881evaluation errors, as it is better to lose the grab in the error case as
1815the session. 1882the session.
1816 1883
1817=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1884=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1818 1885
1838 1905
1839=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1906=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1840 1907
1841=item $term->XChangeInput ($window, $add_events[, $del_events]) 1908=item $term->XChangeInput ($window, $add_events[, $del_events])
1842 1909
1910=item $keysym = $term->XStringToKeysym ($string)
1911
1912=item $string = $term->XKeysymToString ($keysym)
1913
1843Various X or X-related functions. The C<$term> object only serves as 1914Various X or X-related functions. The C<$term> object only serves as
1844the source of the display, otherwise those functions map more-or-less 1915the source of the display, otherwise those functions map more-or-less
1845directory onto the X functions of the same name. 1916directly onto the X functions of the same name.
1846 1917
1847=back 1918=back
1848 1919
1849=cut 1920=cut
1850 1921
2007 2078
2008=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2079=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2009 2080
2010Set the callback to be called when the timer triggers. 2081Set the callback to be called when the timer triggers.
2011 2082
2012=item $tstamp = $timer->at
2013
2014Return the time this watcher will fire next.
2015
2016=item $timer = $timer->set ($tstamp) 2083=item $timer = $timer->set ($tstamp[, $interval])
2017 2084
2018Set the time the event is generated to $tstamp. 2085Set the time the event is generated to $tstamp (and optionally specifies a
2086new $interval).
2019 2087
2020=item $timer = $timer->interval ($interval) 2088=item $timer = $timer->interval ($interval)
2021 2089
2022Normally (and when C<$interval> is C<0>), the timer will automatically 2090By default (and when C<$interval> is C<0>), the timer will automatically
2023stop after it has fired once. If C<$interval> is non-zero, then the timer 2091stop after it has fired once. If C<$interval> is non-zero, then the timer
2024is automatically rescheduled at the given intervals. 2092is automatically rescheduled at the given intervals.
2025 2093
2026=item $timer = $timer->start 2094=item $timer = $timer->start
2027 2095
2028Start the timer. 2096Start the timer.
2029 2097
2030=item $timer = $timer->start ($tstamp) 2098=item $timer = $timer->start ($tstamp[, $interval])
2031 2099
2032Set the event trigger time to C<$tstamp> and start the timer. 2100Set the event trigger time to C<$tstamp> and start the timer. Optionally
2101also replaces the interval.
2033 2102
2034=item $timer = $timer->after ($delay) 2103=item $timer = $timer->after ($delay[, $interval])
2035 2104
2036Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2105Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2037 2106
2038=item $timer = $timer->stop 2107=item $timer = $timer->stop
2039 2108
2170 2239
2171=back 2240=back
2172 2241
2173=head1 AUTHOR 2242=head1 AUTHOR
2174 2243
2175 Marc Lehmann <pcg@goof.com> 2244 Marc Lehmann <schmorp@schmorp.de>
2176 http://software.schmorp.de/pkg/rxvt-unicode 2245 http://software.schmorp.de/pkg/rxvt-unicode
2177 2246
2178=cut 2247=cut
2179 2248
21801 22491

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines