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

Diff Legend

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