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.66 by root, Mon Jan 9 19:28:39 2006 UTC vs.
Revision 1.229 by root, Sat Apr 26 18:53:51 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
450# find on_xxx subs in the package and register them
451# as hooks
452sub register_package($) {
453 my ($pkg) = @_;
454
455 for my $htype (0.. $#HOOKNAME) {
456 my $name = $HOOKNAME[$htype];
457
458 my $ref = $pkg->can ("on_" . lc $name)
459 or next;
460
461 $TERM->{_hook}[$htype]{$pkg} = $ref;
462 $hook_count[$htype]++
463 or set_should_invoke $htype, 1;
464 }
465}
466
467my $extension_pkg = "extension0000";
468my %extension_pkg; 633my %extension_pkg;
469 634
470# load a single script into its own package, once only 635# load a single script into its own package, once only
471sub extension_package($) { 636sub extension_package($) {
472 my ($path) = @_; 637 my ($path) = @_;
473 638
474 $extension_pkg{$path} ||= do { 639 $extension_pkg{$path} ||= do {
475 my $pkg = "urxvt::" . ($extension_pkg++); 640 $path =~ /([^\/\\]+)$/;
641 my $pkg = $1;
642 $pkg =~ s/[^[:word:]]/_/g;
643 $pkg = "urxvt::ext::$pkg";
476 644
477 verbose 3, "loading extension '$path' into package '$pkg'"; 645 verbose 3, "loading extension '$path' into package '$pkg'";
646
647 (${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
478 648
479 open my $fh, "<:raw", $path 649 open my $fh, "<:raw", $path
480 or die "$path: $!"; 650 or die "$path: $!";
481 651
482 my $source = untaint "package $pkg; use strict; use utf8;\n" 652 my $source =
483 . "use base urxvt::term::proxy::;\n" 653 "package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
484 . "#line 1 \"$path\"\n{\n" 654 . "#line 1 \"$path\"\n{\n"
485 . (do { local $/; <$fh> }) 655 . (do { local $/; <$fh> })
486 . "\n};\n1"; 656 . "\n};\n1";
487 657
658 eval $source
488 eval $source or die "$path: $@"; 659 or die "$path: $@";
489 660
490 $pkg 661 $pkg
491 } 662 }
492} 663}
493 664
497sub invoke { 668sub invoke {
498 local $TERM = shift; 669 local $TERM = shift;
499 my $htype = shift; 670 my $htype = shift;
500 671
501 if ($htype == 0) { # INIT 672 if ($htype == 0) { # INIT
502 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 673 my @dirs = $TERM->perl_libdirs;
674
675 my %ext_arg;
676
503 677 {
504 my %want_ext; 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 }
505 685
686 for (
687 @{ delete $TERM->{perl_ext_3} },
506 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 688 grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689 ) {
507 if ($_ eq "default") { 690 if ($_ eq "default") {
508 $want_ext{$_}++ for qw(selection option-popup selection-popup); 691 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
509 } elsif (/^-(.*)$/) { 692 } elsif (/^-(.*)$/) {
510 delete $want_ext{$1}; 693 delete $ext_arg{$1};
694 } elsif (/^([^<]+)<(.*)>$/) {
695 push @{ $ext_arg{$1} }, $2;
511 } else { 696 } else {
512 $want_ext{$_}++; 697 $ext_arg{$_} ||= [];
513 } 698 }
514 } 699 }
515 700
516 for my $ext (keys %want_ext) { 701 for my $ext (sort keys %ext_arg) {
517 my @files = grep -f $_, map "$_/$ext", @dirs; 702 my @files = grep -f $_, map "$_/$ext", @dirs;
518 703
519 if (@files) { 704 if (@files) {
520 register_package extension_package $files[0]; 705 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
521 } else { 706 } else {
522 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";
523 } 708 }
524 } 709 }
525 710
531 716
532 if (my $cb = $TERM->{_hook}[$htype]) { 717 if (my $cb = $TERM->{_hook}[$htype]) {
533 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 718 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
534 if $verbosity >= 10; 719 if $verbosity >= 10;
535 720
536 keys %$cb; 721 for my $pkg (keys %$cb) {
722 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
723 $retval ||= $retval_;
537 724
538 while (my ($pkg, $cb) = each %$cb) {
539 eval {
540 $retval = $cb->(
541 $TERM->{_pkg}{$pkg} ||= do {
542 my $proxy = bless { }, $pkg;
543 Scalar::Util::weaken ($proxy->{term} = $TERM);
544 $proxy
545 },
546 @_,
547 ) and last;
548 };
549 if ($@) { 725 if ($@) {
550 $TERM->ungrab; # better to lose the grab than the session 726 $TERM->ungrab; # better to lose the grab than the session
551 warn $@; 727 warn $@;
552 } 728 }
553 } 729 }
730
731 verbose 11, "$HOOKNAME[$htype] returning <$retval>"
732 if $verbosity >= 11;
554 } 733 }
555 734
556 if ($htype == 1) { # DESTROY 735 if ($htype == 1) { # DESTROY
557 # remove hooks if unused
558 if (my $hook = $TERM->{_hook}) {
559 for my $htype (0..$#$hook) {
560 $hook_count[$htype] -= scalar keys %{ $hook->[$htype] || {} }
561 or set_should_invoke $htype, 0;
562 }
563 }
564
565 # clear package objects 736 # clear package objects
566 %$_ = () for values %{ $TERM->{_pkg} }; 737 %$_ = () for values %{ $TERM->{_pkg} };
567 738
568 # clear package 739 # clear package
569 %$TERM = (); 740 %$TERM = ();
570 } 741 }
571 742
572 $retval 743 $retval
573} 744}
574 745
575# urxvt::term::proxy 746sub SET_COLOR($$$) {
747 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
748}
576 749
577sub urxvt::term::proxy::AUTOLOAD { 750sub rend2mask {
578 $urxvt::term::proxy::AUTOLOAD =~ /:([^:]+)$/ 751 no strict 'refs';
752 my ($str, $mask) = (@_, 0);
753 my %color = ( fg => undef, bg => undef );
754 my @failed;
755 for my $spec ( split /\s+/, $str ) {
756 if ( $spec =~ /^([fb]g)[_:-]?(\d+)/i ) {
757 $color{lc($1)} = $2;
758 } else {
759 my $neg = $spec =~ s/^[-^]//;
760 unless ( exists &{"RS_$spec"} ) {
761 push @failed, $spec;
762 next;
763 }
764 my $cur = &{"RS_$spec"};
765 if ( $neg ) {
766 $mask &= ~$cur;
767 } else {
768 $mask |= $cur;
769 }
770 }
771 }
772 ($mask, @color{qw(fg bg)}, \@failed)
773}
774
775package urxvt::term::extension;
776
777=head2 The C<urxvt::term::extension> class
778
779Each extension attached to a terminal object is represented by
780a C<urxvt::term::extension> object.
781
782You can use these objects, which are passed to all callbacks to store any
783state related to the terminal and extension instance.
784
785The methods (And data members) documented below can be called on extension
786objects, in addition to call methods documented for the <urxvt::term>
787class.
788
789=over 4
790
791=item $urxvt_term = $self->{term}
792
793Returns the C<urxvt::term> object associated with this instance of the
794extension. This member I<must not> be changed in any way.
795
796=cut
797
798our $AUTOLOAD;
799
800sub AUTOLOAD {
801 $AUTOLOAD =~ /:([^:]+)$/
579 or die "FATAL: \$AUTOLOAD '$urxvt::term::proxy::AUTOLOAD' unparsable"; 802 or die "FATAL: \$AUTOLOAD '$AUTOLOAD' unparsable";
580 803
581 eval qq{ 804 eval qq{
582 sub $urxvt::term::proxy::AUTOLOAD { 805 sub $AUTOLOAD {
583 my \$proxy = shift; 806 my \$proxy = shift;
584 \$proxy->{term}->$1 (\@_) 807 \$proxy->{term}->$1 (\@_)
585 } 808 }
586 1 809 1
587 } or die "FATAL: unable to compile method forwarder: $@"; 810 } or die "FATAL: unable to compile method forwarder: $@";
588 811
589 goto &$urxvt::term::proxy::AUTOLOAD; 812 goto &$AUTOLOAD;
590} 813}
591 814
592sub urxvt::term::proxy::DESTROY { 815sub DESTROY {
593 # nop 816 # nop
594} 817}
595 818
596# urxvt::destroy_hook 819# urxvt::destroy_hook (basically a cheap Guard:: implementation)
597 820
598sub urxvt::destroy_hook::DESTROY { 821sub urxvt::destroy_hook::DESTROY {
599 ${$_[0]}->(); 822 ${$_[0]}->();
600} 823}
601 824
602sub urxvt::destroy_hook(&) { 825sub urxvt::destroy_hook(&) {
603 bless \shift, urxvt::destroy_hook:: 826 bless \shift, urxvt::destroy_hook::
604} 827}
605 828
829=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830
831Dynamically enable the given hooks (named without the C<on_> prefix) for
832this extension, replacing any hook previously installed via C<enable> in
833this extension.
834
835This is useful when you want to overwrite time-critical hooks only
836temporarily.
837
838To install additional callbacks for the same hook, you can use the C<on>
839method of the C<urxvt::term> class.
840
841=item $self->disable ($hook_name[, $hook_name..])
842
843Dynamically disable the given hooks.
844
845=cut
846
847sub enable {
848 my ($self, %hook) = @_;
849 my $pkg = $self->{_pkg};
850
851 while (my ($name, $cb) = each %hook) {
852 my $htype = $HOOKTYPE{uc $name};
853 defined $htype
854 or Carp::croak "unsupported hook type '$name'";
855
856 $self->set_should_invoke ($htype, +1)
857 unless exists $self->{term}{_hook}[$htype]{$pkg};
858
859 $self->{term}{_hook}[$htype]{$pkg} = $cb;
860 }
861}
862
863sub disable {
864 my ($self, @hook) = @_;
865 my $pkg = $self->{_pkg};
866
867 for my $name (@hook) {
868 my $htype = $HOOKTYPE{uc $name};
869 defined $htype
870 or Carp::croak "unsupported hook type '$name'";
871
872 $self->set_should_invoke ($htype, -1)
873 if delete $self->{term}{_hook}[$htype]{$pkg};
874 }
875}
876
877=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
878
879Similar to the C<enable> enable, but installs additional callbacks for
880the given hook(s) (that is, it doesn't replace existing callbacks), and
881returns a guard object. When the guard object is destroyed the callbacks
882are disabled again.
883
884=cut
885
886sub urxvt::extension::on_disable::DESTROY {
887 my $disable = shift;
888
889 my $term = delete $disable->{""};
890
891 while (my ($htype, $id) = each %$disable) {
892 delete $term->{_hook}[$htype]{$id};
893 $term->set_should_invoke ($htype, -1);
894 }
895}
896
897sub on {
898 my ($self, %hook) = @_;
899
900 my $term = $self->{term};
901
902 my %disable = ( "" => $term );
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 $term->set_should_invoke ($htype, +1);
910 $term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
911 = sub { shift; $cb->($self, @_) }; # very ugly indeed
912 }
913
914 bless \%disable, "urxvt::extension::on_disable"
915}
916
917=item $self->x_resource ($pattern)
918
919=item $self->x_resource_boolean ($pattern)
920
921These methods support an additional C<%> prefix when called on an
922extension object - see the description of these methods in the
923C<urxvt::term> class for details.
924
925=cut
926
927sub x_resource {
928 my ($self, $name) = @_;
929 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
930 $self->{term}->x_resource ($name)
931}
932
933sub x_resource_boolean {
934 my ($self, $name) = @_;
935 $name =~ s/^%(\.|$)/$_[0]{_name}$1/;
936 $self->{term}->x_resource_boolean ($name)
937}
938
939=back
940
941=cut
942
606package urxvt::anyevent; 943package urxvt::anyevent;
607 944
608=head2 The C<urxvt::anyevent> Class 945=head2 The C<urxvt::anyevent> Class
609 946
610The sole purpose of this class is to deliver an interface to the 947The sole purpose of this class is to deliver an interface to the
611C<AnyEvent> module - any module using it will work inside urxvt without 948C<AnyEvent> module - any module using it will work inside urxvt without
612further work. The only exception is that you cannot wait on condition 949further programming. The only exception is that you cannot wait on
613variables, but non-blocking condvar use is ok. What this means is that you 950condition variables, but non-blocking condvar use is ok.
614cannot use blocking APIs, but the non-blocking variant should work.
615 951
616=cut 952In practical terms this means is that you cannot use blocking APIs, but
953the non-blocking variant should work.
617 954
955=cut
956
618our $VERSION = 1; 957our $VERSION = '5.23';
619 958
620$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 959$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
621push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 960push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
622 961
623sub timer { 962sub timer {
625 964
626 my $cb = $arg{cb}; 965 my $cb = $arg{cb};
627 966
628 urxvt::timer 967 urxvt::timer
629 ->new 968 ->new
630 ->start (urxvt::NOW + $arg{after}) 969 ->after ($arg{after}, $arg{interval})
631 ->cb (sub { 970 ->cb ($arg{interval} ? $cb : sub {
632 $_[0]->stop; # need to cancel manually 971 $_[0]->stop; # need to cancel manually
633 $cb->(); 972 $cb->();
634 }) 973 })
635} 974}
636 975
637sub io { 976sub io {
638 my ($class, %arg) = @_; 977 my ($class, %arg) = @_;
639 978
640 my $cb = $arg{cb}; 979 my $cb = $arg{cb};
980 my $fd = fileno $arg{fh};
981 defined $fd or $fd = $arg{fh};
641 982
642 bless [$arg{fh}, urxvt::iow 983 bless [$arg{fh}, urxvt::iow
643 ->new 984 ->new
644 ->fd (fileno $arg{fh}) 985 ->fd ($fd)
645 ->events (($arg{poll} =~ /r/ ? 1 : 0) 986 ->events (($arg{poll} =~ /r/ ? 1 : 0)
646 | ($arg{poll} =~ /w/ ? 2 : 0)) 987 | ($arg{poll} =~ /w/ ? 2 : 0))
647 ->start 988 ->start
648 ->cb (sub { 989 ->cb ($cb)
649 $cb->(($_[1] & 1 ? 'r' : '')
650 . ($_[1] & 2 ? 'w' : ''));
651 })],
652 urxvt::anyevent:: 990 ], urxvt::anyevent::
991}
992
993sub idle {
994 my ($class, %arg) = @_;
995
996 my $cb = $arg{cb};
997
998 urxvt::iw
999 ->new
1000 ->start
1001 ->cb ($cb)
1002}
1003
1004sub child {
1005 my ($class, %arg) = @_;
1006
1007 my $cb = $arg{cb};
1008
1009 urxvt::pw
1010 ->new
1011 ->start ($arg{pid})
1012 ->cb (sub {
1013 $_[0]->stop; # need to cancel manually
1014 $cb->($_[0]->rpid, $_[0]->rstatus);
1015 })
653} 1016}
654 1017
655sub DESTROY { 1018sub DESTROY {
656 $_[0][1]->stop; 1019 $_[0][1]->stop;
657} 1020}
658 1021
659sub condvar { 1022# only needed for AnyEvent < 6 compatibility
660 bless \my $flag, urxvt::anyevent::condvar:: 1023sub one_event {
661}
662
663sub urxvt::anyevent::condvar::broadcast {
664 ${$_[0]}++;
665}
666
667sub urxvt::anyevent::condvar::wait {
668 unless (${$_[0]}) {
669 require Carp;
670 Carp::croak ("AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API"); 1024 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1025}
1026
1027package urxvt::term;
1028
1029=head2 The C<urxvt::term> Class
1030
1031=over 4
1032
1033=cut
1034
1035# find on_xxx subs in the package and register them
1036# as hooks
1037sub register_package {
1038 my ($self, $pkg, $argv) = @_;
1039
1040 no strict 'refs';
1041
1042 urxvt::verbose 6, "register package $pkg to $self";
1043
1044 @{"$pkg\::ISA"} = urxvt::term::extension::;
1045
1046 my $proxy = bless {
1047 _pkg => $pkg,
1048 _name => ${"$pkg\::_NAME"}, # hackish
1049 argv => $argv,
1050 }, $pkg;
1051 Scalar::Util::weaken ($proxy->{term} = $self);
1052
1053 $self->{_pkg}{$pkg} = $proxy;
1054
1055 for my $name (@HOOKNAME) {
1056 if (my $ref = $pkg->can ("on_" . lc $name)) {
1057 $proxy->enable ($name => $ref);
1058 }
671 } 1059 }
672} 1060}
673 1061
674package urxvt::term; 1062sub perl_libdirs {
1063 map { split /:/ }
1064 $_[0]->resource ("perl_lib"),
1065 $ENV{URXVT_PERL_LIB},
1066 "$ENV{HOME}/.urxvt/ext",
1067 "$LIBDIR/perl"
1068}
675 1069
676=head2 The C<urxvt::term> Class 1070sub scan_meta {
1071 my ($self) = @_;
1072 my @libdirs = perl_libdirs $self;
677 1073
678=over 4 1074 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1075
1076 my %meta;
1077
1078 $self->{meta_libdirs} = join "\x00", @libdirs;
1079 $self->{meta} = \%meta;
1080
1081 for my $dir (reverse @libdirs) {
1082 opendir my $fh, $dir
1083 or next;
1084 for my $ext (readdir $fh) {
1085 $ext !~ /^\./
1086 and open my $fh, "<", "$dir/$ext"
1087 or next;
1088
1089 while (<$fh>) {
1090 if (/^#:META:X_RESOURCE:(.*)/) {
1091 my ($pattern, $type, $desc) = split /:/, $1;
1092 $pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1093 if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1094 warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1095 } else {
1096 $meta{resource}{$pattern} = [$ext, $type, $desc];
1097 }
1098 } elsif (/^\s*(?:#|$)/) {
1099 # skip other comments and empty lines
1100 } else {
1101 last; # stop parsing on first non-empty non-comment line
1102 }
1103 }
1104 }
1105 }
1106}
1107
1108=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1109
1110Creates a new terminal, very similar as if you had started it with system
1111C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1112hash which defines the environment of the new terminal.
1113
1114Croaks (and probably outputs an error message) if the new instance
1115couldn't be created. Returns C<undef> if the new instance didn't
1116initialise perl, and the terminal object otherwise. The C<init> and
1117C<start> hooks will be called before this call returns, and are free to
1118refer to global data (which is race free).
1119
1120=cut
1121
1122sub new {
1123 my ($class, $env, @args) = @_;
1124
1125 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1126 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1127
1128 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
1129}
679 1130
680=item $term->destroy 1131=item $term->destroy
681 1132
682Destroy the terminal object (close the window, free resources etc.). 1133Destroy the terminal object (close the window, free resources
1134etc.). Please note that urxvt will not exit as long as any event
1135watchers (timers, io watchers) are still active.
1136
1137=item $term->exec_async ($cmd[, @args])
1138
1139Works like the combination of the C<fork>/C<exec> builtins, which executes
1140("starts") programs in the background. This function takes care of setting
1141the user environment before exec'ing the command (e.g. C<PATH>) and should
1142be preferred over explicit calls to C<exec> or C<system>.
1143
1144Returns the pid of the subprocess or C<undef> on error.
1145
1146=cut
1147
1148sub exec_async {
1149 my $self = shift;
1150
1151 my $pid = fork;
1152
1153 return $pid
1154 if !defined $pid or $pid;
1155
1156 %ENV = %{ $self->env };
1157
1158 exec @_;
1159 urxvt::_exit 255;
1160}
683 1161
684=item $isset = $term->option ($optval[, $set]) 1162=item $isset = $term->option ($optval[, $set])
685 1163
686Returns true if the option specified by C<$optval> is enabled, and 1164Returns true if the option specified by C<$optval> is enabled, and
687optionally change it. All option values are stored by name in the hash 1165optionally change it. All option values are stored by name in the hash
688C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1166C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
689 1167
690Here is a a likely non-exhaustive list of option names, please see the 1168Here is a likely non-exhaustive list of option names, please see the
691source file F</src/optinc.h> to see the actual list: 1169source file F</src/optinc.h> to see the actual list:
692 1170
693 borderLess console cursorBlink cursorUnderline hold iconic insecure 1171 borderLess buffered console cursorBlink cursorUnderline hold iconic
694 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1172 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1173 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
695 pastableTabs pointerBlank reverseVideo scrollBar scrollBar_floating 1174 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
696 scrollBar_right scrollTtyKeypress scrollTtyOutput scrollWithBuffer 1175 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
697 secondaryScreen secondaryScroll skipBuiltinGlyphs transparent 1176 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
698 tripleclickwords utmpInhibit visualBell 1177 urgentOnBell utmpInhibit visualBell
699 1178
700=item $value = $term->resource ($name[, $newval]) 1179=item $value = $term->resource ($name[, $newval])
701 1180
702Returns the current resource value associated with a given name and 1181Returns the current resource value associated with a given name and
703optionally sets a new value. Setting values is most useful in the C<init> 1182optionally sets a new value. Setting values is most useful in the C<init>
712likely change). 1191likely change).
713 1192
714Please note that resource strings will currently only be freed when the 1193Please note that resource strings will currently only be freed when the
715terminal is destroyed, so changing options frequently will eat memory. 1194terminal is destroyed, so changing options frequently will eat memory.
716 1195
717Here is a a likely non-exhaustive list of resource names, not all of which 1196Here is a likely non-exhaustive list of resource names, not all of which
718are supported in every build, please see the source file F</src/rsinc.h> 1197are supported in every build, please see the source file F</src/rsinc.h>
719to see the actual list: 1198to see the actual list:
720 1199
721 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1200 answerbackstring backgroundPixmap backspace_key blurradius
722 borderLess color cursorBlink cursorUnderline cutchars delete_key 1201 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
723 display_name embed ext_bwidth fade font geometry hold iconName 1202 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
724 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1203 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1204 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
725 italicFont jumpScroll lineSpace loginShell mapAlert menu meta8 modifier 1205 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
726 mouseWheelScrollPage name pastableTabs path perl_eval perl_ext_1 perl_ext_2 1206 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
727 perl_lib pointerBlank pointerBlankDelay preeditType print_pipe pty_fd 1207 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
728 reverseVideo saveLines scrollBar scrollBar_align scrollBar_floating 1208 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
729 scrollBar_right scrollBar_thickness scrollTtyKeypress scrollTtyOutput 1209 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
730 scrollWithBuffer scrollstyle secondaryScreen secondaryScroll selectstyle 1210 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
731 shade term_name title transparent transparent_all tripleclickwords 1211 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1212 term_name title transient_for transparent tripleclickwords urgentOnBell
732 utmpInhibit visualBell 1213 utmpInhibit visualBell
733 1214
734=cut 1215=cut
735 1216
736sub resource($$;$) { 1217sub resource($$;$) {
737 my ($self, $name) = (shift, shift); 1218 my ($self, $name) = (shift, shift);
738 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1219 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
739 &urxvt::term::_resource 1220 goto &urxvt::term::_resource
740} 1221}
1222
1223=item $value = $term->x_resource ($pattern)
1224
1225Returns the X-Resource for the given pattern, excluding the program or
1226class name, i.e. C<< $term->x_resource ("boldFont") >> should return the
1227same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1228resource with that pattern exists.
1229
1230Extensions that define extra resource or command line arguments also need
1231to call this method to access their values.
1232
1233If the method is called on an extension object (basically, from an
1234extension), then the special prefix C<%.> will be replaced by the name of
1235the extension and a dot, and the lone string C<%> will be replaced by the
1236extension name itself. This makes it possible to code extensions so you
1237can rename them and get a new set of commandline switches and resources
1238without having to change the actual code.
1239
1240This method should only be called during the C<on_start> hook, as there is
1241only one resource database per display, and later invocations might return
1242the wrong resources.
1243
1244=item $value = $term->x_resource_boolean ($pattern)
1245
1246Like C<x_resource>, above, but interprets the string value as a boolean
1247and returns C<1> for true values, C<0> for false values and C<undef> if
1248the resource or option isn't specified.
1249
1250You should always use this method to parse boolean resources.
1251
1252=cut
1253
1254sub x_resource_boolean {
1255 my $res = &x_resource;
1256
1257 $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1258}
1259
1260=item $success = $term->parse_keysym ($key, $octets)
1261
1262Adds a key binding exactly as specified via a resource. See the
1263C<keysym> resource in the urxvt(1) manpage.
1264
1265=item $term->register_command ($keysym, $modifiermask, $string)
1266
1267Adds a key binding. This is a lower level api compared to
1268C<parse_keysym>, as it expects a parsed key description, and can be
1269used only inside either the C<on_init> hook, to add a binding, or the
1270C<on_register_command> hook, to modify a parsed binding.
741 1271
742=item $rend = $term->rstyle ([$new_rstyle]) 1272=item $rend = $term->rstyle ([$new_rstyle])
743 1273
744Return and optionally change the current rendition. Text that is output by 1274Return and optionally change the current rendition. Text that is output by
745the terminal application will use this style. 1275the terminal application will use this style.
753 1283
754=item ($row, $col) = $term->selection_beg ([$row, $col]) 1284=item ($row, $col) = $term->selection_beg ([$row, $col])
755 1285
756=item ($row, $col) = $term->selection_end ([$row, $col]) 1286=item ($row, $col) = $term->selection_end ([$row, $col])
757 1287
758Return the current values of the selection mark, begin or end positions, 1288Return the current values of the selection mark, begin or end positions.
759and optionally set them to new values.
760 1289
1290When arguments are given, then the selection coordinates are set to
1291C<$row> and C<$col>, and the selection screen is set to the current
1292screen.
1293
1294=item $screen = $term->selection_screen ([$screen])
1295
1296Returns the current selection screen, and then optionally sets it.
1297
1298=item $term->selection_make ($eventtime[, $rectangular])
1299
1300Tries to make a selection as set by C<selection_beg> and
1301C<selection_end>. If C<$rectangular> is true (default: false), a
1302rectangular selection will be made. This is the preferred function to make
1303a selection.
1304
761=item $success = $term->selection_grab ($eventtime) 1305=item $success = $term->selection_grab ($eventtime[, $clipboard])
762 1306
763Try to request the primary selection from the server (for example, as set 1307Try to acquire ownership of the primary (clipboard if C<$clipboard> is
764by the next method). 1308true) selection from the server. The corresponding text can be set
1309with the next method. No visual feedback will be given. This function
1310is mostly useful from within C<on_sel_grab> hooks.
765 1311
766=item $oldtext = $term->selection ([$newtext]) 1312=item $oldtext = $term->selection ([$newtext, $clipboard])
767 1313
768Return the current selection text and optionally replace it by C<$newtext>. 1314Return the current selection (clipboard if C<$clipboard> is true) text
1315and optionally replace it by C<$newtext>.
769 1316
1317=item $term->selection_clear ([$clipboard])
1318
1319Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1320
770#=item $term->overlay ($x, $y, $text) 1321=item $term->overlay_simple ($x, $y, $text)
771# 1322
772#Create a simple multi-line overlay box. See the next method for details. 1323Create a simple multi-line overlay box. See the next method for details.
773# 1324
774#=cut 1325=cut
775# 1326
776#sub urxvt::term::scr_overlay { 1327sub overlay_simple {
777# my ($self, $x, $y, $text) = @_; 1328 my ($self, $x, $y, $text) = @_;
778# 1329
779# my @lines = split /\n/, $text; 1330 my @lines = split /\n/, $text;
780# 1331
781# my $w = 0; 1332 my $w = List::Util::max map $self->strwidth ($_), @lines;
782# for (map $self->strwidth ($_), @lines) { 1333
783# $w = $_ if $w < $_;
784# }
785#
786# $self->scr_overlay_new ($x, $y, $w, scalar @lines); 1334 my $overlay = $self->overlay ($x, $y, $w, scalar @lines);
787# $self->scr_overlay_set (0, $_, $lines[$_]) for 0.. $#lines; 1335 $overlay->set (0, $_, $lines[$_]) for 0.. $#lines;
788#} 1336
1337 $overlay
1338}
789 1339
790=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]]) 1340=item $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
791 1341
792Create a new (empty) overlay at the given position with the given 1342Create a new (empty) overlay at the given position with the given
793width/height. C<$rstyle> defines the initial rendition style 1343width/height. C<$rstyle> defines the initial rendition style
804 1354
805The methods currently supported on C<urxvt::overlay> objects are: 1355The methods currently supported on C<urxvt::overlay> objects are:
806 1356
807=over 4 1357=over 4
808 1358
809=item $overlay->set ($x, $y, $text, $rend) 1359=item $overlay->set ($x, $y, $text[, $rend])
810 1360
811Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1361Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
812text in rxvt-unicode's special encoding and an array of rendition values 1362text in rxvt-unicode's special encoding and an array of rendition values
813at a specific position inside the overlay. 1363at a specific position inside the overlay.
1364
1365If C<$rend> is missing, then the rendition will not be changed.
814 1366
815=item $overlay->hide 1367=item $overlay->hide
816 1368
817If visible, hide the overlay, but do not destroy it. 1369If visible, hide the overlay, but do not destroy it.
818 1370
860 1412
861=item $string = $term->locale_decode ($octets) 1413=item $string = $term->locale_decode ($octets)
862 1414
863Convert the given locale-encoded octets into a perl string. 1415Convert the given locale-encoded octets into a perl string.
864 1416
1417=item $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
1418
1419XORs the rendition values in the given span with the provided value
1420(default: C<RS_RVid>), which I<MUST NOT> contain font styles. Useful in
1421refresh hooks to provide effects similar to the selection.
1422
1423=item $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])
1424
1425Similar to C<scr_xor_span>, but xors a rectangle instead. Trailing
1426whitespace will additionally be xored with the C<$rstyle2>, which defaults
1427to C<RS_RVid | RS_Uline>, which removes reverse video again and underlines
1428it instead. Both styles I<MUST NOT> contain font styles.
1429
1430=item $term->scr_bell
1431
1432Ring the bell!
1433
865=item $term->scr_add_lines ($string) 1434=item $term->scr_add_lines ($string)
866 1435
867Write the given text string to the screen, as if output by the application 1436Write the given text string to the screen, as if output by the application
868running inside the terminal. It may not contain command sequences (escape 1437running inside the terminal. It may not contain command sequences (escape
869codes), but is free to use line feeds, carriage returns and tabs. The 1438codes), but is free to use line feeds, carriage returns and tabs. The
871 1440
872Normally its not a good idea to use this function, as programs might be 1441Normally its not a good idea to use this function, as programs might be
873confused by changes in cursor position or scrolling. Its useful inside a 1442confused by changes in cursor position or scrolling. Its useful inside a
874C<on_add_lines> hook, though. 1443C<on_add_lines> hook, though.
875 1444
1445=item $term->scr_change_screen ($screen)
1446
1447Switch to given screen - 0 primary, 1 secondary.
1448
876=item $term->cmd_parse ($octets) 1449=item $term->cmd_parse ($octets)
877 1450
878Similar to C<scr_add_lines>, but the argument must be in the 1451Similar to C<scr_add_lines>, but the argument must be in the
879locale-specific encoding of the terminal and can contain command sequences 1452locale-specific encoding of the terminal and can contain command sequences
880(escape codes) that will be interpreted. 1453(escape codes) that will be interpreted.
881 1454
882=item $term->tt_write ($octets) 1455=item $term->tt_write ($octets)
883 1456
884Write the octets given in C<$data> to the tty (i.e. as program input). To 1457Write the octets given in C<$octets> to the tty (i.e. as program input). To
885pass characters instead of octets, you should convert your strings first 1458pass characters instead of octets, you should convert your strings first
886to the locale-specific encoding using C<< $term->locale_encode >>. 1459to the locale-specific encoding using C<< $term->locale_encode >>.
887 1460
1461=item $term->tt_paste ($octets)
1462
1463Write the octets given in C<$octets> to the tty as a paste, converting NL to
1464CR and bracketing the data with control sequences if bracketed paste mode
1465is set.
1466
1467=item $old_events = $term->pty_ev_events ([$new_events])
1468
1469Replaces the event mask of the pty watcher by the given event mask. Can
1470be used to suppress input and output handling to the pty/tty. See the
1471description of C<< urxvt::timer->events >>. Make sure to always restore
1472the previous value.
1473
1474=item $fd = $term->pty_fd
1475
1476Returns the master file descriptor for the pty in use, or C<-1> if no pty
1477is used.
1478
888=item $windowid = $term->parent 1479=item $windowid = $term->parent
889 1480
890Return the window id of the toplevel window. 1481Return the window id of the toplevel window.
891 1482
892=item $windowid = $term->vt 1483=item $windowid = $term->vt
893 1484
894Return the window id of the terminal window. 1485Return the window id of the terminal window.
895 1486
1487=item $term->vt_emask_add ($x_event_mask)
1488
1489Adds the specified events to the vt event mask. Useful e.g. when you want
1490to receive pointer events all the times:
1491
1492 $term->vt_emask_add (urxvt::PointerMotionMask);
1493
1494=item $term->set_urgency ($set)
1495
1496Enable/disable the urgency hint on the toplevel window.
1497
1498=item $term->focus_in
1499
1500=item $term->focus_out
1501
1502=item $term->key_press ($state, $keycode[, $time])
1503
1504=item $term->key_release ($state, $keycode[, $time])
1505
1506Deliver various fake events to to terminal.
1507
896=item $window_width = $term->width 1508=item $window_width = $term->width
897 1509
898=item $window_height = $term->height 1510=item $window_height = $term->height
899 1511
900=item $font_width = $term->fwidth 1512=item $font_width = $term->fwidth
913 1525
914=item $max_scrollback = $term->saveLines 1526=item $max_scrollback = $term->saveLines
915 1527
916=item $nrow_plus_saveLines = $term->total_rows 1528=item $nrow_plus_saveLines = $term->total_rows
917 1529
918=item $lines_in_scrollback = $term->nsaved 1530=item $topmost_scrollback_row = $term->top_row
919 1531
920Return various integers describing terminal characteristics. 1532Return various integers describing terminal characteristics.
921 1533
1534=item $x_display = $term->display_id
1535
1536Return the DISPLAY used by rxvt-unicode.
1537
922=item $lc_ctype = $term->locale 1538=item $lc_ctype = $term->locale
923 1539
924Returns the LC_CTYPE category string used by this rxvt-unicode. 1540Returns the LC_CTYPE category string used by this rxvt-unicode.
925 1541
926=item $x_display = $term->display_id 1542=item $env = $term->env
927 1543
928Return the DISPLAY used by rxvt-unicode. 1544Returns a copy of the environment in effect for the terminal as a hashref
1545similar to C<\%ENV>.
1546
1547=item @envv = $term->envv
1548
1549Returns the environment as array of strings of the form C<VAR=VALUE>.
1550
1551=item @argv = $term->argv
1552
1553Return the argument vector as this terminal, similar to @ARGV, but
1554includes the program name as first element.
1555
1556=cut
1557
1558sub env {
1559 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1560}
929 1561
930=item $modifiermask = $term->ModLevel3Mask 1562=item $modifiermask = $term->ModLevel3Mask
931 1563
932=item $modifiermask = $term->ModMetaMask 1564=item $modifiermask = $term->ModMetaMask
933 1565
934=item $modifiermask = $term->ModNumLockMask 1566=item $modifiermask = $term->ModNumLockMask
935 1567
936Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1568Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
937AltGr), the meta key (often Alt) and the num lock key, if applicable. 1569AltGr), the meta key (often Alt) and the num lock key, if applicable.
938 1570
1571=item $screen = $term->current_screen
1572
1573Returns the currently displayed screen (0 primary, 1 secondary).
1574
1575=item $cursor_is_hidden = $term->hidden_cursor
1576
1577Returns whether the cursor is currently hidden or not.
1578
939=item $view_start = $term->view_start ([$newvalue]) 1579=item $view_start = $term->view_start ([$newvalue])
940 1580
941Returns the negative row number of the topmost line. Minimum value is 1581Returns the row number of the topmost displayed line. Maximum value is
942C<0>, which displays the normal terminal contents. Larger values scroll 1582C<0>, which displays the normal terminal contents. Lower values scroll
943this many lines into the scrollback buffer. 1583this many lines into the scrollback buffer.
944 1584
945=item $term->want_refresh 1585=item $term->want_refresh
946 1586
947Requests a screen refresh. At the next opportunity, rxvt-unicode will 1587Requests a screen refresh. At the next opportunity, rxvt-unicode will
950 1590
951Used after changing terminal contents to display them. 1591Used after changing terminal contents to display them.
952 1592
953=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1593=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
954 1594
955Returns the text of the entire row with number C<$row_number>. Row C<0> 1595Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
956is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1596is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
957terminal line. The scrollback buffer starts at line C<-1> and extends to
958line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1597terminal line. Nothing will be returned if a nonexistent line
959is requested. 1598is requested.
960 1599
961If C<$new_text> is specified, it will replace characters in the current 1600If C<$new_text> is specified, it will replace characters in the current
962line, starting at column C<$start_col> (default C<0>), which is useful 1601line, starting at column C<$start_col> (default C<0>), which is useful
963to replace only parts of a line. The font index in the rendition will 1602to replace only parts of a line. The font index in the rendition will
964automatically be updated. 1603automatically be updated.
965 1604
966C<$text> is in a special encoding: tabs and wide characters that use more 1605C<$text> is in a special encoding: tabs and wide characters that use more
967than one cell when displayed are padded with urxvt::NOCHAR characters 1606than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
968(C<chr 65535>). Characters with combining characters and other characters 1607characters. Characters with combining characters and other characters that
969that do not fit into the normal tetx encoding will be replaced with 1608do not fit into the normal text encoding will be replaced with characters
970characters in the private use area. 1609in the private use area.
971 1610
972You have to obey this encoding when changing text. The advantage is 1611You have to obey this encoding when changing text. The advantage is
973that C<substr> and similar functions work on screen cells and not on 1612that C<substr> and similar functions work on screen cells and not on
974characters. 1613characters.
975 1614
1026Return the row number of the first/last row of the line, respectively. 1665Return the row number of the first/last row of the line, respectively.
1027 1666
1028=item $offset = $line->offset_of ($row, $col) 1667=item $offset = $line->offset_of ($row, $col)
1029 1668
1030Returns the character offset of the given row|col pair within the logical 1669Returns the character offset of the given row|col pair within the logical
1031line. 1670line. Works for rows outside the line, too, and returns corresponding
1671offsets outside the string.
1032 1672
1033=item ($row, $col) = $line->coord_of ($offset) 1673=item ($row, $col) = $line->coord_of ($offset)
1034 1674
1035Translates a string offset into terminal coordinates again. 1675Translates a string offset into terminal coordinates again.
1036 1676
1058} 1698}
1059 1699
1060sub urxvt::line::t { 1700sub urxvt::line::t {
1061 my ($self) = @_; 1701 my ($self) = @_;
1062 1702
1063 if (@_ > 1) 1703 if (@_ > 1) {
1064 {
1065 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1704 $self->{term}->ROW_t ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1066 for $self->{beg} .. $self->{end}; 1705 for $self->{beg} .. $self->{end};
1067 } 1706 }
1068 1707
1069 defined wantarray && 1708 defined wantarray &&
1070 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}), 1709 substr +(join "", map $self->{term}->ROW_t ($_), $self->{beg} .. $self->{end}),
1071 0, $self->{len} 1710 0, $self->{len}
1072} 1711}
1073 1712
1074sub urxvt::line::r { 1713sub urxvt::line::r {
1075 my ($self) = @_; 1714 my ($self) = @_;
1076 1715
1077 if (@_ > 1) 1716 if (@_ > 1) {
1078 {
1079 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol}) 1717 $self->{term}->ROW_r ($_, $_[1], 0, ($_ - $self->{beg}) * $self->{ncol}, $self->{ncol})
1080 for $self->{beg} .. $self->{end}; 1718 for $self->{beg} .. $self->{end};
1081 } 1719 }
1082 1720
1083 if (defined wantarray) { 1721 if (defined wantarray) {
1084 my $rend = [ 1722 my $rend = [
1085 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end} 1723 map @{ $self->{term}->ROW_r ($_) }, $self->{beg} .. $self->{end}
1086 ]; 1724 ];
1118where one character corresponds to one screen cell. See 1756where one character corresponds to one screen cell. See
1119C<< $term->ROW_t >> for details. 1757C<< $term->ROW_t >> for details.
1120 1758
1121=item $string = $term->special_decode $text 1759=item $string = $term->special_decode $text
1122 1760
1123Converts rxvt-unicodes text reprsentation into a perl string. See 1761Converts rxvt-unicodes text representation into a perl string. See
1124C<< $term->ROW_t >> for details. 1762C<< $term->ROW_t >> for details.
1125 1763
1126=item $success = $term->grab_button ($button, $modifiermask) 1764=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1127 1765
1766=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1767
1128Registers a synchronous button grab. See the XGrabButton manpage. 1768Register/unregister a synchronous button grab. See the XGrabButton
1769manpage.
1129 1770
1130=item $success = $term->grab ($eventtime[, $sync]) 1771=item $success = $term->grab ($eventtime[, $sync])
1131 1772
1132Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1773Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1133synchronous (C<$sync> is true). Also remembers the grab timestampe. 1774synchronous (C<$sync> is true). Also remembers the grab timestamp.
1134 1775
1135=item $term->allow_events_async 1776=item $term->allow_events_async
1136 1777
1137Calls XAllowEvents with AsyncBoth for the most recent grab. 1778Calls XAllowEvents with AsyncBoth for the most recent grab.
1138 1779
1145Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 1786Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1146recent grab. 1787recent grab.
1147 1788
1148=item $term->ungrab 1789=item $term->ungrab
1149 1790
1150Calls XUngrab for the most recent grab. Is called automatically on 1791Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1151evaluation errors, as it is better to lose the grab in the error case as 1792evaluation errors, as it is better to lose the grab in the error case as
1152the session. 1793the session.
1794
1795=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1796
1797=item $atom_name = $term->XGetAtomName ($atom)
1798
1799=item @atoms = $term->XListProperties ($window)
1800
1801=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1802
1803=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1804
1805=item $term->XDeleteProperty ($window, $property)
1806
1807=item $window = $term->DefaultRootWindow
1808
1809=item $term->XReparentWindow ($window, $parent, [$x, $y])
1810
1811=item $term->XMapWindow ($window)
1812
1813=item $term->XUnmapWindow ($window)
1814
1815=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1816
1817=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1818
1819=item $term->XChangeInput ($window, $add_events[, $del_events])
1820
1821=item $keysym = $term->XStringToKeysym ($string)
1822
1823=item $string = $term->XKeysymToString ($keysym)
1824
1825Various X or X-related functions. The C<$term> object only serves as
1826the source of the display, otherwise those functions map more-or-less
1827directly onto the X functions of the same name.
1153 1828
1154=back 1829=back
1155 1830
1156=cut 1831=cut
1157 1832
1173 $item->{render} ||= sub { $_[0]{text} }; 1848 $item->{render} ||= sub { $_[0]{text} };
1174 1849
1175 push @{ $self->{item} }, $item; 1850 push @{ $self->{item} }, $item;
1176} 1851}
1177 1852
1853=item $popup->add_title ($title)
1854
1855Adds a non-clickable title to the popup.
1856
1857=cut
1858
1859sub add_title {
1860 my ($self, $title) = @_;
1861
1862 $self->add_item ({
1863 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
1864 text => $title,
1865 activate => sub { },
1866 });
1867}
1868
1869=item $popup->add_separator ([$sepchr])
1870
1871Creates a separator, optionally using the character given as C<$sepchr>.
1872
1873=cut
1874
1178sub add_separator { 1875sub add_separator {
1179 my ($self, $sep) = @_; 1876 my ($self, $sep) = @_;
1180 1877
1181 $sep ||= ""; 1878 $sep ||= "=";
1182 1879
1183 $self->add_item ({ 1880 $self->add_item ({
1184 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" }, 1881 rend => { normal => "\x1b[0;30;47m", hover => "\x1b[0;30;47m", active => "\x1b[0;30;47m" },
1185 text => "", 1882 text => "",
1186 render => sub { $sep x $self->{term}->ncol }, 1883 render => sub { $sep x $self->{term}->ncol },
1187 activate => sub { }, 1884 activate => sub { },
1188 }); 1885 });
1189} 1886}
1190 1887
1191sub add_title { 1888=item $popup->add_button ($text, $cb)
1192 my ($self, $title) = @_;
1193 1889
1194 $self->add_item ({ 1890Adds a clickable button to the popup. C<$cb> is called whenever it is
1195 rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" }, 1891selected.
1196 text => $title, 1892
1197 activate => sub { }, 1893=cut
1198 });
1199}
1200 1894
1201sub add_button { 1895sub add_button {
1202 my ($self, $text, $cb) = @_; 1896 my ($self, $text, $cb) = @_;
1203 1897
1204 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1898 $self->add_item ({ type => "button", text => $text, activate => $cb});
1205} 1899}
1206 1900
1901=item $popup->add_toggle ($text, $initial_value, $cb)
1902
1903Adds a toggle/checkbox item to the popup. The callback gets called
1904whenever it gets toggled, with a boolean indicating its new value as its
1905first argument.
1906
1907=cut
1908
1207sub add_toggle { 1909sub add_toggle {
1208 my ($self, $text, $cb, $value) = @_; 1910 my ($self, $text, $value, $cb) = @_;
1209 1911
1210 my $item; $item = { 1912 my $item; $item = {
1211 type => "button", 1913 type => "button",
1212 text => " $text", 1914 text => " $text",
1213 value => $value, 1915 value => $value,
1214 render => sub { ($_[0]{value} ? "* " : " ") . $text }, 1916 render => sub { ($_[0]{value} ? "* " : " ") . $text },
1215 activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, 1917 activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1216 }; 1918 };
1217 1919
1218 $self->add_item ($item); 1920 $self->add_item ($item);
1219} 1921}
1922
1923=item $popup->show
1924
1925Displays the popup (which is initially hidden).
1926
1927=cut
1220 1928
1221sub show { 1929sub show {
1222 my ($self) = @_; 1930 my ($self) = @_;
1223 1931
1224 local $urxvt::popup::self = $self; 1932 local $urxvt::popup::self = $self;
1225 1933
1934 my $env = $self->{term}->env;
1935 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1936 delete $env->{LC_ALL};
1226 local $ENV{LC_ALL} = $self->{term}->locale; 1937 $env->{LC_CTYPE} = $self->{term}->locale;
1227 1938
1228 urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0, 1939 my $term = urxvt::term->new (
1940 $env, "popup",
1941 "--perl-lib" => "", "--perl-ext-common" => "",
1942 "-pty-fd" => -1, "-sl" => 0,
1943 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1229 "--transient-for" => $self->{term}->parent, 1944 "--transient-for" => $self->{term}->parent,
1230 "-display" => $self->{term}->display_id, 1945 "-display" => $self->{term}->display_id,
1231 "-pe" => "urxvt-popup") 1946 "-pe" => "urxvt-popup",
1232 or die "unable to create popup window\n"; 1947 ) or die "unable to create popup window\n";
1948
1949 unless (delete $term->{urxvt_popup_init_done}) {
1950 $term->ungrab;
1951 $term->destroy;
1952 die "unable to initialise popup window\n";
1953 }
1233} 1954}
1234 1955
1235sub DESTROY { 1956sub DESTROY {
1236 my ($self) = @_; 1957 my ($self) = @_;
1237 1958
1238 delete $self->{term}{_destroy}{$self}; 1959 delete $self->{term}{_destroy}{$self};
1239 $self->{term}->ungrab; 1960 $self->{term}->ungrab;
1240} 1961}
1962
1963=back
1964
1965=cut
1966
1967package urxvt::watcher;
1241 1968
1242=head2 The C<urxvt::timer> Class 1969=head2 The C<urxvt::timer> Class
1243 1970
1244This class implements timer watchers/events. Time is represented as a 1971This class implements timer watchers/events. Time is represented as a
1245fractional number of seconds since the epoch. Example: 1972fractional number of seconds since the epoch. Example:
1249 ->new 1976 ->new
1250 ->interval (1) 1977 ->interval (1)
1251 ->cb (sub { 1978 ->cb (sub {
1252 $term->{overlay}->set (0, 0, 1979 $term->{overlay}->set (0, 0,
1253 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 1980 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1254 }); 1981 });
1255 1982
1256=over 4 1983=over 4
1257 1984
1258=item $timer = new urxvt::timer 1985=item $timer = new urxvt::timer
1259 1986
1262 1989
1263=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 1990=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
1264 1991
1265Set the callback to be called when the timer triggers. 1992Set the callback to be called when the timer triggers.
1266 1993
1267=item $tstamp = $timer->at
1268
1269Return the time this watcher will fire next.
1270
1271=item $timer = $timer->set ($tstamp) 1994=item $timer = $timer->set ($tstamp[, $interval])
1272 1995
1273Set the time the event is generated to $tstamp. 1996Set the time the event is generated to $tstamp (and optionally specifies a
1997new $interval).
1274 1998
1275=item $timer = $timer->interval ($interval) 1999=item $timer = $timer->interval ($interval)
1276 2000
1277Normally (and when C<$interval> is C<0>), the timer will automatically 2001By default (and when C<$interval> is C<0>), the timer will automatically
1278stop after it has fired once. If C<$interval> is non-zero, then the timer 2002stop after it has fired once. If C<$interval> is non-zero, then the timer
1279is automatically rescheduled at the given intervals. 2003is automatically rescheduled at the given intervals.
1280 2004
1281=item $timer = $timer->start 2005=item $timer = $timer->start
1282 2006
1283Start the timer. 2007Start the timer.
1284 2008
1285=item $timer = $timer->start ($tstamp) 2009=item $timer = $timer->start ($tstamp[, $interval])
1286 2010
1287Set the event trigger time to C<$tstamp> and start the timer. 2011Set the event trigger time to C<$tstamp> and start the timer. Optionally
2012also replaces the interval.
2013
2014=item $timer = $timer->after ($delay[, $interval])
2015
2016Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
1288 2017
1289=item $timer = $timer->stop 2018=item $timer = $timer->stop
1290 2019
1291Stop the timer. 2020Stop the timer.
1292 2021
1298 2027
1299 $term->{socket} = ... 2028 $term->{socket} = ...
1300 $term->{iow} = urxvt::iow 2029 $term->{iow} = urxvt::iow
1301 ->new 2030 ->new
1302 ->fd (fileno $term->{socket}) 2031 ->fd (fileno $term->{socket})
1303 ->events (1) # wait for read data 2032 ->events (urxvt::EV_READ)
1304 ->start 2033 ->start
1305 ->cb (sub { 2034 ->cb (sub {
1306 my ($iow, $revents) = @_; 2035 my ($iow, $revents) = @_;
1307 # $revents must be 1 here, no need to check 2036 # $revents must be 1 here, no need to check
1308 sysread $term->{socket}, my $buf, 8192 2037 sysread $term->{socket}, my $buf, 8192
1321Set the callback to be called when io events are triggered. C<$reventmask> 2050Set the callback to be called when io events are triggered. C<$reventmask>
1322is a bitset as described in the C<events> method. 2051is a bitset as described in the C<events> method.
1323 2052
1324=item $iow = $iow->fd ($fd) 2053=item $iow = $iow->fd ($fd)
1325 2054
1326Set the filedescriptor (not handle) to watch. 2055Set the file descriptor (not handle) to watch.
1327 2056
1328=item $iow = $iow->events ($eventmask) 2057=item $iow = $iow->events ($eventmask)
1329 2058
1330Set the event mask to watch. Bit #0 (value C<1>) enables watching for read 2059Set the event mask to watch. The only allowed values are
1331data, Bit #1 (value C<2>) enables watching for write data. 2060C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2061together, or C<urxvt::EV_NONE>.
1332 2062
1333=item $iow = $iow->start 2063=item $iow = $iow->start
1334 2064
1335Start watching for requested events on the given handle. 2065Start watching for requested events on the given handle.
1336 2066
1337=item $iow = $iow->stop 2067=item $iow = $iow->stop
1338 2068
1339Stop watching for events on the given filehandle. 2069Stop watching for events on the given file handle.
2070
2071=back
2072
2073=head2 The C<urxvt::iw> Class
2074
2075This class implements idle watchers, that get called automatically when
2076the process is idle. They should return as fast as possible, after doing
2077some useful work.
2078
2079=over 4
2080
2081=item $iw = new urxvt::iw
2082
2083Create a new idle watcher object in stopped state.
2084
2085=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2086
2087Set the callback to be called when the watcher triggers.
2088
2089=item $timer = $timer->start
2090
2091Start the watcher.
2092
2093=item $timer = $timer->stop
2094
2095Stop the watcher.
2096
2097=back
2098
2099=head2 The C<urxvt::pw> Class
2100
2101This class implements process watchers. They create an event whenever a
2102process exits, after which they stop automatically.
2103
2104 my $pid = fork;
2105 ...
2106 $term->{pw} = urxvt::pw
2107 ->new
2108 ->start ($pid)
2109 ->cb (sub {
2110 my ($pw, $exit_status) = @_;
2111 ...
2112 });
2113
2114=over 4
2115
2116=item $pw = new urxvt::pw
2117
2118Create a new process watcher in stopped state.
2119
2120=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2121
2122Set the callback to be called when the timer triggers.
2123
2124=item $pw = $timer->start ($pid)
2125
2126Tells the watcher to start watching for process C<$pid>.
2127
2128=item $pw = $pw->stop
2129
2130Stop the watcher.
1340 2131
1341=back 2132=back
1342 2133
1343=head1 ENVIRONMENT 2134=head1 ENVIRONMENT
1344 2135
1351 2142
1352=item == 0 - fatal messages 2143=item == 0 - fatal messages
1353 2144
1354=item >= 3 - script loading and management 2145=item >= 3 - script loading and management
1355 2146
1356=item >=10 - all events received 2147=item >=10 - all called hooks
2148
2149=item >=11 - hook return values
1357 2150
1358=back 2151=back
1359 2152
1360=head1 AUTHOR 2153=head1 AUTHOR
1361 2154
1362 Marc Lehmann <pcg@goof.com> 2155 Marc Lehmann <schmorp@schmorp.de>
1363 http://software.schmorp.de/pkg/rxvt-unicode 2156 http://software.schmorp.de/pkg/rxvt-unicode
1364 2157
1365=cut 2158=cut
1366 2159
13671 21601
2161
2162# vim: sw=3:

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines