ViewVC Help

View File | Revision Log | Show Annotations | Download File

/cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.86 by root, Thu Jan 12 05:22:47 2006 UTC vs.
Revision 1.244 by sf-exg, Mon Oct 13 12:17:48 2014 UTC

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

Diff Legend

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