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.153 by root, Sat Jun 2 05:23:11 2007 UTC vs.
Revision 1.220 by root, Tue Jun 19 18:17:56 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"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36A number of extensions are delivered with this release. You can find them
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37in F<@@RXVT_LIBDIR@@/urxvt/perl/>, and the documentation can be viewed
38using F<< man urxvt-<EXTENSIONNAME> >>.
35 39
36You can activate them like this: 40You can activate them like this:
37 41
38 @@RXVT_NAME@@ -pe <extensionname> 42 @@RXVT_NAME@@ -pe <extensionname>
39 43
40Or by adding them to the resource for extensions loaded by default: 44Or by adding them to the resource for extensions loaded by default:
41 45
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 46 URxvt.perl-ext-common: default,selection-autotransform
43 47
44=over 4 48Extensions that add command line parameters or resources on their own are
45 49loaded automatically when used.
46=item selection (enabled by default)
47
48(More) intelligent selection. This extension tries to be more intelligent
49when the user extends selections (double-click and further clicks). Right
50now, it tries to select words, urls and complete shell-quoted
51arguments, which is very convenient, too, if your F<ls> supports
52C<--quoting-style=shell>.
53
54A double-click usually selects the word under the cursor, further clicks
55will enlarge the selection.
56
57The selection works by trying to match a number of regexes and displaying
58them in increasing order of length. You can add your own regexes by
59specifying resources of the form:
60
61 URxvt.selection.pattern-0: perl-regex
62 URxvt.selection.pattern-1: perl-regex
63 ...
64
65The index number (0, 1...) must not have any holes, and each regex must
66contain at least one pair of capturing parentheses, which will be used for
67the match. For example, the following adds a regex that matches everything
68between two vertical bars:
69
70 URxvt.selection.pattern-0: \\|([^|]+)\\|
71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
79You can look at the source of the selection extension to see more
80interesting uses, such as parsing a line from beginning to end.
81
82This extension also offers following bindable keyboard commands:
83
84=over 4
85
86=item rot13
87
88Rot-13 the selection when activated. Used via keyboard trigger:
89
90 URxvt.keysym.C-M-r: perl:selection:rot13
91
92=back
93
94=item option-popup (enabled by default)
95
96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
97runtime.
98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code
105reference. The string will be used as button text and the code reference
106will be called when the toggle changes, with the new boolean value as
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
115
116=item selection-popup (enabled by default)
117
118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
119text into various other formats/action (such as uri unescaping, perl
120evaluation, web-browser starting etc.), depending on content.
121
122Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed.
125
126It's sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>.
131
132The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any
134C<a>s:
135
136 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g }
138 : ()
139 };
140
141=item searchable-scrollback<hotkey> (enabled by default)
142
143Adds regex search functionality to the scrollback buffer, triggered
144by a hotkey (default: C<M-s>). While in search mode, normal terminal
145input/output is suspended and a regex is displayed at the bottom of the
146screen.
147
148Inputting characters appends them to the regex and continues incremental
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary
154selection.
155
156The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix.
159
160See L<perlre> for more info about perl regular expression syntax.
161
162=item readline (enabled by default)
163
164A support package that tries to make editing with readline easier. At
165the moment, it reacts to clicking shift-left mouse button by trying to
166move the text cursor to this position. It does so by generating as many
167cursor-left or cursor-right keypresses as required (the this only works
168for programs that correctly support wide characters).
169
170To avoid too many false positives, this is only done when:
171
172=over 4
173
174=item - the tty is in ICANON state.
175
176=item - the text cursor is visible.
177
178=item - the primary screen is currently being displayed.
179
180=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182=back
183
184The normal selection mechanism isn't disabled, so quick successive clicks
185might interfere with selection creation in harmless ways.
186
187=item selection-autotransform
188
189This selection allows you to do automatic transforms on a selection
190whenever a selection is made.
191
192It works by specifying perl snippets (most useful is a single C<s///>
193operator) that modify C<$_> as resources:
194
195 URxvt.selection-autotransform.0: transform
196 URxvt.selection-autotransform.1: transform
197 ...
198
199For example, the following will transform selections of the form
200C<filename:number>, often seen in compiler messages, into C<vi +$filename
201$word>:
202
203 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
204
205And this example matches the same,but replaces it with vi-commands you can
206paste directly into your (vi :) editor:
207
208 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
209
210Of course, this can be modified to suit your needs and your editor :)
211
212To expand the example above to typical perl error messages ("XXX at
213FILENAME line YYY."), you need a slightly more elaborate solution:
214
215 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
216 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
217
218The first line tells the selection code to treat the unchanging part of
219every error message as a selection pattern, and the second line transforms
220the message into vi commands to load the file.
221
222=item tabbed
223
224This transforms the terminal into a tabbar with additional terminals, that
225is, it implements what is commonly referred to as "tabbed terminal". The topmost line
226displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227button per tab.
228
229Clicking a button will activate that tab. Pressing B<Shift-Left> and
230B<Shift-Right> will switch to the tab left or right of the current one,
231while B<Shift-Down> creates a new tab.
232
233The tabbar itself can be configured similarly to a normal terminal, but
234with a resource class of C<URxvt.tabbed>. In addition, it supports the
235following four resources (shown with defaults):
236
237 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239 URxvt.tabbed.tab-fg: <colour-index, default 0>
240 URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices.
244
245=item matcher
246
247Uses per-line display filtering (C<on_line_update>) to underline text
248matching a certain pattern and make it clickable. When clicked with the
249mouse button specified in the C<matcher.button> resource (default 2, or
250middle), the program specified in the C<matcher.launcher> resource
251(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
252with the matched text as first argument. The default configuration is
253suitable for matching URLs and launching a web browser, like the
254former "mark-urls" extension.
255
256The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis.
260
261Example configuration:
262
263 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser
265 URxvt.keysym.C-Delete: perl:matcher
266 URxvt.matcher.button: 1
267 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
268 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
269 URxvt.matcher.launcher.2: gvim +$2 $1
270
271=item xim-onthespot
272
273This (experimental) perl extension implements OnTheSpot editing. It does
274not work perfectly, and some input methods don't seem to work well with
275OnTheSpot editing in general, but it seems to work at leats for SCIM and
276kinput2.
277
278You enable it by specifying this extension and a preedit style of
279C<OnTheSpot>, i.e.:
280
281 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
282
283=item kuake<hotkey>
284
285A very primitive quake-console-like extension. It was inspired by a
286description of how the programs C<kuake> and C<yakuake> work: Whenever the
287user presses a global accelerator key (by default C<F10>), the terminal
288will show or hide itself. Another press of the accelerator key will hide
289or show it again.
290
291Initially, the window will not be shown when using this extension.
292
293This is useful if you need a single terminal thats not using any desktop
294space most of the time but is quickly available at the press of a key.
295
296The accelerator key is grabbed regardless of any modifiers, so this
297extension will actually grab a physical key just for this function.
298
299If you want a quake-like animation, tell your window manager to do so
300(fvwm can do it).
301
302=item automove-background
303
304This is basically a very small extension that dynamically changes the
305background pixmap offset to the window position, in effect creating the
306same effect as pseudo transparency with a custom pixmap. No scaling is
307supported in this mode. Example:
308
309 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310
311L<http://wiki.archlinux.org/index.php/Perl_Background_Rotation/Extensions>
312shows how this extension can be used to implement an automatically blurred
313transparent background.
314
315=item block-graphics-to-ascii
316
317A not very useful example of filtering all text output to the terminal
318by replacing all line-drawing characters (U+2500 .. U+259F) by a
319similar-looking ascii character.
320
321=item digital-clock
322
323Displays a digital clock using the built-in overlay.
324
325=item remote-clipboard
326
327Somewhat of a misnomer, this extension adds two menu entries to the
328selection popup that allows one ti run external commands to store the
329selection somewhere and fetch it again.
330
331We use it to implement a "distributed selection mechanism", which just
332means that one command uploads the file to a remote server, and another
333reads it.
334
335The commands can be set using the C<URxvt.remote-selection.store> and
336C<URxvt.remote-selection.fetch> resources. The first should read the
337selection to store from STDIN (always in UTF-8), the second should provide
338the selection data on STDOUT (also in UTF-8).
339
340The defaults (which are likely useless to you) use rsh and cat:
341
342 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
343 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
344
345=item selection-pastebin
346
347This is a little rarely useful extension that Uploads the selection as
348textfile to a remote site (or does other things). (The implementation is
349not currently secure for use in a multiuser environment as it writes to
350F</tmp> directly.).
351
352It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
353i.e.
354
355 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
356
357Pressing this combination runs a command with C<%> replaced by the name of
358the textfile. This command can be set via a resource:
359
360 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
361
362And the default is likely not useful to anybody but the few people around
363here :)
364
365The name of the textfile is the hex encoded md5 sum of the selection, so
366the same content should lead to the same filename.
367
368After a successful upload the selection will be replaced by the text given
369in the C<selection-pastebin-url> resource (again, the % is the placeholder
370for the filename):
371
372 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
373
374I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
375the double C</> characters as comment start. Use C<\057\057> instead,
376which works regardless of wether xrdb is used to parse the resource file
377or not.
378
379=item example-refresh-hooks
380
381Displays a very simple digital clock in the upper right corner of the
382window. Illustrates overwriting the refresh callbacks to create your own
383overlays or changes.
384
385=back
386 50
387=head1 API DOCUMENTATION 51=head1 API DOCUMENTATION
388 52
389=head2 General API Considerations 53=head2 General API Considerations
390 54
404 68
405=over 4 69=over 4
406 70
407=item $text 71=item $text
408 72
409Rxvt-unicodes special way of encoding text, where one "unicode" character 73Rxvt-unicode's special way of encoding text, where one "unicode" character
410always 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.
411 75
412=item $string 76=item $string
413 77
414A 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
418=item $octets 82=item $octets
419 83
420Either binary data or - more common - a text string encoded in a 84Either binary data or - more common - a text string encoded in a
421locale-specific way. 85locale-specific way.
422 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
423=back 93=back
424 94
425=head2 Extension Objects 95=head2 Extension Objects
426 96
427Every 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
428for 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,
429which 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
430their C<$self> object without having to think about clashes with other 100their C<$self> object without having to think about clashes with other
431extensions or other terminals, with the exception of methods and members 101extensions or other terminals, with the exception of methods and members
432that begin with an underscore character C<_>: these are reserved for 102that begin with an underscore character C<_>: these are reserved for
433internal use. 103internal use.
442=item $urxvt_term = $self->{term} 112=item $urxvt_term = $self->{term}
443 113
444Returns the C<urxvt::term> object associated with this instance of the 114Returns the C<urxvt::term> object associated with this instance of the
445extension. This member I<must not> be changed in any way. 115extension. This member I<must not> be changed in any way.
446 116
447=item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) 117=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
448 118
449Dynamically enable the given hooks (named without the C<on_> prefix) for 119Dynamically enable the given hooks (named without the C<on_> prefix) for
450this extension, replacing any previous hook. This is useful when you want 120this extension, replacing any previous hook. This is useful when you want
451to overwrite time-critical hooks only temporarily. 121to overwrite time-critical hooks only temporarily.
452 122
123To install additional callbacks for the same hook, you cna use the C<on>
124method of the C<urxvt::term> class.
125
453=item $self->disable ($hook_name[, $hook_name..]) 126=item $self->disable ($hook_name[, $hook_name..])
454 127
455Dynamically 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.
456 137
457=back 138=back
458 139
459=head2 Hooks 140=head2 Hooks
460 141
548 229
549It 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,
550$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
551number of lines that will be in the scrollback buffer. 232number of lines that will be in the scrollback buffer.
552 233
553=item on_osc_seq $term, $op, $args 234=item on_osc_seq $term, $op, $args, $resp
554 235
555Called 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
556behaviour. 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
557suppresses execution of the request completely. Make sure you don't get 238suppresses execution of the request completely. Make sure you don't get
558confused by recursive invocations when you output an osc sequence within 239confused by recursive invocations when you output an OSC sequence within
559this callback. 240this callback.
560 241
561C<on_osc_seq_perl> should be used for new behaviour. 242C<on_osc_seq_perl> should be used for new behaviour.
562 243
563=item on_osc_seq_perl $term, $string 244=item on_osc_seq_perl $term, $args, $resp
564 245
565Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 246Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
566operating system command) is processed. Cursor position and other state 247operating system command) is processed. Cursor position and other state
567information is up-to-date when this happens. For interoperability, the 248information is up-to-date when this happens. For interoperability, the
568string should start with the extension name and a colon, to distinguish 249string should start with the extension name (sans -osc) and a semicolon,
569it from commands for other extensions, and this might be enforced in the 250to distinguish it from commands for other extensions, and this might be
570future. 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 }
571 262
572Be 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,
573as 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
574other 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.
575 269
576=item on_add_lines $term, $string 270=item on_add_lines $term, $string
577 271
578Called 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
579can 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
584=item on_tt_write $term, $octets 278=item on_tt_write $term, $octets
585 279
586Called 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
587suppress or filter tty input. 281suppress or filter tty input.
588 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
589=item on_line_update $term, $row 290=item on_line_update $term, $row
590 291
591Called 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
592screen output (e.g. underline urls or other useless stuff). Only lines 293screen output (e.g. underline urls or other useless stuff). Only lines
593that are being shown will be filtered, and, due to performance reasons, 294that are being shown will be filtered, and, due to performance reasons,
600later 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
601you cannot just toggle rendition bits, but only set them. 302you cannot just toggle rendition bits, but only set them.
602 303
603=item on_refresh_begin $term 304=item on_refresh_begin $term
604 305
605Called just before the screen gets redrawn. Can be used for overlay 306Called just before the screen gets redrawn. Can be used for overlay or
606or similar effects by modify terminal contents in refresh_begin, and 307similar effects by modifying the terminal contents in refresh_begin, and
607restoring them in refresh_end. The built-in overlay and selection display 308restoring them in refresh_end. The built-in overlay and selection display
608code is run after this hook, and takes precedence. 309code is run after this hook, and takes precedence.
609 310
610=item on_refresh_end $term 311=item on_refresh_end $term
611 312
618resource in the @@RXVT_NAME@@(1) manpage). 319resource in the @@RXVT_NAME@@(1) manpage).
619 320
620The 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
621slightly in the future. 322slightly in the future.
622 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
623=item on_resize_all_windows $tern, $new_width, $new_height 331=item on_resize_all_windows $term, $new_width, $new_height
624 332
625Called just after the new window size has been calculated, but before 333Called just after the new window size has been calculated, but before
626windows 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
627returns TRUE, setting of the window hints is being skipped. 335returns TRUE, setting of the window hints is being skipped.
628 336
662 370
663=item on_map_notify $term, $event 371=item on_map_notify $term, $event
664 372
665=item on_unmap_notify $term, $event 373=item on_unmap_notify $term, $event
666 374
667Called whenever the corresponding X event is received for the terminal If 375Called whenever the corresponding X event is received for the terminal. If
668the 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.
669 377
670The 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
671manpage), 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
672(real, not screen-based) row and column under the mouse cursor. 380(real, not screen-based) row and column under the mouse cursor.
673 381
683=item on_wm_delete_window $term, $event 391=item on_wm_delete_window $term, $event
684 392
685Called when various types of ClientMessage events are received (all with 393Called when various types of ClientMessage events are received (all with
686format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 394format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
687 395
396=item on_bell $term
397
398Called on receipt of a bell character.
399
688=back 400=back
689 401
690=cut 402=cut
691 403
692package urxvt; 404package urxvt;
693 405
694use utf8; 406use utf8;
695use strict; 407use strict 'vars';
696use Carp (); 408use Carp ();
697use Scalar::Util (); 409use Scalar::Util ();
698use List::Util (); 410use List::Util ();
699 411
700our $VERSION = 1; 412our $VERSION = 1;
701our $TERM; 413our $TERM;
702our @TERM_INIT; 414our @TERM_INIT; # should go, prevents async I/O etc.
703our @TERM_EXT; 415our @TERM_EXT; # should go, prevents async I/O etc.
704our @HOOKNAME; 416our @HOOKNAME;
705our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 417our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
706our %OPTION; 418our %OPTION;
707 419
708our $LIBDIR; 420our $LIBDIR;
756 468
757=over 4 469=over 4
758 470
759=item urxvt::fatal $errormessage 471=item urxvt::fatal $errormessage
760 472
761Fatally aborts execution with the given error message. Avoid at all 473Fatally aborts execution with the given error message (which should
762costs! The only time this is acceptable is when the terminal process 474include a trailing newline). Avoid at all costs! The only time this
763starts up. 475is acceptable (and useful) is in the init hook, where it prevents the
476terminal from starting up.
764 477
765=item urxvt::warn $string 478=item urxvt::warn $string
766 479
767Calls 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
768newline. The module also overwrites the C<warn> builtin with a function 481newline. The module also overwrites the C<warn> builtin with a function
769that calls this function. 482that calls this function.
770 483
771Using 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
772correct place, e.g. on stderr of the connecting urxvtc client. 485correct place, e.g. on stderr of the connecting urxvtc client.
776=item @terms = urxvt::termlist 489=item @terms = urxvt::termlist
777 490
778Returns all urxvt::term objects that exist in this process, regardless of 491Returns all urxvt::term objects that exist in this process, regardless of
779whether they are started, being destroyed etc., so be careful. Only term 492whether they are started, being destroyed etc., so be careful. Only term
780objects that have perl extensions attached will be returned (because there 493objects that have perl extensions attached will be returned (because there
781is no urxvt::term objet associated with others). 494is no urxvt::term object associated with others).
782 495
783=item $time = urxvt::NOW 496=item $time = urxvt::NOW
784 497
785Returns the "current time" (as per the event loop). 498Returns the "current time" (as per the event loop).
786 499
829 542
830=item $rend = urxvt::OVERLAY_RSTYLE 543=item $rend = urxvt::OVERLAY_RSTYLE
831 544
832Return the rendition mask used for overlays by default. 545Return the rendition mask used for overlays by default.
833 546
834=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
835 549
836Return the bit that enabled bold, italic, blink, reverse-video and 550Return the bit that enabled bold, italic, blink, reverse-video and
837underline, respectively. To enable such a style, just logically OR it into 551underline, respectively. To enable such a style, just logically OR it into
838the bitset. 552the bitset.
839 553
876 }; 590 };
877} 591}
878 592
879no warnings 'utf8'; 593no warnings 'utf8';
880 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
881my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 655my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
882 656
883sub verbose { 657sub verbose {
884 my ($level, $msg) = @_; 658 my ($level, $msg) = @_;
885 warn "$msg\n" if $level <= $verbosity; 659 warn "$msg\n" if $level <= $verbosity;
897 $pkg =~ s/[^[:word:]]/_/g; 671 $pkg =~ s/[^[:word:]]/_/g;
898 $pkg = "urxvt::ext::$pkg"; 672 $pkg = "urxvt::ext::$pkg";
899 673
900 verbose 3, "loading extension '$path' into package '$pkg'"; 674 verbose 3, "loading extension '$path' into package '$pkg'";
901 675
676 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
677
902 open my $fh, "<:raw", $path 678 open my $fh, "<:raw", $path
903 or die "$path: $!"; 679 or die "$path: $!";
904 680
905 my $source = 681 my $source =
906 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 682 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
907 . "#line 1 \"$path\"\n{\n" 683 . "#line 1 \"$path\"\n{\n"
908 . (do { local $/; <$fh> }) 684 . (do { local $/; <$fh> })
909 . "\n};\n1"; 685 . "\n};\n1";
910 686
911 eval $source 687 eval $source
921sub invoke { 697sub invoke {
922 local $TERM = shift; 698 local $TERM = shift;
923 my $htype = shift; 699 my $htype = shift;
924 700
925 if ($htype == 0) { # INIT 701 if ($htype == 0) { # INIT
926 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 702 my @dirs = $TERM->perl_libdirs;
927 703
928 my %ext_arg; 704 my %ext_arg;
929 705
930 { 706 {
931 my @init = @TERM_INIT; 707 my @init = @TERM_INIT;
932 @TERM_INIT = (); 708 @TERM_INIT = ();
934 my @pkg = @TERM_EXT; 710 my @pkg = @TERM_EXT;
935 @TERM_EXT = (); 711 @TERM_EXT = ();
936 $TERM->register_package ($_) for @pkg; 712 $TERM->register_package ($_) for @pkg;
937 } 713 }
938 714
715 for (
716 @{ delete $TERM->{perl_ext_3} },
939 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 717 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718 ) {
940 if ($_ eq "default") { 719 if ($_ eq "default") {
941 $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);
942 } elsif (/^-(.*)$/) { 721 } elsif (/^-(.*)$/) {
943 delete $ext_arg{$1}; 722 delete $ext_arg{$1};
944 } elsif (/^([^<]+)<(.*)>$/) { 723 } elsif (/^([^<]+)<(.*)>$/) {
967 if (my $cb = $TERM->{_hook}[$htype]) { 746 if (my $cb = $TERM->{_hook}[$htype]) {
968 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 747 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
969 if $verbosity >= 10; 748 if $verbosity >= 10;
970 749
971 for my $pkg (keys %$cb) { 750 for my $pkg (keys %$cb) {
972 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 751 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
973 $retval ||= $retval_; 752 $retval ||= $retval_;
974 753
975 if ($@) { 754 if ($@) {
976 $TERM->ungrab; # better to lose the grab than the session 755 $TERM->ungrab; # better to lose the grab than the session
977 warn $@; 756 warn $@;
1020 } 799 }
1021 } 800 }
1022 ($mask, @color{qw(fg bg)}, \@failed) 801 ($mask, @color{qw(fg bg)}, \@failed)
1023} 802}
1024 803
1025# urxvt::term::extension
1026
1027package urxvt::term::extension; 804package urxvt::term::extension;
1028 805
1029sub enable { 806sub enable {
1030 my ($self, %hook) = @_; 807 my ($self, %hook) = @_;
1031 my $pkg = $self->{_pkg}; 808 my $pkg = $self->{_pkg};
1085 862
1086sub urxvt::destroy_hook(&) { 863sub urxvt::destroy_hook(&) {
1087 bless \shift, urxvt::destroy_hook:: 864 bless \shift, urxvt::destroy_hook::
1088} 865}
1089 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
1090package urxvt::anyevent; 879package urxvt::anyevent;
1091 880
1092=head2 The C<urxvt::anyevent> Class 881=head2 The C<urxvt::anyevent> Class
1093 882
1094The 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
1095C<AnyEvent> module - any module using it will work inside urxvt without 884C<AnyEvent> module - any module using it will work inside urxvt without
1096further programming. The only exception is that you cannot wait on 885further programming. The only exception is that you cannot wait on
1097condition variables, but non-blocking condvar use is ok. What this means 886condition variables, but non-blocking condvar use is ok.
1098is that you cannot use blocking APIs, but the non-blocking variant should 887
1099work. 888In practical terms this means is that you cannot use blocking APIs, but
889the non-blocking variant should work.
1100 890
1101=cut 891=cut
1102 892
1103our $VERSION = 1; 893our $VERSION = '5.23';
1104 894
1105$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 895$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1106push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 896push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1107 897
1108sub timer { 898sub timer {
1110 900
1111 my $cb = $arg{cb}; 901 my $cb = $arg{cb};
1112 902
1113 urxvt::timer 903 urxvt::timer
1114 ->new 904 ->new
1115 ->start (urxvt::NOW + $arg{after}) 905 ->after ($arg{after}, $arg{interval})
1116 ->cb (sub { 906 ->cb ($arg{interval} ? $cb : sub {
1117 $_[0]->stop; # need to cancel manually 907 $_[0]->stop; # need to cancel manually
1118 $cb->(); 908 $cb->();
1119 }) 909 })
1120} 910}
1121 911
1122sub io { 912sub io {
1123 my ($class, %arg) = @_; 913 my ($class, %arg) = @_;
1124 914
1125 my $cb = $arg{cb}; 915 my $cb = $arg{cb};
916 my $fd = fileno $arg{fh};
917 defined $fd or $fd = $arg{fh};
1126 918
1127 bless [$arg{fh}, urxvt::iow 919 bless [$arg{fh}, urxvt::iow
1128 ->new 920 ->new
1129 ->fd (fileno $arg{fh}) 921 ->fd ($fd)
1130 ->events (($arg{poll} =~ /r/ ? 1 : 0) 922 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1131 | ($arg{poll} =~ /w/ ? 2 : 0)) 923 | ($arg{poll} =~ /w/ ? 2 : 0))
1132 ->start 924 ->start
1133 ->cb (sub { 925 ->cb ($cb)
1134 $cb->(($_[1] & 1 ? 'r' : '')
1135 . ($_[1] & 2 ? 'w' : ''));
1136 })],
1137 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 })
1138} 952}
1139 953
1140sub DESTROY { 954sub DESTROY {
1141 $_[0][1]->stop; 955 $_[0][1]->stop;
1142} 956}
1143 957
1144sub condvar { 958# only needed for AnyEvent < 6 compatibility
1145 bless \my $flag, urxvt::anyevent::
1146}
1147
1148sub broadcast {
1149 ${$_[0]}++;
1150}
1151
1152sub wait {
1153 unless (${$_[0]}) {
1154 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1155 }
1156}
1157
1158sub one_event { 959sub one_event {
1159 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";
1160} 961}
1161 962
1162package urxvt::term; 963package urxvt::term;
1177 urxvt::verbose 6, "register package $pkg to $self"; 978 urxvt::verbose 6, "register package $pkg to $self";
1178 979
1179 @{"$pkg\::ISA"} = urxvt::term::extension::; 980 @{"$pkg\::ISA"} = urxvt::term::extension::;
1180 981
1181 my $proxy = bless { 982 my $proxy = bless {
1182 _pkg => $pkg, 983 _pkg => $pkg,
984 _name => ${"$pkg\::_NAME"}, # hackish
1183 argv => $argv, 985 argv => $argv,
1184 }, $pkg; 986 }, $pkg;
1185 Scalar::Util::weaken ($proxy->{term} = $self); 987 Scalar::Util::weaken ($proxy->{term} = $self);
1186 988
1187 $self->{_pkg}{$pkg} = $proxy; 989 $self->{_pkg}{$pkg} = $proxy;
1188 990
1191 $proxy->enable ($name => $ref); 993 $proxy->enable ($name => $ref);
1192 } 994 }
1193 } 995 }
1194} 996}
1195 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
1196=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1045=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1197 1046
1198Creates 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
1199C<$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
1200hash which defines the environment of the new terminal. 1049hash which defines the environment of the new terminal.
1220 1069
1221Destroy the terminal object (close the window, free resources 1070Destroy the terminal object (close the window, free resources
1222etc.). 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
1223watchers (timers, io watchers) are still active. 1072watchers (timers, io watchers) are still active.
1224 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 givne 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 paramaters, 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
1225=item $term->exec_async ($cmd[, @args]) 1117=item $term->exec_async ($cmd[, @args])
1226 1118
1227Works 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
1228("starts") programs in the background. This function takes care of setting 1120("starts") programs in the background. This function takes care of setting
1229the 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
1254C<%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.
1255 1147
1256Here 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
1257source file F</src/optinc.h> to see the actual list: 1149source file F</src/optinc.h> to see the actual list:
1258 1150
1259 borderLess console cursorBlink cursorUnderline hold iconic insecure 1151 borderLess buffered console cursorBlink cursorUnderline hold iconic
1260 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1152 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1261 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1153 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1262 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1154 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1263 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1155 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1264 transparent tripleclickwords utmpInhibit visualBell 1156 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1157 urgentOnBell utmpInhibit visualBell
1265 1158
1266=item $value = $term->resource ($name[, $newval]) 1159=item $value = $term->resource ($name[, $newval])
1267 1160
1268Returns the current resource value associated with a given name and 1161Returns the current resource value associated with a given name and
1269optionally 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>
1282 1175
1283Here 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
1284are 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>
1285to see the actual list: 1178to see the actual list:
1286 1179
1287 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1180 answerbackstring backgroundPixmap backspace_key blurradius
1288 borderLess color cursorBlink cursorUnderline cutchars delete_key 1181 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1289 display_name embed ext_bwidth fade font geometry hold iconName 1182 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1290 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
1291 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1185 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1292 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1186 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1293 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1187 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1294 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1188 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1189 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1190 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297 secondaryScreen secondaryScroll selectstyle shade term_name title 1191 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1298 transient_for transparent transparent_all tripleclickwords utmpInhibit 1192 term_name title transient_for transparent tripleclickwords urgentOnBell
1299 visualBell 1193 utmpInhibit visualBell
1300 1194
1301=cut 1195=cut
1302 1196
1303sub resource($$;$) { 1197sub resource($$;$) {
1304 my ($self, $name) = (shift, shift); 1198 my ($self, $name) = (shift, shift);
1305 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1199 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1306 &urxvt::term::_resource 1200 goto &urxvt::term::_resource
1307} 1201}
1308 1202
1309=item $value = $term->x_resource ($pattern) 1203=item $value = $term->x_resource ($pattern)
1310 1204
1311Returns the X-Resource for the given pattern, excluding the program or 1205Returns the X-Resource for the given pattern, excluding the program or
1312class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1206class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1313same 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
1314resource with that pattern exists. 1208resource with that pattern exists.
1315 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
1316This 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
1317only one resource database per display, and later invocations might return 1221only one resource database per display, and later invocations might return
1318the wrong resources. 1222the wrong resources.
1319 1223
1320=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1224=item $value = $term->x_resource_boolean ($pattern)
1321 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
1322Adds a keymap translation exactly as specified via a resource. See the 1242Adds a key binding exactly as specified via a resource. See the
1323C<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.
1324 1251
1325=item $rend = $term->rstyle ([$new_rstyle]) 1252=item $rend = $term->rstyle ([$new_rstyle])
1326 1253
1327Return and optionally change the current rendition. Text that is output by 1254Return and optionally change the current rendition. Text that is output by
1328the terminal application will use this style. 1255the terminal application will use this style.
1336 1263
1337=item ($row, $col) = $term->selection_beg ([$row, $col]) 1264=item ($row, $col) = $term->selection_beg ([$row, $col])
1338 1265
1339=item ($row, $col) = $term->selection_end ([$row, $col]) 1266=item ($row, $col) = $term->selection_end ([$row, $col])
1340 1267
1341Return the current values of the selection mark, begin or end positions, 1268Return the current values of the selection mark, begin or end positions.
1342and 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.
1343 1277
1344=item $term->selection_make ($eventtime[, $rectangular]) 1278=item $term->selection_make ($eventtime[, $rectangular])
1345 1279
1346Tries to make a selection as set by C<selection_beg> and 1280Tries to make a selection as set by C<selection_beg> and
1347C<selection_end>. If C<$rectangular> is true (default: false), a 1281C<selection_end>. If C<$rectangular> is true (default: false), a
1348rectangular selection will be made. This is the prefered function to make 1282rectangular selection will be made. This is the preferred function to make
1349a selection. 1283a selection.
1350 1284
1351=item $success = $term->selection_grab ($eventtime) 1285=item $success = $term->selection_grab ($eventtime[, $clipboard])
1352 1286
1353Try 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
1354set by the next method). No visual feedback will be given. This function 1289with the next method. No visual feedback will be given. This function
1355is mostly useful from within C<on_sel_grab> hooks. 1290is mostly useful from within C<on_sel_grab> hooks.
1356 1291
1357=item $oldtext = $term->selection ([$newtext]) 1292=item $oldtext = $term->selection ([$newtext, $clipboard])
1358 1293
1359Return 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.
1360 1300
1361=item $term->overlay_simple ($x, $y, $text) 1301=item $term->overlay_simple ($x, $y, $text)
1362 1302
1363Create 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.
1364 1304
1394 1334
1395The methods currently supported on C<urxvt::overlay> objects are: 1335The methods currently supported on C<urxvt::overlay> objects are:
1396 1336
1397=over 4 1337=over 4
1398 1338
1399=item $overlay->set ($x, $y, $text, $rend) 1339=item $overlay->set ($x, $y, $text[, $rend])
1400 1340
1401Similar 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
1402text 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
1403at 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.
1404 1346
1405=item $overlay->hide 1347=item $overlay->hide
1406 1348
1407If visible, hide the overlay, but do not destroy it. 1349If visible, hide the overlay, but do not destroy it.
1408 1350
1490locale-specific encoding of the terminal and can contain command sequences 1432locale-specific encoding of the terminal and can contain command sequences
1491(escape codes) that will be interpreted. 1433(escape codes) that will be interpreted.
1492 1434
1493=item $term->tt_write ($octets) 1435=item $term->tt_write ($octets)
1494 1436
1495Write 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
1496pass characters instead of octets, you should convert your strings first 1438pass characters instead of octets, you should convert your strings first
1497to 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.
1498 1446
1499=item $old_events = $term->pty_ev_events ([$new_events]) 1447=item $old_events = $term->pty_ev_events ([$new_events])
1500 1448
1501Replaces 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
1502be 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
1521Adds 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
1522to receive pointer events all the times: 1470to receive pointer events all the times:
1523 1471
1524 $term->vt_emask_add (urxvt::PointerMotionMask); 1472 $term->vt_emask_add (urxvt::PointerMotionMask);
1525 1473
1474=item $term->set_urgency ($set)
1475
1476Enable/disable the urgency hint on the toplevel window.
1477
1526=item $term->focus_in 1478=item $term->focus_in
1527 1479
1528=item $term->focus_out 1480=item $term->focus_out
1529 1481
1530=item $term->key_press ($state, $keycode[, $time]) 1482=item $term->key_press ($state, $keycode[, $time])
1618 1570
1619Used after changing terminal contents to display them. 1571Used after changing terminal contents to display them.
1620 1572
1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1573=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622 1574
1623Returns 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 >>
1624is 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
1625terminal line. The scrollback buffer starts at line C<-1> and extends to
1626line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1577terminal line. Nothing will be returned if a nonexistent line
1627is requested. 1578is requested.
1628 1579
1629If 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
1630line, 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
1631to 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
1632automatically be updated. 1583automatically be updated.
1633 1584
1634C<$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
1635than 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)
1636characters. Characters with combining characters and other characters that 1587characters. Characters with combining characters and other characters that
1637do 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
1638in the private use area. 1589in the private use area.
1639 1590
1640You have to obey this encoding when changing text. The advantage is 1591You have to obey this encoding when changing text. The advantage is
1641that 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
1642characters. 1593characters.
1817Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1768Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1818recent grab. 1769recent grab.
1819 1770
1820=item $term->ungrab 1771=item $term->ungrab
1821 1772
1822Calls XUngrab for the most recent grab. Is called automatically on 1773Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1823evaluation 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
1824the session. 1775the session.
1825 1776
1826=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1777=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1827 1778
1829 1780
1830=item @atoms = $term->XListProperties ($window) 1781=item @atoms = $term->XListProperties ($window)
1831 1782
1832=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1783=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1833 1784
1834=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1785=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1835 1786
1836=item $term->XDeleteProperty ($window, $property) 1787=item $term->XDeleteProperty ($window, $property)
1837 1788
1838=item $window = $term->DefaultRootWindow 1789=item $window = $term->DefaultRootWindow
1839 1790
1846=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1797=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1847 1798
1848=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1799=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1849 1800
1850=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)
1851 1806
1852Various 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
1853the source of the display, otherwise those functions map more-or-less 1808the source of the display, otherwise those functions map more-or-less
1854directory onto the X functions of the same name. 1809directly onto the X functions of the same name.
1855 1810
1856=back 1811=back
1857 1812
1858=cut 1813=cut
1859 1814
1961 my $env = $self->{term}->env; 1916 my $env = $self->{term}->env;
1962 # 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.
1963 delete $env->{LC_ALL}; 1918 delete $env->{LC_ALL};
1964 $env->{LC_CTYPE} = $self->{term}->locale; 1919 $env->{LC_CTYPE} = $self->{term}->locale;
1965 1920
1966 urxvt::term->new ($env, "popup", 1921 my $term = urxvt::term->new (
1922 $env, "popup",
1967 "--perl-lib" => "", "--perl-ext-common" => "", 1923 "--perl-lib" => "", "--perl-ext-common" => "",
1968 "-pty-fd" => -1, "-sl" => 0, 1924 "-pty-fd" => -1, "-sl" => 0,
1969 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1925 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1970 "--transient-for" => $self->{term}->parent, 1926 "--transient-for" => $self->{term}->parent,
1971 "-display" => $self->{term}->display_id, 1927 "-display" => $self->{term}->display_id,
1972 "-pe" => "urxvt-popup") 1928 "-pe" => "urxvt-popup",
1973 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 }
1974} 1936}
1975 1937
1976sub DESTROY { 1938sub DESTROY {
1977 my ($self) = @_; 1939 my ($self) = @_;
1978 1940
1996 ->new 1958 ->new
1997 ->interval (1) 1959 ->interval (1)
1998 ->cb (sub { 1960 ->cb (sub {
1999 $term->{overlay}->set (0, 0, 1961 $term->{overlay}->set (0, 0,
2000 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1962 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2001 }); 1963 });
2002 1964
2003=over 4 1965=over 4
2004 1966
2005=item $timer = new urxvt::timer 1967=item $timer = new urxvt::timer
2006 1968
2009 1971
2010=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1972=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011 1973
2012Set the callback to be called when the timer triggers. 1974Set the callback to be called when the timer triggers.
2013 1975
2014=item $tstamp = $timer->at
2015
2016Return the time this watcher will fire next.
2017
2018=item $timer = $timer->set ($tstamp) 1976=item $timer = $timer->set ($tstamp[, $interval])
2019 1977
2020Set the time the event is generated to $tstamp. 1978Set the time the event is generated to $tstamp (and optionally specifies a
1979new $interval).
2021 1980
2022=item $timer = $timer->interval ($interval) 1981=item $timer = $timer->interval ($interval)
2023 1982
2024Normally (and when C<$interval> is C<0>), the timer will automatically 1983By default (and when C<$interval> is C<0>), the timer will automatically
2025stop 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
2026is automatically rescheduled at the given intervals. 1985is automatically rescheduled at the given intervals.
2027 1986
2028=item $timer = $timer->start 1987=item $timer = $timer->start
2029 1988
2030Start the timer. 1989Start the timer.
2031 1990
2032=item $timer = $timer->start ($tstamp) 1991=item $timer = $timer->start ($tstamp[, $interval])
2033 1992
2034Set 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.
2035 1995
2036=item $timer = $timer->after ($delay) 1996=item $timer = $timer->after ($delay[, $interval])
2037 1997
2038Like 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>.
2039 1999
2040=item $timer = $timer->stop 2000=item $timer = $timer->stop
2041 2001
2049 2009
2050 $term->{socket} = ... 2010 $term->{socket} = ...
2051 $term->{iow} = urxvt::iow 2011 $term->{iow} = urxvt::iow
2052 ->new 2012 ->new
2053 ->fd (fileno $term->{socket}) 2013 ->fd (fileno $term->{socket})
2054 ->events (urxvt::EVENT_READ) 2014 ->events (urxvt::EV_READ)
2055 ->start 2015 ->start
2056 ->cb (sub { 2016 ->cb (sub {
2057 my ($iow, $revents) = @_; 2017 my ($iow, $revents) = @_;
2058 # $revents must be 1 here, no need to check 2018 # $revents must be 1 here, no need to check
2059 sysread $term->{socket}, my $buf, 8192 2019 sysread $term->{socket}, my $buf, 8192
2077Set the file descriptor (not handle) to watch. 2037Set the file descriptor (not handle) to watch.
2078 2038
2079=item $iow = $iow->events ($eventmask) 2039=item $iow = $iow->events ($eventmask)
2080 2040
2081Set the event mask to watch. The only allowed values are 2041Set the event mask to watch. The only allowed values are
2082C<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
2083together, or C<urxvt::EVENT_NONE>. 2043together, or C<urxvt::EV_NONE>.
2084 2044
2085=item $iow = $iow->start 2045=item $iow = $iow->start
2086 2046
2087Start watching for requested events on the given handle. 2047Start watching for requested events on the given handle.
2088 2048
2129 ->new 2089 ->new
2130 ->start ($pid) 2090 ->start ($pid)
2131 ->cb (sub { 2091 ->cb (sub {
2132 my ($pw, $exit_status) = @_; 2092 my ($pw, $exit_status) = @_;
2133 ... 2093 ...
2134 }); 2094 });
2135 2095
2136=over 4 2096=over 4
2137 2097
2138=item $pw = new urxvt::pw 2098=item $pw = new urxvt::pw
2139 2099
2172 2132
2173=back 2133=back
2174 2134
2175=head1 AUTHOR 2135=head1 AUTHOR
2176 2136
2177 Marc Lehmann <pcg@goof.com> 2137 Marc Lehmann <schmorp@schmorp.de>
2178 http://software.schmorp.de/pkg/rxvt-unicode 2138 http://software.schmorp.de/pkg/rxvt-unicode
2179 2139
2180=cut 2140=cut
2181 2141
21821 21421

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines