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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines