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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines