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.154 by root, Sat Jun 2 06:43:02 2007 UTC vs.
Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC

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 @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext" 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<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
38using F<< 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 @@RXVT_NAME@@ -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,automove-background,selection-autotransform 46 URxvt.perl-ext-common: default,selection-autotransform
46 47
47=over 4 48Extensions that add command line parameters or resources on their own are
48 49loaded automatically when used.
49=item selection (enabled by default)
50
51(More) intelligent selection. This extension tries to be more intelligent
52when the user extends selections (double-click and further clicks). Right
53now, it tries to select words, urls and complete shell-quoted
54arguments, which is very convenient, too, if your F<ls> supports
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
106It's 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
129It's 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 be" => 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.
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 (the 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
264Example configuration:
265
266 URxvt.perl-ext: default,matcher
267 URxvt.urlLauncher: sensible-browser
268 URxvt.keysym.C-Delete: perl:matcher
269 URxvt.matcher.button: 1
270 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
271 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
272 URxvt.matcher.launcher.2: gvim +$2 $1
273
274=item xim-onthespot
275
276This (experimental) perl extension implements OnTheSpot editing. It does
277not work perfectly, and some input methods don't seem to work well with
278OnTheSpot editing in general, but it seems to work at leats for SCIM and
279kinput2.
280
281You enable it by specifying this extension and a preedit style of
282C<OnTheSpot>, i.e.:
283
284 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
285
286=item kuake<hotkey>
287
288A very primitive quake-console-like extension. It was inspired by a
289description of how the programs C<kuake> and C<yakuake> work: Whenever the
290user presses a global accelerator key (by default C<F10>), the terminal
291will show or hide itself. Another press of the accelerator key will hide
292or show it again.
293
294Initially, the window will not be shown when using this extension.
295
296This is useful if you need a single terminal thats not using any desktop
297space most of the time but is quickly available at the press of a key.
298
299The accelerator key is grabbed regardless of any modifiers, so this
300extension will actually grab a physical key just for this function.
301
302If you want a quake-like animation, tell your window manager to do so
303(fvwm can do it).
304
305=item automove-background
306
307This is basically a very small extension that dynamically changes the
308background pixmap offset to the window position, in effect creating the
309same effect as pseudo transparency with a custom pixmap. No scaling is
310supported in this mode. Example:
311
312 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
313
314L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
315shows how this extension can be used to implement an automatically blurred
316transparent background.
317
318=item block-graphics-to-ascii
319
320A not very useful example of filtering all text output to the terminal
321by replacing all line-drawing characters (U+2500 .. U+259F) by a
322similar-looking ascii character.
323
324=item digital-clock
325
326Displays a digital clock using the built-in overlay.
327
328=item remote-clipboard
329
330Somewhat of a misnomer, this extension adds two menu entries to the
331selection popup that allows one ti run external commands to store the
332selection somewhere and fetch it again.
333
334We use it to implement a "distributed selection mechanism", which just
335means that one command uploads the file to a remote server, and another
336reads it.
337
338The commands can be set using the C<URxvt.remote-selection.store> and
339C<URxvt.remote-selection.fetch> resources. The first should read the
340selection to store from STDIN (always in UTF-8), the second should provide
341the selection data on STDOUT (also in UTF-8).
342
343The defaults (which are likely useless to you) use rsh and cat:
344
345 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
346 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
347
348=item selection-pastebin
349
350This is a little rarely useful extension that Uploads the selection as
351textfile to a remote site (or does other things). (The implementation is
352not currently secure for use in a multiuser environment as it writes to
353F</tmp> directly.).
354
355It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
356i.e.
357
358 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
359
360Pressing this combination runs a command with C<%> replaced by the name of
361the textfile. This command can be set via a resource:
362
363 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
364
365And the default is likely not useful to anybody but the few people around
366here :)
367
368The name of the textfile is the hex encoded md5 sum of the selection, so
369the same content should lead to the same filename.
370
371After a successful upload the selection will be replaced by the text given
372in the C<selection-pastebin-url> resource (again, the % is the placeholder
373for the filename):
374
375 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
376
377I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
378the double C</> characters as comment start. Use C<\057\057> instead,
379which works regardless of wether xrdb is used to parse the resource file
380or not.
381
382=item example-refresh-hooks
383
384Displays a very simple digital clock in the upper right corner of the
385window. Illustrates overwriting the refresh callbacks to create your own
386overlays or changes.
387
388=back
389 50
390=head1 API DOCUMENTATION 51=head1 API DOCUMENTATION
391 52
392=head2 General API Considerations 53=head2 General API Considerations
393 54
407 68
408=over 4 69=over 4
409 70
410=item $text 71=item $text
411 72
412Rxvt-unicodes special way of encoding text, where one "unicode" character 73Rxvt-unicode's special way of encoding text, where one "unicode" character
413always represents one screen cell. See L<ROW_t> for a discussion of this format. 74always represents one screen cell. See L<ROW_t> for a discussion of this format.
414 75
415=item $string 76=item $string
416 77
417A perl text string, with an emphasis on I<text>. It can store all unicode 78A perl text string, with an emphasis on I<text>. It can store all unicode
421=item $octets 82=item $octets
422 83
423Either binary data or - more common - a text string encoded in a 84Either binary data or - more common - a text string encoded in a
424locale-specific way. 85locale-specific way.
425 86
87=item $keysym
88
89an integer that is a valid X11 keysym code. You can convert a string
90into a keysym and viceversa by using C<XStringToKeysym> and
91C<XKeysymToString>.
92
426=back 93=back
427 94
428=head2 Extension Objects 95=head2 Extension Objects
429 96
430Every perl extension is a perl class. A separate perl object is created 97Every perl extension is a perl class. A separate perl object is created
431for each terminal, and each terminal has its own set of extenion objects, 98for each terminal, and each terminal has its own set of extension objects,
432which are passed as the first parameter to hooks. So extensions can use 99which are passed as the first parameter to hooks. So extensions can use
433their C<$self> object without having to think about clashes with other 100their C<$self> object without having to think about clashes with other
434extensions or other terminals, with the exception of methods and members 101extensions or other terminals, with the exception of methods and members
435that begin with an underscore character C<_>: these are reserved for 102that begin with an underscore character C<_>: these are reserved for
436internal use. 103internal use.
445=item $urxvt_term = $self->{term} 112=item $urxvt_term = $self->{term}
446 113
447Returns the C<urxvt::term> object associated with this instance of the 114Returns the C<urxvt::term> object associated with this instance of the
448extension. This member I<must not> be changed in any way. 115extension. This member I<must not> be changed in any way.
449 116
450=item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) 117=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
451 118
452Dynamically enable the given hooks (named without the C<on_> prefix) for 119Dynamically enable the given hooks (named without the C<on_> prefix) for
453this extension, replacing any previous hook. This is useful when you want 120this extension, replacing any previous hook. This is useful when you want
454to overwrite time-critical hooks only temporarily. 121to overwrite time-critical hooks only temporarily.
455 122
123To install additional callbacks for the same hook, you can use the C<on>
124method of the C<urxvt::term> class.
125
456=item $self->disable ($hook_name[, $hook_name..]) 126=item $self->disable ($hook_name[, $hook_name..])
457 127
458Dynamically disable the given hooks. 128Dynamically disable the given hooks.
129
130=item $self->x_resource ($pattern)
131
132=item $self->x_resource_boolean ($pattern)
133
134These methods support an additional C<%> prefix when called on an
135extension object - see the description of these methods in the
136C<urxvt::term> class for details.
459 137
460=back 138=back
461 139
462=head2 Hooks 140=head2 Hooks
463 141
551 229
552It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 230It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
553$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 231$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
554number of lines that will be in the scrollback buffer. 232number of lines that will be in the scrollback buffer.
555 233
556=item on_osc_seq $term, $op, $args 234=item on_osc_seq $term, $op, $args, $resp
557 235
558Called on every OSC sequence and can be used to suppress it or modify its 236Called on every OSC sequence and can be used to suppress it or modify its
559behaviour. The default should be to return an empty list. A true value 237behaviour. The default should be to return an empty list. A true value
560suppresses execution of the request completely. Make sure you don't get 238suppresses execution of the request completely. Make sure you don't get
561confused by recursive invocations when you output an osc sequence within 239confused by recursive invocations when you output an OSC sequence within
562this callback. 240this callback.
563 241
564C<on_osc_seq_perl> should be used for new behaviour. 242C<on_osc_seq_perl> should be used for new behaviour.
565 243
566=item on_osc_seq_perl $term, $string 244=item on_osc_seq_perl $term, $args, $resp
567 245
568Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 246Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
569operating system command) is processed. Cursor position and other state 247operating system command) is processed. Cursor position and other state
570information is up-to-date when this happens. For interoperability, the 248information is up-to-date when this happens. For interoperability, the
571string should start with the extension name and a colon, to distinguish 249string should start with the extension name (sans -osc) and a semicolon,
572it from commands for other extensions, and this might be enforced in the 250to distinguish it from commands for other extensions, and this might be
573future. 251enforced in the future.
252
253For example, C<overlay-osc> uses this:
254
255 sub on_osc_seq_perl {
256 my ($self, $osc, $resp) = @_;
257
258 return unless $osc =~ s/^overlay;//;
259
260 ... process remaining $osc string
261 }
574 262
575Be careful not ever to trust (in a security sense) the data you receive, 263Be careful not ever to trust (in a security sense) the data you receive,
576as its source can not easily be controlled (e-mail content, messages from 264as its source can not easily be controlled (e-mail content, messages from
577other users on the same system etc.). 265other users on the same system etc.).
266
267For responses, C<$resp> contains the end-of-args separator used by the
268sender.
578 269
579=item on_add_lines $term, $string 270=item on_add_lines $term, $string
580 271
581Called whenever text is about to be output, with the text as argument. You 272Called whenever text is about to be output, with the text as argument. You
582can filter/change and output the text yourself by returning a true value 273can filter/change and output the text yourself by returning a true value
587=item on_tt_write $term, $octets 278=item on_tt_write $term, $octets
588 279
589Called whenever some data is written to the tty/pty and can be used to 280Called whenever some data is written to the tty/pty and can be used to
590suppress or filter tty input. 281suppress or filter tty input.
591 282
283=item on_tt_paste $term, $octets
284
285Called whenever text is about to be pasted, with the text as argument. You
286can filter/change and paste the text yourself by returning a true value
287and calling C<< $term->tt_paste >> yourself. C<$octets> is
288locale-encoded.
289
592=item on_line_update $term, $row 290=item on_line_update $term, $row
593 291
594Called whenever a line was updated or changed. Can be used to filter 292Called whenever a line was updated or changed. Can be used to filter
595screen output (e.g. underline urls or other useless stuff). Only lines 293screen output (e.g. underline urls or other useless stuff). Only lines
596that are being shown will be filtered, and, due to performance reasons, 294that are being shown will be filtered, and, due to performance reasons,
603later with the already-modified line (e.g. if unrelated parts change), so 301later with the already-modified line (e.g. if unrelated parts change), so
604you cannot just toggle rendition bits, but only set them. 302you cannot just toggle rendition bits, but only set them.
605 303
606=item on_refresh_begin $term 304=item on_refresh_begin $term
607 305
608Called just before the screen gets redrawn. Can be used for overlay 306Called just before the screen gets redrawn. Can be used for overlay or
609or similar effects by modify terminal contents in refresh_begin, and 307similar effects by modifying the terminal contents in refresh_begin, and
610restoring them in refresh_end. The built-in overlay and selection display 308restoring them in refresh_end. The built-in overlay and selection display
611code is run after this hook, and takes precedence. 309code is run after this hook, and takes precedence.
612 310
613=item on_refresh_end $term 311=item on_refresh_end $term
614 312
621resource in the @@RXVT_NAME@@(1) manpage). 319resource in the @@RXVT_NAME@@(1) manpage).
622 320
623The event is simply the action string. This interface is assumed to change 321The event is simply the action string. This interface is assumed to change
624slightly in the future. 322slightly in the future.
625 323
324=item on_register_command $term, $keysym, $modifiermask, $string
325
326Called after parsing a keysym resource but before registering the
327associated binding. If this hook returns TRUE the binding is not
328registered. It can be used to modify a binding by calling
329C<register_command>.
330
626=item on_resize_all_windows $tern, $new_width, $new_height 331=item on_resize_all_windows $term, $new_width, $new_height
627 332
628Called just after the new window size has been calculated, but before 333Called just after the new window size has been calculated, but before
629windows are actually being resized or hints are being set. If this hook 334windows are actually being resized or hints are being set. If this hook
630returns TRUE, setting of the window hints is being skipped. 335returns TRUE, setting of the window hints is being skipped.
631 336
665 370
666=item on_map_notify $term, $event 371=item on_map_notify $term, $event
667 372
668=item on_unmap_notify $term, $event 373=item on_unmap_notify $term, $event
669 374
670Called whenever the corresponding X event is received for the terminal If 375Called whenever the corresponding X event is received for the terminal. If
671the hook returns true, then the even will be ignored by rxvt-unicode. 376the hook returns true, then the event will be ignored by rxvt-unicode.
672 377
673The event is a hash with most values as named by Xlib (see the XEvent 378The event is a hash with most values as named by Xlib (see the XEvent
674manpage), with the additional members C<row> and C<col>, which are the 379manpage), with the additional members C<row> and C<col>, which are the
675(real, not screen-based) row and column under the mouse cursor. 380(real, not screen-based) row and column under the mouse cursor.
676 381
686=item on_wm_delete_window $term, $event 391=item on_wm_delete_window $term, $event
687 392
688Called when various types of ClientMessage events are received (all with 393Called when various types of ClientMessage events are received (all with
689format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 394format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
690 395
396=item on_bell $term
397
398Called on receipt of a bell character.
399
691=back 400=back
692 401
693=cut 402=cut
694 403
695package urxvt; 404package urxvt;
696 405
697use utf8; 406use utf8;
698use strict; 407use strict 'vars';
699use Carp (); 408use Carp ();
700use Scalar::Util (); 409use Scalar::Util ();
701use List::Util (); 410use List::Util ();
702 411
703our $VERSION = 1; 412our $VERSION = 1;
704our $TERM; 413our $TERM;
705our @TERM_INIT; 414our @TERM_INIT; # should go, prevents async I/O etc.
706our @TERM_EXT; 415our @TERM_EXT; # should go, prevents async I/O etc.
707our @HOOKNAME; 416our @HOOKNAME;
708our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 417our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
709our %OPTION; 418our %OPTION;
710 419
711our $LIBDIR; 420our $LIBDIR;
759 468
760=over 4 469=over 4
761 470
762=item urxvt::fatal $errormessage 471=item urxvt::fatal $errormessage
763 472
764Fatally aborts execution with the given error message. Avoid at all 473Fatally aborts execution with the given error message (which should
765costs! The only time this is acceptable is when the terminal process 474include a trailing newline). Avoid at all costs! The only time this
766starts up. 475is acceptable (and useful) is in the init hook, where it prevents the
476terminal from starting up.
767 477
768=item urxvt::warn $string 478=item urxvt::warn $string
769 479
770Calls 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
771newline. The module also overwrites the C<warn> builtin with a function 481newline. The module also overwrites the C<warn> builtin with a function
772that calls this function. 482that calls this function.
773 483
774Using 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
775correct place, e.g. on stderr of the connecting urxvtc client. 485correct place, e.g. on stderr of the connecting urxvtc client.
779=item @terms = urxvt::termlist 489=item @terms = urxvt::termlist
780 490
781Returns all urxvt::term objects that exist in this process, regardless of 491Returns all urxvt::term objects that exist in this process, regardless of
782whether they are started, being destroyed etc., so be careful. Only term 492whether they are started, being destroyed etc., so be careful. Only term
783objects that have perl extensions attached will be returned (because there 493objects that have perl extensions attached will be returned (because there
784is no urxvt::term objet associated with others). 494is no urxvt::term object associated with others).
785 495
786=item $time = urxvt::NOW 496=item $time = urxvt::NOW
787 497
788Returns the "current time" (as per the event loop). 498Returns the "current time" (as per the event loop).
789 499
832 542
833=item $rend = urxvt::OVERLAY_RSTYLE 543=item $rend = urxvt::OVERLAY_RSTYLE
834 544
835Return the rendition mask used for overlays by default. 545Return the rendition mask used for overlays by default.
836 546
837=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
838 549
839Return the bit that enabled bold, italic, blink, reverse-video and 550Return the bit that enabled bold, italic, blink, reverse-video and
840underline, respectively. To enable such a style, just logically OR it into 551underline, respectively. To enable such a style, just logically OR it into
841the bitset. 552the bitset.
842 553
879 }; 590 };
880} 591}
881 592
882no warnings 'utf8'; 593no warnings 'utf8';
883 594
595sub parse_resource {
596 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
597
598 $name =~ y/-/./ if $isarg;
599
600 $term->scan_meta;
601
602 my $r = $term->{meta}{resource};
603 keys %$r; # reste iterator
604 while (my ($pattern, $v) = each %$r) {
605 if (
606 $pattern =~ /\.$/
607 ? $pattern eq substr $name, 0, length $pattern
608 : $pattern eq $name
609 ) {
610 $name = "$urxvt::RESCLASS.$name";
611
612 push @{ $term->{perl_ext_3} }, $v->[0];
613
614 if ($v->[1] eq "boolean") {
615 $term->put_option_db ($name, $flag ? "true" : "false");
616 return 1;
617 } else {
618 $term->put_option_db ($name, $value);
619 return 1 + 2;
620 }
621 }
622 }
623
624 0
625}
626
627sub usage {
628 my ($term, $usage_type) = @_;
629
630 $term->scan_meta;
631
632 my $r = $term->{meta}{resource};
633
634 for my $pattern (sort keys %$r) {
635 my ($ext, $type, $desc) = @{ $r->{$pattern} };
636
637 $desc .= " (-pe $ext)";
638
639 if ($usage_type == 1) {
640 $pattern =~ y/./-/;
641 $pattern =~ s/-$/-.../g;
642
643 if ($type eq "boolean") {
644 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
645 } else {
646 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
647 }
648 } else {
649 $pattern =~ s/\.$/.*/g;
650 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
651 }
652 }
653}
654
884my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 655my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
885 656
886sub verbose { 657sub verbose {
887 my ($level, $msg) = @_; 658 my ($level, $msg) = @_;
888 warn "$msg\n" if $level <= $verbosity; 659 warn "$msg\n" if $level <= $verbosity;
900 $pkg =~ s/[^[:word:]]/_/g; 671 $pkg =~ s/[^[:word:]]/_/g;
901 $pkg = "urxvt::ext::$pkg"; 672 $pkg = "urxvt::ext::$pkg";
902 673
903 verbose 3, "loading extension '$path' into package '$pkg'"; 674 verbose 3, "loading extension '$path' into package '$pkg'";
904 675
676 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
677
905 open my $fh, "<:raw", $path 678 open my $fh, "<:raw", $path
906 or die "$path: $!"; 679 or die "$path: $!";
907 680
908 my $source = 681 my $source =
909 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 682 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
910 . "#line 1 \"$path\"\n{\n" 683 . "#line 1 \"$path\"\n{\n"
911 . (do { local $/; <$fh> }) 684 . (do { local $/; <$fh> })
912 . "\n};\n1"; 685 . "\n};\n1";
913 686
914 eval $source 687 eval $source
924sub invoke { 697sub invoke {
925 local $TERM = shift; 698 local $TERM = shift;
926 my $htype = shift; 699 my $htype = shift;
927 700
928 if ($htype == 0) { # INIT 701 if ($htype == 0) { # INIT
929 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 702 my @dirs = $TERM->perl_libdirs;
930 703
931 my %ext_arg; 704 my %ext_arg;
932 705
933 { 706 {
934 my @init = @TERM_INIT; 707 my @init = @TERM_INIT;
935 @TERM_INIT = (); 708 @TERM_INIT = ();
937 my @pkg = @TERM_EXT; 710 my @pkg = @TERM_EXT;
938 @TERM_EXT = (); 711 @TERM_EXT = ();
939 $TERM->register_package ($_) for @pkg; 712 $TERM->register_package ($_) for @pkg;
940 } 713 }
941 714
715 for (
716 @{ delete $TERM->{perl_ext_3} },
942 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 717 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718 ) {
943 if ($_ eq "default") { 719 if ($_ eq "default") {
944 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 720 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
945 } elsif (/^-(.*)$/) { 721 } elsif (/^-(.*)$/) {
946 delete $ext_arg{$1}; 722 delete $ext_arg{$1};
947 } elsif (/^([^<]+)<(.*)>$/) { 723 } elsif (/^([^<]+)<(.*)>$/) {
970 if (my $cb = $TERM->{_hook}[$htype]) { 746 if (my $cb = $TERM->{_hook}[$htype]) {
971 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 747 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
972 if $verbosity >= 10; 748 if $verbosity >= 10;
973 749
974 for my $pkg (keys %$cb) { 750 for my $pkg (keys %$cb) {
975 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 751 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
976 $retval ||= $retval_; 752 $retval ||= $retval_;
977 753
978 if ($@) { 754 if ($@) {
979 $TERM->ungrab; # better to lose the grab than the session 755 $TERM->ungrab; # better to lose the grab than the session
980 warn $@; 756 warn $@;
1023 } 799 }
1024 } 800 }
1025 ($mask, @color{qw(fg bg)}, \@failed) 801 ($mask, @color{qw(fg bg)}, \@failed)
1026} 802}
1027 803
1028# urxvt::term::extension
1029
1030package urxvt::term::extension; 804package urxvt::term::extension;
1031 805
1032sub enable { 806sub enable {
1033 my ($self, %hook) = @_; 807 my ($self, %hook) = @_;
1034 my $pkg = $self->{_pkg}; 808 my $pkg = $self->{_pkg};
1088 862
1089sub urxvt::destroy_hook(&) { 863sub urxvt::destroy_hook(&) {
1090 bless \shift, urxvt::destroy_hook:: 864 bless \shift, urxvt::destroy_hook::
1091} 865}
1092 866
867sub x_resource {
868 my ($self, $name) = @_;
869 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
870 $self->{term}->x_resource ($name)
871}
872
873sub x_resource_boolean {
874 my ($self, $name) = @_;
875 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
876 $self->{term}->x_resource_boolean ($name)
877}
878
1093package urxvt::anyevent; 879package urxvt::anyevent;
1094 880
1095=head2 The C<urxvt::anyevent> Class 881=head2 The C<urxvt::anyevent> Class
1096 882
1097The sole purpose of this class is to deliver an interface to the 883The sole purpose of this class is to deliver an interface to the
1098C<AnyEvent> module - any module using it will work inside urxvt without 884C<AnyEvent> module - any module using it will work inside urxvt without
1099further programming. The only exception is that you cannot wait on 885further programming. The only exception is that you cannot wait on
1100condition variables, but non-blocking condvar use is ok. What this means 886condition variables, but non-blocking condvar use is ok.
1101is that you cannot use blocking APIs, but the non-blocking variant should 887
1102work. 888In practical terms this means is that you cannot use blocking APIs, but
889the non-blocking variant should work.
1103 890
1104=cut 891=cut
1105 892
1106our $VERSION = 1; 893our $VERSION = '5.23';
1107 894
1108$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 895$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1109push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 896push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1110 897
1111sub timer { 898sub timer {
1113 900
1114 my $cb = $arg{cb}; 901 my $cb = $arg{cb};
1115 902
1116 urxvt::timer 903 urxvt::timer
1117 ->new 904 ->new
1118 ->start (urxvt::NOW + $arg{after}) 905 ->after ($arg{after}, $arg{interval})
1119 ->cb (sub { 906 ->cb ($arg{interval} ? $cb : sub {
1120 $_[0]->stop; # need to cancel manually 907 $_[0]->stop; # need to cancel manually
1121 $cb->(); 908 $cb->();
1122 }) 909 })
1123} 910}
1124 911
1125sub io { 912sub io {
1126 my ($class, %arg) = @_; 913 my ($class, %arg) = @_;
1127 914
1128 my $cb = $arg{cb}; 915 my $cb = $arg{cb};
916 my $fd = fileno $arg{fh};
917 defined $fd or $fd = $arg{fh};
1129 918
1130 bless [$arg{fh}, urxvt::iow 919 bless [$arg{fh}, urxvt::iow
1131 ->new 920 ->new
1132 ->fd (fileno $arg{fh}) 921 ->fd ($fd)
1133 ->events (($arg{poll} =~ /r/ ? 1 : 0) 922 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1134 | ($arg{poll} =~ /w/ ? 2 : 0)) 923 | ($arg{poll} =~ /w/ ? 2 : 0))
1135 ->start 924 ->start
1136 ->cb (sub { 925 ->cb ($cb)
1137 $cb->(($_[1] & 1 ? 'r' : '')
1138 . ($_[1] & 2 ? 'w' : ''));
1139 })],
1140 urxvt::anyevent:: 926 ], urxvt::anyevent::
927}
928
929sub idle {
930 my ($class, %arg) = @_;
931
932 my $cb = $arg{cb};
933
934 urxvt::iw
935 ->new
936 ->start
937 ->cb ($cb)
938}
939
940sub child {
941 my ($class, %arg) = @_;
942
943 my $cb = $arg{cb};
944
945 urxvt::pw
946 ->new
947 ->start ($arg{pid})
948 ->cb (sub {
949 $_[0]->stop; # need to cancel manually
950 $cb->($_[0]->rpid, $_[0]->rstatus);
951 })
1141} 952}
1142 953
1143sub DESTROY { 954sub DESTROY {
1144 $_[0][1]->stop; 955 $_[0][1]->stop;
1145} 956}
1146 957
1147sub condvar { 958# only needed for AnyEvent < 6 compatibility
1148 bless \my $flag, urxvt::anyevent::
1149}
1150
1151sub broadcast {
1152 ${$_[0]}++;
1153}
1154
1155sub wait {
1156 unless (${$_[0]}) {
1157 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1158 }
1159}
1160
1161sub one_event { 959sub one_event {
1162 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 960 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1163} 961}
1164 962
1165package urxvt::term; 963package urxvt::term;
1180 urxvt::verbose 6, "register package $pkg to $self"; 978 urxvt::verbose 6, "register package $pkg to $self";
1181 979
1182 @{"$pkg\::ISA"} = urxvt::term::extension::; 980 @{"$pkg\::ISA"} = urxvt::term::extension::;
1183 981
1184 my $proxy = bless { 982 my $proxy = bless {
1185 _pkg => $pkg, 983 _pkg => $pkg,
984 _name => ${"$pkg\::_NAME"}, # hackish
1186 argv => $argv, 985 argv => $argv,
1187 }, $pkg; 986 }, $pkg;
1188 Scalar::Util::weaken ($proxy->{term} = $self); 987 Scalar::Util::weaken ($proxy->{term} = $self);
1189 988
1190 $self->{_pkg}{$pkg} = $proxy; 989 $self->{_pkg}{$pkg} = $proxy;
1191 990
1194 $proxy->enable ($name => $ref); 993 $proxy->enable ($name => $ref);
1195 } 994 }
1196 } 995 }
1197} 996}
1198 997
998sub perl_libdirs {
999 map { split /:/ }
1000 $_[0]->resource ("perl_lib"),
1001 $ENV{URXVT_PERL_LIB},
1002 "$ENV{HOME}/.urxvt/ext",
1003 "$LIBDIR/perl"
1004}
1005
1006sub scan_meta {
1007 my ($self) = @_;
1008 my @libdirs = perl_libdirs $self;
1009
1010 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1011
1012 my %meta;
1013
1014 $self->{meta_libdirs} = join "\x00", @libdirs;
1015 $self->{meta} = \%meta;
1016
1017 for my $dir (reverse @libdirs) {
1018 opendir my $fh, $dir
1019 or next;
1020 for my $ext (readdir $fh) {
1021 $ext ne "."
1022 and $ext ne ".."
1023 and open my $fh, "<", "$dir/$ext"
1024 or next;
1025
1026 while (<$fh>) {
1027 if (/^#:META:X_RESOURCE:(.*)/) {
1028 my ($pattern, $type, $desc) = split /:/, $1;
1029 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1030 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1031 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1032 } else {
1033 $meta{resource}{$pattern} = [$ext, $type, $desc];
1034 }
1035 } elsif (/^\s*(?:#|$)/) {
1036 # skip other comments and empty lines
1037 } else {
1038 last; # stop parsing on first non-empty non-comment line
1039 }
1040 }
1041 }
1042 }
1043}
1044
1199=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1045=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1200 1046
1201Creates a new terminal, very similar as if you had started it with system 1047Creates a new terminal, very similar as if you had started it with system
1202C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1048C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1203hash which defines the environment of the new terminal. 1049hash which defines the environment of the new terminal.
1223 1069
1224Destroy the terminal object (close the window, free resources 1070Destroy the terminal object (close the window, free resources
1225etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1071etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1226watchers (timers, io watchers) are still active. 1072watchers (timers, io watchers) are still active.
1227 1073
1074=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
1075
1076Similar to the extension method C<enable>, but installs additional
1077callbacks for the given hook(s) (existing ones are not replaced), and
1078returns a guard object. When the guard object is destroyed the callbacks
1079are disabled again.
1080
1081Note that these callbacks receive the normal parameters, but the first
1082argument (normally the extension) is currently undefined.
1083
1084=cut
1085
1086sub urxvt::term::on_disable::DESTROY {
1087 my $disable = shift;
1088
1089 my $self = delete $disable->{""};
1090
1091 while (my ($htype, $id) = each %$disable) {
1092 delete $self->{_hook}[$htype]{$id};
1093 $self->set_should_invoke ($htype, -1);
1094 }
1095}
1096
1097sub on {
1098 my ($self, %hook) = @_;
1099
1100 my %disable = ( "" => $self );
1101
1102 while (my ($name, $cb) = each %hook) {
1103 my $htype = $HOOKTYPE{uc $name};
1104 defined $htype
1105 or Carp::croak "unsupported hook type '$name'";
1106
1107 my $id = $cb+0;
1108
1109 $self->set_should_invoke ($htype, +1);
1110 $disable{$htype} = $id;
1111 $self->{_hook}[$htype]{$id} = $cb;
1112 }
1113
1114 bless \%disable, "urxvt::term::on_disable"
1115}
1116
1228=item $term->exec_async ($cmd[, @args]) 1117=item $term->exec_async ($cmd[, @args])
1229 1118
1230Works like the combination of the C<fork>/C<exec> builtins, which executes 1119Works like the combination of the C<fork>/C<exec> builtins, which executes
1231("starts") programs in the background. This function takes care of setting 1120("starts") programs in the background. This function takes care of setting
1232the user environment before exec'ing the command (e.g. C<PATH>) and should 1121the user environment before exec'ing the command (e.g. C<PATH>) and should
1257C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1146C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1258 1147
1259Here is a likely non-exhaustive list of option names, please see the 1148Here is a likely non-exhaustive list of option names, please see the
1260source file F</src/optinc.h> to see the actual list: 1149source file F</src/optinc.h> to see the actual list:
1261 1150
1262 borderLess console cursorBlink cursorUnderline hold iconic insecure 1151 borderLess buffered console cursorBlink cursorUnderline hold iconic
1263 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1152 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1153 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1265 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1154 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1155 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267 transparent tripleclickwords utmpInhibit visualBell 1156 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1157 urgentOnBell utmpInhibit visualBell
1268 1158
1269=item $value = $term->resource ($name[, $newval]) 1159=item $value = $term->resource ($name[, $newval])
1270 1160
1271Returns the current resource value associated with a given name and 1161Returns the current resource value associated with a given name and
1272optionally sets a new value. Setting values is most useful in the C<init> 1162optionally sets a new value. Setting values is most useful in the C<init>
1285 1175
1286Here is a likely non-exhaustive list of resource names, not all of which 1176Here is a likely non-exhaustive list of resource names, not all of which
1287are supported in every build, please see the source file F</src/rsinc.h> 1177are supported in every build, please see the source file F</src/rsinc.h>
1288to see the actual list: 1178to see the actual list:
1289 1179
1290 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1180 answerbackstring backgroundPixmap backspace_key blurradius
1291 borderLess color cursorBlink cursorUnderline cutchars delete_key 1181 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1292 display_name embed ext_bwidth fade font geometry hold iconName 1182 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1293 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1183 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1184 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1294 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1185 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1295 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1186 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1296 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1187 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1297 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1188 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1298 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1189 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1299 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1190 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1300 secondaryScreen secondaryScroll selectstyle shade term_name title 1191 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1301 transient_for transparent transparent_all tripleclickwords utmpInhibit 1192 term_name title transient_for transparent tripleclickwords urgentOnBell
1302 visualBell 1193 utmpInhibit visualBell
1303 1194
1304=cut 1195=cut
1305 1196
1306sub resource($$;$) { 1197sub resource($$;$) {
1307 my ($self, $name) = (shift, shift); 1198 my ($self, $name) = (shift, shift);
1308 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1199 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1309 &urxvt::term::_resource 1200 goto &urxvt::term::_resource
1310} 1201}
1311 1202
1312=item $value = $term->x_resource ($pattern) 1203=item $value = $term->x_resource ($pattern)
1313 1204
1314Returns the X-Resource for the given pattern, excluding the program or 1205Returns the X-Resource for the given pattern, excluding the program or
1315class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1206class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1316same value as used by this instance of rxvt-unicode. Returns C<undef> if no 1207same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1317resource with that pattern exists. 1208resource with that pattern exists.
1318 1209
1210Extensions that define extra resource or command line arguments also need
1211to call this method to access their values.
1212
1213If the method is called on an extension object (basically, from an
1214extension), then the special prefix C<%.> will be replaced by the name of
1215the extension and a dot, and the lone string C<%> will be replaced by the
1216extension name itself. This makes it possible to code extensions so you
1217can rename them and get a new set of commandline switches and resources
1218without having to change the actual code.
1219
1319This method should only be called during the C<on_start> hook, as there is 1220This method should only be called during the C<on_start> hook, as there is
1320only one resource database per display, and later invocations might return 1221only one resource database per display, and later invocations might return
1321the wrong resources. 1222the wrong resources.
1322 1223
1323=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1224=item $value = $term->x_resource_boolean ($pattern)
1324 1225
1226Like C<x_resource>, above, but interprets the string value as a boolean
1227and returns C<1> for true values, C<0> for false values and C<undef> if
1228the resource or option isn't specified.
1229
1230You should always use this method to parse boolean resources.
1231
1232=cut
1233
1234sub x_resource_boolean {
1235 my $res = &x_resource;
1236
1237 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1238}
1239
1240=item $success = $term->parse_keysym ($key, $octets)
1241
1325Adds a keymap translation exactly as specified via a resource. See the 1242Adds a key binding exactly as specified via a resource. See the
1326C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1243C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1244
1245=item $term->register_command ($keysym, $modifiermask, $string)
1246
1247Adds a key binding. This is a lower level api compared to
1248C<parse_keysym>, as it expects a parsed key description, and can be
1249used only inside either the C<on_init> hook, to add a binding, or the
1250C<on_register_command> hook, to modify a parsed binding.
1327 1251
1328=item $rend = $term->rstyle ([$new_rstyle]) 1252=item $rend = $term->rstyle ([$new_rstyle])
1329 1253
1330Return and optionally change the current rendition. Text that is output by 1254Return and optionally change the current rendition. Text that is output by
1331the terminal application will use this style. 1255the terminal application will use this style.
1339 1263
1340=item ($row, $col) = $term->selection_beg ([$row, $col]) 1264=item ($row, $col) = $term->selection_beg ([$row, $col])
1341 1265
1342=item ($row, $col) = $term->selection_end ([$row, $col]) 1266=item ($row, $col) = $term->selection_end ([$row, $col])
1343 1267
1344Return the current values of the selection mark, begin or end positions, 1268Return the current values of the selection mark, begin or end positions.
1345and optionally set them to new values. 1269
1270When arguments are given, then the selection coordinates are set to
1271C<$row> and C<$col>, and the selection screen is set to the current
1272screen.
1273
1274=item $screen = $term->selection_screen ([$screen])
1275
1276Returns the current selection screen, and then optionally sets it.
1346 1277
1347=item $term->selection_make ($eventtime[, $rectangular]) 1278=item $term->selection_make ($eventtime[, $rectangular])
1348 1279
1349Tries to make a selection as set by C<selection_beg> and 1280Tries to make a selection as set by C<selection_beg> and
1350C<selection_end>. If C<$rectangular> is true (default: false), a 1281C<selection_end>. If C<$rectangular> is true (default: false), a
1351rectangular selection will be made. This is the prefered function to make 1282rectangular selection will be made. This is the preferred function to make
1352a selection. 1283a selection.
1353 1284
1354=item $success = $term->selection_grab ($eventtime) 1285=item $success = $term->selection_grab ($eventtime[, $clipboard])
1355 1286
1356Try to request the primary selection text from the server (for example, as 1287Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1288true) selection from the server. The corresponding text can be set
1357set by the next method). No visual feedback will be given. This function 1289with the next method. No visual feedback will be given. This function
1358is mostly useful from within C<on_sel_grab> hooks. 1290is mostly useful from within C<on_sel_grab> hooks.
1359 1291
1360=item $oldtext = $term->selection ([$newtext]) 1292=item $oldtext = $term->selection ([$newtext, $clipboard])
1361 1293
1362Return the current selection text and optionally replace it by C<$newtext>. 1294Return the current selection (clipboard if C<$clipboard> is true) text
1295and optionally replace it by C<$newtext>.
1296
1297=item $term->selection_clear ([$clipboard])
1298
1299Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1363 1300
1364=item $term->overlay_simple ($x, $y, $text) 1301=item $term->overlay_simple ($x, $y, $text)
1365 1302
1366Create a simple multi-line overlay box. See the next method for details. 1303Create a simple multi-line overlay box. See the next method for details.
1367 1304
1397 1334
1398The methods currently supported on C<urxvt::overlay> objects are: 1335The methods currently supported on C<urxvt::overlay> objects are:
1399 1336
1400=over 4 1337=over 4
1401 1338
1402=item $overlay->set ($x, $y, $text, $rend) 1339=item $overlay->set ($x, $y, $text[, $rend])
1403 1340
1404Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1341Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1405text in rxvt-unicode's special encoding and an array of rendition values 1342text in rxvt-unicode's special encoding and an array of rendition values
1406at a specific position inside the overlay. 1343at a specific position inside the overlay.
1344
1345If C<$rend> is missing, then the rendition will not be changed.
1407 1346
1408=item $overlay->hide 1347=item $overlay->hide
1409 1348
1410If visible, hide the overlay, but do not destroy it. 1349If visible, hide the overlay, but do not destroy it.
1411 1350
1493locale-specific encoding of the terminal and can contain command sequences 1432locale-specific encoding of the terminal and can contain command sequences
1494(escape codes) that will be interpreted. 1433(escape codes) that will be interpreted.
1495 1434
1496=item $term->tt_write ($octets) 1435=item $term->tt_write ($octets)
1497 1436
1498Write the octets given in C<$data> to the tty (i.e. as program input). To 1437Write the octets given in C<$octets> to the tty (i.e. as program input). To
1499pass characters instead of octets, you should convert your strings first 1438pass characters instead of octets, you should convert your strings first
1500to the locale-specific encoding using C<< $term->locale_encode >>. 1439to the locale-specific encoding using C<< $term->locale_encode >>.
1440
1441=item $term->tt_paste ($octets)
1442
1443Write the octets given in C<$octets> to the tty as a paste, converting NL to
1444CR and bracketing the data with control sequences if bracketed paste mode
1445is set.
1501 1446
1502=item $old_events = $term->pty_ev_events ([$new_events]) 1447=item $old_events = $term->pty_ev_events ([$new_events])
1503 1448
1504Replaces the event mask of the pty watcher by the given event mask. Can 1449Replaces the event mask of the pty watcher by the given event mask. Can
1505be used to suppress input and output handling to the pty/tty. See the 1450be used to suppress input and output handling to the pty/tty. See the
1524Adds the specified events to the vt event mask. Useful e.g. when you want 1469Adds the specified events to the vt event mask. Useful e.g. when you want
1525to receive pointer events all the times: 1470to receive pointer events all the times:
1526 1471
1527 $term->vt_emask_add (urxvt::PointerMotionMask); 1472 $term->vt_emask_add (urxvt::PointerMotionMask);
1528 1473
1474=item $term->set_urgency ($set)
1475
1476Enable/disable the urgency hint on the toplevel window.
1477
1529=item $term->focus_in 1478=item $term->focus_in
1530 1479
1531=item $term->focus_out 1480=item $term->focus_out
1532 1481
1533=item $term->key_press ($state, $keycode[, $time]) 1482=item $term->key_press ($state, $keycode[, $time])
1621 1570
1622Used after changing terminal contents to display them. 1571Used after changing terminal contents to display them.
1623 1572
1624=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1573=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1625 1574
1626Returns the text of the entire row with number C<$row_number>. Row C<0> 1575Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1627is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1576is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1628terminal line. The scrollback buffer starts at line C<-1> and extends to
1629line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1577terminal line. Nothing will be returned if a nonexistent line
1630is requested. 1578is requested.
1631 1579
1632If C<$new_text> is specified, it will replace characters in the current 1580If C<$new_text> is specified, it will replace characters in the current
1633line, starting at column C<$start_col> (default C<0>), which is useful 1581line, starting at column C<$start_col> (default C<0>), which is useful
1634to replace only parts of a line. The font index in the rendition will 1582to replace only parts of a line. The font index in the rendition will
1635automatically be updated. 1583automatically be updated.
1636 1584
1637C<$text> is in a special encoding: tabs and wide characters that use more 1585C<$text> is in a special encoding: tabs and wide characters that use more
1638than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1586than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1639characters. Characters with combining characters and other characters that 1587characters. Characters with combining characters and other characters that
1640do not fit into the normal tetx encoding will be replaced with characters 1588do not fit into the normal text encoding will be replaced with characters
1641in the private use area. 1589in the private use area.
1642 1590
1643You have to obey this encoding when changing text. The advantage is 1591You have to obey this encoding when changing text. The advantage is
1644that C<substr> and similar functions work on screen cells and not on 1592that C<substr> and similar functions work on screen cells and not on
1645characters. 1593characters.
1820Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1768Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1821recent grab. 1769recent grab.
1822 1770
1823=item $term->ungrab 1771=item $term->ungrab
1824 1772
1825Calls XUngrab for the most recent grab. Is called automatically on 1773Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1826evaluation errors, as it is better to lose the grab in the error case as 1774evaluation errors, as it is better to lose the grab in the error case as
1827the session. 1775the session.
1828 1776
1829=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1777=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1830 1778
1832 1780
1833=item @atoms = $term->XListProperties ($window) 1781=item @atoms = $term->XListProperties ($window)
1834 1782
1835=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1783=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1836 1784
1837=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1785=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1838 1786
1839=item $term->XDeleteProperty ($window, $property) 1787=item $term->XDeleteProperty ($window, $property)
1840 1788
1841=item $window = $term->DefaultRootWindow 1789=item $window = $term->DefaultRootWindow
1842 1790
1849=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1797=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1850 1798
1851=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1799=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1852 1800
1853=item $term->XChangeInput ($window, $add_events[, $del_events]) 1801=item $term->XChangeInput ($window, $add_events[, $del_events])
1802
1803=item $keysym = $term->XStringToKeysym ($string)
1804
1805=item $string = $term->XKeysymToString ($keysym)
1854 1806
1855Various X or X-related functions. The C<$term> object only serves as 1807Various X or X-related functions. The C<$term> object only serves as
1856the source of the display, otherwise those functions map more-or-less 1808the source of the display, otherwise those functions map more-or-less
1857directory onto the X functions of the same name. 1809directly onto the X functions of the same name.
1858 1810
1859=back 1811=back
1860 1812
1861=cut 1813=cut
1862 1814
1964 my $env = $self->{term}->env; 1916 my $env = $self->{term}->env;
1965 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1917 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1966 delete $env->{LC_ALL}; 1918 delete $env->{LC_ALL};
1967 $env->{LC_CTYPE} = $self->{term}->locale; 1919 $env->{LC_CTYPE} = $self->{term}->locale;
1968 1920
1969 urxvt::term->new ($env, "popup", 1921 my $term = urxvt::term->new (
1922 $env, "popup",
1970 "--perl-lib" => "", "--perl-ext-common" => "", 1923 "--perl-lib" => "", "--perl-ext-common" => "",
1971 "-pty-fd" => -1, "-sl" => 0, 1924 "-pty-fd" => -1, "-sl" => 0,
1972 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1925 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1973 "--transient-for" => $self->{term}->parent, 1926 "--transient-for" => $self->{term}->parent,
1974 "-display" => $self->{term}->display_id, 1927 "-display" => $self->{term}->display_id,
1975 "-pe" => "urxvt-popup") 1928 "-pe" => "urxvt-popup",
1976 or die "unable to create popup window\n"; 1929 ) or die "unable to create popup window\n";
1930
1931 unless (delete $term->{urxvt_popup_init_done}) {
1932 $term->ungrab;
1933 $term->destroy;
1934 die "unable to initialise popup window\n";
1935 }
1977} 1936}
1978 1937
1979sub DESTROY { 1938sub DESTROY {
1980 my ($self) = @_; 1939 my ($self) = @_;
1981 1940
1999 ->new 1958 ->new
2000 ->interval (1) 1959 ->interval (1)
2001 ->cb (sub { 1960 ->cb (sub {
2002 $term->{overlay}->set (0, 0, 1961 $term->{overlay}->set (0, 0,
2003 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1962 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2004 }); 1963 });
2005 1964
2006=over 4 1965=over 4
2007 1966
2008=item $timer = new urxvt::timer 1967=item $timer = new urxvt::timer
2009 1968
2012 1971
2013=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1972=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2014 1973
2015Set the callback to be called when the timer triggers. 1974Set the callback to be called when the timer triggers.
2016 1975
2017=item $tstamp = $timer->at
2018
2019Return the time this watcher will fire next.
2020
2021=item $timer = $timer->set ($tstamp) 1976=item $timer = $timer->set ($tstamp[, $interval])
2022 1977
2023Set the time the event is generated to $tstamp. 1978Set the time the event is generated to $tstamp (and optionally specifies a
1979new $interval).
2024 1980
2025=item $timer = $timer->interval ($interval) 1981=item $timer = $timer->interval ($interval)
2026 1982
2027Normally (and when C<$interval> is C<0>), the timer will automatically 1983By default (and when C<$interval> is C<0>), the timer will automatically
2028stop after it has fired once. If C<$interval> is non-zero, then the timer 1984stop after it has fired once. If C<$interval> is non-zero, then the timer
2029is automatically rescheduled at the given intervals. 1985is automatically rescheduled at the given intervals.
2030 1986
2031=item $timer = $timer->start 1987=item $timer = $timer->start
2032 1988
2033Start the timer. 1989Start the timer.
2034 1990
2035=item $timer = $timer->start ($tstamp) 1991=item $timer = $timer->start ($tstamp[, $interval])
2036 1992
2037Set the event trigger time to C<$tstamp> and start the timer. 1993Set the event trigger time to C<$tstamp> and start the timer. Optionally
1994also replaces the interval.
2038 1995
2039=item $timer = $timer->after ($delay) 1996=item $timer = $timer->after ($delay[, $interval])
2040 1997
2041Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 1998Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2042 1999
2043=item $timer = $timer->stop 2000=item $timer = $timer->stop
2044 2001
2052 2009
2053 $term->{socket} = ... 2010 $term->{socket} = ...
2054 $term->{iow} = urxvt::iow 2011 $term->{iow} = urxvt::iow
2055 ->new 2012 ->new
2056 ->fd (fileno $term->{socket}) 2013 ->fd (fileno $term->{socket})
2057 ->events (urxvt::EVENT_READ) 2014 ->events (urxvt::EV_READ)
2058 ->start 2015 ->start
2059 ->cb (sub { 2016 ->cb (sub {
2060 my ($iow, $revents) = @_; 2017 my ($iow, $revents) = @_;
2061 # $revents must be 1 here, no need to check 2018 # $revents must be 1 here, no need to check
2062 sysread $term->{socket}, my $buf, 8192 2019 sysread $term->{socket}, my $buf, 8192
2080Set the file descriptor (not handle) to watch. 2037Set the file descriptor (not handle) to watch.
2081 2038
2082=item $iow = $iow->events ($eventmask) 2039=item $iow = $iow->events ($eventmask)
2083 2040
2084Set the event mask to watch. The only allowed values are 2041Set the event mask to watch. The only allowed values are
2085C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2042C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2086together, or C<urxvt::EVENT_NONE>. 2043together, or C<urxvt::EV_NONE>.
2087 2044
2088=item $iow = $iow->start 2045=item $iow = $iow->start
2089 2046
2090Start watching for requested events on the given handle. 2047Start watching for requested events on the given handle.
2091 2048
2132 ->new 2089 ->new
2133 ->start ($pid) 2090 ->start ($pid)
2134 ->cb (sub { 2091 ->cb (sub {
2135 my ($pw, $exit_status) = @_; 2092 my ($pw, $exit_status) = @_;
2136 ... 2093 ...
2137 }); 2094 });
2138 2095
2139=over 4 2096=over 4
2140 2097
2141=item $pw = new urxvt::pw 2098=item $pw = new urxvt::pw
2142 2099
2175 2132
2176=back 2133=back
2177 2134
2178=head1 AUTHOR 2135=head1 AUTHOR
2179 2136
2180 Marc Lehmann <pcg@goof.com> 2137 Marc Lehmann <schmorp@schmorp.de>
2181 http://software.schmorp.de/pkg/rxvt-unicode 2138 http://software.schmorp.de/pkg/rxvt-unicode
2182 2139
2183=cut 2140=cut
2184 2141
21851 21421

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines