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.46 by root, Sat Jan 7 20:29:28 2006 UTC vs.
Revision 1.253 by sf-exg, Fri Jan 16 20:13:01 2015 UTC

1=encoding utf8 1=encoding utf8
2 2
3=head1 NAME 3=head1 NAME
4 4
5@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter 5urxvtperl - rxvt-unicode's embedded perl interpreter
6 6
7=head1 SYNOPSIS 7=head1 SYNOPSIS
8 8
9 # create a file grab_test in $HOME: 9 # create a file grab_test in $HOME:
10 10
11 sub on_sel_grab { 11 sub on_sel_grab {
12 warn "you selected ", $_[0]->selection; 12 warn "you selected ", $_[0]->selection;
13 () 13 ()
14 } 14 }
15 15
16 # start a @@RXVT_NAME@@ using it: 16 # start a urxvt using it:
17 17
18 @@RXVT_NAME@@ --perl-lib $HOME -pe grab_test 18 urxvt --perl-lib $HOME -pe grab_test
19 19
20=head1 DESCRIPTION 20=head1 DESCRIPTION
21 21
22Everytime 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 urxvtd, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31=head2 Prepackaged Extensions 31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
32 33
33This section describes the extensiosn delivered with this version. You can 34=head1 PREPACKAGED EXTENSIONS
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 35
36A number of extensions are delivered with this release. You can find them
37in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38F<< 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 urxvt -pe <extensionname>
39 43
40=over 4 44Or by adding them to the resource for extensions loaded by default:
41 45
42=item selection 46 URxvt.perl-ext-common: default,selection-autotransform
43 47
44Intelligent selection. This extension tries to be more intelligent when 48Extensions may add additional resources and C<actions>, i.e., methods
45the user extends selections (double-click). Right now, it tries to select 49which can be bound to a key and invoked by the user. An extension can
46urls and complete shell-quoted arguments, which is very convenient, too, 50define the resources it support using so called META comments,
47if your F<ls> supports C<--quoting-style=shell>. 51described below. Similarly to builtin resources, extension resources
52can also be specified on the command line as long options (with C<.>
53replaced by C<->), in which case the corresponding extension is loaded
54automatically. For this to work the extension B<must> define META
55comments for its resources.
48 56
49It also offers the following bindable event: 57=head1 API DOCUMENTATION
50
51=over 4
52
53=item rot13
54
55Rot-13 the selection when activated. Used via keyboard trigger:
56
57 URxvt.keysym.C-M-r: perl:selection:rot13
58
59=back
60
61=item digital-clock
62
63Displays a digital clock using the built-in overlay.
64
65=item mark-urls
66
67Uses per-line display filtering (C<on_line_update>) to underline urls.
68
69=item block-graphics-to-ascii
70
71A not very useful example of filtering all text output to the terminal,
72by replacing all line-drawing characters (U+2500 .. U+259F) by a
73similar-looking ascii character.
74
75=item example-refresh-hooks
76
77Displays a very simple digital clock in the upper right corner of the
78window. Illustrates overwriting the refresh callbacks to create your own
79overlays or changes.
80
81=back
82 58
83=head2 General API Considerations 59=head2 General API Considerations
84 60
85All objects (such as terminals, time watchers etc.) are typical 61All objects (such as terminals, time watchers etc.) are typical
86reference-to-hash objects. The hash can be used to store anything you 62reference-to-hash objects. The hash can be used to store anything you
98 74
99=over 4 75=over 4
100 76
101=item $text 77=item $text
102 78
103Rxvt-unicodes special way of encoding text, where one "unicode" character 79Rxvt-unicode's special way of encoding text, where one "unicode" character
104always represents one screen cell. See L<row_t> for a discussion of this format. 80always represents one screen cell. See L<ROW_t> for a discussion of this format.
105 81
106=item $string 82=item $string
107 83
108A perl text string, with an emphasis on I<text>. It can store all unicode 84A perl text string, with an emphasis on I<text>. It can store all unicode
109characters and is to be distinguished with text encoded in a specific 85characters and is to be distinguished with text encoded in a specific
112=item $octets 88=item $octets
113 89
114Either binary data or - more common - a text string encoded in a 90Either binary data or - more common - a text string encoded in a
115locale-specific way. 91locale-specific way.
116 92
93=item $keysym
94
95an integer that is a valid X11 keysym code. You can convert a string
96into a keysym and viceversa by using C<XStringToKeysym> and
97C<XKeysymToString>.
98
99=back
100
101=head2 Extension Objects
102
103Every perl extension is a perl class. A separate perl object is created
104for each terminal, and each terminal has its own set of extension objects,
105which are passed as the first parameter to hooks. So extensions can use
106their C<$self> object without having to think about clashes with other
107extensions or other terminals, with the exception of methods and members
108that begin with an underscore character C<_>: these are reserved for
109internal use.
110
111Although it isn't a C<urxvt::term> object, you can call all methods of the
112C<urxvt::term> class on this object.
113
114Additional methods only supported for extension objects are described in
115the C<urxvt::extension> section below.
116
117=head2 META comments
118
119Rxvt-unicode recognizes special meta comments in extensions that define
120different types of metadata.
121
122Currently, it recognises only one such comment:
123
124=over 4
125
126=item #:META:RESOURCE:name:type:desc
127
128The RESOURCE comment defines a resource used by the extension, where
129C<name> is the resource name, C<type> is the resource type, C<boolean>
130or C<string>, and C<desc> is the resource description.
131
117=back 132=back
118 133
119=head2 Hooks 134=head2 Hooks
120 135
121The following subroutines can be declared in extension files, and will be 136The following subroutines can be declared in extension files, and will be
122called whenever the relevant event happens. 137called whenever the relevant event happens.
123 138
124The first argument passed to them is an object private to each terminal 139The first argument passed to them is an extension object as described in
125and extension package. You can call all C<urxvt::term> methods on it, but 140the in the C<Extension Objects> section.
126its not a real C<urxvt::term> object. Instead, the real C<urxvt::term>
127object that is shared between all packages is stored in the C<term>
128member. It is, however, blessed intot he package of the extension script,
129so for all practical purposes you can treat an extension script as a class.
130 141
131All of them must return a boolean value. If it is true, then the event 142B<All> of these hooks must return a boolean value. If any of the called
132counts as being I<consumed>, and the invocation of other hooks is skipped, 143hooks returns true, then the event counts as being I<consumed>, and the
133and the relevant action might not be carried out by the C++ code. 144relevant action might not be carried out by the C++ code.
134 145
135When in doubt, return a false value (preferably C<()>). 146I<< When in doubt, return a false value (preferably C<()>). >>
136 147
137=over 4 148=over 4
138 149
139=item on_init $term 150=item on_init $term
140 151
141Called after a new terminal object has been initialized, but before 152Called after a new terminal object has been initialized, but before
142windows are created or the command gets run. Most methods are unsafe to 153windows are created or the command gets run. Most methods are unsafe to
143call or deliver senseless data, as terminal size and other characteristics 154call or deliver senseless data, as terminal size and other characteristics
144have not yet been determined. You can safely query and change resources, 155have not yet been determined. You can safely query and change resources
145though. 156and options, though. For many purposes the C<on_start> hook is a better
157place.
158
159=item on_start $term
160
161Called at the very end of initialisation of a new terminal, just before
162trying to map (display) the toplevel and returning to the main loop.
163
164=item on_destroy $term
165
166Called whenever something tries to destroy terminal, when the terminal is
167still fully functional (not for long, though).
146 168
147=item on_reset $term 169=item on_reset $term
148 170
149Called after the screen is "reset" for any reason, such as resizing or 171Called after the screen is "reset" for any reason, such as resizing or
150control sequences. Here is where you can react on changes to size-related 172control sequences. Here is where you can react on changes to size-related
151variables. 173variables.
152 174
153=item on_start $term 175=item on_child_start $term, $pid
154 176
155Called at the very end of initialisation of a new terminal, just before 177Called just after the child process has been C<fork>ed.
156returning to the mainloop. 178
179=item on_child_exit $term, $status
180
181Called just after the child process has exited. C<$status> is the status
182from C<waitpid>.
157 183
158=item on_sel_make $term, $eventtime 184=item on_sel_make $term, $eventtime
159 185
160Called whenever a selection has been made by the user, but before the 186Called whenever a selection has been made by the user, but before the
161selection text is copied, so changes to the beginning, end or type of the 187selection text is copied, so changes to the beginning, end or type of the
168 194
169Called whenever a selection has been copied, but before the selection is 195Called whenever a selection has been copied, but before the selection is
170requested from the server. The selection text can be queried and changed 196requested from the server. The selection text can be queried and changed
171by calling C<< $term->selection >>. 197by calling C<< $term->selection >>.
172 198
173Returning a true value aborts selection grabbing. It will still be hilighted. 199Returning a true value aborts selection grabbing. It will still be highlighted.
174 200
175=item on_sel_extend $term 201=item on_sel_extend $term
176 202
177Called whenever the user tries to extend the selection (e.g. with a double 203Called whenever the user tries to extend the selection (e.g. with a double
178click) and is either supposed to return false (normal operation), or 204click) and is either supposed to return false (normal operation), or
179should extend the selection itelf and return true to suppress the built-in 205should extend the selection itself and return true to suppress the built-in
180processing. 206processing. This can happen multiple times, as long as the callback
207returns true, it will be called on every further click by the user and is
208supposed to enlarge the selection more and more, if possible.
181 209
182See the F<selection> example extension. 210See the F<selection> example extension.
183 211
184=item on_view_change $term, $offset 212=item on_view_change $term, $offset
185 213
186Called whenever the view offset changes, i..e the user or program 214Called whenever the view offset changes, i.e. the user or program
187scrolls. Offset C<0> means display the normal terminal, positive values 215scrolls. Offset C<0> means display the normal terminal, positive values
188show this many lines of scrollback. 216show this many lines of scrollback.
189 217
190=item on_scroll_back $term, $lines, $saved 218=item on_scroll_back $term, $lines, $saved
191 219
195 223
196It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 224It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
197$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 225$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
198number of lines that will be in the scrollback buffer. 226number of lines that will be in the scrollback buffer.
199 227
200=item on_tty_activity $term *NYI*
201
202Called whenever the program(s) running in the urxvt window send output.
203
204=item on_osc_seq $term, $string 228=item on_osc_seq $term, $op, $args, $resp
229
230Called on every OSC sequence and can be used to suppress it or modify its
231behaviour. The default should be to return an empty list. A true value
232suppresses execution of the request completely. Make sure you don't get
233confused by recursive invocations when you output an OSC sequence within
234this callback.
235
236C<on_osc_seq_perl> should be used for new behaviour.
237
238=item on_osc_seq_perl $term, $args, $resp
205 239
206Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 240Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
207operating system command) is processed. Cursor position and other state 241operating system command) is processed. Cursor position and other state
208information is up-to-date when this happens. For interoperability, the 242information is up-to-date when this happens. For interoperability, the
209string should start with the extension name and a colon, to distinguish 243string should start with the extension name (sans -osc) and a semicolon,
210it from commands for other extensions, and this might be enforced in the 244to distinguish it from commands for other extensions, and this might be
211future. 245enforced in the future.
246
247For example, C<overlay-osc> uses this:
248
249 sub on_osc_seq_perl {
250 my ($self, $osc, $resp) = @_;
251
252 return unless $osc =~ s/^overlay;//;
253
254 ... process remaining $osc string
255 }
212 256
213Be careful not ever to trust (in a security sense) the data you receive, 257Be careful not ever to trust (in a security sense) the data you receive,
214as its source can not easily be controleld (e-mail content, messages from 258as its source can not easily be controlled (e-mail content, messages from
215other users on the same system etc.). 259other users on the same system etc.).
260
261For responses, C<$resp> contains the end-of-args separator used by the
262sender.
216 263
217=item on_add_lines $term, $string 264=item on_add_lines $term, $string
218 265
219Called whenever text is about to be output, with the text as argument. You 266Called whenever text is about to be output, with the text as argument. You
220can filter/change and output the text yourself by returning a true value 267can filter/change and output the text yourself by returning a true value
221and calling C<< $term->scr_add_lines >> yourself. Please note that this 268and calling C<< $term->scr_add_lines >> yourself. Please note that this
222might be very slow, however, as your hook is called for B<all> text being 269might be very slow, however, as your hook is called for B<all> text being
223output. 270output.
224 271
272=item on_tt_write $term, $octets
273
274Called whenever some data is written to the tty/pty and can be used to
275suppress or filter tty input.
276
277=item on_tt_paste $term, $octets
278
279Called whenever text is about to be pasted, with the text as argument. You
280can filter/change and paste the text yourself by returning a true value
281and calling C<< $term->tt_paste >> yourself. C<$octets> is
282locale-encoded.
283
225=item on_line_update $term, $row 284=item on_line_update $term, $row
226 285
227Called whenever a line was updated or changed. Can be used to filter 286Called whenever a line was updated or changed. Can be used to filter
228screen output (e.g. underline urls or other useless stuff). Only lines 287screen output (e.g. underline urls or other useless stuff). Only lines
229that are being shown will be filtered, and, due to performance reasons, 288that are being shown will be filtered, and, due to performance reasons,
236later with the already-modified line (e.g. if unrelated parts change), so 295later with the already-modified line (e.g. if unrelated parts change), so
237you cannot just toggle rendition bits, but only set them. 296you cannot just toggle rendition bits, but only set them.
238 297
239=item on_refresh_begin $term 298=item on_refresh_begin $term
240 299
241Called just before the screen gets redrawn. Can be used for overlay 300Called just before the screen gets redrawn. Can be used for overlay or
242or similar effects by modify terminal contents in refresh_begin, and 301similar effects by modifying the terminal contents in refresh_begin, and
243restoring them in refresh_end. The built-in overlay and selection display 302restoring them in refresh_end. The built-in overlay and selection display
244code is run after this hook, and takes precedence. 303code is run after this hook, and takes precedence.
245 304
246=item on_refresh_end $term 305=item on_refresh_end $term
247 306
248Called just after the screen gets redrawn. See C<on_refresh_begin>. 307Called just after the screen gets redrawn. See C<on_refresh_begin>.
249 308
309=item on_action $term, $string
310
311Called whenever an action is invoked for the corresponding extension
312(e.g. via a C<extension:string> builtin action bound to a key, see
313description of the B<keysym> resource in the urxvt(1) manpage). The
314event is simply the action string. Note that an action event is always
315associated to a single extension.
316
250=item on_keyboard_command $term, $string 317=item on_user_command $term, $string *DEPRECATED*
251 318
252Called whenever the user presses a key combination that has a 319Called whenever a user-configured event is being activated (e.g. via
253C<perl:string> action bound to it (see description of the B<keysym> 320a C<perl:string> action bound to a key, see description of the B<keysym>
254resource in the @@RXVT_NAME@@(1) manpage). 321resource in the urxvt(1) manpage).
322
323The event is simply the action string. This interface is going away in
324preference to the C<on_action> hook.
325
326=item on_resize_all_windows $term, $new_width, $new_height
327
328Called just after the new window size has been calculated, but before
329windows are actually being resized or hints are being set. If this hook
330returns a true value, setting of the window hints is being skipped.
331
332=item on_x_event $term, $event
333
334Called on every X event received on the vt window (and possibly other
335windows). Should only be used as a last resort. Most event structure
336members are not passed.
337
338=item on_root_event $term, $event
339
340Like C<on_x_event>, but is called for events on the root window.
255 341
256=item on_focus_in $term 342=item on_focus_in $term
257 343
258Called whenever the window gets the keyboard focus, before rxvt-unicode 344Called whenever the window gets the keyboard focus, before rxvt-unicode
259does focus in processing. 345does focus in processing.
260 346
261=item on_focus_out $term 347=item on_focus_out $term
262 348
263Called wheneever the window loses keyboard focus, before rxvt-unicode does 349Called whenever the window loses keyboard focus, before rxvt-unicode does
264focus out processing. 350focus out processing.
265 351
352=item on_configure_notify $term, $event
353
354=item on_property_notify $term, $event
355
266=item on_key_press $term, $event, $octets 356=item on_key_press $term, $event, $keysym, $octets
267 357
268=item on_key_release $term, $event 358=item on_key_release $term, $event, $keysym
269 359
270=item on_button_press $term, $event 360=item on_button_press $term, $event
271 361
272=item on_button_release $term, $event 362=item on_button_release $term, $event
273 363
275 365
276=item on_map_notify $term, $event 366=item on_map_notify $term, $event
277 367
278=item on_unmap_notify $term, $event 368=item on_unmap_notify $term, $event
279 369
280Called whenever the corresponding X event is received for the terminal If 370Called whenever the corresponding X event is received for the terminal. If
281the hook returns true, then the even will be ignored by rxvt-unicode. 371the hook returns true, then the event will be ignored by rxvt-unicode.
282 372
283The event is a hash with most values as named by Xlib (see the XEvent 373The event is a hash with most values as named by Xlib (see the XEvent
284manpage), with the additional members C<row> and C<col>, which are the row 374manpage), with the additional members C<row> and C<col>, which are the
285and column under the mouse cursor. 375(real, not screen-based) row and column under the mouse cursor.
286 376
287C<on_key_press> additionally receives the string rxvt-unicode would 377C<on_key_press> additionally receives the string rxvt-unicode would
288output, if any, in locale-specific encoding. 378output, if any, in locale-specific encoding.
289 379
290subwindow. 380=item on_client_message $term, $event
381
382=item on_wm_protocols $term, $event
383
384=item on_wm_delete_window $term, $event
385
386Called when various types of ClientMessage events are received (all with
387format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
388
389=item on_bell $term
390
391Called on receipt of a bell character.
291 392
292=back 393=back
293 394
395=cut
396
397package urxvt;
398
399use utf8;
400use strict 'vars';
401use Carp ();
402use Scalar::Util ();
403use List::Util ();
404
405our $VERSION = 1;
406our $TERM;
407our @TERM_INIT; # should go, prevents async I/O etc.
408our @TERM_EXT; # should go, prevents async I/O etc.
409our @HOOKNAME;
410our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
411our %OPTION;
412
413our $LIBDIR;
414our $RESNAME;
415our $RESCLASS;
416our $RXVTNAME;
417
418our $NOCHAR = chr 0xffff;
419
294=head2 Variables in the C<urxvt> Package 420=head2 Variables in the C<urxvt> Package
295 421
296=over 4 422=over 4
423
424=item $urxvt::LIBDIR
425
426The rxvt-unicode library directory, where, among other things, the perl
427modules and scripts are stored.
428
429=item $urxvt::RESCLASS, $urxvt::RESCLASS
430
431The resource class and name rxvt-unicode uses to look up X resources.
432
433=item $urxvt::RXVTNAME
434
435The basename of the installed binaries, usually C<urxvt>.
297 436
298=item $urxvt::TERM 437=item $urxvt::TERM
299 438
300The current terminal. This variable stores the current C<urxvt::term> 439The current terminal. This variable stores the current C<urxvt::term>
301object, whenever a callback/hook is executing. 440object, whenever a callback/hook is executing.
302 441
442=item @urxvt::TERM_INIT
443
444All code references in this array will be called as methods of the next newly
445created C<urxvt::term> object (during the C<on_init> phase). The array
446gets cleared before the code references that were in it are being executed,
447so references can push themselves onto it again if they so desire.
448
449This complements to the perl-eval command line option, but gets executed
450first.
451
452=item @urxvt::TERM_EXT
453
454Works similar to C<@TERM_INIT>, but contains perl package/class names, which
455get registered as normal extensions after calling the hooks in C<@TERM_INIT>
456but before other extensions. Gets cleared just like C<@TERM_INIT>.
457
303=back 458=back
304 459
305=head2 Functions in the C<urxvt> Package 460=head2 Functions in the C<urxvt> Package
306 461
307=over 4 462=over 4
308 463
309=item $term = new urxvt [arg...]
310
311Creates a new terminal, very similar as if you had started it with
312C<system $binfile, arg...>. Croaks (and probably outputs an error message)
313if the new instance couldn't be created. Returns C<undef> if the new
314instance didn't initialise perl, and the terminal object otherwise. The
315C<init> and C<start> hooks will be called during the call.
316
317=item urxvt::fatal $errormessage 464=item urxvt::fatal $errormessage
318 465
319Fatally aborts execution with the given error message. Avoid at all 466Fatally aborts execution with the given error message (which should
320costs! The only time this is acceptable is when the terminal process 467include a trailing newline). Avoid at all costs! The only time this
321starts up. 468is acceptable (and useful) is in the init hook, where it prevents the
469terminal from starting up.
322 470
323=item urxvt::warn $string 471=item urxvt::warn $string
324 472
325Calls C<rxvt_warn> with the given string which should not include a 473Calls C<rxvt_warn> with the given string which should include a trailing
326newline. The module also overwrites the C<warn> builtin with a function 474newline. The module also overwrites the C<warn> builtin with a function
327that calls this function. 475that calls this function.
328 476
329Using this function has the advantage that its output ends up in the 477Using this function has the advantage that its output ends up in the
330correct place, e.g. on stderr of the connecting urxvtc client. 478correct place, e.g. on stderr of the connecting urxvtc client.
331 479
480Messages have a size limit of 1023 bytes currently.
481
482=item @terms = urxvt::termlist
483
484Returns all urxvt::term objects that exist in this process, regardless of
485whether they are started, being destroyed etc., so be careful. Only term
486objects that have perl extensions attached will be returned (because there
487is no urxvt::term object associated with others).
488
332=item $time = urxvt::NOW 489=item $time = urxvt::NOW
333 490
334Returns the "current time" (as per the event loop). 491Returns the "current time" (as per the event loop).
492
493=item urxvt::CurrentTime
494
495=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
496Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
497Button4Mask, Button5Mask, AnyModifier
498
499=item urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
500ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
501PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
502Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
503KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
504ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
505FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask
506
507=item urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
508EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
509GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
510UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
511ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
512CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
513SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
514
515Various constants for use in X calls and event processing.
335 516
336=back 517=back
337 518
338=head2 RENDITION 519=head2 RENDITION
339 520
354 535
355=item $rend = urxvt::OVERLAY_RSTYLE 536=item $rend = urxvt::OVERLAY_RSTYLE
356 537
357Return the rendition mask used for overlays by default. 538Return the rendition mask used for overlays by default.
358 539
359=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 540=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
541urxvt::RS_RVid, urxvt::RS_Uline
360 542
361Return the bit that enabled bold, italic, blink, reverse-video and 543Return the bit that enabled bold, italic, blink, reverse-video and
362underline, respectively. To enable such a style, just logically OR it into 544underline, respectively. To enable such a style, just logically OR it into
363the bitset. 545the bitset.
364 546
366 548
367=item $background = urxvt::GET_BASEBG $rend 549=item $background = urxvt::GET_BASEBG $rend
368 550
369Return the foreground/background colour index, respectively. 551Return the foreground/background colour index, respectively.
370 552
371=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour) 553=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
372 554
373=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour) 555=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
556
557=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
374 558
375Replace the foreground/background colour in the rendition mask with the 559Replace the foreground/background colour in the rendition mask with the
376specified one. 560specified one.
377 561
378=item $value = urxvt::GET_CUSTOM ($rend) 562=item $value = urxvt::GET_CUSTOM $rend
379 563
380Return the "custom" value: Every rendition has 5 bits for use by 564Return the "custom" value: Every rendition has 5 bits for use by
381extensions. They can be set and changed as you like and are initially 565extensions. They can be set and changed as you like and are initially
382zero. 566zero.
383 567
384=item $rend = urxvt::SET_CUSTOM ($rend, $new_value) 568=item $rend = urxvt::SET_CUSTOM $rend, $new_value
385 569
386Change the custom value. 570Change the custom value.
387 571
388=back 572=back
389 573
390=cut 574=cut
391 575
392package urxvt;
393
394use strict;
395use Scalar::Util ();
396
397our $TERM;
398our @HOOKNAME;
399our $LIBDIR;
400
401BEGIN { 576BEGIN {
402 urxvt->bootstrap;
403
404 # overwrite perl's warn 577 # overwrite perl's warn
405 *CORE::GLOBAL::warn = sub { 578 *CORE::GLOBAL::warn = sub {
406 my $msg = join "", @_; 579 my $msg = join "", @_;
407 $msg .= "\n" 580 $msg .= "\n"
408 unless $msg =~ /\n$/; 581 unless $msg =~ /\n$/;
409 urxvt::warn ($msg); 582 urxvt::warn ($msg);
410 }; 583 };
411} 584}
412 585
413my @hook_count; 586no warnings 'utf8';
587
588sub parse_resource {
589 my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
590
591 $term->scan_extensions;
592
593 my $r = $term->{meta}{resource};
594 keys %$r; # reset iterator
595 while (my ($k, $v) = each %$r) {
596 my $pattern = $k;
597 $pattern =~ y/./-/ if $isarg;
598 my $prefix = $name;
599 my $suffix;
600 if ($pattern =~ /\-$/) {
601 $prefix = substr $name, 0, length $pattern;
602 $suffix = substr $name, length $pattern;
603 }
604 if ($pattern eq $prefix) {
605 $name = "$urxvt::RESCLASS.$k$suffix";
606
607 push @{ $term->{perl_ext_3} }, $v->[0];
608
609 if ($v->[1] eq "boolean") {
610 $term->put_option_db ($name, $flag ? "true" : "false");
611 return 1;
612 } else {
613 $term->put_option_db ($name, $value);
614 return 1 + 2;
615 }
616 }
617 }
618
619 0
620}
621
622sub usage {
623 my ($term, $usage_type) = @_;
624
625 $term->scan_extensions;
626
627 my $r = $term->{meta}{resource};
628
629 for my $pattern (sort keys %$r) {
630 my ($ext, $type, $desc) = @{ $r->{$pattern} };
631
632 $desc .= " (-pe $ext)";
633
634 if ($usage_type == 1) {
635 $pattern =~ y/./-/;
636 $pattern =~ s/-$/-.../g;
637
638 if ($type eq "boolean") {
639 urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
640 } else {
641 urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
642 }
643 } else {
644 $pattern =~ s/\.$/.*/g;
645 urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
646 }
647 }
648}
649
414my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 650my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
415 651
416sub verbose { 652sub verbose {
417 my ($level, $msg) = @_; 653 my ($level, $msg) = @_;
418 warn "$msg\n" if $level <= $verbosity; 654 warn "$msg\n" if $level <= $verbosity;
419} 655}
420 656
421# find on_xxx subs in the package and register them
422# as hooks
423sub register_package($) {
424 my ($pkg) = @_;
425
426 for my $htype (0.. $#HOOKNAME) {
427 my $name = $HOOKNAME[$htype];
428
429 my $ref = $pkg->can ("on_" . lc $name)
430 or next;
431
432 $TERM->{_hook}[$htype]{$pkg} = $ref;
433 $hook_count[$htype]++
434 or set_should_invoke $htype, 1;
435 }
436}
437
438my $extension_pkg = "extension0000";
439my %extension_pkg; 657my %extension_pkg;
440 658
441# load a single script into its own package, once only 659# load a single script into its own package, once only
442sub extension_package($) { 660sub extension_package($) {
443 my ($path) = @_; 661 my ($path) = @_;
444 662
445 $extension_pkg{$path} ||= do { 663 $extension_pkg{$path} ||= do {
446 my $pkg = "urxvt::" . ($extension_pkg++); 664 $path =~ /([^\/\\]+)$/;
665 my $pkg = $1;
666 $pkg =~ s/[^[:word:]]/_/g;
667 $pkg = "urxvt::ext::$pkg";
447 668
448 verbose 3, "loading extension '$path' into package '$pkg'"; 669 verbose 3, "loading extension '$path' into package '$pkg'";
670
671 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
449 672
450 open my $fh, "<:raw", $path 673 open my $fh, "<:raw", $path
451 or die "$path: $!"; 674 or die "$path: $!";
452 675
453 my $source = "package $pkg; use strict; use utf8;\n" 676 my $source =
454 . "use base urxvt::term::proxy::;\n" 677 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
455 . "#line 1 \"$path\"\n{\n" 678 . "#line 1 \"$path\"\n{\n"
456 . (do { local $/; <$fh> }) 679 . (do { local $/; <$fh> })
457 . "\n};\n1"; 680 . "\n};\n1";
458 681
682 eval $source
459 eval $source or die "$path: $@"; 683 or die "$path: $@";
460 684
461 $pkg 685 $pkg
462 } 686 }
463} 687}
464 688
467# called by the rxvt core 691# called by the rxvt core
468sub invoke { 692sub invoke {
469 local $TERM = shift; 693 local $TERM = shift;
470 my $htype = shift; 694 my $htype = shift;
471 695
472 if ($htype == 0) { # INIT 696 if ($htype == HOOK_INIT) {
473 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 697 my @dirs = $TERM->perl_libdirs;
474 698
699 $TERM->scan_extensions;
700
701 my %ext_arg;
702
703 {
704 my @init = @TERM_INIT;
705 @TERM_INIT = ();
706 $_->($TERM) for @init;
707 my @pkg = @TERM_EXT;
708 @TERM_EXT = ();
709 $TERM->register_package ($_) for @pkg;
710 }
711
712 for (
475 for my $ext (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 713 (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2),
714 @{ delete $TERM->{perl_ext_3} }
715 ) {
716 if ($_ eq "default") {
717
718 $ext_arg{$_} = []
719 for qw(selection option-popup selection-popup readline searchable-scrollback);
720
721 for ($TERM->_keysym_resources) {
722 next if /^(?:string|command|builtin|builtin-string|perl)/;
723 next unless /^([A-Za-z0-9_\-]+):/;
724
725 my $ext = $1;
726
727 $ext_arg{$ext} = [];
728 }
729
730 } elsif (/^-(.*)$/) {
731 delete $ext_arg{$1};
732
733 } elsif (/^([^<]+)<(.*)>$/) {
734 push @{ $ext_arg{$1} }, $2;
735
736 } else {
737 $ext_arg{$_} ||= [];
738 }
739 }
740
741 for my $ext (sort keys %ext_arg) {
476 my @files = grep -f $_, map "$_/$ext", @dirs; 742 my @files = grep -f $_, map "$_/$ext", @dirs;
477 743
478 if (@files) { 744 if (@files) {
479 register_package extension_package $files[0]; 745 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
480 } else { 746 } else {
481 warn "perl extension '$ext' not found in perl library search path\n"; 747 warn "perl extension '$ext' not found in perl library search path\n";
482 } 748 }
483 } 749 }
750
751 eval "#line 1 \"--perl-eval resource/argument\"\n" . $TERM->resource ("perl_eval");
752 warn $@ if $@;
484 } 753 }
485 754
486 $retval = undef; 755 $retval = undef;
487 756
488 if (my $cb = $TERM->{_hook}[$htype]) { 757 if (my $cb = $TERM->{_hook}[$htype]) {
489 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 758 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
490 if $verbosity >= 10; 759 if $verbosity >= 10;
491 760
492 keys %$cb; 761 if ($htype == HOOK_ACTION) {
762 # this hook is only sent to the extension with the name
763 # matching the first arg
764 my $pkg = shift;
765 $pkg =~ y/-/_/;
766 $pkg = "urxvt::ext::$pkg";
493 767
494 while (my ($pkg, $cb) = each %$cb) { 768 $cb = $cb->{$pkg}
495 eval { 769 or return undef; #TODO: maybe warn user?
496 $retval = $cb->( 770
497 $TERM->{_pkg}{$pkg} ||= do { 771 $cb = { $pkg => $cb };
498 my $proxy = bless { }, $pkg;
499 Scalar::Util::weaken ($proxy->{term} = $TERM);
500 $proxy
501 },
502 @_,
503 ) and last;
504 };
505 warn $@ if $@;#d#
506 } 772 }
507 }
508 773
509 if ($htype == 1) { # DESTROY 774 for my $pkg (keys %$cb) {
510 # remove hooks if unused 775 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
511 if (my $hook = $TERM->{_hook}) { 776 $retval ||= $retval_;
512 for my $htype (0..$#$hook) { 777
513 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} } 778 if ($@) {
514 or set_should_invoke $htype, 0; 779 $TERM->ungrab; # better to lose the grab than the session
780 warn $@;
515 } 781 }
516 } 782 }
517 783
784 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
785 if $verbosity >= 11;
786 }
787
788 if ($htype == HOOK_DESTROY) {
518 # clear package objects 789 # clear package objects
519 %$_ = () for values %{ $TERM->{_pkg} }; 790 %$_ = () for values %{ $TERM->{_pkg} };
520 791
521 # clear package 792 # clear package
522 %$TERM = (); 793 %$TERM = ();
523 } 794 }
524 795
525 $retval 796 $retval
526} 797}
527 798
528sub urxvt::term::proxy::AUTOLOAD { 799sub SET_COLOR($$$) {
529 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 800 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
801}
802
803sub rend2mask {
804 no strict 'refs';
805 my ($str, $mask) = (@_, 0);
806 my %color = ( fg => undef, bg => undef );
807 my @failed;
808 for my $spec ( split /\s+/, $str ) {
809 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
810 $color{lc($1)} = $2;
811 } else {
812 my $neg = $spec =~ s/^[-^]//;
813 unless ( exists &{"RS_$spec"} ) {
814 push @failed, $spec;
815 next;
816 }
817 my $cur = &{"RS_$spec"};
818 if ( $neg ) {
819 $mask &= ~$cur;
820 } else {
821 $mask |= $cur;
822 }
823 }
824 }
825 ($mask, @color{qw(fg bg)}, \@failed)
826}
827
828package urxvt::term::extension;
829
830=head2 The C<urxvt::term::extension> class
831
832Each extension attached to a terminal object is represented by
833a C<urxvt::term::extension> object.
834
835You can use these objects, which are passed to all callbacks to store any
836state related to the terminal and extension instance.
837
838The methods (And data members) documented below can be called on extension
839objects, in addition to call methods documented for the <urxvt::term>
840class.
841
842=over 4
843
844=item $urxvt_term = $self->{term}
845
846Returns the C<urxvt::term> object associated with this instance of the
847extension. This member I<must not> be changed in any way.
848
849=cut
850
851our $AUTOLOAD;
852
853sub AUTOLOAD {
854 $AUTOLOAD =~ /:([^:]+)$/
530 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 855 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
531 856
532 eval qq{ 857 eval qq{
533 sub $urxvt::term::proxy::AUTOLOAD { 858 sub $AUTOLOAD {
534 my \$proxy = shift; 859 my \$proxy = shift;
535 \$proxy->{term}->$1 (\@_) 860 \$proxy->{term}->$1 (\@_)
536 } 861 }
537 1 862 1
538 } or die "FATAL: unable to compile method forwarder: $@"; 863 } or die "FATAL: unable to compile method forwarder: $@";
539 864
540 goto &$urxvt::term::proxy::AUTOLOAD; 865 goto &$AUTOLOAD;
541} 866}
867
868sub DESTROY {
869 # nop
870}
871
872# urxvt::destroy_hook (basically a cheap Guard:: implementation)
542 873
543sub urxvt::destroy_hook::DESTROY { 874sub urxvt::destroy_hook::DESTROY {
544 ${$_[0]}->(); 875 ${$_[0]}->();
545} 876}
546 877
547sub urxvt::destroy_hook(&) { 878sub urxvt::destroy_hook(&) {
548 bless \shift, urxvt::destroy_hook:: 879 bless \shift, urxvt::destroy_hook::
549} 880}
550 881
882=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
883
884Dynamically enable the given hooks (named without the C<on_> prefix) for
885this extension, replacing any hook previously installed via C<enable> in
886this extension.
887
888This is useful when you want to overwrite time-critical hooks only
889temporarily.
890
891To install additional callbacks for the same hook, you can use the C<on>
892method of the C<urxvt::term> class.
893
894=item $self->disable ($hook_name[, $hook_name..])
895
896Dynamically disable the given hooks.
897
898=cut
899
900sub enable {
901 my ($self, %hook) = @_;
902 my $pkg = $self->{_pkg};
903
904 while (my ($name, $cb) = each %hook) {
905 my $htype = $HOOKTYPE{uc $name};
906 defined $htype
907 or Carp::croak "unsupported hook type '$name'";
908
909 $self->set_should_invoke ($htype, +1)
910 unless exists $self->{term}{_hook}[$htype]{$pkg};
911
912 $self->{term}{_hook}[$htype]{$pkg} = $cb;
913 }
914}
915
916sub disable {
917 my ($self, @hook) = @_;
918 my $pkg = $self->{_pkg};
919
920 for my $name (@hook) {
921 my $htype = $HOOKTYPE{uc $name};
922 defined $htype
923 or Carp::croak "unsupported hook type '$name'";
924
925 $self->set_should_invoke ($htype, -1)
926 if delete $self->{term}{_hook}[$htype]{$pkg};
927 }
928}
929
930=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
931
932Similar to the C<enable> enable, but installs additional callbacks for
933the given hook(s) (that is, it doesn't replace existing callbacks), and
934returns a guard object. When the guard object is destroyed the callbacks
935are disabled again.
936
937=cut
938
939sub urxvt::extension::on_disable::DESTROY {
940 my $disable = shift;
941
942 my $term = delete $disable->{""};
943
944 while (my ($htype, $id) = each %$disable) {
945 delete $term->{_hook}[$htype]{$id};
946 $term->set_should_invoke ($htype, -1);
947 }
948}
949
950sub on {
951 my ($self, %hook) = @_;
952
953 my $term = $self->{term};
954
955 my %disable = ( "" => $term );
956
957 while (my ($name, $cb) = each %hook) {
958 my $htype = $HOOKTYPE{uc $name};
959 defined $htype
960 or Carp::croak "unsupported hook type '$name'";
961
962 $term->set_should_invoke ($htype, +1);
963 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
964 = sub { shift; $cb->($self, @_) }; # very ugly indeed
965 }
966
967 bless \%disable, "urxvt::extension::on_disable"
968}
969
970=item $self->bind_action ($hotkey, $action)
971
972=item $self->x_resource ($pattern)
973
974=item $self->x_resource_boolean ($pattern)
975
976These methods support an additional C<%> prefix for C<$action> or
977C<$pattern> when called on an extension object, compared to the
978C<urxvt::term> methods of the same name - see the description of these
979methods in the C<urxvt::term> class for details.
980
981=cut
982
983sub bind_action {
984 my ($self, $hotkey, $action) = @_;
985 $action =~ s/^%:/$_[0]{_name}:/;
986 $self->{term}->bind_action ($hotkey, $action)
987}
988
989sub x_resource {
990 my ($self, $name) = @_;
991 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
992 $self->{term}->x_resource ($name)
993}
994
995sub x_resource_boolean {
996 my ($self, $name) = @_;
997 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
998 $self->{term}->x_resource_boolean ($name)
999}
1000
1001=back
1002
1003=cut
1004
1005package urxvt::anyevent;
1006
1007=head2 The C<urxvt::anyevent> Class
1008
1009The sole purpose of this class is to deliver an interface to the
1010C<AnyEvent> module - any module using it will work inside urxvt without
1011further programming. The only exception is that you cannot wait on
1012condition variables, but non-blocking condvar use is ok.
1013
1014In practical terms this means is that you cannot use blocking APIs, but
1015the non-blocking variant should work.
1016
1017=cut
1018
1019our $VERSION = '5.23';
1020
1021$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1022push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1023
1024sub timer {
1025 my ($class, %arg) = @_;
1026
1027 my $cb = $arg{cb};
1028
1029 urxvt::timer
1030 ->new
1031 ->after ($arg{after}, $arg{interval})
1032 ->cb ($arg{interval} ? $cb : sub {
1033 $_[0]->stop; # need to cancel manually
1034 $cb->();
1035 })
1036}
1037
1038sub io {
1039 my ($class, %arg) = @_;
1040
1041 my $cb = $arg{cb};
1042 my $fd = fileno $arg{fh};
1043 defined $fd or $fd = $arg{fh};
1044
1045 bless [$arg{fh}, urxvt::iow
1046 ->new
1047 ->fd ($fd)
1048 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1049 | ($arg{poll} =~ /w/ ? 2 : 0))
1050 ->start
1051 ->cb ($cb)
1052 ], urxvt::anyevent::
1053}
1054
1055sub idle {
1056 my ($class, %arg) = @_;
1057
1058 my $cb = $arg{cb};
1059
1060 urxvt::iw
1061 ->new
1062 ->start
1063 ->cb ($cb)
1064}
1065
1066sub child {
1067 my ($class, %arg) = @_;
1068
1069 my $cb = $arg{cb};
1070
1071 urxvt::pw
1072 ->new
1073 ->start ($arg{pid})
1074 ->cb (sub {
1075 $_[0]->stop; # need to cancel manually
1076 $cb->($_[0]->rpid, $_[0]->rstatus);
1077 })
1078}
1079
1080sub DESTROY {
1081 $_[0][1]->stop;
1082}
1083
1084# only needed for AnyEvent < 6 compatibility
1085sub one_event {
1086 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1087}
1088
1089package urxvt::term;
1090
551=head2 The C<urxvt::term> Class 1091=head2 The C<urxvt::term> Class
552 1092
553=over 4 1093=over 4
554 1094
1095=cut
1096
1097# find on_xxx subs in the package and register them
1098# as hooks
1099sub register_package {
1100 my ($self, $pkg, $argv) = @_;
1101
1102 no strict 'refs';
1103
1104 urxvt::verbose 6, "register package $pkg to $self";
1105
1106 @{"$pkg\::ISA"} = urxvt::term::extension::;
1107
1108 my $proxy = bless {
1109 _pkg => $pkg,
1110 _name => ${"$pkg\::_NAME"}, # hackish
1111 argv => $argv,
1112 }, $pkg;
1113 Scalar::Util::weaken ($proxy->{term} = $self);
1114
1115 $self->{_pkg}{$pkg} = $proxy;
1116
1117 for my $name (@HOOKNAME) {
1118 if (my $ref = $pkg->can ("on_" . lc $name)) {
1119 $proxy->enable ($name => $ref);
1120 }
1121 }
1122}
1123
1124sub perl_libdirs {
1125 map { split /:/ }
1126 $_[0]->resource ("perl_lib"),
1127 $ENV{URXVT_PERL_LIB},
1128 "$ENV{HOME}/.urxvt/ext",
1129 "$LIBDIR/perl"
1130}
1131
1132# scan for available extensions and collect their metadata
1133sub scan_extensions {
1134 my ($self) = @_;
1135
1136 return if exists $self->{meta};
1137
1138 my @urxvtdirs = perl_libdirs $self;
1139# my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
1140
1141 $self->{meta} = \my %meta;
1142
1143 # first gather extensions
1144
1145 my $gather = sub {
1146 my ($dir, $core) = @_;
1147
1148 opendir my $fh, $dir
1149 or return;
1150
1151 for my $ext (readdir $fh) {
1152 $ext !~ /^\./
1153 or next;
1154
1155 open my $fh, "<", "$dir/$ext"
1156 or next;
1157
1158 -f $fh
1159 or next;
1160
1161 $ext =~ s/\.uext$// or $core
1162 or next;
1163
1164 my %ext = (dir => $dir);
1165
1166 while (<$fh>) {
1167 if (/^#:META:(?:X_)?RESOURCE:(.*)/) {
1168 my ($pattern, $type, $desc) = split /:/, $1;
1169 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1170 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1171 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1172 } else {
1173 $ext{resource}{$pattern} = [$ext, $type, $desc];
1174 }
1175 } elsif (/^\s*(?:#|$)/) {
1176 # skip other comments and empty lines
1177 } else {
1178 last; # stop parsing on first non-empty non-comment line
1179 }
1180 }
1181
1182 $meta{ext}{$ext} = \%ext;
1183 }
1184 };
1185
1186# $gather->($_, 0) for @cpandirs;
1187 $gather->($_, 1) for @urxvtdirs;
1188
1189 # and now merge resources
1190
1191 $meta{resource} = \my %resource;
1192
1193 while (my ($k, $v) = each %{ $meta{ext} }) {
1194 #TODO: should check for extensions overriding each other
1195 %resource = (%resource, %{ $v->{resource} });
1196 }
1197}
1198
1199=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1200
1201Creates a new terminal, very similar as if you had started it with system
1202C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1203hash which defines the environment of the new terminal.
1204
1205Croaks (and probably outputs an error message) if the new instance
1206couldn't be created. Returns C<undef> if the new instance didn't
1207initialise perl, and the terminal object otherwise. The C<init> and
1208C<start> hooks will be called before this call returns, and are free to
1209refer to global data (which is race free).
1210
1211=cut
1212
1213sub new {
1214 my ($class, $env, @args) = @_;
1215
1216 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1217 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1218
1219 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1220}
1221
555=item $term->destroy 1222=item $term->destroy
556 1223
557Destroy the terminal object (close the window, free resources etc.). 1224Destroy the terminal object (close the window, free resources
1225etc.). Please note that urxvt will not exit as long as any event
1226watchers (timers, io watchers) are still active.
1227
1228=item $term->exec_async ($cmd[, @args])
1229
1230Works like the combination of the C<fork>/C<exec> builtins, which executes
1231("starts") programs in the background. This function takes care of setting
1232the user environment before exec'ing the command (e.g. C<PATH>) and should
1233be preferred over explicit calls to C<exec> or C<system>.
1234
1235Returns the pid of the subprocess or C<undef> on error.
1236
1237=cut
1238
1239sub exec_async {
1240 my $self = shift;
1241
1242 my $pid = fork;
1243
1244 return $pid
1245 if !defined $pid or $pid;
1246
1247 %ENV = %{ $self->env };
1248
1249 exec @_;
1250 urxvt::_exit 255;
1251}
1252
1253=item $isset = $term->option ($optval[, $set])
1254
1255Returns true if the option specified by C<$optval> is enabled, and
1256optionally change it. All option values are stored by name in the hash
1257C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1258
1259Here is a likely non-exhaustive list of option names, please see the
1260source file F</src/optinc.h> to see the actual list:
1261
1262 borderLess buffered console cursorBlink cursorUnderline hold iconic
1263 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1264 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1265 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1266 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1267 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1268 urgentOnBell utmpInhibit visualBell
558 1269
559=item $value = $term->resource ($name[, $newval]) 1270=item $value = $term->resource ($name[, $newval])
560 1271
561Returns the current resource value associated with a given name and 1272Returns the current resource value associated with a given name and
562optionally sets a new value. Setting values is most useful in the C<init> 1273optionally sets a new value. Setting values is most useful in the C<init>
571likely change). 1282likely change).
572 1283
573Please note that resource strings will currently only be freed when the 1284Please note that resource strings will currently only be freed when the
574terminal is destroyed, so changing options frequently will eat memory. 1285terminal is destroyed, so changing options frequently will eat memory.
575 1286
576Here is a a likely non-exhaustive list of resource names, not all of which 1287Here is a likely non-exhaustive list of resource names, not all of which
577are supported in every build, please see the source to see the actual 1288are supported in every build, please see the source file F</src/rsinc.h>
578list: 1289to see the actual list:
579 1290
580 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1291 answerbackstring backgroundPixmap backspace_key blurradius
581 borderLess color cursorBlink cursorUnderline cutchars delete_key 1292 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
582 display_name embed ext_bwidth fade font geometry hold iconName 1293 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
583 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1294 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1295 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
584 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1296 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
585 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1297 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
586 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1298 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
587 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1299 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
588 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1300 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
589 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1301 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
590 shade term_name title transparent transparent_all tripleclickwords 1302 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1303 term_name title transient_for transparent tripleclickwords urgentOnBell
591 utmpInhibit visualBell 1304 utmpInhibit visualBell
592 1305
593=cut 1306=cut
594 1307
595sub urxvt::term::resource($$;$) { 1308sub resource($$;$) {
596 my ($self, $name) = (shift, shift); 1309 my ($self, $name) = (shift, shift);
597 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1310 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
598 &urxvt::term::_resource 1311 goto &urxvt::term::_resource
599} 1312}
1313
1314=item $value = $term->x_resource ($pattern)
1315
1316Returns the X-Resource for the given pattern, excluding the program or
1317class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1318same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1319resource with that pattern exists.
1320
1321Extensions that define extra resources also need to call this method
1322to access their values.
1323
1324If the method is called on an extension object (basically, from an
1325extension), then the special prefix C<%.> will be replaced by the name of
1326the extension and a dot, and the lone string C<%> will be replaced by the
1327extension name itself. This makes it possible to code extensions so you
1328can rename them and get a new set of resources without having to change
1329the actual code.
1330
1331This method should only be called during the C<on_start> hook, as there is
1332only one resource database per display, and later invocations might return
1333the wrong resources.
1334
1335=item $value = $term->x_resource_boolean ($pattern)
1336
1337Like C<x_resource>, above, but interprets the string value as a boolean
1338and returns C<1> for true values, C<0> for false values and C<undef> if
1339the resource or option isn't specified.
1340
1341You should always use this method to parse boolean resources.
1342
1343=cut
1344
1345sub x_resource_boolean {
1346 my $res = &x_resource;
1347
1348 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1349}
1350
1351=item $success = $term->bind_action ($key, $action)
1352
1353Adds a key binding exactly as specified via a C<keysym> resource. See the
1354C<keysym> resource in the urxvt(1) manpage.
1355
1356To add default bindings for actions, an extension should call C<<
1357->bind_action >> in its C<init> hook for every such binding. Doing it
1358in the C<init> hook allows users to override or remove the binding
1359again.
1360
1361Example: the C<searchable-scrollback> by default binds itself
1362on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
1363$term->bind_action >>.
1364
1365 sub init {
1366 my ($self) = @_;
1367
1368 $self->bind_action ("M-s" => "%:start");
1369 }
600 1370
601=item $rend = $term->rstyle ([$new_rstyle]) 1371=item $rend = $term->rstyle ([$new_rstyle])
602 1372
603Return and optionally change the current rendition. Text that is output by 1373Return and optionally change the current rendition. Text that is output by
604the terminal application will use this style. 1374the terminal application will use this style.
612 1382
613=item ($row, $col) = $term->selection_beg ([$row, $col]) 1383=item ($row, $col) = $term->selection_beg ([$row, $col])
614 1384
615=item ($row, $col) = $term->selection_end ([$row, $col]) 1385=item ($row, $col) = $term->selection_end ([$row, $col])
616 1386
617Return the current values of the selection mark, begin or end positions, 1387Return the current values of the selection mark, begin or end positions.
618and optionally set them to new values.
619 1388
1389When arguments are given, then the selection coordinates are set to
1390C<$row> and C<$col>, and the selection screen is set to the current
1391screen.
1392
1393=item $screen = $term->selection_screen ([$screen])
1394
1395Returns the current selection screen, and then optionally sets it.
1396
1397=item $term->selection_make ($eventtime[, $rectangular])
1398
1399Tries to make a selection as set by C<selection_beg> and
1400C<selection_end>. If C<$rectangular> is true (default: false), a
1401rectangular selection will be made. This is the preferred function to make
1402a selection.
1403
620=item $success = $term->selection_grab ($eventtime) 1404=item $success = $term->selection_grab ($eventtime[, $clipboard])
621 1405
622Try to request the primary selection from the server (for example, as set 1406Try to acquire ownership of the primary (clipboard if C<$clipboard> is
623by the next method). 1407true) selection from the server. The corresponding text can be set
1408with the next method. No visual feedback will be given. This function
1409is mostly useful from within C<on_sel_grab> hooks.
624 1410
625=item $oldtext = $term->selection ([$newtext]) 1411=item $oldtext = $term->selection ([$newtext, $clipboard])
626 1412
627Return the current selection text and optionally replace it by C<$newtext>. 1413Return the current selection (clipboard if C<$clipboard> is true) text
1414and optionally replace it by C<$newtext>.
628 1415
1416=item $term->selection_clear ([$clipboard])
1417
1418Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1419
629#=item $term->overlay ($x, $y, $text) 1420=item $term->overlay_simple ($x, $y, $text)
630# 1421
631#Create a simple multi-line overlay box. See the next method for details. 1422Create a simple multi-line overlay box. See the next method for details.
632# 1423
633#=cut 1424=cut
634# 1425
635#sub urxvt::term::scr_overlay { 1426sub overlay_simple {
636# my ($self, $x, $y, $text) = @_; 1427 my ($self, $x, $y, $text) = @_;
637# 1428
638# my @lines = split /\n/, $text; 1429 my @lines = split /\n/, $text;
639# 1430
640# my $w = 0; 1431 my $w = List::Util::max map $self->strwidth ($_), @lines;
641# for (map $self->strwidth ($_), @lines) { 1432
642# $w = $_ if $w < $_;
643# }
644#
645# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1433 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
646# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1434 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
647#} 1435
1436 $overlay
1437}
648 1438
649=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1439=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
650 1440
651Create a new (empty) overlay at the given position with the given 1441Create a new (empty) overlay at the given position with the given
652width/height. C<$rstyle> defines the initial rendition style 1442width/height. C<$rstyle> defines the initial rendition style
663 1453
664The methods currently supported on C<urxvt::overlay> objects are: 1454The methods currently supported on C<urxvt::overlay> objects are:
665 1455
666=over 4 1456=over 4
667 1457
668=item $overlay->set ($x, $y, $text, $rend) 1458=item $overlay->set ($x, $y, $text[, $rend])
669 1459
670Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1460Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
671text in rxvt-unicode's special encoding and an array of rendition values 1461text in rxvt-unicode's special encoding and an array of rendition values
672at a specific position inside the overlay. 1462at a specific position inside the overlay.
673 1463
1464If C<$rend> is missing, then the rendition will not be changed.
1465
674=item $overlay->hide 1466=item $overlay->hide
675 1467
676If visible, hide the overlay, but do not destroy it. 1468If visible, hide the overlay, but do not destroy it.
677 1469
678=item $overlay->show 1470=item $overlay->show
687C<$event> I<must> be the event causing the menu to pop up (a button event, 1479C<$event> I<must> be the event causing the menu to pop up (a button event,
688currently). 1480currently).
689 1481
690=cut 1482=cut
691 1483
692sub urxvt::term::popup { 1484sub popup {
693 my ($self, $event) = @_; 1485 my ($self, $event) = @_;
694 1486
695 $self->grab ($event->{time}, 1) 1487 $self->grab ($event->{time}, 1)
696 or return; 1488 or return;
697 1489
719 1511
720=item $string = $term->locale_decode ($octets) 1512=item $string = $term->locale_decode ($octets)
721 1513
722Convert the given locale-encoded octets into a perl string. 1514Convert the given locale-encoded octets into a perl string.
723 1515
1516=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1517
1518XORs the rendition values in the given span with the provided value
1519(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1520refresh hooks to provide effects similar to the selection.
1521
1522=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1523
1524Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1525whitespace will additionally be xored with the C<$rstyle2>, which defaults
1526to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1527it instead. Both styles I<MUST NOT> contain font styles.
1528
1529=item $term->scr_bell
1530
1531Ring the bell!
1532
724=item $term->scr_add_lines ($string) 1533=item $term->scr_add_lines ($string)
725 1534
726Write the given text string to the screen, as if output by the application 1535Write the given text string to the screen, as if output by the application
727running inside the terminal. It may not contain command sequences (escape 1536running inside the terminal. It may not contain command sequences (escape
728codes), but is free to use line feeds, carriage returns and tabs. The 1537codes - see C<cmd_parse> for that), but is free to use line feeds,
729string is a normal text string, not in locale-dependent encoding. 1538carriage returns and tabs. The string is a normal text string, not in
1539locale-dependent encoding.
730 1540
731Normally its not a good idea to use this function, as programs might be 1541Normally its not a good idea to use this function, as programs might be
732confused by changes in cursor position or scrolling. Its useful inside a 1542confused by changes in cursor position or scrolling. Its useful inside a
733C<on_add_lines> hook, though. 1543C<on_add_lines> hook, though.
734 1544
1545=item $term->scr_change_screen ($screen)
1546
1547Switch to given screen - 0 primary, 1 secondary.
1548
735=item $term->cmd_parse ($octets) 1549=item $term->cmd_parse ($octets)
736 1550
737Similar to C<scr_add_lines>, but the argument must be in the 1551Similar to C<scr_add_lines>, but the argument must be in the
738locale-specific encoding of the terminal and can contain command sequences 1552locale-specific encoding of the terminal and can contain command sequences
739(escape codes) that will be interpreted. 1553(escape codes) that will be interpreted.
740 1554
741=item $term->tt_write ($octets) 1555=item $term->tt_write ($octets)
742 1556
743Write the octets given in C<$data> to the tty (i.e. as program input). To 1557Write the octets given in C<$octets> to the tty (i.e. as user input
1558to the program, see C<cmd_parse> for the opposite direction). To pass
744pass characters instead of octets, you should convert your strings first 1559characters instead of octets, you should convert your strings first to the
745to the locale-specific encoding using C<< $term->locale_encode >>. 1560locale-specific encoding using C<< $term->locale_encode >>.
1561
1562=item $term->tt_write_user_input ($octets)
1563
1564Like C<tt_write>, but should be used when writing strings in response to
1565the user pressing a key, to invoke the additional actions requested by
1566the user for that case (C<tt_write> doesn't do that).
1567
1568The typical use case would be inside C<on_action> hooks.
1569
1570=item $term->tt_paste ($octets)
1571
1572Write the octets given in C<$octets> to the tty as a paste, converting NL to
1573CR and bracketing the data with control sequences if bracketed paste mode
1574is set.
1575
1576=item $old_events = $term->pty_ev_events ([$new_events])
1577
1578Replaces the event mask of the pty watcher by the given event mask. Can
1579be used to suppress input and output handling to the pty/tty. See the
1580description of C<< urxvt::timer->events >>. Make sure to always restore
1581the previous value.
1582
1583=item $fd = $term->pty_fd
1584
1585Returns the master file descriptor for the pty in use, or C<-1> if no pty
1586is used.
746 1587
747=item $windowid = $term->parent 1588=item $windowid = $term->parent
748 1589
749Return the window id of the toplevel window. 1590Return the window id of the toplevel window.
750 1591
751=item $windowid = $term->vt 1592=item $windowid = $term->vt
752 1593
753Return the window id of the terminal window. 1594Return the window id of the terminal window.
754 1595
1596=item $term->vt_emask_add ($x_event_mask)
1597
1598Adds the specified events to the vt event mask. Useful e.g. when you want
1599to receive pointer events all the times:
1600
1601 $term->vt_emask_add (urxvt::PointerMotionMask);
1602
1603=item $term->set_urgency ($set)
1604
1605Enable/disable the urgency hint on the toplevel window.
1606
1607=item $term->focus_in
1608
1609=item $term->focus_out
1610
1611=item $term->key_press ($state, $keycode[, $time])
1612
1613=item $term->key_release ($state, $keycode[, $time])
1614
1615Deliver various fake events to to terminal.
1616
755=item $window_width = $term->width 1617=item $window_width = $term->width
756 1618
757=item $window_height = $term->height 1619=item $window_height = $term->height
758 1620
759=item $font_width = $term->fwidth 1621=item $font_width = $term->fwidth
772 1634
773=item $max_scrollback = $term->saveLines 1635=item $max_scrollback = $term->saveLines
774 1636
775=item $nrow_plus_saveLines = $term->total_rows 1637=item $nrow_plus_saveLines = $term->total_rows
776 1638
777=item $lines_in_scrollback = $term->nsaved 1639=item $topmost_scrollback_row = $term->top_row
778 1640
779Return various integers describing terminal characteristics. 1641Return various integers describing terminal characteristics.
780 1642
1643=item $x_display = $term->display_id
1644
1645Return the DISPLAY used by rxvt-unicode.
1646
1647=item $lc_ctype = $term->locale
1648
1649Returns the LC_CTYPE category string used by this rxvt-unicode.
1650
1651=item $env = $term->env
1652
1653Returns a copy of the environment in effect for the terminal as a hashref
1654similar to C<\%ENV>.
1655
1656=item @envv = $term->envv
1657
1658Returns the environment as array of strings of the form C<VAR=VALUE>.
1659
1660=item @argv = $term->argv
1661
1662Return the argument vector as this terminal, similar to @ARGV, but
1663includes the program name as first element.
1664
1665=cut
1666
1667sub env {
1668 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1669}
1670
1671=item $modifiermask = $term->ModLevel3Mask
1672
1673=item $modifiermask = $term->ModMetaMask
1674
1675=item $modifiermask = $term->ModNumLockMask
1676
1677Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1678AltGr), the meta key (often Alt) and the num lock key, if applicable.
1679
1680=item $screen = $term->current_screen
1681
1682Returns the currently displayed screen (0 primary, 1 secondary).
1683
1684=item $cursor_is_hidden = $term->hidden_cursor
1685
1686Returns whether the cursor is currently hidden or not.
1687
781=item $view_start = $term->view_start ([$newvalue]) 1688=item $view_start = $term->view_start ([$newvalue])
782 1689
783Returns the negative row number of the topmost line. Minimum value is 1690Returns the row number of the topmost displayed line. Maximum value is
784C<0>, which displays the normal terminal contents. Larger values scroll 1691C<0>, which displays the normal terminal contents. Lower values scroll
785this many lines into the scrollback buffer. 1692this many lines into the scrollback buffer.
786 1693
787=item $term->want_refresh 1694=item $term->want_refresh
788 1695
789Requests a screen refresh. At the next opportunity, rxvt-unicode will 1696Requests a screen refresh. At the next opportunity, rxvt-unicode will
790compare the on-screen display with its stored representation. If they 1697compare the on-screen display with its stored representation. If they
791differ, it redraws the differences. 1698differ, it redraws the differences.
792 1699
793Used after changing terminal contents to display them. 1700Used after changing terminal contents to display them.
794 1701
1702=item $term->refresh_check
1703
1704Checks if a refresh has been requested and, if so, schedules one.
1705
795=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1706=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
796 1707
797Returns the text of the entire row with number C<$row_number>. Row C<0> 1708Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
798is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1709is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
799terminal line. The scrollback buffer starts at line C<-1> and extends to
800line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1710terminal line. Nothing will be returned if a nonexistent line
801is requested. 1711is requested.
802 1712
803If C<$new_text> is specified, it will replace characters in the current 1713If C<$new_text> is specified, it will replace characters in the current
804line, starting at column C<$start_col> (default C<0>), which is useful 1714line, starting at column C<$start_col> (default C<0>), which is useful
805to replace only parts of a line. The font index in the rendition will 1715to replace only parts of a line. The font index in the rendition will
806automatically be updated. 1716automatically be updated.
807 1717
808C<$text> is in a special encoding: tabs and wide characters that use more 1718C<$text> is in a special encoding: tabs and wide characters that use more
809than one cell when displayed are padded with urxvt::NOCHAR characters 1719than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
810(C<chr 65535>). Characters with combining characters and other characters 1720characters. Characters with combining characters and other characters that
811that do not fit into the normal tetx encoding will be replaced with 1721do not fit into the normal text encoding will be replaced with characters
812characters in the private use area. 1722in the private use area.
813 1723
814You have to obey this encoding when changing text. The advantage is 1724You have to obey this encoding when changing text. The advantage is
815that C<substr> and similar functions work on screen cells and not on 1725that C<substr> and similar functions work on screen cells and not on
816characters. 1726characters.
817 1727
868Return the row number of the first/last row of the line, respectively. 1778Return the row number of the first/last row of the line, respectively.
869 1779
870=item $offset = $line->offset_of ($row, $col) 1780=item $offset = $line->offset_of ($row, $col)
871 1781
872Returns the character offset of the given row|col pair within the logical 1782Returns the character offset of the given row|col pair within the logical
873line. 1783line. Works for rows outside the line, too, and returns corresponding
1784offsets outside the string.
874 1785
875=item ($row, $col) = $line->coord_of ($offset) 1786=item ($row, $col) = $line->coord_of ($offset)
876 1787
877Translates a string offset into terminal coordinates again. 1788Translates a string offset into terminal coordinates again.
878 1789
879=back 1790=back
880 1791
881=cut 1792=cut
882 1793
883sub urxvt::term::line { 1794sub line {
884 my ($self, $row) = @_; 1795 my ($self, $row) = @_;
885 1796
886 my $maxrow = $self->nrow - 1; 1797 my $maxrow = $self->nrow - 1;
887 1798
888 my ($beg, $end) = ($row, $row); 1799 my ($beg, $end) = ($row, $row);
900} 1811}
901 1812
902sub urxvt::line::t { 1813sub urxvt::line::t {
903 my ($self) = @_; 1814 my ($self) = @_;
904 1815
905 if (@_ > 1) 1816 if (@_ > 1) {
906 {
907 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1817 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
908 for $self->{beg} .. $self->{end}; 1818 for $self->{beg} .. $self->{end};
909 } 1819 }
910 1820
911 defined wantarray && 1821 defined wantarray &&
912 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1822 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
913 0, $self->{len} 1823 0, $self->{len}
914} 1824}
915 1825
916sub urxvt::line::r { 1826sub urxvt::line::r {
917 my ($self) = @_; 1827 my ($self) = @_;
918 1828
919 if (@_ > 1) 1829 if (@_ > 1) {
920 {
921 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1830 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
922 for $self->{beg} .. $self->{end}; 1831 for $self->{beg} .. $self->{end};
923 } 1832 }
924 1833
925 if (defined wantarray) { 1834 if (defined wantarray) {
926 my $rend = [ 1835 my $rend = [
927 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1836 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
928 ]; 1837 ];
952 $offset / $self->{ncol} + $self->{beg}, 1861 $offset / $self->{ncol} + $self->{beg},
953 $offset % $self->{ncol} 1862 $offset % $self->{ncol}
954 ) 1863 )
955} 1864}
956 1865
957=item ($row, $col) = $line->coord_of ($offset)
958=item $text = $term->special_encode $string 1866=item $text = $term->special_encode $string
959 1867
960Converts a perl string into the special encoding used by rxvt-unicode, 1868Converts a perl string into the special encoding used by rxvt-unicode,
961where one character corresponds to one screen cell. See 1869where one character corresponds to one screen cell. See
962C<< $term->ROW_t >> for details. 1870C<< $term->ROW_t >> for details.
963 1871
964=item $string = $term->special_decode $text 1872=item $string = $term->special_decode $text
965 1873
966Converts rxvt-unicodes text reprsentation into a perl string. See 1874Converts rxvt-unicodes text representation into a perl string. See
967C<< $term->ROW_t >> for details. 1875C<< $term->ROW_t >> for details.
968 1876
1877=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1878
1879=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1880
1881Register/unregister a synchronous button grab. See the XGrabButton
1882manpage.
1883
1884=item $success = $term->grab ($eventtime[, $sync])
1885
1886Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1887synchronous (C<$sync> is true). Also remembers the grab timestamp.
1888
1889=item $term->allow_events_async
1890
1891Calls XAllowEvents with AsyncBoth for the most recent grab.
1892
1893=item $term->allow_events_sync
1894
1895Calls XAllowEvents with SyncBoth for the most recent grab.
1896
1897=item $term->allow_events_replay
1898
1899Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1900recent grab.
1901
1902=item $term->ungrab
1903
1904Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1905evaluation errors, as it is better to lose the grab in the error case as
1906the session.
1907
1908=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1909
1910=item $atom_name = $term->XGetAtomName ($atom)
1911
1912=item @atoms = $term->XListProperties ($window)
1913
1914=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1915
1916=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1917
1918=item $term->XDeleteProperty ($window, $property)
1919
1920=item $window = $term->DefaultRootWindow
1921
1922=item $term->XReparentWindow ($window, $parent, [$x, $y])
1923
1924=item $term->XMapWindow ($window)
1925
1926=item $term->XUnmapWindow ($window)
1927
1928=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1929
1930=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1931
1932=item $term->XChangeInput ($window, $add_events[, $del_events])
1933
1934=item $keysym = $term->XStringToKeysym ($string)
1935
1936=item $string = $term->XKeysymToString ($keysym)
1937
1938Various X or X-related functions. The C<$term> object only serves as
1939the source of the display, otherwise those functions map more-or-less
1940directly onto the X functions of the same name.
1941
969=back 1942=back
970 1943
1944=cut
1945
1946package urxvt::popup;
1947
971=head2 The C<urxvt::popup> Class 1948=head2 The C<urxvt::popup> Class
972 1949
973=over 4 1950=over 4
974 1951
975=cut 1952=cut
976
977package urxvt::popup;
978 1953
979sub add_item { 1954sub add_item {
980 my ($self, $item) = @_; 1955 my ($self, $item) = @_;
981 1956
1957 $item->{rend}{normal} = "\x1b[0;30;47m" unless exists $item->{rend}{normal};
1958 $item->{rend}{hover} = "\x1b[0;30;46m" unless exists $item->{rend}{hover};
1959 $item->{rend}{active} = "\x1b[m" unless exists $item->{rend}{active};
1960
1961 $item->{render} ||= sub { $_[0]{text} };
1962
982 push @{ $self->{item} }, $item; 1963 push @{ $self->{item} }, $item;
983} 1964}
1965
1966=item $popup->add_title ($title)
1967
1968Adds a non-clickable title to the popup.
1969
1970=cut
1971
1972sub add_title {
1973 my ($self, $title) = @_;
1974
1975 $self->add_item ({
1976 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1977 text => $title,
1978 activate => sub { },
1979 });
1980}
1981
1982=item $popup->add_separator ([$sepchr])
1983
1984Creates a separator, optionally using the character given as C<$sepchr>.
1985
1986=cut
1987
1988sub add_separator {
1989 my ($self, $sep) = @_;
1990
1991 $sep ||= "=";
1992
1993 $self->add_item ({
1994 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1995 text => "",
1996 render => sub { $sep x $self->{term}->ncol },
1997 activate => sub { },
1998 });
1999}
2000
2001=item $popup->add_button ($text, $cb)
2002
2003Adds a clickable button to the popup. C<$cb> is called whenever it is
2004selected.
2005
2006=cut
984 2007
985sub add_button { 2008sub add_button {
986 my ($self, $text, $cb) = @_; 2009 my ($self, $text, $cb) = @_;
987 2010
988 $self->add_item ({ type => "button", text => "[ $text ]", activate => $cb }); 2011 $self->add_item ({ type => "button", text => $text, activate => $cb});
989} 2012}
2013
2014=item $popup->add_toggle ($text, $initial_value, $cb)
2015
2016Adds a toggle/checkbox item to the popup. The callback gets called
2017whenever it gets toggled, with a boolean indicating its new value as its
2018first argument.
2019
2020=cut
2021
2022sub add_toggle {
2023 my ($self, $text, $value, $cb) = @_;
2024
2025 my $item; $item = {
2026 type => "button",
2027 text => " $text",
2028 value => $value,
2029 render => sub { ($_[0]{value} ? "* " : " ") . $text },
2030 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
2031 };
2032
2033 $self->add_item ($item);
2034}
2035
2036=item $popup->show
2037
2038Displays the popup (which is initially hidden).
2039
2040=cut
990 2041
991sub show { 2042sub show {
992 my ($self) = @_; 2043 my ($self) = @_;
993 2044
994 local $urxvt::popup::self = $self; 2045 local $urxvt::popup::self = $self;
995 2046
996 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 2047 my $env = $self->{term}->env;
2048 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
2049 delete $env->{LC_ALL};
2050 $env->{LC_CTYPE} = $self->{term}->locale;
2051
2052 my $term = urxvt::term->new (
2053 $env, "popup",
2054 "--perl-lib" => "", "--perl-ext-common" => "",
2055 "-pty-fd" => -1, "-sl" => 0,
2056 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
997 "--transient-for" => $self->{term}->parent, 2057 "--transient-for" => $self->{term}->parent,
2058 "-display" => $self->{term}->display_id,
998 "-pe" => "urxvt-popup") 2059 "-pe" => "urxvt-popup",
999 or die "unable to create popup window\n"; 2060 ) or die "unable to create popup window\n";
2061
2062 unless (delete $term->{urxvt_popup_init_done}) {
2063 $term->ungrab;
2064 $term->destroy;
2065 die "unable to initialise popup window\n";
2066 }
1000} 2067}
1001 2068
1002sub DESTROY { 2069sub DESTROY {
1003 my ($self) = @_; 2070 my ($self) = @_;
1004 2071
2072 delete $self->{term}{_destroy}{$self};
1005 $self->{term}->ungrab; 2073 $self->{term}->ungrab;
1006} 2074}
2075
2076=back
2077
2078=cut
2079
2080package urxvt::watcher;
1007 2081
1008=head2 The C<urxvt::timer> Class 2082=head2 The C<urxvt::timer> Class
1009 2083
1010This class implements timer watchers/events. Time is represented as a 2084This class implements timer watchers/events. Time is represented as a
1011fractional number of seconds since the epoch. Example: 2085fractional number of seconds since the epoch. Example:
1015 ->new 2089 ->new
1016 ->interval (1) 2090 ->interval (1)
1017 ->cb (sub { 2091 ->cb (sub {
1018 $term->{overlay}->set (0, 0, 2092 $term->{overlay}->set (0, 0,
1019 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2093 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1020 }); 2094 });
1021 2095
1022=over 4 2096=over 4
1023 2097
1024=item $timer = new urxvt::timer 2098=item $timer = new urxvt::timer
1025 2099
1028 2102
1029=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2103=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1030 2104
1031Set the callback to be called when the timer triggers. 2105Set the callback to be called when the timer triggers.
1032 2106
1033=item $tstamp = $timer->at
1034
1035Return the time this watcher will fire next.
1036
1037=item $timer = $timer->set ($tstamp) 2107=item $timer = $timer->set ($tstamp[, $interval])
1038 2108
1039Set the time the event is generated to $tstamp. 2109Set the time the event is generated to $tstamp (and optionally specifies a
2110new $interval).
1040 2111
1041=item $timer = $timer->interval ($interval) 2112=item $timer = $timer->interval ($interval)
1042 2113
1043Normally (and when C<$interval> is C<0>), the timer will automatically 2114By default (and when C<$interval> is C<0>), the timer will automatically
1044stop after it has fired once. If C<$interval> is non-zero, then the timer 2115stop after it has fired once. If C<$interval> is non-zero, then the timer
1045is automatically rescheduled at the given intervals. 2116is automatically rescheduled at the given intervals.
1046 2117
1047=item $timer = $timer->start 2118=item $timer = $timer->start
1048 2119
1049Start the timer. 2120Start the timer.
1050 2121
1051=item $timer = $timer->start ($tstamp) 2122=item $timer = $timer->start ($tstamp[, $interval])
1052 2123
1053Set the event trigger time to C<$tstamp> and start the timer. 2124Set the event trigger time to C<$tstamp> and start the timer. Optionally
2125also replaces the interval.
2126
2127=item $timer = $timer->after ($delay[, $interval])
2128
2129Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1054 2130
1055=item $timer = $timer->stop 2131=item $timer = $timer->stop
1056 2132
1057Stop the timer. 2133Stop the timer.
1058 2134
1064 2140
1065 $term->{socket} = ... 2141 $term->{socket} = ...
1066 $term->{iow} = urxvt::iow 2142 $term->{iow} = urxvt::iow
1067 ->new 2143 ->new
1068 ->fd (fileno $term->{socket}) 2144 ->fd (fileno $term->{socket})
1069 ->events (1) # wait for read data 2145 ->events (urxvt::EV_READ)
1070 ->start 2146 ->start
1071 ->cb (sub { 2147 ->cb (sub {
1072 my ($iow, $revents) = @_; 2148 my ($iow, $revents) = @_;
1073 # $revents must be 1 here, no need to check 2149 # $revents must be 1 here, no need to check
1074 sysread $term->{socket}, my $buf, 8192 2150 sysread $term->{socket}, my $buf, 8192
1087Set the callback to be called when io events are triggered. C<$reventmask> 2163Set the callback to be called when io events are triggered. C<$reventmask>
1088is a bitset as described in the C<events> method. 2164is a bitset as described in the C<events> method.
1089 2165
1090=item $iow = $iow->fd ($fd) 2166=item $iow = $iow->fd ($fd)
1091 2167
1092Set the filedescriptor (not handle) to watch. 2168Set the file descriptor (not handle) to watch.
1093 2169
1094=item $iow = $iow->events ($eventmask) 2170=item $iow = $iow->events ($eventmask)
1095 2171
1096Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 2172Set the event mask to watch. The only allowed values are
1097data, Bit #1 (value C<2>) enables watching for write data. 2173C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2174together, or C<urxvt::EV_NONE>.
1098 2175
1099=item $iow = $iow->start 2176=item $iow = $iow->start
1100 2177
1101Start watching for requested events on the given handle. 2178Start watching for requested events on the given handle.
1102 2179
1103=item $iow = $iow->stop 2180=item $iow = $iow->stop
1104 2181
1105Stop watching for events on the given filehandle. 2182Stop watching for events on the given file handle.
2183
2184=back
2185
2186=head2 The C<urxvt::iw> Class
2187
2188This class implements idle watchers, that get called automatically when
2189the process is idle. They should return as fast as possible, after doing
2190some useful work.
2191
2192=over 4
2193
2194=item $iw = new urxvt::iw
2195
2196Create a new idle watcher object in stopped state.
2197
2198=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2199
2200Set the callback to be called when the watcher triggers.
2201
2202=item $timer = $timer->start
2203
2204Start the watcher.
2205
2206=item $timer = $timer->stop
2207
2208Stop the watcher.
2209
2210=back
2211
2212=head2 The C<urxvt::pw> Class
2213
2214This class implements process watchers. They create an event whenever a
2215process exits, after which they stop automatically.
2216
2217 my $pid = fork;
2218 ...
2219 $term->{pw} = urxvt::pw
2220 ->new
2221 ->start ($pid)
2222 ->cb (sub {
2223 my ($pw, $exit_status) = @_;
2224 ...
2225 });
2226
2227=over 4
2228
2229=item $pw = new urxvt::pw
2230
2231Create a new process watcher in stopped state.
2232
2233=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2234
2235Set the callback to be called when the timer triggers.
2236
2237=item $pw = $timer->start ($pid)
2238
2239Tells the watcher to start watching for process C<$pid>.
2240
2241=item $pw = $pw->stop
2242
2243Stop the watcher.
1106 2244
1107=back 2245=back
1108 2246
1109=head1 ENVIRONMENT 2247=head1 ENVIRONMENT
1110 2248
1113This variable controls the verbosity level of the perl extension. Higher 2251This variable controls the verbosity level of the perl extension. Higher
1114numbers indicate more verbose output. 2252numbers indicate more verbose output.
1115 2253
1116=over 4 2254=over 4
1117 2255
1118=item =0 - only fatal messages 2256=item == 0 - fatal messages
1119 2257
1120=item =3 - script loading and management 2258=item >= 3 - script loading and management
1121 2259
1122=item =10 - all events received 2260=item >=10 - all called hooks
2261
2262=item >=11 - hook return values
1123 2263
1124=back 2264=back
1125 2265
1126=head1 AUTHOR 2266=head1 AUTHOR
1127 2267
1128 Marc Lehmann <pcg@goof.com> 2268 Marc Lehmann <schmorp@schmorp.de>
1129 http://software.schmorp.de/pkg/rxvt-unicode 2269 http://software.schmorp.de/pkg/rxvt-unicode
1130 2270
1131=cut 2271=cut
1132 2272
11331 22731
2274
2275# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines