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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines