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.54 by root, Sun Jan 8 01:59:29 2006 UTC vs.
Revision 1.236 by root, Sat May 17 17:12:29 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines