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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines