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.72 by root, Mon Jan 9 23:30:01 2006 UTC vs.
Revision 1.244 by sf-exg, Mon Oct 13 12:17:48 2014 UTC

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

Diff Legend

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