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.76 by root, Tue Jan 10 19:46:28 2006 UTC vs.
Revision 1.264 by root, Sat Jul 24 09:42:15 2021 UTC

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

Diff Legend

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