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.150 by root, Thu Dec 7 03:02:44 2006 UTC vs.
Revision 1.221 by sf-exg, Thu Jun 21 06:08:05 2012 UTC

20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Every time a terminal object gets created, extension scripts specified via 22Every time a terminal object gets created, extension scripts specified via
23the C<perl> resource are loaded and associated with it. 23the C<perl> resource are loaded and associated with it.
24 24
25Scripts are compiled in a 'use strict' and 'use utf8' environment, and 25Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
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.matcher.button: 1
266 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
267 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
268 URxvt.matcher.launcher.2: gvim +$2 $1
269
270=item xim-onthespot
271
272This (experimental) perl extension implements OnTheSpot editing. It does
273not work perfectly, and some input methods don't seem to work well with
274OnTheSpot editing in general, but it seems to work at leats for SCIM and
275kinput2.
276
277You enable it by specifying this extension and a preedit style of
278C<OnTheSpot>, i.e.:
279
280 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
281
282=item kuake<hotkey>
283
284A very primitive quake-console-like extension. It was inspired by a
285description of how the programs C<kuake> and C<yakuake> work: Whenever the
286user presses a global accelerator key (by default C<F10>), the terminal
287will show or hide itself. Another press of the accelerator key will hide
288or show it again.
289
290Initially, the window will not be shown when using this extension.
291
292This is useful if you need a single terminal thats not using any desktop
293space most of the time but is quickly available at the press of a key.
294
295The accelerator key is grabbed regardless of any modifiers, so this
296extension will actually grab a physical key just for this function.
297
298If you want a quake-like animation, tell your window manager to do so
299(fvwm can do it).
300
301=item automove-background
302
303This is basically a very small extension that dynamically changes the
304background pixmap offset to the window position, in effect creating the
305same effect as pseudo transparency with a custom pixmap. No scaling is
306supported in this mode. Example:
307
308 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
309
310=item block-graphics-to-ascii
311
312A not very useful example of filtering all text output to the terminal
313by replacing all line-drawing characters (U+2500 .. U+259F) by a
314similar-looking ascii character.
315
316=item digital-clock
317
318Displays a digital clock using the built-in overlay.
319
320=item remote-clipboard
321
322Somewhat of a misnomer, this extension adds two menu entries to the
323selection popup that allows one ti run external commands to store the
324selection somewhere and fetch it again.
325
326We use it to implement a "distributed selection mechanism", which just
327means that one command uploads the file to a remote server, and another
328reads it.
329
330The commands can be set using the C<URxvt.remote-selection.store> and
331C<URxvt.remote-selection.fetch> resources. The first should read the
332selection to store from STDIN (always in UTF-8), the second should provide
333the selection data on STDOUT (also in UTF-8).
334
335The defaults (which are likely useless to you) use rsh and cat:
336
337 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
338 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
339
340=item selection-pastebin
341
342This is a little rarely useful extension that Uploads the selection as
343textfile to a remote site (or does other things). (The implementation is
344not currently secure for use in a multiuser environment as it writes to
345F</tmp> directly.).
346
347It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
348i.e.
349
350 URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
351
352Pressing this combination runs a command with C<%> replaced by the name of
353the textfile. This command can be set via a resource:
354
355 URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
356
357And the default is likely not useful to anybody but the few people around
358here :)
359
360The name of the textfile is the hex encoded md5 sum of the selection, so
361the same content should lead to the same filename.
362
363After a successful upload the selection will be replaced by the text given
364in the C<selection-pastebin-url> resource (again, the % is the placeholder
365for the filename):
366
367 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
368
369I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
370the double C</> characters as comment start. Use C<\057\057> instead,
371which works regardless of wether xrdb is used to parse the resource file
372or not.
373
374=item example-refresh-hooks
375
376Displays a very simple digital clock in the upper right corner of the
377window. Illustrates overwriting the refresh callbacks to create your own
378overlays or changes.
379
380=back
381 50
382=head1 API DOCUMENTATION 51=head1 API DOCUMENTATION
383 52
384=head2 General API Considerations 53=head2 General API Considerations
385 54
399 68
400=over 4 69=over 4
401 70
402=item $text 71=item $text
403 72
404Rxvt-unicodes special way of encoding text, where one "unicode" character 73Rxvt-unicode's special way of encoding text, where one "unicode" character
405always 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.
406 75
407=item $string 76=item $string
408 77
409A 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
413=item $octets 82=item $octets
414 83
415Either binary data or - more common - a text string encoded in a 84Either binary data or - more common - a text string encoded in a
416locale-specific way. 85locale-specific way.
417 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
418=back 93=back
419 94
420=head2 Extension Objects 95=head2 Extension Objects
421 96
422Every 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
423for 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,
424which 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
425their C<$self> object without having to think about clashes with other 100their C<$self> object without having to think about clashes with other
426extensions or other terminals, with the exception of methods and members 101extensions or other terminals, with the exception of methods and members
427that begin with an underscore character C<_>: these are reserved for 102that begin with an underscore character C<_>: these are reserved for
428internal use. 103internal use.
437=item $urxvt_term = $self->{term} 112=item $urxvt_term = $self->{term}
438 113
439Returns the C<urxvt::term> object associated with this instance of the 114Returns the C<urxvt::term> object associated with this instance of the
440extension. This member I<must not> be changed in any way. 115extension. This member I<must not> be changed in any way.
441 116
442=item $self->enable ($hook_name => $cb, [$hook_name => $cb..]) 117=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
443 118
444Dynamically enable the given hooks (named without the C<on_> prefix) for 119Dynamically enable the given hooks (named without the C<on_> prefix) for
445this extension, replacing any previous hook. This is useful when you want 120this extension, replacing any previous hook. This is useful when you want
446to overwrite time-critical hooks only temporarily. 121to overwrite time-critical hooks only temporarily.
447 122
123To install additional callbacks for the same hook, you can use the C<on>
124method of the C<urxvt::term> class.
125
448=item $self->disable ($hook_name[, $hook_name..]) 126=item $self->disable ($hook_name[, $hook_name..])
449 127
450Dynamically 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.
451 137
452=back 138=back
453 139
454=head2 Hooks 140=head2 Hooks
455 141
543 229
544It 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,
545$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
546number of lines that will be in the scrollback buffer. 232number of lines that will be in the scrollback buffer.
547 233
548=item on_osc_seq $term, $op, $args 234=item on_osc_seq $term, $op, $args, $resp
549 235
550Called 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
551behaviour. 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
552suppresses execution of the request completely. Make sure you don't get 238suppresses execution of the request completely. Make sure you don't get
553confused by recursive invocations when you output an osc sequence within 239confused by recursive invocations when you output an OSC sequence within
554this callback. 240this callback.
555 241
556C<on_osc_seq_perl> should be used for new behaviour. 242C<on_osc_seq_perl> should be used for new behaviour.
557 243
558=item on_osc_seq_perl $term, $string 244=item on_osc_seq_perl $term, $args, $resp
559 245
560Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 246Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
561operating system command) is processed. Cursor position and other state 247operating system command) is processed. Cursor position and other state
562information is up-to-date when this happens. For interoperability, the 248information is up-to-date when this happens. For interoperability, the
563string should start with the extension name and a colon, to distinguish 249string should start with the extension name (sans -osc) and a semicolon,
564it from commands for other extensions, and this might be enforced in the 250to distinguish it from commands for other extensions, and this might be
565future. 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 }
566 262
567Be 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,
568as 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
569other 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.
570 269
571=item on_add_lines $term, $string 270=item on_add_lines $term, $string
572 271
573Called 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
574can 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
579=item on_tt_write $term, $octets 278=item on_tt_write $term, $octets
580 279
581Called 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
582suppress or filter tty input. 281suppress or filter tty input.
583 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
584=item on_line_update $term, $row 290=item on_line_update $term, $row
585 291
586Called 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
587screen output (e.g. underline urls or other useless stuff). Only lines 293screen output (e.g. underline urls or other useless stuff). Only lines
588that are being shown will be filtered, and, due to performance reasons, 294that are being shown will be filtered, and, due to performance reasons,
595later 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
596you cannot just toggle rendition bits, but only set them. 302you cannot just toggle rendition bits, but only set them.
597 303
598=item on_refresh_begin $term 304=item on_refresh_begin $term
599 305
600Called just before the screen gets redrawn. Can be used for overlay 306Called just before the screen gets redrawn. Can be used for overlay or
601or similar effects by modify terminal contents in refresh_begin, and 307similar effects by modifying the terminal contents in refresh_begin, and
602restoring them in refresh_end. The built-in overlay and selection display 308restoring them in refresh_end. The built-in overlay and selection display
603code is run after this hook, and takes precedence. 309code is run after this hook, and takes precedence.
604 310
605=item on_refresh_end $term 311=item on_refresh_end $term
606 312
613resource in the @@RXVT_NAME@@(1) manpage). 319resource in the @@RXVT_NAME@@(1) manpage).
614 320
615The 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
616slightly in the future. 322slightly in the future.
617 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
618=item on_resize_all_windows $tern, $new_width, $new_height 331=item on_resize_all_windows $term, $new_width, $new_height
619 332
620Called just after the new window size has been calculated, but before 333Called just after the new window size has been calculated, but before
621windows 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
622returns TRUE, setting of the window hints is being skipped. 335returns TRUE, setting of the window hints is being skipped.
623 336
657 370
658=item on_map_notify $term, $event 371=item on_map_notify $term, $event
659 372
660=item on_unmap_notify $term, $event 373=item on_unmap_notify $term, $event
661 374
662Called whenever the corresponding X event is received for the terminal If 375Called whenever the corresponding X event is received for the terminal. If
663the 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.
664 377
665The 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
666manpage), 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
667(real, not screen-based) row and column under the mouse cursor. 380(real, not screen-based) row and column under the mouse cursor.
668 381
678=item on_wm_delete_window $term, $event 391=item on_wm_delete_window $term, $event
679 392
680Called when various types of ClientMessage events are received (all with 393Called when various types of ClientMessage events are received (all with
681format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 394format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
682 395
396=item on_bell $term
397
398Called on receipt of a bell character.
399
683=back 400=back
684 401
685=cut 402=cut
686 403
687package urxvt; 404package urxvt;
688 405
689use utf8; 406use utf8;
690use strict; 407use strict 'vars';
691use Carp (); 408use Carp ();
692use Scalar::Util (); 409use Scalar::Util ();
693use List::Util (); 410use List::Util ();
694 411
695our $VERSION = 1; 412our $VERSION = 1;
696our $TERM; 413our $TERM;
697our @TERM_INIT; 414our @TERM_INIT; # should go, prevents async I/O etc.
698our @TERM_EXT; 415our @TERM_EXT; # should go, prevents async I/O etc.
699our @HOOKNAME; 416our @HOOKNAME;
700our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 417our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
701our %OPTION; 418our %OPTION;
702 419
703our $LIBDIR; 420our $LIBDIR;
751 468
752=over 4 469=over 4
753 470
754=item urxvt::fatal $errormessage 471=item urxvt::fatal $errormessage
755 472
756Fatally aborts execution with the given error message. Avoid at all 473Fatally aborts execution with the given error message (which should
757costs! The only time this is acceptable is when the terminal process 474include a trailing newline). Avoid at all costs! The only time this
758starts up. 475is acceptable (and useful) is in the init hook, where it prevents the
476terminal from starting up.
759 477
760=item urxvt::warn $string 478=item urxvt::warn $string
761 479
762Calls 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
763newline. The module also overwrites the C<warn> builtin with a function 481newline. The module also overwrites the C<warn> builtin with a function
764that calls this function. 482that calls this function.
765 483
766Using 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
767correct place, e.g. on stderr of the connecting urxvtc client. 485correct place, e.g. on stderr of the connecting urxvtc client.
771=item @terms = urxvt::termlist 489=item @terms = urxvt::termlist
772 490
773Returns all urxvt::term objects that exist in this process, regardless of 491Returns all urxvt::term objects that exist in this process, regardless of
774whether they are started, being destroyed etc., so be careful. Only term 492whether they are started, being destroyed etc., so be careful. Only term
775objects that have perl extensions attached will be returned (because there 493objects that have perl extensions attached will be returned (because there
776is no urxvt::term objet associated with others). 494is no urxvt::term object associated with others).
777 495
778=item $time = urxvt::NOW 496=item $time = urxvt::NOW
779 497
780Returns the "current time" (as per the event loop). 498Returns the "current time" (as per the event loop).
781 499
824 542
825=item $rend = urxvt::OVERLAY_RSTYLE 543=item $rend = urxvt::OVERLAY_RSTYLE
826 544
827Return the rendition mask used for overlays by default. 545Return the rendition mask used for overlays by default.
828 546
829=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
830 549
831Return the bit that enabled bold, italic, blink, reverse-video and 550Return the bit that enabled bold, italic, blink, reverse-video and
832underline, respectively. To enable such a style, just logically OR it into 551underline, respectively. To enable such a style, just logically OR it into
833the bitset. 552the bitset.
834 553
871 }; 590 };
872} 591}
873 592
874no warnings 'utf8'; 593no warnings 'utf8';
875 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
876my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 655my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
877 656
878sub verbose { 657sub verbose {
879 my ($level, $msg) = @_; 658 my ($level, $msg) = @_;
880 warn "$msg\n" if $level <= $verbosity; 659 warn "$msg\n" if $level <= $verbosity;
892 $pkg =~ s/[^[:word:]]/_/g; 671 $pkg =~ s/[^[:word:]]/_/g;
893 $pkg = "urxvt::ext::$pkg"; 672 $pkg = "urxvt::ext::$pkg";
894 673
895 verbose 3, "loading extension '$path' into package '$pkg'"; 674 verbose 3, "loading extension '$path' into package '$pkg'";
896 675
676 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
677
897 open my $fh, "<:raw", $path 678 open my $fh, "<:raw", $path
898 or die "$path: $!"; 679 or die "$path: $!";
899 680
900 my $source = 681 my $source =
901 "package $pkg; use strict; use utf8; no warnings 'utf8';\n" 682 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
902 . "#line 1 \"$path\"\n{\n" 683 . "#line 1 \"$path\"\n{\n"
903 . (do { local $/; <$fh> }) 684 . (do { local $/; <$fh> })
904 . "\n};\n1"; 685 . "\n};\n1";
905 686
906 eval $source 687 eval $source
916sub invoke { 697sub invoke {
917 local $TERM = shift; 698 local $TERM = shift;
918 my $htype = shift; 699 my $htype = shift;
919 700
920 if ($htype == 0) { # INIT 701 if ($htype == 0) { # INIT
921 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 702 my @dirs = $TERM->perl_libdirs;
922 703
923 my %ext_arg; 704 my %ext_arg;
924 705
925 { 706 {
926 my @init = @TERM_INIT; 707 my @init = @TERM_INIT;
927 @TERM_INIT = (); 708 @TERM_INIT = ();
929 my @pkg = @TERM_EXT; 710 my @pkg = @TERM_EXT;
930 @TERM_EXT = (); 711 @TERM_EXT = ();
931 $TERM->register_package ($_) for @pkg; 712 $TERM->register_package ($_) for @pkg;
932 } 713 }
933 714
715 for (
716 @{ delete $TERM->{perl_ext_3} },
934 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 717 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
718 ) {
935 if ($_ eq "default") { 719 if ($_ eq "default") {
936 $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);
937 } elsif (/^-(.*)$/) { 721 } elsif (/^-(.*)$/) {
938 delete $ext_arg{$1}; 722 delete $ext_arg{$1};
939 } elsif (/^([^<]+)<(.*)>$/) { 723 } elsif (/^([^<]+)<(.*)>$/) {
962 if (my $cb = $TERM->{_hook}[$htype]) { 746 if (my $cb = $TERM->{_hook}[$htype]) {
963 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 747 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
964 if $verbosity >= 10; 748 if $verbosity >= 10;
965 749
966 for my $pkg (keys %$cb) { 750 for my $pkg (keys %$cb) {
967 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) }; 751 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
968 $retval ||= $retval_; 752 $retval ||= $retval_;
969 753
970 if ($@) { 754 if ($@) {
971 $TERM->ungrab; # better to lose the grab than the session 755 $TERM->ungrab; # better to lose the grab than the session
972 warn $@; 756 warn $@;
990 774
991sub SET_COLOR($$$) { 775sub SET_COLOR($$$) {
992 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2]) 776 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
993} 777}
994 778
995# urxvt::term::extension 779sub rend2mask {
780 no strict 'refs';
781 my ($str, $mask) = (@_, 0);
782 my %color = ( fg => undef, bg => undef );
783 my @failed;
784 for my $spec ( split /\s+/, $str ) {
785 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
786 $color{lc($1)} = $2;
787 } else {
788 my $neg = $spec =~ s/^[-^]//;
789 unless ( exists &{"RS_$spec"} ) {
790 push @failed, $spec;
791 next;
792 }
793 my $cur = &{"RS_$spec"};
794 if ( $neg ) {
795 $mask &= ~$cur;
796 } else {
797 $mask |= $cur;
798 }
799 }
800 }
801 ($mask, @color{qw(fg bg)}, \@failed)
802}
996 803
997package urxvt::term::extension; 804package urxvt::term::extension;
998 805
999sub enable { 806sub enable {
1000 my ($self, %hook) = @_; 807 my ($self, %hook) = @_;
1055 862
1056sub urxvt::destroy_hook(&) { 863sub urxvt::destroy_hook(&) {
1057 bless \shift, urxvt::destroy_hook:: 864 bless \shift, urxvt::destroy_hook::
1058} 865}
1059 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
1060package urxvt::anyevent; 879package urxvt::anyevent;
1061 880
1062=head2 The C<urxvt::anyevent> Class 881=head2 The C<urxvt::anyevent> Class
1063 882
1064The 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
1065C<AnyEvent> module - any module using it will work inside urxvt without 884C<AnyEvent> module - any module using it will work inside urxvt without
1066further programming. The only exception is that you cannot wait on 885further programming. The only exception is that you cannot wait on
1067condition variables, but non-blocking condvar use is ok. What this means 886condition variables, but non-blocking condvar use is ok.
1068is that you cannot use blocking APIs, but the non-blocking variant should 887
1069work. 888In practical terms this means is that you cannot use blocking APIs, but
889the non-blocking variant should work.
1070 890
1071=cut 891=cut
1072 892
1073our $VERSION = 1; 893our $VERSION = '5.23';
1074 894
1075$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 895$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1076push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 896push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1077 897
1078sub timer { 898sub timer {
1080 900
1081 my $cb = $arg{cb}; 901 my $cb = $arg{cb};
1082 902
1083 urxvt::timer 903 urxvt::timer
1084 ->new 904 ->new
1085 ->start (urxvt::NOW + $arg{after}) 905 ->after ($arg{after}, $arg{interval})
1086 ->cb (sub { 906 ->cb ($arg{interval} ? $cb : sub {
1087 $_[0]->stop; # need to cancel manually 907 $_[0]->stop; # need to cancel manually
1088 $cb->(); 908 $cb->();
1089 }) 909 })
1090} 910}
1091 911
1092sub io { 912sub io {
1093 my ($class, %arg) = @_; 913 my ($class, %arg) = @_;
1094 914
1095 my $cb = $arg{cb}; 915 my $cb = $arg{cb};
916 my $fd = fileno $arg{fh};
917 defined $fd or $fd = $arg{fh};
1096 918
1097 bless [$arg{fh}, urxvt::iow 919 bless [$arg{fh}, urxvt::iow
1098 ->new 920 ->new
1099 ->fd (fileno $arg{fh}) 921 ->fd ($fd)
1100 ->events (($arg{poll} =~ /r/ ? 1 : 0) 922 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1101 | ($arg{poll} =~ /w/ ? 2 : 0)) 923 | ($arg{poll} =~ /w/ ? 2 : 0))
1102 ->start 924 ->start
1103 ->cb (sub { 925 ->cb ($cb)
1104 $cb->(($_[1] & 1 ? 'r' : '')
1105 . ($_[1] & 2 ? 'w' : ''));
1106 })],
1107 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 })
1108} 952}
1109 953
1110sub DESTROY { 954sub DESTROY {
1111 $_[0][1]->stop; 955 $_[0][1]->stop;
1112} 956}
1113 957
1114sub condvar { 958# only needed for AnyEvent < 6 compatibility
1115 bless \my $flag, urxvt::anyevent::
1116}
1117
1118sub broadcast {
1119 ${$_[0]}++;
1120}
1121
1122sub wait {
1123 unless (${$_[0]}) {
1124 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1125 }
1126}
1127
1128sub one_event { 959sub one_event {
1129 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";
1130} 961}
1131 962
1132package urxvt::term; 963package urxvt::term;
1147 urxvt::verbose 6, "register package $pkg to $self"; 978 urxvt::verbose 6, "register package $pkg to $self";
1148 979
1149 @{"$pkg\::ISA"} = urxvt::term::extension::; 980 @{"$pkg\::ISA"} = urxvt::term::extension::;
1150 981
1151 my $proxy = bless { 982 my $proxy = bless {
1152 _pkg => $pkg, 983 _pkg => $pkg,
984 _name => ${"$pkg\::_NAME"}, # hackish
1153 argv => $argv, 985 argv => $argv,
1154 }, $pkg; 986 }, $pkg;
1155 Scalar::Util::weaken ($proxy->{term} = $self); 987 Scalar::Util::weaken ($proxy->{term} = $self);
1156 988
1157 $self->{_pkg}{$pkg} = $proxy; 989 $self->{_pkg}{$pkg} = $proxy;
1158 990
1161 $proxy->enable ($name => $ref); 993 $proxy->enable ($name => $ref);
1162 } 994 }
1163 } 995 }
1164} 996}
1165 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
1166=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1045=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1167 1046
1168Creates 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
1169C<$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
1170hash which defines the environment of the new terminal. 1049hash which defines the environment of the new terminal.
1190 1069
1191Destroy the terminal object (close the window, free resources 1070Destroy the terminal object (close the window, free resources
1192etc.). 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
1193watchers (timers, io watchers) are still active. 1072watchers (timers, io watchers) are still active.
1194 1073
1074=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
1075
1076Similar to the extension method C<enable>, but installs additional
1077callbacks for the given hook(s) (existing ones are not replaced), and
1078returns a guard object. When the guard object is destroyed the callbacks
1079are disabled again.
1080
1081Note that these callbacks receive the normal parameters, but the first
1082argument (normally the extension) is currently undefined.
1083
1084=cut
1085
1086sub urxvt::term::on_disable::DESTROY {
1087 my $disable = shift;
1088
1089 my $self = delete $disable->{""};
1090
1091 while (my ($htype, $id) = each %$disable) {
1092 delete $self->{_hook}[$htype]{$id};
1093 $self->set_should_invoke ($htype, -1);
1094 }
1095}
1096
1097sub on {
1098 my ($self, %hook) = @_;
1099
1100 my %disable = ( "" => $self );
1101
1102 while (my ($name, $cb) = each %hook) {
1103 my $htype = $HOOKTYPE{uc $name};
1104 defined $htype
1105 or Carp::croak "unsupported hook type '$name'";
1106
1107 my $id = $cb+0;
1108
1109 $self->set_should_invoke ($htype, +1);
1110 $disable{$htype} = $id;
1111 $self->{_hook}[$htype]{$id} = $cb;
1112 }
1113
1114 bless \%disable, "urxvt::term::on_disable"
1115}
1116
1195=item $term->exec_async ($cmd[, @args]) 1117=item $term->exec_async ($cmd[, @args])
1196 1118
1197Works 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
1198("starts") programs in the background. This function takes care of setting 1120("starts") programs in the background. This function takes care of setting
1199the 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
1224C<%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.
1225 1147
1226Here 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
1227source file F</src/optinc.h> to see the actual list: 1149source file F</src/optinc.h> to see the actual list:
1228 1150
1229 borderLess console cursorBlink cursorUnderline hold iconic insecure 1151 borderLess buffered console cursorBlink cursorUnderline hold iconic
1230 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1152 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1231 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1153 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1232 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1154 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1233 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1155 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1234 transparent tripleclickwords utmpInhibit visualBell 1156 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1157 urgentOnBell utmpInhibit visualBell
1235 1158
1236=item $value = $term->resource ($name[, $newval]) 1159=item $value = $term->resource ($name[, $newval])
1237 1160
1238Returns the current resource value associated with a given name and 1161Returns the current resource value associated with a given name and
1239optionally 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>
1252 1175
1253Here 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
1254are 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>
1255to see the actual list: 1178to see the actual list:
1256 1179
1257 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1180 answerbackstring backgroundPixmap backspace_key blurradius
1258 borderLess color cursorBlink cursorUnderline cutchars delete_key 1181 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1259 display_name embed ext_bwidth fade font geometry hold iconName 1182 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1260 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
1261 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1185 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1262 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1186 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1263 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1187 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1264 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1188 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1265 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1189 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1190 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1267 secondaryScreen secondaryScroll selectstyle shade term_name title 1191 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1268 transient_for transparent transparent_all tripleclickwords utmpInhibit 1192 term_name title transient_for transparent tripleclickwords urgentOnBell
1269 visualBell 1193 utmpInhibit visualBell
1270 1194
1271=cut 1195=cut
1272 1196
1273sub resource($$;$) { 1197sub resource($$;$) {
1274 my ($self, $name) = (shift, shift); 1198 my ($self, $name) = (shift, shift);
1275 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1199 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1276 &urxvt::term::_resource 1200 goto &urxvt::term::_resource
1277} 1201}
1278 1202
1279=item $value = $term->x_resource ($pattern) 1203=item $value = $term->x_resource ($pattern)
1280 1204
1281Returns the X-Resource for the given pattern, excluding the program or 1205Returns the X-Resource for the given pattern, excluding the program or
1282class name, i.e. C<< $term->x_resource ("boldFont") >> should return the 1206class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1283same 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
1284resource with that pattern exists. 1208resource with that pattern exists.
1285 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
1286This 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
1287only one resource database per display, and later invocations might return 1221only one resource database per display, and later invocations might return
1288the wrong resources. 1222the wrong resources.
1289 1223
1290=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1224=item $value = $term->x_resource_boolean ($pattern)
1291 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
1292Adds a keymap translation exactly as specified via a resource. See the 1242Adds a key binding exactly as specified via a resource. See the
1293C<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.
1294 1251
1295=item $rend = $term->rstyle ([$new_rstyle]) 1252=item $rend = $term->rstyle ([$new_rstyle])
1296 1253
1297Return and optionally change the current rendition. Text that is output by 1254Return and optionally change the current rendition. Text that is output by
1298the terminal application will use this style. 1255the terminal application will use this style.
1306 1263
1307=item ($row, $col) = $term->selection_beg ([$row, $col]) 1264=item ($row, $col) = $term->selection_beg ([$row, $col])
1308 1265
1309=item ($row, $col) = $term->selection_end ([$row, $col]) 1266=item ($row, $col) = $term->selection_end ([$row, $col])
1310 1267
1311Return the current values of the selection mark, begin or end positions, 1268Return the current values of the selection mark, begin or end positions.
1312and 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.
1313 1277
1314=item $term->selection_make ($eventtime[, $rectangular]) 1278=item $term->selection_make ($eventtime[, $rectangular])
1315 1279
1316Tries to make a selection as set by C<selection_beg> and 1280Tries to make a selection as set by C<selection_beg> and
1317C<selection_end>. If C<$rectangular> is true (default: false), a 1281C<selection_end>. If C<$rectangular> is true (default: false), a
1318rectangular selection will be made. This is the prefered function to make 1282rectangular selection will be made. This is the preferred function to make
1319a selection. 1283a selection.
1320 1284
1321=item $success = $term->selection_grab ($eventtime) 1285=item $success = $term->selection_grab ($eventtime[, $clipboard])
1322 1286
1323Try 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
1324set by the next method). No visual feedback will be given. This function 1289with the next method. No visual feedback will be given. This function
1325is mostly useful from within C<on_sel_grab> hooks. 1290is mostly useful from within C<on_sel_grab> hooks.
1326 1291
1327=item $oldtext = $term->selection ([$newtext]) 1292=item $oldtext = $term->selection ([$newtext, $clipboard])
1328 1293
1329Return 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.
1330 1300
1331=item $term->overlay_simple ($x, $y, $text) 1301=item $term->overlay_simple ($x, $y, $text)
1332 1302
1333Create 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.
1334 1304
1364 1334
1365The methods currently supported on C<urxvt::overlay> objects are: 1335The methods currently supported on C<urxvt::overlay> objects are:
1366 1336
1367=over 4 1337=over 4
1368 1338
1369=item $overlay->set ($x, $y, $text, $rend) 1339=item $overlay->set ($x, $y, $text[, $rend])
1370 1340
1371Similar 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
1372text 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
1373at 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.
1374 1346
1375=item $overlay->hide 1347=item $overlay->hide
1376 1348
1377If visible, hide the overlay, but do not destroy it. 1349If visible, hide the overlay, but do not destroy it.
1378 1350
1460locale-specific encoding of the terminal and can contain command sequences 1432locale-specific encoding of the terminal and can contain command sequences
1461(escape codes) that will be interpreted. 1433(escape codes) that will be interpreted.
1462 1434
1463=item $term->tt_write ($octets) 1435=item $term->tt_write ($octets)
1464 1436
1465Write 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
1466pass characters instead of octets, you should convert your strings first 1438pass characters instead of octets, you should convert your strings first
1467to 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.
1468 1446
1469=item $old_events = $term->pty_ev_events ([$new_events]) 1447=item $old_events = $term->pty_ev_events ([$new_events])
1470 1448
1471Replaces 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
1472be 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
1491Adds 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
1492to receive pointer events all the times: 1470to receive pointer events all the times:
1493 1471
1494 $term->vt_emask_add (urxvt::PointerMotionMask); 1472 $term->vt_emask_add (urxvt::PointerMotionMask);
1495 1473
1474=item $term->set_urgency ($set)
1475
1476Enable/disable the urgency hint on the toplevel window.
1477
1496=item $term->focus_in 1478=item $term->focus_in
1497 1479
1498=item $term->focus_out 1480=item $term->focus_out
1499 1481
1500=item $term->key_press ($state, $keycode[, $time]) 1482=item $term->key_press ($state, $keycode[, $time])
1588 1570
1589Used after changing terminal contents to display them. 1571Used after changing terminal contents to display them.
1590 1572
1591=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1573=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1592 1574
1593Returns 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 >>
1594is 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
1595terminal line. The scrollback buffer starts at line C<-1> and extends to
1596line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1577terminal line. Nothing will be returned if a nonexistent line
1597is requested. 1578is requested.
1598 1579
1599If 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
1600line, 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
1601to 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
1602automatically be updated. 1583automatically be updated.
1603 1584
1604C<$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
1605than 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)
1606characters. Characters with combining characters and other characters that 1587characters. Characters with combining characters and other characters that
1607do 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
1608in the private use area. 1589in the private use area.
1609 1590
1610You have to obey this encoding when changing text. The advantage is 1591You have to obey this encoding when changing text. The advantage is
1611that 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
1612characters. 1593characters.
1787Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1768Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1788recent grab. 1769recent grab.
1789 1770
1790=item $term->ungrab 1771=item $term->ungrab
1791 1772
1792Calls XUngrab for the most recent grab. Is called automatically on 1773Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1793evaluation 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
1794the session. 1775the session.
1795 1776
1796=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 1777=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1797 1778
1799 1780
1800=item @atoms = $term->XListProperties ($window) 1781=item @atoms = $term->XListProperties ($window)
1801 1782
1802=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1783=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1803 1784
1804=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1785=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1805 1786
1806=item $term->XDeleteProperty ($window, $property) 1787=item $term->XDeleteProperty ($window, $property)
1807 1788
1808=item $window = $term->DefaultRootWindow 1789=item $window = $term->DefaultRootWindow
1809 1790
1816=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 1797=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1817 1798
1818=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 1799=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1819 1800
1820=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)
1821 1806
1822Various 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
1823the source of the display, otherwise those functions map more-or-less 1808the source of the display, otherwise those functions map more-or-less
1824directory onto the X functions of the same name. 1809directly onto the X functions of the same name.
1825 1810
1826=back 1811=back
1827 1812
1828=cut 1813=cut
1829 1814
1931 my $env = $self->{term}->env; 1916 my $env = $self->{term}->env;
1932 # 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.
1933 delete $env->{LC_ALL}; 1918 delete $env->{LC_ALL};
1934 $env->{LC_CTYPE} = $self->{term}->locale; 1919 $env->{LC_CTYPE} = $self->{term}->locale;
1935 1920
1936 urxvt::term->new ($env, "popup", 1921 my $term = urxvt::term->new (
1922 $env, "popup",
1937 "--perl-lib" => "", "--perl-ext-common" => "", 1923 "--perl-lib" => "", "--perl-ext-common" => "",
1938 "-pty-fd" => -1, "-sl" => 0, 1924 "-pty-fd" => -1, "-sl" => 0,
1939 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1925 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1940 "--transient-for" => $self->{term}->parent, 1926 "--transient-for" => $self->{term}->parent,
1941 "-display" => $self->{term}->display_id, 1927 "-display" => $self->{term}->display_id,
1942 "-pe" => "urxvt-popup") 1928 "-pe" => "urxvt-popup",
1943 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 }
1944} 1936}
1945 1937
1946sub DESTROY { 1938sub DESTROY {
1947 my ($self) = @_; 1939 my ($self) = @_;
1948 1940
1953=back 1945=back
1954 1946
1955=cut 1947=cut
1956 1948
1957package urxvt::watcher; 1949package urxvt::watcher;
1958
1959@urxvt::timer::ISA = __PACKAGE__;
1960@urxvt::iow::ISA = __PACKAGE__;
1961@urxvt::pw::ISA = __PACKAGE__;
1962@urxvt::iw::ISA = __PACKAGE__;
1963 1950
1964=head2 The C<urxvt::timer> Class 1951=head2 The C<urxvt::timer> Class
1965 1952
1966This class implements timer watchers/events. Time is represented as a 1953This class implements timer watchers/events. Time is represented as a
1967fractional number of seconds since the epoch. Example: 1954fractional number of seconds since the epoch. Example:
1971 ->new 1958 ->new
1972 ->interval (1) 1959 ->interval (1)
1973 ->cb (sub { 1960 ->cb (sub {
1974 $term->{overlay}->set (0, 0, 1961 $term->{overlay}->set (0, 0,
1975 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1962 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1976 }); 1963 });
1977 1964
1978=over 4 1965=over 4
1979 1966
1980=item $timer = new urxvt::timer 1967=item $timer = new urxvt::timer
1981 1968
1984 1971
1985=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1972=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1986 1973
1987Set the callback to be called when the timer triggers. 1974Set the callback to be called when the timer triggers.
1988 1975
1989=item $tstamp = $timer->at
1990
1991Return the time this watcher will fire next.
1992
1993=item $timer = $timer->set ($tstamp) 1976=item $timer = $timer->set ($tstamp[, $interval])
1994 1977
1995Set the time the event is generated to $tstamp. 1978Set the time the event is generated to $tstamp (and optionally specifies a
1979new $interval).
1996 1980
1997=item $timer = $timer->interval ($interval) 1981=item $timer = $timer->interval ($interval)
1998 1982
1999Normally (and when C<$interval> is C<0>), the timer will automatically 1983By default (and when C<$interval> is C<0>), the timer will automatically
2000stop 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
2001is automatically rescheduled at the given intervals. 1985is automatically rescheduled at the given intervals.
2002 1986
2003=item $timer = $timer->start 1987=item $timer = $timer->start
2004 1988
2005Start the timer. 1989Start the timer.
2006 1990
2007=item $timer = $timer->start ($tstamp) 1991=item $timer = $timer->start ($tstamp[, $interval])
2008 1992
2009Set 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.
2010 1995
2011=item $timer = $timer->after ($delay) 1996=item $timer = $timer->after ($delay[, $interval])
2012 1997
2013Like 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>.
2014 1999
2015=item $timer = $timer->stop 2000=item $timer = $timer->stop
2016 2001
2024 2009
2025 $term->{socket} = ... 2010 $term->{socket} = ...
2026 $term->{iow} = urxvt::iow 2011 $term->{iow} = urxvt::iow
2027 ->new 2012 ->new
2028 ->fd (fileno $term->{socket}) 2013 ->fd (fileno $term->{socket})
2029 ->events (urxvt::EVENT_READ) 2014 ->events (urxvt::EV_READ)
2030 ->start 2015 ->start
2031 ->cb (sub { 2016 ->cb (sub {
2032 my ($iow, $revents) = @_; 2017 my ($iow, $revents) = @_;
2033 # $revents must be 1 here, no need to check 2018 # $revents must be 1 here, no need to check
2034 sysread $term->{socket}, my $buf, 8192 2019 sysread $term->{socket}, my $buf, 8192
2052Set the file descriptor (not handle) to watch. 2037Set the file descriptor (not handle) to watch.
2053 2038
2054=item $iow = $iow->events ($eventmask) 2039=item $iow = $iow->events ($eventmask)
2055 2040
2056Set the event mask to watch. The only allowed values are 2041Set the event mask to watch. The only allowed values are
2057C<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
2058together, or C<urxvt::EVENT_NONE>. 2043together, or C<urxvt::EV_NONE>.
2059 2044
2060=item $iow = $iow->start 2045=item $iow = $iow->start
2061 2046
2062Start watching for requested events on the given handle. 2047Start watching for requested events on the given handle.
2063 2048
2104 ->new 2089 ->new
2105 ->start ($pid) 2090 ->start ($pid)
2106 ->cb (sub { 2091 ->cb (sub {
2107 my ($pw, $exit_status) = @_; 2092 my ($pw, $exit_status) = @_;
2108 ... 2093 ...
2109 }); 2094 });
2110 2095
2111=over 4 2096=over 4
2112 2097
2113=item $pw = new urxvt::pw 2098=item $pw = new urxvt::pw
2114 2099
2147 2132
2148=back 2133=back
2149 2134
2150=head1 AUTHOR 2135=head1 AUTHOR
2151 2136
2152 Marc Lehmann <pcg@goof.com> 2137 Marc Lehmann <schmorp@schmorp.de>
2153 http://software.schmorp.de/pkg/rxvt-unicode 2138 http://software.schmorp.de/pkg/rxvt-unicode
2154 2139
2155=cut 2140=cut
2156 2141
21571 21421
2143
2144# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines