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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines