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

Diff Legend

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