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.33 by root, Thu Jan 5 01:04:10 2006 UTC vs.
Revision 1.254 by sf-exg, Tue Mar 17 09:23:08 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines