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.217 by root, Sun Jun 10 13:58:05 2012 UTC vs.
Revision 1.271 by root, Fri Dec 9 05:06:46 2022 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 some directory:
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 instance using it:
17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 urxvt --perl-lib path/to/somedirectory -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 "vars"' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict qw(vars subs)' and 'use utf8'
26thus must be encoded as UTF-8. 26environment, and thus 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 or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266"perl:matcher:list" as seen in the example below.
267
268Example configuration:
269
270 URxvt.perl-ext: default,matcher
271 URxvt.urlLauncher: sensible-browser
272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
274 URxvt.matcher.button: 1
275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277 URxvt.matcher.launcher.2: gvim +$2 $1
278
279=item xim-onthespot
280
281This (experimental) perl extension implements OnTheSpot editing. It does
282not work perfectly, and some input methods don't seem to work well with
283OnTheSpot editing in general, but it seems to work at least for SCIM and
284kinput2.
285
286You enable it by specifying this extension and a preedit style of
287C<OnTheSpot>, i.e.:
288
289 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291=item kuake<hotkey>
292
293A very primitive quake-console-like extension. It was inspired by a
294description of how the programs C<kuake> and C<yakuake> work: Whenever the
295user presses a global accelerator key (by default C<F10>), the terminal
296will show or hide itself. Another press of the accelerator key will hide
297or show it again.
298
299Initially, the window will not be shown when using this extension.
300
301This is useful if you need a single terminal that is not using any desktop
302space most of the time but is quickly available at the press of a key.
303
304The accelerator key is grabbed regardless of any modifiers, so this
305extension will actually grab a physical key just for this function.
306
307If you want a quake-like animation, tell your window manager to do so
308(fvwm can do it).
309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
315
316=item block-graphics-to-ascii
317
318A not very useful example of filtering all text output to the terminal
319by replacing all line-drawing characters (U+2500 .. U+259F) by a
320similar-looking ascii character.
321
322=item digital-clock
323
324Displays a digital clock using the built-in overlay.
325
326=item remote-clipboard
327
328Somewhat of a misnomer, this extension adds two menu entries to the
329selection popup that allows one to run external commands to store the
330selection somewhere and fetch it again.
331
332We use it to implement a "distributed selection mechanism", which just
333means that one command uploads the file to a remote server, and another
334reads it.
335
336The commands can be set using the C<URxvt.remote-selection.store> and
337C<URxvt.remote-selection.fetch> resources. The first should read the
338selection to store from STDIN (always in UTF-8), the second should provide
339the selection data on STDOUT (also in UTF-8).
340
341The defaults (which are likely useless to you) use rsh and cat:
342
343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346=item selection-pastebin
347
348This is a little rarely useful extension that uploads the selection as
349textfile to a remote site (or does other things). (The implementation is
350not currently secure for use in a multiuser environment as it writes to
351F</tmp> directly.).
352
353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354i.e.
355
356 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358Pressing this combination runs a command with C<%> replaced by the name of
359the textfile. This command can be set via a resource:
360
361 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363And the default is likely not useful to anybody but the few people around
364here :)
365
366The name of the textfile is the hex encoded md5 sum of the selection, so
367the same content should lead to the same filename.
368
369After a successful upload the selection will be replaced by the text given
370in the C<selection-pastebin-url> resource (again, the % is the placeholder
371for the filename):
372
373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376the double C</> characters as comment start. Use C<\057\057> instead,
377which works regardless of whether xrdb is used to parse the resource file
378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used like this:
384
385 URxvt.perl-ext-common: default,macosx-clipboard
386 URxvt.keysym.M-c: perl:macosx-clipboard:copy
387 URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
393
394=item example-refresh-hooks
395
396Displays a very simple digital clock in the upper right corner of the
397window. Illustrates overwriting the refresh callbacks to create your own
398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
412
413=back
414 56
415=head1 API DOCUMENTATION 57=head1 API DOCUMENTATION
416 58
417=head2 General API Considerations 59=head2 General API Considerations
418 60
428terminal is destroyed. 70terminal is destroyed.
429 71
430Argument names also often indicate the type of a parameter. Here are some 72Argument names also often indicate the type of a parameter. Here are some
431hints on what they mean: 73hints on what they mean:
432 74
433=over 4 75=over
434 76
435=item $text 77=item $text
436 78
437Rxvt-unicode's special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
438always 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.
467internal use. 109internal use.
468 110
469Although 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
470C<urxvt::term> class on this object. 112C<urxvt::term> class on this object.
471 113
472It has the following methods and data members: 114Additional methods only supported for extension objects are described in
115the C<urxvt::extension> section below.
473 116
117=head2 META comments
118
119Rxvt-unicode recognizes special meta comments in extensions that define
120different types of metadata. These comments are scanned whenever a
121terminal is created and are typically used to autoload extensions when
122their resources or command line parameters are used.
123
124Currently, it recognises these comments below. Individual components are
125separated by colons (C<:>), and should not contain colons themselves -
126there is also currently no escaping mechanism provided for this.
127
474=over 4 128=over
475 129
476=item $urxvt_term = $self->{term} 130=item #:META:RESOURCE:name:type:desc
477 131
478Returns the C<urxvt::term> object associated with this instance of the 132The RESOURCE comment defines a resource used by the extension, where
479extension. This member I<must not> be changed in any way. 133C<name> is the resource name, C<type> is the resource type, C<boolean>
134or C<string>, and C<desc> is the resource description.
480 135
481=item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) 136The extension will be autoloaded when this resource is specified or used
137as a command line parameter.
482 138
483Dynamically enable the given hooks (named without the C<on_> prefix) for 139Example: matcher provides the C<matcher.launcher> resource by having this
484this extension, replacing any previous hook. This is useful when you want 140comment:
485to overwrite time-critical hooks only temporarily.
486 141
487=item $self->disable ($hook_name[, $hook_name..]) 142 #:META:RESOURCE:%.launcher:string:default launcher command
488 143
489Dynamically disable the given hooks. 144Example: load this extension when the C<-tr> command line option or
145resource name is used.
146
147 #:META:RESOURCE:tr:boolean:set root pixmap as background
148
149=item #:META:OSC:number:desc
150
151The OSC comment specifies an OSC sequence, where C<number> is the
152numerical OSC code and C<desc> is a short description that is currently
153unused.
154
155This will cause the extension to be autoloaded when the OSC sequence is
156used for the first time.
157
158Note that autoloading carries some extra responsibilities with it:
159although the terminal cannot really protect itself against malicious
160sources of command sequences, therefore relying on the programs running
161I<inside> to sanitize data that they output, it is very common for
162programs to emit command sequences from untrusted sources.
163
164While this means that extensions should, as a defense-in-depth mechanism,
165always consider whether OSC sequences are safe, autoloading automatically
166exposes any autoloaded extension in all terminal windows, so extra care
167should be taken.
168
169Example: the background extension registers OSC C<20> like this:
170
171 #:META:OSC:20:change/query background image
172
173=item #:META:OSC_PERL:prefix:desc
174
175The same as the OSC comment, but for the Perl OSC sequence (C<777>). The
176C<prefix> should be unique among extensions, of course, which is most
177easily arranged by using the extension name, although this is not
178required.
179
180Example: the overlay-osc extension registers its Perl OSC like this:
181
182 #:META:OSC_PERL:overlay:man overlay-osc
490 183
491=back 184=back
492 185
493=head2 Hooks 186=head2 Hooks
494 187
502hooks returns true, then the event counts as being I<consumed>, and the 195hooks returns true, then the event counts as being I<consumed>, and the
503relevant action might not be carried out by the C++ code. 196relevant action might not be carried out by the C++ code.
504 197
505I<< When in doubt, return a false value (preferably C<()>). >> 198I<< When in doubt, return a false value (preferably C<()>). >>
506 199
507=over 4 200=over
201
202=item on_attach $term
203
204Called when an extension package is attached to a running terminal
205instance. Must return true in all cases, and runs with the same
206limitations as C<on_init>.
207
208Unlike C<on_init> or C<on_start>, this is called when the extension is
209attached to a terminal, regardless of whether the extension is loaded
210before or after the terminal is started. Extensions that need to do
211something before they work can do it in this callback, as opposed to e.g.
212C<on_init>, which might not be called.
508 213
509=item on_init $term 214=item on_init $term
510 215
511Called after a new terminal object has been initialized, but before 216Called after a new terminal object has been initialized, but before
512windows are created or the command gets run. Most methods are unsafe to 217windows are created or the command gets run. Most methods are unsafe to
594 299
595C<on_osc_seq_perl> should be used for new behaviour. 300C<on_osc_seq_perl> should be used for new behaviour.
596 301
597=item on_osc_seq_perl $term, $args, $resp 302=item on_osc_seq_perl $term, $args, $resp
598 303
599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 304Called whenever the B<ESC ] 777 ; prefix ; string ST> command sequence
600operating system command) is processed. Cursor position and other state 305(OSC = operating system command) is processed. Cursor position and other
601information is up-to-date when this happens. For interoperability, the 306state information is up-to-date when this happens. For interoperability,
602string should start with the extension name (sans -osc) and a semicolon, 307the argument should start with the extension name (sans -osc) or some
603to distinguish it from commands for other extensions, and this might be 308other suitable prefix, and a semicolon, to distinguish it from commands
604enforced in the future. 309for other extensions.
605 310
606For example, C<overlay-osc> uses this: 311For example, C<overlay-osc> uses this:
607 312
608 sub on_osc_seq_perl { 313 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_; 314 my ($self, $osc, $resp) = @_;
663 368
664=item on_refresh_end $term 369=item on_refresh_end $term
665 370
666Called just after the screen gets redrawn. See C<on_refresh_begin>. 371Called just after the screen gets redrawn. See C<on_refresh_begin>.
667 372
373=item on_action $term, $string
374
375Called whenever an action is invoked for the corresponding extension
376(e.g. via a C<extension:string> builtin action bound to a key, see
377description of the B<keysym> resource in the urxvt(1) manpage). The
378event is simply the action string. Note that an action event is always
379associated to a single extension.
380
668=item on_user_command $term, $string 381=item on_user_command $term, $string *DEPRECATED*
669 382
670Called whenever a user-configured event is being activated (e.g. via 383Called whenever a user-configured event is being activated (e.g. via
671a C<perl:string> action bound to a key, see description of the B<keysym> 384a C<perl:string> action bound to a key, see description of the B<keysym>
672resource in the @@RXVT_NAME@@(1) manpage). 385resource in the urxvt(1) manpage).
673 386
674The event is simply the action string. This interface is assumed to change 387The event is simply the action string. This interface is going away in
675slightly in the future. 388preference to the C<on_action> hook.
676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683 389
684=item on_resize_all_windows $term, $new_width, $new_height 390=item on_resize_all_windows $term, $new_width, $new_height
685 391
686Called just after the new window size has been calculated, but before 392Called just after the new window size has been calculated, but before
687windows are actually being resized or hints are being set. If this hook 393windows are actually being resized or hints are being set. If this hook
688returns TRUE, setting of the window hints is being skipped. 394returns a true value, setting of the window hints is being skipped.
689 395
690=item on_x_event $term, $event 396=item on_x_event $term, $event
691 397
692Called on every X event received on the vt window (and possibly other 398Called on every X event received on the vt window (and possibly other
693windows). Should only be used as a last resort. Most event structure 399windows). Should only be used as a last resort. Most event structure
733(real, not screen-based) row and column under the mouse cursor. 439(real, not screen-based) row and column under the mouse cursor.
734 440
735C<on_key_press> additionally receives the string rxvt-unicode would 441C<on_key_press> additionally receives the string rxvt-unicode would
736output, if any, in locale-specific encoding. 442output, if any, in locale-specific encoding.
737 443
738subwindow.
739
740=item on_client_message $term, $event 444=item on_client_message $term, $event
741 445
742=item on_wm_protocols $term, $event 446=item on_wm_protocols $term, $event
743 447
744=item on_wm_delete_window $term, $event 448=item on_wm_delete_window $term, $event
755=cut 459=cut
756 460
757package urxvt; 461package urxvt;
758 462
759use utf8; 463use utf8;
760use strict 'vars'; 464use strict qw(vars subs);
761use Carp (); 465use Carp ();
762use Scalar::Util (); 466use Scalar::Util ();
763use List::Util (); 467use List::Util ();
764 468
765our $VERSION = 1; 469our $VERSION = 1;
777 481
778our $NOCHAR = chr 0xffff; 482our $NOCHAR = chr 0xffff;
779 483
780=head2 Variables in the C<urxvt> Package 484=head2 Variables in the C<urxvt> Package
781 485
782=over 4 486=over
783 487
784=item $urxvt::LIBDIR 488=item $urxvt::LIBDIR
785 489
786The rxvt-unicode library directory, where, among other things, the perl 490The rxvt-unicode library directory, where, among other things, the perl
787modules and scripts are stored. 491modules and scripts are stored.
817 521
818=back 522=back
819 523
820=head2 Functions in the C<urxvt> Package 524=head2 Functions in the C<urxvt> Package
821 525
822=over 4 526=over
823 527
824=item urxvt::fatal $errormessage 528=item urxvt::fatal $errormessage
825 529
826Fatally aborts execution with the given error message (which should 530Fatally aborts execution with the given error message (which should
827include a trailing newline). Avoid at all costs! The only time this 531include a trailing newline). Avoid at all costs! The only time this
872CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest, 576CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
873SelectionNotify, ColormapNotify, ClientMessage, MappingNotify 577SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
874 578
875Various constants for use in X calls and event processing. 579Various constants for use in X calls and event processing.
876 580
581=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
582PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
583PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
584PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
585PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
586PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
587PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtMouseUTF8,
588PrivMode_ExtMouseUrxvt, PrivMode_BlinkingCursor, PrivMode_mouse_report,
589PrivMode_Default
590
591Constants for checking DEC private modes.
592
877=back 593=back
878 594
879=head2 RENDITION 595=head2 RENDITION
880 596
881Rendition bitsets contain information about colour, font, font styles and 597Rendition bitsets contain information about colour, font, font styles and
884The following "macros" deal with changes in rendition sets. You should 600The following "macros" deal with changes in rendition sets. You should
885never just create a bitset, you should always modify an existing one, 601never just create a bitset, you should always modify an existing one,
886as they contain important information required for correct operation of 602as they contain important information required for correct operation of
887rxvt-unicode. 603rxvt-unicode.
888 604
889=over 4 605=over
890 606
891=item $rend = urxvt::DEFAULT_RSTYLE 607=item $rend = urxvt::DEFAULT_RSTYLE
892 608
893Returns the default rendition, as used when the terminal is starting up or 609Returns the default rendition, as used when the terminal is starting up or
894being reset. Useful as a base to start when creating renditions. 610being reset. Useful as a base to start when creating renditions.
946no warnings 'utf8'; 662no warnings 'utf8';
947 663
948sub parse_resource { 664sub parse_resource {
949 my ($term, $name, $isarg, $longopt, $flag, $value) = @_; 665 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
950 666
951 $name =~ y/-/./ if $isarg;
952
953 $term->scan_meta; 667 $term->scan_extensions;
954 668
669 # iterating over all resources has quadratic time overhead
670 # overall, maybe this could be optimised?
955 my $r = $term->{meta}{resource}; 671 my $r = $term->{meta}{resource};
956 keys %$r; # reste iterator 672 keys %$r; # reset iterator
957 while (my ($pattern, $v) = each %$r) { 673 while (my ($k, $v) = each %$r) {
958 if ( 674 my $pattern = $k;
675 $pattern =~ y/./-/ if $isarg;
676 my $prefix = $name;
677 my $suffix;
959 $pattern =~ /\.$/ 678 if ($pattern =~ /\-$/) {
960 ? $pattern eq substr $name, 0, length $pattern 679 $prefix = substr $name, 0, length $pattern;
961 : $pattern eq $name 680 $suffix = substr $name, length $pattern;
962 ) { 681 }
682 if ($pattern eq $prefix) {
963 $name = "$urxvt::RESCLASS.$name"; 683 $name = "$urxvt::RESCLASS.$k$suffix";
964 684
965 push @{ $term->{perl_ext_3} }, $v->[0]; 685 push @{ $term->{perl_ext_3} }, $v->[0];
686
687 return 1 unless $isarg;
966 688
967 if ($v->[1] eq "boolean") { 689 if ($v->[1] eq "boolean") {
968 $term->put_option_db ($name, $flag ? "true" : "false"); 690 $term->put_option_db ($name, $flag ? "true" : "false");
969 return 1; 691 return 1;
970 } else { 692 } else {
978} 700}
979 701
980sub usage { 702sub usage {
981 my ($term, $usage_type) = @_; 703 my ($term, $usage_type) = @_;
982 704
983 $term->scan_meta; 705 $term->scan_extensions;
984 706
985 my $r = $term->{meta}{resource}; 707 my $r = $term->{meta}{resource};
986 708
987 for my $pattern (sort keys %$r) { 709 for my $pattern (sort keys %$r) {
988 my ($ext, $type, $desc) = @{ $r->{$pattern} }; 710 my ($ext, $type, $desc) = @{ $r->{$pattern} };
1003 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type; 725 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
1004 } 726 }
1005 } 727 }
1006} 728}
1007 729
1008my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 730my $verbosity = $ENV{URXVT_PERL_VERBOSITY} // 2;
1009 731
1010sub verbose { 732sub verbose {
1011 my ($level, $msg) = @_; 733 my ($level, $msg) = @_;
1012 warn "$msg\n" if $level <= $verbosity; 734 warn "$msg\n" if $level <= $verbosity;
1013} 735}
1030 752
1031 open my $fh, "<:raw", $path 753 open my $fh, "<:raw", $path
1032 or die "$path: $!"; 754 or die "$path: $!";
1033 755
1034 my $source = 756 my $source =
1035 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n" 757 "package $pkg; use strict qw(vars subs); use utf8; no warnings 'utf8';\n"
1036 . "#line 1 \"$path\"\n{\n" 758 . "#line 1 \"$path\"\n{\n"
1037 . (do { local $/; <$fh> }) 759 . (do { local $/; <$fh> })
1038 . "\n};\n1"; 760 . "\n};\n1";
1039 761
1040 eval $source 762 eval $source
1049# called by the rxvt core 771# called by the rxvt core
1050sub invoke { 772sub invoke {
1051 local $TERM = shift; 773 local $TERM = shift;
1052 my $htype = shift; 774 my $htype = shift;
1053 775
1054 if ($htype == 0) { # INIT 776 if ($htype == HOOK_INIT) {
1055 my @dirs = $TERM->perl_libdirs; 777 $TERM->scan_extensions;
1056 778
1057 my %ext_arg; 779 my %ext_arg;
1058 780
1059 { 781 {
1060 my @init = @TERM_INIT; 782 my @init = @TERM_INIT;
1065 $TERM->register_package ($_) for @pkg; 787 $TERM->register_package ($_) for @pkg;
1066 } 788 }
1067 789
1068 for ( 790 for (
1069 @{ delete $TERM->{perl_ext_3} }, 791 @{ delete $TERM->{perl_ext_3} },
1070 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2 792 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
1071 ) { 793 ) {
1072 if ($_ eq "default") { 794 if ($_ eq "default") {
795
796 $ext_arg{$_} = []
1073 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 797 for qw(selection option-popup selection-popup readline searchable-scrollback confirm-paste);
798
799 for ($TERM->_keysym_resources) {
800 next if /^(?:string|command|builtin|builtin-string|perl)/;
801 next unless /^([A-Za-z0-9_\-]+):/;
802
803 my $ext = $1;
804
805 $ext_arg{$ext} = [];
806 }
807
1074 } elsif (/^-(.*)$/) { 808 } elsif (/^-(.*)$/) { # remove from set
1075 delete $ext_arg{$1}; 809 delete $ext_arg{$1};
1076 } elsif (/^([^<]+)<(.*)>$/) { 810
811 } elsif (/^\/(.*)$/) { # prohibit loading
812 undef $TERM->{ext_prohibit}{$1};
813
814 } elsif (/^([^<]+)(?:<(.*)>)?$/) { # add to set, clear prohibit status
815 delete $TERM->{ext_prohibit}{$1};
1077 push @{ $ext_arg{$1} }, $2; 816 push @{ $ext_arg{$1} }, defined $2 ? $2 : ();
817
1078 } else { 818 } else {
1079 $ext_arg{$_} ||= []; 819 verbose 2, "cannot parse extension specification '$_', ignoring.";
1080 } 820 }
1081 } 821 }
1082 822
823 $TERM->set_should_invoke (HOOK_OSC_SEQ , +1) if $TERM->{meta}{autoload_osc};
824 $TERM->set_should_invoke (HOOK_OSC_SEQ_PERL, +1) if $TERM->{meta}{autoload_osc_perl};
825
1083 for my $ext (sort keys %ext_arg) { 826 for my $ext (sort keys %ext_arg) {
1084 my @files = grep -f $_, map "$_/$ext", @dirs; 827 my $path = $TERM->extension_path ($ext);
1085 828
1086 if (@files) { 829 if (defined $path) {
1087 $TERM->register_package (extension_package $files[0], $ext_arg{$ext}); 830 $TERM->autoload_extension ($ext, $ext_arg{$ext});
1088 } else { 831 } else {
1089 warn "perl extension '$ext' not found in perl library search path\n"; 832 verbose 2, "perl extension '$ext' not found in perl library search path";
1090 } 833 }
1091 } 834 }
1092 835
1093 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval"); 836 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
1094 warn $@ if $@; 837 warn $@ if $@;
1095 } 838 }
1096 839
840 if ($htype == HOOK_OSC_SEQ) {
841 if (my $exts = delete $TERM->{meta}{autoload_osc}{$_[0]}) {
842 $TERM->autoload_extension ($_->[0]) for @$exts;
843 }
844 } elsif ($htype == HOOK_OSC_SEQ_PERL) {
845 if ($_[0] =~ /^([^;]+)/ and (my $exts = delete $TERM->{meta}{autoload_osc_perl}{$1})) {
846 $TERM->autoload_extension ($_->[0]) for @$exts;
847 }
848 }
849
1097 $retval = undef; 850 $retval = undef;
1098 851
1099 if (my $cb = $TERM->{_hook}[$htype]) { 852 if (my $cb = $TERM->{_hook}[$htype]) {
1100 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 853 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
1101 if $verbosity >= 10; 854 if $verbosity >= 10;
1102 855
856 if ($htype == HOOK_ACTION) {
857 # this hook is only sent to the extension with the name
858 # matching the first arg
859 my $pkg = shift;
860 $pkg =~ y/-/_/;
861 $pkg = "urxvt::ext::$pkg";
862
863 $cb = $cb->{$pkg}
864 or return undef; #TODO: maybe warn user?
865
866 $cb = { $pkg => $cb };
867 }
868
1103 for my $pkg (keys %$cb) { 869 for my $pkg (keys %$cb) {
1104 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 870 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1105 $retval ||= $retval_; 871 $retval ||= $retval_;
1106 872
1107 if ($@) { 873 if ($@) {
1108 $TERM->ungrab; # better to lose the grab than the session 874 $TERM->ungrab; # better to lose the grab than the session
1109 warn $@; 875 warn $@;
1112 878
1113 verbose 11, "$HOOKNAME[$htype] returning <$retval>" 879 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
1114 if $verbosity >= 11; 880 if $verbosity >= 11;
1115 } 881 }
1116 882
1117 if ($htype == 1) { # DESTROY 883 if ($htype == HOOK_DESTROY) {
1118 # clear package objects 884 # clear package objects
1119 %$_ = () for values %{ $TERM->{_pkg} }; 885 %$_ = () for values %{ $TERM->{_pkg} };
1120 886
1121 # clear package 887 # clear package
1122 %$TERM = (); 888 %$TERM = ();
1154 ($mask, @color{qw(fg bg)}, \@failed) 920 ($mask, @color{qw(fg bg)}, \@failed)
1155} 921}
1156 922
1157package urxvt::term::extension; 923package urxvt::term::extension;
1158 924
1159sub enable { 925=head2 The C<urxvt::term::extension> class
1160 my ($self, %hook) = @_;
1161 my $pkg = $self->{_pkg};
1162 926
1163 while (my ($name, $cb) = each %hook) { 927Each extension attached to a terminal object is represented by
1164 my $htype = $HOOKTYPE{uc $name}; 928a C<urxvt::term::extension> object.
1165 defined $htype
1166 or Carp::croak "unsupported hook type '$name'";
1167 929
1168 $self->set_should_invoke ($htype, +1) 930You can use these objects, which are passed to all callbacks to store any
1169 unless exists $self->{term}{_hook}[$htype]{$pkg}; 931state related to the terminal and extension instance.
1170 932
1171 $self->{term}{_hook}[$htype]{$pkg} = $cb; 933The methods (And data members) documented below can be called on extension
1172 } 934objects, in addition to call methods documented for the <urxvt::term>
1173} 935class.
1174 936
1175sub disable { 937=over
1176 my ($self, @hook) = @_;
1177 my $pkg = $self->{_pkg};
1178 938
1179 for my $name (@hook) { 939=item $urxvt_term = $self->{term}
1180 my $htype = $HOOKTYPE{uc $name};
1181 defined $htype
1182 or Carp::croak "unsupported hook type '$name'";
1183 940
1184 $self->set_should_invoke ($htype, -1) 941Returns the C<urxvt::term> object associated with this instance of the
1185 if delete $self->{term}{_hook}[$htype]{$pkg}; 942extension. This member I<must not> be changed in any way.
1186 } 943
1187} 944=cut
1188 945
1189our $AUTOLOAD; 946our $AUTOLOAD;
1190 947
1191sub AUTOLOAD { 948sub AUTOLOAD {
1192 $AUTOLOAD =~ /:([^:]+)$/ 949 $AUTOLOAD =~ /:([^:]+)$/
1205 962
1206sub DESTROY { 963sub DESTROY {
1207 # nop 964 # nop
1208} 965}
1209 966
1210# urxvt::destroy_hook 967# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1211 968
1212sub urxvt::destroy_hook::DESTROY { 969sub urxvt::destroy_hook::DESTROY {
1213 ${$_[0]}->(); 970 ${$_[0]}->();
1214} 971}
1215 972
1216sub urxvt::destroy_hook(&) { 973sub urxvt::destroy_hook(&) {
1217 bless \shift, urxvt::destroy_hook:: 974 bless \shift, urxvt::destroy_hook::
975}
976
977=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
978
979Dynamically enable the given hooks (named without the C<on_> prefix) for
980this extension, replacing any hook previously installed via C<enable> in
981this extension.
982
983This is useful when you want to overwrite time-critical hooks only
984temporarily.
985
986To install additional callbacks for the same hook, you can use the C<on>
987method of the C<urxvt::term> class.
988
989=item $self->disable ($hook_name[, $hook_name..])
990
991Dynamically disable the given hooks.
992
993=cut
994
995sub enable {
996 my ($self, %hook) = @_;
997 my $pkg = $self->{_pkg};
998
999 while (my ($name, $cb) = each %hook) {
1000 my $htype = $HOOKTYPE{uc $name};
1001 defined $htype
1002 or Carp::croak "unsupported hook type '$name'";
1003
1004 $self->set_should_invoke ($htype, +1)
1005 unless exists $self->{term}{_hook}[$htype]{$pkg};
1006
1007 $self->{term}{_hook}[$htype]{$pkg} = $cb;
1008 }
1009}
1010
1011sub disable {
1012 my ($self, @hook) = @_;
1013 my $pkg = $self->{_pkg};
1014
1015 for my $name (@hook) {
1016 my $htype = $HOOKTYPE{uc $name};
1017 defined $htype
1018 or Carp::croak "unsupported hook type '$name'";
1019
1020 $self->set_should_invoke ($htype, -1)
1021 if delete $self->{term}{_hook}[$htype]{$pkg};
1022 }
1023}
1024
1025=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
1026
1027Similar to the C<enable> enable, but installs additional callbacks for
1028the given hook(s) (that is, it doesn't replace existing callbacks), and
1029returns a guard object. When the guard object is destroyed the callbacks
1030are disabled again.
1031
1032=cut
1033
1034sub urxvt::extension::on_disable::DESTROY {
1035 my $disable = shift;
1036
1037 my $term = delete $disable->{""};
1038
1039 while (my ($htype, $id) = each %$disable) {
1040 delete $term->{_hook}[$htype]{$id};
1041 $term->set_should_invoke ($htype, -1);
1042 }
1043}
1044
1045sub on {
1046 my ($self, %hook) = @_;
1047
1048 my $term = $self->{term};
1049
1050 my %disable = ( "" => $term );
1051
1052 while (my ($name, $cb) = each %hook) {
1053 my $htype = $HOOKTYPE{uc $name};
1054 defined $htype
1055 or Carp::croak "unsupported hook type '$name'";
1056
1057 $term->set_should_invoke ($htype, +1);
1058 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
1059 = sub { shift; $cb->($self, @_) }; # very ugly indeed
1060 }
1061
1062 bless \%disable, "urxvt::extension::on_disable"
1063}
1064
1065=item $self->bind_action ($hotkey, $action)
1066
1067=item $self->x_resource ($pattern)
1068
1069=item $self->x_resource_boolean ($pattern)
1070
1071These methods support an additional C<%> prefix for C<$action> or
1072C<$pattern> when called on an extension object, compared to the
1073C<urxvt::term> methods of the same name - see the description of these
1074methods in the C<urxvt::term> class for details.
1075
1076=cut
1077
1078sub bind_action {
1079 my ($self, $hotkey, $action) = @_;
1080 $action =~ s/^%:/$_[0]{_name}:/;
1081 $self->{term}->bind_action ($hotkey, $action)
1218} 1082}
1219 1083
1220sub x_resource { 1084sub x_resource {
1221 my ($self, $name) = @_; 1085 my ($self, $name) = @_;
1222 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 1086 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1226sub x_resource_boolean { 1090sub x_resource_boolean {
1227 my ($self, $name) = @_; 1091 my ($self, $name) = @_;
1228 $name =~ s/^%(\.|$)/$_[0]{_name}$1/; 1092 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
1229 $self->{term}->x_resource_boolean ($name) 1093 $self->{term}->x_resource_boolean ($name)
1230} 1094}
1095
1096=back
1097
1098=cut
1231 1099
1232package urxvt::anyevent; 1100package urxvt::anyevent;
1233 1101
1234=head2 The C<urxvt::anyevent> Class 1102=head2 The C<urxvt::anyevent> Class
1235 1103
1315 1183
1316package urxvt::term; 1184package urxvt::term;
1317 1185
1318=head2 The C<urxvt::term> Class 1186=head2 The C<urxvt::term> Class
1319 1187
1320=over 4 1188=over
1321 1189
1322=cut 1190=cut
1323 1191
1324# find on_xxx subs in the package and register them 1192# find on_xxx subs in the package and register them
1325# as hooks 1193# as hooks
1326sub register_package { 1194sub register_package {
1327 my ($self, $pkg, $argv) = @_; 1195 my ($self, $pkg, $argv) = @_;
1196
1197 return if $self->{_pkg}{$pkg};
1328 1198
1329 no strict 'refs'; 1199 no strict 'refs';
1330 1200
1331 urxvt::verbose 6, "register package $pkg to $self"; 1201 urxvt::verbose 6, "register package $pkg to $self";
1332 1202
1344 for my $name (@HOOKNAME) { 1214 for my $name (@HOOKNAME) {
1345 if (my $ref = $pkg->can ("on_" . lc $name)) { 1215 if (my $ref = $pkg->can ("on_" . lc $name)) {
1346 $proxy->enable ($name => $ref); 1216 $proxy->enable ($name => $ref);
1347 } 1217 }
1348 } 1218 }
1219
1220 if (my $attach_hook = $pkg->can ("on_attach")) {
1221 $attach_hook->($proxy)
1222 or urxvt::verbose 1, "$pkg->on_attach returned false, extension failed to attach";
1223 }
1224}
1225
1226# map extension name to filesystem path
1227sub extension_path {
1228 (grep -f $_, map "$_/$_[1]", $_[0]->perl_libdirs)[0]
1229}
1230
1231# load an extension by name
1232sub load_extension_file {
1233 my ($self, $path, $argv) = @_;
1234
1235 $self->register_package (urxvt::extension_package $path, $argv);
1236}
1237
1238# autoload an extension unless loading it is prohibited
1239sub autoload_extension {
1240 my ($self, $name, $argv) = @_;
1241
1242 return if exists $self->{ext_prohibit}{$name};
1243
1244 my $path = $self->extension_path ($name)
1245 // return urxvt::verbose 2, "perl extension '$name' not found in perl library search path (during autoload)";
1246
1247 $self->load_extension_file ($path, $argv);
1349} 1248}
1350 1249
1351sub perl_libdirs { 1250sub perl_libdirs {
1352 map { split /:/ } 1251 map { split /:/ }
1353 $_[0]->resource ("perl_lib"), 1252 $_[0]->resource ("perl_lib"),
1354 $ENV{URXVT_PERL_LIB}, 1253 $ENV{URXVT_PERL_LIB},
1355 "$ENV{HOME}/.urxvt/ext", 1254 "$ENV{HOME}/.urxvt/ext",
1356 "$LIBDIR/perl" 1255 "$LIBDIR/perl"
1357} 1256}
1358 1257
1359sub scan_meta { 1258# scan for available extensions and collect their metadata
1259sub scan_extensions {
1360 my ($self) = @_; 1260 my ($self) = @_;
1261
1262 return if exists $self->{meta};
1263
1361 my @libdirs = perl_libdirs $self; 1264 my @urxvtdirs = perl_libdirs $self;
1265# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1362 1266
1363 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1364
1365 my %meta;
1366
1367 $self->{meta_libdirs} = join "\x00", @libdirs;
1368 $self->{meta} = \%meta; 1267 $self->{meta} = \my %allmeta;
1369 1268
1370 for my $dir (reverse @libdirs) { 1269 # first gather extensions
1270
1271 my $gather = sub {
1272 my ($dir, $core) = @_;
1273
1371 opendir my $fh, $dir 1274 opendir my $fh, $dir
1372 or next; 1275 or return;
1276
1373 for my $ext (readdir $fh) { 1277 for my $ext (readdir $fh) {
1374 $ext ne "." 1278 $ext !~ /^\./
1375 and $ext ne ".."
1376 and open my $fh, "<", "$dir/$ext"
1377 or next; 1279 or next;
1378 1280
1281 open my $fh, "<", "$dir/$ext"
1282 or next;
1283
1284 -f $fh
1285 or next;
1286
1287 $ext =~ s/\.uext$// or $core
1288 or next;
1289
1290 my %meta = (dir => $dir);
1291
1379 while (<$fh>) { 1292 while (<$fh>) {
1380 if (/^#:META:X_RESOURCE:(.*)/) { 1293 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1381 my ($pattern, $type, $desc) = split /:/, $1; 1294 my ($pattern, $type, $desc) = split /:/, $1;
1382 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name 1295 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1383 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) { 1296 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1384 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n"; 1297 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1385 } else { 1298 } else {
1386 $meta{resource}{$pattern} = [$ext, $type, $desc]; 1299 $meta{resource}{$pattern} = [$ext, $type, $desc];
1387 } 1300 }
1301
1302 } elsif (/^#:META:OSC:([0-9]+):(.*)/) {
1303 push @{$allmeta{autoload_osc}{$1}}, [$ext, $2];
1304
1305 } elsif (/^#:META:OSC_PERL:([^:]+):(.*)/) {
1306 push @{$allmeta{autoload_osc_perl}{$1}}, [$ext, $2];
1307
1388 } elsif (/^\s*(?:#|$)/) { 1308 } elsif (/^\s*(?:#|$)/) {
1389 # skip other comments and empty lines 1309 # skip other comments and empty lines
1310
1390 } else { 1311 } else {
1391 last; # stop parsing on first non-empty non-comment line 1312 last; # stop parsing on first non-empty non-comment line
1392 } 1313 }
1393 } 1314 }
1315
1316 $allmeta{ext}{$ext} = \%meta;
1394 } 1317 }
1318 };
1319
1320# $gather->($_, 0) for @cpandirs;
1321 $gather->($_, 1) for @urxvtdirs;
1322
1323 # and now merge resources
1324
1325 $allmeta{resource} = \my %resource;
1326
1327 while (my ($k, $v) = each %{ $allmeta{ext} }) {
1328 #TODO: should check for extensions overriding each other
1329 %resource = (%resource, %{ $v->{resource} });
1395 } 1330 }
1396} 1331}
1397 1332
1398=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1333=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1399 1334
1419} 1354}
1420 1355
1421=item $term->destroy 1356=item $term->destroy
1422 1357
1423Destroy the terminal object (close the window, free resources 1358Destroy the terminal object (close the window, free resources
1424etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1359etc.). Please note that urxvt will not exit as long as any event
1425watchers (timers, io watchers) are still active. 1360watchers (timers, io watchers) are still active.
1426 1361
1427=item $term->exec_async ($cmd[, @args]) 1362=item $term->exec_async ($cmd[, @args])
1428 1363
1429Works like the combination of the C<fork>/C<exec> builtins, which executes 1364Works like the combination of the C<fork>/C<exec> builtins, which executes
1430("starts") programs in the background. This function takes care of setting 1365("starts") programs in the background. This function takes care of setting
1431the user environment before exec'ing the command (e.g. C<PATH>) and should 1366the user environment before exec'ing the command (e.g. C<PATH>) and should
1432be preferred over explicit calls to C<exec> or C<system>. 1367be preferred over explicit calls to C<exec> or C<system>.
1433 1368
1369It also sets the C<URXVT_EXT_WINDOWID> environment variable to the window
1370ID of the terminal (C<< $self->parent >>), similar to the C<WINDOWID>
1371variable set for the process spawned inside the terminal.
1372
1434Returns the pid of the subprocess or C<undef> on error. 1373Returns the pid of the subprocess or C<undef> on error.
1435 1374
1436=cut 1375=cut
1437 1376
1438sub exec_async { 1377sub exec_async {
1441 my $pid = fork; 1380 my $pid = fork;
1442 1381
1443 return $pid 1382 return $pid
1444 if !defined $pid or $pid; 1383 if !defined $pid or $pid;
1445 1384
1385 %ENV = (
1446 %ENV = %{ $self->env }; 1386 %{ $self->env },
1387 URXVT_EXT_WINDOWID => $self->parent,
1388 );
1447 1389
1448 exec @_; 1390 exec @_;
1449 urxvt::_exit 255; 1391 urxvt::_exit 255;
1450} 1392}
1451 1393
1462 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell 1404 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1463 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs 1405 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1464 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right 1406 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1465 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen 1407 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1466 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords 1408 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1467 urgentOnBell utmpInhibit visualBell 1409 urgentOnBell utmpInhibit visualBell disablePasteBrackets
1468 1410
1469=item $value = $term->resource ($name[, $newval]) 1411=item $value = $term->resource ($name[, $newval])
1470 1412
1471Returns the current resource value associated with a given name and 1413Returns the current resource value associated with a given name and
1472optionally sets a new value. Setting values is most useful in the C<init> 1414optionally sets a new value. Setting values is most useful in the C<init>
1485 1427
1486Here is a likely non-exhaustive list of resource names, not all of which 1428Here is a likely non-exhaustive list of resource names, not all of which
1487are supported in every build, please see the source file F</src/rsinc.h> 1429are supported in every build, please see the source file F</src/rsinc.h>
1488to see the actual list: 1430to see the actual list:
1489 1431
1490 answerbackstring backgroundPixmap backspace_key blendtype blurradius 1432 answerbackstring backgroundPixmap backspace_key blurradius
1491 boldFont boldItalicFont borderLess buffered chdir color cursorBlink 1433 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1492 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth 1434 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1493 fade font geometry hold iconName iconfile imFont imLocale inputMethod 1435 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1494 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont 1436 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1495 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier 1437 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1498 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1440 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1499 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1441 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1500 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1442 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1501 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll 1443 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1502 term_name title transient_for transparent tripleclickwords urgentOnBell 1444 term_name title transient_for transparent tripleclickwords urgentOnBell
1503 utmpInhibit visualBell 1445 utmpInhibit visualBell rewrapMode disablePasteBrackets
1504 1446
1505=cut 1447=cut
1506 1448
1507sub resource($$;$) { 1449sub resource($$;$) {
1508 my ($self, $name) = (shift, shift); 1450 my ($self, $name) = (shift, shift);
1515Returns the X-Resource for the given pattern, excluding the program or 1457Returns the X-Resource for the given pattern, excluding the program or
1516class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1458class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1517same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1459same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1518resource with that pattern exists. 1460resource with that pattern exists.
1519 1461
1520Extensions that define extra resource or command line arguments also need 1462Extensions that define extra resources also need to call this method
1521to call this method to access their values. 1463to access their values.
1522 1464
1523If the method is called on an extension object (basically, from an 1465If the method is called on an extension object (basically, from an
1524extension), then the special prefix C<%.> will be replaced by the name of 1466extension), then the special prefix C<%.> will be replaced by the name of
1525the extension and a dot, and the lone string C<%> will be replcaed by the 1467the extension and a dot, and the lone string C<%> will be replaced by the
1526extension name itself. This makes it possible to code extensions so you 1468extension name itself. This makes it possible to code extensions so you
1527can rename them and get a new set of commandline switches and resources 1469can rename them and get a new set of resources without having to change
1528without having to change the actual code. 1470the actual code.
1529 1471
1530This method should only be called during the C<on_start> hook, as there is 1472This method should only be called during the C<on_start> hook, as there is
1531only one resource database per display, and later invocations might return 1473only one resource database per display, and later invocations might return
1532the wrong resources. 1474the wrong resources.
1533 1475
1545 my $res = &x_resource; 1487 my $res = &x_resource;
1546 1488
1547 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0 1489 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1548} 1490}
1549 1491
1550=item $success = $term->parse_keysym ($key, $octets) 1492=item $action = $term->lookup_keysym ($keysym, $state)
1551 1493
1494Returns the action bound to key combination C<($keysym, $state)>,
1495if a binding for it exists, and C<undef> otherwise.
1496
1497=item $success = $term->bind_action ($key, $action)
1498
1552Adds a key binding exactly as specified via a resource. See the 1499Adds a key binding exactly as specified via a C<keysym> resource. See the
1553C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1500C<keysym> resource in the urxvt(1) manpage.
1554 1501
1555=item $term->register_command ($keysym, $modifiermask, $string) 1502To add default bindings for actions, an extension should call C<<
1503->bind_action >> in its C<init> hook for every such binding. Doing it
1504in the C<init> hook allows users to override or remove the binding
1505again.
1556 1506
1557Adds a key binding. This is a lower level api compared to 1507Example: the C<searchable-scrollback> by default binds itself
1558C<parse_keysym>, as it expects a parsed key description, and can be 1508on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1559used only inside either the C<on_init> hook, to add a binding, or the 1509$term->bind_action >>.
1560C<on_register_command> hook, to modify a parsed binding. 1510
1511 sub init {
1512 my ($self) = @_;
1513
1514 $self->bind_action ("M-s" => "%:start");
1515 }
1561 1516
1562=item $rend = $term->rstyle ([$new_rstyle]) 1517=item $rend = $term->rstyle ([$new_rstyle])
1563 1518
1564Return and optionally change the current rendition. Text that is output by 1519Return and optionally change the current rendition. Text that is output by
1565the terminal application will use this style. 1520the terminal application will use this style.
1642This method returns an urxvt::overlay object. The overlay will be visible 1597This method returns an urxvt::overlay object. The overlay will be visible
1643as long as the perl object is referenced. 1598as long as the perl object is referenced.
1644 1599
1645The methods currently supported on C<urxvt::overlay> objects are: 1600The methods currently supported on C<urxvt::overlay> objects are:
1646 1601
1647=over 4 1602=over
1648 1603
1649=item $overlay->set ($x, $y, $text[, $rend]) 1604=item $overlay->set ($x, $y, $text[, $rend])
1650 1605
1651Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1606Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1652text in rxvt-unicode's special encoding and an array of rendition values 1607text in rxvt-unicode's special encoding and an array of rendition values
1696Returns the number of screen-cells this string would need. Correctly 1651Returns the number of screen-cells this string would need. Correctly
1697accounts for wide and combining characters. 1652accounts for wide and combining characters.
1698 1653
1699=item $octets = $term->locale_encode ($string) 1654=item $octets = $term->locale_encode ($string)
1700 1655
1701Convert the given text string into the corresponding locale encoding. 1656Convert the given text string into the corresponding locale
1657encoding. Returns C<undef> if C<$string> is C<undef>.
1702 1658
1703=item $string = $term->locale_decode ($octets) 1659=item $string = $term->locale_decode ($octets)
1704 1660
1705Convert the given locale-encoded octets into a perl string. 1661Convert the given locale-encoded octets into a perl string. Returns
1662C<undef> if C<$octets> is C<undef>.
1706 1663
1707=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle]) 1664=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1708 1665
1709XORs the rendition values in the given span with the provided value 1666XORs the rendition values in the given span with the provided value
1710(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in 1667(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1723 1680
1724=item $term->scr_add_lines ($string) 1681=item $term->scr_add_lines ($string)
1725 1682
1726Write the given text string to the screen, as if output by the application 1683Write the given text string to the screen, as if output by the application
1727running inside the terminal. It may not contain command sequences (escape 1684running inside the terminal. It may not contain command sequences (escape
1728codes), but is free to use line feeds, carriage returns and tabs. The 1685codes - see C<cmd_parse> for that), but is free to use line feeds,
1729string is a normal text string, not in locale-dependent encoding. 1686carriage returns and tabs. The string is a normal text string, not in
1687locale-dependent encoding.
1730 1688
1731Normally its not a good idea to use this function, as programs might be 1689Normally its not a good idea to use this function, as programs might be
1732confused by changes in cursor position or scrolling. Its useful inside a 1690confused by changes in cursor position or scrolling. Its useful inside a
1733C<on_add_lines> hook, though. 1691C<on_add_lines> hook, though.
1734 1692
1742locale-specific encoding of the terminal and can contain command sequences 1700locale-specific encoding of the terminal and can contain command sequences
1743(escape codes) that will be interpreted. 1701(escape codes) that will be interpreted.
1744 1702
1745=item $term->tt_write ($octets) 1703=item $term->tt_write ($octets)
1746 1704
1747Write the octets given in C<$octets> to the tty (i.e. as program input). To 1705Write the octets given in C<$octets> to the tty (i.e. as user input
1706to the program, see C<cmd_parse> for the opposite direction). To pass
1748pass characters instead of octets, you should convert your strings first 1707characters instead of octets, you should convert your strings first to the
1749to the locale-specific encoding using C<< $term->locale_encode >>. 1708locale-specific encoding using C<< $term->locale_encode >>.
1709
1710=item $term->tt_write_user_input ($octets)
1711
1712Like C<tt_write>, but should be used when writing strings in response to
1713the user pressing a key, to invoke the additional actions requested by
1714the user for that case (C<tt_write> doesn't do that).
1715
1716The typical use case would be inside C<on_action> hooks.
1750 1717
1751=item $term->tt_paste ($octets) 1718=item $term->tt_paste ($octets)
1752 1719
1753Write the octets given in C<$octets> to the tty as a paste, converting NL to 1720Write the octets given in C<$octets> to the tty as a paste, converting NL to
1754CR and bracketing the data with control sequences if bracketed paste mode 1721CR and bracketing the data with control sequences if bracketed paste mode
1793 1760
1794=item $term->key_release ($state, $keycode[, $time]) 1761=item $term->key_release ($state, $keycode[, $time])
1795 1762
1796Deliver various fake events to to terminal. 1763Deliver various fake events to to terminal.
1797 1764
1798=item $window_width = $term->width 1765=item $window_width = $term->width ([$new_value])
1799 1766
1800=item $window_height = $term->height 1767=item $window_height = $term->height ([$new_value])
1801 1768
1802=item $font_width = $term->fwidth 1769=item $font_width = $term->fwidth ([$new_value])
1803 1770
1804=item $font_height = $term->fheight 1771=item $font_height = $term->fheight ([$new_value])
1805 1772
1806=item $font_ascent = $term->fbase 1773=item $font_ascent = $term->fbase ([$new_value])
1807 1774
1808=item $terminal_rows = $term->nrow 1775=item $terminal_rows = $term->nrow ([$new_value])
1809 1776
1810=item $terminal_columns = $term->ncol 1777=item $terminal_columns = $term->ncol ([$new_value])
1811 1778
1812=item $has_focus = $term->focus 1779=item $has_focus = $term->focus ([$new_value])
1813 1780
1814=item $is_mapped = $term->mapped 1781=item $is_mapped = $term->mapped ([$new_value])
1815 1782
1816=item $max_scrollback = $term->saveLines 1783=item $max_scrollback = $term->saveLines ([$new_value])
1817 1784
1818=item $nrow_plus_saveLines = $term->total_rows 1785=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
1819 1786
1820=item $topmost_scrollback_row = $term->top_row 1787=item $topmost_scrollback_row = $term->top_row ([$new_value])
1821 1788
1822Return various integers describing terminal characteristics. 1789Return various integers describing terminal characteristics. If an
1790argument is given, changes the value and returns the previous one.
1823 1791
1824=item $x_display = $term->display_id 1792=item $x_display = $term->display_id
1825 1793
1826Return the DISPLAY used by rxvt-unicode. 1794Return the DISPLAY used by rxvt-unicode.
1827 1795
1864 1832
1865=item $cursor_is_hidden = $term->hidden_cursor 1833=item $cursor_is_hidden = $term->hidden_cursor
1866 1834
1867Returns whether the cursor is currently hidden or not. 1835Returns whether the cursor is currently hidden or not.
1868 1836
1837=item $priv_modes = $term->priv_modes
1838
1839Returns a bitset with the state of DEC private modes.
1840
1841Example:
1842
1843 if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
1844 # mouse reporting is turned on
1845 }
1846
1869=item $view_start = $term->view_start ([$newvalue]) 1847=item $view_start = $term->view_start ([$newvalue])
1870 1848
1871Returns the row number of the topmost displayed line. Maximum value is 1849Returns the row number of the topmost displayed line and changes it,
1872C<0>, which displays the normal terminal contents. Lower values scroll 1850if an argument is given. Values greater than or equal to C<0> display
1873this many lines into the scrollback buffer. 1851the terminal contents. Lower values scroll this many lines into the
1852scrollback buffer.
1874 1853
1875=item $term->want_refresh 1854=item $term->want_refresh
1876 1855
1877Requests a screen refresh. At the next opportunity, rxvt-unicode will 1856Requests a screen refresh. At the next opportunity, rxvt-unicode will
1878compare the on-screen display with its stored representation. If they 1857compare the on-screen display with its stored representation. If they
1879differ, it redraws the differences. 1858differ, it redraws the differences.
1880 1859
1881Used after changing terminal contents to display them. 1860Used after changing terminal contents to display them.
1861
1862=item $term->refresh_check
1863
1864Checks if a refresh has been requested and, if so, schedules one.
1882 1865
1883=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1866=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1884 1867
1885Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >> 1868Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1886is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost 1869is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1932 1915
1933Create and return a new C<urxvt::line> object that stores information 1916Create and return a new C<urxvt::line> object that stores information
1934about the logical line that row C<$row_number> is part of. It supports the 1917about the logical line that row C<$row_number> is part of. It supports the
1935following methods: 1918following methods:
1936 1919
1937=over 4 1920=over
1938 1921
1939=item $text = $line->t ([$new_text]) 1922=item $text = $line->t ([$new_text])
1940 1923
1941Returns or replaces the full text of the line, similar to C<ROW_t> 1924Returns or replaces the full text of the line, similar to C<ROW_t>
1942 1925
1988} 1971}
1989 1972
1990sub urxvt::line::t { 1973sub urxvt::line::t {
1991 my ($self) = @_; 1974 my ($self) = @_;
1992 1975
1993 if (@_ > 1) 1976 if (@_ > 1) {
1994 {
1995 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1977 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1996 for $self->{beg} .. $self->{end}; 1978 for $self->{beg} .. $self->{end};
1997 } 1979 }
1998 1980
1999 defined wantarray && 1981 defined wantarray &&
2000 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1982 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
2001 0, $self->{len} 1983 0, $self->{len}
2002} 1984}
2003 1985
2004sub urxvt::line::r { 1986sub urxvt::line::r {
2005 my ($self) = @_; 1987 my ($self) = @_;
2006 1988
2007 if (@_ > 1) 1989 if (@_ > 1) {
2008 {
2009 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1990 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
2010 for $self->{beg} .. $self->{end}; 1991 for $self->{beg} .. $self->{end};
2011 } 1992 }
2012 1993
2013 if (defined wantarray) { 1994 if (defined wantarray) {
2014 my $rend = [ 1995 my $rend = [
2015 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1996 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
2016 ]; 1997 ];
2048where one character corresponds to one screen cell. See 2029where one character corresponds to one screen cell. See
2049C<< $term->ROW_t >> for details. 2030C<< $term->ROW_t >> for details.
2050 2031
2051=item $string = $term->special_decode $text 2032=item $string = $term->special_decode $text
2052 2033
2053Converts rxvt-unicodes text representation into a perl string. See 2034Converts rxvt-unicode's text representation into a perl string. See
2054C<< $term->ROW_t >> for details. 2035C<< $term->ROW_t >> for details.
2055 2036
2056=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt]) 2037=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
2057 2038
2058=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt]) 2039=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
2124 2105
2125package urxvt::popup; 2106package urxvt::popup;
2126 2107
2127=head2 The C<urxvt::popup> Class 2108=head2 The C<urxvt::popup> Class
2128 2109
2129=over 4 2110=over
2130 2111
2131=cut 2112=cut
2132 2113
2133sub add_item { 2114sub add_item {
2134 my ($self, $item) = @_; 2115 my ($self, $item) = @_;
2270 ->cb (sub { 2251 ->cb (sub {
2271 $term->{overlay}->set (0, 0, 2252 $term->{overlay}->set (0, 0,
2272 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2253 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2273 }); 2254 });
2274 2255
2275=over 4 2256=over
2276 2257
2277=item $timer = new urxvt::timer 2258=item $timer = new urxvt::timer
2278 2259
2279Create a new timer object in started state. It is scheduled to fire 2260Create a new timer object in started state. It is scheduled to fire
2280immediately. 2261immediately.
2329 sysread $term->{socket}, my $buf, 8192 2310 sysread $term->{socket}, my $buf, 8192
2330 or end-of-file; 2311 or end-of-file;
2331 }); 2312 });
2332 2313
2333 2314
2334=over 4 2315=over
2335 2316
2336=item $iow = new urxvt::iow 2317=item $iow = new urxvt::iow
2337 2318
2338Create a new io watcher object in stopped state. 2319Create a new io watcher object in stopped state.
2339 2320
2366 2347
2367This class implements idle watchers, that get called automatically when 2348This class implements idle watchers, that get called automatically when
2368the process is idle. They should return as fast as possible, after doing 2349the process is idle. They should return as fast as possible, after doing
2369some useful work. 2350some useful work.
2370 2351
2371=over 4 2352=over
2372 2353
2373=item $iw = new urxvt::iw 2354=item $iw = new urxvt::iw
2374 2355
2375Create a new idle watcher object in stopped state. 2356Create a new idle watcher object in stopped state.
2376 2357
2401 ->cb (sub { 2382 ->cb (sub {
2402 my ($pw, $exit_status) = @_; 2383 my ($pw, $exit_status) = @_;
2403 ... 2384 ...
2404 }); 2385 });
2405 2386
2406=over 4 2387=over
2407 2388
2408=item $pw = new urxvt::pw 2389=item $pw = new urxvt::pw
2409 2390
2410Create a new process watcher in stopped state. 2391Create a new process watcher in stopped state.
2411 2392
2428=head2 URXVT_PERL_VERBOSITY 2409=head2 URXVT_PERL_VERBOSITY
2429 2410
2430This variable controls the verbosity level of the perl extension. Higher 2411This variable controls the verbosity level of the perl extension. Higher
2431numbers indicate more verbose output. 2412numbers indicate more verbose output.
2432 2413
2433=over 4 2414=over
2434 2415
2435=item == 0 - fatal messages 2416=item == 0 - fatal messages only
2417
2418=item >= 2 - general warnings (default level)
2436 2419
2437=item >= 3 - script loading and management 2420=item >= 3 - script loading and management
2438 2421
2439=item >=10 - all called hooks 2422=item >=10 - all called hooks
2440 2423

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines