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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines