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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines