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

Diff Legend

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