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.57 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.247 by root, Fri Dec 26 19:19:30 2014 UTC

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

Diff Legend

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