ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

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

Diff Legend

–	Removed lines
+	Added lines
<	Changed lines
>	Changed lines