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.224 by root, Sat Jul 14 08:00:34 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.
434 104
435Although it isn't a C<urxvt::term> object, you can call all methods of the 105Although it isn't a C<urxvt::term> object, you can call all methods of the
436C<urxvt::term> class on this object. 106C<urxvt::term> class on this object.
437 107
438It has the following methods and data members: 108Additional methods only supported for extension objects are described in
439 109the C<urxvt::extension> section below.
440=over 4
441
442=item $urxvt_term = $self->{term}
443
444Returns the C<urxvt::term> object associated with this instance of the
445extension. This member I<must not> be changed in any way.
446
447=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
448
449Dynamically enable the given hooks (named without the C<on_> prefix) for
450this extension, replacing any previous hook. This is useful when you want
451to overwrite time-critical hooks only temporarily.
452
453=item $self->disable ($hook_name[, $hook_name..])
454
455Dynamically disable the given hooks.
456
457=back
458 110
459=head2 Hooks 111=head2 Hooks
460 112
461The following subroutines can be declared in extension files, and will be 113The following subroutines can be declared in extension files, and will be
462called whenever the relevant event happens. 114called whenever the relevant event happens.
548 200
549It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 201It 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 202$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
551number of lines that will be in the scrollback buffer. 203number of lines that will be in the scrollback buffer.
552 204
553=item on_osc_seq $term, $op, $args 205=item on_osc_seq $term, $op, $args, $resp
554 206
555Called on every OSC sequence and can be used to suppress it or modify its 207Called 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 208behaviour. The default should be to return an empty list. A true value
557suppresses execution of the request completely. Make sure you don't get 209suppresses execution of the request completely. Make sure you don't get
558confused by recursive invocations when you output an osc sequence within 210confused by recursive invocations when you output an OSC sequence within
559this callback. 211this callback.
560 212
561C<on_osc_seq_perl> should be used for new behaviour. 213C<on_osc_seq_perl> should be used for new behaviour.
562 214
563=item on_osc_seq_perl $term, $string 215=item on_osc_seq_perl $term, $args, $resp
564 216
565Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 217Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
566operating system command) is processed. Cursor position and other state 218operating system command) is processed. Cursor position and other state
567information is up-to-date when this happens. For interoperability, the 219information is up-to-date when this happens. For interoperability, the
568string should start with the extension name and a colon, to distinguish 220string should start with the extension name (sans -osc) and a semicolon,
569it from commands for other extensions, and this might be enforced in the 221to distinguish it from commands for other extensions, and this might be
570future. 222enforced in the future.
223
224For example, C<overlay-osc> uses this:
225
226 sub on_osc_seq_perl {
227 my ($self, $osc, $resp) = @_;
228
229 return unless $osc =~ s/^overlay;//;
230
231 ... process remaining $osc string
232 }
571 233
572Be careful not ever to trust (in a security sense) the data you receive, 234Be 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 235as its source can not easily be controlled (e-mail content, messages from
574other users on the same system etc.). 236other users on the same system etc.).
237
238For responses, C<$resp> contains the end-of-args separator used by the
239sender.
575 240
576=item on_add_lines $term, $string 241=item on_add_lines $term, $string
577 242
578Called whenever text is about to be output, with the text as argument. You 243Called 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 244can filter/change and output the text yourself by returning a true value
584=item on_tt_write $term, $octets 249=item on_tt_write $term, $octets
585 250
586Called whenever some data is written to the tty/pty and can be used to 251Called whenever some data is written to the tty/pty and can be used to
587suppress or filter tty input. 252suppress or filter tty input.
588 253
254=item on_tt_paste $term, $octets
255
256Called whenever text is about to be pasted, with the text as argument. You
257can filter/change and paste the text yourself by returning a true value
258and calling C<< $term->tt_paste >> yourself. C<$octets> is
259locale-encoded.
260
589=item on_line_update $term, $row 261=item on_line_update $term, $row
590 262
591Called whenever a line was updated or changed. Can be used to filter 263Called whenever a line was updated or changed. Can be used to filter
592screen output (e.g. underline urls or other useless stuff). Only lines 264screen output (e.g. underline urls or other useless stuff). Only lines
593that are being shown will be filtered, and, due to performance reasons, 265that are being shown will be filtered, and, due to performance reasons,
600later with the already-modified line (e.g. if unrelated parts change), so 272later with the already-modified line (e.g. if unrelated parts change), so
601you cannot just toggle rendition bits, but only set them. 273you cannot just toggle rendition bits, but only set them.
602 274
603=item on_refresh_begin $term 275=item on_refresh_begin $term
604 276
605Called just before the screen gets redrawn. Can be used for overlay 277Called just before the screen gets redrawn. Can be used for overlay or
606or similar effects by modify terminal contents in refresh_begin, and 278similar effects by modifying the terminal contents in refresh_begin, and
607restoring them in refresh_end. The built-in overlay and selection display 279restoring them in refresh_end. The built-in overlay and selection display
608code is run after this hook, and takes precedence. 280code is run after this hook, and takes precedence.
609 281
610=item on_refresh_end $term 282=item on_refresh_end $term
611 283
618resource in the @@RXVT_NAME@@(1) manpage). 290resource in the @@RXVT_NAME@@(1) manpage).
619 291
620The event is simply the action string. This interface is assumed to change 292The event is simply the action string. This interface is assumed to change
621slightly in the future. 293slightly in the future.
622 294
295=item on_register_command $term, $keysym, $modifiermask, $string
296
297Called after parsing a keysym resource but before registering the
298associated binding. If this hook returns TRUE the binding is not
299registered. It can be used to modify a binding by calling
300C<register_command>.
301
623=item on_resize_all_windows $tern, $new_width, $new_height 302=item on_resize_all_windows $term, $new_width, $new_height
624 303
625Called just after the new window size has been calculated, but before 304Called just after the new window size has been calculated, but before
626windows are actually being resized or hints are being set. If this hook 305windows are actually being resized or hints are being set. If this hook
627returns TRUE, setting of the window hints is being skipped. 306returns TRUE, setting of the window hints is being skipped.
628 307
662 341
663=item on_map_notify $term, $event 342=item on_map_notify $term, $event
664 343
665=item on_unmap_notify $term, $event 344=item on_unmap_notify $term, $event
666 345
667Called whenever the corresponding X event is received for the terminal If 346Called whenever the corresponding X event is received for the terminal. If
668the hook returns true, then the even will be ignored by rxvt-unicode. 347the hook returns true, then the event will be ignored by rxvt-unicode.
669 348
670The event is a hash with most values as named by Xlib (see the XEvent 349The 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 350manpage), with the additional members C<row> and C<col>, which are the
672(real, not screen-based) row and column under the mouse cursor. 351(real, not screen-based) row and column under the mouse cursor.
673 352
683=item on_wm_delete_window $term, $event 362=item on_wm_delete_window $term, $event
684 363
685Called when various types of ClientMessage events are received (all with 364Called when various types of ClientMessage events are received (all with
686format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 365format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
687 366
367=item on_bell $term
368
369Called on receipt of a bell character.
370
688=back 371=back
689 372
690=cut 373=cut
691 374
692package urxvt; 375package urxvt;
693 376
694use utf8; 377use utf8;
695use strict; 378use strict 'vars';
696use Carp (); 379use Carp ();
697use Scalar::Util (); 380use Scalar::Util ();
698use List::Util (); 381use List::Util ();
699 382
700our $VERSION = 1; 383our $VERSION = 1;
701our $TERM; 384our $TERM;
702our @TERM_INIT; 385our @TERM_INIT; # should go, prevents async I/O etc.
703our @TERM_EXT; 386our @TERM_EXT; # should go, prevents async I/O etc.
704our @HOOKNAME; 387our @HOOKNAME;
705our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 388our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
706our %OPTION; 389our %OPTION;
707 390
708our $LIBDIR; 391our $LIBDIR;
756 439
757=over 4 440=over 4
758 441
759=item urxvt::fatal $errormessage 442=item urxvt::fatal $errormessage
760 443
761Fatally aborts execution with the given error message. Avoid at all 444Fatally aborts execution with the given error message (which should
762costs! The only time this is acceptable is when the terminal process 445include a trailing newline). Avoid at all costs! The only time this
763starts up. 446is acceptable (and useful) is in the init hook, where it prevents the
447terminal from starting up.
764 448
765=item urxvt::warn $string 449=item urxvt::warn $string
766 450
767Calls C<rxvt_warn> with the given string which should not include a 451Calls C<rxvt_warn> with the given string which should include a trailing
768newline. The module also overwrites the C<warn> builtin with a function 452newline. The module also overwrites the C<warn> builtin with a function
769that calls this function. 453that calls this function.
770 454
771Using this function has the advantage that its output ends up in the 455Using this function has the advantage that its output ends up in the
772correct place, e.g. on stderr of the connecting urxvtc client. 456correct place, e.g. on stderr of the connecting urxvtc client.
776=item @terms = urxvt::termlist 460=item @terms = urxvt::termlist
777 461
778Returns all urxvt::term objects that exist in this process, regardless of 462Returns all urxvt::term objects that exist in this process, regardless of
779whether they are started, being destroyed etc., so be careful. Only term 463whether they are started, being destroyed etc., so be careful. Only term
780objects that have perl extensions attached will be returned (because there 464objects that have perl extensions attached will be returned (because there
781is no urxvt::term objet associated with others). 465is no urxvt::term object associated with others).
782 466
783=item $time = urxvt::NOW 467=item $time = urxvt::NOW
784 468
785Returns the "current time" (as per the event loop). 469Returns the "current time" (as per the event loop).
786 470
829 513
830=item $rend = urxvt::OVERLAY_RSTYLE 514=item $rend = urxvt::OVERLAY_RSTYLE
831 515
832Return the rendition mask used for overlays by default. 516Return the rendition mask used for overlays by default.
833 517
834=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 518=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
519urxvt::RS_RVid, urxvt::RS_Uline
835 520
836Return the bit that enabled bold, italic, blink, reverse-video and 521Return the bit that enabled bold, italic, blink, reverse-video and
837underline, respectively. To enable such a style, just logically OR it into 522underline, respectively. To enable such a style, just logically OR it into
838the bitset. 523the bitset.
839 524
876 }; 561 };
877} 562}
878 563
879no warnings 'utf8'; 564no warnings 'utf8';
880 565
566sub parse_resource {
567 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568
569 $name =~ y/-/./ if $isarg;
570
571 $term->scan_meta;
572
573 my $r = $term->{meta}{resource};
574 keys %$r; # reste iterator
575 while (my ($pattern, $v) = each %$r) {
576 if (
577 $pattern =~ /\.$/
578 ? $pattern eq substr $name, 0, length $pattern
579 : $pattern eq $name
580 ) {
581 $name = "$urxvt::RESCLASS.$name";
582
583 push @{ $term->{perl_ext_3} }, $v->[0];
584
585 if ($v->[1] eq "boolean") {
586 $term->put_option_db ($name, $flag ? "true" : "false");
587 return 1;
588 } else {
589 $term->put_option_db ($name, $value);
590 return 1 + 2;
591 }
592 }
593 }
594
595 0
596}
597
598sub usage {
599 my ($term, $usage_type) = @_;
600
601 $term->scan_meta;
602
603 my $r = $term->{meta}{resource};
604
605 for my $pattern (sort keys %$r) {
606 my ($ext, $type, $desc) = @{ $r->{$pattern} };
607
608 $desc .= " (-pe $ext)";
609
610 if ($usage_type == 1) {
611 $pattern =~ y/./-/;
612 $pattern =~ s/-$/-.../g;
613
614 if ($type eq "boolean") {
615 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
616 } else {
617 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
618 }
619 } else {
620 $pattern =~ s/\.$/.*/g;
621 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
622 }
623 }
624}
625
881my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 626my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
882 627
883sub verbose { 628sub verbose {
884 my ($level, $msg) = @_; 629 my ($level, $msg) = @_;
885 warn "$msg\n" if $level <= $verbosity; 630 warn "$msg\n" if $level <= $verbosity;
897 $pkg =~ s/[^[:word:]]/_/g; 642 $pkg =~ s/[^[:word:]]/_/g;
898 $pkg = "urxvt::ext::$pkg"; 643 $pkg = "urxvt::ext::$pkg";
899 644
900 verbose 3, "loading extension '$path' into package '$pkg'"; 645 verbose 3, "loading extension '$path' into package '$pkg'";
901 646
647 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
648
902 open my $fh, "<:raw", $path 649 open my $fh, "<:raw", $path
903 or die "$path: $!"; 650 or die "$path: $!";
904 651
905 my $source = 652 my $source =
906 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 653 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
907 . "#line 1 \"$path\"\n{\n" 654 . "#line 1 \"$path\"\n{\n"
908 . (do { local $/; <$fh> }) 655 . (do { local $/; <$fh> })
909 . "\n};\n1"; 656 . "\n};\n1";
910 657
911 eval $source 658 eval $source
921sub invoke { 668sub invoke {
922 local $TERM = shift; 669 local $TERM = shift;
923 my $htype = shift; 670 my $htype = shift;
924 671
925 if ($htype == 0) { # INIT 672 if ($htype == 0) { # INIT
926 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 673 my @dirs = $TERM->perl_libdirs;
927 674
928 my %ext_arg; 675 my %ext_arg;
929 676
930 { 677 {
931 my @init = @TERM_INIT; 678 my @init = @TERM_INIT;
932 @TERM_INIT = (); 679 @TERM_INIT = ();
934 my @pkg = @TERM_EXT; 681 my @pkg = @TERM_EXT;
935 @TERM_EXT = (); 682 @TERM_EXT = ();
936 $TERM->register_package ($_) for @pkg; 683 $TERM->register_package ($_) for @pkg;
937 } 684 }
938 685
686 for (
687 @{ delete $TERM->{perl_ext_3} },
939 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 688 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689 ) {
940 if ($_ eq "default") { 690 if ($_ eq "default") {
941 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline); 691 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
942 } elsif (/^-(.*)$/) { 692 } elsif (/^-(.*)$/) {
943 delete $ext_arg{$1}; 693 delete $ext_arg{$1};
944 } elsif (/^([^<]+)<(.*)>$/) { 694 } elsif (/^([^<]+)<(.*)>$/) {
967 if (my $cb = $TERM->{_hook}[$htype]) { 717 if (my $cb = $TERM->{_hook}[$htype]) {
968 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
969 if $verbosity >= 10; 719 if $verbosity >= 10;
970 720
971 for my $pkg (keys %$cb) { 721 for my $pkg (keys %$cb) {
972 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
973 $retval ||= $retval_; 723 $retval ||= $retval_;
974 724
975 if ($@) { 725 if ($@) {
976 $TERM->ungrab; # better to lose the grab than the session 726 $TERM->ungrab; # better to lose the grab than the session
977 warn $@; 727 warn $@;
1020 } 770 }
1021 } 771 }
1022 ($mask, @color{qw(fg bg)}, \@failed) 772 ($mask, @color{qw(fg bg)}, \@failed)
1023} 773}
1024 774
1025# urxvt::term::extension
1026
1027package urxvt::term::extension; 775package urxvt::term::extension;
1028 776
1029sub enable { 777=head2 The C<urxvt::term::extension> class
1030 my ($self, %hook) = @_;
1031 my $pkg = $self->{_pkg};
1032 778
1033 while (my ($name, $cb) = each %hook) { 779Each extension attached to a terminal object is represented by
1034 my $htype = $HOOKTYPE{uc $name}; 780a C<urxvt::term::extension> object.
1035 defined $htype
1036 or Carp::croak "unsupported hook type '$name'";
1037 781
1038 $self->set_should_invoke ($htype, +1) 782You can use these objects, which are passed to all callbacks to store any
1039 unless exists $self->{term}{_hook}[$htype]{$pkg}; 783state related to the terminal and extension instance.
1040 784
1041 $self->{term}{_hook}[$htype]{$pkg} = $cb; 785The methods (And data members) documented below can be called on extension
1042 } 786objects, in addition to call methods documented for the <urxvt::term>
1043} 787class.
1044 788
1045sub disable { 789=over 4
1046 my ($self, @hook) = @_;
1047 my $pkg = $self->{_pkg};
1048 790
1049 for my $name (@hook) { 791=item $urxvt_term = $self->{term}
1050 my $htype = $HOOKTYPE{uc $name};
1051 defined $htype
1052 or Carp::croak "unsupported hook type '$name'";
1053 792
1054 $self->set_should_invoke ($htype, -1) 793Returns the C<urxvt::term> object associated with this instance of the
1055 if delete $self->{term}{_hook}[$htype]{$pkg}; 794extension. This member I<must not> be changed in any way.
1056 } 795
1057} 796=cut
1058 797
1059our $AUTOLOAD; 798our $AUTOLOAD;
1060 799
1061sub AUTOLOAD { 800sub AUTOLOAD {
1062 $AUTOLOAD =~ /:([^:]+)$/ 801 $AUTOLOAD =~ /:([^:]+)$/
1075 814
1076sub DESTROY { 815sub DESTROY {
1077 # nop 816 # nop
1078} 817}
1079 818
1080# urxvt::destroy_hook 819# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1081 820
1082sub urxvt::destroy_hook::DESTROY { 821sub urxvt::destroy_hook::DESTROY {
1083 ${$_[0]}->(); 822 ${$_[0]}->();
1084} 823}
1085 824
1086sub urxvt::destroy_hook(&) { 825sub urxvt::destroy_hook(&) {
1087 bless \shift, urxvt::destroy_hook:: 826 bless \shift, urxvt::destroy_hook::
1088} 827}
828
829=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830
831Dynamically enable the given hooks (named without the C<on_> prefix) for
832this extension, replacing any previous hook. This is useful when you want
833to overwrite time-critical hooks only temporarily.
834
835To install additional callbacks for the same hook, you can use the C<on>
836method of the C<urxvt::term> class.
837
838=item $self->disable ($hook_name[, $hook_name..])
839
840Dynamically disable the given hooks.
841
842=cut
843
844sub enable {
845 my ($self, %hook) = @_;
846 my $pkg = $self->{_pkg};
847
848 while (my ($name, $cb) = each %hook) {
849 my $htype = $HOOKTYPE{uc $name};
850 defined $htype
851 or Carp::croak "unsupported hook type '$name'";
852
853 $self->set_should_invoke ($htype, +1)
854 unless exists $self->{term}{_hook}[$htype]{$pkg};
855
856 $self->{term}{_hook}[$htype]{$pkg} = $cb;
857 }
858}
859
860sub disable {
861 my ($self, @hook) = @_;
862 my $pkg = $self->{_pkg};
863
864 for my $name (@hook) {
865 my $htype = $HOOKTYPE{uc $name};
866 defined $htype
867 or Carp::croak "unsupported hook type '$name'";
868
869 $self->set_should_invoke ($htype, -1)
870 if delete $self->{term}{_hook}[$htype]{$pkg};
871 }
872}
873
874=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
875
876Similar to the C<enable> enable, but installs additional callbacks for
877the given hook(s) (that is, it doesn't replace existing callbacks), and
878returns a guard object. When the guard object is destroyed the callbacks
879are disabled again.
880
881=cut
882
883sub urxvt::extension::on_disable::DESTROY {
884 my $disable = shift;
885
886 my $term = delete $disable->{""};
887
888 while (my ($htype, $id) = each %$disable) {
889 delete $term->{_hook}[$htype]{$id};
890 $term->set_should_invoke ($htype, -1);
891 }
892}
893
894sub on {
895 my ($self, %hook) = @_;
896
897 my $term = $self->{term};
898
899 my %disable = ( "" => $term );
900
901 while (my ($name, $cb) = each %hook) {
902 my $htype = $HOOKTYPE{uc $name};
903 defined $htype
904 or Carp::croak "unsupported hook type '$name'";
905
906 $term->set_should_invoke ($htype, +1);
907 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908 = sub { shift; $cb->($self, @_) }; # very ugly indeed
909 }
910
911 bless \%disable, "urxvt::extension::on_disable"
912}
913
914=item $self->x_resource ($pattern)
915
916=item $self->x_resource_boolean ($pattern)
917
918These methods support an additional C<%> prefix when called on an
919extension object - see the description of these methods in the
920C<urxvt::term> class for details.
921
922=cut
923
924sub x_resource {
925 my ($self, $name) = @_;
926 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
927 $self->{term}->x_resource ($name)
928}
929
930sub x_resource_boolean {
931 my ($self, $name) = @_;
932 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
933 $self->{term}->x_resource_boolean ($name)
934}
935
936=back
937
938=cut
1089 939
1090package urxvt::anyevent; 940package urxvt::anyevent;
1091 941
1092=head2 The C<urxvt::anyevent> Class 942=head2 The C<urxvt::anyevent> Class
1093 943
1094The sole purpose of this class is to deliver an interface to the 944The sole purpose of this class is to deliver an interface to the
1095C<AnyEvent> module - any module using it will work inside urxvt without 945C<AnyEvent> module - any module using it will work inside urxvt without
1096further programming. The only exception is that you cannot wait on 946further programming. The only exception is that you cannot wait on
1097condition variables, but non-blocking condvar use is ok. What this means 947condition variables, but non-blocking condvar use is ok.
1098is that you cannot use blocking APIs, but the non-blocking variant should
1099work.
1100 948
1101=cut 949In practical terms this means is that you cannot use blocking APIs, but
950the non-blocking variant should work.
1102 951
952=cut
953
1103our $VERSION = 1; 954our $VERSION = '5.23';
1104 955
1105$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 956$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1106push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 957push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1107 958
1108sub timer { 959sub timer {
1110 961
1111 my $cb = $arg{cb}; 962 my $cb = $arg{cb};
1112 963
1113 urxvt::timer 964 urxvt::timer
1114 ->new 965 ->new
1115 ->start (urxvt::NOW + $arg{after}) 966 ->after ($arg{after}, $arg{interval})
1116 ->cb (sub { 967 ->cb ($arg{interval} ? $cb : sub {
1117 $_[0]->stop; # need to cancel manually 968 $_[0]->stop; # need to cancel manually
1118 $cb->(); 969 $cb->();
1119 }) 970 })
1120} 971}
1121 972
1122sub io { 973sub io {
1123 my ($class, %arg) = @_; 974 my ($class, %arg) = @_;
1124 975
1125 my $cb = $arg{cb}; 976 my $cb = $arg{cb};
977 my $fd = fileno $arg{fh};
978 defined $fd or $fd = $arg{fh};
1126 979
1127 bless [$arg{fh}, urxvt::iow 980 bless [$arg{fh}, urxvt::iow
1128 ->new 981 ->new
1129 ->fd (fileno $arg{fh}) 982 ->fd ($fd)
1130 ->events (($arg{poll} =~ /r/ ? 1 : 0) 983 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1131 | ($arg{poll} =~ /w/ ? 2 : 0)) 984 | ($arg{poll} =~ /w/ ? 2 : 0))
1132 ->start 985 ->start
1133 ->cb (sub { 986 ->cb ($cb)
1134 $cb->(($_[1] & 1 ? 'r' : '')
1135 . ($_[1] & 2 ? 'w' : ''));
1136 })],
1137 urxvt::anyevent:: 987 ], urxvt::anyevent::
988}
989
990sub idle {
991 my ($class, %arg) = @_;
992
993 my $cb = $arg{cb};
994
995 urxvt::iw
996 ->new
997 ->start
998 ->cb ($cb)
999}
1000
1001sub child {
1002 my ($class, %arg) = @_;
1003
1004 my $cb = $arg{cb};
1005
1006 urxvt::pw
1007 ->new
1008 ->start ($arg{pid})
1009 ->cb (sub {
1010 $_[0]->stop; # need to cancel manually
1011 $cb->($_[0]->rpid, $_[0]->rstatus);
1012 })
1138} 1013}
1139 1014
1140sub DESTROY { 1015sub DESTROY {
1141 $_[0][1]->stop; 1016 $_[0][1]->stop;
1142} 1017}
1143 1018
1144sub condvar { 1019# 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 { 1020sub one_event {
1159 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1021 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1160} 1022}
1161 1023
1162package urxvt::term; 1024package urxvt::term;
1177 urxvt::verbose 6, "register package $pkg to $self"; 1039 urxvt::verbose 6, "register package $pkg to $self";
1178 1040
1179 @{"$pkg\::ISA"} = urxvt::term::extension::; 1041 @{"$pkg\::ISA"} = urxvt::term::extension::;
1180 1042
1181 my $proxy = bless { 1043 my $proxy = bless {
1182 _pkg => $pkg, 1044 _pkg => $pkg,
1045 _name => ${"$pkg\::_NAME"}, # hackish
1183 argv => $argv, 1046 argv => $argv,
1184 }, $pkg; 1047 }, $pkg;
1185 Scalar::Util::weaken ($proxy->{term} = $self); 1048 Scalar::Util::weaken ($proxy->{term} = $self);
1186 1049
1187 $self->{_pkg}{$pkg} = $proxy; 1050 $self->{_pkg}{$pkg} = $proxy;
1188 1051
1191 $proxy->enable ($name => $ref); 1054 $proxy->enable ($name => $ref);
1192 } 1055 }
1193 } 1056 }
1194} 1057}
1195 1058
1059sub perl_libdirs {
1060 map { split /:/ }
1061 $_[0]->resource ("perl_lib"),
1062 $ENV{URXVT_PERL_LIB},
1063 "$ENV{HOME}/.urxvt/ext",
1064 "$LIBDIR/perl"
1065}
1066
1067sub scan_meta {
1068 my ($self) = @_;
1069 my @libdirs = perl_libdirs $self;
1070
1071 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1072
1073 my %meta;
1074
1075 $self->{meta_libdirs} = join "\x00", @libdirs;
1076 $self->{meta} = \%meta;
1077
1078 for my $dir (reverse @libdirs) {
1079 opendir my $fh, $dir
1080 or next;
1081 for my $ext (readdir $fh) {
1082 $ext ne "."
1083 and $ext ne ".."
1084 and open my $fh, "<", "$dir/$ext"
1085 or next;
1086
1087 while (<$fh>) {
1088 if (/^#:META:X_RESOURCE:(.*)/) {
1089 my ($pattern, $type, $desc) = split /:/, $1;
1090 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1091 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1092 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1093 } else {
1094 $meta{resource}{$pattern} = [$ext, $type, $desc];
1095 }
1096 } elsif (/^\s*(?:#|$)/) {
1097 # skip other comments and empty lines
1098 } else {
1099 last; # stop parsing on first non-empty non-comment line
1100 }
1101 }
1102 }
1103 }
1104}
1105
1196=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1106=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1197 1107
1198Creates a new terminal, very similar as if you had started it with system 1108Creates 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 1109C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1200hash which defines the environment of the new terminal. 1110hash which defines the environment of the new terminal.
1254C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1164C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1255 1165
1256Here is a likely non-exhaustive list of option names, please see the 1166Here is a likely non-exhaustive list of option names, please see the
1257source file F</src/optinc.h> to see the actual list: 1167source file F</src/optinc.h> to see the actual list:
1258 1168
1259 borderLess console cursorBlink cursorUnderline hold iconic insecure 1169 borderLess buffered console cursorBlink cursorUnderline hold iconic
1260 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1170 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1261 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1171 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1262 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1172 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1263 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1173 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1264 transparent tripleclickwords utmpInhibit visualBell 1174 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1175 urgentOnBell utmpInhibit visualBell
1265 1176
1266=item $value = $term->resource ($name[, $newval]) 1177=item $value = $term->resource ($name[, $newval])
1267 1178
1268Returns the current resource value associated with a given name and 1179Returns the current resource value associated with a given name and
1269optionally sets a new value. Setting values is most useful in the C<init> 1180optionally sets a new value. Setting values is most useful in the C<init>
1282 1193
1283Here is a likely non-exhaustive list of resource names, not all of which 1194Here 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> 1195are supported in every build, please see the source file F</src/rsinc.h>
1285to see the actual list: 1196to see the actual list:
1286 1197
1287 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1198 answerbackstring backgroundPixmap backspace_key blurradius
1288 borderLess color cursorBlink cursorUnderline cutchars delete_key 1199 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1289 display_name embed ext_bwidth fade font geometry hold iconName 1200 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1290 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1201 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1202 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1291 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1203 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1292 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1204 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1293 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1205 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1294 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1206 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1295 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1207 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1296 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1208 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1297 secondaryScreen secondaryScroll selectstyle shade term_name title 1209 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1298 transient_for transparent transparent_all tripleclickwords utmpInhibit 1210 term_name title transient_for transparent tripleclickwords urgentOnBell
1299 visualBell 1211 utmpInhibit visualBell
1300 1212
1301=cut 1213=cut
1302 1214
1303sub resource($$;$) { 1215sub resource($$;$) {
1304 my ($self, $name) = (shift, shift); 1216 my ($self, $name) = (shift, shift);
1305 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1217 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1306 &urxvt::term::_resource 1218 goto &urxvt::term::_resource
1307} 1219}
1308 1220
1309=item $value = $term->x_resource ($pattern) 1221=item $value = $term->x_resource ($pattern)
1310 1222
1311Returns the X-Resource for the given pattern, excluding the program or 1223Returns the X-Resource for the given pattern, excluding the program or
1312class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1224class 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 1225same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1314resource with that pattern exists. 1226resource with that pattern exists.
1315 1227
1228Extensions that define extra resource or command line arguments also need
1229to call this method to access their values.
1230
1231If the method is called on an extension object (basically, from an
1232extension), then the special prefix C<%.> will be replaced by the name of
1233the extension and a dot, and the lone string C<%> will be replaced by the
1234extension name itself. This makes it possible to code extensions so you
1235can rename them and get a new set of commandline switches and resources
1236without having to change the actual code.
1237
1316This method should only be called during the C<on_start> hook, as there is 1238This 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 1239only one resource database per display, and later invocations might return
1318the wrong resources. 1240the wrong resources.
1319 1241
1320=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1242=item $value = $term->x_resource_boolean ($pattern)
1321 1243
1244Like C<x_resource>, above, but interprets the string value as a boolean
1245and returns C<1> for true values, C<0> for false values and C<undef> if
1246the resource or option isn't specified.
1247
1248You should always use this method to parse boolean resources.
1249
1250=cut
1251
1252sub x_resource_boolean {
1253 my $res = &x_resource;
1254
1255 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1256}
1257
1258=item $success = $term->parse_keysym ($key, $octets)
1259
1322Adds a keymap translation exactly as specified via a resource. See the 1260Adds a key binding exactly as specified via a resource. See the
1323C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1261C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1262
1263=item $term->register_command ($keysym, $modifiermask, $string)
1264
1265Adds a key binding. This is a lower level api compared to
1266C<parse_keysym>, as it expects a parsed key description, and can be
1267used only inside either the C<on_init> hook, to add a binding, or the
1268C<on_register_command> hook, to modify a parsed binding.
1324 1269
1325=item $rend = $term->rstyle ([$new_rstyle]) 1270=item $rend = $term->rstyle ([$new_rstyle])
1326 1271
1327Return and optionally change the current rendition. Text that is output by 1272Return and optionally change the current rendition. Text that is output by
1328the terminal application will use this style. 1273the terminal application will use this style.
1336 1281
1337=item ($row, $col) = $term->selection_beg ([$row, $col]) 1282=item ($row, $col) = $term->selection_beg ([$row, $col])
1338 1283
1339=item ($row, $col) = $term->selection_end ([$row, $col]) 1284=item ($row, $col) = $term->selection_end ([$row, $col])
1340 1285
1341Return the current values of the selection mark, begin or end positions, 1286Return the current values of the selection mark, begin or end positions.
1342and optionally set them to new values. 1287
1288When arguments are given, then the selection coordinates are set to
1289C<$row> and C<$col>, and the selection screen is set to the current
1290screen.
1291
1292=item $screen = $term->selection_screen ([$screen])
1293
1294Returns the current selection screen, and then optionally sets it.
1343 1295
1344=item $term->selection_make ($eventtime[, $rectangular]) 1296=item $term->selection_make ($eventtime[, $rectangular])
1345 1297
1346Tries to make a selection as set by C<selection_beg> and 1298Tries to make a selection as set by C<selection_beg> and
1347C<selection_end>. If C<$rectangular> is true (default: false), a 1299C<selection_end>. If C<$rectangular> is true (default: false), a
1348rectangular selection will be made. This is the prefered function to make 1300rectangular selection will be made. This is the preferred function to make
1349a selection. 1301a selection.
1350 1302
1351=item $success = $term->selection_grab ($eventtime) 1303=item $success = $term->selection_grab ($eventtime[, $clipboard])
1352 1304
1353Try to request the primary selection text from the server (for example, as 1305Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1306true) selection from the server. The corresponding text can be set
1354set by the next method). No visual feedback will be given. This function 1307with the next method. No visual feedback will be given. This function
1355is mostly useful from within C<on_sel_grab> hooks. 1308is mostly useful from within C<on_sel_grab> hooks.
1356 1309
1357=item $oldtext = $term->selection ([$newtext]) 1310=item $oldtext = $term->selection ([$newtext, $clipboard])
1358 1311
1359Return the current selection text and optionally replace it by C<$newtext>. 1312Return the current selection (clipboard if C<$clipboard> is true) text
1313and optionally replace it by C<$newtext>.
1314
1315=item $term->selection_clear ([$clipboard])
1316
1317Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1360 1318
1361=item $term->overlay_simple ($x, $y, $text) 1319=item $term->overlay_simple ($x, $y, $text)
1362 1320
1363Create a simple multi-line overlay box. See the next method for details. 1321Create a simple multi-line overlay box. See the next method for details.
1364 1322
1394 1352
1395The methods currently supported on C<urxvt::overlay> objects are: 1353The methods currently supported on C<urxvt::overlay> objects are:
1396 1354
1397=over 4 1355=over 4
1398 1356
1399=item $overlay->set ($x, $y, $text, $rend) 1357=item $overlay->set ($x, $y, $text[, $rend])
1400 1358
1401Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1359Similar 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 1360text in rxvt-unicode's special encoding and an array of rendition values
1403at a specific position inside the overlay. 1361at a specific position inside the overlay.
1362
1363If C<$rend> is missing, then the rendition will not be changed.
1404 1364
1405=item $overlay->hide 1365=item $overlay->hide
1406 1366
1407If visible, hide the overlay, but do not destroy it. 1367If visible, hide the overlay, but do not destroy it.
1408 1368
1490locale-specific encoding of the terminal and can contain command sequences 1450locale-specific encoding of the terminal and can contain command sequences
1491(escape codes) that will be interpreted. 1451(escape codes) that will be interpreted.
1492 1452
1493=item $term->tt_write ($octets) 1453=item $term->tt_write ($octets)
1494 1454
1495Write the octets given in C<$data> to the tty (i.e. as program input). To 1455Write 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 1456pass characters instead of octets, you should convert your strings first
1497to the locale-specific encoding using C<< $term->locale_encode >>. 1457to the locale-specific encoding using C<< $term->locale_encode >>.
1458
1459=item $term->tt_paste ($octets)
1460
1461Write the octets given in C<$octets> to the tty as a paste, converting NL to
1462CR and bracketing the data with control sequences if bracketed paste mode
1463is set.
1498 1464
1499=item $old_events = $term->pty_ev_events ([$new_events]) 1465=item $old_events = $term->pty_ev_events ([$new_events])
1500 1466
1501Replaces the event mask of the pty watcher by the given event mask. Can 1467Replaces 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 1468be 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 1487Adds the specified events to the vt event mask. Useful e.g. when you want
1522to receive pointer events all the times: 1488to receive pointer events all the times:
1523 1489
1524 $term->vt_emask_add (urxvt::PointerMotionMask); 1490 $term->vt_emask_add (urxvt::PointerMotionMask);
1525 1491
1492=item $term->set_urgency ($set)
1493
1494Enable/disable the urgency hint on the toplevel window.
1495
1526=item $term->focus_in 1496=item $term->focus_in
1527 1497
1528=item $term->focus_out 1498=item $term->focus_out
1529 1499
1530=item $term->key_press ($state, $keycode[, $time]) 1500=item $term->key_press ($state, $keycode[, $time])
1618 1588
1619Used after changing terminal contents to display them. 1589Used after changing terminal contents to display them.
1620 1590
1621=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1591=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1622 1592
1623Returns the text of the entire row with number C<$row_number>. Row C<0> 1593Returns 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 1594is 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 1595terminal line. Nothing will be returned if a nonexistent line
1627is requested. 1596is requested.
1628 1597
1629If C<$new_text> is specified, it will replace characters in the current 1598If 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 1599line, 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 1600to replace only parts of a line. The font index in the rendition will
1632automatically be updated. 1601automatically be updated.
1633 1602
1634C<$text> is in a special encoding: tabs and wide characters that use more 1603C<$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) 1604than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1636characters. Characters with combining characters and other characters that 1605characters. Characters with combining characters and other characters that
1637do not fit into the normal tetx encoding will be replaced with characters 1606do not fit into the normal text encoding will be replaced with characters
1638in the private use area. 1607in the private use area.
1639 1608
1640You have to obey this encoding when changing text. The advantage is 1609You have to obey this encoding when changing text. The advantage is
1641that C<substr> and similar functions work on screen cells and not on 1610that C<substr> and similar functions work on screen cells and not on
1642characters. 1611characters.
1817Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1786Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1818recent grab. 1787recent grab.
1819 1788
1820=item $term->ungrab 1789=item $term->ungrab
1821 1790
1822Calls XUngrab for the most recent grab. Is called automatically on 1791Calls 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 1792evaluation errors, as it is better to lose the grab in the error case as
1824the session. 1793the session.
1825 1794
1826=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1795=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1827 1796
1829 1798
1830=item @atoms = $term->XListProperties ($window) 1799=item @atoms = $term->XListProperties ($window)
1831 1800
1832=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1801=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1833 1802
1834=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1803=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1835 1804
1836=item $term->XDeleteProperty ($window, $property) 1805=item $term->XDeleteProperty ($window, $property)
1837 1806
1838=item $window = $term->DefaultRootWindow 1807=item $window = $term->DefaultRootWindow
1839 1808
1846=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1815=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1847 1816
1848=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1817=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1849 1818
1850=item $term->XChangeInput ($window, $add_events[, $del_events]) 1819=item $term->XChangeInput ($window, $add_events[, $del_events])
1820
1821=item $keysym = $term->XStringToKeysym ($string)
1822
1823=item $string = $term->XKeysymToString ($keysym)
1851 1824
1852Various X or X-related functions. The C<$term> object only serves as 1825Various X or X-related functions. The C<$term> object only serves as
1853the source of the display, otherwise those functions map more-or-less 1826the source of the display, otherwise those functions map more-or-less
1854directory onto the X functions of the same name. 1827directly onto the X functions of the same name.
1855 1828
1856=back 1829=back
1857 1830
1858=cut 1831=cut
1859 1832
1961 my $env = $self->{term}->env; 1934 my $env = $self->{term}->env;
1962 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1935 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1963 delete $env->{LC_ALL}; 1936 delete $env->{LC_ALL};
1964 $env->{LC_CTYPE} = $self->{term}->locale; 1937 $env->{LC_CTYPE} = $self->{term}->locale;
1965 1938
1966 urxvt::term->new ($env, "popup", 1939 my $term = urxvt::term->new (
1940 $env, "popup",
1967 "--perl-lib" => "", "--perl-ext-common" => "", 1941 "--perl-lib" => "", "--perl-ext-common" => "",
1968 "-pty-fd" => -1, "-sl" => 0, 1942 "-pty-fd" => -1, "-sl" => 0,
1969 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1943 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1970 "--transient-for" => $self->{term}->parent, 1944 "--transient-for" => $self->{term}->parent,
1971 "-display" => $self->{term}->display_id, 1945 "-display" => $self->{term}->display_id,
1972 "-pe" => "urxvt-popup") 1946 "-pe" => "urxvt-popup",
1973 or die "unable to create popup window\n"; 1947 ) or die "unable to create popup window\n";
1948
1949 unless (delete $term->{urxvt_popup_init_done}) {
1950 $term->ungrab;
1951 $term->destroy;
1952 die "unable to initialise popup window\n";
1953 }
1974} 1954}
1975 1955
1976sub DESTROY { 1956sub DESTROY {
1977 my ($self) = @_; 1957 my ($self) = @_;
1978 1958
1996 ->new 1976 ->new
1997 ->interval (1) 1977 ->interval (1)
1998 ->cb (sub { 1978 ->cb (sub {
1999 $term->{overlay}->set (0, 0, 1979 $term->{overlay}->set (0, 0,
2000 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1980 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
2001 }); 1981 });
2002 1982
2003=over 4 1983=over 4
2004 1984
2005=item $timer = new urxvt::timer 1985=item $timer = new urxvt::timer
2006 1986
2009 1989
2010=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1990=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2011 1991
2012Set the callback to be called when the timer triggers. 1992Set the callback to be called when the timer triggers.
2013 1993
2014=item $tstamp = $timer->at
2015
2016Return the time this watcher will fire next.
2017
2018=item $timer = $timer->set ($tstamp) 1994=item $timer = $timer->set ($tstamp[, $interval])
2019 1995
2020Set the time the event is generated to $tstamp. 1996Set the time the event is generated to $tstamp (and optionally specifies a
1997new $interval).
2021 1998
2022=item $timer = $timer->interval ($interval) 1999=item $timer = $timer->interval ($interval)
2023 2000
2024Normally (and when C<$interval> is C<0>), the timer will automatically 2001By 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 2002stop after it has fired once. If C<$interval> is non-zero, then the timer
2026is automatically rescheduled at the given intervals. 2003is automatically rescheduled at the given intervals.
2027 2004
2028=item $timer = $timer->start 2005=item $timer = $timer->start
2029 2006
2030Start the timer. 2007Start the timer.
2031 2008
2032=item $timer = $timer->start ($tstamp) 2009=item $timer = $timer->start ($tstamp[, $interval])
2033 2010
2034Set the event trigger time to C<$tstamp> and start the timer. 2011Set the event trigger time to C<$tstamp> and start the timer. Optionally
2012also replaces the interval.
2035 2013
2036=item $timer = $timer->after ($delay) 2014=item $timer = $timer->after ($delay[, $interval])
2037 2015
2038Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2016Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2039 2017
2040=item $timer = $timer->stop 2018=item $timer = $timer->stop
2041 2019
2049 2027
2050 $term->{socket} = ... 2028 $term->{socket} = ...
2051 $term->{iow} = urxvt::iow 2029 $term->{iow} = urxvt::iow
2052 ->new 2030 ->new
2053 ->fd (fileno $term->{socket}) 2031 ->fd (fileno $term->{socket})
2054 ->events (urxvt::EVENT_READ) 2032 ->events (urxvt::EV_READ)
2055 ->start 2033 ->start
2056 ->cb (sub { 2034 ->cb (sub {
2057 my ($iow, $revents) = @_; 2035 my ($iow, $revents) = @_;
2058 # $revents must be 1 here, no need to check 2036 # $revents must be 1 here, no need to check
2059 sysread $term->{socket}, my $buf, 8192 2037 sysread $term->{socket}, my $buf, 8192
2077Set the file descriptor (not handle) to watch. 2055Set the file descriptor (not handle) to watch.
2078 2056
2079=item $iow = $iow->events ($eventmask) 2057=item $iow = $iow->events ($eventmask)
2080 2058
2081Set the event mask to watch. The only allowed values are 2059Set the event mask to watch. The only allowed values are
2082C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2060C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2083together, or C<urxvt::EVENT_NONE>. 2061together, or C<urxvt::EV_NONE>.
2084 2062
2085=item $iow = $iow->start 2063=item $iow = $iow->start
2086 2064
2087Start watching for requested events on the given handle. 2065Start watching for requested events on the given handle.
2088 2066
2129 ->new 2107 ->new
2130 ->start ($pid) 2108 ->start ($pid)
2131 ->cb (sub { 2109 ->cb (sub {
2132 my ($pw, $exit_status) = @_; 2110 my ($pw, $exit_status) = @_;
2133 ... 2111 ...
2134 }); 2112 });
2135 2113
2136=over 4 2114=over 4
2137 2115
2138=item $pw = new urxvt::pw 2116=item $pw = new urxvt::pw
2139 2117
2172 2150
2173=back 2151=back
2174 2152
2175=head1 AUTHOR 2153=head1 AUTHOR
2176 2154
2177 Marc Lehmann <pcg@goof.com> 2155 Marc Lehmann <schmorp@schmorp.de>
2178 http://software.schmorp.de/pkg/rxvt-unicode 2156 http://software.schmorp.de/pkg/rxvt-unicode
2179 2157
2180=cut 2158=cut
2181 2159
21821 21601

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines