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

Diff Legend

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