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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines